List events

GET/v1/eventsRun

Requires webhooks:read permission.

Query parameters

typestringoptional

One event type, or a family such as payment.*.

Example: payment.succeeded

Pattern: ^(\*|[a-z_]+(\.[a-z_]+)*(\.\*)?)$

Max length: 64

project_idstringoptional

Only the events of this project.

Example: prj_01k7q3m8x2v5t9n4b6c1d0e7fa

Prefixed with prj_.

payment_idstringoptional

Only the events about this payment.

Example: pay_01k7q3m8x2v5t9n4b6c1d0e7fa

Prefixed with pay_.

payment_link_idstringoptional

Only the events about this payment link.

Example: lnk_01k7q3m8x2v5t9n4b6c1d0e7fa

Prefixed with lnk_.

starting_afterstringoptional

The id of the last item on the page you have. The next page starts after it.

Example: wev_01k7q3m8x2v5t9n4b6c1d0e7fa

Prefixed with wev_.

limitintegeroptional

How many items one page holds, from 1 to 100. The default is 20.

Example: 20

Minimum: 1

Maximum: 100

Response (200)

Returns a page of a list: data holds the items, and meta.pagination says how the list goes on. Page with limit and starting_after (the id of the last item you have), or fetch meta.pagination.next.

dataarray of objectrequired

The returned object, or an array of objects for a list.

metaobjectrequired

Request details such as its id and pagination cursor.

request_idstringrequired

The id of this request. Quote it when you ask support about it.

Example: req_Hy3k9QzT2LmN8vXa

paginationobjectrequired

Pagination details for a list response. Use next to fetch the next page, or starting_after to build the URL yourself.

per_pageintegerrequired

Number of items returned on this page.

Example: 20

has_morebooleanrequired

true means more items are available on another page.

nextstring | nullrequired

The address of the next page, with your filters kept; null on the last page.

Example: string

A failed request answers with the common error shape; see Errors.

Request

curl "https://api.baiyar.com/v1/events" \
  -H "Authorization: Bearer $BAIYAR_KEY"

Response

{
  "data": [
    {}
  ],
  "meta": {
    "request_id": "req_Hy3k9QzT2LmN8vXa",
    "pagination": {
      "per_page": 20,
      "has_more": true,
      "next": "https://api.baiyar.com/v1/events?starting_after=id"
    }
  }
}