---
title: "Get leads fields list"
method: GET
path: "/crm/v1/entities/leads/fields"
tags: ["items"]
---

# Get leads fields list

`GET /crm/v1/entities/leads/fields`

## Request

- Base URL: `https://{domain}.uspacy.ua`
- URL: `https://{domain}.uspacy.ua/crm/v1/entities/leads/fields`
- Auth: HTTP bearer
- TypeScript: <https://skmtc.dev/uspacy/apis/crm-service-2/docs/crm/v1/entities/leads/fields/get.ts> (a function with typed inputs; its response is checked against the schema)

Returns the list of all fields configured for the leads entity.

## Response `200`

Successful response

- Field[]
  - `name` string
  - `code` string
  - `required` boolean
  - `editable` boolean
  - `show` boolean
  - `hidden` boolean
  - `multiple` boolean
  - `fieldSectionId` integer
  - `default_value` string
  - `tooltip` string
  - `type` string
  - `entity_reference_id` integer
  - `sort` integer

## Other responses

- `401`: Access token is missing or invalid

---

[API](https://skmtc.dev/uspacy/apis/crm-service-2.md) - [All operations](https://skmtc.dev/uspacy/apis/crm-service-2/llms.txt) - [OpenAPI document](https://skmtc.dev/uspacy/apis/crm-service-2/revisions/f80578d43845?raw)