Skip to content

Endpoints

Obtaining information for endpoints in API.

Operations

List of available endpoints

Request

List of endpoints available within the systems. Using the "status" parameter, you can list the approved endpoints, or endpoints pending approval. In default state, without the parameter, the endpoint returns the approved endpoints.

status=pending always returns an empty endpoints list for private access tokens, since pending-approval tracking only applies to tokens associated with a registered add-on service.

Security
shoptetAccessToken or shoptetPrivateApiToken
Query
statusstring

supported values: approved, pending

Example:status=approved
Headers
Content-Typestringrequired
Default:"application/json"
curl -i -X GET \
  'https://api.docs.shoptet.com/_mock/shoptet-api/openapi/api/system/endpoints?status=approved' \
  -H 'Content-Type: application/json' \
  -H 'Shoptet-Access-Token: YOUR_API_KEY_HERE'

Responses

OK

Bodyapplication/json
dataobjectrequired
errorsArray of objects or null(Errors)required
metadataobject(Metadata)required
Response
{
  "data": {
    "endpoints": [ … ]
  },
  "errors": [
    { … }
  ],
  "metadata": {
    "requestId": "019c8c34-64f3-7328-af43-bf1e34fa39d7"
  }
}