Custom Fields

/customfields

List custom fields.

Sorted by custom field position as configured in the app.

get/v1/customfields

Request

  • Base URL
    api.air.inc (relative, and the document’s source URL is not known)
  • Auth
    • API key in header x-api-key and API key in header x-air-workspace-id
    • or HTTP bearer and API key in header x-air-workspace-id
  • TypeScript
    A function with typed inputs. Its response is checked against the schema.

Query parameters

namestring

Free text search for custom field names matching criteria

limitstring

The number of records returned

cursorstring

The cursor returned to from previous page of results

sortBy'pos'

Sort custom fields by the specified field. Only pos is supported.

Response

Default

totalinteger

Changes

No recorded changes to this operation across all 2 revisions of this API.