> ## Documentation Index
> Fetch the complete documentation index at: https://docs.yampi.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# Application API

> Endpoints de aplicación: cuenta, treasury, propiedades, compañías, oportunidades, contratos, Captain, SLA y más

<Info>
  Base: `https://app.yampi.ai/api/v1/`. Autenticación típica: **userApiKey** (token de usuario).
</Info>

## Cuenta y auditoría

<CardGroup cols={2}>
  <Card title="Get Account" icon="eye" href="/api-reference/app-account-show" />

  <Card title="Update Account" icon="pen" href="/api-reference/app-account-update" />

  <Card title="Audit Logs" icon="list" href="/api-reference/app-audit-logs" />
</CardGroup>

## Contacts

<CardGroup cols={2}>
  <Card title="List Contacts" icon="list" href="/api-reference/app-contacts-index" />

  <Card title="Create Contact" icon="plus" href="/api-reference/app-contacts-create" />

  <Card title="Get Contact" icon="eye" href="/api-reference/app-contacts-show" />

  <Card title="Search Contacts" icon="magnifying-glass" href="/api-reference/app-contacts-search" />

  <Card title="Filter Contacts" icon="filter" href="/api-reference/app-contacts-filter" />

  <Card title="Contact Conversations" icon="comments" href="/api-reference/app-contact-conversations" />

  <Card title="Update Contact" icon="pen" href="/api-reference/app-contacts-update" />

  <Card title="Delete Contact" icon="trash" href="/api-reference/app-contacts-delete" />

  <Card title="Contact Labels (list)" icon="tags" href="/api-reference/app-contact-labels-index" />

  <Card title="Contact Labels (create)" icon="plus" href="/api-reference/app-contact-labels-create" />

  <Card title="Merge Contacts" icon="code-merge" href="/api-reference/app-contact-merge" />
</CardGroup>

## Conversations

<CardGroup cols={2}>
  <Card title="List Conversations" icon="list" href="/api-reference/app-conversations-index" />

  <Card title="Create Conversation" icon="plus" href="/api-reference/app-conversations-create" />

  <Card title="Get Conversation" icon="eye" href="/api-reference/app-conversation-show" />

  <Card title="Conversation Meta" icon="chart-simple" href="/api-reference/app-conversation-meta" />

  <Card title="Update Conversation" icon="pen" href="/api-reference/app-conversation-update" />

  <Card title="Toggle Status" icon="toggle-on" href="/api-reference/app-conversation-toggle-status" />

  <Card title="Filter Conversations" icon="filter" href="/api-reference/app-conversation-filter" />

  <Card title="Toggle Priority" icon="star" href="/api-reference/app-conversation-toggle-priority" />

  <Card title="Custom Attributes" icon="list" href="/api-reference/app-conversation-custom-attributes" />

  <Card title="Assignments" icon="user-plus" href="/api-reference/app-conversation-assignments" />

  <Card title="Conversation Labels (list)" icon="tags" href="/api-reference/app-conversation-labels-index" />

  <Card title="Conversation Labels (create)" icon="plus" href="/api-reference/app-conversation-labels-create" />

  <Card title="Reporting Events" icon="chart-line" href="/api-reference/app-conversation-reporting-events" />
</CardGroup>

## Messages

<CardGroup cols={2}>
  <Card title="List Messages" icon="list" href="/api-reference/app-messages-index" />

  <Card title="Create Message" icon="plus" href="/api-reference/app-messages-create" />

  <Card title="Delete Message" icon="trash" href="/api-reference/app-messages-delete" />
</CardGroup>

## Inboxes

<CardGroup cols={2}>
  <Card title="List Inboxes" icon="list" href="/api-reference/app-inboxes-index" />

  <Card title="Get Inbox" icon="eye" href="/api-reference/app-inbox-show" />

  <Card title="Create Inbox" icon="plus" href="/api-reference/app-inbox-create" />

  <Card title="Update Inbox" icon="pen" href="/api-reference/app-inbox-update" />

  <Card title="Get Agent Bot" icon="robot" href="/api-reference/app-inbox-get-agent-bot" />

  <Card title="Set Agent Bot" icon="robot" href="/api-reference/app-inbox-set-agent-bot" />

  <Card title="Inbox Members (show)" icon="user" href="/api-reference/app-inbox-members-show" />

  <Card title="Inbox Members (create)" icon="plus" href="/api-reference/app-inbox-members-create" />

  <Card title="Inbox Members (update)" icon="pen" href="/api-reference/app-inbox-members-update" />

  <Card title="Inbox Members (delete)" icon="trash" href="/api-reference/app-inbox-members-delete" />
