Ctrlk
For the complete documentation index, see llms.txt. This page is also available as Markdown.

Export

This is URL structure for export:

{{url}}/{{tenantName}}/{{instanceName}}/export/{{resourceName}}?start={value}&pageSize={value}

When working with the API, the resourceName parameter must be in uppercase.

This parameter specifies the type of resource you want to work with and can have one of the following values:

Name
Description

ASSESSMENT

Exports all assessments stored in the database

CALENDAR_EVENT

Exports all calendar events stored in the database

CDT_RECORD

Exports all cdt records stored in the database

CHAT

Exports all chat messages records stored in the database

EMAIL

Exports all emails stored in the database

ENCOUNTER

Exports all encounters stored in the database

ENCOUNTER_COMMENT

Exports all encounter comments stored in the database

ENCOUNTER_DISPOSITION

Exports all encounter dispositions stored in the database

PATIENT

Exports all patients stored in the database

PFA

Exports all assessments sent to the patient

SMS

Exports all sms records stored in the database

TASK

Exports all tasks stored in the database

VOICE_CALL

Exports all voice calls stored in the database

WHATS_APP

Exports all WhatsApp messages stored in the database

Response Body

The response body contains a cursor object with the following properties:

  • start: The date the selection started from. This can be null if the start query parameter was not specified.

  • end: The date the selection ended for the current request.

  • hasNext: A boolean indicating whether there are more records left to retrieve.

  • pageSize: The maximum number of records in the data field for the current request.

Note: To fetch the next set of data, use the value of cursor → end as the start query parameter in your next request. The final query will return at least one record, as the selection is performed with a "less than or equal" condition. All records in the data field are sorted by the last update in the database, from oldest to newest.

Permission The export API is only accessible to API clients. To retrieve the data, an administrator must set up appropriate policies for the API client.

To perform exports, the API client needs to have the appropriate export permissions

Export Formation Version

get

The endpoint for retrieving Formation versions.

This will return a list of all available Formation versions.

Authorizations
AuthorizationstringRequired

Bearer token obtained from POST /{tenantName}/admin/api_clients/{clientName}. Valid for 60 minutes.

Path parameters
tenantNamestringRequired

Your organization (tenant) name, e.g. acme-health

Example: acme-health
instanceNamestringRequired

Your environment name: live, sandbox, or a custom name

Example: live
Query parameters
pageSizestringOptionalExample: 50
Responses
200

Cursor-paginated export data (generic placeholder).

application/json
get/{tenantName}/{instanceName}/export/formation_version
GET /{tenantName}/{instanceName}/export/formation_version HTTP/1.1
Host: api.live.welkincloud.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "data": [
    {
      "ANY_ADDITIONAL_PROPERTY": "anything"
    }
  ],
  "cursor": {
    "start": "2026-01-01T00:00:00.000Z",
    "end": "2026-01-01T00:00:00.000Z",
    "hasNext": true,
    "pageSize": 1
  }
}

Export Assessment Formation

get

Endpoint to obtain the Assessment Formation for a selected version.

The {{version}} parameter should be either a version number, "current," or "draft" ("-1").

The response will be provided in a ZIP file. To save it, click on "Save response to file." The ZIP file contains a JSON file with the Assessment formation for the selected version.

Authorizations
AuthorizationstringRequired

Bearer token obtained from POST /{tenantName}/admin/api_clients/{clientName}. Valid for 60 minutes.

Path parameters
tenantNamestringRequired

Your organization (tenant) name, e.g. acme-health

Example: acme-health
instanceNamestringRequired

Your environment name: live, sandbox, or a custom name

Example: live
versionstringRequired

Formation version identifier (e.g. current, draft, or a version number)

Example: current
Responses
200

Cursor-paginated export data (generic placeholder).

application/json
get/{tenantName}/{instanceName}/export/formations/{version}/assessments
GET /{tenantName}/{instanceName}/export/formations/{version}/assessments HTTP/1.1
Host: api.live.welkincloud.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "data": [
    {
      "ANY_ADDITIONAL_PROPERTY": "anything"
    }
  ],
  "cursor": {
    "start": "2026-01-01T00:00:00.000Z",
    "end": "2026-01-01T00:00:00.000Z",
    "hasNext": true,
    "pageSize": 1
  }
}

Export CDT Records

get

Exports all cdt records stored in database

Authorizations
AuthorizationstringRequired

Bearer token obtained from POST /{tenantName}/admin/api_clients/{clientName}. Valid for 60 minutes.

Path parameters
tenantNamestringRequired

Your organization (tenant) name, e.g. acme-health

Example: acme-health
instanceNamestringRequired

Your environment name: live, sandbox, or a custom name

Example: live
Query parameters
startstringOptional

Used as a cursor for fetching data from the database. If the parameter is not specified, the selection will start from the oldest record

Example: 2021-09-07T16:52:35.410Z
pageSizeintegerOptional

Min value is 1, max value is 500. If the parameter is not specified, the page size will be 500

Default: 20
patientIdsstring[]Optional

Allows you to export all CDT records for a specific patient. If you need to export records for multiple patients, their IDs should be entered separated by commas.

Responses
200

Cursor-paginated export data.

application/json
get/{tenantName}/{instanceName}/export/CDT_RECORD
GET /{tenantName}/{instanceName}/export/CDT_RECORD HTTP/1.1
Host: api.live.welkincloud.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "data": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "patientId": "123e4567-e89b-12d3-a456-426614174000",
      "cdtId": "123e4567-e89b-12d3-a456-426614174000",
      "version": 1,
      "cdtName": "text",
      "jsonBody": {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      }
    }
  ],
  "cursor": {
    "start": "2026-01-01T00:00:00.000Z",
    "end": "2026-01-01T00:00:00.000Z",
    "hasNext": true,
    "pageSize": 1
  }
}

Export PDT Records

get

Exports all pdt records stored in database. To export, the API client needs to have permissions to export PDT Records (permissions are configured in Designer under Security Policies).

Authorizations
AuthorizationstringRequired

Bearer token obtained from POST /{tenantName}/admin/api_clients/{clientName}. Valid for 60 minutes.

Path parameters
tenantNamestringRequired

Your organization (tenant) name, e.g. acme-health

Example: acme-health
instanceNamestringRequired

Your environment name: live, sandbox, or a custom name

Example: live
Query parameters
startstringOptional

Used as a cursor for fetching data from the database. If the parameter is not specified, the selection will start from the oldest record

Example: 2024-01-07T16:00:00.410Z
pageSizeintegerOptional

