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

# Get Custom Fields

`GET /custom_fields`

Get a list of custom fields scoped by the query parameters.

## Query parameters

- `id` string — Custom Field ID.
- `organizationId` string — Organization ID. A lack of this property will look for all custom fields in the account, both account scoped and organization scoped.
- `cursor` string — Cursor for start of next set of items. Pass whatever you receive from the response to get the next elements in the array.
- `limit` number — Limit of items per page.

## Response `200`

Returns a list of agents that match the query parameters.

- object
  - `items` CustomField[], required — List of custom fields that match the specified filter.
    - `id` string, required — The ID of the custom field.
    - `type` 'custom_field', required — The type of object the attached ID corresponds to.
    - `name` string, required — The name of the custom field.
    - `agentVisible` boolean, required — Whether the custom field is visible to agents.
    - `organizationId` string — The organization this custom field is scoped to (if any).
    - `createdAt` string, required — An ISO-8601 string representing the date the custom field was created.
  - `cursor` string, nullable, required — Cursor for start of next set of items. If there were no items to return with the last cursor you passed, this will return null.
  - `hasMore` boolean, required — Whether there are more items to load past this cursor.

## Other responses

- `400` — Bad Request
- `401` — Unauthorized
- `404` — Not Found
- `422` — Unprocessable Entity
- `500` — Internal Server Error

---

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