Sources

List sources

get

Returns a list of sources.

Query parameters

typestringOptional

Filter by source type

Responses

200

Sources

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

500

Internal Server Error

application/json

get/api/sources

HTTPcURLJavaScriptPython

GET /api/sources HTTP/1.1
Accept: */*

{
  "data": [
    {
      "active": true,
      "config": {
        "endpoint": "https://example.salesforce.com"
      },
      "external_id": "src-crm",
      "id": 1,
      "type": "salesforce"
    }
  ]
}

Create a source

post

Creates a source.

Body

application/json

Responses

201

Created

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

422

Unprocessable Entity

application/json

500

Internal Server Error

application/json

post/api/sources

HTTPcURLJavaScriptPython

POST /api/sources HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 111

{
  "source": {
    "config": {
      "endpoint": "https://example.salesforce.com"
    },
    "external_id": "src-crm",
    "type": "salesforce"
  }
}

{
  "data": {
    "active": true,
    "config": {
      "endpoint": "https://example.salesforce.com"
    },
    "dynamic_content": {
      "endpoint": {
        "origin": "user",
        "value": "https://example.salesforce.com"
      }
    },
    "external_id": "src-crm",
    "id": 1,
    "inserted_at": "2026-05-12T10:00:00Z",
    "type": "salesforce",
    "updated_at": "2026-05-12T10:00:00Z"
  }
}

Get a source by external ID

get

Fetches a source by external ID.

Path parameters

external_idstringRequired

Source external ID

Responses

200

Source

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

404

Not found

application/json

500

Internal Server Error

application/json

get/api/sources/{external_id}

HTTPcURLJavaScriptPython

GET /api/sources/{external_id} HTTP/1.1
Accept: */*

{
  "data": {
    "active": true,
    "config": {
      "endpoint": "https://example.salesforce.com"
    },
    "dynamic_content": {
      "endpoint": {
        "origin": "user",
        "value": "https://example.salesforce.com"
      }
    },
    "external_id": "src-crm",
    "id": 1,
    "inserted_at": "2026-05-12T10:00:00Z",
    "type": "salesforce",
    "updated_at": "2026-05-12T10:00:00Z"
  }
}

Update a source or source configuration

put

Update either the source properties or the source configuration. Use 'source' key for general source updates or 'source_config' key for configuration updates.

Path parameters

external_idstringRequired

Source external ID

Body

application/json

Update request that can contain either 'source' (general source update) or 'source_config' (configuration update). Only one of them should be provided.

or

Responses

200

Updated

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

404

Not found

application/json

422

Unprocessable Entity

application/json

500

Internal Server Error

application/json

put/api/sources/{external_id}

HTTPcURLJavaScriptPython

PUT /api/sources/{external_id} HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 87

{
  "source": {
    "config": {
      "endpoint": "https://example.salesforce.com"
    },
    "type": "salesforce"
  }
}

{
  "data": {
    "active": true,
    "config": {
      "endpoint": "https://example.salesforce.com"
    },
    "dynamic_content": {
      "endpoint": {
        "origin": "user",
        "value": "https://example.salesforce.com"
      }
    },
    "external_id": "src-crm",
    "id": 1,
    "inserted_at": "2026-05-12T10:00:00Z",
    "type": "salesforce",
    "updated_at": "2026-05-12T10:00:00Z"
  }
}

Delete a source

delete

Deletes a source.

Path parameters

external_idstringRequired

Source external ID

Responses

204

Source deleted

No content

401

Unauthorized

application/json

403

Forbidden

application/json

404

Not found

application/json

500

Internal Server Error

application/json

delete/api/sources/{external_id}

HTTPcURLJavaScriptPython

DELETE /api/sources/{external_id} HTTP/1.1
Accept: */*

No content

Update a source or source configuration

patch

Update either the source properties or the source configuration. Use 'source' key for general source updates or 'source_config' key for configuration updates.

Path parameters

external_idstringRequired

Source external ID

Body

application/json

Update request that can contain either 'source' (general source update) or 'source_config' (configuration update). Only one of them should be provided.

or

Responses

200

Updated

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

404

Not found

application/json

422

Unprocessable Entity

application/json

500

Internal Server Error

application/json

patch/api/sources/{external_id}

HTTPcURLJavaScriptPython

PATCH /api/sources/{external_id} HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 87

{
  "source": {
    "config": {
      "endpoint": "https://example.salesforce.com"
    },
    "type": "salesforce"
  }
}

{
  "data": {
    "active": true,
    "config": {
      "endpoint": "https://example.salesforce.com"
    },
    "dynamic_content": {
      "endpoint": {
        "origin": "user",
        "value": "https://example.salesforce.com"
      }
    },
    "external_id": "src-crm",
    "id": 1,
    "inserted_at": "2026-05-12T10:00:00Z",
    "type": "salesforce",
    "updated_at": "2026-05-12T10:00:00Z"
  }
}