v1.0.4

OpenAPI 3.1.1

Condens API

Server

For accounts with EU server location. If you’re unsure which server your account uses, check the API & MCP-Server settings page in Condens to view the assigned base URL.

Client Libraries

Shell Curl

List workspaces

Query Parameters

page
Type:
min:
1

Page number (starting at 1).
pageSize
Type:
min:
1
max:
100

Number of items per page.
sort
Type: string

Sort items by name or information field value.

Sort order: prefix with '-' for descending, omit for ascending.

Responses

application/json
application/json
application/json
application/json
application/json

get/v1/workspaces

curl 'https://api.condens.io/v1/workspaces?page=1&pageSize=100&sort=name' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

Show Schema

{
  "page": 1,
  "pageSize": 100,
  "total": 0,
  "totalPages": 0,
  "hasNext": true,
  "items": [
    {
      "id": "string",
      "name": "string",
      "updatedAt": "2026-10-01T12:28:47.989Z"
    }
  ]
}

Workspaces page

Get a workspace

Path Parameters

id
Type: string
required

Responses

application/json
application/json
application/json
application/json
application/json
application/json

get/v1/workspaces/{id}

curl 'https://api.condens.io/v1/workspaces/{id}' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

Show Schema

{
  "id": "string",
  "name": "string",
  "updatedAt": "2026-10-01T12:28:47.989Z"
}

Workspace

List users

Query Parameters

workspaceId
Type: string
page
Type:
min:
1

Page number (starting at 1).
pageSize
Type:
min:
1
max:
100

Number of items per page.
sort
Type: string

Sort items by name or information field value.

Sort order: prefix with '-' for descending, omit for ascending.

Responses

application/json
application/json
application/json
application/json
application/json

get/v1/users

curl 'https://api.condens.io/v1/users?page=1&pageSize=100&sort=name' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

Show Schema

{
  "page": 1,
  "pageSize": 100,
  "total": 0,
  "totalPages": 0,
  "hasNext": true,
  "items": [
    {
      "id": "string",
      "name": "string",
      "email": "hello@example.com",
      "role": "administrator",
      "active": true,
      "updatedAt": "2026-10-01T12:28:47.989Z"
    }
  ]
}

Users page

Get a user

Path Parameters

id
Type: string
required

Responses

application/json
application/json
application/json
application/json
application/json
application/json

get/v1/users/{id}

curl 'https://api.condens.io/v1/users/{id}' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

Show Schema

{
  "id": "string",
  "name": "string",
  "email": "hello@example.com",
  "role": "administrator",
  "workspaceIds": [
    "string"
  ],
  "active": true,
  "updatedAt": "2026-10-01T12:28:47.989Z"
}

User

List participants

Query Parameters

workspaceId
Type: string
page
Type:
min:
1

Page number (starting at 1).
pageSize
Type:
min:
1
max:
100

Number of items per page.
filter
Type: string

JSON-encoded filter object
sort
Type: string

Sort items by name or information field value.

Sort order: prefix with '-' for descending, omit for ascending.

Responses

application/json
application/json
application/json
application/json
application/json

get/v1/participants

curl 'https://api.condens.io/v1/participants?page=1&pageSize=100&sort=name' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

Show Schema

{
  "page": 1,
  "pageSize": 100,
  "total": 0,
  "totalPages": 0,
  "hasNext": true,
  "items": [
    {
      "id": "string",
      "name": "",
      "workspaceId": "string",
      "informationFields": [
        {
          "fieldName": "string",
          "fieldType": "text",
          "value": "string"
        }
      ],
      "updatedAt": "2026-10-01T12:28:47.989Z"
    }
  ]
}

Participants page

Create a participant

Body·

required

application/json

name
Type: string
required
attachments
Type:
Properties: 3
informationFields
Type:
workspaceId
Type: string

Responses

application/json
application/json
application/json
application/json
application/json

post/v1/participants

curl https://api.condens.io/v1/participants \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --data '{
  "workspaceId": "",
  "name": "",
  "informationFields": [
    {
      "fieldName": "",
      "fieldType": "text",
      "value": ""
    }
  ],
  "attachments": [
    {
      "sourceUrl": "",
      "sourceAuth": {
        "type": "bearer",
        "token": ""
      },
      "name": ""
    }
  ]
}'

Show Schema

{
  "id": "string",
  "name": "",
  "workspaceId": "string",
  "informationFields": [
    {
      "fieldName": "string",
      "fieldType": "text",
      "value": "string"
    }
  ],
  "attachments": [
    {
      "name": "string"
    }
  ],
  "updatedAt": "2026-10-01T12:28:47.989Z",
  "failedUploadUrls": [
    "https://example.com"
  ]
}

