organizations

List active organizations in a clinic

Lists active CRM organizations with pagination and optional filters. Requires CRM to be available for the target clinic and organization access to be granted by Ritten.

get/organizations

Request

  • Base URL: https://api.ritten.io/v1
  • URL: https://api.ritten.io/v1/organizations
  • Auth: none declared

Query parameters

searchstring

Case-insensitive search on organization name.

organizationTypeIdsstring[]

Filter by one or more organization type IDs.

assignedUserIdsstring[]

Filter by one or more assigned user IDs.

tagIdsstring[]

Filter by one or more tag IDs.

matchAllTagsboolean

When true, only return records that have ALL selected tags (AND). Default false returns records matching ANY selected tag (OR).

sortBy'name_asc' | 'name_desc' | 'createdAt_asc' | 'createdAt_desc'

Sort order for returned organizations.

limitinteger

How many organizations to return at one time (max 20).

offsetinteger

How many organizations to skip before returning results. Use for pagination.

Response

success

Example response

{
  "meta": {
    "count": 1,
    "totalCount": 10
  },
  "organizations": [
    {
      "name": "Ritten Recovery Center",
      "website": "https://example.com",
      "createdAt": "2024-01-01T00:00:00Z"
    }
  ]
}

Changes

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