Get Custom Fields

get

https://api.zylo.com/v2/customFields

Required Permissions

admin

Rate Limit

basic

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

description

string

The custom field description.

entity_type

string

enum

The type of entity this custom field applies to. Defaults to applications.

Allowed:

string

[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-4[0-9A-Fa-f]{3}-[89ABab][0-9A-Fa-f]{3}-[0-9A-Fa-f]{12}

Unique identifier for a custom field.

is_enabled

boolean

Indicates whether the custom field is enabled or not.

name

string

The custom field name.

type

string

enum

The type of the custom field.

zylo_created_at

string

^^([0-9]{4}-[0-9]{2}-[0-9]{2}(,(gt|gte),[0-9]{4}-[0-9]{2}-[0-9]{2},(lt|lte)))$|^([0-9]{4}-[0-9]{2}-[0-9]{2}(,(lt|gt|gte|lte)))$

Date and time the record was created in Zylo.

zylo_modified_at

string

^^([0-9]{4}-[0-9]{2}-[0-9]{2}(,(gt|gte),[0-9]{4}-[0-9]{2}-[0-9]{2},(lt|lte)))$|^([0-9]{4}-[0-9]{2}-[0-9]{2}(,(lt|gt|gte|lte)))$

Date and time the record was last modified in Zylo. Uses the created date by default.

sort

string

Defaults to +zylo_created_at

Sort by any non-object or array value. Use +/- to indicate direction.

limit

double

≤ 1000

Defaults to 50

Number of results to bring back.

skip

double

Defaults to 0

Offset the results by this number.

cursor

string

id value to use cursor based pagination. Can be used in place of skip.

string

Search the results by this string.

Response

Language

Credentials

Bearer

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Ok