Min value is 1, max value is 500. If the parameter is not specified, the page size will be 500

Default: 20Example: 10
Responses
200

Cursor-paginated export data.

application/json
get/{tenantName}/{instanceName}/export/PDT_RECORD
GET /{tenantName}/{instanceName}/export/PDT_RECORD HTTP/1.1
Host: api.live.welkincloud.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "data": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "createdAt": "2026-01-01T00:00:00.000Z",
      "updatedAt": "2026-01-01T00:00:00.000Z",
      "fullValue": "text",
      "deleted": true,
      "pdtName": "text",
      "jsonBody": {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      }
    }
  ],
  "cursor": {
    "start": "2026-01-01T00:00:00.000Z",
    "end": "2026-01-01T00:00:00.000Z",
    "hasNext": true,
    "pageSize": 1
  }
}

Export Care Plans

get

Exports all care plans stored in database

Authorizations
AuthorizationstringRequired

Bearer token obtained from POST /{tenantName}/admin/api_clients/{clientName}. Valid for 60 minutes.

Path parameters
tenantNamestringRequired

Your organization (tenant) name, e.g. acme-health

Example: acme-health
instanceNamestringRequired

Your environment name: live, sandbox, or a custom name

Example: live
Query parameters
startstringOptional

Used as a cursor for fetching data from the database. If the parameter is not specified, the selection will start from the oldest record

Example: 2021-09-07T16:52:35.410Z
pageSizeintegerOptional

Min value is 1, max value is 500. If the parameter is not specified, the page size will be 500

Default: 20
Responses
200

Cursor-paginated export data.

application/json
get/{tenantName}/{instanceName}/export/CARE_PLAN
GET /{tenantName}/{instanceName}/export/CARE_PLAN HTTP/1.1
Host: api.live.welkincloud.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "data": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "createdByName": "text",
      "createdAt": "2026-01-01T00:00:00.000Z",
      "updatedByName": "text",
      "updatedAt": "2026-01-01T00:00:00.000Z",
      "patientId": "123e4567-e89b-12d3-a456-426614174000",
      "patientOverview": {
        "createdByName": "text",
        "createdAt": "2026-01-01T00:00:00.000Z",
        "updatedByName": "text",
        "updatedAt": "2026-01-01T00:00:00.000Z",
        "overview": "text"
      },
      "goals": [
        {
          "details": {
            "id": "123e4567-e89b-12d3-a456-426614174000",
            "createdByName": "text",
            "createdAt": "text",
            "updatedByName": "text",
            "updatedAt": "text",
            "name": "text",
            "type": "text",
            "priority": "LOW",
            "status": "ACTIVE",
            "templateName": "text"
          },
          "tasks": [
            {
              "id": "123e4567-e89b-12d3-a456-426614174000",
              "createdBy": "123e4567-e89b-12d3-a456-426614174000",
              "updatedBy": "123e4567-e89b-12d3-a456-426614174000",
              "createdByName": "text",
              "updatedByName": "text",
              "createdAt": "2026-01-01T00:00:00.000Z",
              "updatedAt": "2026-01-01T00:00:00.000Z",
              "name": "text",
              "description": "text",
              "dueDate": "2026-01-01T00:00:00.000Z",
              "status": "TODO",
              "priority": "LOW",
              "patient": {
                "id": "123e4567-e89b-12d3-a456-426614174000",
                "name": "text"
              },
              "assignee": {
                "id": "123e4567-e89b-12d3-a456-426614174000",
                "name": "text",
                "enabled": true
              },
              "watchers": [
                {
                  "id": "123e4567-e89b-12d3-a456-426614174000",
                  "name": "text",
                  "enabled": true
                }
              ],
              "comments": [
                {
                  "id": "123e4567-e89b-12d3-a456-426614174000",
                  "createdAt": "2026-01-01T00:00:00.000Z",
                  "author": {
                    "id": "123e4567-e89b-12d3-a456-426614174000",
                    "name": "text",
                    "enabled": true
                  },
                  "text": "text",
                  "patient": {
                    "id": "123e4567-e89b-12d3-a456-426614174000",
                    "name": "text"
                  },
                  "user": {
                    "id": "123e4567-e89b-12d3-a456-426614174000",
                    "name": "text"
                  }
                }
              ],
              "goalId": "123e4567-e89b-12d3-a456-426614174000",
              "templateName": "text",
              "createdType": "AUTOMATION",
              "sourceId": "123e4567-e89b-12d3-a456-426614174000",
              "sourceType": "ASSESSMENT",
              "hiddenPhi": true,
              "watchersType": "POINT_OF_CONTACT"
            }
          ],
          "comments": [
            {
              "id": "123e4567-e89b-12d3-a456-426614174000",
              "createdByName": "text",
              "createdAt": "2026-01-01T00:00:00.000Z",
              "updatedByName": "text",
              "updatedAt": "2026-01-01T00:00:00.000Z",
              "text": "text"
            }
          ]
        }
      ]
    }
  ],
  "cursor": {
    "start": "2026-01-01T00:00:00.000Z",
    "end": "2026-01-01T00:00:00.000Z",
    "hasNext": true,
    "pageSize": 1
  }
}

Export Voice Calls

get

Exports all voices calls stored in database

Authorizations
AuthorizationstringRequired

Bearer token obtained from POST /{tenantName}/admin/api_clients/{clientName}. Valid for 60 minutes.

Path parameters
tenantNamestringRequired

Your organization (tenant) name, e.g. acme-health

Example: acme-health
instanceNamestringRequired

Your environment name: live, sandbox, or a custom name

Example: live
Query parameters
startstringOptional

Used as a cursor for fetching data from the database. If the parameter is not specified, the selection will start from the oldest record

pageSizeintegerOptional

Min value is 1, max value is 500. If the parameter is not specified, the page size will be 500

Default: 20
patientIdsstring[]Optional

Allows you to export all Voice calls for a specific patient. If you need to export records for multiple patients, their IDs should be entered separated by commas.

Responses
200

Cursor-paginated export data.