Created participant

Get a participant

Path Parameters

id
Type: string
required

Responses

application/json
application/json
application/json
application/json
application/json
application/json

get/v1/participants/{id}

curl 'https://api.condens.io/v1/participants/{id}' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

Show Schema

{
  "id": "string",
  "name": "",
  "workspaceId": "string",
  "informationFields": [
    {
      "fieldName": "string",
      "fieldType": "text",
      "value": "string"
    }
  ],
  "attachments": [
    {
      "name": "string"
    }
  ],
  "updatedAt": "2026-10-01T12:28:47.989Z",
  "failedUploadUrls": [
    "https://example.com"
  ]
}

Participant

Update a participant

Path Parameters

id
Type: string
required

Body·

required

attachments
Type:
Properties: 3
informationFields
Type:
name
Type: string

Responses

application/json
application/json
application/json
application/json
application/json
application/json

patch/v1/participants/{id}

curl 'https://api.condens.io/v1/participants/{id}' \
  --request PATCH \
  --header 'Content-Type: application/merge-patch+json' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --data '{
  "name": "",
  "informationFields": [
    {
      "fieldName": "",
      "fieldType": "text",
      "value": ""
    }
  ],
  "attachments": [
    {
      "sourceUrl": "",
      "sourceAuth": {
        "type": "bearer",
        "token": ""
      },
      "name": ""
    }
  ]
}'

Show Schema

{
  "id": "string",
  "name": "",
  "workspaceId": "string",
  "informationFields": [
    {
      "fieldName": "string",
      "fieldType": "text",
      "value": "string"
    }
  ],
  "attachments": [
    {
      "name": "string"
    }
  ],
  "updatedAt": "2026-10-01T12:28:47.989Z",
  "failedUploadUrls": [
    "https://example.com"
  ]
}

Updated participant

Delete a Participant

Deleted items can be restored from the trash in the Condens app for up to 30 days.

Path Parameters

id
Type: string
required

Responses

204

Deleted
application/json
application/json
application/json
application/json
application/json

delete/v1/participants/{id}

curl 'https://api.condens.io/v1/participants/{id}' \
  --request DELETE \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

No Body

Deleted

List projects

Query Parameters

projectFolderId
Type: string
workspaceId
Type: string
page
Type:
min:
1

Page number (starting at 1).
pageSize
Type:
min:
1
max:
100

Number of items per page.
filter
Type: string

JSON-encoded filter object
sort
Type: string

Sort items by name or information field value.

Sort order: prefix with '-' for descending, omit for ascending.

Responses

application/json
application/json
application/json
application/json
application/json

get/v1/projects

curl 'https://api.condens.io/v1/projects?page=1&pageSize=100&sort=name' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

Show Schema

{
  "page": 1,
  "pageSize": 100,
  "total": 0,
  "totalPages": 0,
  "hasNext": true,
  "items": [
    {
      "id": "string",
      "name": "",
      "projectFolderId": "string",
      "workspaceId": "string",
      "informationFields": [
        {
          "fieldName": "string",
          "fieldType": "text",
          "value": "string"
        }
      ],
      "updatedAt": "2026-10-01T12:28:47.989Z"
    }
  ]
}

Projects page

Create a project

Body·

required

application/json

name
Type: string
required
informationFields
Type:
involvedContributorIds
Type: array of string
projectFolderId
Type: string
workspaceId
Type: string

Responses

application/json
application/json
application/json
application/json
application/json

post/v1/projects

curl https://api.condens.io/v1/projects \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --data '{
  "name": "",
  "projectFolderId": "",
  "workspaceId": "",
  "involvedContributorIds": [],
  "informationFields": [
    {
      "fieldName": "",
      "fieldType": "text",
      "value": ""
    }
  ]
}'

Show Schema

{
  "id": "string",
  "name": "",
  "projectFolderId": null,
  "workspaceId": "string",
  "involvedContributorIds": [],
  "informationFields": [
    {
      "fieldName": "string",
      "fieldType": "text",
      "value": "string"
    }
  ],
  "updatedAt": "2026-10-01T12:28:47.989Z"
}

Created project

Get a project

Path Parameters

id
Type: string
required

Responses

application/json
application/json
application/json
application/json
application/json
application/json

get/v1/projects/{id}

curl 'https://api.condens.io/v1/projects/{id}' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

