Query parameters

• page number

  Maximum value is 1000. Default value is 1.

• perPage number

  Maximum value is 100. Default value is 10.

• skip number

  Takes precedence over page/perPage when provided. Mutually exclusive with page in practice: nextPage/previousPage track page, so they are meaningless when paging by skip.

  Maximum value is 100000.

• limit number

  Takes precedence over perPage when provided.

  Maximum value is 100.

• sortOrder string

  Values are asc or desc. Default value is desc.

• searchText string

  Case-insensitive partial match on organization name, slug, or email. Does not match users.

  Minimum length is 1, maximum length is 100.

• sortBy string

  Values are createdAt, updatedAt, or name. Default value is createdAt.

• isActive boolean

  Filter by the ORGANIZATION's active state. Does not filter the nested users.

Responses

• 200 application/json
  Hide response attributes Show response attributes object

  • data object Required
    Hide data attributes Show data attributes object

    • total number Required
    • page number
    • perPage number
    • skip number
    • limit number
    • totalPages number Required
    • nextPage number | null Required
    • previousPage number | null Required
    • data array[object]
      Hide data attributes Show data attributes object

      • createdAt string(date-time) Required
      • updatedAt string(date-time) Required
      • id string Required
      • name string Required
      • slug string Required
      • isActive boolean Required
      • users array[object] Required

        Members of this organization, excluding claimable placeholder accounts and memberships whose user no longer exists. An empty array therefore means "no listable members", not necessarily "no memberships".

        Hide users attributes Show users attributes object

        • id string Required
        • name string Required
        • email string Required
        • role string Required

          Values are user, client, employee, billing, full_access, admin, owner, or member.

        • isActive boolean Required
      • membershipCount number Required

        Total memberships for this organization, counted before truncation and before claimable/deleted users are filtered out. Always >= users.length.

      • hasMoreUsers boolean Required

        True when this organization has more memberships than the response cap and users was truncated. For the full member list use GET /admin/user?organizationId=&skip=0&limit=100 — page it with skip/limit rather than page/perPage, and note that endpoint does not exclude claimable accounts.

  • statusCode number Required
  • timestamp string(date-time) Required