Custom Field

Search resources by custom field

Return permission-filtered resource IDs matching an indexed custom-field predicate.

post/v1/custom-fields/search

Request

Base URL: https://example.com/api
URL: https://example.com/api/v1/custom-fields/search
Auth: OAuth 2 (authorization code, authorization URL /oauth/authorize, token URL /oauth/token; client credentials, token URL /oauth/token; password, token URL /oauth/token, scopes: custom_field.read)

definition_idstring required

op'eq' | 'gt' | 'gte' | 'lt' | 'lte' | 'match' required

textstring

integerinteger

decimalstring

booleanboolean

datestring date

datetimestring date-time

urlstring

option_keystring

user_idstring

resource_idstring

limitinteger

resource_idsstring[] required