Search Brokers

This endpoint is used to list customs brokers.

Request

GET /api/v1/brokers

Headers

Name	Type	Description
Authorization	string	Bearer token for authentication
X-Target-Server	string	Target server identifier

Query Parameters

Name	Type	Description
page	number	Page number for pagination
per_page	number	Number of items per page

Example Request

curl --request GET \
  --url '{{HOST}}/api/v1/brokers?page=1&per_page=10' \
  --header 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...' \
  --header 'X-Target-Server: user'

Response

Success Response

{
  "result": {
    "total": 2,
    "page": 1,
    "per_page": 10,
    "nodes": [
      {
        "id": "678903753843ebd17a862bce",
        "name": "DALİO TEKNOLOJİ DANIŞMANLIK VE TİCARET ANONİM ŞİRKETİ",
        "external_id": "2680993652",
        "created_at": "2025-01-16T13:02:45.828Z",
        "updated_at": "2025-01-16T13:02:45.828Z"
      },
      {
        "id": "6788c850d171017eae617e20",
        "name": "Interzoon A.S",
        "external_id": "a94494902032asd",
        "created_at": "2025-01-16T08:50:24.362Z",
        "updated_at": "2025-01-16T08:50:24.362Z"
      }
    ]
  },
  "errors": null
}

Response Fields

Field	Type	Description
result.total	number	Total number of brokers
result.page	number	Current page number
result.per_page	number	Number of items per page
result.nodes	array	Array of broker objects
result.nodes[].id	string	Unique identifier of the broker
result.nodes[].name	string	Name of the broker
result.nodes[].external_id	string	External identifier of the broker
result.nodes[].created_at	string	Creation timestamp
result.nodes[].updated_at	string	Last update timestamp
errors	null	Error information if any