GET/desk/api/v2/search/customers.json
Search for customers
Query Params
- Name
updatedBefore- Type
- string
- Description
- Name
updatedAfter- Type
- string
- Description
- Name
searchAfter- Type
- string
- Description
- Name
search- Type
- string
- Description
- Name
orderMode- Type
- string
- Description
- Name
orderBy- Type
- string
- Description
- Name
domain- Type
- string
- Description
- Name
createdBefore- Type
- string
- Description
- Name
createdAfter- Type
- string
- Description
- Name
addMethod- Type
- string
- Description
- Name
searchAfterID- Type
- integer
- Description
- Name
pageSize- Type
- integer
- Description
- Name
page- Type
- integer
- Description
- Name
excludeDomainMatchedCustomers- Type
- boolean
- Description
- Name
tagIds[]- Type
- array[integer]
- Description
- Format
- Comma separated values
- Name
excludeCompanies[]- Type
- array[integer]
- Description
- Format
- Comma separated values
- Name
companies[]- Type
- array[integer]
- Description
- Format
- Comma separated values
Responses
- Code
- 200
- Type
- object
- Schema
- Description
- 200 OK
CustomersAPIBody is the request/response format for bulk company API calls
- Code
- 400
- Type
- object
- Schema
- Description
- 400 Bad Request
Validator hold the validation errors. Typically you shouldn't create this directly but use the New() function.
200 OK
CustomersAPIBody
{ "customers": [ { "addMethod": "string", "address": "string", "avatarURL": "string", "company": { "delete": true, "id": 0, "meta": {}, "type": 0 }, "contacts": [ { "delete": true, "id": 0, "meta": {}, "type": 0