# Intercom API (unofficial showcase)

> Intercom API (unofficial showcase) API documentation

## Admins
- [GET /admins](https://octri-a72w4pdqwsum.octri.dev/get-admins): List admins
- [GET /admins/{admin_id}](https://octri-a72w4pdqwsum.octri.dev/get-admins-admin_id): Retrieve an admin
- [PUT /admins/{admin_id}/away](https://octri-a72w4pdqwsum.octri.dev/put-admins-admin_id-away): Set an admin to away
- [GET /admins/activity_log_event_types](https://octri-a72w4pdqwsum.octri.dev/get-admins-activity_log_event_types): List admin activity log event types
- [GET /admins/activity_logs](https://octri-a72w4pdqwsum.octri.dev/get-admins-activity_logs): List admin activity logs
- [POST /admins/activity_logs/search](https://octri-a72w4pdqwsum.octri.dev/post-admins-activity_logs-search): Search admin activity logs

## Ai
- [GET /ai/content_import_sources](https://octri-a72w4pdqwsum.octri.dev/get-ai-content_import_sources): List content import sources
- [POST /ai/content_import_sources](https://octri-a72w4pdqwsum.octri.dev/post-ai-content_import_sources): Create a content import source
- [GET /ai/content_import_sources/{source_id}](https://octri-a72w4pdqwsum.octri.dev/get-ai-content_import_sources-source_id): Retrieve a content import source
- [PUT /ai/content_import_sources/{source_id}](https://octri-a72w4pdqwsum.octri.dev/put-ai-content_import_sources-source_id): Update a content import source
- [DELETE /ai/content_import_sources/{source_id}](https://octri-a72w4pdqwsum.octri.dev/delete-ai-content_import_sources-source_id): Delete a content import source
- [GET /ai/external_pages](https://octri-a72w4pdqwsum.octri.dev/get-ai-external_pages): List external pages
- [POST /ai/external_pages](https://octri-a72w4pdqwsum.octri.dev/post-ai-external_pages): Create or update an external page
- [GET /ai/external_pages/{page_id}](https://octri-a72w4pdqwsum.octri.dev/get-ai-external_pages-page_id): Retrieve an external page
- [PUT /ai/external_pages/{page_id}](https://octri-a72w4pdqwsum.octri.dev/put-ai-external_pages-page_id): Update an external page
- [DELETE /ai/external_pages/{page_id}](https://octri-a72w4pdqwsum.octri.dev/delete-ai-external_pages-page_id): Delete an external page

## Articles
- [GET /articles](https://octri-a72w4pdqwsum.octri.dev/get-articles): List articles
- [POST /articles](https://octri-a72w4pdqwsum.octri.dev/post-articles): Create an article
- [GET /articles/{article_id}](https://octri-a72w4pdqwsum.octri.dev/get-articles-article_id): Retrieve an article
- [PUT /articles/{article_id}](https://octri-a72w4pdqwsum.octri.dev/put-articles-article_id): Update an article
- [DELETE /articles/{article_id}](https://octri-a72w4pdqwsum.octri.dev/delete-articles-article_id): Delete an article
- [POST /articles/{article_id}/tags](https://octri-a72w4pdqwsum.octri.dev/post-articles-article_id-tags): Add a tag to an article
- [DELETE /articles/{article_id}/tags/{id}](https://octri-a72w4pdqwsum.octri.dev/delete-articles-article_id-tags-id): Remove a tag from an article
- [GET /articles/{article_id}/versions](https://octri-a72w4pdqwsum.octri.dev/get-articles-article_id-versions): List article versions
- [GET /articles/{article_id}/versions/{id}](https://octri-a72w4pdqwsum.octri.dev/get-articles-article_id-versions-id): Retrieve an article version
- [GET /articles/{id}/draft](https://octri-a72w4pdqwsum.octri.dev/get-articles-id-draft): Retrieve an article draft
- [PUT /articles/{id}/draft](https://octri-a72w4pdqwsum.octri.dev/put-articles-id-draft): Stage an article draft
- [POST /articles/{id}/draft/publish](https://octri-a72w4pdqwsum.octri.dev/post-articles-id-draft-publish): Publish an article draft
- [GET /articles/search](https://octri-a72w4pdqwsum.octri.dev/get-articles-search): Search for articles

## Audiences
- [GET /audiences](https://octri-a72w4pdqwsum.octri.dev/get-audiences): List audiences
- [POST /audiences](https://octri-a72w4pdqwsum.octri.dev/post-audiences): Create an audience
- [GET /audiences/{id}](https://octri-a72w4pdqwsum.octri.dev/get-audiences-id): Retrieve an audience
- [PUT /audiences/{id}](https://octri-a72w4pdqwsum.octri.dev/put-audiences-id): Update an audience
- [DELETE /audiences/{id}](https://octri-a72w4pdqwsum.octri.dev/delete-audiences-id): Delete an audience

## Away_status_reasons
- [GET /away_status_reasons](https://octri-a72w4pdqwsum.octri.dev/get-away_status_reasons): List away status reasons

## Brands
- [GET /brands](https://octri-a72w4pdqwsum.octri.dev/get-brands): List all brands
- [GET /brands/{id}](https://octri-a72w4pdqwsum.octri.dev/get-brands-id): Retrieve a brand

## Calls
- [GET /calls](https://octri-a72w4pdqwsum.octri.dev/get-calls): List calls
- [GET /calls/{call_id}](https://octri-a72w4pdqwsum.octri.dev/get-calls-call_id): Get a call
- [GET /calls/{call_id}/recording](https://octri-a72w4pdqwsum.octri.dev/get-calls-call_id-recording): Get a call recording
- [GET /calls/{call_id}/transcript](https://octri-a72w4pdqwsum.octri.dev/get-calls-call_id-transcript): Get a call transcript
- [POST /calls/search](https://octri-a72w4pdqwsum.octri.dev/post-calls-search): List calls with transcripts

## Companies
- [GET /companies](https://octri-a72w4pdqwsum.octri.dev/get-companies): List or retrieve companies
- [POST /companies](https://octri-a72w4pdqwsum.octri.dev/post-companies): Create or update a company
- [GET /companies/{company_id}](https://octri-a72w4pdqwsum.octri.dev/get-companies-company_id): Retrieve a company by ID
- [PUT /companies/{company_id}](https://octri-a72w4pdqwsum.octri.dev/put-companies-company_id): Replace company details
- [DELETE /companies/{company_id}](https://octri-a72w4pdqwsum.octri.dev/delete-companies-company_id): Delete a company
- [GET /companies/{company_id}/contacts](https://octri-a72w4pdqwsum.octri.dev/get-companies-company_id-contacts): List contacts attached to a company
- [GET /companies/{company_id}/notes](https://octri-a72w4pdqwsum.octri.dev/get-companies-company_id-notes): List notes for a company
- [POST /companies/{company_id}/notes](https://octri-a72w4pdqwsum.octri.dev/post-companies-company_id-notes): Create a note for a company
- [GET /companies/{company_id}/segments](https://octri-a72w4pdqwsum.octri.dev/get-companies-company_id-segments): List segments attached to a company
- [POST /companies/list](https://octri-a72w4pdqwsum.octri.dev/post-companies-list): List all companies
- [GET /companies/scroll](https://octri-a72w4pdqwsum.octri.dev/get-companies-scroll): Scroll through all companies
- [POST /companies/search](https://octri-a72w4pdqwsum.octri.dev/post-companies-search): Search companies

## Contacts
- [GET /contacts](https://octri-a72w4pdqwsum.octri.dev/get-contacts): List contacts
- [POST /contacts](https://octri-a72w4pdqwsum.octri.dev/post-contacts): Create a contact
- [GET /contacts/{contact_id}](https://octri-a72w4pdqwsum.octri.dev/get-contacts-contact_id): Get a contact
- [PUT /contacts/{contact_id}](https://octri-a72w4pdqwsum.octri.dev/put-contacts-contact_id): Update a contact
- [DELETE /contacts/{contact_id}](https://octri-a72w4pdqwsum.octri.dev/delete-contacts-contact_id): Delete a contact
- [POST /contacts/{contact_id}/archive](https://octri-a72w4pdqwsum.octri.dev/post-contacts-contact_id-archive): Archive a contact
- [POST /contacts/{contact_id}/block](https://octri-a72w4pdqwsum.octri.dev/post-contacts-contact_id-block): Block a contact
- [GET /contacts/{contact_id}/companies](https://octri-a72w4pdqwsum.octri.dev/get-contacts-contact_id-companies): List companies attached to a contact
- [POST /contacts/{contact_id}/companies](https://octri-a72w4pdqwsum.octri.dev/post-contacts-contact_id-companies): Attach a company to a contact
- [DELETE /contacts/{contact_id}/companies/{company_id}](https://octri-a72w4pdqwsum.octri.dev/delete-contacts-contact_id-companies-company_id): Detach a company from a contact
- [GET /contacts/{contact_id}/notes](https://octri-a72w4pdqwsum.octri.dev/get-contacts-contact_id-notes): List notes for a contact
- [POST /contacts/{contact_id}/notes](https://octri-a72w4pdqwsum.octri.dev/post-contacts-contact_id-notes): Create a note for a contact
- [GET /contacts/{contact_id}/segments](https://octri-a72w4pdqwsum.octri.dev/get-contacts-contact_id-segments): List segments for a contact
- [GET /contacts/{contact_id}/subscriptions](https://octri-a72w4pdqwsum.octri.dev/get-contacts-contact_id-subscriptions): List subscriptions for a contact
- [POST /contacts/{contact_id}/subscriptions](https://octri-a72w4pdqwsum.octri.dev/post-contacts-contact_id-subscriptions): Add a subscription to a contact
- [DELETE /contacts/{contact_id}/subscriptions/{subscription_id}](https://octri-a72w4pdqwsum.octri.dev/delete-contacts-contact_id-subscriptions-subscription_id): Remove a subscription from a contact
- [GET /contacts/{contact_id}/tags](https://octri-a72w4pdqwsum.octri.dev/get-contacts-contact_id-tags): List tags for a contact
- [POST /contacts/{contact_id}/tags](https://octri-a72w4pdqwsum.octri.dev/post-contacts-contact_id-tags): Add a tag to a contact
- [DELETE /contacts/{contact_id}/tags/{tag_id}](https://octri-a72w4pdqwsum.octri.dev/delete-contacts-contact_id-tags-tag_id): Remove a tag from a contact
- [POST /contacts/{contact_id}/unarchive](https://octri-a72w4pdqwsum.octri.dev/post-contacts-contact_id-unarchive): Unarchive a contact
- [GET /contacts/{id}/banners](https://octri-a72w4pdqwsum.octri.dev/get-contacts-id-banners): List banners for a contact
- [POST /contacts/{id}/banners/{view_id}/dismiss](https://octri-a72w4pdqwsum.octri.dev/post-contacts-id-banners-view_id-dismiss): Dismiss a banner for a contact
- [GET /contacts/{id}/merge_history](https://octri-a72w4pdqwsum.octri.dev/get-contacts-id-merge_history): Get contact merge history
- [GET /contacts/activities](https://octri-a72w4pdqwsum.octri.dev/get-contacts-activities): List contact activities
- [POST /contacts/bulk](https://octri-a72w4pdqwsum.octri.dev/post-contacts-bulk): Bulk create contacts
- [PUT /contacts/bulk](https://octri-a72w4pdqwsum.octri.dev/put-contacts-bulk): Bulk update contacts
- [GET /contacts/bulk/{id}](https://octri-a72w4pdqwsum.octri.dev/get-contacts-bulk-id): Get a bulk contact job
- [POST /contacts/bulk/delete](https://octri-a72w4pdqwsum.octri.dev/post-contacts-bulk-delete): Bulk delete contacts
- [GET /contacts/deleted](https://octri-a72w4pdqwsum.octri.dev/get-contacts-deleted): List deleted contacts
- [GET /contacts/find_by_external_id/{external_id}](https://octri-a72w4pdqwsum.octri.dev/get-contacts-find_by_external_id-external_id): Get a user contact by external ID
- [POST /contacts/merge](https://octri-a72w4pdqwsum.octri.dev/post-contacts-merge): Merge a lead into a user contact
- [POST /contacts/merge/preview](https://octri-a72w4pdqwsum.octri.dev/post-contacts-merge-preview): Preview a contact merge
- [POST /contacts/search](https://octri-a72w4pdqwsum.octri.dev/post-contacts-search): Search contacts

## Content_snippets
- [GET /content_snippets](https://octri-a72w4pdqwsum.octri.dev/get-content_snippets): List content snippets
- [POST /content_snippets](https://octri-a72w4pdqwsum.octri.dev/post-content_snippets): Create a content snippet
- [POST /content_snippets/{content_snippet_id}/tags](https://octri-a72w4pdqwsum.octri.dev/post-content_snippets-content_snippet_id-tags): Add a tag to a content snippet
- [DELETE /content_snippets/{content_snippet_id}/tags/{id}](https://octri-a72w4pdqwsum.octri.dev/delete-content_snippets-content_snippet_id-tags-id): Remove a tag from a content snippet
- [GET /content_snippets/{id}](https://octri-a72w4pdqwsum.octri.dev/get-content_snippets-id): Retrieve a content snippet
- [PUT /content_snippets/{id}](https://octri-a72w4pdqwsum.octri.dev/put-content_snippets-id): Update a content snippet
- [DELETE /content_snippets/{id}](https://octri-a72w4pdqwsum.octri.dev/delete-content_snippets-id): Delete a content snippet

## Content
- [POST /content/bulk_actions](https://octri-a72w4pdqwsum.octri.dev/post-content-bulk_actions): Run a bulk action on Knowledge Hub content
- [GET /content/search](https://octri-a72w4pdqwsum.octri.dev/get-content-search): Search Knowledge Hub content

## Conversations
- [GET /conversations](https://octri-a72w4pdqwsum.octri.dev/get-conversations): List conversations
- [POST /conversations](https://octri-a72w4pdqwsum.octri.dev/post-conversations): Create a conversation
- [GET /conversations/{conversation_id}](https://octri-a72w4pdqwsum.octri.dev/get-conversations-conversation_id): Retrieve a conversation
- [PUT /conversations/{conversation_id}](https://octri-a72w4pdqwsum.octri.dev/put-conversations-conversation_id): Update a conversation
- [DELETE /conversations/{conversation_id}](https://octri-a72w4pdqwsum.octri.dev/delete-conversations-conversation_id): Delete a conversation
- [POST /conversations/{conversation_id}/convert](https://octri-a72w4pdqwsum.octri.dev/post-conversations-conversation_id-convert): Convert a conversation to a ticket
- [POST /conversations/{conversation_id}/customers](https://octri-a72w4pdqwsum.octri.dev/post-conversations-conversation_id-customers): Attach a contact to a conversation
- [DELETE /conversations/{conversation_id}/customers/{contact_id}](https://octri-a72w4pdqwsum.octri.dev/delete-conversations-conversation_id-customers-contact_id): Detach a contact from a group conversation
- [POST /conversations/{conversation_id}/parts](https://octri-a72w4pdqwsum.octri.dev/post-conversations-conversation_id-parts): Manage a conversation
- [POST /conversations/{conversation_id}/reply](https://octri-a72w4pdqwsum.octri.dev/post-conversations-conversation_id-reply): Reply to a conversation
- [POST /conversations/{conversation_id}/tags](https://octri-a72w4pdqwsum.octri.dev/post-conversations-conversation_id-tags): Add a tag to a conversation
- [DELETE /conversations/{conversation_id}/tags/{tag_id}](https://octri-a72w4pdqwsum.octri.dev/delete-conversations-conversation_id-tags-tag_id): Remove a tag from a conversation
- [GET /conversations/{id}/handling_events](https://octri-a72w4pdqwsum.octri.dev/get-conversations-id-handling_events): List conversation handling events
- [GET /conversations/{id}/hitl_events](https://octri-a72w4pdqwsum.octri.dev/get-conversations-id-hitl_events): List conversation HITL events
- [POST /conversations/{id}/merge](https://octri-a72w4pdqwsum.octri.dev/post-conversations-id-merge): Merge a conversation into another conversation
- [GET /conversations/{id}/side_conversations](https://octri-a72w4pdqwsum.octri.dev/get-conversations-id-side_conversations): List side conversations
- [GET /conversations/attributes](https://octri-a72w4pdqwsum.octri.dev/get-conversations-attributes): List conversation attributes
- [POST /conversations/attributes](https://octri-a72w4pdqwsum.octri.dev/post-conversations-attributes): Create a conversation attribute
- [GET /conversations/attributes/{id}](https://octri-a72w4pdqwsum.octri.dev/get-conversations-attributes-id): Get a conversation attribute
- [PUT /conversations/attributes/{id}](https://octri-a72w4pdqwsum.octri.dev/put-conversations-attributes-id): Update a conversation attribute
- [DELETE /conversations/attributes/{id}](https://octri-a72w4pdqwsum.octri.dev/delete-conversations-attributes-id): Archive a conversation attribute
- [POST /conversations/attributes/{id}/options](https://octri-a72w4pdqwsum.octri.dev/post-conversations-attributes-id-options): Add an option to a conversation attribute
- [PUT /conversations/attributes/{id}/options/{option_id}](https://octri-a72w4pdqwsum.octri.dev/put-conversations-attributes-id-options-option_id): Update an option on a conversation attribute
- [DELETE /conversations/attributes/{id}/options/{option_id}](https://octri-a72w4pdqwsum.octri.dev/delete-conversations-attributes-id-options-option_id): Archive a conversation attribute option
- [GET /conversations/deleted](https://octri-a72w4pdqwsum.octri.dev/get-conversations-deleted): List deleted conversation IDs
- [POST /conversations/redact](https://octri-a72w4pdqwsum.octri.dev/post-conversations-redact): Redact a conversation part or source message
- [POST /conversations/search](https://octri-a72w4pdqwsum.octri.dev/post-conversations-search): Search conversations

## Custom_object_instances
- [GET /custom_object_instances/{custom_object_type_identifier}](https://octri-a72w4pdqwsum.octri.dev/get-custom_object_instances-custom_object_type_identifier): List custom object instances
- [POST /custom_object_instances/{custom_object_type_identifier}](https://octri-a72w4pdqwsum.octri.dev/post-custom_object_instances-custom_object_type_identifier): Create or update a custom object instance
- [DELETE /custom_object_instances/{custom_object_type_identifier}](https://octri-a72w4pdqwsum.octri.dev/delete-custom_object_instances-custom_object_type_identifier): Delete a custom object instance by external ID
- [GET /custom_object_instances/{custom_object_type_identifier}/{custom_object_instance_id}](https://octri-a72w4pdqwsum.octri.dev/get-custom_object_instances-custom_object_type_identifier-custom_object_instance_id): Retrieve a custom object instance by ID
- [DELETE /custom_object_instances/{custom_object_type_identifier}/{custom_object_instance_id}](https://octri-a72w4pdqwsum.octri.dev/delete-custom_object_instances-custom_object_type_identifier-custom_object_instance_id): Delete a custom object instance by ID

## Data_attributes
- [GET /data_attributes](https://octri-a72w4pdqwsum.octri.dev/get-data_attributes): List data attributes
- [POST /data_attributes](https://octri-a72w4pdqwsum.octri.dev/post-data_attributes): Create a data attribute
- [PUT /data_attributes/{data_attribute_id}](https://octri-a72w4pdqwsum.octri.dev/put-data_attributes-data_attribute_id): Update a data attribute

## Data_connectors
- [GET /data_connectors](https://octri-a72w4pdqwsum.octri.dev/get-data_connectors): List data connectors
- [POST /data_connectors](https://octri-a72w4pdqwsum.octri.dev/post-data_connectors): Create a data connector
- [GET /data_connectors/{data_connector_id}/execution_results](https://octri-a72w4pdqwsum.octri.dev/get-data_connectors-data_connector_id-execution_results): List execution results for a data connector
- [GET /data_connectors/{data_connector_id}/execution_results/{id}](https://octri-a72w4pdqwsum.octri.dev/get-data_connectors-data_connector_id-execution_results-id): Retrieve a data connector execution result
- [GET /data_connectors/{id}](https://octri-a72w4pdqwsum.octri.dev/get-data_connectors-id): Retrieve a data connector
- [PATCH /data_connectors/{id}](https://octri-a72w4pdqwsum.octri.dev/patch-data_connectors-id): Update a data connector
- [DELETE /data_connectors/{id}](https://octri-a72w4pdqwsum.octri.dev/delete-data_connectors-id): Delete a data connector
- [GET /data_connectors/{id}/versions](https://octri-a72w4pdqwsum.octri.dev/get-data_connectors-id-versions): List versions of a data connector
- [GET /data_connectors/{id}/versions/{version_id}](https://octri-a72w4pdqwsum.octri.dev/get-data_connectors-id-versions-version_id): Retrieve a version of a data connector
- [PATCH /data_connectors/{id}/versions/{version_id}](https://octri-a72w4pdqwsum.octri.dev/patch-data_connectors-id-versions-version_id): Update the note on a data connector version

## Download
- [GET /download/content/data/{job_identifier}](https://octri-a72w4pdqwsum.octri.dev/get-download-content-data-job_identifier): Download content data export
- [GET /download/reporting_data/{job_identifier}](https://octri-a72w4pdqwsum.octri.dev/get-download-reporting_data-job_identifier): Download completed reporting export data

## Dynamic_contents
- [GET /dynamic_contents](https://octri-a72w4pdqwsum.octri.dev/get-dynamic_contents): List dynamic content
- [POST /dynamic_contents](https://octri-a72w4pdqwsum.octri.dev/post-dynamic_contents): Create dynamic content
- [GET /dynamic_contents/{id}](https://octri-a72w4pdqwsum.octri.dev/get-dynamic_contents-id): Retrieve dynamic content
- [PUT /dynamic_contents/{id}](https://octri-a72w4pdqwsum.octri.dev/put-dynamic_contents-id): Update dynamic content
- [DELETE /dynamic_contents/{id}](https://octri-a72w4pdqwsum.octri.dev/delete-dynamic_contents-id): Delete dynamic content

## Emails
- [GET /emails](https://octri-a72w4pdqwsum.octri.dev/get-emails): List email settings
- [GET /emails/{id}](https://octri-a72w4pdqwsum.octri.dev/get-emails-id): Retrieve an email setting

## Events
- [GET /events](https://octri-a72w4pdqwsum.octri.dev/get-events): List data events
- [POST /events](https://octri-a72w4pdqwsum.octri.dev/post-events): Submit a data event
- [POST /events/summaries](https://octri-a72w4pdqwsum.octri.dev/post-events-summaries): Create event summaries

## Export
- [POST /export/cancel/{job_identifier}](https://octri-a72w4pdqwsum.octri.dev/post-export-cancel-job_identifier): Cancel a content data export
- [POST /export/content/data](https://octri-a72w4pdqwsum.octri.dev/post-export-content-data): Create a content data export
- [GET /export/content/data/{job_identifier}](https://octri-a72w4pdqwsum.octri.dev/get-export-content-data-job_identifier): Get content data export status
- [GET /export/reporting_data/{job_identifier}](https://octri-a72w4pdqwsum.octri.dev/get-export-reporting_data-job_identifier): Get reporting data export job status
- [POST /export/reporting_data/enqueue](https://octri-a72w4pdqwsum.octri.dev/post-export-reporting_data-enqueue): Enqueue a reporting data export
- [GET /export/reporting_data/get_datasets](https://octri-a72w4pdqwsum.octri.dev/get-export-reporting_data-get_datasets): List available reporting datasets and attributes
- [GET /export/workflows/{id}](https://octri-a72w4pdqwsum.octri.dev/get-export-workflows-id): Export a workflow configuration

## Fin_voice
- [GET /fin_voice/collect/{id}](https://octri-a72w4pdqwsum.octri.dev/get-fin_voice-collect-id): Collect Fin Voice call by ID
- [GET /fin_voice/conversation/{conversation_id}](https://octri-a72w4pdqwsum.octri.dev/get-fin_voice-conversation-conversation_id): Collect Fin Voice calls by conversation ID
- [GET /fin_voice/external_id/{external_id}](https://octri-a72w4pdqwsum.octri.dev/get-fin_voice-external_id-external_id): Collect Fin Voice call by external ID
- [GET /fin_voice/phone_number/{phone_number}](https://octri-a72w4pdqwsum.octri.dev/get-fin_voice-phone_number-phone_number): Collect Fin Voice call by phone number
- [POST /fin_voice/register](https://octri-a72w4pdqwsum.octri.dev/post-fin_voice-register): Register a Fin Voice call

## Fin
- [POST /fin/ask](https://octri-a72w4pdqwsum.octri.dev/post-fin-ask): Ask Fin a question
- [POST /fin/capabilities](https://octri-a72w4pdqwsum.octri.dev/post-fin-capabilities): List Fin capabilities for a user
- [POST /fin/csat](https://octri-a72w4pdqwsum.octri.dev/post-fin-csat): Submit a Fin conversation CSAT rating
- [POST /fin/escalate](https://octri-a72w4pdqwsum.octri.dev/post-fin-escalate): Escalate a Fin conversation to a human
- [POST /fin/procedures/{procedure_id}/run](https://octri-a72w4pdqwsum.octri.dev/post-fin-procedures-procedure_id-run): Run a Fin procedure
- [POST /fin/reply](https://octri-a72w4pdqwsum.octri.dev/post-fin-reply): Reply to a Fin conversation
- [POST /fin/start](https://octri-a72w4pdqwsum.octri.dev/post-fin-start): Start a Fin conversation

## Folders
- [GET /folders](https://octri-a72w4pdqwsum.octri.dev/get-folders): List folders
- [POST /folders](https://octri-a72w4pdqwsum.octri.dev/post-folders): Create a folder
- [GET /folders/{id}](https://octri-a72w4pdqwsum.octri.dev/get-folders-id): Retrieve a folder
- [PUT /folders/{id}](https://octri-a72w4pdqwsum.octri.dev/put-folders-id): Update a folder
- [DELETE /folders/{id}](https://octri-a72w4pdqwsum.octri.dev/delete-folders-id): Delete a folder

## Help_center
- [GET /help_center/collections](https://octri-a72w4pdqwsum.octri.dev/get-help_center-collections): List help center collections
- [POST /help_center/collections](https://octri-a72w4pdqwsum.octri.dev/post-help_center-collections): Create a help center collection
- [GET /help_center/collections/{collection_id}](https://octri-a72w4pdqwsum.octri.dev/get-help_center-collections-collection_id): Retrieve a help center collection
- [PUT /help_center/collections/{collection_id}](https://octri-a72w4pdqwsum.octri.dev/put-help_center-collections-collection_id): Replace help center collection details
- [DELETE /help_center/collections/{collection_id}](https://octri-a72w4pdqwsum.octri.dev/delete-help_center-collections-collection_id): Delete a help center collection
- [GET /help_center/help_centers](https://octri-a72w4pdqwsum.octri.dev/get-help_center-help_centers): List help centers
- [GET /help_center/help_centers/{help_center_id}](https://octri-a72w4pdqwsum.octri.dev/get-help_center-help_centers-help_center_id): Retrieve a help center
- [GET /help_center/help_centers/{help_center_id}/redirects](https://octri-a72w4pdqwsum.octri.dev/get-help_center-help_centers-help_center_id-redirects): List redirects for a help center
- [POST /help_center/help_centers/{help_center_id}/redirects](https://octri-a72w4pdqwsum.octri.dev/post-help_center-help_centers-help_center_id-redirects): Create a help center redirect
- [GET /help_center/help_centers/{help_center_id}/redirects/{id}](https://octri-a72w4pdqwsum.octri.dev/get-help_center-help_centers-help_center_id-redirects-id): Retrieve a help center redirect
- [DELETE /help_center/help_centers/{help_center_id}/redirects/{id}](https://octri-a72w4pdqwsum.octri.dev/delete-help_center-help_centers-help_center_id-redirects-id): Delete a help center redirect

## Internal_articles
- [GET /internal_articles](https://octri-a72w4pdqwsum.octri.dev/get-internal_articles): List internal articles
- [POST /internal_articles](https://octri-a72w4pdqwsum.octri.dev/post-internal_articles): Create an internal article
- [GET /internal_articles/{internal_article_id}](https://octri-a72w4pdqwsum.octri.dev/get-internal_articles-internal_article_id): Retrieve an internal article
- [PUT /internal_articles/{internal_article_id}](https://octri-a72w4pdqwsum.octri.dev/put-internal_articles-internal_article_id): Update an internal article
- [DELETE /internal_articles/{internal_article_id}](https://octri-a72w4pdqwsum.octri.dev/delete-internal_articles-internal_article_id): Delete an internal article
- [POST /internal_articles/{internal_article_id}/tags](https://octri-a72w4pdqwsum.octri.dev/post-internal_articles-internal_article_id-tags): Add a tag to an internal article
- [DELETE /internal_articles/{internal_article_id}/tags/{id}](https://octri-a72w4pdqwsum.octri.dev/delete-internal_articles-internal_article_id-tags-id): Remove a tag from an internal article
- [GET /internal_articles/search](https://octri-a72w4pdqwsum.octri.dev/get-internal_articles-search): Search internal articles

## Ip_allowlist
- [GET /ip_allowlist](https://octri-a72w4pdqwsum.octri.dev/get-ip_allowlist): Get IP allowlist settings
- [PUT /ip_allowlist](https://octri-a72w4pdqwsum.octri.dev/put-ip_allowlist): Update IP allowlist settings

## Jobs
- [GET /jobs/status/{job_id}](https://octri-a72w4pdqwsum.octri.dev/get-jobs-status-job_id): Retrieve job status

## Macros
- [GET /macros](https://octri-a72w4pdqwsum.octri.dev/get-macros): List macros
- [GET /macros/{id}](https://octri-a72w4pdqwsum.octri.dev/get-macros-id): Retrieve a macro

## Me
- [GET /me](https://octri-a72w4pdqwsum.octri.dev/get-me): Identify the authenticated admin

## Messages
- [POST /messages](https://octri-a72w4pdqwsum.octri.dev/post-messages): Create a message
- [GET /messages/status](https://octri-a72w4pdqwsum.octri.dev/get-messages-status): List WhatsApp message status events
- [GET /messages/whatsapp/status](https://octri-a72w4pdqwsum.octri.dev/get-messages-whatsapp-status): Retrieve WhatsApp message delivery status

## News
- [GET /news/news_items](https://octri-a72w4pdqwsum.octri.dev/get-news-news_items): List news items
- [POST /news/news_items](https://octri-a72w4pdqwsum.octri.dev/post-news-news_items): Create a news item
- [GET /news/news_items/{news_item_id}](https://octri-a72w4pdqwsum.octri.dev/get-news-news_items-news_item_id): Get a news item
- [PUT /news/news_items/{news_item_id}](https://octri-a72w4pdqwsum.octri.dev/put-news-news_items-news_item_id): Update a news item
- [DELETE /news/news_items/{news_item_id}](https://octri-a72w4pdqwsum.octri.dev/delete-news-news_items-news_item_id): Delete a news item
- [GET /news/newsfeeds](https://octri-a72w4pdqwsum.octri.dev/get-news-newsfeeds): List newsfeeds
- [GET /news/newsfeeds/{newsfeed_id}](https://octri-a72w4pdqwsum.octri.dev/get-news-newsfeeds-newsfeed_id): Get a newsfeed
- [GET /news/newsfeeds/{newsfeed_id}/items](https://octri-a72w4pdqwsum.octri.dev/get-news-newsfeeds-newsfeed_id-items): List live items in a newsfeed

## Notes
- [GET /notes/{note_id}](https://octri-a72w4pdqwsum.octri.dev/get-notes-note_id): Get a note
- [DELETE /notes/{note_id}](https://octri-a72w4pdqwsum.octri.dev/delete-notes-note_id): Delete a note

## Office_hours_schedules
- [GET /office_hours_schedules](https://octri-a72w4pdqwsum.octri.dev/get-office_hours_schedules): List office hours schedules
- [POST /office_hours_schedules](https://octri-a72w4pdqwsum.octri.dev/post-office_hours_schedules): Create an office hours schedule
- [GET /office_hours_schedules/{id}](https://octri-a72w4pdqwsum.octri.dev/get-office_hours_schedules-id): Retrieve an office hours schedule
- [PUT /office_hours_schedules/{id}](https://octri-a72w4pdqwsum.octri.dev/put-office_hours_schedules-id): Update an office hours schedule
- [DELETE /office_hours_schedules/{id}](https://octri-a72w4pdqwsum.octri.dev/delete-office_hours_schedules-id): Delete an office hours schedule
- [GET /office_hours_schedules/{office_hours_schedule_id}/office_hours_exceptions](https://octri-a72w4pdqwsum.octri.dev/get-office_hours_schedules-office_hours_schedule_id-office_hours_exceptions): List office hours exceptions
- [POST /office_hours_schedules/{office_hours_schedule_id}/office_hours_exceptions](https://octri-a72w4pdqwsum.octri.dev/post-office_hours_schedules-office_hours_schedule_id-office_hours_exceptions): Create an office hours exception
- [GET /office_hours_schedules/{office_hours_schedule_id}/office_hours_exceptions/{id}](https://octri-a72w4pdqwsum.octri.dev/get-office_hours_schedules-office_hours_schedule_id-office_hours_exceptions-id): Retrieve an office hours exception
- [PUT /office_hours_schedules/{office_hours_schedule_id}/office_hours_exceptions/{id}](https://octri-a72w4pdqwsum.octri.dev/put-office_hours_schedules-office_hours_schedule_id-office_hours_exceptions-id): Update an office hours exception
- [DELETE /office_hours_schedules/{office_hours_schedule_id}/office_hours_exceptions/{id}](https://octri-a72w4pdqwsum.octri.dev/delete-office_hours_schedules-office_hours_schedule_id-office_hours_exceptions-id): Delete an office hours exception

## Phone_call_redirects
- [POST /phone_call_redirects](https://octri-a72w4pdqwsum.octri.dev/post-phone_call_redirects): Create a phone call redirect

## Segments
- [GET /segments](https://octri-a72w4pdqwsum.octri.dev/get-segments): List segments
- [GET /segments/{segment_id}](https://octri-a72w4pdqwsum.octri.dev/get-segments-segment_id): Retrieve a segment

## Subscription_types
- [GET /subscription_types](https://octri-a72w4pdqwsum.octri.dev/get-subscription_types): List subscription types

## Tags
- [GET /tags](https://octri-a72w4pdqwsum.octri.dev/get-tags): List tags
- [POST /tags](https://octri-a72w4pdqwsum.octri.dev/post-tags): Create or apply a tag
- [GET /tags/{tag_id}](https://octri-a72w4pdqwsum.octri.dev/get-tags-tag_id): Get a tag
- [DELETE /tags/{tag_id}](https://octri-a72w4pdqwsum.octri.dev/delete-tags-tag_id): Delete a tag

## Teams
- [GET /teams](https://octri-a72w4pdqwsum.octri.dev/get-teams): List teams
- [GET /teams/{team_id}](https://octri-a72w4pdqwsum.octri.dev/get-teams-team_id): Get a team
- [GET /teams/{team_id}/metrics](https://octri-a72w4pdqwsum.octri.dev/get-teams-team_id-metrics): Get real-time team activity metrics

## Ticket_states
- [GET /ticket_states](https://octri-a72w4pdqwsum.octri.dev/get-ticket_states): List ticket states

## Ticket_types
- [GET /ticket_types](https://octri-a72w4pdqwsum.octri.dev/get-ticket_types): List ticket types
- [POST /ticket_types](https://octri-a72w4pdqwsum.octri.dev/post-ticket_types): Create a ticket type
- [GET /ticket_types/{ticket_type_id}](https://octri-a72w4pdqwsum.octri.dev/get-ticket_types-ticket_type_id): Retrieve a ticket type
- [PUT /ticket_types/{ticket_type_id}](https://octri-a72w4pdqwsum.octri.dev/put-ticket_types-ticket_type_id): Update a ticket type
- [POST /ticket_types/{ticket_type_id}/attributes](https://octri-a72w4pdqwsum.octri.dev/post-ticket_types-ticket_type_id-attributes): Create a ticket type attribute
- [PUT /ticket_types/{ticket_type_id}/attributes/{attribute_id}](https://octri-a72w4pdqwsum.octri.dev/put-ticket_types-ticket_type_id-attributes-attribute_id): Update a ticket type attribute

## Tickets
- [POST /tickets](https://octri-a72w4pdqwsum.octri.dev/post-tickets): Create a ticket
- [GET /tickets/{ticket_id}](https://octri-a72w4pdqwsum.octri.dev/get-tickets-ticket_id): Retrieve a ticket
- [PUT /tickets/{ticket_id}](https://octri-a72w4pdqwsum.octri.dev/put-tickets-ticket_id): Update a ticket
- [DELETE /tickets/{ticket_id}](https://octri-a72w4pdqwsum.octri.dev/delete-tickets-ticket_id): Delete a ticket
- [POST /tickets/{ticket_id}/change_type](https://octri-a72w4pdqwsum.octri.dev/post-tickets-ticket_id-change_type): Change a ticket's type
- [POST /tickets/{ticket_id}/linked_conversations](https://octri-a72w4pdqwsum.octri.dev/post-tickets-ticket_id-linked_conversations): Link a conversation to a ticket
- [DELETE /tickets/{ticket_id}/linked_conversations/{id}](https://octri-a72w4pdqwsum.octri.dev/delete-tickets-ticket_id-linked_conversations-id): Unlink a conversation from a ticket
- [POST /tickets/{ticket_id}/reply](https://octri-a72w4pdqwsum.octri.dev/post-tickets-ticket_id-reply): Reply to a ticket
- [POST /tickets/{ticket_id}/tags](https://octri-a72w4pdqwsum.octri.dev/post-tickets-ticket_id-tags): Add a tag to a ticket
- [DELETE /tickets/{ticket_id}/tags/{tag_id}](https://octri-a72w4pdqwsum.octri.dev/delete-tickets-ticket_id-tags-tag_id): Remove a tag from a ticket
- [POST /tickets/enqueue](https://octri-a72w4pdqwsum.octri.dev/post-tickets-enqueue): Enqueue ticket creation
- [POST /tickets/search](https://octri-a72w4pdqwsum.octri.dev/post-tickets-search): Search tickets

## Visitors
- [GET /visitors](https://octri-a72w4pdqwsum.octri.dev/get-visitors): Retrieve a visitor by user ID
- [PUT /visitors](https://octri-a72w4pdqwsum.octri.dev/put-visitors): Update a visitor
- [POST /visitors/convert](https://octri-a72w4pdqwsum.octri.dev/post-visitors-convert): Convert a visitor to a contact

## Optional
- [Changelog](https://octri-a72w4pdqwsum.octri.dev/changelog): API version history and breaking changes