v2

latestOpenAPI 3.0.32026-08-07222102695.9 KB

Contact

Get contact

get/contacts/{id}

Path parameters

idstring int64 required

Query parameters

q[]string[]

Filter result by one or more fields.

See Filtering Results

Available filters:

Value	Format
archived_at	date-time
deleted_at	date-time

Response

Successful operation

address_1string nullable

address_2string nullable

address_3string nullable

archived_atstring date-time nullable

citystring nullable

company_namestring nullable

countrystring nullable

country_codestring nullable

ISO 3166-1 country code

created_atstring date-time

deleted_atstring date-time nullable

doctor_type'general_practitioner' | 'specialist' nullable

emailstring nullable

first_namestring nullable

idstring int64

last_namestring nullable

notesstring nullable

occupationstring nullable

post_codestring nullable

preferred_namestring nullable

provider_numberstring nullable

statestring nullable

titlestring nullable

type'Doctor' | '3rd Party Payer' | 'Standard' nullable

type_code0 | 1 | 2

updated_atstring date-time

Example response

{
  "country_code": "AU",
  "links": {
    "self": "https://api.au1.cliniko.com/v1/contacts/1"
  },
  "phone_numbers": [
    {
      "normalized_number": "39012345678",
      "number": "0-123-456-78"
    }
  ]
}