v1

latestOpenAPI 3.1.02026-07-2498134321.1 KB

Workflows

Retrieve Email Threads from A Workflow

List all email threads in the specified workflow.

OAuth Scope required: public.workflows.readEmailCommunications

get/workflows/{id}/emails

Path parameters

idstring required

The unique identifier of a workflow

Query parameters

pageinteger

The page number used when paginating through a list of results.

pageSizeinteger

A limit of the number of results to return.

Headers

x-as-user-emailstring

Example:jane.doe@test.com

Denotes the actor of the request. When used, the API will take into account this user's permissions and access. This or x-as-user-id is required when the associated token was produced from the Client Credentials grant or with legacy bearer tokens on select endpoints. More information about permissions.

x-as-user-idstring

Example:5f0375c4cdc1927a3c5edcd3

Denotes the actor of the request. When used, the API will take into account this user's permissions and access. This or x-as-user-email is required when the associated token was produced from the Client Credentials grant or with legacy bearer tokens on select endpoints. More information about permissions.

Response

GET Emails Response.

pageinteger

pageSizeinteger

countinteger

Example response

{
  "pageSize": 20,
  "count": 1,
  "list": [
    {
      "id": "ez3cvz95z",
      "emailThreadId": "emailThread498b9193da784477b09454f1d925e26d",
      "timestamp": "2022-09-28T19:21:05.034Z",
      "author": {
        "type": "internalUser",
        "companyName": "Jabba the Hutt Industries",
        "displayName": "Boba Fett",
        "email": "boba@example.com",
        "userId": "63d415e0dd0d828c3a878548"
      },
      "subject": "Re: Contract Review Request - New Jedi Interceptors",
      "body": "I'll review the contract with care, ensuring it aligns with the Jedi Order's principles. You'll have my insights soon so we can secure a fleet worthy of peace and balance.\n\nMay the Force be with you,\nObi-Wan Kenobi",
      "attachments": [
        {
          "filename": "file.pdf",
          "download": "/public/api/v1/workflows/6013609108b8f070cee94fc1/emails/z_1zgjgjq/attachments/attachmentIdc85d7e3be5d84bf28cebe4591e39c894",
          "content-type": "application/pdf",
          "documentKey": "5xfsCSMmfxkp4C1gKv67l",
          "documentVersion": 1
        }
      ]
    }
  ]
}