Skip to main content
GET
/
v1
/
credits
Get all credits
curl --request GET \
  --url https://dev.flextell.ai/api/v1/credits \
  --header 'Authorization: Bearer <token>' \
  --header 'X-Tenant: <x-tenant>'
{
  "data": [
    {
      "id": 123,
      "tenant_id": 123,
      "type": "<string>",
      "type_label": "<string>",
      "amount": 123,
      "formatted_amount": "<string>",
      "start_date": "2023-11-07T05:31:56Z",
      "end_date": "2023-11-07T05:31:56Z",
      "is_active": true,
      "created_at": "2023-11-07T05:31:56Z"
    }
  ],
  "links": {
    "first": "<string>",
    "last": "<string>",
    "prev": "<string>",
    "next": "<string>"
  },
  "meta": {
    "current_page": 2,
    "from": 2,
    "last_page": 2,
    "links": [
      {
        "url": "<string>",
        "label": "<string>",
        "active": true
      }
    ],
    "path": "<string>",
    "per_page": 1,
    "to": 2,
    "total": 1
  }
}

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
​
links
object
required
​
meta
object
required