> This page is for version v1 (default).
> For other versions, use one of these documentation indexes:
> - v1 (default): https://docs.plextera.com/v-1/llms.txt

> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://docs.plextera.com/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.plextera.com/_mcp/server.

# List subscriptions

GET https://api.plextera.com/api/public/v1/event-subscriptions

Returns a page of webhook subscriptions, newest first by default.

Reference: https://docs.plextera.com/api/api-reference/event-subscriptions/list-event-subscriptions

## Authentication

- `Authorization` header (required) — Use the API key format: `api-key <token>`.

## Request

### Query parameters

- `page` (integer, optional, default: 0) — Zero-based page index. Defaults to 0.
- `size` (integer, optional, default: 50) — Page size between 1 and 100. Defaults to 50.
- `name` (string, optional) — Return only subscriptions whose name contains this text, ignoring case. Matched anywhere in the name; subscriptions created without a name never match.
- `status` (enum, optional) — Filter by subscription status: `active` or `paused`.
  - Allowed values: `active`, `paused`
- `eventType` (enum, optional) — Return only subscriptions that include this event type.
  - Allowed values: `document-insights.extraction.completed`, `document-insights.extraction.failed`, `document-insights.extraction.rejected`, `workflow.run.completed`, `workflow.run.failed`
- `from` (datetime, optional) — Return subscriptions created at or after this UTC ISO-8601 timestamp.
- `to` (datetime, optional) — Return subscriptions created at or before this UTC ISO-8601 timestamp.
- `sortBy` (enum, optional) — Field used to sort the list. Defaults to createdAt.
  - Allowed values: `createdAt`, `updatedAt`
- `sort` (enum, optional) — Sort direction. Defaults to desc.
  - Allowed values: `asc`, `desc`

## Response

### 200

One page of subscriptions, newest first.

- `data` (list of EventSubscription, required) — Items on the requested page.
- `pageInfo` (PageInfo, required) — Paging details for this result set.

## Errors

### 400 Bad Request Error

INVALID_REQUEST — The request is malformed: unreadable JSON, an invalid parameter value, or a bad multipart body.

- `error` (ApiError, optional) — Machine-readable error details shared by every error response.

### 401 Unauthorized Error

UNAUTHORIZED — The API key is missing, malformed, or revoked.

- `error` (ApiError, optional) — Machine-readable error details shared by every error response.

### 403 Forbidden Error

FORBIDDEN — The API key is valid but not allowed to perform this operation.

- `error` (ApiError, optional) — Machine-readable error details shared by every error response.

### 405 Method Not Allowed Error

METHOD_NOT_ALLOWED — The HTTP method is not supported for this path.

- `error` (ApiError, optional) — Machine-readable error details shared by every error response.

### 406 Not Acceptable Error

NOT_ACCEPTABLE — The requested response media type is not supported.

- `error` (ApiError, optional) — Machine-readable error details shared by every error response.

### 429 Too Many Requests Error

RATE_LIMITED — Too many requests in a short window. 429 responses are enforced at the network edge; the body may be plain text instead of this envelope, so rely on the status code and the Retry-After header.

- `error` (ApiError, optional) — Machine-readable error details shared by every error response.

### 500 Internal Server Error

INTERNAL_ERROR — Unexpected failure inside Plextera. Retry with backoff; contact support with the requestId if it persists.

- `error` (ApiError, optional) — Machine-readable error details shared by every error response.

## Types

### EventSubscription

Webhook subscription without its signing secret.

- `id` (string, required) — Subscription identifier.
- `status` (enum, required) — `active` subscriptions receive deliveries; `paused` ones do not.
  - Allowed values: `active`, `paused`
- `endpointUrl` (string, required) — HTTPS URL events are delivered to.
- `eventTypes` (list of enum, required) — Event types this subscription receives.
  - Allowed values: `document-insights.extraction.completed`, `document-insights.extraction.failed`, `document-insights.extraction.rejected`, `workflow.run.completed`, `workflow.run.failed`
