Skip to main content
GET
/
api
/
v1
/
merchants
List all merchants
curl --request GET \
  --url https://dev.superpool.unyte.africa/api/v1/merchants \
  --header 'X-API-Key: <api-key>'
{
  "count": 123,
  "results": [
    {
      "id": 123,
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z",
      "name": "<string>",
      "tenant_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "is_trashed": true,
      "trashed_at": "2023-11-07T05:31:56Z",
      "restored_at": "2023-11-07T05:31:56Z",
      "short_code": "<string>",
      "business_email": "[email protected]",
      "support_email": "[email protected]",
      "is_active": true,
      "tax_identification_number": "<string>",
      "registration_number": "<string>",
      "address": "<string>",
      "kyc_verified": true,
      "user": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
    }
  ],
  "next": "http://api.example.org/accounts/?offset=400&limit=100",
  "previous": "http://api.example.org/accounts/?offset=200&limit=100"
}

Authorizations

​
X-API-Key
string
header
required

Query Parameters

​
limit
integer

Number of results to return per page.

​
offset
integer

The initial index from which to return the results.

Response

List of merchants

​
count
integer
required
Example:

123

​
results
object[]
required
​
next
string<uri> | null
Example:

"http://api.example.org/accounts/?offset=400&limit=100"

​
previous
string<uri> | null
Example:

"http://api.example.org/accounts/?offset=200&limit=100"