---
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`

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.net/drchrono/apis/untitled-api.md) · [All operations](https://skmtc.net/drchrono/apis/untitled-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/drchrono/untitled-api/versions/e595797fe800/schema)