application/json
get/{tenantName}/{instanceName}/export/VOICE_CALL
GET /{tenantName}/{instanceName}/export/VOICE_CALL HTTP/1.1
Host: api.live.welkincloud.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "data": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "createdAt": "2026-01-01T00:00:00.000Z",
      "updatedAt": "2026-01-01T00:00:00.000Z",
      "createdBy": "123e4567-e89b-12d3-a456-426614174000",
      "updatedBy": "123e4567-e89b-12d3-a456-426614174000",
      "createdByName": "text",
      "updatedByName": "text",
      "sendNow": true,
      "sentAt": "2026-01-01T00:00:00.000Z",
      "receivedAt": "2026-01-01T00:00:00.000Z",
      "deletedAt": "2026-01-01T00:00:00.000Z",
      "date": "2026-01-01T00:00:00.000Z",
      "careTeam": "text",
      "patientInfo": "text",
      "sender": "123e4567-e89b-12d3-a456-426614174000",
      "senderType": "CS_TOOL_CLIENT",
      "senderName": "text",
      "from": "text",
      "receiver": "123e4567-e89b-12d3-a456-426614174000",
      "receiverType": "CS_TOOL_CLIENT",
      "receiverName": "text",
      "to": "text",
      "direction": "OUT",
      "externalId": "text",
      "starred": true,
      "errorMessage": "text",
      "assignedBy": "123e4567-e89b-12d3-a456-426614174000",
      "assignedByName": "text",
      "hasHistory": true,
      "unrecognized": true,
      "childCallSid": "text",
      "parentCallStatus": "QUEUED",
      "childCallStatus": "QUEUED",
      "userPhone": "text",
      "parentCallDuration": 1,
      "childCallDuration": 1,
      "recorded": true,
      "recordingDuration": 1,
      "recordingSid": "text",
      "recordingUrl": "text",
      "recordingFile": {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "originalName": "text",
        "size": 1,
        "contentType": "text",
        "storageKey": "text"
      },
      "phoneId": "123e4567-e89b-12d3-a456-426614174000"
    }
  ],
  "cursor": {
    "start": "2026-01-01T00:00:00.000Z",
    "end": "2026-01-01T00:00:00.000Z",
    "hasNext": true,
    "pageSize": 1
  }
}

Export Patients

get

Exports all patients stored in database

Authorizations
AuthorizationstringRequired

Bearer token obtained from POST /{tenantName}/admin/api_clients/{clientName}. Valid for 60 minutes.

Path parameters
tenantNamestringRequired

Your organization (tenant) name, e.g. acme-health

Example: acme-health
instanceNamestringRequired

Your environment name: live, sandbox, or a custom name

Example: live
Query parameters
startstringOptional

Used as a cursor for fetching data from the database. If the parameter is not specified, the selection will start from the oldest record

Example: 2021-09-07T16:52:35.381Z
pageSizeintegerOptional

Min value is 1, max value is 500. If the parameter is not specified, the page size will be 500

Default: 20
Responses
200

Cursor-paginated export data.

application/json
get/{tenantName}/{instanceName}/export/PATIENT
GET /{tenantName}/{instanceName}/export/PATIENT HTTP/1.1
Host: api.live.welkincloud.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "data": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "externalGuid": "123e4567-e89b-12d3-a456-426614174000",
      "externalId": "text",
      "mrn": "text",
      "nric": "text",
      "accessCode": "text",
      "createdAt": "2026-01-01T00:00:00.000Z",
      "updatedAt": "2026-01-01T00:00:00.000Z",
      "createdByName": "text",
      "updatedByName": "text",
      "firstName": "text",
      "lastName": "text",
      "middleName": "text",
      "birthDate": "2026-01-01T00:00:00.000Z",
      "gender": "MALE",
      "maritalStatus": "A",
      "primaryLanguage": "ENGLISH",
      "secondaryLanguage": "ENGLISH",
      "email": "name@gmail.com",
      "secondaryEmail": "name@gmail.com",
      "phone": "text",
      "phoneLabel": "text",
      "primaryPhoneCapabilities": [
        "VOICE_CALL"
      ],
      "secondaryPhone": "text",
      "secondaryPhoneLabel": "text",
      "secondaryPhoneCapabilities": [
        "VOICE_CALL"
      ],
      "preferableInstancePhoneId": "123e4567-e89b-12d3-a456-426614174000",
      "country": "text",
      "state": "text",
      "city": "text",
      "zip": "text",
      "addressLine1": "text",
      "addressLine2": "text",
      "timezone": "text",
      "patientType": "ADULT",
      "notes": "text",
      "careTeamMembers": [
        {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "pointOfContact": true
        }
      ],
      "patientPrograms": [
        {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "createdByName": "text",
          "createdAt": "2026-01-01T00:00:00.000Z",
          "updatedByName": "text",
          "updatedAt": "2026-01-01T00:00:00.000Z",
          "programName": "text",
          "programTitle": "text",
          "programDescription": "text",
          "assigned": true,
          "patientId": "123e4567-e89b-12d3-a456-426614174000",
          "currentPhase": {
            "timestamp": "2026-01-01T00:00:00.000Z",
            "createdBy": "123e4567-e89b-12d3-a456-426614174000",
            "createdByName": "text",
            "name": "text",
            "title": "text",
            "description": "text",
            "currentVersion": "text",
            "deleted": true
          },
          "status": "NOT_STARTED",
          "compatibleWithCurrentVersion": true,
          "pathHistory": [
            {
              "timestamp": "2026-01-01T00:00:00.000Z",
              "createdBy": "123e4567-e89b-12d3-a456-426614174000",
              "createdByName": "text",
              "name": "text",
              "title": "text",
              "description": "text",
              "currentVersion": "text",
              "deleted": true
            }
          ]
        }
      ],
      "careTeam": [
        {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "username": "text",
          "firstName": "text",
          "lastName": "text",
          "email": "name@gmail.com",
          "roles": [
            {
              "name": "text",
              "primaryRole": true,
              "description": "text",
              "instanceId": "123e4567-e89b-12d3-a456-426614174000"
            }
          ],
          "pointOfContact": true,
          "enabled": true
        }
      ],
      "territorialTeam": [
        {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "username": "text",
          "firstName": "text",
          "lastName": "text",
          "email": "name@gmail.com",
          "roles": [
            {
              "name": "text",
              "primaryRole": true,
              "description": "text",
              "instanceId": "123e4567-e89b-12d3-a456-426614174000"
            }
          ],
          "pointOfContact": true,
          "enabled": true
        }
      ],
      "cadence": [
        {
          "schedules": [
            {
              "hour": 1,
              "minute": 1,
              "days": [
                "MONDAY"
              ],
              "weekNumbers": [
                1
              ]
            }
          ],
          "priority": "LOW"
        }
      ],
      "patientRegion": "text",
      "patientRegionTitle": "text",
      "patientTerritory": "text",
      "pointOfContact": {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "username": "text",
        "firstName": "text",
        "lastName": "text",
        "email": "name@gmail.com",
        "roles": [
          {
            "name": "text",
            "primaryRole": true,
            "description": "text",
            "instanceId": "123e4567-e89b-12d3-a456-426614174000"
          }
        ],
        "pointOfContact": true,
        "enabled": true
      },
      "ANY_ADDITIONAL_PROPERTY": "anything"
    }
  ],
  "cursor": {
    "start": "2026-01-01T00:00:00.000Z",
    "end": "2026-01-01T00:00:00.000Z",
    "hasNext": true,
    "pageSize": 1
  }
}

