organizations

Get an active organization

Returns a single active CRM organization by ID. Requires CRM to be available for the target clinic and organization access to be granted by Ritten.

get/organizations/{id}

Request

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

Path parameters

idstring uuid required

Organization ID.

Response

success

idstring uuid
namestring
typeIdstring uuid

Organization type ID.

assignedUserIdstring uuid

User assigned to the organization, if any.

websitestring uri

Organization website URL.

createdAtstring date-time

Example response

{
  "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.