Sign in

v4

OpenAPI 3.1.02026-07-3156189324.6 KB
Integrations Resource Records V2

Sync Integration Resource Records Data

get/integrations/v2/resource-records/{integration_id}/type/{resource_record_type}/sync

Path parameters

integration_idstring required
Example:5eb7cf5a86d9755df3a6c593
resource_record_type'locations' | 'practitioners' | 'visiting_reasons' | 'patients' | 'insurance_details' | 'appointments' | 'waitlist' | 'outreach' | 'appointment_types' | 'visit_statuses' | 'insurance_payers' required

Defines the type of resource record.

Query parameters

sizeinteger

Number of items per page

Number of items per page

pageinteger

Page number

Page number

searchstring nullable

Search keywords

Search keywords

startstring date-time nullable

Filter by start time (ISO 8601 format)

Filter by start time (ISO 8601 format)

endstring date-time nullable

Filter by end time (ISO 8601 format)

Filter by end time (ISO 8601 format)

Response

Successful Response

totalinteger nullable

Total number of integrations resource records available without pagination.

Example response

{
  "integration_resource_records": [
    {
      "teamId": "5eb7cf5a86d9755df3a6c593",
      "createdBy": "5eb7cf5a86d9755df3a6c593",
      "updatedBy": "5eb7cf5a86d9755df3a6c593",
      "_id": "5eb7cf5a86d9755df3a6c593",
      "integrationId": "5eb7cf5a86d9755df3a6c593",
      "config": {
        "supervisorId": "5eb7cf5a86d9755df3a6c593",
        "preferred_visiting_reasons": [
          "5eb7cf5a86d9755df3a6c593"
        ]
      }
    }
  ]
}