Skip to main content
GET
/
v1
/
subscriptions
Get subscriptions
curl --request GET \
  --url https://external.pleo.io/v1/subscriptions \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "createdAt": "2022-01-01T00:00:00Z",
      "endpointUrl": "https://example.com/webhook",
      "eventTypes": "v1.export-job.created",
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "status": "ACTIVE",
      "updatedAt": "2022-01-10T00:00:00Z",
      "customHeaders": {
        "user": "pass"
      },
      "deletedAt": "2022-01-01T00:00:00Z",
      "deletedBy": "urn:pleo:organisation:12345678-1234-1234-1234-123456789012",
      "endpointAuth": {
        "credentials": {
          "password": "password",
          "token": "token",
          "username": "username"
        },
        "type": "NONE"
      }
    }
  ],
  "pagination": {
    "currentRequestPagination": {
      "parameters": {},
      "after": "<string>",
      "before": "<string>",
      "limit": 123,
      "offset": 123,
      "sortingKeys": [
        "<string>"
      ],
      "sortingOrder": [
        "ASC"
      ]
    },
    "hasNextPage": true,
    "hasPreviousPage": true,
    "endCursor": "<string>",
    "startCursor": "<string>",
    "total": 123
  }
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

​
status
string

Filters subscriptions by status. If the value is null, all subscriptions for the specific event types (registered for the specific company or organisation by the third party application) are returned.

​
event_types
string[]

Filters subscriptions by versioned event types. If the value is null, all subscriptions for the specific event types (registered for the specific company or organisation by the third party application) are returned.

​
before
string

Lower bound of the page of data to return (cannot be used together with [after] or [offset]).

​
after
string

Upper bound of the page of data to return (cannot be used together with [before] or [offset]).

​
offset
integer<int64>

Offset of the page of data to return (cannot be used together with [before] or [after]).

​
limit
integer<int32>

The maximum amount of items to return.

​
sorting_keys
string[]

The keys to sort the results by.

​
sorting_order
enum<string>[]

The order to sort the results by. Must be the same length as [sortingKeys]; one order per key.

Available options:
ASC,
ASC_NULLS_FIRST,
ASC_NULLS_LAST,
DESC,
DESC_NULLS_FIRST,
DESC_NULLS_LAST

Response

Returns list of subscriptions.

​
data
object[]
required
​
pagination
object
required