Copy page

Partner API

Provider Information Updates API

This document describes the two available methods for retrieving updated location and provider records from Intelibly:

• GET /api/changes?cursor=..., an HTTP API
• Daily JSONL file uploads via SFTP

Both channels return the same structured data in a standardized format.

HTTP API: retrieve updates

Endpoint

Code
GET /api/changes?cursor=<timestamp>

The endpoint is global; the authenticated token determines which partner's data is accessible. You do not need to specify a partner ID in the URL.

Purpose

Fetches a chronologically ordered stream of all location and provider records that have changed since the given timestamp (cursor). This is useful for partners who prefer to poll for changes.

Query parameters

Authentication

All API requests must be authenticated with bearer token authentication:

• Include an Authorization header in each request: Authorization: Bearer <your_api_token>
• API tokens are issued to each partner and should be kept secure.
• Requests without valid authentication receive a 401 Unauthorized response.

Response format

The API responds in JSON Lines (JSONL) format. Each line is a valid JSON object. There are two types of entries:

• location entries
• provider entries

Example response

Code
{"type":"location","location":{"id":101,"name":"CareSmile Dental","street":"123 Main St","city":"Dallas","state":"TX","zip":"75201","partners_internal_id":"LOC-2025-0001","updated_at":"2025-06-05T07:22:30Z","inserted_at":"2024-08-15T10:00:00Z"}}
{"type":"provider","provider":{"id":205,"name":"Dr. Alicia Rivera","npi_number":"1770954829","bio":"Specialist in cosmetic and restorative dentistry.","partners_internal_id":"PROV-311X","updated_at":"2025-06-05T07:23:45Z","inserted_at":"2024-11-01T14:30:00Z"}}

Field descriptions

Location payload

Provider payload

HTTP status codes

SFTP file delivery

Overview

As an alternative to polling the API, Intelibly offers automatic daily uploads of change data to your organization's configured SFTP server.

Format

• Files are in JSONL format, identical in structure to the API response.
• Each line is either a location or provider object.

Delivery details

Example file contents

Code
{"type":"location","location":{"id":101,"name":"CareSmile Dental","street":"123 Main St","city":"Dallas","state":"TX","zip":"75201","partners_internal_id":"LOC-2025-0001","updated_at":"2025-06-05T07:22:30Z","inserted_at":"2024-08-15T10:00:00Z"}}
{"type":"location","location":{"id":102,"name":"BrightDental Clinic","street":"987 Oak Ave","city":"Plano","state":"TX","zip":"75024","partners_internal_id":"LOC-2025-0002","updated_at":"2025-06-05T07:22:59Z","inserted_at":"2024-12-12T09:00:00Z"}}
{"type":"provider","provider":{"id":205,"name":"Dr. Alicia Rivera","npi_number":"1770954829","bio":"Specialist in cosmetic and restorative dentistry.","partners_internal_id":"PROV-311X","updated_at":"2025-06-05T07:23:45Z","inserted_at":"2024-11-01T14:30:00Z"}}

Security and integrity

• Files are transferred via secure SFTP with credential-based access.
• Files are removed from Intelibly's servers after successful delivery.
• Timestamp cursors are used to prevent duplicate deliveries.

Authentication credentials

Each partner provides Intelibly with unique SFTP credentials:

• Username: provided by the partner's team
• Password: provided by the partner's team (or an SSH key, if preferred)

Credentials are required to access the SFTP server and exchange files.

Tips for consumers

• When using the API, save the latest updated_at timestamp and use it as the next cursor.
• When using SFTP, assume the file contains only new changes since your last pull.
• Process each line independently; there is no need to parse the entire file into memory.