Skip to content
Pulse Docs

Accounts

The /accounts endpoint provides information about the accounts a user belongs to, including details about each account and the user’s permissions within those accounts.

Example Response

[
  {
    "id": "6591739253089529",
    "uniqueId": "6591739253089529",
    "name": "zach@example.com",
    "repcode": "3",
    "accountTypeId": "default",
    "accountTypeTemplate": false,
    "createdBy": "zach@example.com",
    "updatedBy": "zach@example.com",
    "createdAt": "2025-02-11T05:51:29.529Z",
    "updatedAt": "2025-02-11T05:51:29.529Z",


    "customerServicePhone": "555-1234",
    "customerServiceEmail": "support@example.com",
    "whitelabelSettings": {
      "logo": "logo.png",
      "theme": "dark"
    },
    "permissions": ["readSupport"],
    "roles": ["admin", "user"]
  },
  {
    "id": "9182374987",
    "uniqueId": "9182374987",
    "name": "Payments",
    "repcode": null,
    "accountTypeId": "default",
    "accountTypeTemplate": false,
    "createdBy": "zach@example.com",
    "updatedBy": "zach@example.com",
    "createdAt": "2025-02-11T05:51:29.529Z",
    "customerServicePhone": "555-5678",
    "customerServiceEmail": "payments@example.com",
    "whitelabelSettings": {
      "logo": "payments-logo.png",
      "theme": "light"
    },
    "permissions": ["readData", "writeData"],
    "roles": ["user"]
  }
]

Properties

id

  • Type: string
  • Description: The unique identifier of the account in the database.

uniqueId

  • Type: string
  • Description: A globally unique identifier for the account.

name

  • Type: string
  • Description: The name of the account.

repcode

  • Type: string | null
  • Description: The repcode associated with the account. Agents only.

customerServicePhone

  • Type: string
  • Description: Customer service phone number.

customerServiceEmail

  • Type: string
  • Description: Customer service email address.

whitelabelSettings

  • Type: object
  • Description: WhiteLabel Settings, including properties like logo and theme.

permissions

  • Type: array of string
  • Description: Permission names associated with the account.

roles

  • Type: array of string
  • Description: Roles associated with the account.

createdBy

  • Type: string
  • Description: The email address of the user who created the account.

updatedBy

  • Type: string
  • Description: The email address of the user who last updated the account.

createdAt

  • Type: string (ISO 8601 datetime)
  • Description: The timestamp of when the account was created.

updatedAt

  • Type: string (ISO 8601 datetime)
  • Description: The timestamp of the last update to the account.