---
title: "Fetching a list of Custom Fields"
method: GET
path: "/custom_fields"
tags: ["Custom Fields"]
---

# Fetching a list of Custom Fields

`GET /custom_fields`

## Request

- Base URL: `https://api.mavenlink.com/api/v1`
- URL: `https://api.mavenlink.com/api/v1/custom_fields`
- Auth: none declared

Returns all Custom Fields, unless filter parameters have been applied.

This endpoint returns structured Custom Field objects.
As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the `results` array
and will be indexed by ID in the `custom_fields` top-level JSON key.
Please see our [Response Format](#section/Response-Format) section for more information.

## Query parameters

- `created_after` string, date-time
- `created_before` string, date-time
- `external_reference_external_message` string
- `external_reference_external_status` string
- `external_reference_service_model` string
- `external_reference_service_model_ref` integer
- `external_reference_service_model_refs` string
- `external_reference_service_name` string
- `external_reference_status` string
- `has_external_references` boolean
- `include` string
- `matching` string
- `only` string
- `order` string
- `page` integer
- `per_page` integer
- `subject_type` string
- `updated_after` string, date-time
- `updated_before` string, date-time
- `without_external_reference_service_name` string

## Response `200`

A list of Custom Fields have been retrieved.

- object
  - `count` integer
  - `meta` object
    - `count` integer
    - `page_count` integer
    - `page_number` integer
    - `page_size` integer
  - `results` object[]
    - `key` string
    - `id` string
  - `custom_fields` object
  - `external_references` object
  - `users` object
  - `custom_field_choices` object
  - `custom_field_sets` object

## Other responses

- `400`: Bad Request
- `401`: Unauthorized request
- `403`: Forbidden request
- `404`: Page Not Found
- `422`: Unprocessable Entity
- `503`: Service is unavailable

---

[API](https://skmtc.dev/kantata/apis/kantata-ox-api-documentation.md) - [All operations](https://skmtc.dev/kantata/apis/kantata-ox-api-documentation/llms.txt) - [OpenAPI document](https://skmtc.dev/kantata/apis/kantata-ox-api-documentation/revisions/9d4ebed2fa98?raw)