Show Schema

{
  "id": "string",
  "name": "",
  "projectFolderId": null,
  "workspaceId": "string",
  "involvedContributorIds": [],
  "informationFields": [
    {
      "fieldName": "string",
      "fieldType": "text",
      "value": "string"
    }
  ],
  "updatedAt": "2026-10-01T12:28:47.989Z"
}

Project

Update a project

Path Parameters

id
Type: string
required

Body·

required

informationFields
Type:
involvedContributorIds
Type: array of string
name
Type: string
projectFolderId
Type: string

Responses

application/json
application/json
application/json
application/json
application/json
application/json

patch/v1/projects/{id}

curl 'https://api.condens.io/v1/projects/{id}' \
  --request PATCH \
  --header 'Content-Type: application/merge-patch+json' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --data '{
  "name": "",
  "projectFolderId": "",
  "involvedContributorIds": [
    ""
  ],
  "informationFields": [
    {
      "fieldName": "",
      "fieldType": "text",
      "value": ""
    }
  ]
}'

Show Schema

{
  "id": "string",
  "name": "",
  "projectFolderId": null,
  "workspaceId": "string",
  "involvedContributorIds": [],
  "informationFields": [
    {
      "fieldName": "string",
      "fieldType": "text",
      "value": "string"
    }
  ],
  "updatedAt": "2026-10-01T12:28:47.989Z"
}

Updated project

Delete a project

Deleted items can be restored from the trash in the Condens app for up to 30 days.

Path Parameters

id
Type: string
required

Responses

204

Deleted
application/json
application/json
application/json
application/json
application/json

delete/v1/projects/{id}

curl 'https://api.condens.io/v1/projects/{id}' \
  --request DELETE \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

No Body

Deleted

List project folders

Query Parameters

workspaceId
Type: string
page
Type:
min:
1

Page number (starting at 1).
pageSize
Type:
min:
1
max:
100

Number of items per page.
sort
Type: string

Sort items by name or information field value.

Sort order: prefix with '-' for descending, omit for ascending.

Responses

application/json
application/json
application/json
application/json
application/json

get/v1/projectFolders

curl 'https://api.condens.io/v1/projectFolders?page=1&pageSize=100&sort=name' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

Show Schema

{
  "page": 1,
  "pageSize": 100,
  "total": 0,
  "totalPages": 0,
  "hasNext": true,
  "items": [
    {
      "id": "string",
      "workspaceId": "string",
      "name": "",
      "updatedAt": "2026-10-01T12:28:47.989Z"
    }
  ]
}

Project folders page

Create a project folder

Body·

required

application/json

name
Type: string
required
workspaceId
Type: string

Responses

application/json
application/json
application/json
application/json
application/json

post/v1/projectFolders

curl https://api.condens.io/v1/projectFolders \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --data '{
  "workspaceId": "",
  "name": ""
}'

Show Schema

{
  "id": "string",
  "workspaceId": "string",
  "name": "",
  "updatedAt": "2026-10-01T12:28:47.989Z"
}

Created project folder

Get a project folder

Path Parameters

id
Type: string
required

Responses

application/json
application/json
application/json
application/json
application/json
application/json

get/v1/projectFolders/{id}

curl 'https://api.condens.io/v1/projectFolders/{id}' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

Show Schema

{
  "id": "string",
  "workspaceId": "string",
  "name": "",
  "updatedAt": "2026-10-01T12:28:47.989Z"
}

Project folder

Update a project folder

Path Parameters

id
Type: string
required

Body·

required

name
Type: string

Responses

application/json
application/json
application/json
application/json
application/json
application/json

patch/v1/projectFolders/{id}

curl 'https://api.condens.io/v1/projectFolders/{id}' \
  --request PATCH \
  --header 'Content-Type: application/merge-patch+json' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --data '{
  "name": ""
}'

Show Schema

{
  "id": "string",
  "workspaceId": "string",
  "name": "",
  "updatedAt": "2026-10-01T12:28:47.989Z"
}

Updated project folder

Delete a project folder

Deleted items can be restored from the trash in the Condens app for up to 30 days.

Path Parameters

id
Type: string
required

Responses

204

Deleted
application/json
application/json
application/json
application/json
application/json

delete/v1/projectFolders/{id}

curl 'https://api.condens.io/v1/projectFolders/{id}' \
  --request DELETE \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

No Body

Deleted

List sessions

Query Parameters

projectId
Type: string
required
workspaceId
Type: string
page
Type:
min:
1

