Skip to content

List organizations

GET
/organizations
curl --request GET \
--url 'https://optlo.com/api/v1/organizations?limit=50' \
--header 'Authorization: Bearer <token>'

Requires organizations:read.

limit
integer
default: 50 >= 1 <= 100

Maximum number of resources to return on one page.

cursor
string

Opaque cursor from the preceding page. Bound to workspace, resource and filters; survives key rotation.

Success

Media typeapplication/json
Show child attributesHide child attributes
data
required

Resources on this page.

array of dictionaries
Show child attributesHide child attributes
id
required

Unique identifier for the organization.

string
name
required

Organization’s display name.

string
externalId
required

Organization identifier in your system. String and numeric IDs are distinct.

string
or
number
nextCursor
required

Pass this cursor to retrieve the next page. Null when no further page is available. When polling events in ascending order, retain the cursor even on empty pages.

nullable string

Example

{
"data": [
{
"id": "k6m3p9x2r8n4q7v5b1c0dfgh",
"name": "Acme",
"externalId": "company_1042"
}
],
"nextCursor": null
}