Skip to main content

Get all Custom APIs

GET 

/v2/settings/extensions/custom-apis

Get all Custom APIs

Filtering

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

AttributeOperatorsExample
nameeq,likeeq(name,"Wishlist")
descriptioneq,likelike(description,*list*)
slugeq,like,inlike(slug,*lists)
api_typeeq,like,inlike(api_type,wishlist*)
idlt,le,eq,gt,ge,ineq(id,7e067539-6f6c-46e1-8c55-940031b36c6a)
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.

  • api_type
  • created_at
  • description
  • id
  • name
  • updated_at

Request

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 CustomApiAttributes[]required
  • Array [
  • id uuid

    The unique identifier for the Custom API.

    type string

    Specifies the type of the resource object, use custom_api for Custom APIs.

    name string

    Possible values: non-empty and <= 255 characters

    Specifies the name of this Custom API.

    description string

    Possible values: <= 255 characters

    Specifies the description for this Custom API.

    slug string

    Possible values: Value must match regular expression ^[a-z0-9_-]{1,63}$

    Specifies a unique slug identifier for the Custom API. The API Entries for the created Custom API will be accessible at the location /v2/extensions/<slug>.

    api_type string

    Possible values: Value must match regular expression ^[a-z0-9_]{1,59}_ext$

    Specifies a unique API type for this Custom API. Entries for this API will use this value for their type field. This field must be suffixed with _ext to distinguish it from built in APIs.

    allow_upserts boolean

    Controls whether upsert operations are allowed for Custom API Entries via the PUT method. When set to true, it allows the creation of new Custom API Entries using PUT if the record doesn't exist, and updates the existing record if it does. When false, PUT requests can only update existing entries.

    links object
    self uri

    Specifies the URI of the Custom API.

    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.

    relationships object
    parent_apis objectrequired
    data object[]required
  • Array [
  • id stringrequired

    The unique identifier for the related Custom API. When the type of an object is set to api_location then id must be /v2/extensions. When the type of an object is set to custom_api, then id must be that of a Custom API that results in a relationship that does not have a depth exceeding 2 and does not result in a cycle.

    type stringrequired

    Possible values: [custom_api, api_location]

    Specifies the type of parent relationship, can be custom_api or api_location.

  • ]
  • ]
  • 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...