Search Callbacks

get

https://partner-api.getpliant.com/api/callbacks

Get a list of all callbacks we produced for you, whether we could send them to you or not. This log contains all callbacks Pliant produced, together with a status and further metadata to let you investigate problems etc. You can add optional filters to narrow down the results. To get the payload of a specific callback, use the GET /callbacks/{callbackId} endpoint. To re-trigger delivery of one or more callbacks, use the POST /callbacks/resend endpoint.

Query Params

organizationId

uuid

Filter by organization id.

entityId

uuid

deprecated

Filter by single entity id.

entityIds

array of uuids

Filter by (multiple) entity ids.

entityIds

eventType

string

Filter by event type.

status

string

enum

Filter by status. The status of the callback. The callback starts as UNSENT, transitions to IN_PROGRESS, then to SENT or FAILED. If the callback is skipped (mostly due to manual interventions), it will be marked as SKIPPED. The status TO_BE_SEND_IMMEDIATELY is a short-lived, intermediate status similar to UNSENT.

Allowed:

fromDate

date-time

The from date to filter by as zero-offset UTC time. The date boundary is inclusive. Meaning we compare with >=.

toDate

date-time

The to date to filter by as zero-offset UTC time. The date boundary is inclusive. Meaning we compare with <=.

byDateField

string

enum

Defaults to createdAt

The date field to filter by if fromDate and toDate are present.

Allowed:

limit

integer

The maximum number of items to return per page. The default value if not provided is 100, the maximum allowed value is 1000.

page

integer

The page number to return, starting with 0, this counts up to the total number of pages. The total number of pages is determined by the total number of records divided by the limit.

sortBy

string

enum

The field to sort by.

Allowed:

sortDirection

string

enum

The direction to sort by.

Allowed:

Responses

200Ok

400Bad Request. The API consumer sent a malformed request which could not be processed.

401Unauthorized. The API consumer is not authorized to access the requested resource.

403Forbidden. The API consumer is not allowed to access the requested resource.

429Too Many Requests. The API consumer has sent too many requests in a given amount of time. Please check our API guidelines.

500Internal Server Error. The request was not completed due to an internal error.