Search customers by phone (fuzzy or exact)

GET

/api/v1/customers/search

const url = 'https://api.dokanmazad.com/api/v1/customers/search?phone=%2B971501234567&exact=true';
const options = {method: 'GET', headers: {'X-API-Key': '<X-API-Key>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url 'https://api.dokanmazad.com/api/v1/customers/search?phone=%2B971501234567&exact=true' \
  --header 'X-API-Key: <X-API-Key>'

Authorizations

ApiKeyAuth

Parameters

Query Parameters

phone

required

string

Customer phone number. When called via API key, exact match is automatically enforced regardless of the exact param.

Example

+971501234567

exact

string

Pass “true” for exact phone match. IMPORTANT: When called via API key, exact match is automatically enforced regardless of this parameter to prevent customer enumeration.

Example

true

Responses

200

Success

application/json

object

success

required

boolean

data

required

meta

object

page

integer

limit

integer

total

integer

totalPages

integer

data

required

object

required

Customer CUID (use as customerId in POST /orders)

string

name

required

Customer name

string

mobileNumber

Customer phone

string

tenantId

Tenant identifier (when applicable)

string

Examples

success

{
  "success": true,
  "data": [
    {
      "id": "cmoabcde000001ny11aabbcc0",
      "name": "Ahmed Ali",
      "mobileNumber": "+971501234567",
      "tenantId": "haragkora"
    }
  ]
}

401

Unauthorized — missing or invalid API key

application/json

object

success

required

boolean

error

required

string

statusCode

required

integer

Example

{
  "success": false
}

403

Forbidden — route not in this key’s allowedRoutes

application/json

object

success

required

boolean

error

required

string

statusCode

required

integer

Example

{
  "success": false
}

429

Rate limit exceeded

application/json

object

success

required

boolean

error

required

string

statusCode

required

integer

Example

{
  "success": false
}

Headers

Retry-After

integer

Seconds to wait before retrying