For the complete documentation index, see llms.txt. This page is also available as Markdown.

Data Sources

List data sources

get

List data sources for a workspace with optional filtering.

Authorizations
AuthorizationstringRequired

API key issued via POST /v1/{workspace_id}/api-keys. Pass the returned api_key value as a Bearer token.

Path parameters
workspace_idstring · uuidRequired
Query parameters
limitinteger · max: 200OptionalDefault: 50
continuation_tokenanyOptional
is_activeboolean · nullableOptional
source_typestring[] · nullableOptional

Filter by source type (repeatable)

searchstring · nullableOptional

Search by name, ID, type, or sync status

qstring · nullableOptional
Responses
200

Successful Response

application/json
has_morebooleanRequired
continuation_tokenanyOptional
get/v1/{workspace_id}/data-sources
GET /v1/{workspace_id}/data-sources HTTP/1.1
Host: platform.api-us.concurrence.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
  "items": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "workspace_id": "123e4567-e89b-12d3-a456-426614174000",
      "name": "text",
      "display_name": "text",
      "source_type": "ehr",
      "connection_config": {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      },
      "entity_types": [
        "text"
      ],
      "field_mappings": {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      },
      "sync_strategy": "manual",
      "sync_schedule": "text",
      "is_active": true,
      "created_at": "2026-01-01T00:00:00.000Z",
      "updated_at": "2026-01-01T00:00:00.000Z"
    }
  ],
  "has_more": true,
  "continuation_token": null
}

Create a data source

post

Register a new external data source in the workspace.

Authorizations
AuthorizationstringRequired

API key issued via POST /v1/{workspace_id}/api-keys. Pass the returned api_key value as a Bearer token.

Path parameters
workspace_idstring · uuidRequired
Body
namestring · min: 1 · max: 256Required
display_namestring · min: 1 · max: 256 · nullableOptional
source_typestring · enumRequiredPossible values:
entity_typesstring[] · max: 100Optional
sync_strategystring · enumOptionalDefault: manualPossible values:
sync_schedulestring · max: 256 · nullableOptional
Responses
201

Successful Response

application/json
idstring · uuidRequired
workspace_idstring · uuidRequired
namestringRequired
display_namestring · nullableRequired
source_typestring · enumRequiredPossible values:
entity_typesstring[] · nullableRequired
sync_strategystring · enumRequiredPossible values:
sync_schedulestring · nullableRequired
is_activebooleanRequired
created_atstring · date-timeRequired
updated_atstring · date-timeRequired
post/v1/{workspace_id}/data-sources
POST /v1/{workspace_id}/data-sources HTTP/1.1
Host: platform.api-us.concurrence.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 244

{
  "name": "text",
  "display_name": "text",
  "source_type": "ehr",
  "connection_config": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "entity_types": [
    "text"
  ],
  "field_mappings": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "sync_strategy": "manual",
  "sync_schedule": "text"
}
{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "workspace_id": "123e4567-e89b-12d3-a456-426614174000",
  "name": "text",
  "display_name": "text",
  "source_type": "ehr",
  "connection_config": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "entity_types": [
    "text"
  ],
  "field_mappings": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "sync_strategy": "manual",
  "sync_schedule": "text",
  "is_active": true,
  "created_at": "2026-01-01T00:00:00.000Z",
  "updated_at": "2026-01-01T00:00:00.000Z"
}

Get a data source

get

Retrieve a data source by ID.

Authorizations
AuthorizationstringRequired

API key issued via POST /v1/{workspace_id}/api-keys. Pass the returned api_key value as a Bearer token.

Path parameters
workspace_idstring · uuidRequired
data_source_idstring · uuidRequired
Responses
200

Successful Response

application/json
idstring · uuidRequired
workspace_idstring · uuidRequired
namestringRequired
display_namestring · nullableRequired
source_typestring · enumRequiredPossible values:
entity_typesstring[] · nullableRequired
sync_strategystring · enumRequiredPossible values:
sync_schedulestring · nullableRequired
is_activebooleanRequired
created_atstring · date-timeRequired
updated_atstring · date-timeRequired
get/v1/{workspace_id}/data-sources/{data_source_id}
GET /v1/{workspace_id}/data-sources/{data_source_id} HTTP/1.1
Host: platform.api-us.concurrence.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "workspace_id": "123e4567-e89b-12d3-a456-426614174000",
  "name": "text",
  "display_name": "text",
  "source_type": "ehr",
  "connection_config": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "entity_types": [
    "text"
  ],
  "field_mappings": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "sync_strategy": "manual",
  "sync_schedule": "text",
  "is_active": true,
  "created_at": "2026-01-01T00:00:00.000Z",
  "updated_at": "2026-01-01T00:00:00.000Z"
}

