---
title: "GET /api/custom_appointment_fields"
method: GET
path: "/api/custom_appointment_fields"
tags: ["Clinical"]
---

# GET /api/custom_appointment_fields

`GET /api/custom_appointment_fields`

## Request

- Base URL: `https://app.drchrono.com`
- URL: `https://app.drchrono.com/api/custom_appointment_fields`
- Auth: OAuth 2
  - Authorization code: `https://app.drchrono.com/o/authorize/`
  - Token URL: `https://app.drchrono.com/o/token/` scopes: `clinical:read`, `clinical:write`, `settings:read`, `settings:write`

Retrieve or search custom appointment fields

## Query parameters

- `cursor` string: The pagination cursor value.
- `page_size` integer: Number of results to return per page.
- `doctor` integer

## Response `200`

OK

- object: Paginated Result
  - `previous` string: Previous paginated page
  - `data` CustomAppointmentFieldType[]: result data
    - `archived` boolean: Indicates that the object has been soft-deleted and should not be used
    - `doctor` string
    - `created_at` string
    - `updated_at` string
    - `order` integer: displayed order in patient's demographic page
    - `field_desc` string: Description of the custom field
    - `field_name` string
    - `id` integer
  - `next` string: Next Paginated page

## Other responses

- `400`: Bad Request
- `401`: Unauthorized
- `403`: Permission Denied
- `404`: Not Found
- `405`: Method Not Allowed
- `500`: Internal Server Error

---

[API](https://skmtc.dev/drchrono/apis/drchrono-api.md) - [All operations](https://skmtc.dev/drchrono/apis/drchrono-api/llms.txt) - [OpenAPI document](https://skmtc.dev/drchrono/apis/drchrono-api/revisions/98cabe79d150?raw)