---
title: "GET /v1/custom-fields"
method: GET
path: "/v1/custom-fields"
tags: ["Custom Fields"]
---

# GET /v1/custom-fields

`GET /v1/custom-fields`

## Request

- Base URL: `https://api.relaticle.com`
- URL: `https://api.relaticle.com/v1/custom-fields`
- Auth: HTTP bearer

## Request body

- object
  - `entity_type` 'company' | 'people' | 'opportunity' | 'task' | 'note'
  - `per_page` integer: Must be at least 1. Must not be greater than 100.
  - `page` integer: Must be at least 1. Must not be greater than 1000000.

## Response `200`

- object
  - `data` object[]
    - `id` string
    - `type` string
    - `attributes` object
      - `code` string
      - `name` string
      - `type` string
      - `entity_type` string
      - `required` boolean
      - `unique` boolean
      - `created_at` string
      - `updated_at` string
  - `links` object
    - `first` string
    - `last` string
    - `prev` string, nullable
    - `next` string, nullable
  - `meta` object
    - `current_page` integer
    - `from` integer
    - `last_page` integer
    - `links` object[]
      - `url` string, nullable
      - `label` string
      - `page` string, nullable
      - `active` boolean
    - `path` string
    - `per_page` integer
    - `to` integer
    - `total` integer

## Other responses

- `401`: Missing or invalid access token.
- `402`: Relaticle Cloud only: the workspace is paused until it has an active subscription. The body carries an `upgrade_url`.
- `403`: The token lacks the `read` ability, or its user no longer belongs to the token's workspace.
- `429`: Rate limit exceeded. Back off for the number of seconds in `Retry-After`.

---

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