Skip to main content
GET
/
platform-customers
cURL
curl --request GET \
  --url https://ebrcapi.dev.eximfiles.com/api/v1/platform-customers \
  --header 'x-api-key: <api-key>'
{
  "items": [
    {
      "id": "<string>",
      "name": "<string>",
      "email": "[email protected]",
      "type": "customer",
      "companyName": "<string>",
      "address": "<string>",
      "platformId": "<string>",
      "isActive": true,
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z"
    }
  ],
  "meta": {
    "totalItems": 123,
    "itemsPerPage": 123,
    "totalPages": 123,
    "currentPage": 123
  }
}

Authorizations

x-api-key
string
header
required

Query Parameters

page
integer<int32>
default:1

Page number (starts at 1)

Required range: x >= 1
limit
integer<int32>
default:10

Items per page

Required range: 1 <= x <= 100

Filter by partial name or email

Response

Paginated list of platform customers

items
object[]
meta
object