Skip to content

List accounts

get /v1/accounts

The accounts of the company, ordered by id ascending and paged with a signed cursor. Use it to find the account_id a collection accepts, or to turn an id from an accounts field back into a name. Accounts with no usable email domain are left out. q narrows the page to accounts whose name or email domain contains the text, case-insensitively. Any collection read scope opens this catalog. For a user credential, empty when the company’s ACCOUNTS feature is off.

Requires the meetings.read, calls.read, emails.read and whatsapp.read scopes together.

NameTypeRequiredDescription
limitintegerNoRecords per page, 1 to 100. A page may return fewer than this while has_more is still true; drive the loop by has_more, not by the size of data.
cursorstringNoSigned cursor returned by the previous page.
qstringNoText to look for in the account name or email domain, 2 to 100 characters after trimming, matched case-insensitively anywhere in the value. Only GET /v1/accounts accepts it.
Terminal window
curl "https://api.salesbud.com.br/v1/accounts?limit=...&cursor=..." \
-H "Authorization: Bearer $SALESBUD_ACCESS_TOKEN"
200 OK
{
"data": [
{
"id": "acc_01JEXAMPLE",
"object": "account",
"name": "Example Ltda",
"domain": "example.net",
"cnpj": "00.000.000/0001-00"
},
{
"id": "acc_01JEXAMPLE2",
"object": "account",
"name": null,
"domain": "example.org",
"cnpj": null
}
],
"pagination": {
"limit": 50,
"has_more": false,
"next_cursor": null
},
"request_id": "req_ExampleRequestId01"
}
StatusDescription
200Company-scoped account page.
400Invalid request.
401Missing or invalid credentials.
403The token lacks the required scope, its user owner lost matching product access, or a connector awaits administrator approval. API_ACCESS_DISABLED identifies the feature gate for manual clients and third-party OAuth apps; AI_COLLABORATORS_DISABLED identifies the gate for first-party OAuth apps. For partner credentials, the gate also requires an active partner and the required published module, and applies to previously issued tokens.
429Client rate limit exceeded.
503A required audit or rate-limit dependency is unavailable.