Get organizations

Request

Retrieve a list of all organizations. This should be called from the backend, using an admin access token (generated by a management app).

Required permissions: organizations:read, orgs:read, organizations:list, orgs:list.

Security

AdminAccessToken

Query

limitnumber

Maximum number of results to return. Defaults to 1000, maximum 1000.

offsetnumber

Number of results to skip. Defaults to 0.

searchstring

Filter results by organization name

sort_fieldstring

The name of the field you wish to sort by.

Default:"created_at"

Enum:"name""created_at""status"

sort_orderstring

The order of the sort

Default:"asc"

Enum:"asc""desc"

app_idArray of strings

Filter results by application IDs

curl -i -X GET \
  'https://api.sbx.transmitsecurity.io/cis/v1/organizations?limit=0&offset=0&search=string&sort_field=name&sort_order=asc&app_id=string' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Bodyapplication/json

total_countnumberrequired

page_infoobjectrequired

resultArray of objectsrequired

Response

{
  "total_count": 0,
  "page_info": {
    "has_next_page": true,
    "has_previous_page": true
  },
  "result": [
    { … }
  ]
}