Export Chat Messages

get

Exports all chat messages stored in database

Authorizations
AuthorizationstringRequired

Bearer token obtained from POST /{tenantName}/admin/api_clients/{clientName}. Valid for 60 minutes.

Path parameters
tenantNamestringRequired

Your organization (tenant) name, e.g. acme-health

Example: acme-health
instanceNamestringRequired

Your environment name: live, sandbox, or a custom name

Example: live
Query parameters
startstringOptionalExample: 2022-11-07T16:52:35.410Z
pageSizeintegerOptionalDefault: 20Example: 5
Responses
200

Cursor-paginated export data.

application/json
get/{tenantName}/{instanceName}/export/CHAT
GET /{tenantName}/{instanceName}/export/CHAT HTTP/1.1
Host: api.live.welkincloud.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "data": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "sender": {
        "clientType": "CS_TOOL_CLIENT",
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "titleName": "text",
        "patientFullName": "text"
      },
      "receiver": {
        "clientType": "CS_TOOL_CLIENT",
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "titleName": "text",
        "patientFullName": "text"
      },
      "message": "text",
      "externalId": "text",
      "createdAt": "2026-01-01T00:00:00.000Z",
      "attachments": [
        {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "originalName": "text",
          "size": 1,
          "contentType": "text",
          "storageKey": "text"
        }
      ],
      "skipEvent": true,
      "deletedAt": "2026-01-01T00:00:00.000Z"
    }
  ],
  "cursor": {
    "start": "2026-01-01T00:00:00.000Z",
    "end": "2026-01-01T00:00:00.000Z",
    "hasNext": true,
    "pageSize": 1
  }
}

Export Programs

get

Exports all programs stored in database

Authorizations
AuthorizationstringRequired

Bearer token obtained from POST /{tenantName}/admin/api_clients/{clientName}. Valid for 60 minutes.

Path parameters
tenantNamestringRequired

Your organization (tenant) name, e.g. acme-health

Example: acme-health
instanceNamestringRequired

Your environment name: live, sandbox, or a custom name

Example: live
Query parameters
startstringOptional

Used as a cursor for fetching data from the database. If the parameter is not specified, the selection will start from the oldest record

Example: 2021-09-07T16:52:35.381Z
pageSizeintegerOptional

Min value is 1, max value is 500. If the parameter is not specified, the page size will be 500

Default: 20
patientIdsstring[]Optional

Allows you to export all programs for a specific patient. If you need to export records for multiple patients, their IDs should be entered separated by commas.

Responses
200

Cursor-paginated export data.

application/json
get/{tenantName}/{instanceName}/export/PATIENT_PROGRAM
GET /{tenantName}/{instanceName}/export/PATIENT_PROGRAM HTTP/1.1
Host: api.live.welkincloud.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "data": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "createdByName": "text",
      "createdAt": "2026-01-01T00:00:00.000Z",
      "updatedByName": "text",
      "updatedAt": "2026-01-01T00:00:00.000Z",
      "programName": "text",
      "programTitle": "text",
      "programDescription": "text",
      "assigned": true,
      "patientId": "123e4567-e89b-12d3-a456-426614174000",
      "currentPhase": {
        "timestamp": "2026-01-01T00:00:00.000Z",
        "createdBy": "123e4567-e89b-12d3-a456-426614174000",
        "createdByName": "text",
        "name": "text",
        "title": "text",
        "description": "text",
        "currentVersion": "text",
        "deleted": true
      },
      "status": "NOT_STARTED",
      "compatibleWithCurrentVersion": true,
      "pathHistory": [
        {
          "timestamp": "2026-01-01T00:00:00.000Z",
          "createdBy": "123e4567-e89b-12d3-a456-426614174000",
          "createdByName": "text",
          "name": "text",
          "title": "text",
          "description": "text",
          "currentVersion": "text",
          "deleted": true
        }
      ]
    }
  ],
  "cursor": {
    "start": "2026-01-01T00:00:00.000Z",
    "end": "2026-01-01T00:00:00.000Z",
    "hasNext": true,
    "pageSize": 1
  }
}

Export SMS

get

Exports all sms records stored in database

Authorizations
AuthorizationstringRequired

Bearer token obtained from POST /{tenantName}/admin/api_clients/{clientName}. Valid for 60 minutes.

Path parameters
tenantNamestringRequired

Your organization (tenant) name, e.g. acme-health

Example: acme-health
instanceNamestringRequired

Your environment name: live, sandbox, or a custom name

Example: live
Query parameters
startstringOptional

Used as a cursor for fetching data from the database. If the parameter is not specified, the selection will start from the oldest record

Example: 2021-09-04T17:51:01.817Z
pageSizeintegerOptional

Min value is 1, max value is 500. If the parameter is not specified, the page size will be 500

Default: 20
patientIdsstring[]Optional

Allows you to export all SMS for a specific patient. If you need to export records for multiple patients, their IDs should be entered separated by commas.

Responses
200

Cursor-paginated export data.

