---
title: "List contact fields"
method: GET
path: "/v1/sites/{site_id}/contact-fields"
tags: ["Contact fields"]
---

# List contact fields

`GET /v1/sites/{site_id}/contact-fields`

## Request

- Base URL: `https://api.getsitecontrol.com`
- URL: `https://api.getsitecontrol.com/v1/sites/{site_id}/contact-fields`
- Auth: HTTP bearer

Custom contact fields of the site in the admin's order, with their ids, names
and value types. Call it before writing contacts: `fields` of
`upsert_contact`, `upsert_contacts` and `update_contacts` is keyed by these
ids and takes values of these types. System fields such as email or first name
are not listed. Every field comes in one response; the list is never paged.

## Path parameters

- `site_id` integer, required

## Response `200`

Successful Response

- ContactFieldList: One page of a list; `next_cursor` is null on the last page.
  - `items` ContactField[], required
    - `id` string, required: Derived from the name on creation; kept on rename
    - `name` string, required: Display name
    - `type` 'text' | 'integer' | 'number' | 'datetime' | 'date' | 'boolean' | 'other', required: `text`: a string; `integer`: a whole number; `number`: a number, decimals allowed; `datetime`: a moment, ISO 8601 in UTC; `date`: a day, YYYY-MM-DD; `boolean`: true or false; `other`: a field kept from older versions of the admin, read-only on contacts.
    - `created_at` string, date-time, nullable: Null for fields created before the date was recorded
  - `next_cursor` string, nullable: Always null: every field comes in one page

## Other responses

- `400`: Unsupported GSC-Version
- `401`: Missing or invalid API key or access token
- `403`: Access denied
- `404`: Not found
- `422`: Validation failed
- `429`: Rate limited
- `503`: Temporarily unavailable; retry later

---

[API](https://skmtc.dev/getsitecontrol/apis/getsitecontrol-public-api.md) - [All operations](https://skmtc.dev/getsitecontrol/apis/getsitecontrol-public-api/llms.txt) - [OpenAPI document](https://skmtc.dev/getsitecontrol/apis/getsitecontrol-public-api/revisions/084fcad80e75?raw)