</CardGroup>

## Profile

<Card title="Get Profile" icon="user" href="/api-reference/app-profile" />

## Teams

<CardGroup cols={2}>
  <Card title="List Teams" icon="list" href="/api-reference/app-teams-index" />

  <Card title="Create Team" icon="plus" href="/api-reference/app-teams-create" />

  <Card title="Get Team" icon="eye" href="/api-reference/app-teams-show" />

  <Card title="Update Team" icon="pen" href="/api-reference/app-teams-update" />

  <Card title="Delete Team" icon="trash" href="/api-reference/app-teams-delete" />

  <Card title="Team Members (list)" icon="list" href="/api-reference/app-team-members-index" />

  <Card title="Team Members (add)" icon="plus" href="/api-reference/app-team-members-create" />

  <Card title="Team Members (update)" icon="pen" href="/api-reference/app-team-members-update" />

  <Card title="Team Members (remove)" icon="trash" href="/api-reference/app-team-members-delete" />
</CardGroup>

## Webhooks

<CardGroup cols={2}>
  <Card title="List Webhooks" icon="list" href="/api-reference/app-webhooks-index" />

  <Card title="Create Webhook" icon="plus" href="/api-reference/app-webhooks-create" />

  <Card title="Update Webhook" icon="pen" href="/api-reference/app-webhooks-update" />

  <Card title="Delete Webhook" icon="trash" href="/api-reference/app-webhooks-delete" />
</CardGroup>

## Agent Bots (Application)

<CardGroup cols={2}>
  <Card title="List Agent Bots" icon="list" href="/api-reference/app-agent-bots-index" />

  <Card title="Create Agent Bot" icon="plus" href="/api-reference/app-agent-bots-create" />

  <Card title="Get Agent Bot" icon="eye" href="/api-reference/app-agent-bots-show" />

  <Card title="Update Agent Bot" icon="pen" href="/api-reference/app-agent-bots-update" />

  <Card title="Delete Agent Bot" icon="trash" href="/api-reference/app-agent-bots-delete" />
</CardGroup>

## Agents

<CardGroup cols={2}>
  <Card title="List Agents" icon="list" href="/api-reference/app-agents-index" />

  <Card title="Create Agent" icon="plus" href="/api-reference/app-agents-create" />

  <Card title="Update Agent" icon="pen" href="/api-reference/app-agents-update" />

  <Card title="Delete Agent" icon="trash" href="/api-reference/app-agents-delete" />
</CardGroup>

## Custom Filters

<CardGroup cols={2}>
  <Card title="List Custom Filters" icon="list" href="/api-reference/app-custom-filters-index" />

  <Card title="Create Custom Filter" icon="plus" href="/api-reference/app-custom-filters-create" />

  <Card title="Get Custom Filter" icon="eye" href="/api-reference/app-custom-filters-show" />

  <Card title="Update Custom Filter" icon="pen" href="/api-reference/app-custom-filters-update" />

  <Card title="Delete Custom Filter" icon="trash" href="/api-reference/app-custom-filters-delete" />
</CardGroup>

## Automation Rules

<CardGroup cols={2}>
  <Card title="List Automation Rules" icon="list" href="/api-reference/app-automation-rules-index" />

  <Card title="Create Automation Rule" icon="plus" href="/api-reference/app-automation-rules-create" />

  <Card title="Get Automation Rule" icon="eye" href="/api-reference/app-automation-rules-show" />

  <Card title="Update Automation Rule" icon="pen" href="/api-reference/app-automation-rules-update" />

  <Card title="Delete Automation Rule" icon="trash" href="/api-reference/app-automation-rules-delete" />
</CardGroup>

## Canned Responses

<CardGroup cols={2}>
  <Card title="List Canned Responses" icon="list" href="/api-reference/app-canned-responses-index" />

  <Card title="Create Canned Response" icon="plus" href="/api-reference/app-canned-responses-create" />

  <Card title="Update Canned Response" icon="pen" href="/api-reference/app-canned-responses-update" />

  <Card title="Delete Canned Response" icon="trash" href="/api-reference/app-canned-responses-delete" />
