Reseller

List Organizations

Shows details of Organizations belonging to the account associated with your API credentials.

Note: This endpoint will also return a pagination key on the root level.
Please refer to the pagination section within our docs for more information.

get/v1/accounts/{account_id}/organizations

Path parameters

account_idinteger required

Query parameters

limitinteger

Max number of resources returned in a paged collection. Defaults to 10, with a minimum of 1 and maximum 500.

page_tokenstring

Token used to request the next page in paginated results. Defaults to 'null'

sort_field'id' | 'created_at' | 'updated_at' | 'name' | 'key'

Field to sort by. Defaults to 'id'.

sort_direction'asc' | 'desc'

Sort direction. Defaults to 'desc'.

namestring

Filter by organization name.

keystring

Filter by organization key.

Response

List Organizations

Example response

{
  "organizations": [
    {
      "id": 1,
      "agents_count": 42,
      "account_id": 5,
      "created_at": "2022-03-01T18:54:02Z",
      "incident_reports_count": 42,
      "key": "test1",
      "logs_sources_count": 42,
      "identity_provider_tenant_id": "dcd219dd-bc68-4b9b-bf0b-4a33a796be35",
      "billable_identity_count": 42,
      "name": "Acme Inc.",
      "report_recipients": [
        "test@test.com",
        "fakenotificiation@test.com"
      ],
      "sat_learner_count": 42,
      "updated_at": "2022-03-01T18:54:02Z"
    }
  ]
}