programs

List active programs in a clinic

Lists active clinic programs with pagination and optional filters. Archived programs are never returned by the external API.

get/programs

Request

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

Query parameters

facilityIdstring uuid

Filter programs by active facility ID.

programType'Clinical' | 'Additional Service'

Filter programs by type.

searchstring

Case-insensitive search on program name.

limitinteger

How many programs to return at one time (max 200).

offsetinteger

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

Response

success

Example response

{
  "meta": {
    "count": 1,
    "totalCount": 10
  },
  "programs": [
    {
      "id": "182c2e54-3494-4b85-aba5-038cf539d5bf",
      "name": "Residential",
      "createdAt": "2024-01-01T00:00:00Z"
    }
  ]
}

Changes

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