application/json
get/{tenantName}/{instanceName}/export/SMS
GET /{tenantName}/{instanceName}/export/SMS HTTP/1.1
Host: api.live.welkincloud.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "data": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "createdAt": "2026-01-01T00:00:00.000Z",
      "updatedAt": "2026-01-01T00:00:00.000Z",
      "createdBy": "123e4567-e89b-12d3-a456-426614174000",
      "updatedBy": "123e4567-e89b-12d3-a456-426614174000",
      "createdByName": "text",
      "updatedByName": "text",
      "sendNow": true,
      "sentAt": "2026-01-01T00:00:00.000Z",
      "receivedAt": "2026-01-01T00:00:00.000Z",
      "deletedAt": "2026-01-01T00:00:00.000Z",
      "date": "2026-01-01T00:00:00.000Z",
      "careTeam": "text",
      "patientInfo": "text",
      "sender": "123e4567-e89b-12d3-a456-426614174000",
      "senderType": "CS_TOOL_CLIENT",
      "senderName": "text",
      "from": "text",
      "receiver": "123e4567-e89b-12d3-a456-426614174000",
      "receiverType": "CS_TOOL_CLIENT",
      "receiverName": "text",
      "to": "text",
      "direction": "OUT",
      "externalId": "text",
      "starred": true,
      "errorMessage": "text",
      "assignedBy": "123e4567-e89b-12d3-a456-426614174000",
      "assignedByName": "text",
      "hasHistory": true,
      "unrecognized": true,
      "message": "text",
      "parts": 1,
      "status": "SCHEDULED",
      "messageType": "CARE_TEAM",
      "phoneId": "123e4567-e89b-12d3-a456-426614174000",
      "attachments": [
        {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "originalName": "text",
          "size": 1,
          "contentType": "text",
          "storageKey": "text"
        }
      ],
      "attachmentsFromTemplate": [
        {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "originalName": "text",
          "size": 1,
          "contentType": "text",
          "storageKey": "text"
        }
      ],
      "skipEvent": true
    }
  ],
  "cursor": {
    "start": "2026-01-01T00:00:00.000Z",
    "end": "2026-01-01T00:00:00.000Z",
    "hasNext": true,
    "pageSize": 1
  }
}

Export WhatsApp Messages

get
Authorizations
AuthorizationstringRequired

Bearer token obtained from POST /{tenantName}/admin/api_clients/{clientName}. Valid for 60 minutes.

Path parameters
tenantNamestringRequired

Your organization (tenant) name, e.g. acme-health

Example: acme-health
instanceNamestringRequired

Your environment name: live, sandbox, or a custom name

Example: live
Query parameters
startstringOptionalExample: 2022-11-07T16:52:35.410Z
pageSizeintegerOptionalDefault: 20Example: 5
Responses
200

Cursor-paginated export data.

application/json
get/{tenantName}/{instanceName}/export/WHATS_APP
GET /{tenantName}/{instanceName}/export/WHATS_APP HTTP/1.1
Host: api.live.welkincloud.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "data": [
    {
      "ANY_ADDITIONAL_PROPERTY": "anything"
    }
  ],
  "cursor": {
    "start": "2026-01-01T00:00:00.000Z",
    "end": "2026-01-01T00:00:00.000Z",
    "hasNext": true,
    "pageSize": 1
  }
}

Export Calendar Events

get

Exports all calendar events stored in database

Authorizations
AuthorizationstringRequired

Bearer token obtained from POST /{tenantName}/admin/api_clients/{clientName}. Valid for 60 minutes.

Path parameters
tenantNamestringRequired

Your organization (tenant) name, e.g. acme-health

Example: acme-health
instanceNamestringRequired

Your environment name: live, sandbox, or a custom name

Example: live
Query parameters
startstringOptional

Used as a cursor for fetching data from the database. If the parameter is not specified, the selection will start from the oldest record

pageSizeintegerOptional

Min value is 1, max value is 500. If the parameter is not specified, the page size will be 500

Default: 20
Responses
200

Cursor-paginated export data.

application/json
get/{tenantName}/{instanceName}/export/CALENDAR_EVENT
GET /{tenantName}/{instanceName}/export/CALENDAR_EVENT HTTP/1.1
Host: api.live.welkincloud.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "data": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "createdBy": "123e4567-e89b-12d3-a456-426614174000",
      "createdAt": "2026-01-01T00:00:00.000Z",
      "updatedBy": "123e4567-e89b-12d3-a456-426614174000",
      "updatedAt": "2026-01-01T00:00:00.000Z",
      "externalId": "text",
      "externalIdUpdatedAt": "2026-01-01T00:00:00.000Z",
      "eventTitle": "text",
      "eventDescription": "text",
      "startDateTime": "2026-01-01T00:00:00.000Z",
      "localStartDateTime": "2026-01-01T00:00:00.000Z",
      "endDateTime": "2026-01-01T00:00:00.000Z",
      "localEndDateTime": "2026-01-01T00:00:00.000Z",
      "allDayEvent": true,
      "duration": 1,
      "eventType": "text",
      "eventStatus": "text",
      "eventMode": "text",
      "eventColor": "text",
      "hostId": "123e4567-e89b-12d3-a456-426614174000",
      "timezone": "text",
      "additionalInfo": {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      },
      "acuityAppointmentId": 1,
      "externalCalendarEventId": "text",
      "encounterInfo": {
        "encounterId": "123e4567-e89b-12d3-a456-426614174000",
        "dispositionId": "123e4567-e89b-12d3-a456-426614174000",
        "templateName": "text",
        "templateTitle": "text",
        "patientId": "123e4567-e89b-12d3-a456-426614174000",
        "title": "text",
        "description": "text",
        "notes": "text",
        "type": "text",
        "status": "DRAFT",
        "serviceCost": 1,
        "preVisitCost": 1,
        "visitServices": [
          {
            "name": "text",
            "quantity": 1,
            "serviceCost": 1,
            "cancellationFee": 1,
            "preVisitCost": 1,
            "modifiers": [
              "text"
            ]
          }
        ],
        "location": "text"
      },
      "participants": [
        {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "participantId": "123e4567-e89b-12d3-a456-426614174000",
          "participantRole": "patient",
          "participationStatus": "UNKNOWN",
          "attended": true,
          "timezone": "text",
          "firstName": "text",
          "lastName": "text",
          "deleted": true,
          "hasAccess": true,
          "hiddenPhi": true,
          "email": "name@gmail.com",
          "phone": "text",
          "gender": "MALE",
          "birthDate": "2026-01-01T00:00:00.000Z",
          "enabled": true
        }
      ],
      "externalEventMetadata": {
        "participants": [
          {
            "email": "name@gmail.com",
            "status": "UNKNOWN",
            "owner": true
          }
        ],
        "calendarProvider": "GOOGLE"
      }
    }
  ],
  "cursor": {
    "start": "2026-01-01T00:00:00.000Z",
    "end": "2026-01-01T00:00:00.000Z",
    "hasNext": true,
    "pageSize": 1
  }
}

Export Email

get

Exports all emails stored in database

Authorizations
AuthorizationstringRequired

Bearer token obtained from POST /{tenantName}/admin/api_clients/{clientName}. Valid for 60 minutes.

Path parameters
tenantNamestringRequired

Your organization (tenant) name, e.g. acme-health

Example: acme-health
instanceNamestringRequired

