---
title: "List all custom fields"
method: GET
path: "/api/v2/custom-fields"
tags: ["Custom Fields"]
---

# List all custom fields

`GET /api/v2/custom-fields`

> 🔑
>
> Required OAuth scope: `customFields:read`.

> 📖
>
> This endpoint is paginated with a page size of 1,000 custom fields. For more information, see the [Pagination guide](https://360learning.readme.io/docs/pagination).

Lists all custom fields in your platform.

## Query parameters

- `name` object
  - `eq` string — Filter on values equal to the given one
  - `ne` string — Filter on values not equal to the given one
  - `in` string[] — Filter on values including the given ones
  - `nin` string[] — Filter on values excluding the given ones
- `targetType` object
  - `eq` 'users' | 'contents' — Filter on values equal to the given one
  - `ne` 'users' | 'contents' — Filter on values not equal to the given one
  - `in` string[] — Filter on values including the given ones
  - `nin` string[] — Filter on values excluding the given ones
- `type` object
  - `eq` 'string' | 'date' — Filter on values equal to the given one
  - `ne` 'string' | 'date' — Filter on values not equal to the given one
  - `in` string[] — Filter on values including the given ones
  - `nin` string[] — Filter on values excluding the given ones

## Headers

- `360-api-version` 'v2.0', required

## Response `200`

Returns one page of 1000 custom fields.

- CustomFieldDTO[]
  - `name` string, required — The name of the custom field.
  - `targetType` 'users' | 'contents', required — The resource type to which the custom field is linked.
  - `type` 'string' | 'date', required — The type of the custom field.
  - `_id` string, ObjectId, required — The unique ID of the custom field.

## Other responses

- `401` — The given access token is either missing, invalid, has expired, or has been revoked.
- `403` — The given access token does not have the required OAuth scope to execute the request.
- `429` — The client has sent too many requests in a short amount of time.

---

[API](https://skmtc.net/360learning/apis/core-api.md) · [All operations](https://skmtc.net/360learning/apis/core-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/360learning/core-api/revisions/94b691b0b72c/schema)