--- updatedAt: 2026-06-18T12:14:42.000Z agentTools: projectIndex: https://developer.liveswitch.com/llms.txt --- # Gets documents by conversation id. **Required scope:** `profile` # OpenAPI definition ```json { "openapi": "3.0.1", "info": { "title": "LiveSwitch Public API", "version": "v1" }, "servers": [ { "url": "https://public-api.production.liveswitch.com/", "description": "Public API" } ], "paths": { "/v1/documents/conversation/{conversationId}": { "get": { "tags": [ "Documents" ], "summary": "Gets documents by conversation id.", "description": "**Required scope:** `profile`", "parameters": [ { "name": "conversationId", "in": "path", "description": "The id of the project you want to get a list of documents for.", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DocumentDto" } } } } }, "security": [ { "oauth2": [ "profile" ] } ] } } }, "components": { "schemas": { "DocumentDto": { "type": "object", "properties": { "id": { "type": "string", "description": "Refers to the unique identifier for a document.", "format": "uuid" }, "relatedEntity": { "$ref": "#/components/schemas/DocumentRelatedEntity" }, "projectId": { "type": "string", "description": "Refers to the project id in LiveSwitch Contact.", "format": "uuid", "nullable": true }, "conversationId": { "type": "string", "description": "Refers to the session id in LiveSwitch Contact.", "format": "uuid", "nullable": true }, "organizationId": { "type": "string", "description": "Refers to the organization id in LiveSwitch Contact.", "format": "uuid", "nullable": true }, "index": { "type": "integer", "description": "Refers to the display order from LiveSwitch Contact.", "format": "int32" }, "tags": { "type": "array", "items": { "$ref": "#/components/schemas/TagDto" }, "description": "Tags assigned to this document", "nullable": true }, "externalAccessAllowed": { "type": "boolean", "description": "Refers to if the record can be accessed by the public url." }, "publicUrl": { "type": "string", "description": "Refers to the public url that can access the document without being logged into LiveSwitch Contact. Access can be removed if requested.", "nullable": true }, "thumbnailUrl": { "type": "string", "description": "Refers to the public url that can access the document's thumbnail without being logged into LiveSwitch Contact. Access can be removed if requested.", "nullable": true }, "fileName": { "type": "string", "description": "Refers to the best guess file name, not all files or snapshots have filenames attached to them.", "nullable": true }, "caption": { "type": "string", "description": "Refers to a caption added to the document.", "nullable": true }, "createdAt": { "type": "string", "description": "The date and time the document was created", "format": "date-time" }, "updatedAt": { "type": "string", "description": "The date and time the document was last updated", "format": "date-time", "nullable": true } }, "additionalProperties": false, "description": "Refers to a snapspot or asset uploaded to a project or session." }, "DocumentRelatedEntity": { "enum": [ "File", "Snapshot" ], "type": "string", "description": "What entity table does a document relate to when requiring more information about the document." }, "TagDto": { "type": "object", "properties": { "id": { "type": "string", "description": "The unique identifier for the Tag.", "format": "uuid" }, "name": { "type": "string", "description": "The string value for display.", "nullable": true }, "hexColor": { "type": "string", "description": "The hex-based color value for display. Useful if you want to match the color in your application to LiveSwitch.", "nullable": true } }, "additionalProperties": false } }, "securitySchemes": { "oauth2": { "type": "oauth2", "description": "OAuth2 authentication using Auth0 Implicit flow", "flows": { "implicit": { "authorizationUrl": "https://id.staging.liveswitch.com/authorize", "scopes": { "openid": "OpenID Connect scope", "profile": "Access to user profile", "email": "Access to user email", "me": "Access to user information", "contacts": "Read access to contacts", "contacts.write": "Write access to contacts", "conversations": "Read access to conversations", "conversations.write": "Write access to conversations", "organizations": "Read access to organizations", "webhooks": "Read access to webhooks", "webhooks.write": "Write access to webhooks", "applications": "Read access to applications", "applications.write": "Write access to applications", "forms": "Read access to forms", "projects": "Read access to projects", "projects.write": "Write access to projects", "recordings": "Read access to recordings", "documents": "Read access to documents", "accounts": "Read access to accounts", "guided-instructions": "Read access to guided instructions", "sparks": "Read access to Spark runs", "sparks.write": "Write access to Spark runs", "spark-templates": "Read access to installed Spark templates for the organization", "scribe-templates": "Read access to installed Scribe templates (legacy)" } } } }, "bearer": { "type": "http", "description": "

Please enter a valid token. This shoud NOT include the Bearer: prefix, but just the token itself.

\n
\n

To generate a token from the Swagger UI:

\n

\n 1. Select the 'v1/tokens' endpoint in the Swagger UI
\n 2. Set the 'redirect' setting to false
\n 3. Fill in the values according to your application configuration
\n 4. Click 'Execute'
\n

\n
\n

\n The response from this request will include the URL you need to generate a token. Copy/paste it into a new window and follow the instructions.\n

", "scheme": "bearer", "bearerFormat": "JWT" } } }, "security": [ { "bearer": [] } ] } ``` # Sibling pages * [Gets a document by id.](https://developer.liveswitch.com/reference/get_v1-documents-id.md) * [Gets documents by project id.](https://developer.liveswitch.com/reference/get_v1-documents-project-projectid.md) * [Gets snapshots by conversation id.](https://developer.liveswitch.com/reference/get_v1-documents-conversation-snapshots-conversationid.md) * [Gets snapshots by project id.](https://developer.liveswitch.com/reference/get_v1-documents-project-snapshots-projectid.md) * [Gets files by conversation id.](https://developer.liveswitch.com/reference/get_v1-documents-conversation-files-conversationid.md) * [Gets files by project id.](https://developer.liveswitch.com/reference/get_v1-documents-project-files-projectid.md)