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:

Attribute	Operators	Example
name	eq,like	eq(name,"Wishlist")
description	eq,like	like(description,*list*)
slug	eq,like,in	like(slug,*lists)
api_type	eq,like,in	like(api_type,wishlist*)
id	lt,le,eq,gt,ge,in	eq(id,7e067539-6f6c-46e1-8c55-940031b36c6a)
created_at	lt,le,eq,gt,ge	ge(created_at,2024-04-29T00:00:00.000Z)
updated_at	lt,le,eq,gt,ge	le(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: <= 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

200

OK

application/json

Schema

Schema

data CustomApiAttributes[]required
Array [
iduuid
The unique identifier for the Custom API.
typestring
Specifies the type of the resource object, use custom_api for Custom APIs.
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
selfuri
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.
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
currenturirequired
Always the current page.
Example: /v2/settings/custom-apis?page[offset]=0&page[limit]=100
firsturirequired
Always the first page.
Example: /v2/settings/custom-apis?page[offset]=0&page[limit]=100
lasturirequired
Always null if there is only one page.
Example: /v2/settings/custom-apis?page[offset]=0&page[limit]=100
nextstring | nullrequired
Always null if there is only one page.
Example: null
prevstring | nullrequired
Always null if the user is on the first page.
Example: null

Example (auto)

{
  "data": [
    {
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "type": "string",
      "name": "string",
      "description": "string",
      "slug": "string",
      "api_type": "string",
      "allow_upserts": false,
      "links": {
        "self": "/settings/extensions/custom-apis/3fa85f64-5717-4562-b3fc-2c963f66afa6"
      },
      "meta": {
        "timestamps": {
          "updated_at": "2017-01-10T11:41:19.244Z",
          "created_at": "2017-01-10T11:41:19.244Z"
        }
      },
      "relationships": {
        "parent_apis": {
          "data": [
            {
              "id": "652e39d8-d613-493e-8c20-fef99ad6327a",
              "type": "custom_api"
            }
          ]
        }
      }
    }
  ],
  "meta": {
    "results": {
      "total": 0
    },
    "page": {
      "limit": 100,
      "offset": 0,
      "current": 1,
      "total": 1
    }
  },
  "links": {
    "current": "/v2/settings/custom-apis?page[offset]=0&page[limit]=100",
    "first": "/v2/settings/custom-apis?page[offset]=0&page[limit]=100",
    "last": "/v2/settings/custom-apis?page[offset]=0&page[limit]=100",
    "next": null,
    "prev": null
  }
}

400

Bad request. The request failed validation.

application/json

Schema

Schema

errors Error[]required
Array [
titlestringrequired
A brief summary of the error.
statusstringrequired
The HTTP response code of the error.
detailstring
Optional additional detail about the error.
]

Example (auto)

{
  "errors": [
    {
      "title": "string",
      "status": "string",
      "detail": "string"
    }
  ]
}

missing-name

Required field missing

{
  "errors": [
    {
      "detail": "Invalid filter: unknown field [version] specified in search filter, allowed fields are [api_type created_at description id name slug updated_at]",
      "status": "400",
      "title": "Bad Request"
    }
  ]
}

500

Internal server error. There was a system failure in the platform.

application/json

Schema

Schema

errors Error[]required
Array [
titlestringrequired
A brief summary of the error.
statusstringrequired
The HTTP response code of the error.
detailstring
Optional additional detail about the error.
]

Example (auto)

{
  "errors": [
    {
      "title": "string",
      "status": "string",
      "detail": "string"
    }
  ]
}

internal-server-error

Internal server error

{
  "errors": [
    {
      "title": "Internal Server Error",
      "status": "500",
      "detail": "there was a problem processing your request"
    }
  ]
}

Authorization: http

name: bearerAuthtype: httpscheme: bearer

• csharp
• curl
• dart
• go
• http
• java
• javascript
• kotlin
• c
• nodejs
• objective-c
• ocaml
• php
• powershell
• python
• r
• ruby
• rust
• shell
• swift

• HTTPCLIENT
• RESTSHARP

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

Bearer Token

Parameters

page[offset] — query

page[limit] — query

filter — query

sort — query

ResponseClear

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