List

Please note: if there are no values ​​in the user_ids parameter, the default will display a list of emails from accounts belonging to the token owner.

List of emails with paging

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

Path Parameters

Name	Type	Description
/24*	Int	Code of the module № 24 is Mail

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,"subject":"Happy!"}
  ]"

401: Unauthorized

Example

cURL

curl --location --request 
POST 'https://do.workzeal.com/common/list/paging/24
?records_onpage=50
&sorting_column=id
&user_ids=37
&sorting_direction=1
&date1=2021-01-01
&date2=2021-12-31
&page=1
&columns=id,subject,from,from_address,to,to_address,small_part_of_body' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer XXXXXX.XXXXXXX.XXXXXX' \
--data-raw ''

PHP

NodeJS(Request)

Columns

Note: Both legal entities and individuals. For legal entities, company_name is the company name, while for individuals, it's the individual's full name.

Имя	Описание
id	Letter ID
from	From name
from_address	From address
to	To name
to_address	To address
cc	Copy
bcc	Hide copy
subject	Subject
date	Date
user_name	Username, owned an account
company_name	Client name
company_id	Client IS
contact_id	Contact ID
contact	Contact name
company_type_id	Client's type ID
company_type	Client's type
company_category_id	Client's category ID
company_category	Client's category
company_status_id	Client's status ID
company_status	Client's status
deal	Name of a deal that letter is related to
deal_id	Deal ID
message_id	Unique Message ID
attachment_flag	1: The letter has attachment 0: Has not
small_part_of_body	First 255 characters of the letter
body	Email content in HTML format ⚡️ It is not recommended to specify this column in large list queries. When possible, retrieve the position of a single email by ID. Filter parameter id=xx

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
?subject=Hapy!
?to_address="[email protected]"
?from_address="[email protected]"
?company_id=1
?deal_id=1
?page=1

// id - Letter ID
// segment - Message folder ID (see description)
// user_ids - User ID whose accounts need to be viewed
// date1 - From date (YYYY.MM.DD format)
// date2 - To date (YYYY.MM.DD format)
// subject - Message subject
// to_address - Email address to
// from_address - Email address from (all emails for a deal)
// company_id - Counterparty ID (all emails for a company)
// deal_id - Deal ID
// page - Page number to retrieve

⚡️user_ids

Коды пользователей можно найти в раздели - пользоватли

Users

⚡️segment

1. Inbox

2. Sent

3. Drafts

4. Trash

5. Spam

6. More

Ready-made custom filters

?user_filter_ids = 1
or
?user_filter_ids=1,2

⚡️ user_filter_ids

Filter codes can be found in the filters section

Filters