Your environment name: live, sandbox, or a custom name

Example: live
Query parameters
startstringOptional

Used as a cursor for fetching data from the database. If the parameter is not specified, the selection will start from the oldest record

Example: 2021-08-16T15:22:13.823Z
pageSizeintegerOptional

Min value is 1, max value is 500. If the parameter is not specified, the page size will be 500

Default: 20
patientIdsstring[]Optional

Allows you to export all emails for a specific patient. If you need to export records for multiple patients, their IDs should be entered separated by commas.

Responses
200

Cursor-paginated export data.

application/json
get/{tenantName}/{instanceName}/export/EMAIL
GET /{tenantName}/{instanceName}/export/EMAIL HTTP/1.1
Host: api.live.welkincloud.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "data": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "createdAt": "2026-01-01T00:00:00.000Z",
      "updatedAt": "2026-01-01T00:00:00.000Z",
      "createdBy": "123e4567-e89b-12d3-a456-426614174000",
      "updatedBy": "123e4567-e89b-12d3-a456-426614174000",
      "createdByName": "text",
      "updatedByName": "text",
      "sendNow": true,
      "sentAt": "2026-01-01T00:00:00.000Z",
      "receivedAt": "2026-01-01T00:00:00.000Z",
      "deletedAt": "2026-01-01T00:00:00.000Z",
      "date": "2026-01-01T00:00:00.000Z",
      "careTeam": "text",
      "patientInfo": "text",
      "sender": "123e4567-e89b-12d3-a456-426614174000",
      "senderType": "CS_TOOL_CLIENT",
      "senderName": "text",
      "from": "text",
      "receiver": "123e4567-e89b-12d3-a456-426614174000",
      "receiverType": "CS_TOOL_CLIENT",
      "receiverName": "text",
      "to": "text",
      "direction": "OUT",
      "externalId": "text",
      "starred": true,
      "errorMessage": "text",
      "assignedBy": "123e4567-e89b-12d3-a456-426614174000",
      "assignedByName": "text",
      "hasHistory": true,
      "unrecognized": true,
      "subject": "text",
      "body": "text",
      "emailEditorJson": "text",
      "status": "SCHEDULED",
      "secure": false,
      "attachments": [
        {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "originalName": "text",
          "size": 1,
          "contentType": "text",
          "storageKey": "text"
        }
      ],
      "attachmentsFromTemplate": [
        {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "originalName": "text",
          "size": 1,
          "contentType": "text",
          "storageKey": "text"
        }
      ],
      "bodyAttachments": [
        {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "originalName": "text",
          "size": 1,
          "contentType": "text",
          "storageKey": "text",
          "url": "https://example.com",
          "thumbnailUrl": "https://example.com"
        }
      ],
      "messageType": "CARE_TEAM",
      "bodyType": "PLAIN_TEXT",
      "inReplyTo": "text",
      "messageId": "text",
      "skipEvent": true
    }
  ],
  "cursor": {
    "start": "2026-01-01T00:00:00.000Z",
    "end": "2026-01-01T00:00:00.000Z",
    "hasNext": true,
    "pageSize": 1
  }
}

Export Tasks

get

Exports all tasks stored in database

Authorizations
AuthorizationstringRequired

Bearer token obtained from POST /{tenantName}/admin/api_clients/{clientName}. Valid for 60 minutes.

Path parameters
tenantNamestringRequired

Your organization (tenant) name, e.g. acme-health

Example: acme-health
instanceNamestringRequired

Your environment name: live, sandbox, or a custom name

Example: live
Query parameters
startstringOptional

Used as a cursor for fetching data from the database. If the parameter is not specified, the selection will start from the oldest record

pageSizeintegerOptional

Min value is 1, max value is 500. If the parameter is not specified, the page size will be 500

Default: 20
Responses
200

Cursor-paginated export data.

application/json
get/{tenantName}/{instanceName}/export/TASK
GET /{tenantName}/{instanceName}/export/TASK HTTP/1.1
Host: api.live.welkincloud.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "data": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "createdBy": "123e4567-e89b-12d3-a456-426614174000",
      "updatedBy": "123e4567-e89b-12d3-a456-426614174000",
      "createdByName": "text",
      "updatedByName": "text",
      "createdAt": "2026-01-01T00:00:00.000Z",
      "updatedAt": "2026-01-01T00:00:00.000Z",
      "name": "text",
      "description": "text",
      "dueDate": "2026-01-01T00:00:00.000Z",
      "status": "TODO",
      "priority": "LOW",
      "patient": {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "name": "text"
      },
      "assignee": {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "name": "text",
        "enabled": true
      },
      "watchers": [
        {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "name": "text",
          "enabled": true
        }
      ],
      "comments": [
        {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "createdAt": "2026-01-01T00:00:00.000Z",
          "author": {
            "id": "123e4567-e89b-12d3-a456-426614174000",
            "name": "text",
            "enabled": true
          },
          "text": "text",
          "patient": {
            "id": "123e4567-e89b-12d3-a456-426614174000",
            "name": "text"
          },
          "user": {
            "id": "123e4567-e89b-12d3-a456-426614174000",
            "name": "text"
          }
        }
      ],
      "goalId": "123e4567-e89b-12d3-a456-426614174000",
      "templateName": "text",
      "createdType": "AUTOMATION",
      "sourceId": "123e4567-e89b-12d3-a456-426614174000",
      "sourceType": "ASSESSMENT",
      "hiddenPhi": true,
      "watchersType": "POINT_OF_CONTACT"
    }
  ],
  "cursor": {
    "start": "2026-01-01T00:00:00.000Z",
    "end": "2026-01-01T00:00:00.000Z",
    "hasNext": true,
    "pageSize": 1
  }
}

Export Assessment

get

Exports all assessments stored in database

Authorizations
AuthorizationstringRequired

Bearer token obtained from POST /{tenantName}/admin/api_clients/{clientName}. Valid for 60 minutes.

Path parameters
tenantNamestringRequired

Your organization (tenant) name, e.g. acme-health

Example: acme-health
instanceNamestringRequired

Your environment name: live, sandbox, or a custom name

Example: live
Query parameters
startstringOptional

Used as a cursor for fetching data from the database. If the parameter is not specified, the selection will start from the oldest record

pageSizeintegerOptional

Min value is 1, max value is 500. If the parameter is not specified, the page size will be 500

Default: 20
patientIdsstring[]Optional

Allows you to export all assessments for a specific patient. If you need to export records for multiple patients, their IDs should be entered separated by commas.

