v1

latestOpenAPI 3.1.02026-08-04164270844.7 KB

Custom Fields

List all 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.

Lists all custom fields in your platform.

get/api/v2/custom-fields

Query parameters

eqstring

Filter on values equal to the given one

nestring

Filter on values not equal to the given one

instring[]

Filter on values including the given ones

ninstring[]

Filter on values excluding the given ones

Filter on name property with LHS bracket notation.

Expected value format is a string.

{
  "eq": "loremIpsum",
  "ne": "loremIpsum",
  "in": [
    "loremIpsum"
  ],
  "nin": [
    "loremIpsum"
  ]
}

eq'users' | 'contents'

Filter on values equal to the given one

ne'users' | 'contents'

Filter on values not equal to the given one

instring[]

Filter on values including the given ones

ninstring[]

Filter on values excluding the given ones

Filter on targetType property with LHS bracket notation.

Expected value format is a string (users, contents).

{
  "eq": "users",
  "ne": "users",
  "in": [
    "users"
  ],
  "nin": [
    "users"
  ]
}

eq'string' | 'date'

Filter on values equal to the given one

ne'string' | 'date'

Filter on values not equal to the given one

instring[]

Filter on values including the given ones

ninstring[]

Filter on values excluding the given ones

Filter on type property with LHS bracket notation.

Expected value format is a string (string, date).

{
  "eq": "string",
  "ne": "string",
  "in": [
    "string"
  ],
  "nin": [
    "string"
  ]
}

Headers

360-api-version'v2.0' required

The version of the API.

Response

Returns one page of 1000 custom fields.

namestring 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.

_idstring ObjectId required

The unique ID of the custom field.

Example response

[
  {
    "name": "Department",
    "_id": "507f1f77bcf86cd799439011"
  }
]