Sign in

v5

latestOpenAPI 3.1.02026-08-0456189324.9 KB
Integrations IO V2

Export Integration

get/integrations/v2/integrations/{integration_id}/export

Path parameters

integration_idstring required
Example:5eb7cf5a86d9755df3a6c593

Query parameters

include_appointmentsboolean
include_patientsboolean
include_outreachboolean

Response

Successful Response

Example response

{
  "integration": {
    "teamId": "5eb7cf5a86d9755df3a6c593",
    "createdBy": "5eb7cf5a86d9755df3a6c593",
    "updatedBy": "5eb7cf5a86d9755df3a6c593",
    "_id": "5eb7cf5a86d9755df3a6c593"
  },
  "use_cases": [
    {
      "teamId": "5eb7cf5a86d9755df3a6c593",
      "createdBy": "5eb7cf5a86d9755df3a6c593",
      "updatedBy": "5eb7cf5a86d9755df3a6c593",
      "_id": "5eb7cf5a86d9755df3a6c593",
      "integrationId": "5eb7cf5a86d9755df3a6c593",
      "config": {
        "assistantId": "5eb7cf5a86d9755df3a6c593"
      }
    }
  ],
  "resource_records": [
    {
      "teamId": "5eb7cf5a86d9755df3a6c593",
      "createdBy": "5eb7cf5a86d9755df3a6c593",
      "updatedBy": "5eb7cf5a86d9755df3a6c593",
      "_id": "5eb7cf5a86d9755df3a6c593",
      "integrationId": "5eb7cf5a86d9755df3a6c593",
      "config": {
        "supervisorId": "5eb7cf5a86d9755df3a6c593",
        "preferred_visiting_reasons": [
          "5eb7cf5a86d9755df3a6c593"
        ]
      }
    }
  ]
}