Responses
200

Cursor-paginated export data.

application/json
get/{tenantName}/{instanceName}/export/ASSESSMENT
GET /{tenantName}/{instanceName}/export/ASSESSMENT HTTP/1.1
Host: api.live.welkincloud.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "data": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "createdAt": "2026-01-01T00:00:00.000Z",
      "updatedAt": "2026-01-01T00:00:00.000Z",
      "finalizedDate": "2026-01-01T00:00:00.000Z",
      "assessmentName": "text",
      "assessmentTitle": "text",
      "assessmentCdtName": "text",
      "version": 1,
      "patientId": "123e4567-e89b-12d3-a456-426614174000",
      "status": "text",
      "cdtRecordId": "123e4567-e89b-12d3-a456-426614174000",
      "scoringRecordId": "123e4567-e89b-12d3-a456-426614174000",
      "answers": {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      },
      "scoring": {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      },
      "questions": {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      }
    }
  ],
  "cursor": {
    "start": "2026-01-01T00:00:00.000Z",
    "end": "2026-01-01T00:00:00.000Z",
    "hasNext": true,
    "pageSize": 1
  }
}

Export PFA

get

Exports all assessments sent to the patient

Authorizations
AuthorizationstringRequired

Bearer token obtained from POST /{tenantName}/admin/api_clients/{clientName}. Valid for 60 minutes.

Path parameters
tenantNamestringRequired

Your organization (tenant) name, e.g. acme-health

Example: acme-health
instanceNamestringRequired

Your environment name: live, sandbox, or a custom name

Example: live
Query parameters
startstringOptional

Used as a cursor for fetching data from the database. If the parameter is not specified, the selection will start from the oldest record

pageSizeintegerOptional

Min value is 1, max value is 500. If the parameter is not specified, the page size will be 500

Default: 20
Responses
200

Cursor-paginated export data.

application/json
get/{tenantName}/{instanceName}/export/PFA
GET /{tenantName}/{instanceName}/export/PFA HTTP/1.1
Host: api.live.welkincloud.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "data": [
    {
      "ANY_ADDITIONAL_PROPERTY": "anything"
    }
  ],
  "cursor": {
    "start": "2026-01-01T00:00:00.000Z",
    "end": "2026-01-01T00:00:00.000Z",
    "hasNext": true,
    "pageSize": 1
  }
}

Export Encounter

get

Exports all encounters stored in database

Authorizations
AuthorizationstringRequired

Bearer token obtained from POST /{tenantName}/admin/api_clients/{clientName}. Valid for 60 minutes.

Path parameters
tenantNamestringRequired

Your organization (tenant) name, e.g. acme-health

Example: acme-health
instanceNamestringRequired

Your environment name: live, sandbox, or a custom name

Example: live
Query parameters
startstringOptional

Used as a cursor for fetching data from the database. If the parameter is not specified, the selection will start from the oldest record

pageSizeintegerOptional

Min value is 1, max value is 500. If the parameter is not specified, the page size will be 500

Default: 20
patientIdsstring[]Optional

Allows you to export all CDT records for a specific patient. If you need to export records for multiple patients, their IDs should be entered separated by commas.

Responses
200

Cursor-paginated export data.

application/json
get/{tenantName}/{instanceName}/export/ENCOUNTER
GET /{tenantName}/{instanceName}/export/ENCOUNTER HTTP/1.1
Host: api.live.welkincloud.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "data": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "patientId": "123e4567-e89b-12d3-a456-426614174000",
      "cdtId": "123e4567-e89b-12d3-a456-426614174000",
      "version": 1,
      "cdtName": "text",
      "jsonBody": {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      }
    }
  ],
  "cursor": {
    "start": "2026-01-01T00:00:00.000Z",
    "end": "2026-01-01T00:00:00.000Z",
    "hasNext": true,
    "pageSize": 1
  }
}

Export Encounter Comments

get

Exports all encounter comments stored in database

Authorizations
AuthorizationstringRequired

Bearer token obtained from POST /{tenantName}/admin/api_clients/{clientName}. Valid for 60 minutes.

Path parameters
tenantNamestringRequired

Your organization (tenant) name, e.g. acme-health

Example: acme-health
instanceNamestringRequired

Your environment name: live, sandbox, or a custom name

Example: live
Query parameters
startstringOptional

Used as a cursor for fetching data from the database. If the parameter is not specified, the selection will start from the oldest record

pageSizeintegerOptional

Min value is 1, max value is 500. If the parameter is not specified, the page size will be 500

Default: 20
Responses
200

Cursor-paginated export data.

application/json
get/{tenantName}/{instanceName}/export/ENCOUNTER_COMMENT
GET /{tenantName}/{instanceName}/export/ENCOUNTER_COMMENT HTTP/1.1
Host: api.live.welkincloud.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "data": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "createdAt": "2026-01-01T00:00:00.000Z",
      "updatedAt": "2026-01-01T00:00:00.000Z",
      "createdByName": "text",
      "updatedByName": "text",
      "encounterId": "123e4567-e89b-12d3-a456-426614174000",
      "text": "text"
    }
  ],
  "cursor": {
    "start": "2026-01-01T00:00:00.000Z",
    "end": "2026-01-01T00:00:00.000Z",
    "hasNext": true,
    "pageSize": 1
  }
}

Export Encounter Disposition

get

Exports all encounter dispositions stored in database

Authorizations
AuthorizationstringRequired

Bearer token obtained from POST /{tenantName}/admin/api_clients/{clientName}. Valid for 60 minutes.

Path parameters
tenantNamestringRequired

Your organization (tenant) name, e.g. acme-health

Example: acme-health
instanceNamestringRequired

Your environment name: live, sandbox, or a custom name

Example: live
Query parameters
startstringOptional

Used as a cursor for fetching data from the database. If the parameter is not specified, the selection will start from the oldest record

pageSizeintegerOptional

Min value is 1, max value is 500. If the parameter is not specified, the page size will be 500

Default: 20
patientIdsstring[]Optional

Allows you to export all CDT records for a specific patient. If you need to export records for multiple patients, their IDs should be entered separated by commas.

Responses
200

Cursor-paginated export data.

