Skip to main content
GET
/
api
/
v1
/
sync
/
logs
/
{id}
Get a sync log
curl --request GET \
  --url https://breadbox.example.com/api/v1/sync/logs/{id} \
  --header 'X-API-Key: <api-key>'
{
  "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>"
}

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.

Path Parameters

id
string
required

UUID or 8-char short_id.

Response

Sync log.

id
string
short_id
string
connection_id
string
status
enum<string>
Available options:
in_progress,
success,
error
trigger
enum<string>
Available options:
cron,
webhook,
manual,
initial
started_at
string<date-time>
finished_at
string<date-time> | null
added_count
integer | null
modified_count
integer | null
removed_count
integer | null
error_message
string | null