List event types

curl --request GET \
  --url https://payouts.api.trykarat.com/events \
  --header 'Authorization: Bearer <token>'

{
  "data": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "payout.updated",
      "createdAt": "2023-11-07T05:31:56Z"
    }
  ],
  "meta": {
    "total": 123,
    "limit": 123,
    "offset": 123
  }
}

GET

events

List event types

curl --request GET \
  --url https://payouts.api.trykarat.com/events \
  --header 'Authorization: Bearer <token>'

{
  "data": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "payout.updated",
      "createdAt": "2023-11-07T05:31:56Z"
    }
  ],
  "meta": {
    "total": 123,
    "limit": 123,
    "offset": 123
  }
}

Authorizations

Authorization

string

header

required

Pass your API key as a bearer token: Authorization: Bearer <API_KEY>.

Query Parameters

limit

integer

default:100

Maximum number of results to return (max 100, default 100).

Required range: 1 <= x <= 100

offset

integer

default:0

Number of results to skip for pagination (default 0).

Required range: x >= 0

Response

A paginated list of event types.

data

object[]

Show child attributes