List mail items

GET

https://api.middesk.com/v1/partner/mail

GET

/v1/partner/mail

1 curl https://api.middesk.com/v1/partner/mail \
2      -u "<username>:<password>"

Try it

200Mail items list

1 {
2   "object": "list",
3   "data": [
4     {
5       "object": "mail",
6       "id": "b4c5d6e7-f8a9-0123-789a-bcdef0123456",
7       "created_at": "2025-01-07T12:00:00Z",
8       "updated_at": "2025-01-07T12:00:00Z",
9       "mail_viewed": true,
10       "tag_names": [
11         "tag_names"
12       ],
13       "suggested_action_request": true,
14       "source": {},
15       "company": {},
16       "arrived_at": "2024-01-15T09:30:00Z",
17       "external_id": "external_id",
18       "sender_name": "sender_name",
19       "recipient_name": "recipient_name",
20       "agency_name": "agency_name",
21       "internal_status": "internal_status",
22       "notes": "notes",
23       "document_url": "document_url",
24       "summary_payload": {
25         "key": "value"
26       },
27       "suggested_mail_tag": "suggested_mail_tag",
28       "suggested_partner_name": "suggested_partner_name",
29       "mailbox_name": "mailbox_name",
30       "registration_request_id": "registration_request_id",
31       "state": "AL",
32       "document": {
33         "key": "value"
34       }
35     }
36   ],
37   "url": "/v1/partner/mail",
38   "has_more": false,
39   "count": 1
40 }

Authentication

AuthorizationBasic

Basic authentication of the form Basic <username:password>.

Query parameters

pageintegerOptional

Page number

per_pageintegerOptional

Items per page

statestringOptional

Filter by state

qstringOptional

Search query

sort_bystringOptional

Sort field

sort_orderstringOptional

Sort order

Response

mail items list

objectstring or null

datalist of objects or null

urlstring or null

has_moreboolean or null

countinteger or null