Skip to main content
GET
/
integrations
/
v2
/
resource-records
/
{integration_id}
/
type
/
{resource_record_type}
/
sync
Sync Integration Resource Records Data
curl --request GET \
  --url https://api-qa.interactly.ai/integrations/v2/resource-records/{integration_id}/type/{resource_record_type}/sync \
  --header 'Authorization: Bearer <token>'
{
  "integration_resource_records": [
    {
      "teamId": "5eb7cf5a86d9755df3a6c593",
      "createdBy": "5eb7cf5a86d9755df3a6c593",
      "updatedBy": "5eb7cf5a86d9755df3a6c593",
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z",
      "_id": "5eb7cf5a86d9755df3a6c593",
      "logicalId": "<string>",
      "integrationId": "5eb7cf5a86d9755df3a6c593",
      "config": {
        "type": "practitioners",
        "organizationId": "<string>",
        "id": "<string>",
        "name": "<string>",
        "gender": "<string>",
        "avatar": "<string>",
        "summary": "<string>",
        "qualification": "<string>",
        "education": "<string>",
        "supervisorId": "5eb7cf5a86d9755df3a6c593",
        "status": "active",
        "languages": [
          "<string>"
        ],
        "specialties": [
          {
            "name": "<string>",
            "code": "<string>"
          }
        ],
        "locations": [
          {
            "locationId": "<string>",
            "locationName": "<string>"
          }
        ],
        "preferred_visiting_reasons": [
          "5eb7cf5a86d9755df3a6c593"
        ],
        "recordSource": "from_upstream"
      }
    }
  ],
  "total": 123
}

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

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.