Skip to main content
Every list endpoint answers from the connected system’s last completed sync.

​
How a read works

Freshness is set by the sync, not by your request. A record edited an hour ago is invisible until the next sync runs - see Syncing. Reads succeed even when syncing is broken. A connector that stopped syncing weeks ago still returns 200 with stale data. Nothing in the response says so, so health has to be watched separately - see Sync Status. Change events tell you a record moved, and carry enough to go and read it - see Webhooks. Every request needs your API key and the connector token for the end customer whose data you are reading:

​
Query parameters

Query parameters control what comes back. They work alongside cursor and page_size, and combine in a single request.

Filters

Narrow the result set to the records you care about.

Expand

Return related objects inline instead of just their IDs.

modified_after

Return only records updated since a point in time.

​
Putting it together

Filters, expand, modified_after and pagination all compose in a single request:
That request returns active employees changed since the given timestamp, 200 records per page.

Pagination

Page through large result sets with cursor and page_size.

Syncing

How often Bindbee pulls fresh data from each connector.

Webhooks

Get notified when data is created or modified instead of polling.

Custom fields

Extend unified models with fields specific to your use case.