List contacts

Authorization

BearerAuth

AuthorizationBearer <token>

JWT access token for REST API endpoints (user-facing apps).

Authorization: Bearer <jwt_access_token>

Tokens expire after 15 minutes. Use the refresh token to obtain a new one.

In: header

Query Parameters

type?string

Value in

"customer"
"supplier"
"both"

search?string

limit?integer

Default50

offset?integer

Default0

Header Parameters

X-API-Version?string

Date-based minor version negotiation (e.g. 2026-07-01). If omitted, the latest version is used.

Match^\d{4}-\d{2}-\d{2}$

Response Body

`application/json`

curl -X GET "https://example.com/api/v1/contacts"

{  "success": true,  "data": [    {      "id": 0,      "contact_type": "customer",      "name": "string",      "email": "string",      "phone": "string",      "mobile": "string",      "address": "string",      "city": "string",      "postal_code": "string",      "country": "string",      "tax_number": "string",      "registration_number": "string",      "website": "string",      "notes": "string",      "is_active": true,      "client_id": 0,      "created_at": "2019-08-24T14:15:22Z",      "updated_at": "2019-08-24T14:15:22Z"    }  ],  "meta": {    "api_version": "string",    "request_id": "string",    "pagination": {      "total": 0,      "limit": 0,      "offset": 0    }  }}