Skip to main content
GET
Sync Integration Resource Records Data

Authorizations

Authorization
string
header
required

Retrieve your API Key from Dashboard API Keys Section.

Path Parameters

integration_id
string
required
Required string length: 24
Pattern: ^[0-9a-f]{24}$
Example:

"5eb7cf5a86d9755df3a6c593"

resource_record_type
enum<string>
required

Defines the type of resource record.

Available options:
locations,
practitioners,
visiting_reasons,
patients,
insurance_details,
appointments,
waitlist,
outreach,
appointment_types,
visit_statuses,
insurance_payers

Query Parameters

size
integer
default:300

Number of items per page

Required range: x >= 1
page
integer
default:1

Page number

Required range: x >= 1
search
string | null

Search keywords

start
string<date-time> | null

Filter by start time (ISO 8601 format)

end
string<date-time> | null

Filter by end time (ISO 8601 format)

Response

Successful Response

Response model for a list of integrations resource records. Contains a list of IntegrationsResourceRecordsModel objects.

integration_resource_records
IntegrationsResourceRecordsModel · object[]

List of integrations resource records

total
integer | null

Total number of integrations resource records available without pagination.