Accounts & connections · Account Groups

List groups

Returns groups.

GEThttps://api.pozy.ai/v1/account-groups
listAccountGroups

Guide: Account groups

Request

Send your API key as Authorization: Bearer pz_live_.... Read-only keys can call it. Keys with the accounts resource group disabled get 403 resource_group_disabled. Authentication

Example

curl -X GET "https://api.pozy.ai/v1/account-groups" \
  -H "Authorization: Bearer $POZY_API_KEY"

Response

200 on success

  • groupsarray of object
    • _idstring
    • namestring
    • accountIdsarray of string
    • createdBystring
    • profileIdstring
200 response
{
  "groups": [
    {
      "_id": "635d87e261ae344ef27fd1df",
      "name": "Acme",
      "accountIds": [
        "string"
      ],
      "createdBy": "string",
      "profileId": "6a0b6573846efc28aaa9a3ff"
    }
  ]
}

Errors

Errors use one shape: { error, type, code, param?, details? }. The ones you are most likely to see here:

400invalid_request_errorA parameter or body field is missing or invalid. param names it.
401authentication_errorThe API key is missing, revoked or expired.
403permission_errorThe key is scoped to other profiles or has this resource group disabled.
429rate_limit_errorToo many requests this minute. Wait for Retry-After seconds.

Every code is listed in Errors.

More in Account Groups