Skip to main content

Get all Custom Fields

GET 

/v2/settings/extensions/custom-apis/:custom_api_id/fields

Get all Custom Fields

Filtering

The following operators and attributes are available for filtering Custom Fields:

AttributeOperatorsExample
nameeq,likeeq(name,"Last Name")
descriptioneq,likelike(description,*confidential*)
slugeq,like,inlike(slug,*private*)
field_typeeq,ineq(field_type,string)
idlt,le,eq,gt,ge,ineq(id,859aeba1-03c2-4822-bd4c-89afce93d7eb)
created_atlt,le,eq,gt,gege(created_at,2024-04-29T00:00:00.000Z)
updated_atlt,le,eq,gt,gele(updated_at,2024-04-29T00:00:00.000Z)

Sorting

The following attributes are available for filtering. When specified, the results are sorted in ascending order based on the value of the field. To sort in descending order, prefix the attribute with -, for example, -updated_at. The default sort order is created_at in descending order.

  • created_at
  • description
  • field_type
  • id
  • name
  • updated_at

Request

Path Parameters

    custom_api_id stringrequired

    The id of the Custom API.

    Example: 3fa85f64-5717-4562-b3fc-2c963f66afa6

Query Parameters

    page[offset] int64

    Possible values: <= 10000

    The current offset by number of records, not pages. Offset is zero-based. The maximum records you can offset is 10,000. If no page size is set, the page length store setting is used.

    page[limit] int64

    The maximum number of records per page for this response. You can set this value up to 100. If no page size is set, the page length store setting is used.

    filter string

    Filter attributes. For more information, see the Filtering section.

    sort string

    Sort attributes, For more information, see the Sorting section.

Responses

OK

Schema
    data object[]required
  • Array [
  • anyOf
    id uuid

    The unique identifier of the Custom Field.

    type string

    Specifies the type of the resource object, use custom_field for Custom Field.

    name string

    Possible values: non-empty and <= 255 characters

    Specifies the name of this Custom Field.

    description string

    Possible values: <= 255 characters

    Specifies the description for this Custom API.

    slug string

    Possible values: non-empty and <= 63 characters

    Specifies a slug that must be unique within the scope of the Custom API. This slug will be value as the key in the JSON Object in all entries.

    field_type string

    Possible values: [string, integer, boolean, float]

    Specifies the type of the field. This field cannot be updated.

    links object
    self uri
    meta object
    timestamps objectrequired
    updated_at stringrequired

    Specifies the date the entity is created.

    created_at stringrequired

    Specifies the date the entity is last updated.

    validation object
    boolean object
    allow_null_values booleannull

    Default value: true

    When set to true, this allows null values for that field on Custom API Entries. When set to false, storing null values is not permitted.

    immutable booleannull

    When set to true, prevents changing the field.

  • ]
  • meta object
    results objectrequired
    total integer

    Total number of results for the entire collection.

    page objectrequired
    limit integer

    The maximum number of records for all pages.

    offset integer

    The current offset by number of pages.

    current integer

    The current number of pages.

    total integer

    The total number of records for the entire collection.

    links object
    current urirequired

    Always the current page.

    first urirequired

    Always the first page.

    last urirequired

    Always null if there is only one page.

    next stringnullrequired

    Always null if there is only one page.

    prev stringnullrequired

    Always null if the user is on the first page.

Loading...