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

# GET /api/custom_demographics

`GET /api/custom_demographics`

## Request

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

Retrieve or search custom demographics 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` CustomPatientFieldType[]: result data
    - `archived` boolean: Indicates that the object has been soft-deleted, and should not be used
    - `description` string
    - `doctor` integer, required
    - `template_name` string: Custom Patient Demographics with `template_name` set can be inserted into clinical notes via Form Builder. Only letters (a-z or A-Z), numbers (0-9) or underscore(_) are allowed for template name.
    - `allowed_values` string: Allowed values if needed. Values must be separated by comma `,`
    - `id` integer
    - `name` string, required
  - `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)