contacts

List contacts in a clinic

Lists contacts in a clinic

get/contacts

Request

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

Query parameters

limitinteger

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

offsetinteger

How many contacts to skip before returning the limit number of contacts. Use this to page.

Response

success

idstring
firststring
middlestring
laststring
dobstring

Date of birth

mrnstring

Ritten Medical Record Number (if applicable)

emailstring

The contact's primary email address. Falls back to their most recently added email when none is marked primary, and is omitted when they have none.

createdAtstring date-time

Contact record creation timestamp.

Example response

[
  {
    "id": "182c2e54-3494-4b85-aba5-038cf539d5bf",
    "first": "John",
    "last": "Doe",
    "dob": "1990-02-23",
    "email": "john@example.com",
    "createdAt": "2024-01-01T00:00:00Z",
    "organizations": [
      {
        "id": "9a5e64b0-0a73-4cb5-ab32-44fea16da4e1",
        "name": "Sunrise Recovery Center",
        "relationshipType": "member"
      }
    ]
  }
]

Changes

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