content stringlengths 1 103k ⌀ | path stringlengths 8 216 | filename stringlengths 2 179 | language stringclasses 15
values | size_bytes int64 2 189k | quality_score float64 0.5 0.95 | complexity float64 0 1 | documentation_ratio float64 0 1 | repository stringclasses 5
values | stars int64 0 1k | created_date stringdate 2023-07-10 19:21:08 2025-07-09 19:11:45 | license stringclasses 4
values | is_test bool 2
classes | file_hash stringlengths 32 32 |
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
type: object\nproperties:\n settings:\n type: object\n description: The settings required by the integration\n | dataset_sample\yaml\chatwoot_chatwoot\swagger\definitions\request\integrations\hook_update_payload.yml | hook_update_payload.yml | YAML | 112 | 0.85 | 0 | 0 | vue-tools | 90 | 2023-11-25T16:15:59.170927 | BSD-3-Clause | false | feb2eb5be8bedaf1ed79caa23e33d92c |
type: object\nproperties:\n content:\n type: string\n description: The text content.\n meta:\n type: object\n description: Use for search\n example: { tags: ['article_name'], title: 'article title', description: 'article description' }\n position:\n type: integer\n description: article position in category\n status:\n type: integer\n example: ['draft', 'published', 'archived']\n title:\n type: string\n slug:\n type: string\n views:\n type: integer\n portal_id:\n type: integer\n account_id:\n type: integer\n author_id:\n type: integer\n category_id:\n type: integer\n folder_id:\n type: integer\n associated_article_id:\n type: integer\n description: To associate similar articles to each other, e.g to provide the link for the reference.\n | dataset_sample\yaml\chatwoot_chatwoot\swagger\definitions\request\portal\article_create_update_payload.yml | article_create_update_payload.yml | YAML | 782 | 0.7 | 0.058824 | 0 | node-utils | 347 | 2024-11-16T14:38:34.046744 | MIT | false | 58ff9e7a91ac62cd1167f25b9d306de5 |
type: object\nproperties:\n description:\n type: string\n description: Category description\n locale:\n type: string\n description: Category locale\n example: en/es\n name:\n type: string\n description: Category name\n slug:\n type: string\n description: Category slug\n position:\n type: integer\n description: Category position in the portal list to sort\n portal_id:\n type: integer\n account_id:\n type: integer\n associated_category_id:\n type: integer\n description: To associate similar categories to each other, e.g same category of product documentation in different languages\n parent_category_id:\n type: integer\n description: To define parent category, e.g product documentation has multiple level features in sales category or in engineering category.\n | dataset_sample\yaml\chatwoot_chatwoot\swagger\definitions\request\portal\category_create_update_payload.yml | category_create_update_payload.yml | YAML | 799 | 0.7 | 0 | 0 | python-kit | 791 | 2024-04-03T17:20:44.971113 | Apache-2.0 | false | a2729bb405e7df5bbd64449e63d8d3ed |
type: object\nproperties:\n archived:\n type: boolean\n description: Status to check if portal is live\n color:\n type: string\n description: Header color for help-center\n example: add color HEX string, "#fffff"\n config:\n type: object\n description: Configuration about supporting locales\n example: { allowed_locales: ['en', 'es'], default_locale: 'en' }\n custom_domain:\n type: string\n description: Custom domain to display help center.\n example: https://chatwoot.help/.\n header_text:\n type: string\n description: Help center header\n example: Handbook\n homepage_link:\n type: string\n description: link to main dashboard\n example: https://www.chatwoot.com/\n name:\n type: string\n description: Name for the portal\n slug:\n type: string\n description: Slug for the portal to display in link\n page_title:\n type: string\n description: Page title for the portal\n account_id:\n type: integer\n | dataset_sample\yaml\chatwoot_chatwoot\swagger\definitions\request\portal\portal_create_update_payload.yml | portal_create_update_payload.yml | YAML | 953 | 0.8 | 0.138889 | 0 | python-kit | 439 | 2024-12-30T15:02:53.988250 | MIT | false | 4f25e8218e9a799b96a86fde098d1b8e |
\ntype: object\nproperties:\n identifier:\n type: string\n description: External identifier of the contact\n identifier_hash:\n type: string\n description: Identifier hash prepared for HMAC authentication\n email:\n type: string\n description: Email of the contact\n name:\n type: string\n description: Name of the contact\n phone_number:\n type: string\n description: Phone number of the contact\n avatar_url:\n type: string\n description: The url to a jpeg, png file for the user avatar\n custom_attributes:\n type: object\n description: Custom attributes of the customer | dataset_sample\yaml\chatwoot_chatwoot\swagger\definitions\request\public\contact\create_update_payload.yml | create_update_payload.yml | YAML | 599 | 0.7 | 0.086957 | 0 | react-lib | 266 | 2025-04-28T17:33:08.780366 | BSD-3-Clause | false | dd1b930d875a4af437c388766b679082 |
type: object\nproperties:\n custom_attributes:\n type: object\n description: Custom attributes of the conversation\n | dataset_sample\yaml\chatwoot_chatwoot\swagger\definitions\request\public\conversation\create_payload.yml | create_payload.yml | YAML | 118 | 0.7 | 0 | 0 | vue-tools | 627 | 2024-06-27T08:08:41.490231 | BSD-3-Clause | false | 6dbc757c31f7500985a68c27a1289ba3 |
\ntype: object\nproperties:\n content:\n type: string\n description: Content for the message\n echo_id:\n type: string\n description: Temporary identifier which will be passed back via websockets\n | dataset_sample\yaml\chatwoot_chatwoot\swagger\definitions\request\public\message\create_payload.yml | create_payload.yml | YAML | 204 | 0.7 | 0.111111 | 0 | python-kit | 973 | 2024-02-12T00:34:45.612347 | GPL-3.0 | false | f285e68e21b4d9c26bdb1670498c5938 |
\ntype: object\nproperties:\n submitted_values:\n type: object\n description: Replies to the Bot Message Types | dataset_sample\yaml\chatwoot_chatwoot\swagger\definitions\request\public\message\update_payload.yml | update_payload.yml | YAML | 112 | 0.7 | 0 | 0 | awesome-app | 662 | 2025-03-12T17:27:41.942604 | Apache-2.0 | false | be7c32d3e4d72c7e83868dc98e0961e8 |
type: object\nproperties:\n name:\n type: string\n description: The name of the team\n description:\n type: string\n description: The description of the team\n allow_auto_assign:\n type: boolean\n description: If this setting is turned on, the system would automatically assign the conversation to an agent in the team while assigning the conversation to a team\n | dataset_sample\yaml\chatwoot_chatwoot\swagger\definitions\request\team\create_update_payload.yml | create_update_payload.yml | YAML | 373 | 0.7 | 0.090909 | 0 | vue-tools | 925 | 2025-06-16T23:41:23.827520 | MIT | false | 2b0167c85375bfe7be216e41719d9cff |
type: object\nproperties:\n name:\n type: string\n description: Name of the user\n email:\n type: string\n description: Email of the user\n password:\n type: string\n description: Password must contain uppercase, lowercase letters, number and a special character\n custom_attributes:\n type: object\n description: Custom attributes you want to associate with the user\n\n | dataset_sample\yaml\chatwoot_chatwoot\swagger\definitions\request\user\create_update_payload.yml | create_update_payload.yml | YAML | 384 | 0.7 | 0 | 0 | react-lib | 6 | 2024-02-09T22:05:43.332440 | BSD-3-Clause | false | effc45a47caf4f1539cefba0813c1ff9 |
type: object\nproperties:\n url:\n type: string\n description: The url where the events should be sent\n subscriptions:\n type: array\n items:\n type: string\n enum: [\n "conversation_created",\n "conversation_status_changed",\n "conversation_updated",\n "message_created",\n "message_updated",\n "webwidget_triggered"\n ]\n description: The events you want to subscribe to.\n | dataset_sample\yaml\chatwoot_chatwoot\swagger\definitions\request\webhooks\create_update_payload.yml | create_update_payload.yml | YAML | 432 | 0.7 | 0 | 0 | vue-tools | 607 | 2025-04-21T00:36:02.707957 | MIT | false | 714db170df36665d9a72c6a4fc75661f |
type: object\nproperties:\n id:\n type: number\n description: Account ID\n name:\n type: string\n description: Name of the account\n role:\n type: string\n enum: ['administrator', 'agent']\n description: The user role in the account\n | dataset_sample\yaml\chatwoot_chatwoot\swagger\definitions\resource\account.yml | account.yml | YAML | 246 | 0.7 | 0 | 0 | node-utils | 758 | 2024-04-09T06:41:03.361900 | MIT | false | b3c0357a18f8f9b835f494f842a8b443 |
type: object\nproperties:\n id:\n type: integer\n uid:\n type: string\n name:\n type: string\n available_name:\n type: string\n display_name:\n type: string\n email:\n type: string\n account_id:\n type: integer\n role:\n type: string\n enum: ['agent', 'administrator']\n confirmed:\n type: boolean\n availability_status: \n type: string\n enum: ['available', 'busy', 'offline']\n description: The availability status of the agent computed by Chatwoot.\n auto_offline:\n type: boolean\n description: Whether the availability status of agent is configured to go offline automatically when away.\n custom_attributes: \n type: object\n description: Available for users who are created through platform APIs and has custom attributes associated.\n\n | dataset_sample\yaml\chatwoot_chatwoot\swagger\definitions\resource\agent.yml | agent.yml | YAML | 775 | 0.7 | 0.03125 | 0 | vue-tools | 507 | 2024-01-19T21:45:40.418941 | BSD-3-Clause | false | 6b9ddb54629bad04e60ac22552afb0b0 |
type: object\nproperties:\n id:\n type: number\n description: ID of the agent bot\n name:\n type: string\n description: The name of the agent bot\n description:\n type: string\n description: The description about the agent bot\n account_id:\n type: number\n description: Account ID if it's an account specific bot\n outgoing_url:\n type: string\n description: The webhook URL for the bot\n | dataset_sample\yaml\chatwoot_chatwoot\swagger\definitions\resource\agent_bot.yml | agent_bot.yml | YAML | 407 | 0.7 | 0.117647 | 0 | vue-tools | 13 | 2023-11-25T03:33:37.528357 | BSD-3-Clause | false | 619c277afd3f6e20b048267d100dd531 |
type: object\nproperties:\n id:\n type: integer\n content:\n type: string\n description: The text content.\n meta:\n type: object\n position:\n type: integer\n status:\n type: integer\n enum: ['draft', 'published', 'archived']\n title:\n type: string\n slug:\n type: string\n views:\n type: integer\n portal_id:\n type: integer\n account_id:\n type: integer\n author_id:\n type: integer\n category_id:\n type: integer\n folder_id:\n type: integer\n associated_article_id:\n type: integer\n description: To associate similar articles to each other, e.g to provide the link for the reference.\n | dataset_sample\yaml\chatwoot_chatwoot\swagger\definitions\resource\article.yml | article.yml | YAML | 624 | 0.7 | 0.030303 | 0 | react-lib | 758 | 2025-03-11T13:25:58.798875 | GPL-3.0 | false | edc3403a000641b15a40c1a4734497db |
type: object\nproperties:\n event_name:\n type: string\n description: Automation Rule event, on which we call the actions(conversation_created, conversation_updated, message_created)\n enum:\n - conversation_created\n - conversation_updated\n - message_created\n example: message_created\n name:\n type: string\n description: The name of the rule\n example: Add label on message create event\n description:\n type: string\n description: Description to give more context about the rule\n example: Add label support and sales on message create event if incoming message content contains text help\n active:\n type: boolean\n description: Enable/disable automation rule\n actions:\n type: array\n description: Array of actions which we perform when condition matches\n items:\n type: object\n example:\n action_name: add_label\n action_params:\n - support\n - sales\n conditions:\n type: array\n description: Array of conditions on which conversation/message filter would work\n items:\n type: object\n example:\n attribute_key: content\n filter_operator: contains\n values:\n - help\n query_operator: nil\n account_id:\n type: integer\n description: Account Id\n | dataset_sample\yaml\chatwoot_chatwoot\swagger\definitions\resource\automation_rule.yml | automation_rule.yml | YAML | 1,286 | 0.7 | 0.022222 | 0 | python-kit | 122 | 2024-10-05T12:18:09.378546 | GPL-3.0 | false | 9cea069a8f89f4874f98e3d3fbdee710 |
type: object\nproperties:\n id:\n type: integer\n description: ID of the canned response\n content:\n type: string\n description: Message content for canned response\n short_code:\n type: string\n description: Short Code for quick access of the canned response\n account_id:\n type: integer\n description: Account Id\n | dataset_sample\yaml\chatwoot_chatwoot\swagger\definitions\resource\canned_response.yml | canned_response.yml | YAML | 332 | 0.7 | 0.142857 | 0 | vue-tools | 361 | 2023-07-31T23:51:35.438701 | GPL-3.0 | false | 7e008d8c8632d1d80e5da59e6d08bc9f |
type: object\nproperties:\n id:\n type: integer\n description:\n type: string\n description: The text content.\n locale:\n type: string\n name:\n type: string\n slug:\n type: string\n position:\n type: integer\n portal_id:\n type: integer\n account_id:\n type: integer\n associated_category_id:\n type: integer\n description: To associate similar categories to each other, e.g same category of product documentation in different languages\n parent_category_id:\n type: integer\n description: To define parent category, e.g product documentation has multiple level features in sales category or in engineering category.\n | dataset_sample\yaml\chatwoot_chatwoot\swagger\definitions\resource\category.yml | category.yml | YAML | 644 | 0.7 | 0 | 0 | react-lib | 452 | 2024-10-25T13:24:06.054982 | GPL-3.0 | false | 4d23297afd923ec85eb69a2b28078da5 |
type: object\nproperties:\n payload:\n type: object\n properties:\n contact:\n type: object\n properties:\n email:\n type: string\n description: Email address of the contact\n name:\n type: string\n description: The name of the contact\n phone_number:\n type: string\n description: Phone number of the contact\n thumbnail:\n type: string\n description: Avatar URL of the contact\n additional_attributes:\n type: object\n description: The object containing additional attributes related to the contact\n custom_attributes:\n type: object\n description: The object to save custom attributes for contact, accepts custom attributes key and value\n example: { attribute_key: attribute_value, signed_up_at: dd/mm/yyyy }\n contact_inboxes:\n type: array\n items:\n $ref: '#/definitions/contact_inboxes'\n | dataset_sample\yaml\chatwoot_chatwoot\swagger\definitions\resource\contact.yml | contact.yml | YAML | 1,033 | 0.8 | 0.032258 | 0 | vue-tools | 70 | 2025-03-03T03:45:40.907653 | Apache-2.0 | false | 779e99c4d3a3a5c942a3885b7c8fb403 |
type: object\nproperties:\n source_id:\n type: string\n description: Contact Inbox Source Id\n inbox:\n type: object\n $ref: '#/definitions/inbox'\n | dataset_sample\yaml\chatwoot_chatwoot\swagger\definitions\resource\contactable_inboxes.yml | contactable_inboxes.yml | YAML | 154 | 0.8 | 0 | 0 | node-utils | 669 | 2023-07-15T23:23:16.876007 | BSD-3-Clause | false | 282071cead384f069da4c211f2e26d39 |
type: object\nproperties:\n source_id:\n type: string\n description: Contact Inbox Source Id\n inbox:\n type: object\n $ref: '#/definitions/inbox'\n | dataset_sample\yaml\chatwoot_chatwoot\swagger\definitions\resource\contact_inboxes.yml | contact_inboxes.yml | YAML | 154 | 0.8 | 0 | 0 | vue-tools | 805 | 2024-09-18T06:47:29.593764 | Apache-2.0 | false | 282071cead384f069da4c211f2e26d39 |
type: object\nproperties:\n id:\n type: number\n description: ID of the conversation\n messages:\n type: array\n items:\n $ref: '#/definitions/message'\n account_id:\n type: number\n description: Account Id\n inbox_id:\n type: number\n description: ID of the inbox\n status:\n type: string\n enum: ['open', 'resolved', 'pending']\n description: The status of the conversation\n timestamp:\n type: string\n description: The time at which conversation was created\n contact_last_seen_at:\n type: string\n agent_last_seen_at:\n type: string\n unread_count:\n type: number\n description: The number of unread messages\n additional_attributes:\n type: object\n description: The object containing additional attributes related to the conversation\n custom_attributes:\n type: object\n description: The object to save custom attributes for conversation, accepts custom attributes key and value\n example: { attribute_key: attribute_value, priority_conversation_number: 3 }\n | dataset_sample\yaml\chatwoot_chatwoot\swagger\definitions\resource\conversation.yml | conversation.yml | YAML | 1,013 | 0.8 | 0.027778 | 0 | react-lib | 80 | 2025-03-07T07:47:19.445647 | GPL-3.0 | false | c8b22532f85b150e3290bef37ee271c4 |
type: object\nproperties:\n id:\n type: integer\n description: Identifier\n attribute_display_name:\n type: string\n description: Attribute display name\n attribute_display_type:\n type: string\n description: Attribute display type (text, number, currency, percent, link, date, list, checkbox)\n attribute_description:\n type: string\n description: Attribute description\n attribute_key:\n type: string\n description: Attribute unique key value\n attribute_values:\n type: string\n description: Attribute values\n default_value:\n type: string\n description: Attribute default value\n attribute_model:\n type: string\n description: Attribute type(conversation_attribute/contact_attribute)\n account_id:\n type: integer\n description: Account Id\n | dataset_sample\yaml\chatwoot_chatwoot\swagger\definitions\resource\custom_attribute.yml | custom_attribute.yml | YAML | 780 | 0.7 | 0 | 0 | react-lib | 187 | 2023-12-02T18:33:03.753157 | GPL-3.0 | false | 02a11b16476cd70aa1665f70d934cbbb |
type: object\nproperties:\n id:\n type: number\n description: The ID of the custom filter\n name:\n type: string\n description: The name of the custom filter\n type:\n type: string\n enum: ["conversation", "contact", "report"]\n description: The description about the custom filter\n query:\n type: object\n description: A query that needs to be saved as a custom filter\n created_at:\n type: string\n format: date-time\n description: The time at which the custom filter was created\n updated_at:\n type: string\n format: date-time\n description: The time at which the custom filter was updated\n | dataset_sample\yaml\chatwoot_chatwoot\swagger\definitions\resource\custom_filter.yml | custom_filter.yml | YAML | 624 | 0.7 | 0 | 0 | python-kit | 360 | 2023-12-14T11:29:12.869277 | BSD-3-Clause | false | f45e4ba77f7b56459b941f9a4d5e4e77 |
type: object\nproperties:\n id:\n type: number\n description: ID of the inbox\n name:\n type: string\n description: The name of the inbox\n website_url:\n type: string\n description: Website URL\n channel_type:\n type: string\n description: The type of the inbox\n avatar_url:\n type: string\n description: The avatar image of the inbox\n widget_color:\n type: string\n description: Widget Color used for customization of the widget\n website_token:\n type: string\n description: Website Token\n enable_auto_assignment:\n type: boolean\n description: The flag which shows whether Auto Assignment is enabled or not\n web_widget_script:\n type: string\n description: Script used to load the website widget\n welcome_title:\n type: string\n description: Welcome title to be displayed on the widget\n welcome_tagline:\n type: string\n description: Welcome tagline to be displayed on the widget\n greeting_enabled:\n type: boolean\n description: The flag which shows whether greeting is enabled\n greeting_message:\n type: string\n description: A greeting message when the user starts the conversation\n | dataset_sample\yaml\chatwoot_chatwoot\swagger\definitions\resource\inbox.yml | inbox.yml | YAML | 1,148 | 0.7 | 0.02439 | 0 | react-lib | 76 | 2024-04-04T06:40:09.700851 | Apache-2.0 | false | 20b9591fdd4634b20963a103228ad445 |
type: object\nproperties:\n content:\n type: string\n description: The text content of the message\n content_type:\n type: string\n enum: ["text", "input_select", "cards", "form"]\n description: The type of the template message\n content_attributes:\n type: object\n description: The content attributes for each content_type\n message_type:\n type: string\n enum: ["incoming", "outgoing", "activity", "template"]\n description: The type of the message\n created_at:\n type: integer\n description: The time at which message was created\n private:\n type: boolean\n description: The flags which shows whether the message is private or not\n attachment:\n type: object\n description: The file object attached to the image\n sender:\n type: object\n description: User/Agent/AgentBot object\n conversation_id:\n type: number\n description: ID of the conversation\n | dataset_sample\yaml\chatwoot_chatwoot\swagger\definitions\resource\message.yml | message.yml | YAML | 897 | 0.7 | 0.032258 | 0 | python-kit | 80 | 2024-08-16T17:00:53.539103 | BSD-3-Clause | false | c8dfd4bdd0bb779244a068aa123bd5f4 |
type: object\nproperties:\n id:\n type: number\n description: Account ID\n name:\n type: string\n description: Name of the account\n\n | dataset_sample\yaml\chatwoot_chatwoot\swagger\definitions\resource\platform_account.yml | platform_account.yml | YAML | 139 | 0.7 | 0 | 0 | vue-tools | 578 | 2025-04-08T19:38:49.657897 | BSD-3-Clause | false | 46ccb7b6f5802bd920f640abd4763d7e |
type: object\nproperties:\n id:\n type: integer\n archived:\n type: boolean\n color:\n type: string\n config:\n type: object\n description: Save information about locales, allowed_locales and default portal/help-center locale\n custom_domain:\n type: string\n header_text:\n type: string\n description: The text content.\n homepage_link:\n type: string\n name:\n type: string\n slug:\n type: string\n page_title:\n type: string\n account_id:\n type: integer\n categories:\n type: array\n items:\n $ref: '#/definitions/category'\n articles:\n type: array\n items:\n $ref: '#/definitions/article'\n | dataset_sample\yaml\chatwoot_chatwoot\swagger\definitions\resource\portal.yml | portal.yml | YAML | 636 | 0.8 | 0 | 0 | vue-tools | 318 | 2025-02-18T00:45:59.183838 | GPL-3.0 | false | 306f9d53d100b11d0f220fe141d2757f |
type: object\nproperties:\n id:\n type: number\n description: The ID of the team\n name:\n type: string\n description: The name of the team\n description:\n type: string\n description: The description about the team\n allow_auto_assign:\n type: boolean\n description: If this setting is turned on, the system would automatically assign the conversation to an agent in the team while assigning the conversation to a team\n account_id:\n type: number\n description: The ID of the account with the team is a part of\n is_member:\n type: boolean\n description: This field shows whether the current user is a part of the team\n | dataset_sample\yaml\chatwoot_chatwoot\swagger\definitions\resource\team.yml | team.yml | YAML | 644 | 0.7 | 0.05 | 0 | python-kit | 739 | 2024-08-06T07:21:35.708501 | MIT | false | ac72cc1de2e25a25f00cd88a6f4b4ed9 |
type: object\nproperties:\n id:\n type: number\n uid:\n type: string\n name:\n type: string\n available_name:\n type: string\n display_name:\n type: string\n email:\n type: string\n account_id:\n type: number\n role:\n type: string\n enum: ['agent', 'administrator']\n confirmed:\n type: boolean\n custom_attributes: \n type: object\n description: Available for users who are created through platform APIs and has custom attributes associated.\n accounts:\n type: array\n items:\n $ref: '#/definitions/account'\n | dataset_sample\yaml\chatwoot_chatwoot\swagger\definitions\resource\user.yml | user.yml | YAML | 542 | 0.8 | 0.035714 | 0 | node-utils | 953 | 2024-05-17T19:36:58.625628 | Apache-2.0 | false | 423f93c2f85e10279937938efe4471f2 |
type: object\nproperties:\n id:\n type: number\n description: The ID of the webhook\n url:\n type: string\n description: The url to which the events will be send\n subscriptions:\n type: array\n items:\n type: string\n enum: [\n "conversation_created",\n "conversation_status_changed",\n "conversation_updated",\n "contact_created",\n "contact_updated",\n "message_created",\n "message_updated",\n "webwidget_triggered"\n ]\n description: The list of subscribed events\n account_id:\n type: number\n description: The id of the account which the webhook object belongs to\n | dataset_sample\yaml\chatwoot_chatwoot\swagger\definitions\resource\webhook.yml | webhook.yml | YAML | 648 | 0.7 | 0 | 0 | react-lib | 15 | 2024-07-06T23:58:56.010033 | BSD-3-Clause | false | 217223a641e8dcb5b42c1086c1326e6b |
type: object\nproperties:\n meta:\n type: object\n properties:\n sender:\n type: object\n properties:\n id:\n type: number\n description: ID fo the sender\n name:\n type: string\n description: The name of the sender\n thumbnail:\n type: string\n description: Avatar URL of the contact\n channel:\n type: string\n description: Channel Type\n assignee:\n $ref: '#/definitions/user'\n | dataset_sample\yaml\chatwoot_chatwoot\swagger\definitions\resource\extension\contact\conversation.yml | conversation.yml | YAML | 521 | 0.8 | 0 | 0 | node-utils | 884 | 2024-05-10T16:33:56.098532 | GPL-3.0 | false | dbe8bbd9ed3ab214c90275dc70f647ce |
type: object\nproperties:\n payload:\n type: array\n description: Array of labels\n items:\n type: string\n | dataset_sample\yaml\chatwoot_chatwoot\swagger\definitions\resource\extension\contact\labels.yml | labels.yml | YAML | 115 | 0.7 | 0 | 0 | python-kit | 341 | 2024-05-03T17:38:59.568275 | MIT | false | 2bbfda81d9154c58bde3514e3fb1b271 |
type: object\nproperties:\n id:\n type: number\n description: Id of the user\n availability_status:\n type: string\n enum: ['online', 'offline']\n description: Availability status of the user\n | dataset_sample\yaml\chatwoot_chatwoot\swagger\definitions\resource\extension\contact\show.yml | show.yml | YAML | 201 | 0.7 | 0 | 0 | awesome-app | 586 | 2025-02-16T19:24:45.951361 | MIT | false | 40d528fe7ebbf4278001e94f7ca8d94d |
type: object\nproperties:\n payload:\n type: array\n description: Array of labels\n items:\n type: string\n | dataset_sample\yaml\chatwoot_chatwoot\swagger\definitions\resource\extension\conversation\labels.yml | labels.yml | YAML | 115 | 0.7 | 0 | 0 | react-lib | 196 | 2025-01-19T09:56:21.490380 | BSD-3-Clause | false | 2bbfda81d9154c58bde3514e3fb1b271 |
type: object\nproperties:\n data:\n type: object\n properties:\n meta:\n type: object\n properties:\n mine_count:\n type: number\n unassigned_count:\n type: number\n assigned_count:\n type: number\n all_count:\n type: number\n payload:\n type: array\n description: 'array of conversations'\n items:\n allOf:\n - $ref: '#/definitions/generic_id'\n - $ref: '#/definitions/conversation'\n - $ref: '../contact/conversation.yml'\n | dataset_sample\yaml\chatwoot_chatwoot\swagger\definitions\resource\extension\conversation\list.yml | list.yml | YAML | 575 | 0.8 | 0 | 0 | react-lib | 553 | 2024-07-23T14:52:28.093717 | BSD-3-Clause | false | 9db4c3a998d777d6779e3a9f28d1b0c8 |
type: object\nallOf:\n - $ref: '#/definitions/conversation'\n - $ref: '../contact/conversation.yml'\n | dataset_sample\yaml\chatwoot_chatwoot\swagger\definitions\resource\extension\conversation\show.yml | show.yml | YAML | 99 | 0.6 | 0 | 0 | node-utils | 484 | 2023-12-20T09:18:53.572222 | BSD-3-Clause | false | b6918f5f3e7d82def4bc846ae2b4c06f |
type: object\nproperties:\n meta:\n type: object\n payload:\n type: object\n properties:\n success:\n type: boolean\n current_status:\n type: string\n enum: ['open', 'resolved']\n conversation_id:\n type: number\n | dataset_sample\yaml\chatwoot_chatwoot\swagger\definitions\resource\extension\conversation\status_toggle.yml | status_toggle.yml | YAML | 253 | 0.7 | 0 | 0 | python-kit | 779 | 2024-12-24T15:34:39.121340 | Apache-2.0 | false | f015ea65ba3d97d47d69cc9983dbcdf4 |
type: object\nproperties:\n id:\n type: string\n description: The ID of the integration\n name:\n type: string\n description: The name of the integration\n description:\n type: string\n description: The description about the team\n hook_type:\n type: string\n description: Whether the integration is an account or inbox integration\n enabled:\n type: boolean\n description: Whether the integration is enabled for the account\n allow_multiple_hooks:\n type: boolean\n description: Whether multiple hooks can be created for the integration\n hooks:\n type: array\n items:\n type: object\n description: If there are any hooks created for this integration\n | dataset_sample\yaml\chatwoot_chatwoot\swagger\definitions\resource\integrations\app.yml | app.yml | YAML | 685 | 0.7 | 0.12 | 0 | python-kit | 435 | 2024-09-30T02:54:16.423447 | Apache-2.0 | false | da78ba4c8ce9018e0b6869bb7da75446 |
type: object\nproperties:\n id:\n type: string\n description: The ID of the integration hook\n app_id:\n type: string\n description: The ID of the integration app\n inbox_id:\n type: string\n description: Inbox ID if its an Inbox integration\n account_id:\n type: string\n description: Account ID of the integration\n status:\n type: boolean\n description: Whether the integration hook is enabled for the account\n hook_type:\n type: boolean\n description: Whether its an account or inbox integration hook\n settings:\n type: object\n description: The associated settings for the integration | dataset_sample\yaml\chatwoot_chatwoot\swagger\definitions\resource\integrations\hook.yml | hook.yml | YAML | 618 | 0.7 | 0.136364 | 0 | python-kit | 342 | 2025-01-06T17:21:44.470013 | Apache-2.0 | false | 25d173905543b0d5b065d53e27035e15 |
type: object\nproperties: \n id:\n type: integer\n description: Id of the contact\n source_id:\n type: string\n description: The session identifier of the contact\n name:\n type: string\n description: Name of the contact\n email:\n type: string\n description: Email of the contact\n pubsub_token:\n type: string\n description: The token to be used to connect to chatwoot websocket | dataset_sample\yaml\chatwoot_chatwoot\swagger\definitions\resource\public\contact.yml | contact.yml | YAML | 399 | 0.7 | 0 | 0 | python-kit | 384 | 2024-07-27T14:54:54.254216 | Apache-2.0 | false | 384d0f2baead7cbc539e6497dcea15bc |
type: object\nproperties:\n id:\n type: integer\n description: Id of the conversation\n inbox_id:\n type: string\n description: The inbox id of the conversation\n messages:\n type: array\n items:\n $ref: '#/definitions/message'\n description: Messages in the conversation\n contact:\n type: object\n description: The contact information associated to the conversation\n | dataset_sample\yaml\chatwoot_chatwoot\swagger\definitions\resource\public\conversation.yml | conversation.yml | YAML | 389 | 0.8 | 0 | 0 | awesome-app | 571 | 2024-04-04T03:14:42.423390 | BSD-3-Clause | false | 67e0129cab164d8f36a3f7b17aa333b5 |
type: object\nproperties:\n identifier:\n type: string\n description: Inbox identifier\n name:\n type: string\n description: Name of the inbox\n timezone:\n type: string\n description: The timezone defined on the inbox\n working_hours:\n type: array\n description: The working hours defined on the inbox\n items:\n type: object\n properties:\n day_of_week:\n type: integer\n description: Day of the week as a number. Sunday -> 0, Saturday -> 6\n open_all_day:\n type: boolean\n description: Whether or not the business is open the whole day\n closed_all_day:\n type: boolean\n description: Whether or not the business is closed the whole day\n open_hour:\n type: integer\n description: Opening hour. Can be null if closed all day\n open_minutes:\n type: integer\n description: Opening minute. Can be null if closed all day\n close_hour:\n type: integer\n description: Closing hour. Can be null if closed all day\n close_minutes:\n type: integer\n description: Closing minute. Can be null if closed all day\n working_hours_enabled:\n type: boolean\n description: Whether of not the working hours are enabled on the inbox\n csat_survey_enabled:\n type: boolean\n description: Whether of not the Customer Satisfaction survey is enabled on the inbox\n greeting_enabled:\n type: boolean\n description: Whether of not the Greeting Message is enabled on the inbox\n identity_validation_enabled:\n type: boolean\n description: Whether of not the User Identity Validation is enforced on the inbox\n | dataset_sample\yaml\chatwoot_chatwoot\swagger\definitions\resource\public\inbox.yml | inbox.yml | YAML | 1,683 | 0.7 | 0.08 | 0 | python-kit | 926 | 2024-10-23T18:44:57.356582 | MIT | false | b64bb3deea0b92df15af6440aa578e45 |
type: object\nproperties:\n id:\n type: string\n description: Id of the message\n content:\n type: string\n description: Text content of the message\n message_type:\n type: string\n description: Denotes the message type\n content_type:\n type: string\n description: Content type of the message\n content_attributes:\n type: string\n description: Additional content attributes of the message\n created_at:\n type: string\n description: Created at time stamp of the message\n conversation_id:\n type: string\n description: Conversation Id of the message\n attachments:\n type: array\n items:\n type: object\n description: Attachments if any\n sender:\n type: object\n description: Details of the sender\n\n\n\n\n\n\n\n | dataset_sample\yaml\chatwoot_chatwoot\swagger\definitions\resource\public\message.yml | message.yml | YAML | 749 | 0.7 | 0.026316 | 0 | awesome-app | 355 | 2024-11-06T03:00:03.848583 | BSD-3-Clause | false | 65e95e3efda18ed315f47e2e28b18d0a |
type: object\nproperties:\n avg_first_response_time:\n type: string\n avg_resolution_time:\n type: string\n conversations_count:\n type: number\n incoming_messages_count:\n type: number\n outgoing_messages_count:\n type: number\n resolutions_count:\n type: number\n previous:\n type: object\n properties:\n avg_first_response_time:\n type: string\n avg_resolution_time:\n type: string\n conversations_count:\n type: number\n incoming_messages_count:\n type: number\n outgoing_messages_count:\n type: number\n resolutions_count:\n type: number | dataset_sample\yaml\chatwoot_chatwoot\swagger\definitions\resource\reports\summary.yml | summary.yml | YAML | 617 | 0.7 | 0 | 0 | awesome-app | 322 | 2024-06-06T05:19:52.109564 | MIT | false | e238c305854283401a101453cd5230a6 |
type: object\nproperties:\n id:\n type: number\n name:\n type: string\n email:\n type: string\n thumbnail:\n type: string\n availability:\n type: string\n metric:\n type: object\n properties:\n open:\n type: number\n unattended:\n type: number | dataset_sample\yaml\chatwoot_chatwoot\swagger\definitions\resource\reports\conversation\agent.yml | agent.yml | YAML | 276 | 0.7 | 0 | 0 | node-utils | 548 | 2024-05-03T06:34:33.255764 | GPL-3.0 | false | cef08b3d05663bc755e20eaaec8fbc4e |
in: path\nname: account_id\ntype: integer\nrequired: true\ndescription: The numeric ID of the account\n | dataset_sample\yaml\chatwoot_chatwoot\swagger\parameters\account_id.yml | account_id.yml | YAML | 98 | 0.65 | 0 | 0 | python-kit | 910 | 2023-10-07T03:45:33.528173 | Apache-2.0 | false | 575065d75bcfad22e2e4eb2c9d1a492b |
in: path\nname: id\ntype: integer\nrequired: true\ndescription: The ID of the agentbot to be updated\n | dataset_sample\yaml\chatwoot_chatwoot\swagger\parameters\agent_bot_id.yml | agent_bot_id.yml | YAML | 97 | 0.65 | 0 | 0 | react-lib | 349 | 2024-09-26T04:52:20.246490 | Apache-2.0 | false | 2c155d30fe970aa518bed0f6fbb289dc |
in: query\nname: sort\ntype: string\nenum:\n - name\n - email\n - phone_number\n - last_activity_at\n - -name\n - -email\n - -phone_number\n - -last_activity_at\nrequired: false\ndescription: The attribute by which list should be sorted\n | dataset_sample\yaml\chatwoot_chatwoot\swagger\parameters\contact_sort.yml | contact_sort.yml | YAML | 232 | 0.85 | 0 | 0 | awesome-app | 119 | 2024-11-14T23:14:29.730569 | BSD-3-Clause | false | b8dcae219328a16f9180d0824eddfdb1 |
in: path\nname: conversation_id\ntype: integer\nrequired: true\ndescription: The numeric ID of the conversation\n | dataset_sample\yaml\chatwoot_chatwoot\swagger\parameters\conversation_id.yml | conversation_id.yml | YAML | 108 | 0.85 | 0 | 0 | react-lib | 1,000 | 2024-04-23T15:41:41.849253 | MIT | false | 622c90c98ab934364eebea2d51aa4448 |
in: path\nname: conversation_uuid\ntype: integer\nrequired: true\ndescription: The uuid of the conversation\n | dataset_sample\yaml\chatwoot_chatwoot\swagger\parameters\conversation_uuid.yml | conversation_uuid.yml | YAML | 104 | 0.85 | 0 | 0 | python-kit | 967 | 2023-11-04T07:28:24.323202 | Apache-2.0 | false | 095c9a9d1702bf6c251f8c15ffbbd453 |
in: path\nname: custom_filter_id\ntype: integer\nrequired: true\ndescription: The numeric ID of the custom filter\n | dataset_sample\yaml\chatwoot_chatwoot\swagger\parameters\custom_filter_id.yml | custom_filter_id.yml | YAML | 110 | 0.85 | 0 | 0 | vue-tools | 643 | 2025-07-03T08:56:18.852669 | GPL-3.0 | false | cb57ab32b8fd821131f15ee3ede7528c |
in: path\nname: hook_id\ntype: integer\nrequired: true\ndescription: The numeric ID of the integration hook\n | dataset_sample\yaml\chatwoot_chatwoot\swagger\parameters\hook_id.yml | hook_id.yml | YAML | 104 | 0.85 | 0 | 0 | node-utils | 627 | 2025-06-06T08:02:34.937755 | GPL-3.0 | false | 6a6ba2bc81033a123b0000a1c4650209 |
account_id:\n $ref: ./account_id.yml\n\nagent_bot_id:\n $ref: ./agent_bot_id.yml\n\nteam_id:\n $ref: ./team_id.yml\n\ninbox_id:\n $ref: ./inbox_id.yml\n\nhook_id:\n $ref: ./hook_id.yml\n\nsource_id:\n $ref: ./source_id.yml\n\ncontact_sort_param:\n $ref: ./contact_sort.yml\n\nconversation_id:\n $ref: ./conversation_id.yml\n\nconversation_uuid:\n $ref: ./conversation_uuid.yml\n\ncustom_filter_id:\n $ref: ./custom_filter_id.yml\n\nwebhook_id:\n $ref: ./webhook_id.yml\n\nmessage_id:\n $ref: ./message_id.yml\n\npage:\n $ref: ./page.yml\n\nplatform_user_id:\n $ref: ./platform_user_id.yml\n\nreport_type:\n $ref: ./report_type.yml\n\nreport_metric:\n $ref: ./report_metric.yml\n\npublic_inbox_identifier:\n $ref: ./public/inbox_identifier.yml\n\npublic_contact_identifier:\n $ref: ./public/contact_identifier.yml\n\nportal_id:\n $ref: ./portal_id.yml | dataset_sample\yaml\chatwoot_chatwoot\swagger\parameters\index.yml | index.yml | YAML | 814 | 0.7 | 0 | 0 | python-kit | 854 | 2024-12-11T11:05:48.349441 | BSD-3-Clause | false | 4136e71afe1fe0e1eb05083e37e117c8 |
in: path\nname: message_id\ntype: integer\nrequired: true\ndescription: The numeric ID of the message\n | dataset_sample\yaml\chatwoot_chatwoot\swagger\parameters\message_id.yml | message_id.yml | YAML | 98 | 0.65 | 0 | 0 | python-kit | 644 | 2023-08-10T23:28:13.615260 | MIT | false | d3498910b3342aa992b228640ac04599 |
in: query\nname: page\ntype: integer\ndefault: 1\nrequired: false\ndescription: The page parameter\n | dataset_sample\yaml\chatwoot_chatwoot\swagger\parameters\page.yml | page.yml | YAML | 94 | 0.65 | 0 | 0 | python-kit | 349 | 2025-05-12T11:58:50.124983 | MIT | false | c4a62f802ccb0160e8e24d3d512717ff |
in: path\nname: id\ntype: integer\nrequired: true\ndescription: The numeric ID of the user on the platform\n | dataset_sample\yaml\chatwoot_chatwoot\swagger\parameters\platform_user_id.yml | platform_user_id.yml | YAML | 103 | 0.85 | 0 | 0 | node-utils | 627 | 2024-12-18T09:41:41.734010 | GPL-3.0 | false | c0b864e984a0aa2138936bcb6dc70fe4 |
in: path\nname: portal_id\ntype: integer\nrequired: true\ndescription: The numeric ID of the portal\n | dataset_sample\yaml\chatwoot_chatwoot\swagger\parameters\portal_id.yml | portal_id.yml | YAML | 96 | 0.65 | 0 | 0 | awesome-app | 552 | 2025-06-24T05:05:23.479871 | GPL-3.0 | false | f76e7554485c74fe7da0ba082c0d1dc9 |
in: query\nname: metric\ntype: string\nenum:\n - conversations_count\n - incoming_messages_count\n - outgoing_messages_count\n - avg_first_response_time\n - avg_resolution_time\n - resolutions_count\nrequired: true\ndescription: The type of metric\n | dataset_sample\yaml\chatwoot_chatwoot\swagger\parameters\report_metric.yml | report_metric.yml | YAML | 243 | 0.85 | 0 | 0 | node-utils | 830 | 2023-08-22T21:37:12.540536 | MIT | false | f69adea9314031edaf67020fc19e0ff6 |
in: query\nname: type\ntype: string\nenum:\n - account\n - agent\n - inbox\n - label\n - team\nrequired: true\ndescription: Type of report\n | dataset_sample\yaml\chatwoot_chatwoot\swagger\parameters\report_type.yml | report_type.yml | YAML | 134 | 0.85 | 0 | 0 | vue-tools | 697 | 2024-06-28T16:58:17.295465 | MIT | false | 9f73d39584c3e7f26cfcae163a22135f |
in: path\nname: source_id\nrequired: true\ntype: string\ndescription: "Id of the session for which the conversation is created.\n\n\n\n Source Ids can be obtained through contactable inboxes API or via generated.<br/><br/>Website: Chatwoot generated string which can be obtained from webhook events. <br/> Phone Channels(Twilio): Phone number in e164 format <br/> Email Channels: Contact Email address <br/> API Channel: Any Random String"\n | dataset_sample\yaml\chatwoot_chatwoot\swagger\parameters\source_id.yml | source_id.yml | YAML | 436 | 0.85 | 0.2 | 0 | vue-tools | 228 | 2024-02-11T22:54:31.665960 | GPL-3.0 | false | ff0a6ad71065b81b01820eb3898ff33f |
in: path\nname: team_id\ntype: integer\nrequired: true\ndescription: The ID of the team to be updated\n | dataset_sample\yaml\chatwoot_chatwoot\swagger\parameters\team_id.yml | team_id.yml | YAML | 98 | 0.65 | 0 | 0 | vue-tools | 118 | 2023-08-03T16:43:47.257859 | MIT | false | 1bef46c6ef91b2fe0e7135f58492149e |
in: path\nname: webhook_id\ntype: integer\nrequired: true\ndescription: The numeric ID of the webhook\n | dataset_sample\yaml\chatwoot_chatwoot\swagger\parameters\webhook_id.yml | webhook_id.yml | YAML | 98 | 0.65 | 0 | 0 | react-lib | 747 | 2024-05-16T09:23:42.503788 | GPL-3.0 | false | 19a60a5f3ff4de33dc49f0508dc9a9a3 |
in: path\nname: contact_identifier\ntype: string\nrequired: true\ndescription: The source id of contact obtained on contact create\n | dataset_sample\yaml\chatwoot_chatwoot\swagger\parameters\public\contact_identifier.yml | contact_identifier.yml | YAML | 127 | 0.85 | 0 | 0 | python-kit | 918 | 2024-10-23T04:47:16.857659 | Apache-2.0 | false | b6d4f438ad10738a917be92fe014feef |
in: path\nname: inbox_identifier\ntype: string\nrequired: true\ndescription: The identifier obtained from API inbox channel\n | dataset_sample\yaml\chatwoot_chatwoot\swagger\parameters\public\inbox_identifier.yml | inbox_identifier.yml | YAML | 120 | 0.85 | 0 | 0 | python-kit | 927 | 2024-02-28T12:57:00.390257 | BSD-3-Clause | false | 12df85b5254868ae1e9bc8492f37c6dd |
# ------------ Platform API routes ------------#\n\n# Accounts\n\n/platform/api/v1/accounts:\n post:\n $ref: ./platform/accounts/create.yml\n/platform/api/v1/accounts/{account_id}:\n parameters:\n - $ref: '#/parameters/account_id'\n get:\n $ref: './platform/accounts/show.yml'\n patch:\n $ref: ./platform/accounts/update.yml\n delete:\n $ref: ./platform/accounts/delete.yml\n\n\n# Account Users\n\n/platform/api/v1/accounts/{account_id}/account_users:\n parameters:\n - $ref: '#/parameters/account_id'\n get:\n $ref: './platform/account_users/index.yml'\n post:\n $ref: ./platform/account_users/create.yml\n delete:\n $ref: ./platform/account_users/delete.yml\n\n# AgentBots\n\n/platform/api/v1/agent_bots:\n get:\n $ref: ./platform/agent_bots/index.yml\n post:\n $ref: ./platform/agent_bots/create.yml\n/platform/api/v1/agent_bots/{id}:\n parameters:\n - $ref: '#/parameters/agent_bot_id'\n get:\n $ref: './platform/agent_bots/show.yml'\n patch:\n $ref: ./platform/agent_bots/update.yml\n delete:\n $ref: ./platform/agent_bots/delete.yml\n\n# Users\n\n/platform/api/v1/users:\n post:\n $ref: ./platform/users/create.yml\n/platform/api/v1/users/{id}:\n parameters:\n - $ref: '#/parameters/platform_user_id'\n get:\n $ref: './platform/users/show.yml'\n patch:\n $ref: ./platform/users/update.yml\n delete:\n $ref: ./platform/users/delete.yml\n/platform/api/v1/users/{id}/login:\n parameters:\n - $ref: '#/parameters/platform_user_id'\n get:\n $ref: './platform/users/login.yml'\n\n\n# ---------------- end of platform path -----------#\n\n# ------------ Public API routes ------------#\n\n# Inbox\n\n/public/api/v1/inboxes/{inbox_identifier}:\n parameters:\n - $ref: '#/parameters/public_inbox_identifier'\n get:\n $ref: './public/inboxes/show.yml'\n\n# Contacts\n\n/public/api/v1/inboxes/{inbox_identifier}/contacts:\n parameters:\n - $ref: '#/parameters/public_inbox_identifier'\n post:\n $ref: ./public/inboxes/contacts/create.yml\n/public/api/v1/inboxes/{inbox_identifier}/contacts/{contact_identifier}:\n parameters:\n - $ref: '#/parameters/public_inbox_identifier'\n - $ref: '#/parameters/public_contact_identifier'\n get:\n $ref: './public/inboxes/contacts/show.yml'\n patch:\n $ref: ./public/inboxes/contacts/update.yml\n\n/public/api/v1/inboxes/{inbox_identifier}/contacts/{contact_identifier}/conversations:\n parameters:\n - $ref: '#/parameters/public_inbox_identifier'\n - $ref: '#/parameters/public_contact_identifier'\n post:\n $ref: ./public/inboxes/conversations/create.yml\n get:\n $ref: ./public/inboxes/conversations/index.yml\n\n/public/api/v1/inboxes/{inbox_identifier}/contacts/{contact_identifier}/conversations/{conversation_id}:\n parameters:\n - $ref: '#/parameters/public_inbox_identifier'\n - $ref: '#/parameters/public_contact_identifier'\n - $ref: '#/parameters/conversation_id'\n get:\n $ref: ./public/inboxes/conversations/show.yml\n\n/public/api/v1/inboxes/{inbox_identifier}/contacts/{contact_identifier}/conversations/{conversation_id}/toggle_status:\n parameters:\n - $ref: '#/parameters/public_inbox_identifier'\n - $ref: '#/parameters/public_contact_identifier'\n - $ref: '#/parameters/conversation_id'\n post:\n $ref: ./public/inboxes/conversations/toggle_status.yml\n\n/public/api/v1/inboxes/{inbox_identifier}/contacts/{contact_identifier}/conversations/{conversation_id}/toggle_typing:\n parameters:\n - $ref: '#/parameters/public_inbox_identifier'\n - $ref: '#/parameters/public_contact_identifier'\n - $ref: '#/parameters/conversation_id'\n post:\n $ref: ./public/inboxes/conversations/toggle_typing.yml\n\n/public/api/v1/inboxes/{inbox_identifier}/contacts/{contact_identifier}/conversations/{conversation_id}/update_last_seen:\n parameters:\n - $ref: '#/parameters/public_inbox_identifier'\n - $ref: '#/parameters/public_contact_identifier'\n - $ref: '#/parameters/conversation_id'\n post:\n $ref: ./public/inboxes/conversations/update_last_seen.yml\n\n/public/api/v1/inboxes/{inbox_identifier}/contacts/{contact_identifier}/conversations/{conversation_id}/messages:\n parameters:\n - $ref: '#/parameters/public_inbox_identifier'\n - $ref: '#/parameters/public_contact_identifier'\n - $ref: '#/parameters/conversation_id'\n post:\n $ref: ./public/inboxes/messages/create.yml\n get:\n $ref: ./public/inboxes/messages/index.yml\n/public/api/v1/inboxes/{inbox_identifier}/contacts/{contact_identifier}/conversations/{conversation_id}/messages/{message_id}:\n parameters:\n - $ref: '#/parameters/public_inbox_identifier'\n - $ref: '#/parameters/public_contact_identifier'\n - $ref: '#/parameters/conversation_id'\n - $ref: '#/parameters/message_id'\n patch:\n $ref: ./public/inboxes/messages/update.yml\n/api/v1/accounts/{account_id}/contacts/{contact_identifier}/labels:\n parameters:\n - $ref: '#/parameters/account_id'\n - $ref: '#/parameters/public_contact_identifier'\n get:\n $ref: ./application/contacts/labels/index.yml\n post:\n $ref: ./application/contacts/labels/create.yml\n\n# ---------------- end of public api routes-----------#\n\n# ------------ Other routes ------------#\n\n/survey/responses/{conversation_uuid}:\n parameters:\n - $ref: '#/parameters/conversation_uuid'\n get:\n $ref: ./survey/show.yml\n\n# ----------- end of other routes -----------#\n\n# ------------ Application API routes ------------#\n\n\n# AgentBots\n/api/v1/accounts/{account_id}/agent_bots:\n parameters:\n - $ref: '#/parameters/account_id'\n get:\n $ref: ./application/agent_bots/index.yml\n post:\n $ref: ./application/agent_bots/create.yml\n/api/v1/accounts/{account_id}/agent_bots/{id}:\n parameters:\n - $ref: '#/parameters/account_id'\n - $ref: '#/parameters/agent_bot_id'\n get:\n $ref: './application/agent_bots/show.yml'\n patch:\n $ref: ./application/agent_bots/update.yml\n delete:\n $ref: ./application/agent_bots/delete.yml\n\n# Agents\n/api/v1/accounts/{account_id}/agents:\n parameters:\n - $ref: '#/parameters/account_id'\n get:\n $ref: ./application/agents/index.yml\n post:\n $ref: ./application/agents/create.yml\n/api/v1/accounts/{account_id}/agents/{id}:\n parameters:\n - $ref: '#/parameters/account_id'\n patch:\n $ref: ./application/agents/update.yml\n delete:\n $ref: ./application/agents/delete.yml\n\n# Canned Responses\n/api/v1/accounts/{account_id}/canned_responses:\n parameters:\n - $ref: '#/parameters/account_id'\n get:\n $ref: ./application/canned_responses/index.yml\n post:\n $ref: ./application/canned_responses/create.yml\n/api/v1/accounts/{account_id}/canned_responses/{id}:\n parameters:\n - $ref: '#/parameters/account_id'\n patch:\n $ref: ./application/canned_responses/update.yml\n delete:\n $ref: ./application/canned_responses/delete.yml\n\n# Custom Attributes\n/api/v1/accounts/{account_id}/custom_attribute_definitions:\n parameters:\n - $ref: '#/parameters/account_id'\n get:\n $ref: ./application/custom_attributes/index.yml\n post:\n $ref: ./application/custom_attributes/create.yml\n/api/v1/accounts/{account_id}/custom_attribute_definitions/{id}:\n parameters:\n - $ref: '#/parameters/account_id'\n - name: id\n in: path\n type: number\n description: ID of the custom attribute\n required: true\n get:\n $ref: './application/custom_attributes/show.yml'\n patch:\n $ref: ./application/custom_attributes/update.yml\n delete:\n $ref: ./application/custom_attributes/delete.yml\n\n# Contacts\n/api/v1/accounts/{account_id}/contacts:\n $ref: ./application/contacts/list_create.yml\n/api/v1/accounts/{account_id}/contacts/{id}:\n $ref: ./application/contacts/crud.yml\n/api/v1/accounts/{account_id}/contacts/{id}/conversations:\n $ref: ./application/contacts/conversations.yml\n/api/v1/accounts/{account_id}/contacts/search:\n $ref: ./application/contacts/search.yml\n/api/v1/accounts/{account_id}/contacts/filter:\n parameters:\n - $ref: '#/parameters/account_id'\n post:\n $ref: ./application/contacts/filter.yml\n/api/v1/accounts/{account_id}/contacts/{id}/contact_inboxes:\n $ref: ./application/contact_inboxes/create.yml\n/api/v1/accounts/{account_id}/contacts/{id}/contactable_inboxes:\n $ref: ./application/contactable_inboxes/get.yml\n\n\n# Automation Rule\n/api/v1/accounts/{account_id}/automation_rules:\n parameters:\n - $ref: '#/parameters/account_id'\n get:\n $ref: ./application/automation_rule/index.yml\n post:\n $ref: ./application/automation_rule/create.yml\n/api/v1/accounts/{account_id}/automation_rules/{id}:\n parameters:\n - $ref: '#/parameters/account_id'\n - name: id\n in: path\n type: number\n description: ID of the Automation Rule\n required: true\n get:\n $ref: ./application/automation_rule/show.yml\n patch:\n $ref: ./application/automation_rule/update.yml\n delete:\n $ref: ./application/automation_rule/delete.yml\n\n\n# Help Center\n/api/v1/accounts/{account_id}/portals:\n parameters:\n - $ref: '#/parameters/account_id'\n post:\n $ref: ./application/portal/create.yml\n get:\n $ref: ./application/portal/index.yml\n patch:\n $ref: ./application/portal/update.yml\n\n\n# Help Center category\n/api/v1/accounts/{account_id}/portals/{portal_id}/categories:\n parameters:\n - $ref: '#/parameters/account_id'\n - $ref: '#/parameters/portal_id'\n post:\n $ref: ./application/category/create.yml\n\n# Help Center article\n/api/v1/accounts/{account_id}/portals/{portal_id}/articles:\n parameters:\n - $ref: '#/parameters/account_id'\n - $ref: '#/parameters/portal_id'\n post:\n $ref: ./application/article/create.yml\n\n\n# Conversations\n/api/v1/accounts/{account_id}/conversations/meta:\n $ref: ./application/conversation/meta.yml\n/api/v1/accounts/{account_id}/conversations:\n $ref: ./application/conversation/index.yml\n/api/v1/accounts/{account_id}/conversations/filter:\n parameters:\n - $ref: '#/parameters/account_id'\n post:\n $ref: ./application/conversation/filter.yml\n/api/v1/accounts/{account_id}/conversations/{conversation_id}:\n parameters:\n - $ref: '#/parameters/account_id'\n - $ref: '#/parameters/conversation_id'\n get:\n $ref: ./application/conversation/show.yml\n patch:\n $ref: ./application/conversation/update.yml\n/api/v1/accounts/{account_id}/conversations/{conversation_id}/toggle_status:\n parameters:\n - $ref: '#/parameters/account_id'\n - $ref: '#/parameters/conversation_id'\n post:\n $ref: ./application/conversation/toggle_status.yml\n/api/v1/accounts/{account_id}/conversations/{conversation_id}/toggle_priority:\n parameters:\n - $ref: '#/parameters/account_id'\n - $ref: '#/parameters/conversation_id'\n post:\n $ref: ./application/conversation/toggle_priority.yml\n\n/api/v1/accounts/{account_id}/conversations/{conversation_id}/custom_attributes:\n parameters:\n - $ref: '#/parameters/account_id'\n - $ref: '#/parameters/conversation_id'\n post:\n $ref: ./application/conversation/custom_attributes.yml\n\n# Conversations Assignments\n\n/api/v1/accounts/{account_id}/conversations/{conversation_id}/assignments:\n parameters:\n - $ref: '#/parameters/account_id'\n - $ref: '#/parameters/conversation_id'\n post:\n $ref: ./application/conversation/assignments.yml\n\n# Conversation Labels\n\n/api/v1/accounts/{account_id}/conversations/{conversation_id}/labels:\n parameters:\n - $ref: '#/parameters/account_id'\n - $ref: '#/parameters/conversation_id'\n get:\n $ref: ./application/conversation/labels/index.yml\n post:\n $ref: ./application/conversation/labels/create.yml\n\n\n# Inboxes\n/api/v1/accounts/{account_id}/inboxes:\n $ref: ./application/inboxes/index.yml\n/api/v1/accounts/{account_id}/inboxes/{id}/:\n $ref: ./application/inboxes/show.yml\n/api/v1/accounts/{account_id}/inboxes/:\n $ref: ./application/inboxes/create.yml\n/api/v1/accounts/{account_id}/inboxes/{id}:\n $ref: ./application/inboxes/update.yml\n/api/v1/accounts/{account_id}/inboxes/{id}/agent_bot:\n $ref: ./application/inboxes/get_agent_bot.yml\n/api/v1/accounts/{account_id}/inboxes/{id}/set_agent_bot:\n $ref: ./application/inboxes/set_agent_bot.yml\n\n# Inbox Members\n/api/v1/accounts/{account_id}/inbox_members/{inbox_id}:\n parameters:\n - $ref: '#/parameters/account_id'\n - $ref: '#/parameters/inbox_id'\n get:\n $ref: ./application/inboxes/inbox_members/show.yml\n\n/api/v1/accounts/{account_id}/inbox_members:\n parameters:\n - $ref: '#/parameters/account_id'\n post:\n $ref: ./application/inboxes/inbox_members/create.yml\n patch:\n $ref: ./application/inboxes/inbox_members/update.yml\n delete:\n $ref: ./application/inboxes/inbox_members/delete.yml\n\n\n\n# Messages\n/api/v1/accounts/{account_id}/conversations/{conversation_id}/messages:\n parameters:\n - $ref: '#/parameters/account_id'\n - $ref: '#/parameters/conversation_id'\n get:\n $ref: ./application/conversation/messages/index.yml\n post:\n $ref: ./application/conversation/messages/create.yml\n/api/v1/accounts/{account_id}/conversations/{conversation_id}/messages/{message_id}:\n parameters:\n - $ref: '#/parameters/account_id'\n - $ref: '#/parameters/conversation_id'\n - $ref: '#/parameters/message_id'\n delete:\n $ref: ./application/conversation/messages/delete.yml\n\n\n\n# Integrations\n/api/v1/accounts/{account_id}/integrations/apps:\n parameters:\n - $ref: '#/parameters/account_id'\n get:\n $ref: './application/integrations/apps/show.yml'\n/api/v1/accounts/{account_id}/integrations/hooks:\n post:\n $ref: './application/integrations/hooks/create.yml'\n/api/v1/accounts/{account_id}/integrations/hooks/{hook_id}:\n patch:\n $ref: ./application/integrations/hooks/update.yml\n delete:\n $ref: ./application/integrations/hooks/delete.yml\n\n\n\n# Profile\n/api/v1/profile:\n $ref: ./profile/index.yml\n\n\n# Teams\n/api/v1/accounts/{account_id}/teams:\n parameters:\n - $ref: '#/parameters/account_id'\n get:\n $ref: ./application/teams/index.yml\n post:\n $ref: ./application/teams/create.yml\n/api/v1/accounts/{account_id}/teams/{team_id}:\n parameters:\n - $ref: '#/parameters/account_id'\n - $ref: '#/parameters/team_id'\n get:\n $ref: './application/teams/show.yml'\n patch:\n $ref: ./application/teams/update.yml\n delete:\n $ref: ./application/teams/delete.yml\n/api/v1/accounts/{account_id}/teams/{team_id}/team_members:\n parameters:\n - $ref: '#/parameters/account_id'\n - $ref: '#/parameters/team_id'\n get:\n $ref: ./application/team_members/index.yml\n post:\n $ref: ./application/team_members/create.yml\n patch:\n $ref: ./application/team_members/update.yml\n delete:\n $ref: ./application/team_members/delete.yml\n\n### Custom Filters goes here\n\n# Custom Filters\n/api/v1/accounts/{account_id}/custom_filters:\n parameters:\n - $ref: '#/parameters/account_id'\n - in: query\n name: filter_type\n type: string\n enum: ['conversation', 'contact', 'report']\n required: false\n description: The type of custom filter\n get:\n $ref: ./application/custom_filters/index.yml\n post:\n $ref: ./application/custom_filters/create.yml\n/api/v1/accounts/{account_id}/custom_filters/{custom_filter_id}:\n parameters:\n - $ref: '#/parameters/account_id'\n - $ref: '#/parameters/custom_filter_id'\n get:\n $ref: './application/custom_filters/show.yml'\n patch:\n $ref: ./application/custom_filters/update.yml\n delete:\n $ref: ./application/custom_filters/delete.yml\n\n# webhooks\n/api/v1/accounts/{account_id}/webhooks:\n parameters:\n - $ref: '#/parameters/account_id'\n get:\n $ref: ./application/webhooks/index.yml\n post:\n $ref: ./application/webhooks/create.yml\n/api/v1/accounts/{account_id}/webhooks/{webhook_id}:\n parameters:\n - $ref: '#/parameters/account_id'\n - $ref: '#/parameters/webhook_id'\n patch:\n $ref: ./application/webhooks/update.yml\n delete:\n $ref: ./application/webhooks/delete.yml\n\n### Reports\n\n# List\n/api/v2/accounts/{account_id}/reports:\n parameters:\n - $ref: '#/parameters/account_id'\n - $ref: '#/parameters/report_metric'\n - $ref: '#/parameters/report_type'\n - in: query\n name: id\n type: string\n description: The Id of specific object in case of agent/inbox/label\n - in: query\n name: since\n type: string\n description: The timestamp from where report should start.\n - in: query\n name: until\n type: string\n description: The timestamp from where report should stop.\n get:\n $ref: './application/reports/index.yml'\n\n# Summary\n/api/v2/accounts/{account_id}/reports/summary:\n parameters:\n - $ref: '#/parameters/account_id'\n - $ref: '#/parameters/report_type'\n - in: query\n name: id\n type: string\n description: The Id of specific object in case of agent/inbox/label\n - in: query\n name: since\n type: string\n description: The timestamp from where report should start.\n - in: query\n name: until\n type: string\n description: The timestamp from where report should stop.\n get:\n $ref: './application/reports/summary.yml'\n\n# Conversation metrics for account\n/api/v2/accounts/{account_id}/reports/conversations:\n parameters:\n - $ref: '#/parameters/account_id'\n - in: query\n name: type\n type: string\n enum:\n - account\n required: true\n description: Type of report\n get:\n $ref: './application/reports/conversation/account.yml'\n\n# Conversation metrics for agent\n/api/v2/accounts/{account_id}/reports/conversations/:\n parameters:\n - $ref: '#/parameters/account_id'\n - in: query\n name: type\n type: string\n enum:\n - agent\n required: true\n description: Type of report\n - in: query\n name: user_id\n type: string\n description: The numeric ID of the user\n get:\n $ref: './application/reports/conversation/agent.yml'\n | dataset_sample\yaml\chatwoot_chatwoot\swagger\paths\index.yml | index.yml | YAML | 17,642 | 0.95 | 0.003289 | 0.072491 | python-kit | 537 | 2024-03-29T07:32:20.506984 | GPL-3.0 | false | 9449877d81108eb4c98619986eab5767 |
tags:\n - Agents\noperationId: add-new-agent-to-account\nsummary: Add a New Agent\ndescription: Add a new Agent to Account\nsecurity:\n - userApiKey: []\nparameters:\n - name: data\n in: body\n required: true\n schema:\n type: object\n required:\n - name\n - email\n - role\n properties:\n name:\n type: string\n description: Full Name of the agent\n email:\n type: string\n description: Email of the Agent\n role:\n type: string\n enum: ['agent', 'administrator']\n description: Whether its administrator or agent\n availability_status:\n type: string\n enum: ['available', 'busy', 'offline']\n description: The availability setting of the agent.\n auto_offline:\n type: boolean\n description: Whether the availability status of agent is configured to go offline automatically when away.\nresponses:\n 200:\n description: Success\n schema:\n description: 'Newly Created Agent'\n $ref: '#/definitions/agent'\n 403:\n description: Access denied\n | dataset_sample\yaml\chatwoot_chatwoot\swagger\paths\application\agents\create.yml | create.yml | YAML | 1,118 | 0.95 | 0 | 0 | awesome-app | 931 | 2024-05-05T09:10:22.680584 | BSD-3-Clause | false | 4529edaa54224502bdd1f2749f27a4e9 |
tags:\n - Agents\noperationId: delete-agent-from-account\nsummary: Remove an Agent from Account\ndescription: Remove an Agent from Account\nsecurity:\n - userApiKey: []\nparameters:\n - in: path\n name: id\n type: integer\n required: true\n description: The ID of the agent to be deleted\nresponses:\n 200:\n description: Success\n 404:\n description: Agent not found\n 403:\n description: Access denied\n | dataset_sample\yaml\chatwoot_chatwoot\swagger\paths\application\agents\delete.yml | delete.yml | YAML | 412 | 0.85 | 0 | 0 | awesome-app | 934 | 2023-12-13T15:13:52.683682 | GPL-3.0 | false | f254c05eb46b2b1e4a00b9768ec4b7e2 |
tags:\n - Agents\noperationId: get-account-agents\nsummary: List Agents in Account\ndescription: Get Details of Agents in an Account\nsecurity:\n - userApiKey: []\nresponses:\n 200:\n description: Success\n schema:\n type: array\n description: 'Array of all active agents'\n items:\n $ref: '#/definitions/agent'\n 403:\n description: Access denied\n | dataset_sample\yaml\chatwoot_chatwoot\swagger\paths\application\agents\index.yml | index.yml | YAML | 375 | 0.8 | 0 | 0 | python-kit | 553 | 2024-06-18T05:47:34.509536 | MIT | false | 49330e06044c7a42e1ef9a89a5181e71 |
tags:\n - Agents\noperationId: update-agent-in-account\nsummary: Update Agent in Account\ndescription: Update an Agent in Account\nsecurity:\n - userApiKey: []\nparameters:\n - in: path\n name: id\n type: integer\n required: true\n description: The ID of the agent to be updated.\n - name: data\n in: body\n required: true\n schema:\n type: object\n required:\n - role\n properties:\n role:\n type: string\n enum: ['agent', 'administrator']\n description: Whether its administrator or agent\n availability:\n type: string\n enum: ['available', 'busy', 'offline']\n description: The availability setting of the agent.\n auto_offline:\n type: boolean\n description: Whether the availability status of agent is configured to go offline automatically when away.\nresponses:\n 200:\n description: Success\n schema:\n description: 'The updated agent'\n $ref: '#/definitions/agent'\n 404:\n description: Agent not found\n 403:\n description: Access denied\n | dataset_sample\yaml\chatwoot_chatwoot\swagger\paths\application\agents\update.yml | update.yml | YAML | 1,077 | 0.95 | 0 | 0 | python-kit | 55 | 2024-04-03T04:30:13.437993 | Apache-2.0 | false | c7c96b561e2a471a63234cbfe3616b64 |
tags:\n - Account AgentBots\noperationId: create-an-account-agent-bot\nsummary: Create an Agent Bot\ndescription: Create an agent bot in the account\nparameters:\n - $ref: '#/parameters/account_id'\n - name: data\n in: body\n required: true\n schema:\n $ref: '#/definitions/agent_bot_create_update_payload'\nresponses:\n 200:\n description: Success\n schema:\n $ref: '#/definitions/agent_bot'\n 401:\n description: Unauthorized\n | dataset_sample\yaml\chatwoot_chatwoot\swagger\paths\application\agent_bots\create.yml | create.yml | YAML | 443 | 0.95 | 0 | 0 | vue-tools | 134 | 2024-02-06T21:37:19.866799 | GPL-3.0 | false | 2bb57ae673d4707e914d035a7063d6ac |
tags:\n - Account AgentBots\noperationId: delete-an-account-agent-bot\nsummary: Delete an AgentBot\ndescription: Delete an AgentBot from the account\nresponses:\n 200:\n description: Success\n 401:\n description: Unauthorized\n 404:\n description: The agent bot does not exist in the account\n | dataset_sample\yaml\chatwoot_chatwoot\swagger\paths\application\agent_bots\delete.yml | delete.yml | YAML | 294 | 0.7 | 0 | 0 | react-lib | 373 | 2024-06-13T01:59:37.293215 | BSD-3-Clause | false | 1fa41b128afb5fd384633fb873a8f7f2 |
tags:\n - Account AgentBots\noperationId: list-all-account-agent-bots\nsummary: List all AgentBots\ndescription: List all agent bots available for the current account\nresponses:\n 200:\n description: Success\n schema:\n type: array\n description: 'Array of agent bots'\n items:\n $ref: '#/definitions/agent_bot'\n\n 401:\n description: Unauthorized\n | dataset_sample\yaml\chatwoot_chatwoot\swagger\paths\application\agent_bots\index.yml | index.yml | YAML | 369 | 0.8 | 0.0625 | 0 | awesome-app | 259 | 2023-10-27T20:28:51.619969 | MIT | false | 1ed69b77f120e16b475f2214cf9b2c40 |
tags:\n - Account AgentBots\noperationId: get-details-of-a-single-account-agent-bot\nsummary: Get an agent bot details\ndescription: Get the details of an agent bot in the account\nresponses:\n 200:\n description: Success\n schema:\n $ref: '#/definitions/agent_bot'\n 401:\n description: Unauthorized\n 404:\n description: The given agent bot ID does not exist in the account\n | dataset_sample\yaml\chatwoot_chatwoot\swagger\paths\application\agent_bots\show.yml | show.yml | YAML | 384 | 0.8 | 0 | 0 | react-lib | 179 | 2023-12-23T05:03:26.412510 | BSD-3-Clause | false | 6bd5a79e843e38055c78ca4116bf3ab3 |
tags:\n - Account AgentBots\noperationId: update-an-account-agent-bot\nsummary: Update an agent bot\ndescription: Update an agent bot's attributes\nparameters:\n - name: data\n in: body\n required: true\n schema:\n $ref: '#/definitions/agent_bot_create_update_payload'\nresponses:\n 200:\n description: Success\n schema:\n $ref: '#/definitions/agent_bot'\n 401:\n description: Unauthorized\n | dataset_sample\yaml\chatwoot_chatwoot\swagger\paths\application\agent_bots\update.yml | update.yml | YAML | 405 | 0.95 | 0 | 0 | python-kit | 646 | 2024-12-06T04:08:13.956303 | GPL-3.0 | false | 2b44b86274eacd397f6537a23c53d21f |
tags:\n - Help Center\noperationId: add-new-article-to-account\nsummary: Add a new article\ndescription: Add a new article to portal\nsecurity:\n - userApiKey: []\nparameters:\n - name: data\n in: body\n required: true\n schema:\n $ref: '#/definitions/article_create_update_payload'\nresponses:\n '200':\n description: Success\n schema:\n $ref: '#/definitions/article'\n '403':\n description: Access denied\n | dataset_sample\yaml\chatwoot_chatwoot\swagger\paths\application\article\create.yml | create.yml | YAML | 421 | 0.95 | 0 | 0 | awesome-app | 425 | 2024-11-01T09:31:03.501786 | GPL-3.0 | false | 0ddb377105d370be9271de2b54197068 |
tags:\n - Automation Rule\noperationId: add-new-automation-rule-to-account\nsummary: Add a new automation rule\ndescription: Add a new automation rule to account\nsecurity:\n - userApiKey: []\nparameters:\n - name: data\n in: body\n required: true\n schema:\n $ref: '#/definitions/automation_rule_create_update_payload'\nresponses:\n '200':\n description: Success\n schema:\n $ref: '#/definitions/automation_rule'\n '403':\n description: Access denied\n | dataset_sample\yaml\chatwoot_chatwoot\swagger\paths\application\automation_rule\create.yml | create.yml | YAML | 466 | 0.95 | 0 | 0 | node-utils | 96 | 2023-09-03T19:00:13.144403 | BSD-3-Clause | false | 4ae25679a489dd82bf57bfcb643cd911 |
tags:\n - Automation Rule\noperationId: delete-automation-rule-from-account\nsummary: Remove a automation rule from account\ndescription: Remove a automation rule from account\nsecurity:\n - userApiKey: []\nparameters:\n - in: path\n name: id\n type: integer\n required: true\n description: The ID of the automation rule to be deleted\nresponses:\n '200':\n description: Success\n '403':\n description: Access denied\n '404':\n description: automation rule not found\n | dataset_sample\yaml\chatwoot_chatwoot\swagger\paths\application\automation_rule\delete.yml | delete.yml | YAML | 475 | 0.85 | 0 | 0 | python-kit | 713 | 2025-03-18T06:38:43.802836 | Apache-2.0 | false | 2b0ed8dd24e1a66bf449e2b6c595578e |
tags:\n - Automation Rule\noperationId: get-account-automation-rule\nsummary: List all automation rules in an account\nparameters:\n - $ref: '#/parameters/account_id'\n - $ref: '#/parameters/page'\ndescription: Get details of automation rules in an Account\nsecurity:\n - userApiKey: []\nresponses:\n '200':\n description: Success\n schema:\n type: array\n description: Array of all automation rules\n items:\n $ref: '#/definitions/automation_rule'\n '403':\n description: Access denied\n | dataset_sample\yaml\chatwoot_chatwoot\swagger\paths\application\automation_rule\index.yml | index.yml | YAML | 505 | 0.8 | 0 | 0 | node-utils | 579 | 2024-10-06T13:21:33.717919 | MIT | false | 1670d928e6f1895b74250795f30df6d1 |
tags:\n - Automation Rule\noperationId: get-details-of-a-single-automation-rule\nsummary: Get a automation rule details\ndescription: Get the details of a automation rule in the account\nparameters:\n - in: path\n name: id\n type: integer\n required: true\n description: The ID of the automation rule to be updated.\nresponses:\n '200':\n description: Success\n schema:\n $ref: '#/definitions/automation_rule'\n '401':\n description: Unauthorized\n '404':\n description: The given rule ID does not exist in the account\n | dataset_sample\yaml\chatwoot_chatwoot\swagger\paths\application\automation_rule\show.yml | show.yml | YAML | 534 | 0.95 | 0 | 0 | node-utils | 591 | 2024-10-20T17:30:18.944518 | BSD-3-Clause | false | 5bac59c4bd080ef65bae600316f17a5c |
tags:\n - Automation Rule\noperationId: update-automation-rule-in-account\nsummary: Update automation rule in Account\ndescription: Update a automation rule in account\nsecurity:\n - userApiKey: []\nparameters:\n - in: path\n name: id\n type: integer\n required: true\n description: The ID of the automation rule to be updated.\n - name: data\n in: body\n required: true\n schema:\n $ref: '#/definitions/automation_rule_create_update_payload'\nresponses:\n '200':\n description: Success\n schema:\n $ref: '#/definitions/automation_rule'\n '403':\n description: Access denied\n '404':\n description: Rule not found\n | dataset_sample\yaml\chatwoot_chatwoot\swagger\paths\application\automation_rule\update.yml | update.yml | YAML | 638 | 0.95 | 0 | 0 | vue-tools | 588 | 2023-07-19T13:10:41.843341 | Apache-2.0 | false | 3364ae82fb76c230ba0bbcbb1e26e222 |
tags:\n - Canned Responses\noperationId: add-new-canned-response-to-account\nsummary: Add a New Canned Response\ndescription: Add a new Canned Response to Account\nsecurity:\n - userApiKey: []\nparameters:\n - name: data\n in: body\n required: true\n schema:\n $ref: '#/definitions/canned_response_create_update_payload'\nresponses:\n 200:\n description: Success\n schema:\n description: 'Newly Created Canned Response'\n $ref: '#/definitions/canned_response'\n 403:\n description: Access denied\n | dataset_sample\yaml\chatwoot_chatwoot\swagger\paths\application\canned_responses\create.yml | create.yml | YAML | 518 | 0.95 | 0 | 0 | awesome-app | 411 | 2025-04-22T19:11:48.086891 | MIT | false | 2c51ba480b62d3d8837868c1bdf79f30 |
tags:\n - Canned Responses\noperationId: delete-canned-response-from-account\nsummary: Remove a Canned Response from Account\ndescription: Remove a Canned Response from Account\nsecurity:\n - userApiKey: []\nparameters:\n - in: path\n name: id\n type: integer\n required: true\n description: The ID of the canned response to be deleted\nresponses:\n 200:\n description: Success\n 404:\n description: Canned Response not found\n 403:\n description: Access denied\n | dataset_sample\yaml\chatwoot_chatwoot\swagger\paths\application\canned_responses\delete.yml | delete.yml | YAML | 470 | 0.85 | 0 | 0 | awesome-app | 530 | 2025-06-12T16:15:16.136792 | MIT | false | 5a4cac8d069e51714e70a069b8fa2780 |
tags:\n - Canned Responses\noperationId: get-account-canned-response\nsummary: List all Canned Responses in an Account\ndescription: Get Details of Canned Responses in an Account\nsecurity:\n - userApiKey: []\nresponses:\n 200:\n description: Success\n schema:\n type: array\n description: 'Array of all canned responses'\n items:\n $ref: '#/definitions/canned_response'\n 403:\n description: Access denied\n | dataset_sample\yaml\chatwoot_chatwoot\swagger\paths\application\canned_responses\index.yml | index.yml | YAML | 434 | 0.8 | 0 | 0 | node-utils | 651 | 2023-08-23T06:24:26.387188 | GPL-3.0 | false | 5ba4d4ce658bca8e22b05755c84b4906 |
tags:\n - Canned Response\noperationId: update-canned-response-in-account\nsummary: Update Canned Response in Account\ndescription: Update a Canned Response in Account\nsecurity:\n - userApiKey: []\nparameters:\n - in: path\n name: id\n type: integer\n required: true\n description: The ID of the canned response to be updated.\n - name: data\n in: body\n required: true\n schema:\n $ref: '#/definitions/canned_response_create_update_payload'\nresponses:\n 200:\n description: Success\n schema:\n description: 'The updated canned response'\n $ref: '#/definitions/canned_response'\n 404:\n description: Agent not found\n 403:\n description: Access denied\n | dataset_sample\yaml\chatwoot_chatwoot\swagger\paths\application\canned_responses\update.yml | update.yml | YAML | 686 | 0.95 | 0 | 0 | python-kit | 80 | 2025-05-04T22:24:26.145108 | BSD-3-Clause | false | 78639c7b6bad29cd30ac2dc6f3d25256 |
tags:\n - Help Center\noperationId: add-new-category-to-account\nsummary: Add a new category\ndescription: Add a new category to portal\nsecurity:\n - userApiKey: []\nparameters:\n - name: data\n in: body\n required: true\n schema:\n $ref: '#/definitions/category_create_update_payload'\nresponses:\n '200':\n description: Success\n schema:\n $ref: '#/definitions/category'\n '403':\n description: Access denied\n | dataset_sample\yaml\chatwoot_chatwoot\swagger\paths\application\category\create.yml | create.yml | YAML | 426 | 0.95 | 0 | 0 | node-utils | 797 | 2024-08-18T12:28:59.050003 | BSD-3-Clause | false | 163a802eceb6047d54e3742da862ea73 |
get:\n tags:\n - Contact\n operationId: contactableInboxesGet\n description: Get List of contactable Inboxes\n summary: Get Contactable Inboxes\n parameters:\n - $ref: '#/parameters/account_id'\n - name: id\n in: path\n type: number\n description: ID of the contact\n required: true\n responses:\n 200:\n description: Success\n schema:\n $ref: '#/definitions/contactable_inboxes'\n 401:\n description: Authentication error\n schema:\n $ref: '#/definitions/bad_request_error'\n 422:\n description: Incorrect payload\n | dataset_sample\yaml\chatwoot_chatwoot\swagger\paths\application\contactable_inboxes\get.yml | get.yml | YAML | 575 | 0.95 | 0 | 0 | awesome-app | 969 | 2024-12-04T02:44:33.845838 | MIT | false | 9136ade2a5218933ee70b731879cdd07 |
get:\n tags:\n - Contacts\n operationId: contactConversations\n summary: Contact Conversations\n description: Get conversations associated to that contact\n parameters:\n - $ref: '#/parameters/account_id'\n - name: id\n in: path\n type: number\n description: ID of the contact\n required: true\n responses:\n 200:\n description: Success\n schema:\n $ref: '#/definitions/contact_conversations'\n 404:\n description: Contact not found\n 403:\n description: Access denied\n | dataset_sample\yaml\chatwoot_chatwoot\swagger\paths\application\contacts\conversations.yml | conversations.yml | YAML | 519 | 0.95 | 0 | 0 | awesome-app | 809 | 2024-03-28T01:30:54.120082 | GPL-3.0 | false | 4661b5743a20e739d37697504433b9ac |
parameters:\n - $ref: '#/parameters/account_id'\n - name: id\n in: path\n type: number\n description: ID of the contact\n required: true\n\nget:\n tags:\n - Contacts\n operationId: contactDetails\n summary: Show Contact\n description: Get a contact belonging to the account using ID\n responses:\n 200:\n description: Success\n schema:\n $ref: '#/definitions/extended_contact'\n 404:\n description: Contact not found\n 403:\n description: Access denied\n\nput:\n tags:\n - Contacts\n operationId: contactUpdate\n summary: Update Contact\n description: Update a contact belonging to the account using ID\n parameters:\n - name: data\n in: body\n required: true\n schema:\n $ref: '#/definitions/contact_update'\n responses:\n 204:\n description: Success\n schema:\n $ref: '#/definitions/contact_base'\n 404:\n description: Contact not found\n 403:\n description: Access denied\n\ndelete:\n tags:\n - Contacts\n operationId: contactDelete\n summary: Delete Contact\n responses:\n 200:\n description: Success\n 401:\n description: Unauthorized\n 404:\n description: Contact not found\n | dataset_sample\yaml\chatwoot_chatwoot\swagger\paths\application\contacts\crud.yml | crud.yml | YAML | 1,182 | 0.95 | 0 | 0 | awesome-app | 724 | 2025-02-15T23:50:01.474859 | BSD-3-Clause | false | b7d94035c16bdf9d302c8c8e4096a8c4 |
tags:\n - Contacts\noperationId: contactFilter\ndescription: Filter contacts with custom filter options and pagination\nsummary: Contact Filter\nsecurity:\n - userApiKey: []\n - agentBotApiKey: []\nparameters:\n - name: page\n in: query\n type: integer\n - name: body\n in: body\n required: true\n schema:\n type: object\n properties:\n payload:\n type: array\n items:\n type: object\n properties:\n attribute_key:\n type: string\n description: filter attribute name\n filter_operator:\n type: string\n description: filter operator name\n enum: [ equal_to, not_equal_to, contains, does_not_contain ]\n values:\n type: array\n items:\n type: string\n description: array of the attribute values to filter\n query_operator:\n type: string\n description: query operator name\n enum: [ AND, OR ]\n example:\n - attribute_key: 'name'\n filter_operator: 'equal_to'\n values: ['en']\n query_operator: 'AND'\n - attribute_key: 'country_code'\n filter_operator: 'equal_to'\n values: ['us']\n query_operator: null\n\nresponses:\n 200:\n description: Success\n schema:\n $ref: '#/definitions/contact_list'\n 400:\n description: Bad Request Error\n schema:\n $ref: '#/definitions/bad_request_error'\n | dataset_sample\yaml\chatwoot_chatwoot\swagger\paths\application\contacts\filter.yml | filter.yml | YAML | 1,573 | 0.95 | 0 | 0 | awesome-app | 625 | 2024-12-02T05:52:40.899999 | Apache-2.0 | false | bcf6a3e74749a5397d2701da603156a7 |
get:\n tags:\n - Contacts\n operationId: contactList\n description: Listing all the resolved contacts with pagination (Page size = 15) . Resolved contacts are the ones with a value for identifier, email or phone number\n summary: List Contacts\n parameters:\n - $ref: '#/parameters/account_id'\n - $ref: '#/parameters/contact_sort_param'\n - $ref: '#/parameters/page'\n responses:\n 200:\n description: Success\n schema:\n $ref: '#/definitions/contact_list'\n 400:\n description: Bad Request Error\n schema:\n $ref: '#/definitions/bad_request_error'\n\npost:\n tags:\n - Contacts\n operationId: contactCreate\n description: Create a new Contact\n summary: Create Contact\n parameters:\n - $ref: '#/parameters/account_id'\n - name: data\n in: body\n required: true\n schema:\n $ref: '#/definitions/contact_create'\n responses:\n 200:\n description: Success\n schema:\n $ref: '#/definitions/extended_contact'\n 400:\n description: Bad Request Error\n schema:\n $ref: '#/definitions/bad_request_error'\n | dataset_sample\yaml\chatwoot_chatwoot\swagger\paths\application\contacts\list_create.yml | list_create.yml | YAML | 1,093 | 0.95 | 0.02381 | 0 | python-kit | 710 | 2025-03-31T05:34:35.999612 | GPL-3.0 | false | 900a43a84767d644f975310a296c1019 |
get:\n tags:\n - Contacts\n operationId: contactSearch\n description: Search the resolved contacts using a search key, currently supports email search (Page size = 15). Resolved contacts are the ones with a value for identifier, email or phone number\n summary: Search Contacts\n parameters:\n - $ref: '#/parameters/account_id'\n - name: q\n in: query\n type: string\n description: Search using contact `name`, `identifier`, `email` or `phone number`\n - $ref: '#/parameters/contact_sort_param'\n - $ref: '#/parameters/page'\n responses:\n 200:\n description: Success\n schema:\n type: object\n properties:\n payload:\n $ref: '#/definitions/contact_list'\n 401:\n description: Authentication error\n schema:\n $ref: '#/definitions/bad_request_error'\n | dataset_sample\yaml\chatwoot_chatwoot\swagger\paths\application\contacts\search.yml | search.yml | YAML | 828 | 0.8 | 0.038462 | 0 | vue-tools | 670 | 2024-09-11T05:23:32.736932 | Apache-2.0 | false | 94d5e61bfb40829d6c7aac35627f25d5 |
tags:\n - Contact Labels\noperationId: contact-add-labels\nsummary: Add Labels\ndescription: Add labels to a contact. Note that this API would overwrite the existing list of labels associated to the conversation.\nparameters:\n - name: data\n in: body\n required: true\n schema:\n type: object\n properties:\n labels:\n type: array\n description: Array of labels (comma-separated strings)\n items:\n type: string\nresponses:\n 200:\n description: Success\n schema:\n $ref: '#/definitions/contact_labels'\n 404:\n description: Contact not found\n 401:\n description: Unauthorized\n | dataset_sample\yaml\chatwoot_chatwoot\swagger\paths\application\contacts\labels\create.yml | create.yml | YAML | 640 | 0.95 | 0 | 0 | awesome-app | 714 | 2024-09-22T20:06:30.422826 | GPL-3.0 | false | c8fa65133bd6a70596dc5d05908b69e2 |
tags:\n - Contact Labels\noperationId: list-all-labels-of-a-contact\nsummary: List Labels\ndescription: Lists all the labels of a contact\nresponses:\n 200:\n description: Success\n schema:\n $ref: '#/definitions/contact_labels'\n 404:\n description: Contact not found\n 401:\n description: Unauthorized\n | dataset_sample\yaml\chatwoot_chatwoot\swagger\paths\application\contacts\labels\index.yml | index.yml | YAML | 312 | 0.8 | 0 | 0 | python-kit | 797 | 2025-06-18T02:10:19.012246 | GPL-3.0 | false | 90da0cb54658ce42ae4fa1d3e2c44167 |
post:\n tags:\n - Contact\n operationId: contactInboxCreation\n description: Create a contact inbox record for an inbox\n summary: Create contact inbox\n parameters:\n - $ref: '#/parameters/account_id'\n - name: id\n in: path\n type: number\n description: ID of the contact\n required: true\n - name: data\n in: body\n required: true\n schema:\n type: object\n required:\n - inbox_id\n properties:\n inbox_id:\n type: number\n description: The ID of the inbox\n source_id:\n type: string\n description: Contact Inbox Source Id\n responses:\n 200:\n description: Success\n schema:\n $ref: '#/definitions/contact_inboxes'\n 401:\n description: Authentication error\n schema:\n $ref: '#/definitions/bad_request_error'\n 422:\n description: Incorrect payload\n | dataset_sample\yaml\chatwoot_chatwoot\swagger\paths\application\contact_inboxes\create.yml | create.yml | YAML | 911 | 0.95 | 0.026316 | 0 | vue-tools | 723 | 2024-02-23T18:54:31.775450 | Apache-2.0 | false | 9e60bae139769088f67cb96bea00d978 |
tags:\n - Conversation Assignment\noperationId: assign-a-conversation\nsummary: Assign Conversation\ndescription: Assign a conversation to an agent or a team\nsecurity:\n - userApiKey: []\n - agentBotApiKey: []\nparameters:\n - name: data\n in: body\n required: true\n schema:\n type: object\n properties:\n assignee_id:\n type: number\n description: Id of the assignee user\n team_id:\n type: number\n description: Id of the team. If the assignee_id is present, this param would be ignored\nresponses:\n 200:\n description: Success\n schema:\n $ref: '#/definitions/user'\n 404:\n description: Conversation not found\n 401:\n description: Unauthorized\n | dataset_sample\yaml\chatwoot_chatwoot\swagger\paths\application\conversation\assignments.yml | assignments.yml | YAML | 716 | 0.95 | 0 | 0 | node-utils | 964 | 2025-04-23T13:30:37.241519 | GPL-3.0 | false | badf44211cfcab3d7ae23397f3984521 |
tags:\n - Conversations\noperationId: update-custom-attributes-of-a-conversation\nsummary: Update Custom Attributes\ndescription: Updates the custom attributes of a conversation\nsecurity:\n - userApiKey: []\n - agentBotApiKey: []\nparameters:\n - name: data\n in: body\n required: true\n schema:\n type: object\n required:\n - custom_attributes\n properties:\n custom_attributes:\n type: object\n description: The custom attributes to be set for the conversation\n example:\n order_id: "12345"\n previous_conversation: "67890"\nresponses:\n 200:\n description: Success\n schema:\n type: object\n properties:\n custom_attributes:\n type: object\n description: The custom attributes of the conversation\n 404:\n description: Conversation not found\n 401:\n description: Unauthorized | dataset_sample\yaml\chatwoot_chatwoot\swagger\paths\application\conversation\custom_attributes.yml | custom_attributes.yml | YAML | 888 | 0.85 | 0.028571 | 0 | awesome-app | 318 | 2024-03-16T08:48:15.456520 | GPL-3.0 | false | 8ea313a46fa637e282755bfe4cf001dd |
tags:\n - Conversations\noperationId: conversationFilter\ndescription: Filter conversations with custom filter options and pagination\nsummary: Conversations Filter\nsecurity:\n - userApiKey: []\n - agentBotApiKey: []\nparameters:\n - name: page\n in: query\n type: integer\n - name: body\n in: body\n required: true\n schema:\n type: object\n properties:\n payload:\n type: array\n items:\n type: object\n properties:\n attribute_key:\n type: string\n description: filter attribute name\n filter_operator:\n type: string\n description: filter operator name\n enum: [ equal_to, not_equal_to, contains, does_not_contain ]\n values:\n type: array\n items:\n type: string\n description: array of the attribute values to filter\n query_operator:\n type: string\n description: query operator name\n enum: [ AND, OR ]\n example:\n - attribute_key: 'browser_language'\n filter_operator: 'not_eq'\n values: ['en']\n query_operator: 'AND'\n - attribute_key: 'status'\n filter_operator: 'eq'\n values: ['pending']\n query_operator: null\n\nresponses:\n 200:\n description: Success\n schema:\n $ref: '#/definitions/conversation_list'\n 400:\n description: Bad Request Error\n schema:\n $ref: '#/definitions/bad_request_error'\n | dataset_sample\yaml\chatwoot_chatwoot\swagger\paths\application\conversation\filter.yml | filter.yml | YAML | 1,602 | 0.95 | 0 | 0 | react-lib | 665 | 2024-04-23T14:34:58.259221 | Apache-2.0 | false | a9f98d9337477646e86921b490aaaa34 |
parameters:\n - $ref: '#/parameters/account_id'\n\nget:\n tags:\n - Conversations\n operationId: conversationList\n description: List all the conversations with pagination\n summary: Conversations List\n parameters:\n - name: assignee_type\n in: query\n type: string\n enum: ['me', 'unassigned', 'all', 'assigned']\n default: 'all'\n description: Filter conversations by assignee type.\n - name: status\n in: query\n type: string\n enum: ['all', 'open', 'resolved', 'pending', 'snoozed']\n default: 'open'\n description: Filter by conversation status.\n - name: q\n in: query\n type: string\n description: Filters conversations with messages containing the search term\n - name: inbox_id\n in: query\n type: integer\n - name: team_id\n in: query\n type: integer\n - name: labels\n in: query\n type: array\n items:\n type: string\n - name: page\n in: query\n type: integer\n default: 1\n description: paginate through conversations\n\n responses:\n 200:\n description: Success\n schema:\n $ref: '#/definitions/conversation_list'\n 400:\n description: Bad Request Error\n schema:\n $ref: '#/definitions/bad_request_error'\n\npost:\n tags:\n - Conversations\n operationId: newConversation\n summary: Create New Conversation\n description: "Creating a conversation in chatwoot requires a source id. \n\n Learn more about source_id: https://github.com/chatwoot/chatwoot/wiki/Building-on-Top-of-Chatwoot:-Importing-Existing-Contacts-and-Creating-Conversations"\n security:\n - userApiKey: []\n - agentBotApiKey: []\n parameters:\n - name: data\n in: body\n required: true\n schema:\n type: object\n required:\n - source_id\n - inbox_id\n properties:\n source_id:\n type: string\n description: Conversation source id\n inbox_id:\n type: string\n description: "Id of inbox in which the conversation is created <br/> Allowed Inbox Types: Website, Phone, Api, Email "\n contact_id:\n type: string\n description: Contact Id for which conversation is created\n additional_attributes:\n type: object\n description: Lets you specify attributes like browser information\n custom_attributes:\n type: object\n description: The object to save custom attributes for conversation, accepts custom attributes key and value\n example: { attribute_key: attribute_value, priority_conversation_number: 3 }\n status:\n type: string\n enum: ['open', 'resolved', 'pending']\n description: Specify the conversation whether it's pending, open, closed\n assignee_id:\n type: string\n description: Agent Id for assigning a conversation to an agent\n team_id:\n type: string\n description: Team Id for assigning a conversation to a team\n message:\n type: object\n description: The initial message to be sent to the conversation\n required: ['content']\n properties:\n content:\n type: string\n description: The content of the message\n template_params:\n type: object\n description: The template params for the message in case of whatsapp Channel\n properties:\n name:\n type: string\n description: Name of the template\n example: 'sample_issue_resolution'\n category:\n type: string\n description: Category of the template\n example: UTILITY\n language:\n type: string\n description: Language of the template\n example: en_US\n processed_params: \n type: object\n description: The processed param values for template variables in template\n example: \n 1: "Chatwoot"\n responses:\n 200:\n description: Success\n schema:\n type: object\n properties:\n id:\n type: number\n description: ID of the conversation\n account_id:\n type: number\n description: Account Id\n inbox_id:\n type: number\n description: ID of the inbox\n 403:\n description: Access denied\n | dataset_sample\yaml\chatwoot_chatwoot\swagger\paths\application\conversation\index.yml | index.yml | YAML | 4,622 | 0.95 | 0.041667 | 0 | vue-tools | 772 | 2023-09-29T10:22:11.331589 | GPL-3.0 | false | 570332cd628b7fed60843dc762f4583c |
parameters:\n - $ref: '#/parameters/account_id'\n\nget:\n tags:\n - Conversations\n operationId: conversationListMeta\n description: Get open, unassigned and all Conversation counts\n summary: Get Conversation Counts\n parameters:\n - name: status\n in: query\n type: string\n enum: ['all', 'open', 'resolved', 'pending', 'snoozed']\n default: 'open'\n description: Filter by conversation status.\n - name: q\n in: query\n type: string\n description: Filters conversations with messages containing the search term\n - name: inbox_id\n in: query\n type: integer\n - name: team_id\n in: query\n type: integer\n - name: labels\n in: query\n type: array\n items:\n type: string\n\n responses:\n 200:\n description: Success\n schema:\n type: object\n properties:\n meta:\n type: object\n properties:\n mine_count:\n type: number\n unassigned_count:\n type: number\n assigned_count:\n type: number\n all_count:\n type: number\n 400:\n description: Bad Request Error\n schema:\n $ref: '#/definitions/bad_request_error' | dataset_sample\yaml\chatwoot_chatwoot\swagger\paths\application\conversation\meta.yml | meta.yml | YAML | 1,256 | 0.8 | 0 | 0 | awesome-app | 433 | 2025-07-08T17:49:41.024778 | Apache-2.0 | false | a025a4a801c57decaf7393d652403fd7 |
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.