Skip to main content

List suborganizations​

Retrieve a list of all descendant organizations.

Query Parameters
  • filter string

    A filter to be applied to the result list, using the SCIM 2.0 Filter syntax.

    Example (org_name_eq): name eq "my_org"
    Example (org_name_co): name co "some_str"
    Example (org_name_sw): name sw "my_prefix"
    Example (org_id_eq): id eq "0be15c7a-a72d-47c4-ab9a-9a88bac3416d"
    Example (parent_org_id_eq): parent_org_id eq "0be15c7a-a72d-47c4-ab9a-9a88bac3416d"
Header Parameters
  • SlashID-OrgID string required

    The organization ID

    Example: af5fbd30-7ce7-4548-8b30-4cd59cb2aba1
Responses

OK

Schema
  • meta object
  • pagination object
  • limit integer
  • offset integer
  • total_count int64
  • cursor_pagination object

    Cursors are opaque. Follow the tokens the server returns; never construct, parse or modify one.

  • limit integer
  • next_cursor string

    Opaque token addressing the next page. Absent on the last page.

  • prev_cursor string

    Opaque token addressing the previous page. Absent on the first page.

  • last_cursor string

    Opaque token addressing the final page directly, so a client can jump to the end without a total count.

  • total_count int64

    Total number of matching items. Returned on the FIRST page only; clients cache it for the remainder of the walk.

  • errors object[]
  • httpcode integer
  • message string
  • result string[]