Skip to main content
GET
/
api
/
v1
/
sync
/
logs
List sync logs
curl --request GET \
  --url https://breadbox.example.com/api/v1/sync/logs \
  --header 'X-API-Key: <api-key>'
{
  "sync_logs": [
    {
      "id": "<string>",
      "short_id": "<string>",
      "connection_id": "<string>",
      "started_at": "2023-11-07T05:31:56Z",
      "finished_at": "2023-11-07T05:31:56Z",
      "added_count": 123,
      "modified_count": 123,
      "removed_count": 123,
      "error_message": "<string>"
    }
  ],
  "next_cursor": "<string>",
  "has_more": true,
  "limit": 123
}

Documentation Index

Fetch the complete documentation index at: https://docs.breadbox.sh/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
X-API-Key
string
header
required

Breadbox API key with format bb_<base62>. Carries either read_only or full_access scope. Write endpoints (and a handful of sensitive reads — /api-keys, /users/{user_id}/login) require full_access; endpoints that require it are flagged in their description.

Query Parameters

​
cursor
string

Opaque pagination cursor returned by a previous list response.

​
limit
integer

Page size (default 50, capped per-endpoint).

Required range: 1 <= x <= 200
​
connection_id
string
​
status
enum<string>
Available options:
in_progress,
success,
error
​
trigger
enum<string>
Available options:
cron,
webhook,
manual,
initial

Response

200 - application/json

Sync logs.

​
sync_logs
object[]
​
next_cursor
string | null
​
has_more
boolean
​
limit
integer