Skip to main content
GET
/
v1
/
subscriptions
/
{id}
Get subscription by id
curl --request GET \
  --url https://external.pleo.io/v1/subscriptions/{id} \
  --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"
    }
  }
}

Authorizations

Authorization
string
header
required

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

Path Parameters

id
string<uuid>
required

The unique identifier of the subscription

Response

The subscription details are returned.

data
object
required