For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Fork this repoGet a demo
  • Docs
    • Welcome
    • Quickstart
    • Concepts
    • Search
    • MCP Server
    • CLI
    • Agent Skills
    • Connect
    • Add New Connector
    • Rate Limits
  • API Reference
      • GETList Source Connections
      • GETGet Source Connection
      • GETList Sync Jobs
      • POSTCreate Source Connection
      • PATCHUpdate Source Connection
      • POSTRun Sync
      • POSTCancel Sync Job
      • DELDelete Source Connection
LogoLogo
Fork this repoGet a demo
API ReferenceSource Connections

List Sync Jobs

GET
/source-connections/:source_connection_id/jobs
GET
/source-connections/:source_connection_id/jobs
1import requests
2
3url = "https://api.airweave.ai/source-connections/550e8400-e29b-41d4-a716-446655440000/jobs"
4
5headers = {"x-api-key": "<apiKey>"}
6
7response = requests.get(url, headers=headers)
8
9print(response.json())
1[
2  {
3    "id": "770e8400-e29b-41d4-a716-446655440002",
4    "source_connection_id": "550e8400-e29b-41d4-a716-446655440000",
5    "status": "created",
6    "started_at": "2024-01-15T09:30:00Z",
7    "completed_at": "2024-01-15T09:30:00Z",
8    "duration_seconds": 1.1,
9    "entities_inserted": 0,
10    "entities_updated": 0,
11    "entities_deleted": 0,
12    "entities_failed": 0,
13    "error": "string",
14    "error_category": "oauth_credentials_expired",
15    "error_details": {}
16  }
17]
Retrieve the sync job history for a source connection. Returns a list of sync jobs ordered by creation time (newest first). Each job includes status, timing information, and entity counts. Job statuses: - **PENDING**: Job is queued, waiting for the worker to pick it up - **RUNNING**: Sync is actively pulling and processing data - **COMPLETED**: Sync finished successfully - **FAILED**: Sync encountered an unrecoverable error - **CANCELLING**: Cancellation has been requested. The worker is gracefully stopping the pipeline and cleaning up destination data. - **CANCELLED**: Sync was cancelled. The worker has fully stopped and destination data cleanup has been scheduled.
Was this page helpful?
Previous

Create Source Connection

Next
Built with

Retrieve the sync job history for a source connection.

Returns a list of sync jobs ordered by creation time (newest first). Each job includes status, timing information, and entity counts.

Job statuses:

  • PENDING: Job is queued, waiting for the worker to pick it up
  • RUNNING: Sync is actively pulling and processing data
  • COMPLETED: Sync finished successfully
  • FAILED: Sync encountered an unrecoverable error
  • CANCELLING: Cancellation has been requested. The worker is gracefully stopping the pipeline and cleaning up destination data.
  • CANCELLED: Sync was cancelled. The worker has fully stopped and destination data cleanup has been scheduled.

Authentication

x-api-keystring
API Key authentication via header

Path parameters

source_connection_idstringRequiredformat: "uuid"

Unique identifier of the source connection (UUID)

Query parameters

limitintegerOptional1-1000Defaults to 100

Maximum number of jobs to return (1-1000)

Response

List of sync jobs
idstringformat: "uuid"
Unique identifier of the sync job
source_connection_idstringformat: "uuid"
ID of the source connection this job belongs to
statusenum

Current status: PENDING, RUNNING, COMPLETED, FAILED, CANCELLED, or CANCELLING

started_atstring or nullformat: "date-time"

When the job started execution (ISO 8601)

completed_atstring or nullformat: "date-time"

When the job finished (ISO 8601). Null if still running.

duration_secondsdouble or null
Total execution time in seconds. Null if still running.
entities_insertedintegerDefaults to 0
Number of new entities created during this sync
entities_updatedintegerDefaults to 0
Number of existing entities updated during this sync
entities_deletedintegerDefaults to 0
Number of entities removed during this sync
entities_failedintegerDefaults to 0
Number of entities that failed to process
errorstring or null
Error message if the job failed
error_categoryenum or null

Error category for credential errors (e.g. oauth_credentials_expired)

error_detailsmap from strings to any or null
Additional error context for debugging

Errors

404
Not Found Error
422
Unprocessable Entity Error
429
Too Many Requests Error