Skip to main content

Get all Custom API Entries

GET 

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

Get all Custom API Entries

Filtering

The following operators and attributes are available for filtering all Custom API Entries:

AttributeOperatorsExample
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)

The following operators and attributes may be available for filtering Custom API Entries depending on how the Custom Fields for that Custom API are configured.

Field typeOperators
stringlt,le,eq,gt,ge,in,like
integerlt,le,eq,gt,ge,in
floatlt,le,gt,ge,in
booleaneq

Given there is a Custom Field with "slug": "name" and "field_type": "string".

When you get all Custom API Entries with query parameter: ?filter=like(name,*wish*).

Then you will get all Custom API Entries where name contains the string wish.

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
  • id
  • updated_at

Request

Responses

OK