# Appointment Types

Dr.Online catalog — consultation types for your credential (GET only; name, price, and duration are managed by Dr.Online)

## GET /connected/appointment\_types

>

```json
{"openapi":"3.2.0","info":{"title":"Dr.Online Connected API","version":"2026-05-29"},"tags":[{"name":"Appointment Types","summary":"Appointment Types","description":"Dr.Online catalog — consultation types for your credential (GET only; name, price, and duration are managed by Dr.Online)"}],"servers":[{"url":"http://localhost:3001/v1","description":"Live (production credentials)"},{"url":"http://localhost:3001/v1","description":"Sandbox (non-production credentials)"}],"security":[{"bearerAuth":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","description":"Connected API secret key from the credential reveal flow (`sk_live_…` or `sk_sandbox_…`). Each key is tied to one Dr.Online catalogue. Server-to-server only: `Authorization: Bearer <secret_key>`."}}},"paths":{"/connected/appointment_types":{"get":{"operationId":"partnerV1ListAppointmentTypes","tags":["Appointment Types"],"parameters":[{"schema":{"type":"string","enum":["en","pt"]},"in":"query","name":"locale","required":false,"description":"Request services in this language. When omitted, the default for the request context is used (e.g. widget language in the booking system, app default elsewhere)."}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"object":{"type":"string","enum":["list"]},"url":{"type":"string","description":"Canonical collection path for this list (query parameters omitted)."},"has_more":{"type":"boolean","description":"{\"example\":false}"},"data":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"Appointment type id from `GET /connected/appointment_types`"},"object":{"type":"string","enum":["appointment_type"]},"appointment_type_id":{"type":"string","description":"Appointment type id from `GET /connected/appointment_types`"},"available_contact_types":{"type":"array","items":{"type":"string","enum":["phone_call","video_call","in_person"]},"description":"{\"example\":[\"video_call\",\"phone_call\"]}"},"booking_channel_id":{"type":"string","nullable":true,"description":"Reserved. Always `null` on Connected API resources — catalogue scope is fixed per API credential."},"currency":{"type":"string","enum":["GBP","EUR","USD"],"description":"{\"example\":\"GBP\"}"},"description":{"type":"string","nullable":true},"duration_minutes":{"type":"number","description":"{\"example\":15}"},"metadata":{"type":"object","additionalProperties":{"type":"string","maxLength":500},"description":"Partner-owned key-value strings. Keys cannot start with \"dronline\". Only keys you set are returned; Dr.Online may store other fields internally.","default":{}},"name":{"type":"string","description":"{\"example\":\"GP video consultation\"}"},"price_in_cents":{"type":"integer","minimum":0,"description":"List price in minor currency units (see `GET /account` `currency`)"}},"required":["id","object","appointment_type_id","available_contact_types","booking_channel_id","currency","description","duration_minutes","name","price_in_cents"],"additionalProperties":false}}},"required":["object","url","has_more","data"],"additionalProperties":false}}}}}}}}}
```

## GET /connected/appointment\_types/{appointment\_type\_id}

>

```json
{"openapi":"3.2.0","info":{"title":"Dr.Online Connected API","version":"2026-05-29"},"tags":[{"name":"Appointment Types","summary":"Appointment Types","description":"Dr.Online catalog — consultation types for your credential (GET only; name, price, and duration are managed by Dr.Online)"}],"servers":[{"url":"http://localhost:3001/v1","description":"Live (production credentials)"},{"url":"http://localhost:3001/v1","description":"Sandbox (non-production credentials)"}],"security":[{"bearerAuth":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","description":"Connected API secret key from the credential reveal flow (`sk_live_…` or `sk_sandbox_…`). Each key is tied to one Dr.Online catalogue. Server-to-server only: `Authorization: Bearer <secret_key>`."}}},"paths":{"/connected/appointment_types/{appointment_type_id}":{"get":{"operationId":"partnerV1GetAppointmentType","tags":["Appointment Types"],"parameters":[{"schema":{"type":"string","enum":["en","pt"]},"in":"query","name":"locale","required":false,"description":"Request services in this language. When omitted, the default for the request context is used (e.g. widget language in the booking system, app default elsewhere)."},{"schema":{"type":"string"},"in":"path","name":"appointment_type_id","required":true,"description":"Appointment type id from `GET /connected/appointment_types`"}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","description":"Appointment type id from `GET /connected/appointment_types`"},"object":{"type":"string","enum":["appointment_type"]},"appointment_type_id":{"type":"string","description":"Appointment type id from `GET /connected/appointment_types`"},"available_contact_types":{"type":"array","items":{"type":"string","enum":["phone_call","video_call","in_person"]},"description":"{\"example\":[\"video_call\",\"phone_call\"]}"},"booking_channel_id":{"type":"string","nullable":true,"description":"Reserved. Always `null` on Connected API resources — catalogue scope is fixed per API credential."},"currency":{"type":"string","enum":["GBP","EUR","USD"],"description":"{\"example\":\"GBP\"}"},"description":{"type":"string","nullable":true},"duration_minutes":{"type":"number","description":"{\"example\":15}"},"metadata":{"type":"object","additionalProperties":{"type":"string","maxLength":500},"description":"Partner-owned key-value strings. Keys cannot start with \"dronline\". Only keys you set are returned; Dr.Online may store other fields internally.","default":{}},"name":{"type":"string","description":"{\"example\":\"GP video consultation\"}"},"price_in_cents":{"type":"integer","minimum":0,"description":"List price in minor currency units (see `GET /account` `currency`)"}},"required":["id","object","appointment_type_id","available_contact_types","booking_channel_id","currency","description","duration_minutes","name","price_in_cents"],"additionalProperties":false}}}}}}}}}
```


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.dronline.uk/connected-api/appointment-types.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
