Get Subscriptions [Batch]

🚧

Early Access API Version

This endpoint version is currently in Early Access and available only to approved early adoption (EA) participants. Do not rely on this version for production workloads unless explicitly authorized. If you have any feedback, please share with your designated Early Adoption program representative.

Summary Description

Retrieves the current webhook subscription(s) configured for the authenticated client. This endpoint allows clients to review their active webhook settings, including subscribed event types, target URL, authentication configuration, and delivery settings.

Use this endpoint to:

  • View all existing webhook subscriptions

  • Confirm which event types are currently enabled

  • Validate the delivery endpoint URL and retry settings

This endpoint helps ensure transparency and accuracy in managing webhook integrations with the Paylocity platform.

Query Params
int32
0 to 100

Specifies the maximum number of webhook subscriptions to return in the response. Use this parameter to control the page size for paginated results. The default and maximum value is 100.

string

A filter expression to limit the webhook subscriptions returned. Filterable fields: status (eq), clientId (eq, ne, in), applicationId (eq). Example: status eq 'Active'.

boolean

When provided and set to true will cause the API to return the X-Pcty-Total-Count header in the response which will be set to the total number of resources available even if only a subset of those were returned. The default is false.

int32

The number of resources to skip when returning paginated results. The default is 0.

string

A comma-separated, xpath-like formatting string that identifies the fields that you want the API to use for sorting the resources when they are returned. The default value can vary from API to API.

Responses

401

Unauthorized

Language
Credentials
Bearer
JWT
LoadingLoading…
Response
Choose an example:
application/json