Skip to main content
GET
Get all credits

Authorizations

Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Headers

X-Tenant
number
required

Tenant identifier. Send the Tenant ID in the X-Tenant header to scope API requests to a specific tenant.

Query Parameters

type
enum<string>

Filter by type.

Available options:
sms,
storage,
whatsapp
is_active
boolean | null

Filter by active status.

per_page
integer | null

The number of items per page.

Required range: 1 <= x <= 100
page
integer | null

The page number.

Required range: x >= 1
sort_by
enum<string> | null

The field to sort by.

Available options:
created_at,
start_date,
end_date,
amount
sort_order
enum<string> | null

The sort direction (asc or desc).

Available options:
asc,
desc

Response

Paginated set of CreditResource

data
CreditResource · object[]
required
meta
object
required