List

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

List of deals with paging

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

Path Parameters

Name	Type	Description
/20*	Int	Code of the module № 20 is Deals

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":"Sale"}
  ]"

401: Unauthorized

Example

сURL

curl --location --request 
POST 'https://do.workzeal.com/common/list/paging/20
?columns=id,name,type,status,sum
&records_onpage=1000
&sorting_direction=0
&sorting_column=id
&user_ids=37
&type_id=1
&date1=2021-01-01&date2=2022-12-31' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer XXXXX.XXXXX.XXXXX' \
--data-raw ''

PHP

NodeJs(Request)

Columns

Note: Columns with the company_ prefix contain information about the counterparty, which can be either a legal entity or an individual. For a legal entity, company_name is the company name, and for an individual, it is the individual's full name.

Имя	Описние
id	Deal ID
name	Name
sum	Sum
type_id	Type ID
type	Type
status_id	Status ID
status	Status
company_id	Client ID
company_name	Client's name
company_type	Client's type
company_status	Client's status
company_category	Client's category
company_tax_id	Client's Tax ID
company_country	Client's country
company_region	Client's region
company_city	Client's city
company_url	Client's website
user_id	User ID who is responsible for a deal
user_name	Username
note	Note
ADD_{name}	Additional custom fields

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 https://help.workzeal.com/settings/filters

Columns for filtering

?id=1
?segment=1 
?user_ids=1  0r ?user_ids=1,3,5
?date1=2021-12-01
?date2=2021-12-31
?company_id=1
?type_id=1
?status_id=1
?page=1

// id - Deal ID
// user_ids - User ID whose deals need to be retrieved
// date1 - From date (YYYY.MM.DD format)
// date2 - To date (YYYY.MM.DD format)
// company_id - Client ID (all deals for the company)
// type_id - Deal's type ID
// status_id - Deal's status ID
// page - Page number to retrieve

⚡️type_id ⚡️status_id

Codes can be found in the administration app in the reference section

References

⚡️user_ids

User codes can be found in the administration app in the users section

Users