Skip to main content
GET
/
api
/
customers
{
  "message": "Customers list retrieved successfully",
  "data": [
    {
      "id": 123,
      "CID": "<string>",
      "name": "<string>",
      "email": "<string>",
      "url": "<string>",
      "number_range_id": 123,
      "marketing_opt_in_at": "<string>"
    }
  ],
  "meta": {
    "current_page": 1,
    "last_page": 5,
    "per_page": 10,
    "total": 45
  }
}

Authorizations

Authorization
string
header
required

Enter your JWT token in the format 'Bearer '

Query Parameters

per_page
integer<int32>
default:10

Number of customers to return per page (default: 10)

Required range: x >= 1
page
integer<int32>
default:1

Page number to retrieve (default: 1)

Required range: x >= 1

Response

Customers list retrieved successfully

message
string
Example:

"Customers list retrieved successfully"

data
object[]
meta
object

Pagination meta data