List

Please note: positions in the list will be assigned based on the token owner's access level. About access, loock at the topic : https://help.workzeal.com/settings/users/access-rights

List of clients with paging

POST https://do.workzeal.com/common/list/paging/1

Path Parameters

Name	Type	Description
/1*	Int	Code of the module №1 is Clients

Query Parameters

Name	Type	Description
columns *	String	List of columns
sorting_direction	Int	0: ASC 1: DSC
sorting_column	String	Column for sorting
page	int	Page number
records_onpage	Int	Records on one page but not more than 500

Headers

Name	Type	Description
Authorization*	String	Bearer XXXXX-XXXXXXX-XXXXX
Content-Type	String	application/json

Answer

200: OK

{
  "status": "success",
  "error": "",
  "code": null,
  "rows": 1,
  "pages": 1,
  "page": 1,
  "value": "[
       {"id":1,"name":"Apple"}
  ]"

401: Unauthorized

Exapmle

cURL

curl --location --request 
POST 'https://do.workzeal.com/common/list/paging/1
?columns=id,name
&records_onpage=1000
&sorting_direction=0
&sorting_column=id
&user_ids=37' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer XXXXXX.XXXXXXX.XXXXXX' \
--data-raw ''

PHP

NodeJs(Request)

Columns

Имя	Описание
id	Client ID
name	Name
address	Address
created	Added on date
city	City
region	Region
country	Country
activity_type	Activity type
property_form	Form of corporation
type_id	Type ID
type	Type
created_by	Added by user
info_source	Source of adding
first_name	First Name of individual
middle_name	Middle Name of individual
last_name	Last Name of individual
url	Website
user_id	User ID
user_name	Username, who is a responsible for the client
person	Type of Client 1 - Company 2 - Individual
note	Note
external_code	External code
category_id	Category ID
category	Category
status_id	Status ID
status	Status
agent_id	Agent ID
agent	Agent
tax_id	Tax ID
which_site_source	Website that's a source of getting the client
which_host_source	Host that's a source of getting the client
which_link_source	Full link that's a source of getting the client
utm_campaign	UTM campaign
utm_source	UTM source
utm_medium	UTM medium
utm_content	UTM content
utm_term	UTM term
ADD_{name}	Additional custom columns

Additinal columns

Filtering

Note: You can use two filtering methods: standard filtering by columns and filtering by the ID of a pre-made filter created within the app. For more information, look at the topic https://help.workzeal.com/settings/filters

Columns for filtering

?id=1
?name=apple
[email protected]
?phone=[phone]
?tax_id=7811505326
?user_ids=1 or ?user_ids=1,3,4
?page=1 - Номер страницы которую нужно получить

// id - Client ID
// name - Company name, search by partial character match
// email - Email of counterparty or contact persons
// phone - Phone number of counterparty or contact persons
// tax_id - Taxpayer code from the company's list of details
// user_ids - Code of the person responsible for the counterparty
// page - Page number to retrieve

⚡️ tax_id The default position should be selected in the list of company details: https://help.workzeal.com/attachment/crm/forms-company

⚡️ user_ids User codes can be found in the administration app in the users section.

Users

Ready-made custom filters

?user_filter_ids = 1
or
?user_filter_ids=1,2

// user_filter_ids - IDs of custom filters

⚡️ user_filter_ids

Filter codes can be found in the filters section

Filters