application/json
get/{tenantName}/{instanceName}/export/ENCOUNTER_DISPOSITION
GET /{tenantName}/{instanceName}/export/ENCOUNTER_DISPOSITION HTTP/1.1
Host: api.live.welkincloud.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "data": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "patientId": "123e4567-e89b-12d3-a456-426614174000",
      "cdtId": "123e4567-e89b-12d3-a456-426614174000",
      "version": 1,
      "cdtName": "text",
      "jsonBody": {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      }
    }
  ],
  "cursor": {
    "start": "2026-01-01T00:00:00.000Z",
    "end": "2026-01-01T00:00:00.000Z",
    "hasNext": true,
    "pageSize": 1
  }
}

Export Automation Audit

get

Exports all automation audit records stored in the database

Authorizations
AuthorizationstringRequired

Bearer token obtained from POST /{tenantName}/admin/api_clients/{clientName}. Valid for 60 minutes.

Path parameters
tenantNamestringRequired

Your organization (tenant) name, e.g. acme-health

Example: acme-health
instanceNamestringRequired

Your environment name: live, sandbox, or a custom name

Example: live
Query parameters
startstringOptional

Used as a cursor for fetching data from the database. If the parameter is not specified, the selection will start from the oldest record

pageSizeintegerOptional

Min value is 1, max value is 1000. If the parameter is not specified, the page size will be 1000

Default: 20
statusstringOptional

Allows you to retrieve records for a specific status only. Available values failure, success, conditions_check_failed

Responses
200

Cursor-paginated export data (generic placeholder).

application/json
get/{tenantName}/{instanceName}/export/automation-audit
GET /{tenantName}/{instanceName}/export/automation-audit HTTP/1.1
Host: api.live.welkincloud.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "data": [
    {
      "ANY_ADDITIONAL_PROPERTY": "anything"
    }
  ],
  "cursor": {
    "start": "2026-01-01T00:00:00.000Z",
    "end": "2026-01-01T00:00:00.000Z",
    "hasNext": true,
    "pageSize": 1
  }
}

Export Contacts

get

This endpoint allows you to retrieve an export of contact data from the specified tenant and instance. The exported data will be in a format suitable for further analysis or integration with other systems.

Request

  • Method: GET

  • URL: {{url}}/{{tenantName}}/{{instanceName}}/export/CONTACT

Response

The response will contain the exported contact data in a suitable format, typically JSON.

Example

Request:

arduinoCopy codeGET {{url}}/{{tenantName}}/{{instanceName}}/export/CONTACT

Response:

perlCopy code{
  "contacts": [
    {
      "id": "1",
      "name": "John Doe",
      "email": "johndoe@example.com",
      "phone": "123-456-7890"
    },
    {
      "id": "2",
      "name": "Jane Smith",
      "email": "janesmith@example.com",
      "phone": "987-654-3210"
    },
    ...
  ]
}

Error Codes

  • 404 Not Found: The specified {{tenantName}} or {{instanceName}} does not exist.

Authentication

Make sure to include appropriate authentication credentials, such as an API key or token, in the request headers for accessing this endpoint.

Rate Limiting

This endpoint may be subject to rate limiting. If you encounter rate limit errors, please wait for a suitable period of time before making additional requests.

Notes

  • This endpoint is specifically designed for exporting contact data. If you need to export data of a different type, refer to the corresponding endpoint documentation.

  • Ensure that you have the necessary permissions and access rights to retrieve contact data from the specified {{tenantName}} and {{instanceName}}.

Authorizations
AuthorizationstringRequired

Bearer token obtained from POST /{tenantName}/admin/api_clients/{clientName}. Valid for 60 minutes.

Path parameters
tenantNamestringRequired

Your organization (tenant) name, e.g. acme-health

Example: acme-health
instanceNamestringRequired

Your environment name: live, sandbox, or a custom name

Example: live
Query parameters
startstringOptionalExample: 2022-11-07T16:52:35.410Z
pageSizeintegerOptionalDefault: 20Example: 5
Responses
200

Cursor-paginated export data.

application/json
get/{tenantName}/{instanceName}/export/CONTACT
GET /{tenantName}/{instanceName}/export/CONTACT HTTP/1.1
Host: api.live.welkincloud.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "data": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "createdAt": "2026-01-01T00:00:00.000Z",
      "updatedAt": "2026-01-01T00:00:00.000Z",
      "createdBy": "123e4567-e89b-12d3-a456-426614174000",
      "updatedBy": "123e4567-e89b-12d3-a456-426614174000",
      "createdByName": "text",
      "updatedByName": "text",
      "name": "text",
      "email": "name@gmail.com",
      "emailLabel": "text",
      "emailPdtFieldName": "text",
      "phone": "text",
      "phoneLabel": "text",
      "phonePdtFieldName": "text",
      "secondaryPhone": "text",
      "secondaryPhoneLabel": "text",
      "secondaryPhonePdtFieldName": "text",
      "patientId": "123e4567-e89b-12d3-a456-426614174000",
      "pdtRecordId": "123e4567-e89b-12d3-a456-426614174000",
      "relation": "text",
      "active": true
    }
  ],
  "cursor": {
    "start": "2026-01-01T00:00:00.000Z",
    "end": "2026-01-01T00:00:00.000Z",
    "hasNext": true,
    "pageSize": 1
  }
}

Export Document Summary

get
Authorizations
AuthorizationstringRequired

Bearer token obtained from POST /{tenantName}/admin/api_clients/{clientName}. Valid for 60 minutes.

Path parameters
tenantNamestringRequired

Your organization (tenant) name, e.g. acme-health

Example: acme-health
instanceNamestringRequired

Your environment name: live, sandbox, or a custom name

Example: live
Query parameters
startstringOptional

Used as a cursor for fetching data from the database. If the parameter is not specified, the selection will start from the oldest record

Example: 2024-08-09T11:44:39.289Z
patientIdstring · uuidOptional

Allows you to export all document summary records for a specific patient. If you need to export records for multiple patients, their IDs should be entered separated by commas.

Responses
200

Cursor-paginated export data.

application/json
get/{tenantName}/{instanceName}/export/DOCUMENT_SUMMARY
GET /{tenantName}/{instanceName}/export/DOCUMENT_SUMMARY HTTP/1.1
Host: api.live.welkincloud.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "data": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "patientId": "123e4567-e89b-12d3-a456-426614174000",
      "cdtId": "123e4567-e89b-12d3-a456-426614174000",
      "version": 1,
      "cdtName": "text",
      "jsonBody": {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      }
    }
  ],
  "cursor": {
    "start": "2026-01-01T00:00:00.000Z",
    "end": "2026-01-01T00:00:00.000Z",
    "hasNext": true,
    "pageSize": 1
  }
}
PreviousAudit
NextDocument Types Formation

Last updated

Was this helpful?