Skip to main content

Get all Custom APIs

GET 

https://useast.api.elasticpath.com/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 sorting. 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.

  • name
  • slug
  • api_type
  • id
  • created_at
  • updated_at

Request

Query Parameters

    page[offset] int64

    Possible values: >= 0 and <= 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

    Possible values: >= 0

    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 [
  • idstring<uuid>

    The unique identifier for the Custom API.

    typestring

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

    Constant value: custom_api
    namestring

    Specifies the name of this Custom API.

    Possible values: non-empty and <= 255 characters

    descriptionstring

    Specifies the description for this Custom API.

    Possible values: <= 255 characters

    slugstring

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

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

    api_typestring

    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.

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

    allow_upsertsboolean

    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.

    Default value: false
    links object
    selfstring,null<uri>nullable

    Specifies the URI of the Custom API.

    Example: /settings/extensions/custom-apis/3fa85f64-5717-4562-b3fc-2c963f66afa6
    meta object
    timestamps objectrequired
    updated_atstringrequired

    Specifies the date the entity is created.

    Example: 2017-01-10T11:41:19.244Z
    created_atstringrequired

    Specifies the date the entity is last updated.

    Example: 2017-01-10T11:41:19.244Z
    relationships object
    parent_apis objectrequired
    data object[]required
  • Array [
  • idstringrequired

    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.

    Example: 652e39d8-d613-493e-8c20-fef99ad6327a
    typestringrequired

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

    Possible values: [custom_api, api_location]

  • ]
  • ]
  • meta object
    results objectrequired
    totalinteger

    Total number of results for the entire collection.

    total_methodstring

    The method used to calculate the total number results

    Enum ValueDescription
    exactIndicates that the total is an exact count of results
    lower_boundWhen there are more than 10,000 results, we stop counting at 10,000 and report that the count is a lower_bound.
    observedWill indicate if there is at least one more result past the current page, this is the highest performing option as it doesn't require an extra call.

    Possible values: [exact, lower_bound, observed]

    page objectrequired
    limitinteger

    The maximum number of records for all pages.

    Example: 100
    offsetinteger

    The current offset by number of pages.

    Example: 0
    currentinteger

    The current number of pages.

    Example: 1
    totalinteger

    The total number of records for the entire collection.

    Example: 1
    links object
    currentstring,null<uri>nullablerequired

    Always the current page.

    Example: /v2/settings/custom-apis?page[offset]=0&page[limit]=100
    firststring,null<uri>nullablerequired

    Always the first page.

    Example: /v2/settings/custom-apis?page[offset]=0&page[limit]=100
    laststring,null<uri>nullablerequired

    Always null if there is only one page.

    Example: /v2/settings/custom-apis?page[offset]=0&page[limit]=100
    nextstring | nullnullablerequired

    Always null if there is only one page.

    Example: null
    prevstring | nullnullablerequired

    Always null if the user is on the first page.

    Example: null

Authorization: http

name: bearerAuthtype: httpscheme: bearer
var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Get, "https://useast.api.elasticpath.com/v2/settings/extensions/custom-apis");
request.Headers.Add("Accept", "application/json");
request.Headers.Add("Authorization", "Bearer <token>");
var response = await client.SendAsync(request);
response.EnsureSuccessStatusCode();
Console.WriteLine(await response.Content.ReadAsStringAsync());
Request Collapse all
Base URL
https://useast.api.elasticpath.com
Auth
Parameters
— query
— query
— query
— query
ResponseClear

Click the Send API Request button above and see the response here!