Page number (starting at 1).
pageSize
Type:
min:
1
max:
100

Number of items per page.
filter
Type: string

JSON-encoded filter object
sort
Type: string

Sort items by name or information field value.

Sort order: prefix with '-' for descending, omit for ascending.

Responses

application/json
application/json
application/json
application/json
application/json

get/v1/sessions

curl 'https://api.condens.io/v1/sessions?projectId=&page=1&pageSize=100&sort=name' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

Show Schema

{
  "page": 1,
  "pageSize": 100,
  "total": 0,
  "totalPages": 0,
  "hasNext": true,
  "items": [
    {
      "id": "string",
      "name": "",
      "projectId": "string",
      "workspaceId": "string",
      "processed": true,
      "informationFields": [
        {
          "fieldName": "string",
          "fieldType": "text",
          "value": "string"
        }
      ],
      "updatedAt": "2026-10-01T12:28:47.989Z"
    }
  ]
}

Sessions page

Create a session

Body·

required

application/json

name
Type: string
required
projectId
Type: string
required
attachments
Type:
Properties: 3
informationFields
Type:
media
Type:
Properties: 5
note
Type:
Properties: 3

Responses

application/json
application/json
application/json
application/json
application/json

post/v1/sessions

curl https://api.condens.io/v1/sessions \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --data '{
  "name": "",
  "projectId": "",
  "informationFields": [
    {
      "fieldName": "",
      "fieldType": "text",
      "value": ""
    }
  ],
  "media": {
    "name": "",
    "sourceUrl": "",
    "sourceAuth": {
      "type": "bearer",
      "token": ""
    },
    "transcription": {
      "languages": [
        "af-ZA"
      ],
      "numberOfSpeakers": 2,
      "generateBookmarks": false
    },
    "anonymization": {
      "blurMode": "video",
      "anonymizeAudio": false
    }
  },
  "note": {
    "name": "",
    "content": "",
    "type": "plain"
  },
  "attachments": [
    {
      "sourceUrl": "",
      "sourceAuth": {
        "type": "bearer",
        "token": ""
      },
      "name": ""
    }
  ]
}'

Show Schema

{
  "id": "string",
  "name": "",
  "projectId": "string",
  "workspaceId": "string",
  "processed": true,
  "informationFields": [
    {
      "fieldName": "string",
      "fieldType": "text",
      "value": "string"
    }
  ],
  "attachments": [
    {
      "name": "string"
    }
  ],
  "updatedAt": "2026-10-01T12:28:47.989Z",
  "failedUploadUrls": [
    "https://example.com"
  ]
}

Created session

Get a session

Path Parameters

id
Type: string
required

Responses

application/json
application/json
application/json
application/json
application/json
application/json

get/v1/sessions/{id}

curl 'https://api.condens.io/v1/sessions/{id}' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

Show Schema

{
  "id": "string",
  "name": "",
  "projectId": "string",
  "workspaceId": "string",
  "processed": true,
  "informationFields": [
    {
      "fieldName": "string",
      "fieldType": "text",
      "value": "string"
    }
  ],
  "attachments": [
    {
      "name": "string"
    }
  ],
  "updatedAt": "2026-10-01T12:28:47.989Z",
  "failedUploadUrls": [
    "https://example.com"
  ]
}

Session

Update a session

Path Parameters

id
Type: string
required

Body·

required

attachments
Type:
Properties: 3
informationFields
Type:
media
Type:
Properties: 5
name
Type: string
note
Type:
Properties: 3

Responses

application/json
application/json
application/json
application/json
application/json
application/json

patch/v1/sessions/{id}

curl 'https://api.condens.io/v1/sessions/{id}' \
  --request PATCH \
  --header 'Content-Type: application/merge-patch+json' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --data '{
  "name": "",
  "informationFields": [
    {
      "fieldName": "",
      "fieldType": "text",
      "value": ""
    }
  ],
  "media": {
    "name": "",
    "sourceUrl": "",
    "sourceAuth": {
      "type": "bearer",
      "token": ""
    },
    "transcription": {
      "languages": [
        "af-ZA"
      ],
      "numberOfSpeakers": 2,
      "generateBookmarks": false
    },
    "anonymization": {
      "blurMode": "video",
      "anonymizeAudio": false
    }
  },
  "note": {
    "name": "",
    "content": "",
    "type": "plain"
  },
  "attachments": [
    {
      "sourceUrl": "",
      "sourceAuth": {
        "type": "bearer",
        "token": ""
      },
      "name": ""
    }
  ]
}'

