Sign in
Sync

Per-resource sync state (repos / channels / collections) for one connection

Changed on
get/workspaces/{workspaceSlug}/connections/{connectionId}/sync/resources

Request

  • Base URL: / (relative, and the document was published on a file host, not at the API’s origin)
  • URL: /workspaces/{workspaceSlug}/connections/{connectionId}/sync/resources
  • Auth: HTTP bearer

Path parameters

workspaceSlugstring required

Workspace slug

connectionIdinteger required

Response

OK

backfillCompletedThroughstring date-time

Per-resource backfill horizon

backfillPercentinteger

Per-resource backfill percent

externalIdstring required

Vendor-side identifier

idinteger required

The integration's own row id

itemCountinteger

Headline mirrored item count — the rollup of counts

lastErrorstring

Last sync error, if any

lastSyncedAtstring date-time

Last successful sync timestamp across all entity classes

namestring required

Display name

statestring required

Integration-defined status string

type'REPOSITORY' | 'CHANNEL' | 'COLLECTION' required

Resource kind

upstreamCountinteger

Vendor-reported upstream count, if cheaply available

Example response

[
  {
    "counts": [
      {
        "key": "pullRequests",
        "label": "Pull requests"
      }
    ]
  }
]

Changes

  • 9662502b2cc4Revision changes
    • breaking

      for the path request parameter workspaceSlug, the minLength was increased from 0 to 3

    • warning

      for the path request parameter workspaceSlug, the maxLength was set to 51

    • warning

      changed the pattern of the path request parameter workspaceSlug from ^[a-z0-9][a-z0-9-]{2,50}$ to ^(?!.*--)[a-z0-9][a-z0-9-]{1,49}[a-z0-9]$