Skip to main content
GET
List compliance custom field definitions with filtering, sorting, and pagination.

Headers

X-Delogue-Api
string

Query Parameters

Free-text search matching the field name or the user-defined identifier.

Ids
integer<int64>[]

Filter to fields with any of the given identifiers.

Names
string[]

Filter to fields matching any of the given exact names.

UserDefinedIds
string[]

Filter to fields matching any of the given user-defined identifiers.

Types
enum<string>[]

Filter to fields of any of the given field types.

Available options:
allowedValue,
date,
text,
nestedAllowedValue,
numeric,
divider
State
enum<string>

Filter to fields in the given lifecycle state. Current lifecycle state of the compliance custom field.

Available options:
active,
inactive,
deleted
IsMandatory
boolean

When true, returns only mandatory fields; when false, returns only non-mandatory fields.

InternalOnly
boolean

When true, returns only internal-only fields; when false, returns only fields visible to suppliers.

ParentCustomFieldId
integer<int64>

Filter to child fields whose parent is the given field. Used to list the children of a nestedAllowedValue parent.

sort
object[]

Repeat the parameter per sort column: sort[0].property=<column>&sort[0].order=Ascending|Descending, sort[1].... for a secondary column. order accepts asc, desc, ascending or descending (case-insensitive) and may also be spelled direction. Mutually exclusive with cursor. Sortable columns include: Id, Name, UserDefinedId, Position, Type.

pageSize

Number of results to return per page. Defaults to 30, maximum 100.

pageNumber

The 1-based page number to return. Defaults to 1.

cursor
string

Opaque keyset pagination token. Mutually exclusive with the filter, sort, pageSize, and pageNumber parameters.

Response

OK

status
enum<string>
required

The coarse outcome of the request, indicating whether it succeeded or failed.

Available options:
success,
error
code
string
required

The specific machine-readable outcome code, such as ok on success or the most specific error code on failure. Always lowercase on the wire.

data
object[]
required

The page of results, always an array. An empty page is an empty array rather than null or an omitted field.

pagination
object
required

Paging metadata for this response, carrying whether more rows remain and the cursor used to request the next page.