List integrations

GET 
https://euwest.api.elasticpath.com/integrations

Returns a list of all integrations created by the store.

Responses

200

Success. All integrations are returned.

application/json

Schema

Schema

dataobject[]
links object
links object
Links are used to allow you to move between requests.
selfuri
Single entities use a self parameter with a link to that specific resource.
Example: ?page[offset]=0&page[limit]=25
meta object
meta object
timestamps Timestamps
The date and time a transaction is created.
created_atdate-time
The date and time an integration is updated.
Example: 2017-07-21T17:32:28Z
updated_atdate-time
The date and time an integration is updated.
Example: 2017-07-21T17:32:28Z

Example (auto)

{
  "data": [
    {
      "id": "2da46671-b4c2-44ac-b133-d1221aafc77b",
      "type": "integration",
      "name": "Order shipping notification",
      "description": "Send a shipping notification via email with discount code",
      "enabled": true,
      "integration_type": "webhook",
      "observes": [
        "string"
      ],
      "configuration": {
        "url": "https://sqs.eu-west-1.amazonaws.com/123456789/epcc-external-queue",
        "aws_access_key_id": "****************JIMB",
        "aws_secret_access_key": "************************************HK4o",
        "region": "eu-west-1"
      },
      "links": {
        "self": "?page[offset]=0&page[limit]=25"
      },
      "meta": {
        "timestamps": {
          "created_at": "2017-07-21T17:32:28Z",
          "updated_at": "2017-07-21T17:32:28Z"
        }
      }
    }
  ],
  "links": {
    "links": {
      "self": "?page[offset]=0&page[limit]=25"
    }
  },
  "meta": {
    "meta": {
      "timestamps": {
        "created_at": "2017-07-21T17:32:28Z",
        "updated_at": "2017-07-21T17:32:28Z"
      }
    }
  }
}

500

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

application/json

Schema

Schema

errors ErrorBody[]required
Array [
statusint
The HTTP response code of the error.
Example: 500
titlestringrequired
A brief summary of the error.
Example: Internal server error
detailstring
Optional additional detail about the error.
Example: An internal error has occurred.
]

Example (auto)

{
  "errors": [
    {
      "status": 500,
      "title": "Internal server error",
      "detail": "An internal error has occurred."
    }
  ]
}

internal-server-error

{
  "errors": [
    {
      "title": "Internal Server Error",
      "status": 500
    }
  ]
}

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://euwest.api.elasticpath.com/integrations");
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://euwest.api.elasticpath.com

Auth

Bearer Token

ResponseClear

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