Delete a data source

delete

Delete a data source.

Authorizations
AuthorizationstringRequired

API key issued via POST /v1/{workspace_id}/api-keys. Pass the returned api_key value as a Bearer token.

Path parameters
workspace_idstring · uuidRequired
data_source_idstring · uuidRequired
Responses
204

Successful Response

No content

delete/v1/{workspace_id}/data-sources/{data_source_id}
DELETE /v1/{workspace_id}/data-sources/{data_source_id} HTTP/1.1
Host: platform.api-us.concurrence.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

Update a data source

patch

Update a data source's configuration.

Authorizations
AuthorizationstringRequired

API key issued via POST /v1/{workspace_id}/api-keys. Pass the returned api_key value as a Bearer token.

Path parameters
workspace_idstring · uuidRequired
data_source_idstring · uuidRequired
Body
display_namestring · min: 1 · max: 256 · nullableOptional
entity_typesstring[] · max: 100 · nullableOptional
sync_strategystring · enum · nullableOptionalPossible values:
sync_schedulestring · max: 256 · nullableOptional
is_activeboolean · nullableOptional
Responses
200

Successful Response

application/json
idstring · uuidRequired
workspace_idstring · uuidRequired
namestringRequired
display_namestring · nullableRequired
source_typestring · enumRequiredPossible values:
entity_typesstring[] · nullableRequired
sync_strategystring · enumRequiredPossible values:
sync_schedulestring · nullableRequired
is_activebooleanRequired
created_atstring · date-timeRequired
updated_atstring · date-timeRequired
patch/v1/{workspace_id}/data-sources/{data_source_id}
PATCH /v1/{workspace_id}/data-sources/{data_source_id} HTTP/1.1
Host: platform.api-us.concurrence.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 227

{
  "display_name": "text",
  "connection_config": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "entity_types": [
    "text"
  ],
  "field_mappings": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "sync_strategy": "manual",
  "sync_schedule": "text",
  "is_active": true
}
{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "workspace_id": "123e4567-e89b-12d3-a456-426614174000",
  "name": "text",
  "display_name": "text",
  "source_type": "ehr",
  "connection_config": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "entity_types": [
    "text"
  ],
  "field_mappings": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "sync_strategy": "manual",
  "sync_schedule": "text",
  "is_active": true,
  "created_at": "2026-01-01T00:00:00.000Z",
  "updated_at": "2026-01-01T00:00:00.000Z"
}

Get data source status

get

Get event counts, sync status, and health for a data source.

Authorizations
AuthorizationstringRequired

API key issued via POST /v1/{workspace_id}/api-keys. Pass the returned api_key value as a Bearer token.

Path parameters
workspace_idstring · uuidRequired
data_source_idstring · uuidRequired
Responses
200

Successful Response

application/json
data_source_idstring · uuidRequired
namestringRequired
is_activebooleanRequired
event_countintegerRequired
synced_countintegerRequired
failed_countintegerRequired
get/v1/{workspace_id}/data-sources/{data_source_id}/status
GET /v1/{workspace_id}/data-sources/{data_source_id}/status HTTP/1.1
Host: platform.api-us.concurrence.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
  "data_source_id": "123e4567-e89b-12d3-a456-426614174000",
  "name": "text",
  "is_active": true,
  "event_count": 1,
  "synced_count": 1,
  "failed_count": 1
}

Get data source sync history

get

Daily event timeline + recent sync failures for a data source.

Authorizations
AuthorizationstringRequired

API key issued via POST /v1/{workspace_id}/api-keys. Pass the returned api_key value as a Bearer token.

Path parameters
workspace_idstring · uuidRequired
data_source_idstring · uuidRequired
Query parameters
daysinteger · min: 1 · max: 90OptionalDefault: 30
Responses
200

Successful Response

application/json
data_source_idstring · uuidRequired
namestringRequired
get/v1/{workspace_id}/data-sources/{data_source_id}/sync-history
GET /v1/{workspace_id}/data-sources/{data_source_id}/sync-history HTTP/1.1
Host: platform.api-us.concurrence.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
  "data_source_id": "123e4567-e89b-12d3-a456-426614174000",
  "name": "text",
  "timeline": [
    {
      "date": "text",
      "event_count": 1,
      "synced_count": 1,
      "failed_count": 1
    }
  ],
  "recent_failures": [
    {
      "event_id": "123e4567-e89b-12d3-a456-426614174000",
      "event_type": "text",
      "fhir_resource_type": "text",
      "fhir_resource_id": "text",
      "sync_error": "text",
      "created_at": "text"
    }
  ]
}

Last updated

Was this helpful?