</CardGroup>

## Custom Attribute Definitions

<CardGroup cols={2}>
  <Card title="List Definitions" icon="list" href="/api-reference/app-custom-attributes-index" />

  <Card title="Create Definition" icon="plus" href="/api-reference/app-custom-attributes-create" />

  <Card title="Get Definition" icon="eye" href="/api-reference/app-custom-attributes-show" />

  <Card title="Update Definition" icon="pen" href="/api-reference/app-custom-attributes-update" />

  <Card title="Delete Definition" icon="trash" href="/api-reference/app-custom-attributes-delete" />
</CardGroup>

## Integrations

<CardGroup cols={2}>
  <Card title="List Integration Apps" icon="list" href="/api-reference/app-integrations-apps" />

  <Card title="Create Hook" icon="plus" href="/api-reference/app-integrations-hooks-create" />

  <Card title="Update Hook" icon="pen" href="/api-reference/app-integrations-hooks-update" />

  <Card title="Delete Hook" icon="trash" href="/api-reference/app-integrations-hooks-delete" />
</CardGroup>

## Portals (Help Center)

<CardGroup cols={2}>
  <Card title="List Portals" icon="list" href="/api-reference/app-portals-index" />

  <Card title="Get Portal" icon="eye" href="/api-reference/app-portals-show" />

  <Card title="Create Portal Category" icon="folder" href="/api-reference/app-portals-categories" />

  <Card title="Create Portal Article" icon="file-lines" href="/api-reference/app-portals-articles" />
</CardGroup>

## Reports (v2)

<CardGroup cols={2}>
  <Card title="Account Reports" icon="chart-line" href="/api-reference/app-reports-v2-index" />

  <Card title="Reports Summary" icon="chart-pie" href="/api-reference/app-reports-v2-summary" />

  <Card title="Conversations (Account)" icon="comments" href="/api-reference/app-reports-v2-conversations-account" />

  <Card title="Conversations (Agent)" icon="user" href="/api-reference/app-reports-v2-conversations-agent" />

  <Card title="Summary by Channel" icon="satellite-dish" href="/api-reference/app-reports-v2-summary-channel" />

  <Card title="Summary by Inbox" icon="inbox" href="/api-reference/app-reports-v2-summary-inbox" />

  <Card title="Summary by Agent" icon="user" href="/api-reference/app-reports-v2-summary-agent" />

  <Card title="Summary by Team" icon="people-group" href="/api-reference/app-reports-v2-summary-team" />

  <Card title="First Response Time" icon="clock" href="/api-reference/app-reports-v2-first-response-time" />

  <Card title="Inbox Label Matrix" icon="table" href="/api-reference/app-reports-v2-inbox-label-matrix" />
</CardGroup>

## Reporting

<Card title="Reporting Events" icon="list" href="/api-reference/app-reporting-events" />

## Treasury

<CardGroup cols={2}>
  <Card title="List Subscriptions" icon="list" href="/api-reference/app-treasury-subscriptions-index" />

  <Card title="Get Subscription" icon="eye" href="/api-reference/app-treasury-subscription-show" />

  <Card title="Update Subscription" icon="pen" href="/api-reference/app-treasury-subscription-update" />

  <Card title="List Payments" icon="list" href="/api-reference/app-treasury-payments" />

  <Card title="List Payouts" icon="list" href="/api-reference/app-treasury-payouts" />

  <Card title="List Adjustments" icon="list" href="/api-reference/app-treasury-adjustments-index" />

  <Card title="Create Adjustment" icon="plus" href="/api-reference/app-treasury-adjustments-create" />

  <Card title="Notification Rules" icon="list" href="/api-reference/app-treasury-notification-rules" />

  <Card title="Retry Rules" icon="list" href="/api-reference/app-treasury-retry-rules" />

  <Card title="Treasury Dashboard" icon="chart-line" href="/api-reference/app-treasury-dashboard" />

  <Card title="Treasury Settings" icon="gear" href="/api-reference/app-treasury-settings" />
</CardGroup>

## Properties

<CardGroup cols={2}>
  <Card title="List Properties" icon="list" href="/api-reference/app-properties-index" />

  <Card title="Get Property" icon="eye" href="/api-reference/app-properties-show" />

  <Card title="Update Property" icon="pen" href="/api-reference/app-properties-update" />

  <Card title="Property Events" icon="list" href="/api-reference/app-properties-events" />

  <Card title="Property Contracts" icon="list" href="/api-reference/app-properties-contracts" />