Show Schema

{
  "id": "string",
  "name": "",
  "projectId": "string",
  "workspaceId": "string",
  "processed": true,
  "informationFields": [
    {
      "fieldName": "string",
      "fieldType": "text",
      "value": "string"
    }
  ],
  "attachments": [
    {
      "name": "string"
    }
  ],
  "updatedAt": "2026-10-01T12:28:47.989Z",
  "failedUploadUrls": [
    "https://example.com"
  ]
}

Updated session

Delete a Session

Deleted items can be restored from the trash in the Condens app for up to 30 days.

Path Parameters

id
Type: string
required

Responses

204

Deleted
application/json
application/json
application/json
application/json
application/json

delete/v1/sessions/{id}

curl 'https://api.condens.io/v1/sessions/{id}' \
  --request DELETE \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

No Body

Deleted

List artifacts

Query Parameters

projectId
Type: string
required
workspaceId
Type: string
type
Type: string
min length:
1

Optionally filter artifacts by type.
page
Type:
min:
1

Page number (starting at 1).
pageSize
Type:
min:
1
max:
100

Number of items per page.
filter
Type: string

JSON-encoded filter object
sort
Type: string

Sort items by name or information field value.

Sort order: prefix with '-' for descending, omit for ascending.

Responses

application/json
application/json
application/json
application/json
application/json

get/v1/artifacts

curl 'https://api.condens.io/v1/artifacts?projectId=&page=1&pageSize=100&sort=name' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

Show Schema

{
  "page": 1,
  "pageSize": 100,
  "total": 0,
  "totalPages": 0,
  "hasNext": true,
  "items": [
    {
      "id": "string",
      "name": "",
      "coverImageUrl": null,
      "projectId": "string",
      "workspaceId": "string",
      "summary": "",
      "isPublished": true,
      "type": "string",
      "informationFields": [
        {
          "fieldName": "string",
          "fieldType": "text",
          "value": "string"
        }
      ],
      "updatedAt": "2026-10-01T12:28:47.989Z"
    }
  ]
}

Artifacts page

Update an artifact

Update values of existing information fields for this artifact's type. Field names are matched ignoring case and surrounding whitespace. Unknown fields and mismatched field types return 400. Fields omitted from the request remain unchanged. This endpoint does not create field definitions or update artifact content.

Path Parameters

id
Type: string
required

Body·

required

informationFields
Type:
required

Responses

application/json
application/json
application/json
application/json
application/json
application/json

patch/v1/artifacts/{id}

curl 'https://api.condens.io/v1/artifacts/{id}' \
  --request PATCH \
  --header 'Content-Type: application/merge-patch+json' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --data '{
  "informationFields": [
    {
      "fieldName": "",
      "fieldType": "text",
      "value": ""
    }
  ]
}'

Show Schema

{
  "id": "string",
  "name": "",
  "coverImageUrl": null,
  "projectId": "string",
  "workspaceId": "string",
  "summary": "",
  "isPublished": true,
  "type": "string",
  "informationFields": [
    {
      "fieldName": "string",
      "fieldType": "text",
      "value": "string"
    }
  ],
  "updatedAt": "2026-10-01T12:28:47.989Z"
}

Updated artifact

Condens API

AuthenticationRequired

List workspaces

Query Parameters

Responses

Get a workspace

Path Parameters

Responses

List users

Query Parameters

Responses

Get a user

Path Parameters

Responses

List participants

Query Parameters

Responses

Create a participant

Body·CreateParticipant

Responses

Get a participant

Path Parameters

Responses

Update a participant

Path Parameters

Body·UpdateParticipant

Responses

Delete a Participant

Path Parameters

Responses

List projects

Query Parameters

Responses

Create a project

Body·CreateProject

Responses

Get a project

Path Parameters

Responses

Update a project

Path Parameters

Body·UpdateProject

Responses

Delete a project

Path Parameters

Responses

List project folders

Query Parameters

Responses

Create a project folder

Body·CreateProjectFolder

Responses

Get a project folder

Path Parameters

Responses

Update a project folder

Path Parameters

Body·UpdateProjectFolder

Responses

Delete a project folder

Path Parameters

Responses

List sessions

Query Parameters

Responses

Create a session

Body·CreateSession

Responses

Get a session

Path Parameters

Responses

Update a session

Path Parameters

Body·UpdateSession

Responses

Delete a Session

Path Parameters

Responses

List artifacts

Query Parameters

Body·

Body·

Body·

Body·

Body·

Body·

Body·

Body·

Body·