Skip to main content
Read purchase order correspondence

Authorizations

Authorization
string
header
required

Personal API key sent as a bearer token, together with X-Organization-Id. The key must have at least the access level the endpoint requires (read, write or admin).

Headers

X-Organization-Id
string

The organization to act in. Required for personal API keys; list the organizations you can access with GET /v1/organizations.

Path Parameters

id
string<uuid>
required

Query Parameters

fields
string[]

Return only these fields of each row; use dots for nested fields, such as member.user_id. id is always returned. Fields: id, direction, kind, created_at, subject, from, to, cc, reply_to, body, truncated, forwarded_by, member, forwarded_from, read_as, unread_files, status, attachments.

limit
integer
default:20
Required range: 1 <= x <= 50
cursor
string
Maximum string length: 4096

Response

Correspondence page.

data
object[]
required
Maximum array length: 1000
next_cursor
string | null
required