</CardGroup>

## Companies

<CardGroup cols={2}>
  <Card title="List Companies" icon="list" href="/api-reference/app-companies-index" />

  <Card title="Create Company" icon="plus" href="/api-reference/app-companies-create" />

  <Card title="Get Company" icon="eye" href="/api-reference/app-companies-show" />

  <Card title="Update Company" icon="pen" href="/api-reference/app-companies-update" />

  <Card title="Delete Company" icon="trash" href="/api-reference/app-companies-destroy" />

  <Card title="Company Avatar" icon="image" href="/api-reference/app-companies-avatar" />
</CardGroup>

## Opportunities

<CardGroup cols={2}>
  <Card title="List Opportunities" icon="list" href="/api-reference/app-opportunities-index" />

  <Card title="Create Opportunity" icon="plus" href="/api-reference/app-opportunities-create" />

  <Card title="Get Opportunity" icon="eye" href="/api-reference/app-opportunities-show" />

  <Card title="Update Opportunity" icon="pen" href="/api-reference/app-opportunities-update" />

  <Card title="Delete Opportunity" icon="trash" href="/api-reference/app-opportunities-destroy" />

  <Card title="Restore Opportunity" icon="rotate-left" href="/api-reference/app-opportunities-restore" />

  <Card title="List Reminders" icon="list" href="/api-reference/app-opportunity-reminders-index" />

  <Card title="Create Reminder" icon="plus" href="/api-reference/app-opportunity-reminders-create" />
</CardGroup>

## Contract Templates

<CardGroup cols={2}>
  <Card title="List Templates" icon="list" href="/api-reference/app-contract-templates-index" />

  <Card title="Create Template" icon="plus" href="/api-reference/app-contract-templates-create" />

  <Card title="Get Template" icon="eye" href="/api-reference/app-contract-templates-show" />

  <Card title="Update Template" icon="pen" href="/api-reference/app-contract-templates-update" />

  <Card title="Delete Template" icon="trash" href="/api-reference/app-contract-templates-destroy" />

  <Card title="Archive Template" icon="box-archive" href="/api-reference/app-contract-templates-archive" />

  <Card title="Clone Template" icon="copy" href="/api-reference/app-contract-templates-clone" />

  <Card title="Detect Fields" icon="magnifying-glass" href="/api-reference/app-contract-templates-detect-fields" />

  <Card title="Template Submissions" icon="list" href="/api-reference/app-contract-templates-submissions" />
</CardGroup>

## Contract Submissions

<CardGroup cols={2}>
  <Card title="List Submissions" icon="list" href="/api-reference/app-contract-submissions-index" />

  <Card title="Create Submission" icon="plus" href="/api-reference/app-contract-submissions-create" />

  <Card title="Get Submission" icon="eye" href="/api-reference/app-contract-submissions-show" />

  <Card title="Update Submission" icon="pen" href="/api-reference/app-contract-submissions-update" />

  <Card title="Delete Submission" icon="trash" href="/api-reference/app-contract-submissions-destroy" />

  <Card title="Send Invitations" icon="envelope" href="/api-reference/app-contract-submissions-send-invitations" />
</CardGroup>

## Captain

<CardGroup cols={2}>
  <Card title="List Assistants" icon="list" href="/api-reference/app-captain-assistants-index" />

  <Card title="Create Assistant" icon="plus" href="/api-reference/app-captain-assistants-create" />

  <Card title="Captain Tools" icon="wrench" href="/api-reference/app-captain-assistants-tools" />

  <Card title="Summarize Task" icon="comment" href="/api-reference/app-captain-tasks-summarize" />

  <Card title="Reply Suggestion" icon="lightbulb" href="/api-reference/app-captain-tasks-reply-suggestion" />
</CardGroup>

## SLA y SAML

<CardGroup cols={2}>
  <Card title="SLA Policies" icon="list" href="/api-reference/app-sla-policies" />

  <Card title="Applied SLAs" icon="list" href="/api-reference/app-applied-slas" />

  <Card title="SAML Settings" icon="gear" href="/api-reference/app-saml-settings" />
</CardGroup>
