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

# Get custom fields

`GET /custom-fields/fields`

REQUIRED SCOPES <code>['custom-fields:read']</code><br>This API request returns the entire collection of custom fields that are available for use in a user`s account. <br><br>The response will contain the names and values of all the custom fields. Choose the number of results per page that you wish to view. <br><br>I addition, the endpoint allows for setting a search filter by field name.

## Query parameters

- `search` string
- `length` string
- `page` string

## Response `200`

OK

- object
  - `data` CustomFieldResource[]
    - `id` integer
    - `organization_id` integer
    - `key` string
    - `name` string
    - `type` string
    - `visible` integer

## Other responses

- `500` — Error

---

[API](https://skmtc.net/salesmessage/apis/salesmessage-public-api.md) · [All operations](https://skmtc.net/salesmessage/apis/salesmessage-public-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/salesmessage/salesmessage-public-api/revisions/e96b3e58b041/schema)