# LiveSwitch API Documentation

> Documentation for LiveSwitch API

## Guides
- [Welcome to LiveSwitch](https://developer.liveswitch.com/docs/getting-started.md)
- [Authentication](https://developer.liveswitch.com/docs/basic-concepts.md): How to authenticate your users and call the LiveSwitch API from your own application.
- [Creating a Conversation](https://developer.liveswitch.com/docs/creating-a-conversation.md)
- [Viewing Recordings, Photos, and Sessions (aka Conversations)](https://developer.liveswitch.com/docs/viewing-recordings-photos-and-sessions-aka-conversations.md): How do I make the LiveSwitch conversations available in my application?
- [Webhooks](https://developer.liveswitch.com/docs/webhooks-1.md)
- [Querying with "where"](https://developer.liveswitch.com/docs/querying-with-where.md)
- [Embedding media in a CRM](https://developer.liveswitch.com/docs/embedding-media-in-a-crm.md)
- [Logging Out](https://developer.liveswitch.com/docs/logging-out.md)
- [Sparky AI Reports — Integration Guide](https://developer.liveswitch.com/docs/sparky-ai-reports-sparks-integration-guide.md): This guide explains how to use the LiveSwitch API to run, view, and manage Sparks — Sparky's AI-generated reports — from a third-party system. It's written to be followed manually by a developer, or handed as-is to an AI coding agent to implement.
- [Albi](https://developer.liveswitch.com/docs/albi.md): By LiveSwitch
- [Builder Prime](https://developer.liveswitch.com/docs/builder-prime.md): By LiveSwitch
- [Chariot Moving AI Inventory](https://developer.liveswitch.com/docs/chariot-moving-ai-inventory.md): By: LiveSwitch
- [Chariot Moving](https://developer.liveswitch.com/docs/chariot-moving.md)
- [Chrome Extension](https://developer.liveswitch.com/docs/chrome-extension.md): By LiveSwitch
- [Housecall Pro](https://developer.liveswitch.com/docs/housecallpro.md): By LiveSwitch
- [HubSpot](https://developer.liveswitch.com/docs/hubspot.md): By: LiveSwitch
- [Jobber](https://developer.liveswitch.com/docs/jobber.md): By LiveSwitch
- [JobNimbus](https://developer.liveswitch.com/docs/jobnimbus.md): By LiveSwitch
- [Kickserv](https://developer.liveswitch.com/docs/kickserv.md): By LiveSwitch
- [MoveItPro](https://developer.liveswitch.com/docs/moveitpro.md)
- [ResponsiBid](https://developer.liveswitch.com/docs/responsibid.md)
- [ServiceMonster](https://developer.liveswitch.com/docs/servicemonster.md): By LiveSwitch
- [ServiceTitan](https://developer.liveswitch.com/docs/servicetitan.md): By LiveSwitch
- [Simpro](https://developer.liveswitch.com/docs/simpro.md): By LiveSwitch
- [Smart Moving](https://developer.liveswitch.com/docs/smart-moving.md)
- [Exchange Overview](https://developer.liveswitch.com/docs/getting-started-with-liveswitch-exchange.md)
- [Getting Started with Exchange](https://developer.liveswitch.com/docs/getting-started-with-liveswitch-exchange-1.md)
- [Zapier Example - Calendly](https://developer.liveswitch.com/docs/example-calendly.md)
- [Zapier Example - Jobber Request](https://developer.liveswitch.com/docs/zapier-example-jobber-request.md)
- [Zapier Examples - Video Recordings](https://developer.liveswitch.com/docs/zapier-video-examples-liveswitch-contact.md)
- [Zapier Example - Google Sheets](https://developer.liveswitch.com/docs/zapier-example-google-sheet.md)
- [Add a LiveSwitch Web Form to your website](https://developer.liveswitch.com/docs/adding-web-forms-to-wordpress.md): The instructions below pertain to WordPress-based websites. If your website is not based on WordPress and you need help setting up the LiveSwitch Web Form, please contact Support at +1 844-587-9824 or help@liveswitch.com.

## API Reference
- [Getting Started](https://developer.liveswitch.com/reference/getting-started.md): A complete getting started guide is available [here](/docs/getting-started). For the best experience, log in so we can show your request logs and automatically manage your tokens. Note that due to technical limits, you may occasionally see references to an "API Key". In LiveSwitch, that refers to the OAuth Bearer token.
- [Authentication](https://developer.liveswitch.com/reference/authentication.md): A complete getting started guide is available [here](/docs/getting-started). For the best experience, log in so we can show your request logs and automatically manage your auth tokens.
- [Retrieves a list of accounts](https://developer.liveswitch.com/reference/get_v1-accounts.md): **Required scope:** `accounts`
- [Gets an account by user ID](https://developer.liveswitch.com/reference/get_v1-accounts-userid.md): **Required scope:** `accounts`
- [Gets a list of attribute groups](https://developer.liveswitch.com/reference/get_v1-attribute-groups.md): **Required scope:** `attributes`
- [Creates an attribute group](https://developer.liveswitch.com/reference/post_v1-attribute-groups.md): **Required scope:** `attributes.write`
- [/v1/attribute-groups/app/{appId}](https://developer.liveswitch.com/reference/get_v1-attribute-groups-app-appid.md): **Required scope:** `attributes`
- [Gets an attribute group by id](https://developer.liveswitch.com/reference/get_v1-attribute-groups-id.md): **Required scope:** `attributes`
- [Updates an attribute group](https://developer.liveswitch.com/reference/put_v1-attribute-groups-id.md): **Required scope:** `attributes.write`
- [Deletes an attribute group](https://developer.liveswitch.com/reference/delete_v1-attribute-groups-id.md): **Required scope:** `attributes.write`
- [Gets an attribute group by name](https://developer.liveswitch.com/reference/get_v1-attribute-groups-by-name-name.md): **Required scope:** `attributes`
- [Gets a list of attributes](https://developer.liveswitch.com/reference/get_v1-attributes.md): **Required scope:** `attributes`
- [Creates an attribute](https://developer.liveswitch.com/reference/post_v1-attributes.md): **Required scope:** `attributes.write`
- [Gets a single attribute by id](https://developer.liveswitch.com/reference/get_v1-attributes-id.md): **Required scope:** `attributes`
- [Updates an attribute](https://developer.liveswitch.com/reference/put_v1-attributes-id.md): **Required scope:** `attributes.write`
- [Deletes an attribute by id](https://developer.liveswitch.com/reference/delete_v1-attributes-id.md): **Required scope:** `attributes.write`
- [Creates a new contact](https://developer.liveswitch.com/reference/post_v1-contacts.md): **Required scope:** `contacts.write`
- [Gets a list of contacts](https://developer.liveswitch.com/reference/get_v1-contacts.md): **Required scope:** `contacts`
- [Gets a contact by id](https://developer.liveswitch.com/reference/get_v1-contacts-id.md): **Required scope:** `contacts`
- [Gets a contact by phone](https://developer.liveswitch.com/reference/get_v1-contacts-by-phone-phone.md): **Required scope:** `contacts`
- [Updates a contact by ID](https://developer.liveswitch.com/reference/put_v1-contacts-id.md): **Required scope:** `contacts.write`
- [Deletes a contact](https://developer.liveswitch.com/reference/delete_v1-contacts-id.md): **Required scope:** `contacts`
- [Creates a conversation.](https://developer.liveswitch.com/reference/post_v1-conversations.md): **Required scope:** `conversations.write`
- [Retrieves a list of conversations.](https://developer.liveswitch.com/reference/get_v1-conversations.md): **Required scope:** `conversations`
- [Gets a conversation by ID.](https://developer.liveswitch.com/reference/get_v1-conversations-id.md): **Required scope:** `conversations`
- [Creates presigned URLs for uploading images to a conversation](https://developer.liveswitch.com/reference/post_v1-conversations-id-upload-urls-images.md): **Required scope:** `conversations.write`
- [Creates presigned URLs for uploading documents to a conversation](https://developer.liveswitch.com/reference/post_v1-conversations-id-upload-urls-documents.md): **Required scope:** `conversations.write`
- [Creates presigned URLs for uploading videos to a conversation](https://developer.liveswitch.com/reference/post_v1-conversations-id-upload-urls-videos.md): **Required scope:** `conversations.write`
- [Updates a conversation.](https://developer.liveswitch.com/reference/put_v1-conversations-id.md): **Required scope:** `conversations.write`
- [Run a Spark on a conversation](https://developer.liveswitch.com/reference/post_v1-conversations-conversationid-sparks.md): **Required scope:** `sparks.write`
- [Gets all Sparks by conversation ID](https://developer.liveswitch.com/reference/get_v1-conversations-conversationid-sparks.md): **Required scope:** `sparks`
- [Gets a document by id.](https://developer.liveswitch.com/reference/get_v1-documents-id.md): **Required scope:** `profile`
- [Gets documents by conversation id.](https://developer.liveswitch.com/reference/get_v1-documents-conversation-conversationid.md): **Required scope:** `profile`
- [Gets documents by project id.](https://developer.liveswitch.com/reference/get_v1-documents-project-projectid.md): **Required scope:** `profile`
- [Gets snapshots by conversation id.](https://developer.liveswitch.com/reference/get_v1-documents-conversation-snapshots-conversationid.md): **Required scope:** `profile`
- [Gets snapshots by project id.](https://developer.liveswitch.com/reference/get_v1-documents-project-snapshots-projectid.md): **Required scope:** `profile`
- [Gets files by conversation id.](https://developer.liveswitch.com/reference/get_v1-documents-conversation-files-conversationid.md): **Required scope:** `profile`
- [Gets files by project id.](https://developer.liveswitch.com/reference/get_v1-documents-project-files-projectid.md): **Required scope:** `profile`
- [Gets all the EntityAttributes for a given EntityType.](https://developer.liveswitch.com/reference/get_v1-entity-attributes-entitytype.md): You likely want the by-entity, which allows you to
 get all the EntityAttributes for a specific EntityType AND Entity - so you can get, for example, all the
 EntityAttributes on Conversation 1.  **Required scope:** `attributes`
- [Create an EntityAttribute for a given Entity.](https://developer.liveswitch.com/reference/post_v1-entity-attributes-entitytype.md): You can identify the attribute using either:
 - attributeId (the GUID of the attribute), OR
 - both attributeGroupName and attributeName together  **Required scope:** `attributes.write`
- [Allows you to get all the EntityAttributes for a specific EntityType AND Entity Instance.](https://developer.liveswitch.com/reference/get_v1-entity-attributes-entitytype-by-entity-entityid.md): Allows you to easily get, for example, all the EntityAttributes on Conversation A.
 You can optionally filter by attributeGroupName and/or attributeName.  **Required scope:** `attributes`
- [Reads a specific EntityAttribute for a given Entity Type by ID](https://developer.liveswitch.com/reference/get_v1-entity-attributes-entitytype-id.md): **Required scope:** `attributes`
- [Updates a given EntityAttribute](https://developer.liveswitch.com/reference/put_v1-entity-attributes-entitytype-id.md): **Required scope:** `attributes.write`
- [Deletes an EntityAttribute](https://developer.liveswitch.com/reference/delete_v1-entity-attributes-entitytype-id.md): **Required scope:** `attributes.write`
- [Gets a form by id.](https://developer.liveswitch.com/reference/get_v1-forms-id.md): **Required scope:** `forms`
- [Gets a form submission by id.](https://developer.liveswitch.com/reference/get_v1-forms-submissions-id.md): **Required scope:** `forms`
- [Gets guided instructions templates](https://developer.liveswitch.com/reference/get_v1-guided-instructions.md): **Required scope:** `guided-instructions`
- [Gets the current user](https://developer.liveswitch.com/reference/get_v1-me.md): **Required scope:** `me`
- [Gets your currently logged in organization settings.](https://developer.liveswitch.com/reference/get_v1-organizations-settings.md): **Required scope:** `organizations`
- [Updates the SMS enabled setting for your currently logged in organization.](https://developer.liveswitch.com/reference/patch_v1-organizations-sms-enabled.md): **Required scope:** `organizations.write`
- [Creates a project](https://developer.liveswitch.com/reference/post_v1-projects.md): **Required scope:** `projects.write`
- [Retrieves a list of projects](https://developer.liveswitch.com/reference/get_v1-projects.md): **Required scope:** `projects`
- [Gets a project by id](https://developer.liveswitch.com/reference/get_v1-projects-id.md): **Required scope:** `projects`
- [Updates a project](https://developer.liveswitch.com/reference/put_v1-projects-id.md): **Required scope:** `projects.write`
- [Creates presigned URLs for uploading images to a project](https://developer.liveswitch.com/reference/post_v1-projects-id-upload-urls-images.md): **Required scope:** `projects.write`
- [Creates presigned URLs for uploading documents to a project](https://developer.liveswitch.com/reference/post_v1-projects-id-upload-urls-documents.md): **Required scope:** `projects.write`
- [Creates presigned URLs for uploading videos to a project](https://developer.liveswitch.com/reference/post_v1-projects-id-upload-urls-videos.md): **Required scope:** `projects.write`
- [Creates a Spark on a project](https://developer.liveswitch.com/reference/post_v1-projects-projectid-sparks.md): **Required scope:** `sparks.write`
- [Lists all Spark runs for a project](https://developer.liveswitch.com/reference/get_v1-projects-projectid-sparks.md): **Required scope:** `sparks`
- [Gets a recording by id.](https://developer.liveswitch.com/reference/get_v1-recordings-id.md): **Required scope:** `recordings`
- [Gets recordings by conversation id.](https://developer.liveswitch.com/reference/get_v1-recordings-conversation-conversationid.md): **Required scope:** `recordings`
- [Gets recordings by project id.](https://developer.liveswitch.com/reference/get_v1-recordings-project-projectid.md): **Required scope:** `recordings`
- [Gets a Spark run by ID](https://developer.liveswitch.com/reference/get_v1-sparks-id.md): **Required scope:** `sparks`
- [Deletes a Spark run](https://developer.liveswitch.com/reference/delete_v1-sparks-id.md): **Required scope:** `sparks.write`
- [Makes a Spark report publicly shareable](https://developer.liveswitch.com/reference/makes-a-spark-report-publicly-shareable.md): **Required scope:** `sparks.write`
- [Gets all Spark templates for org ](https://developer.liveswitch.com/reference/get_v1-spark-templates.md): **Required scope:** `spark-templates`
- [Creates a tag](https://developer.liveswitch.com/reference/post_v1-tags.md): **Required scope:** `tags.write`
- [Retrieves a list of tags](https://developer.liveswitch.com/reference/get_v1-tags.md): **Required scope:** `tags`
- [Updates a tag. Supports partial updates.](https://developer.liveswitch.com/reference/put_v1-tags-id.md): **Required scope:** `tags.write`
- [Creates a webhook.](https://developer.liveswitch.com/reference/post_v1-webhooks.md): **Required scope:** `webhooks.write`
- [Gets a webhook by id.](https://developer.liveswitch.com/reference/get_v1-webhooks-id.md): **Required scope:** `webhooks`
- [Gets a list of all webhooks for this organization](https://developer.liveswitch.com/reference/get_v1-webhooks.md): **Required scope:** `webhooks`
- [Gets a list of all webhooks for this organization and the specific app](https://developer.liveswitch.com/reference/get_v1-webhooks-by-app-appid.md): **Required scope:** `webhooks`
- [Updates a webhoook](https://developer.liveswitch.com/reference/put_v1-webhooks-id.md): **Required scope:** `webhooks.write`
- [Deletes a webhook](https://developer.liveswitch.com/reference/delete_v1-webhooks-id.md): **Required scope:** `webhooks.write`
- [Deletes all webhooks by app id](https://developer.liveswitch.com/reference/unsubscribe.md): **Required scope:** `webhooks.write`

## Pages
- [Developer Apps](https://developer.liveswitch.com/my-developer-apps.md)