Sign in

v2

latestOpenAPI 3.0.32026-08-07222102695.9 KB
Relationship

Get relationship

get/relationships/{id}

Path parameters

idstring int64 required

Query parameters

q[]string[]

Filter result by one or more fields.

See Filtering Results

Available filters:

ValueFormat
archived_atdate-time

Response

Successful operation

archived_atstring date-time nullable
created_atstring date-time
idstring int64
relation10 | 20 | 30 | 40 | 50 | 60 | 70 nullable
relation_description'Parent' | 'Child' | 'Sibling' | 'Spouse' | 'Partner' | 'Relative' | 'Other' nullable
updated_atstring date-time

Example response

{
  "links": {
    "self": "https://api.au1.cliniko.com/v1/relationships/1"
  },
  "patient": {
    "links": {
      "self": "https://api.au1.cliniko.com/v1/patients/1"
    }
  },
  "related_patient": {
    "links": {
      "self": "https://api.au1.cliniko.com/v1/patients/1"
    }
  }
}