HomeGuidesRecipesAPI ReferencePython SDK
Alation Help Center
API Reference

Bulk Read Custom Fields

This endpoint can be used to list all Custom Fields. Deleted Custom Fields are ignored.

Query Params
boolean
Defaults to false

Filter by allow_multiple. Only used when field_type is OBJECT_SET.

string

Filter by field_type.

integer
≥ 1

Filter by Custom Field ID. Multiple IDs can be specified using the format ?id=3&id=4.

integer
≥ 1
Defaults to 100

The number of items to return.

string
length ≤ 255

Filter by an exact match on name_plural.

string
length ≤ 255

Filter by a case-sensitive substring on name_plural.

string
length ≤ 255

Filter by a case-insensitive substring on name_plural.

string
length ≤ 255

Filter by an exact match on name_singular.

string
length ≤ 255

Filter by a case-sensitive substring on name_singular.

string
length ≤ 255

Filter by a case-insensitive subsring on name_singular.

integer
Defaults to 0

The number of items to skip.

string

Sort by a specified property:

  • field_type - Ordering: TEXT, DATE, PICKER, OBJECT_SET, RICH_TEXT, MULTI_PICKER
  • -field_type - Ordering: MULTI_PICKER, RICH_TEXT, OBJECT_SET, PICKER, DATE, TEXT
  • id - Ascending by id
  • -id - Descending by id
  • name_plural - A to Z, by name_plural
  • -name_plural - Z to A, by name_plural
  • name_singular - A to Z, by name_singular
  • -name_singular - Z to A, by name_singular
string
length ≤ 255

Filter by an exact match on tooltip_text.

string
length ≤ 255

Filter by a case-sensitive substring on tooltip_text.

string
length ≤ 255

Filter by a case-insensitive substring on tooltip_text.

string

A comma-separated sub-set of properties to select for each item.

Responses

Language
Credentials
URL
Choose an example:
application/json