- `createdAt` (datetime, required) — UTC timestamp when the subscription was created.
- `updatedAt` (datetime, required) — UTC timestamp of the last subscription change.
- `name` (string, optional) — Optional human-readable name. Omitted for subscriptions created before names were introduced.
- `filters` (EventSubscriptionFilter, optional) — Delivery filters. Omitted when none are configured.

### PageInfo

Paging details returned by every list endpoint.

- `page` (integer, optional) — Zero-based index of the returned page.
- `size` (integer, optional) — Requested page size.
- `totalItems` (long, optional) — Total number of items matching the query.
- `totalPages` (integer, optional) — Total number of pages for the requested size.

### ApiError

Machine-readable error details shared by every error response.

- `code` (string, optional) — Stable machine-readable error code. Branch your handling on this, not on `message`.
- `message` (string, optional) — Human-readable explanation. Wording may change; do not parse it.
- `requestId` (string, optional) — Unique request identifier, also returned in the X-Request-Id response header. Include it in support requests.
- `retryable` (boolean, optional) — True when retrying the same request later may succeed.
- `details` (list of ApiErrorDetail, optional) — Field-level validation issues. Present only for VALIDATION_FAILED.

### EventSubscriptionFilter

Optional delivery filters for a subscription.

- `workflowId` (string, optional) — Optional workflow id filter. Applies only to workflow events. Unsupported filter fields are rejected instead of being silently ignored.

### ApiErrorDetail

Field-level validation issue.

- `field` (string, optional) — Name of the invalid request field.
- `issue` (string, optional) — What is wrong with the field value.

## Examples

**Response**

```json
{
  "data": [
    {
      "id": "sub_01JY7MA0Q2D9V64ZFD0Y2J5K3T",
      "status": "active",
      "endpointUrl": "string",
      "eventTypes": [
        "document-insights.extraction.completed"
      ],
      "createdAt": "2024-01-15T09:30:00Z",
      "updatedAt": "2024-01-15T09:30:00Z",
      "name": "Production document events",
      "filters": {
        "workflowId": "invoice-processing"
      }
    }
  ],
  "pageInfo": {
    "page": 1,
    "size": 1,
    "totalItems": 1,
    "totalPages": 1
  }
}
```

**SDK Code**

```python
import requests

url = "https://api.plextera.com/api/public/v1/event-subscriptions"

headers = {"Authorization": "<apiKey>"}

response = requests.get(url, headers=headers)

print(response.json())
```

```javascript
const url = 'https://api.plextera.com/api/public/v1/event-subscriptions';
const options = {method: 'GET', headers: {Authorization: '<apiKey>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go
package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.plextera.com/api/public/v1/event-subscriptions"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "<apiKey>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby
require 'uri'
require 'net/http'

url = URI("https://api.plextera.com/api/public/v1/event-subscriptions")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = '<apiKey>'

response = http.request(request)
puts response.read_body
```

```java
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.get("https://api.plextera.com/api/public/v1/event-subscriptions")
  .header("Authorization", "<apiKey>")
  .asString();
```

```php
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://api.plextera.com/api/public/v1/event-subscriptions', [
  'headers' => [
    'Authorization' => '<apiKey>',
  ],
]);

echo $response->getBody();
```

```csharp
using RestSharp;

var client = new RestClient("https://api.plextera.com/api/public/v1/event-subscriptions");
var request = new RestRequest(Method.GET);
request.AddHeader("Authorization", "<apiKey>");
IRestResponse response = client.Execute(request);
```

```swift
import Foundation

let headers = ["Authorization": "<apiKey>"]

let request = NSMutableURLRequest(url: NSURL(string: "https://api.plextera.com/api/public/v1/event-subscriptions")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "GET"
request.allHTTPHeaderFields = headers

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```