Gateway GRPC

List organisations

Mode	Parameters	Result
Root organisations (default)	Omit both parent_id and include_descendants	Returns only root organisations visible to the current user
All accessible organisations	include_descendants=true and no parent_id	Returns all organisations the user can access under their roots
Direct children of a parent	Provide parent_id; omit include_descendants or set it to false	Returns only the direct children of the specified parent
All descendants of a parent	Provide parent_id and set include_descendants=true	Returns all descendants of the specified parent

Additional filters

Parameter	Description
query	Performs a case-insensitive substring search on organisation display_name
ids	May be provided alone (without any other query parameters) to fetch an explicit list of organisations by ID

get/v2/organisations

Request

Base URL
https://api.cautio.in (the document declares no server; this is the origin it was published from)
Auth
HTTP bearer

Query parameters

limitnumber

Example:10

Number of items per page

pagenumber

Example:1

Page number

querystring

Search query

parent_idstring

Example:a9a7e4e8-3e4b-4b1a-8e4a-4a2a4a2a4a2a

Parent organisation id. If omitted, returns effective roots.

include_descendantsboolean

Include descendants

false (default)
- No parent_id: return root organisations only.
- With parent_id: return direct children only.
true
- No parent_id: return all organisations accessible under the user's root organisations.
- With parent_id: return all descendants of the specified parent organisation.

include_ancestorsboolean

Populate visible ancestor chain for each returned organisation

idsstring[]

List of organisation IDs to fetch. If present, parent_id is ignored.

[
  "a9a7e4e8-3e4b-4b1a-8e4a-4a2a4a2a4a2a"
]

Response

List of organisations

Example response

{
  "items": [
    {
      "id": "a9a7e4e8-3e4b-4b1a-8e4a-4a2a4a2a4a2a",
      "display_name": "Cautio",
      "parent_id": "a9a7e4e8-3e4b-4b1a-8e4a-4a2a4a2a4a2a",
      "path": [
        {
          "id": "a9a7e4e8-3e4b-4b1a-8e4a-4a2a4a2a4a2a",
          "display_name": "Cautio",
          "parent_id": "a9a7e4e8-3e4b-4b1a-8e4a-4a2a4a2a4a2a"
        }
      ]
    }
  ],
  "pagination": {
    "page": 1,
    "limit": 10,
    "total": 100,
    "has_next": true
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.