Skip to main content
GET
/
v1
/
customers
List customers
curl --request GET \
  --url https://api.platnova.com/v1/customers \
  --header 'X-API-KEY: <api-key>'
{
  "status": true,
  "data": {
    "items": [
      {}
    ],
    "page": 123,
    "size": 123,
    "max_page": 123,
    "total_pages": 123,
    "total": 123,
    "last": true,
    "first": true,
    "visible": 123
  },
  "error": [
    "<unknown>"
  ],
  "message": "<string>"
}

Documentation Index

Fetch the complete documentation index at: https://docs.platnova.com/llms.txt

Use this file to discover all available pages before exploring further.

​
Overview

Retrieve a paginated list of all customers associated with your account. This endpoint allows you to view all customers with their basic information and status.

Authorizations

​
X-API-KEY
string
header
required

API key for authentication.

Query Parameters

​
page
integer

Page number (0-indexed)

​
size
integer

Number of items per page

Response

200 - application/json

Customers retrieved successfully

​
status
boolean
​
data
object
​
error
any[]
​
message
string