WorkspaceGroup

accounts object[]

The agency account (principal) comes first, then one workspace per client.

Array [

idstring

namestring

statusstring

principalboolean

clientInvitesboolean

createdAtstring<date-time>

deletion objectnullable

requestedAtstring<date-time>nullable

scheduledAtstring<date-time>

alerts object

Numbers with yellow or red quality, and inactive numbers.

lowQualityNumbersinteger

inactiveNumbersinteger

access object[]

Who of the team was given access to this client.

Array [

userIdstring

tenantRolestring

allowedPhoneNumberIdsstring[]

]

usage object

What the account consumed in the current billing period.

periodstring

Billing period, YYYY-MM.

connectedNumbersinteger

contactsinteger

messagesinteger

]

team object[]

The agency team's people who are not owners — owners reach every client.

Array [

idstring

namestringnullable

emailstring

tenantRolestring

]

limitintegernullable

How many accounts the subscription covers, the agency's included: one workspace per WhatsApp number the plan allows (more, if the plan says so). null = no cap, on a plan with no cap on numbers.

usedinteger

How many accounts exist, the agency's included.

enabledboolean

Whether creating workspaces is available on the platform.

WorkspaceGroup

{
  "accounts": [
    {
      "id": "string",
      "name": "string",
      "status": "string",
      "principal": true,
      "clientInvites": true,
      "createdAt": "2024-07-29T15:51:28.071Z",
      "deletion": {
        "requestedAt": "2024-07-29T15:51:28.071Z",
        "scheduledAt": "2024-07-29T15:51:28.071Z"
      },
      "alerts": {
        "lowQualityNumbers": 0,
        "inactiveNumbers": 0
      },
      "access": [
        {
          "userId": "string",
          "tenantRole": "string",
          "allowedPhoneNumberIds": [
            "string"
          ]
        }
      ],
      "usage": {
        "period": "string",
        "connectedNumbers": 0,
        "contacts": 0,
        "messages": 0
      }
    }
  ],
  "team": [
    {
      "id": "string",
      "name": "string",
      "email": "string",
      "tenantRole": "string"
    }
  ],
  "limit": 0,
  "used": 0,
  "enabled": true
}