Get Customers List

List platform customers

curl --request GET \
  --url https://ebrcapi.eximfiles.io/api/v1/platform-customers \
  --header 'x-api-key: <api-key>'

import requests

url = "https://ebrcapi.eximfiles.io/api/v1/platform-customers"

headers = {"x-api-key": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};

fetch('https://ebrcapi.eximfiles.io/api/v1/platform-customers', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://ebrcapi.eximfiles.io/api/v1/platform-customers",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "x-api-key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://ebrcapi.eximfiles.io/api/v1/platform-customers"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("x-api-key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://ebrcapi.eximfiles.io/api/v1/platform-customers")
  .header("x-api-key", "<api-key>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://ebrcapi.eximfiles.io/api/v1/platform-customers")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "items": [
    {
      "id": "<string>",
      "name": "<string>",
      "email": "jsmith@example.com",
      "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
  }
}

{
  "code": "<string>",
  "message": "<string>"
}

GET

platform-customers

List platform customers

curl --request GET \
  --url https://ebrcapi.eximfiles.io/api/v1/platform-customers \
  --header 'x-api-key: <api-key>'

import requests

url = "https://ebrcapi.eximfiles.io/api/v1/platform-customers"

headers = {"x-api-key": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};

fetch('https://ebrcapi.eximfiles.io/api/v1/platform-customers', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://ebrcapi.eximfiles.io/api/v1/platform-customers",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "x-api-key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://ebrcapi.eximfiles.io/api/v1/platform-customers"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("x-api-key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://ebrcapi.eximfiles.io/api/v1/platform-customers")
  .header("x-api-key", "<api-key>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://ebrcapi.eximfiles.io/api/v1/platform-customers")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "items": [
    {
      "id": "<string>",
      "name": "<string>",
      "email": "jsmith@example.com",
      "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
  }
}

{
  "code": "<string>",
  "message": "<string>"
}

List every exporter entity under your platform account. Use this to reconcile your records with the API or to look up a platformCustomerId you did not store.

Request example

curl --location 'https://ebrcapi.eximfiles.io/api/v1/platform-customers?page=1&limit=10&search=surya' \
  --header 'x-api-key: <YOUR_API_KEY>'

page starts at 1; limit defaults to 10 and caps at 100; search filters by partial name or email.

Response example

{
  "success": true,
  "data": {
    "items": [
      {
        "id": "ee849a90-7a28-49b4-8cb2-8e31041650a2",
        "name": "Rohan Mehta",
        "email": "finance@suryatextiles.example.com",
        "type": "customer",
        "companyName": "Surya Textile Exports Pvt Ltd",
        "address": "Tiruppur, Tamil Nadu",
        "platformId": "1f0c9a52-3b41-4d78-9e26-7a8b5c4d3e2f",
        "isActive": true,
        "createdAt": "2026-07-22T10:15:04.874Z",
        "updatedAt": "2026-07-22T10:21:33.120Z"
      }
    ],
    "meta": {
      "totalItems": 1,
      "itemsPerPage": 10,
      "totalPages": 1,
      "currentPage": 1
    }
  },
  "statusCode": 200,
  "timestamp": "2026-07-22T10:25:00.000Z"
}

Next steps

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

string

Filter by partial name or email

Response

Paginated list of platform customers

items

object[]

Show child attributes

​Request example

​Response example