{ "openapi": "3.1.0", "info": { "title": "HelpSpot API v2", "version": "2.0.0", "description": "HelpSpot API v2 endpoints are available under `/api/v2`. JSON is returned by default; send `Accept: application/xml` or `?format=xml` for XML.\n\n### Authentication\n\nAll endpoints require a staff bearer token or HTTP Basic authentication. Staff accounts with two-factor authentication must use a bearer token.\n\nReplace `helpspot.example.com` with your installation's host and path. Always use HTTPS to protect credentials in transit. The private API must be enabled in your installation.\n\n**Bearer token** \u2014 replace `YOUR_API_TOKEN` with your staff API token:\n\n```shell\ncurl 'https://helpspot.example.com/api/v2/version' \\\n --header 'Authorization: Bearer YOUR_API_TOKEN'\n```\n\n**HTTP Basic** \u2014 replace `YOUR_USERNAME` with your staff login. Curl prompts for your password, keeping it out of the command and shell history:\n\n```shell\ncurl 'https://helpspot.example.com/api/v2/version' \\\n --user 'YOUR_USERNAME'\n```\n\nHTTP Basic is unavailable for SAML installations and staff accounts with two-factor authentication; use a bearer token instead. Both examples request JSON, the default response format.\n\n### Dates and timezones\n\nCalendar dates use the installation's configured timezone, not the API caller's timezone. Date-only custom fields preserve the local calendar date: a value entered as `2026-10-06` returns `2026-10-06`. Datetime custom fields and request/history timestamps represent instants and return ISO 8601 UTC with a `Z` suffix. Include an explicit offset when submitting an ISO 8601 datetime.\n\nTimestamp write parameters `opened_at`, `changed_at`, and `added_at` accept Unix seconds from **0** through **2147483647**.\n\n\n### Pagination\n\nRequest listing, request search, saved/system filter results, and audit logs accept `offset` (zero-based, default **0**) and `per_page` (default **10**, maximum **100**). For example: `/api/v2/requests/search?per_page=25&offset=0`.\n\nEvery paginated response includes `meta.offset`, `meta.per_page`, `meta.count` (items in this page), `meta.has_more`, and `meta.next_offset`. Pass `next_offset` as the next request's `offset`, keeping the same filters and sort options. Stop when `has_more` is false and `next_offset` is null. XML represents the null continuation as an empty `` element. Empty and out-of-range pages return **200** with no items and no continuation. Responses do not include a total result count.\n\nRequests and audit logs default to descending ID order. Search preserves its requested sort; saved filters preserve their grouping and urgent ordering. Equal sort values are ordered by request ID. Access restrictions apply before pagination. Bulk `request_ids` lookup is not paginated and cannot be combined with `offset`, `per_page`, or `direction`.\n\nOffset pagination is not a snapshot: inserts, deletions, or changes to matching/sort fields between calls can shift subsequent pages. Other collection endpoints do not accept pagination parameters.\n\n\n### Validation\n\nForm endpoints reject unknown fields with **422** errors keyed by field name. JSON integers must be numbers and JSON booleans must be `true` or `false`; query-string integers use canonical decimal notation. Boolean query parameters accept `true`, `false`, `1`, and `0` (case-sensitive, without surrounding whitespace). IDs and timestamps must fit signed 32-bit storage, with zero allowed only where documented. Invalid or inaccessible resources return **404** or **403**. Errors support JSON and XML.\n\n\n### Errors\n\nAPI errors contain one `error` object with a stable `code`, a human-readable `message`, `fields` (a map of field names to lists of validation messages), and `request_id`. Branch on the code and HTTP status, not the message text. Empty field errors are `{}`. Nested fields use dot paths such as `attachments.0.content_base64`.\n\n```json\n{\n \"error\": {\n \"code\": \"validation_failed\",\n \"message\": \"Some fields are invalid.\",\n \"fields\": {\n \"email\": [\n \"The email field must be a valid email address.\"\n ]\n },\n \"request_id\": \"550e8400-e29b-41d4-a716-446655440000\"\n }\n}\n```\n\nSend the `request_id` when contacting support; it matches the `X-Helpspot-Request-Id` response header. Optional `details` provide code-specific information: `request_merged` includes the destination HelpSpot request number in `details.request_id`, and `not_acceptable` includes `details.supported_formats`.\n\n- **400** \u2014 `invalid_json`, `bad_request`: the request body cannot be parsed.\n- **401** \u2014 `unauthenticated`: authentication failed.\n- **403** \u2014 `forbidden`, `api_disabled`, `two_factor_required`, `trial_expired`: access is denied. Two-factor accounts must use a bearer token.\n- **404** \u2014 `not_found`: the endpoint or accessible resource was not found.\n- **405** \u2014 `method_not_allowed`: use a method listed in the `Allow` header.\n- **406** \u2014 `not_acceptable`: request JSON or XML. This error is returned as JSON.\n- **409** \u2014 `conflict`, `request_merged`, `request_history_limit`, `forum_closed`, `idempotency_conflict`, `idempotency_unresolved`: the resource or operation state prevents this call. See Safe retries on the create-request endpoint before retrying an idempotency conflict.\n- **410** \u2014 `operation_unavailable`: the operation is not available.\n- **413** \u2014 `payload_too_large`: the body exceeds the allowed size.\n- **422** \u2014 `validation_failed`: correct the supplied values. Field-specific errors appear in `fields` when available.\n- **429** \u2014 `rate_limited`: wait the number of seconds in `Retry-After` before retrying.\n- **500** \u2014 `internal_error`: an unexpected error occurred. Contact support with the request ID.\n- **503** \u2014 `service_unavailable`: the API is temporarily unavailable.\n\nXML errors use a `` root and the same field names. Each field's messages are `` elements; empty fields are ``:\n\n```xml\n\n \n validation_failed\n Some fields are invalid.\n \n \n Enter a valid email address.\n \n \n \u2026\n \n\n```\n\nServer failures do not include stack traces or internal exception messages. Errors produced by a reverse proxy or web server before reaching the API may use that server's response format." }, "servers": [ { "url": "https://{host}/api/v2", "description": "Your HelpSpot installation", "variables": { "host": { "default": "helpspot.example.com" } } } ], "tags": [ { "name": "Contacts", "description": "### Address-book contacts\n\n`GET /contacts` returns an unpaginated `data` array, ordered by highlighted contacts first, then last name and first name. Empty lists return `{\"data\":[]}`. `POST /contacts` returns the saved contact in a `data` object with HTTP 201.\n\nContacts contain integer `id`, boolean `highlight`, and `first_name`, `last_name`, `email`, `title`, and `description`. Empty text is null. Creation returns stored values, including trimmed text.\n\n```json\n{\n \"data\": {\n \"id\": 42,\n \"first_name\": \"Alex\",\n \"last_name\": \"Morgan\",\n \"email\": \"alex@example.com\",\n \"title\": \"Support manager\",\n \"description\": null,\n \"highlight\": false\n }\n}\n```\n\nXML uses `\u2026` for lists and `\u2026` for creation. Booleans are `true`/`false`; null values and empty lists use empty elements. `DELETE /contacts/{contact}` returns `{\"deleted\":true}`; missing contacts return HTTP 404.\n" }, { "name": "Filters", "description": "### Available filters\n\n`GET /me/filters` returns an unpaginated `data` array: Inbox (`inbox`), My Queue (`myq`), then accessible saved filters in name order. All filter IDs are strings, including saved IDs such as `\"42\"`. Use the ID directly in `/filters/{filter}/requests`.\n\nEach filter has `id`, `name`, boolean `global`, nullable `folder`, integer `request_count`, nullable integer `unread_count`, nullable UTC ISO 8601 `last_public_update_at`, and ordered `columns` entries containing `key` and `label`. Column keys identify display columns, not API request-resource field names. My Queue supplies unread counts and the latest public-history timestamp for requests assigned to the current staff member. Inbox and saved filters return null for unavailable unread counts and timestamps; null is not a zero count. Counts retain the installation's filter rules and permission restrictions.\n\n```json\n{\n \"data\": [{\n \"id\": \"inbox\",\n \"name\": \"Inbox\",\n \"global\": false,\n \"folder\": null,\n \"request_count\": 12,\n \"unread_count\": null,\n \"last_public_update_at\": null,\n \"columns\": [{\"key\": \"sTitle\", \"label\": \"Title\"}]\n }]\n}\n```\n\nFilter XML uses `\u2026`; `columns` contains `` elements in display order. Null values and empty lists use empty elements.\n" }, { "name": "Preferences", "description": "### Staff preferences\n\n`GET /me/preferences` returns a `data` object for the authenticated staff member. It contains boolean `hide_images`, `hide_wysiwyg`, `default_to_public`, `sidebar_search_full_text`, `notify_email`, `notify_secondary_email`, `notify_sms`, `notify_sms_urgent_only`, and `notify_new_request`, plus integer `request_history_limit` and `return_after_close_mode`. Return modes are 0 (workspace), 1 (same request), and 2 (next request in the queue, or workspace when none remains).\n\nAuthentication secrets, recovery codes, remember tokens, profile information, and internal workspace data are not returned. XML uses `\u2026` with `true`/`false` boolean text.\n\n```json\n{\n \"data\": {\n \"hide_images\": true,\n \"hide_wysiwyg\": false,\n \"default_to_public\": false,\n \"return_after_close_mode\": 2,\n \"sidebar_search_full_text\": false,\n \"notify_email\": true,\n \"notify_secondary_email\": false,\n \"notify_sms\": false,\n \"notify_sms_urgent_only\": false,\n \"notify_new_request\": false,\n \"request_history_limit\": 25\n }\n}\n```\n" }, { "name": "Predefined responses", "description": "### Predefined responses\n\n`GET /responses` returns an unpaginated `data` array, ordered by folder and title. `GET /responses/{response}` returns a single `data` object. Both expose integer `id` and `owner_staff_id`, plus `title`, `folder`, and `body_html`. Empty text is null. HTML and template placeholders are returned unchanged, not rendered or substituted. Internal response actions, recurrence settings, and sharing configuration are not returned.\n\n```json\n{\n \"data\": {\n \"id\": 42,\n \"title\": \"Welcome\",\n \"folder\": \"Customer service\",\n \"body_html\": \"

Thanks for contacting us.

\",\n \"owner_staff_id\": 7\n }\n}\n```\n\n`GET /me/responses/most-used` returns a `data` array of summaries with `id`, `title`, and integer `usage_count`. Counts cover the current staff member's usage in the last three months; results are ordered by descending usage and may be cached briefly. This endpoint considers the ten most-used active responses, then removes any the caller cannot currently access; it can therefore return fewer than ten. Fetch response details to retrieve the body.\n\nAll three endpoints honor ownership, global sharing, permission-group sharing, and explicitly shared staff membership. Deleted or inaccessible replies are excluded from collections. Empty collections return `{\"data\":[]}`. XML uses `\u2026` for lists and `\u2026` for details; HTML is XML-escaped text and null values use empty elements.\n" }, { "name": "Customers" }, { "name": "Documents" }, { "name": "Knowledge base", "description": "### Knowledge-base responses\n\nKnowledge-base endpoints require staff authentication and are available under `/knowledge-books` and `/knowledge-pages`. Read responses use `data`: book/page details return an object; book lists, search results, and tables of contents return arrays. Empty collections return `{\"data\":[]}`. Private books, hidden chapters, and hidden pages are not accessible.\n\n- **Books:** `id`, `name`, `description`, and integer `position`.\n- **Table of contents:** chapter objects contain `id`, `book_id`, `name`, `position`, boolean `appendix`, and a `pages` array. Page order follows the book's configured order. Use `?include_page_html=1` to include each page's `body_html`.\n- **Pages:** `id`, `chapter_id`, `name`, `body_html`, `created_by_staff_id`, `updated_by_staff_id`, `created_at`, `updated_at`, `position`, `highlighted`, `helpful_votes`, and `unhelpful_votes`. Names do not contain generated chapter/page numbering. HTML markup is preserved, with content links/images resolved by the public knowledge-base renderer. Dates use ISO 8601 UTC; unset dates, unset staff references, and empty text are null. IDs, positions, and vote counts are integers; `highlighted` is boolean.\n- **Related content:** when present, `related_pages` is an array of `{id, name, chapter_name, book_id, book_name}`, `tags` is an array of strings, and page details include `attachment_urls` as an array of download links. These optional collections can be omitted when empty; tables of contents do not include attachments.\n- **Search:** `/knowledge-pages?query=sign%20in` returns `{id, name, book_id, book_name, excerpt, url}` objects in relevance order. Search retains the installation's result limit and accepts no pagination parameters. Relative search and attachment links resolve against the HelpSpot installation URL.\n- **Votes:** `POST /knowledge-pages/{page}/helpful-votes` returns `data.helpful_count`; `POST /knowledge-pages/{page}/unhelpful-votes` returns `data.unhelpful_count`. Counts are integers. The same published-book and visible-content restrictions apply.\n\nXML uses `\u2026` for details and `\u2026` for collections. Nested lists also use ``. HTML is XML-escaped text, booleans are `true`/`false`, and nulls and empty lists use empty elements. Helpful/unhelpful voting endpoints have their own response contracts.\n" }, { "name": "Lookups", "description": "### Lookup responses\n\n`GET /categories`, `/request-statuses`, `/mailboxes`, and `/staff` return unpaginated `data` arrays, including `{\"data\":[]}` when empty. IDs and counts are integers, flags are booleans, and empty text or unset references are null. XML uses `\u2026`; empty collections use ``.\n\n- **Categories:** `id`, `name`, `group`, and `custom_field_ids` (an array of integers). Categories include inactive categories and expose `inactive`, `allows_public_submit`, `default_staff_id`, `assignment_mode`, `staff` (objects with `id`, `name`, `assigned_request_count`), and `reporting_tags` (objects with `id`, `name`). Assignment mode is an integer: 0 off, 1 default staff, 2 random including admins, 3 random non-admin, 4 least assigned including admins, 5 least assigned non-admin, 6 round robin including admins, 7 round robin non-admin.\n- **Request statuses:** `id` and `name`. Active statuses are returned by default; use `?include_inactive=1` to include inactive statuses. Spam status is visible only to staff with spam-management permission.\n- **Mailboxes:** `id`, `reply_name`, and `reply_email`. Active mailboxes are returned by default; use `?include_inactive=1` to include inactive mailboxes. Reply-name placeholders use their display labels, not a particular staff member's name. Mail-server credentials and connection settings are not returned. Use an active mailbox's `id` as `email_from_mailbox_id` when composing a request. Example: `{\"data\":[{\"id\":3,\"reply_name\":\"Support\",\"reply_email\":\"support@example.com\"}]}`.\n- **Staff:** `id`, `first_name`, `last_name`, `name`, `email`, `phone`, `permission_group_id`, and `inactive`. Active staff are returned by default; use `?include_inactive=1` to include historical staff. Authentication secrets, permission flags, signatures, and workspace preferences are not returned.\n\nFor example, a status collection is `{\"data\":[{\"id\":1,\"name\":\"Active\"}]}`. Staff photo and subscription endpoints have their own response contracts.\n" }, { "name": "Custom fields", "description": "### Custom-field definitions\n\n`GET /custom-fields` returns an unpaginated `data` array ordered by configured position, then field name. Empty collections return `{\"data\":[]}`. The lookup accepts `?category_id=3`, including fields assigned to that category and always-visible fields. Use category `custom_field_ids` together with `always_visible` to determine applicability.\n\nDefinitions contain integer `id` and `position`, plain-text `name`, `type`, and boolean `required`, `always_visible`, and `public`. AJAX URLs, serialized settings, and option colors are not returned.\n\nTypes retain their identifiers: `text`, `numtext`, `decimal`, `checkbox`, `lrgtext`, `regex`, `ajax`, `date`, `datetime`, `select`, and `drilldown`. Type-specific metadata is present only when applicable:\n\n- `max_length` for text, AJAX, regex, select, and drill-down values (255 when no size is configured).\n- `decimal_places` for decimal values; submit exact decimal strings. Storage precision is ten digits including the fractional part.\n- `pattern` for regex fields, or null when empty. Regex fields support compatible PCRE/JavaScript patterns with `i`, `m`, `s`, and `u` flags; unsupported JavaScript constructs fail validation.\n- `options` for select and drill-down fields, including `[]` when no choices exist. Each node has string `value` and `label` plus an ordered `children` array. Select values are literal strings, preserving leading zeros and special characters. Drill-down values contain the full `#-#`-separated path; for example, `OS#-#Linux`. Intermediate paths such as `OS` are also selectable. Leaf nodes have `children: []`.\n\n```json\n{\n \"data\": [{\n \"id\": 7,\n \"name\": \"Priority\",\n \"type\": \"select\",\n \"required\": true,\n \"always_visible\": true,\n \"position\": 2,\n \"max_length\": 255,\n \"options\": [\n {\"value\": \"High\", \"label\": \"High\", \"children\": []},\n {\"value\": \"Low\", \"label\": \"Low\", \"children\": []}\n ]\n }]\n}\n```\n\nSubmit a selected value using its field ID, for example `{\"custom_fields\":{\"7\":\"High\"}}`. Names are plain text, not HTML; escape them when rendering HTML. XML uses `\u2026`, with nested `` elements for options and children. Booleans use `true`/`false`; nulls and empty arrays use empty elements.\n" }, { "name": "Report", "description": "### Report date ranges\n\nSaved-report `from` and `to` parameters accept `YYYY-MM-DD` dates from **1970-01-01** through **2038-01-18**. Both selected calendar days are included. The query starts at local midnight on `from` and ends exclusively at local midnight after `to`, including the final minute of the selected day. Daylight-saving transitions can make a day 23 or 25 hours long. Report `metadata.date_range` contains the effective Unix-second boundaries (`from` inclusive, `to` exclusive), and `metadata.timezone` names the timezone used.\n" }, { "name": "Requests", "description": "### Request responses\n\nRequest get, list, search, filter results, bulk lookup, create, and update responses use `data`. A single request is an object; a collection is an array, including `[]` when empty. Paginated request collections also include `meta` alongside `data`. Create requests with `POST /requests`, read them with `GET /requests/{request}`, and add notes or replies with `PATCH /requests/{request}`. Use `/requests/search` with customer filters to find a customer's accessible requests.\n\nPrivate single-request and bulk reads resolve merged request IDs to their destination and require access to that destination. PATCH to a merged ID returns HTTP 409 with `error.code` set to `request_merged` and the destination ID in `error.details.request_id`; it does not modify the destination. Fetch the destination and review its state before submitting an update to its ID. For single-request reads and PATCH, inaccessible destinations return HTTP 403 without merge details; missing destinations return HTTP 404.\n\n```json\n{\n \"data\": {\n \"id\": 123,\n \"title\": \"Cannot sign in\",\n \"customer_id\": \"00042\",\n \"category_id\": 4,\n \"assigned_staff_id\": null,\n \"open\": true,\n \"urgent\": false,\n \"opened_at\": \"2026-10-05T12:30:00Z\",\n \"closed_at\": null,\n \"custom_fields\": [{\"id\": 7, \"value\": false}]\n }\n}\n```\n\nRequest IDs and numeric codes are integers; customer IDs are strings, preserving leading zeros. Flags are booleans. Unset references, empty text, and unset dates are `null`. Dates use ISO 8601 UTC with a `Z` suffix. Field types do not depend on display preferences. With `include_time_total=true`, private get, list, search, and bulk lookup return integer `time_total_seconds`.\n\nCustom fields are a list of `{id, value}` objects sorted by field ID. Values are booleans for checkboxes, integers for integer fields, exact decimal strings with the configured scale for decimal fields, `YYYY-MM-DD` strings for date-only fields, ISO 8601 UTC timestamps for datetime fields, and strings for text/choice fields. Unset values are null, except unchecked checkboxes are false. Custom-field inputs use an ID-keyed object, for example `{\"custom_fields\":{\"7\":false}}`.\n\nGet and bulk detail responses include `history` when available. History and `attachments` are arrays, not ID-keyed objects. History uses `id`, `request_id`, `author_id`, `created_at`, and `body_html`; author ID `0` means customer and `-1` means system. Details can also include reporting tags, subscriber IDs, and survey responses. Paginated collections and write responses omit history. Search/filter rows can include a plain-text `summary`; My Queue includes `unread`.\n\nRequest passwords, storage hashes, raw email headers, and attachment bodies are not returned. Treat public attachment URLs as credentials.\n\nCreate returns **201** and PATCH returns **200**, with saved request fields. If a write succeeds but its new assignment/category prevents the caller from reading the request, the response acknowledges success with only `data.id`. Read restrictions still apply to subsequent requests.\n\nXML uses `\u2026` for one request and `\u2026` for collections. Nested lists also use `` elements. Booleans are `true`/`false`; null values and empty lists use empty elements. Each custom-field item carries its own `id` and `value`.\n\n\n### Request validation\n\nRequest writes validate customer storage lengths, effective customer/category/assignment state, active staff, sender mailboxes, portals, reporting tags, recipient email lists, and required custom fields before execution. PATCH omission preserves a value; `null` clears nullable fields. Recipients are comma-separated plain addresses, not display-name syntax. Attachments require a note, canonical base64, safe filenames, media types, and the installation size limit.\n\nCustom-field writes use configured types, category applicability, lengths, select/drilldown choices, and decimal precision. Send exact decimal fractions as strings. Dates accept calendar dates, ISO timestamps, or signed Unix timestamps; timestamp zero is reserved for unset values. Regex fields support compatible PCRE/JavaScript patterns with `i`, `m`, `s`, and `u` flags; unsupported JavaScript constructs fail validation. Request searches accept type-appropriate scalar or `{op, value}` custom-field predicates; time searches accept scalar equality only.\n\nRequest-search before/after dates are exclusive calendar-day boundaries.\n" }, { "name": "Request actions" }, { "name": "Time tracking", "description": "### Time-tracking responses\n\nTime-event `year`, `month`, and `day` identify the work date in the installation timezone; they do not identify a UTC instant. Durations are elapsed seconds and do not change with timezone. Calendar dates that do not exist in the installation timezone are rejected. Time entries accept minutes, decimal hours, or `H:MM[:SS]`, normalized to exact whole seconds.\n\n`GET /requests/{request}/time-events` and `GET /time-events` return unpaginated `data` arrays; an empty result is `{\"data\":[]}`. Creating a time event returns **201** with the saved event in a `data` object.\n\nCreating a time event requires access to the request and an active `staff_id`. Staff limited to their own requests or assigned categories can record time only for themselves or staff sharing their categories; other staff IDs return **403**.\n\nEvents contain integer `id`, `request_id`, `staff_id`, and `duration_seconds`; boolean `billable`; `description`; `work_date` as an installation-local `YYYY-MM-DD` calendar date; and `created_at` as an ISO 8601 UTC timestamp. Empty descriptions and unset creation timestamps are null. A staff ID of zero means no staff reference. Field types and date formats are independent of display preferences. Search results additionally contain `customer_id` (a string preserving leading zeros), `first_name`, `last_name`, and `email`; empty customer fields are null.\n\n```json\n{\n \"data\": {\n \"id\": 42,\n \"request_id\": 123,\n \"staff_id\": 7,\n \"duration_seconds\": 5415,\n \"billable\": true,\n \"description\": \"Work & review\",\n \"work_date\": \"2026-10-06\",\n \"created_at\": \"2023-11-14T22:15:23Z\"\n }\n}\n```\n\nSearch filters and ordering select which events are returned; request-access restrictions apply to both list endpoints. XML uses `\u2026` for lists and `\u2026` for creation. Booleans are `true`/`false`; null values and empty arrays use empty elements. Deletion returns `{\"deleted\":true}`.\n" }, { "name": "Staff" }, { "name": "System" }, { "name": "Webhooks" } ], "paths": { "/contacts": { "get": { "operationId": "v2.contacts.index", "summary": "List address book contacts", "tags": [ "Contacts" ], "responses": { "200": { "description": "Address-book contact. See the Contacts guide.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer" }, "first_name": { "type": [ "string", "null" ] }, "last_name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "title": { "type": [ "string", "null" ] }, "description": { "type": [ "string", "null" ] }, "highlight": { "type": "boolean" } } } } }, "required": [ "data" ] } }, "application/xml": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer" }, "first_name": { "type": [ "string", "null" ] }, "last_name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "title": { "type": [ "string", "null" ] }, "description": { "type": [ "string", "null" ] }, "highlight": { "type": "boolean" } } } } }, "required": [ "data" ] } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ApiError" } } }, "headers": { "X-Helpspot-Request-Id": { "description": "Correlation ID matching error.request_id. Include it when contacting support.", "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ApiError" } } }, "headers": { "X-Helpspot-Request-Id": { "description": "Correlation ID matching error.request_id. Include it when contacting support.", "schema": { "type": "string" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ApiError" } } }, "headers": { "X-Helpspot-Request-Id": { "description": "Correlation ID matching error.request_id. Include it when contacting support.", "schema": { "type": "string" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ApiError" } } }, "headers": { "X-Helpspot-Request-Id": { "description": "Correlation ID matching error.request_id. Include it when contacting support.", "schema": { "type": "string" } } } }, "405": { "description": "Method Not Allowed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ApiError" } } }, "headers": { "X-Helpspot-Request-Id": { "description": "Correlation ID matching error.request_id. Include it when contacting support.", "schema": { "type": "string" } } } }, "406": { "description": "Not Acceptable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } }, "headers": { "X-Helpspot-Request-Id": { "description": "Correlation ID matching error.request_id. Include it when contacting support.", "schema": { "type": "string" } } } }, "413": { "description": "Content Too Large", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ApiError" } } }, "headers": { "X-Helpspot-Request-Id": { "description": "Correlation ID matching error.request_id. Include it when contacting support.", "schema": { "type": "string" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ApiError" } } }, "headers": { "X-Helpspot-Request-Id": { "description": "Correlation ID matching error.request_id. Include it when contacting support.", "schema": { "type": "string" } }, "Retry-After": { "description": "Seconds to wait before retrying.", "schema": { "type": "string" }, "example": "60" } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ApiError" } } }, "headers": { "X-Helpspot-Request-Id": { "description": "Correlation ID matching error.request_id. Include it when contacting support.", "schema": { "type": "string" } } } }, "503": { "description": "Service Unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ApiError" } } }, "headers": { "X-Helpspot-Request-Id": { "description": "Correlation ID matching error.request_id. Include it when contacting support.", "schema": { "type": "string" } } } } }, "security": [ { "bearerAuth": [] }, { "basicAuth": [] } ] }, "post": { "operationId": "v2.contacts.store", "summary": "Create an address book contact", "tags": [ "Contacts" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StoreContactRequest" } } } }, "responses": { "422": { "$ref": "#/components/responses/ValidationException" }, "201": { "description": "Address-book contact. See the Contacts guide.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "integer" }, "first_name": { "type": [ "string", "null" ] }, "last_name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "title": { "type": [ "string", "null" ] }, "description": { "type": [ "string", "null" ] }, "highlight": { "type": "boolean" } } } }, "required": [ "data" ] } }, "application/xml": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "integer" }, "first_name": { "type": [ "string", "null" ] }, "last_name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "title": { "type": [ "string", "null" ] }, "description": { "type": [ "string", "null" ] }, "highlight": { "type": "boolean" } } } }, "required": [ "data" ] } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ApiError" } } }, "headers": { "X-Helpspot-Request-Id": { "description": "Correlation ID matching error.request_id. Include it when contacting support.", "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ApiError" } } }, "headers": { "X-Helpspot-Request-Id": { "description": "Correlation ID matching error.request_id. Include it when contacting support.", "schema": { "type": "string" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ApiError" } } }, "headers": { "X-Helpspot-Request-Id": { "description": "Correlation ID matching error.request_id. Include it when contacting support.", "schema": { "type": "string" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ApiError" } } }, "headers": { "X-Helpspot-Request-Id": { "description": "Correlation ID matching error.request_id. Include it when contacting support.", "schema": { "type": "string" } } } }, "405": { "description": "Method Not Allowed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ApiError" } } }, "headers": { "X-Helpspot-Request-Id": { "description": "Correlation ID matching error.request_id. Include it when contacting support.", "schema": { "type": "string" } } } }, "406": { "description": "Not Acceptable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } }, "headers": { "X-Helpspot-Request-Id": { "description": "Correlation ID matching error.request_id. Include it when contacting support.", "schema": { "type": "string" } } } }, "413": { "description": "Content Too Large", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ApiError" } } }, "headers": { "X-Helpspot-Request-Id": { "description": "Correlation ID matching error.request_id. Include it when contacting support.", "schema": { "type": "string" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ApiError" } } }, "headers": { "X-Helpspot-Request-Id": { "description": "Correlation ID matching error.request_id. Include it when contacting support.", "schema": { "type": "string" } }, "Retry-After": { "description": "Seconds to wait before retrying.", "schema": { "type": "string" }, "example": "60" } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ApiError" } } }, "headers": { "X-Helpspot-Request-Id": { "description": "Correlation ID matching error.request_id. Include it when contacting support.", "schema": { "type": "string" } } } }, "503": { "description": "Service Unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ApiError" } } }, "headers": { "X-Helpspot-Request-Id": { "description": "Correlation ID matching error.request_id. Include it when contacting support.", "schema": { "type": "string" } } } } }, "security": [ { "bearerAuth": [] }, { "basicAuth": [] } ] } }, "/contacts/{contact}": { "delete": { "operationId": "v2.contacts.destroy", "summary": "Delete an address book contact", "tags": [ "Contacts" ], "parameters": [ { "name": "contact", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "403": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ApiError" } } }, "headers": { "X-Helpspot-Request-Id": { "description": "Correlation ID matching error.request_id. Include it when contacting support.", "schema": { "type": "string" } } } }, "200": { "description": "Operation result.", "content": { "application/json": { "schema": { "type": "object", "properties": { "deleted": { "type": "boolean" } }, "required": [ "deleted" ] } }, "application/xml": { "schema": { "type": "object", "properties": { "deleted": { "type": "boolean" } }, "required": [ "deleted" ] } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ApiError" } } }, "headers": { "X-Helpspot-Request-Id": { "description": "Correlation ID matching error.request_id. Include it when contacting support.", "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ApiError" } } }, "headers": { "X-Helpspot-Request-Id": { "description": "Correlation ID matching error.request_id. Include it when contacting support.", "schema": { "type": "string" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ApiError" } } }, "headers": { "X-Helpspot-Request-Id": { "description": "Correlation ID matching error.request_id. Include it when contacting support.", "schema": { "type": "string" } } } }, "405": { "description": "Method Not Allowed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ApiError" } } }, "headers": { "X-Helpspot-Request-Id": { "description": "Correlation ID matching error.request_id. Include it when contacting support.", "schema": { "type": "string" } } } }, "406": { "description": "Not Acceptable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } }, "headers": { "X-Helpspot-Request-Id": { "description": "Correlation ID matching error.request_id. Include it when contacting support.", "schema": { "type": "string" } } } }, "413": { "description": "Content Too Large", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ApiError" } } }, "headers": { "X-Helpspot-Request-Id": { "description": "Correlation ID matching error.request_id. Include it when contacting support.", "schema": { "type": "string" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ApiError" } } }, "headers": { "X-Helpspot-Request-Id": { "description": "Correlation ID matching error.request_id. Include it when contacting support.", "schema": { "type": "string" } }, "Retry-After": { "description": "Seconds to wait before retrying.", "schema": { "type": "string" }, "example": "60" } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ApiError" } } }, "headers": { "X-Helpspot-Request-Id": { "description": "Correlation ID matching error.request_id. Include it when contacting support.", "schema": { "type": "string" } } } }, "503": { "description": "Service Unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ApiError" } } }, "headers": { "X-Helpspot-Request-Id": { "description": "Correlation ID matching error.request_id. Include it when contacting support.", "schema": { "type": "string" } } } } }, "security": [ { "bearerAuth": [] }, { "basicAuth": [] } ] } }, "/me/filters": { "get": { "operationId": "v2.me.filters.index", "summary": "List the current staff member's system and saved filters", "tags": [ "Filters" ], "responses": { "200": { "description": "Unpaginated lookup collection. See this resource group for field definitions.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/FilterResource" } } }, "required": [ "data" ] } }, "application/xml": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/FilterResource" } } }, "required": [ "data" ] } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ApiError" } } }, "headers": { "X-Helpspot-Request-Id": { "description": "Correlation ID matching error.request_id. Include it when contacting support.", "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ApiError" } } }, "headers": { "X-Helpspot-Request-Id": { "description": "Correlation ID matching error.request_id. Include it when contacting support.", "schema": { "type": "string" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ApiError" } } }, "headers": { "X-Helpspot-Request-Id": { "description": "Correlation ID matching error.request_id. Include it when contacting support.", "schema": { "type": "string" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ApiError" } } }, "headers": { "X-Helpspot-Request-Id": { "description": "Correlation ID matching error.request_id. Include it when contacting support.", "schema": { "type": "string" } } } }, "405": { "description": "Method Not Allowed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ApiError" } } }, "headers": { "X-Helpspot-Request-Id": { "description": "Correlation ID matching error.request_id. Include it when contacting support.", "schema": { "type": "string" } } } }, "406": { "description": "Not Acceptable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } }, "headers": { "X-Helpspot-Request-Id": { "description": "Correlation ID matching error.request_id. Include it when contacting support.", "schema": { "type": "string" } } } }, "413": { "description": "Content Too Large", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ApiError" } } }, "headers": { "X-Helpspot-Request-Id": { "description": "Correlation ID matching error.request_id. Include it when contacting support.", "schema": { "type": "string" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ApiError" } } }, "headers": { "X-Helpspot-Request-Id": { "description": "Correlation ID matching error.request_id. Include it when contacting support.", "schema": { "type": "string" } }, "Retry-After": { "description": "Seconds to wait before retrying.", "schema": { "type": "string" }, "example": "60" } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ApiError" } } }, "headers": { "X-Helpspot-Request-Id": { "description": "Correlation ID matching error.request_id. Include it when contacting support.", "schema": { "type": "string" } } } }, "503": { "description": "Service Unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ApiError" } } }, "headers": { "X-Helpspot-Request-Id": { "description": "Correlation ID matching error.request_id. Include it when contacting support.", "schema": { "type": "string" } } } } }, "security": [ { "bearerAuth": [] }, { "basicAuth": [] } ] } }, "/me/preferences": { "get": { "operationId": "v2.me.preferences.show", "summary": "Retrieve the current staff member's preferences", "tags": [ "Preferences" ], "responses": { "200": { "description": "Current staff preferences. See the Preferences guide.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "hide_images": { "type": "boolean" }, "hide_wysiwyg": { "type": "boolean" }, "default_to_public": { "type": "boolean" }, "return_after_close_mode": { "type": "integer" }, "sidebar_search_full_text": { "type": "boolean" }, "notify_email": { "type": "boolean" }, "notify_secondary_email": { "type": "boolean" }, "notify_sms": { "type": "boolean" }, "notify_sms_urgent_only": { "type": "boolean" }, "notify_new_request": { "type": "boolean" }, "request_history_limit": { "type": "integer" } } } }, "required": [ "data" ] } }, "application/xml": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "hide_images": { "type": "boolean" }, "hide_wysiwyg": { "type": "boolean" }, "default_to_public": { "type": "boolean" }, "return_after_close_mode": { "type": "integer" }, "sidebar_search_full_text": { "type": "boolean" }, "notify_email": { "type": "boolean" }, "notify_secondary_email": { "type": "boolean" }, "notify_sms": { "type": "boolean" }, "notify_sms_urgent_only": { "type": "boolean" }, "notify_new_request": { "type": "boolean" }, "request_history_limit": { "type": "integer" } } } }, "required": [ "data" ] } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ApiError" } } }, "headers": { "X-Helpspot-Request-Id": { "description": "Correlation ID matching error.request_id. Include it when contacting support.", "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ApiError" } } }, "headers": { "X-Helpspot-Request-Id": { "description": "Correlation ID matching error.request_id. Include it when contacting support.", "schema": { "type": "string" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ApiError" } } }, "headers": { "X-Helpspot-Request-Id": { "description": "Correlation ID matching error.request_id. Include it when contacting support.", "schema": { "type": "string" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ApiError" } } }, "headers": { "X-Helpspot-Request-Id": { "description": "Correlation ID matching error.request_id. Include it when contacting support.", "schema": { "type": "string" } } } }, "405": { "description": "Method Not Allowed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ApiError" } } }, "headers": { "X-Helpspot-Request-Id": { "description": "Correlation ID matching error.request_id. Include it when contacting support.", "schema": { "type": "string" } } } }, "406": { "description": "Not Acceptable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } }, "headers": { "X-Helpspot-Request-Id": { "description": "Correlation ID matching error.request_id. Include it when contacting support.", "schema": { "type": "string" } } } }, "413": { "description": "Content Too Large", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ApiError" } } }, "headers": { "X-Helpspot-Request-Id": { "description": "Correlation ID matching error.request_id. Include it when contacting support.", "schema": { "type": "string" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ApiError" } } }, "headers": { "X-Helpspot-Request-Id": { "description": "Correlation ID matching error.request_id. Include it when contacting support.", "schema": { "type": "string" } }, "Retry-After": { "description": "Seconds to wait before retrying.", "schema": { "type": "string" }, "example": "60" } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ApiError" } } }, "headers": { "X-Helpspot-Request-Id": { "description": "Correlation ID matching error.request_id. Include it when contacting support.", "schema": { "type": "string" } } } }, "503": { "description": "Service Unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ApiError" } } }, "headers": { "X-Helpspot-Request-Id": { "description": "Correlation ID matching error.request_id. Include it when contacting support.", "schema": { "type": "string" } } } } }, "security": [ { "bearerAuth": [] }, { "basicAuth": [] } ] } }, "/me/responses/most-used": { "get": { "operationId": "v2.me.responses.most-used", "summary": "List the current staff member's most-used predefined responses", "tags": [ "Predefined responses" ], "responses": { "200": { "description": "Predefined response resource. See the Predefined responses guide.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/MostUsedResponseResource" } } }, "required": [ "data" ] } }, "application/xml": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/MostUsedResponseResource" } } }, "required": [ "data" ] } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ApiError" } } }, "headers": { "X-Helpspot-Request-Id": { "description": "Correlation ID matching error.request_id. Include it when contacting support.", "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ApiError" } } }, "headers": { "X-Helpspot-Request-Id": { "description": "Correlation ID matching error.request_id. Include it when contacting support.", "schema": { "type": "string" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ApiError" } } }, "headers": { "X-Helpspot-Request-Id": { "description": "Correlation ID matching error.request_id. Include it when contacting support.", "schema": { "type": "string" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ApiError" } } }, "headers": { "X-Helpspot-Request-Id": { "description": "Correlation ID matching error.request_id. Include it when contacting support.", "schema": { "type": "string" } } } }, "405": { "description": "Method Not Allowed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ApiError" } } }, "headers": { "X-Helpspot-Request-Id": { "description": "Correlation ID matching error.request_id. Include it when contacting support.", "schema": { "type": "string" } } } }, "406": { "description": "Not Acceptable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } }, "headers": { "X-Helpspot-Request-Id": { "description": "Correlation ID matching error.request_id. Include it when contacting support.", "schema": { "type": "string" } } } }, "413": { "description": "Content Too Large", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ApiError" } } }, "headers": { "X-Helpspot-Request-Id": { "description": "Correlation ID matching error.request_id. Include it when contacting support.", "schema": { "type": "string" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ApiError" } } }, "headers": { "X-Helpspot-Request-Id": { "description": "Correlation ID matching error.request_id. Include it when contacting support.", "schema": { "type": "string" } }, "Retry-After": { "description": "Seconds to wait before retrying.", "schema": { "type": "string" }, "example": "60" } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ApiError" } } }, "headers": { "X-Helpspot-Request-Id": { "description": "Correlation ID matching error.request_id. Include it when contacting support.", "schema": { "type": "string" } } } }, "503": { "description": "Service Unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ApiError" } } }, "headers": { "X-Helpspot-Request-Id": { "description": "Correlation ID matching error.request_id. Include it when contacting support.", "schema": { "type": "string" } } } } }, "security": [ { "bearerAuth": [] }, { "basicAuth": [] } ] } }, "/customers/{email}/portal-password": { "put": { "operationId": "v2.customers.portal-password.update", "description": "Password updates accept at most 72 bytes, avoiding silent hasher truncation.", "summary": "Set a portal customer's password. Password retrieval is intentionally unsupported", "tags": [ "Customers" ], "parameters": [ { "name": "email", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdatePortalPasswordRequest" } } } }, "responses": { "404": { "$ref": "#/components/responses/ModelNotFoundException" }, "422": { "$ref": "#/components/responses/ValidationException" }, "200": { "description": "Password updated. The password is never returned.", "content": { "application/json": { "schema": { "type": "object", "properties": { "updated": { "type": "boolean" } }, "required": [ "updated" ] } }, "application/xml": { "schema": { "type": "object", "properties": { "updated": { "type": "boolean" } }, "required": [ "updated" ] } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ApiError" } } }, "headers": { "X-Helpspot-Request-Id": { "description": "Correlation ID matching error.request_id. Include it when contacting support.", "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ApiError" } } }, "headers": { "X-Helpspot-Request-Id": { "description": "Correlation ID matching error.request_id. Include it when contacting support.", "schema": { "type": "string" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ApiError" } } }, "headers": { "X-Helpspot-Request-Id": { "description": "Correlation ID matching error.request_id. Include it when contacting support.", "schema": { "type": "string" } } } }, "405": { "description": "Method Not Allowed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ApiError" } } }, "headers": { "X-Helpspot-Request-Id": { "description": "Correlation ID matching error.request_id. Include it when contacting support.", "schema": { "type": "string" } } } }, "406": { "description": "Not Acceptable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } }, "headers": { "X-Helpspot-Request-Id": { "description": "Correlation ID matching error.request_id. Include it when contacting support.", "schema": { "type": "string" } } } }, "413": { "description": "Content Too Large", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ApiError" } } }, "headers": { "X-Helpspot-Request-Id": { "description": "Correlation ID matching error.request_id. Include it when contacting support.", "schema": { "type": "string" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ApiError" } } }, "headers": { "X-Helpspot-Request-Id": { "description": "Correlation ID matching error.request_id. Include it when contacting support.", "schema": { "type": "string" } }, "Retry-After": { "description": "Seconds to wait before retrying.", "schema": { "type": "string" }, "example": "60" } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ApiError" } } }, "headers": { "X-Helpspot-Request-Id": { "description": "Correlation ID matching error.request_id. Include it when contacting support.", "schema": { "type": "string" } } } }, "503": { "description": "Service Unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ApiError" } } }, "headers": { "X-Helpspot-Request-Id": { "description": "Correlation ID matching error.request_id. Include it when contacting support.", "schema": { "type": "string" } } } } }, "security": [ { "bearerAuth": [] }, { "basicAuth": [] } ] } }, "/documents/{document}": { "get": { "operationId": "v2.documents.show", "description": "Returns document metadata and base64-encoded original file bytes in a `data` object. Use attachment IDs from request history. Access requires permission to the parent request or predefined response. Documents without either parent return **403**. `history_id` and `response_id` are nullable integer references; unset metadata is null. `content_base64` is an empty string for an empty file. Decode it as binary, not UTF-8 text. Storage paths and internal flags are not returned. XML uses `\u2026`; null and empty strings use empty elements.", "summary": "Retrieve document metadata and base64-encoded content", "tags": [ "Documents" ], "parameters": [ { "name": "document", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Document metadata and base64-encoded content.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "examples": [ { "id": 42, "history_id": 123, "response_id": null, "filename": "hello.txt", "mime_type": "text/plain", "content_id": null, "content_base64": "SGVsbG8K" } ], "properties": { "id": { "type": "integer" }, "history_id": { "type": [ "integer", "null" ] }, "response_id": { "type": [ "integer", "null" ] }, "filename": { "type": [ "string", "null" ] }, "mime_type": { "type": [ "string", "null" ] }, "content_id": { "type": [ "string", "null" ] }, "content_base64": { "type": [ "string", "null" ], "format": "byte" } }, "required": [ "id", "history_id", "response_id", "filename", "mime_type", "content_id", "content_base64" ] } }, "required": [ "data" ] } }, "application/xml": { "schema": { "type": "object", "properties": { "data": { "type": "object", "examples": [ { "id": 42, "history_id": 123, "response_id": null, "filename": "hello.txt", "mime_type": "text/plain", "content_id": null, "content_base64": "SGVsbG8K" } ], "properties": { "id": { "type": "integer" }, "history_id": { "type": [ "integer", "null" ] }, "response_id": { "type": [ "integer", "null" ] }, "filename": { "type": [ "string", "null" ] }, "mime_type": { "type": [ "string", "null" ] }, "content_id": { "type": [ "string", "null" ] }, "content_base64": { "type": [ "string", "null" ], "format": "byte" } }, "required": [ "id", "history_id", "response_id", "filename", "mime_type", "content_id", "content_base64" ] } }, "required": [ "data" ] } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ApiError" } } }, "headers": { "X-Helpspot-Request-Id": { "description": "Correlation ID matching error.request_id. Include it when contacting support.", "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ApiError" } } }, "headers": { "X-Helpspot-Request-Id": { "description": "Correlation ID matching error.request_id. Include it when contacting support.", "schema": { "type": "string" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ApiError" } } }, "headers": { "X-Helpspot-Request-Id": { "description": "Correlation ID matching error.request_id. Include it when contacting support.", "schema": { "type": "string" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ApiError" } } }, "headers": { "X-Helpspot-Request-Id": { "description": "Correlation ID matching error.request_id. Include it when contacting support.", "schema": { "type": "string" } } } }, "405": { "description": "Method Not Allowed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ApiError" } } }, "headers": { "X-Helpspot-Request-Id": { "description": "Correlation ID matching error.request_id. Include it when contacting support.", "schema": { "type": "string" } } } }, "406": { "description": "Not Acceptable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } }, "headers": { "X-Helpspot-Request-Id": { "description": "Correlation ID matching error.request_id. Include it when contacting support.", "schema": { "type": "string" } } } }, "413": { "description": "Content Too Large", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ApiError" } } }, "headers": { "X-Helpspot-Request-Id": { "description": "Correlation ID matching error.request_id. Include it when contacting support.", "schema": { "type": "string" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ApiError" } } }, "headers": { "X-Helpspot-Request-Id": { "description": "Correlation ID matching error.request_id. Include it when contacting support.", "schema": { "type": "string" } }, "Retry-After": { "description": "Seconds to wait before retrying.", "schema": { "type": "string" }, "example": "60" } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ApiError" } } }, "headers": { "X-Helpspot-Request-Id": { "description": "Correlation ID matching error.request_id. Include it when contacting support.", "schema": { "type": "string" } } } }, "503": { "description": "Service Unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ApiError" } } }, "headers": { "X-Helpspot-Request-Id": { "description": "Correlation ID matching error.request_id. Include it when contacting support.", "schema": { "type": "string" } } } } }, "security": [ { "bearerAuth": [] }, { "basicAuth": [] } ] } }, "/filters/{filter}/requests": { "get": { "operationId": "v2.filters.requests.index", "summary": "Run Inbox, My Queue, or an accessible saved filter", "tags": [ "Filters" ], "parameters": [ { "name": "filter", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "offset", "in": "query", "schema": { "type": "integer", "minimum": 0 } }, { "name": "per_page", "in": "query", "schema": { "type": "integer", "minimum": 1, "maximum": 100 } } ], "responses": { "422": { "$ref": "#/components/responses/ValidationException" }, "200": { "description": "Request resource. Fields depend on visibility and endpoint; see the Requests guide.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/RequestResource" } }, "meta": { "type": "object", "properties": { "offset": { "type": "integer" }, "per_page": { "type": "integer" }, "count": { "type": "integer" }, "has_more": { "type": "boolean" }, "next_offset": { "type": [ "integer", "null" ] } }, "required": [ "offset", "per_page", "count", "has_more", "next_offset" ] } }, "required": [ "data" ] } }, "application/xml": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/RequestResource" } }, "meta": { "type": "object", "properties": { "offset": { "type": "integer" }, "per_page": { "type": "integer" }, "count": { "type": "integer" }, "has_more": { "type": "boolean" }, "next_offset": { "type": [ "integer", "null" ] } }, "required": [ "offset", "per_page", "count", "has_more", "next_offset" ] } }, "required": [ "data" ] } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ApiError" } } }, "headers": { "X-Helpspot-Request-Id": { "description": "Correlation ID matching error.request_id. Include it when contacting support.", "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ApiError" } } }, "headers": { "X-Helpspot-Request-Id": { "description": "Correlation ID matching error.request_id. Include it when contacting support.", "schema": { "type": "string" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ApiError" } } }, "headers": { "X-Helpspot-Request-Id": { "description": "Correlation ID matching error.request_id. Include it when contacting support.", "schema": { "type": "string" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ApiError" } } }, "headers": { "X-Helpspot-Request-Id": { "description": "Correlation ID matching error.request_id. Include it when contacting support.", "schema": { "type": "string" } } } }, "405": { "description": "Method Not Allowed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ApiError" } } }, "headers": { "X-Helpspot-Request-Id": { "description": "Correlation ID matching error.request_id. Include it when contacting support.", "schema": { "type": "string" } } } }, "406": { "description": "Not Acceptable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } }, "headers": { "X-Helpspot-Request-Id": { "description": "Correlation ID matching error.request_id. Include it when contacting support.", "schema": { "type": "string" } } } }, "413": { "description": "Content Too Large", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ApiError" } } }, "headers": { "X-Helpspot-Request-Id": { "description": "Correlation ID matching error.request_id. Include it when contacting support.", "schema": { "type": "string" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ApiError" } } }, "headers": { "X-Helpspot-Request-Id": { "description": "Correlation ID matching error.request_id. Include it when contacting support.", "schema": { "type": "string" } }, "Retry-After": { "description": "Seconds to wait before retrying.", "schema": { "type": "string" }, "example": "60" } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ApiError" } } }, "headers": { "X-Helpspot-Request-Id": { "description": "Correlation ID matching error.request_id. Include it when contacting support.", "schema": { "type": "string" } } } }, "503": { "description": "Service Unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ApiError" } } }, "headers": { "X-Helpspot-Request-Id": { "description": "Correlation ID matching error.request_id. Include it when contacting support.", "schema": { "type": "string" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ApiError" } } }, "headers": { "X-Helpspot-Request-Id": { "description": "Correlation ID matching error.request_id. Include it when contacting support.", "schema": { "type": "string" } } } } }, "security": [ { "bearerAuth": [] }, { "basicAuth": [] } ] } }, "/knowledge-books": { "get": { "operationId": "v2.knowledge-books.index", "summary": "List knowledge books", "tags": [ "Knowledge base" ], "responses": { "200": { "description": "Knowledge-base resource. See the Knowledge base guide.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/KnowledgeBookResource" } } }, "required": [ "data" ] } }, "application/xml": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/KnowledgeBookResource" } } }, "required": [ "data" ] } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ApiError" } } }, "headers": { "X-Helpspot-Request-Id": { "description": "Correlation ID matching error.request_id. Include it when contacting support.", "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ApiError" } } }, "headers": { "X-Helpspot-Request-Id": { "description": "Correlation ID matching error.request_id. Include it when contacting support.", "schema": { "type": "string" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ApiError" } } }, "headers": { "X-Helpspot-Request-Id": { "description": "Correlation ID matching error.request_id. Include it when contacting support.", "schema": { "type": "string" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ApiError" } } }, "headers": { "X-Helpspot-Request-Id": { "description": "Correlation ID matching error.request_id. Include it when contacting support.", "schema": { "type": "string" } } } }, "405": { "description": "Method Not Allowed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ApiError" } } }, "headers": { "X-Helpspot-Request-Id": { "description": "Correlation ID matching error.request_id. Include it when contacting support.", "schema": { "type": "string" } } } }, "406": { "description": "Not Acceptable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } }, "headers": { "X-Helpspot-Request-Id": { "description": "Correlation ID matching error.request_id. Include it when contacting support.", "schema": { "type": "string" } } } }, "413": { "description": "Content Too Large", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ApiError" } } }, "headers": { "X-Helpspot-Request-Id": { "description": "Correlation ID matching error.request_id. Include it when contacting support.", "schema": { "type": "string" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ApiError" } } }, "headers": { "X-Helpspot-Request-Id": { "description": "Correlation ID matching error.request_id. Include it when contacting support.", "schema": { "type": "string" } }, "Retry-After": { "description": "Seconds to wait before retrying.", "schema": { "type": "string" }, "example": "60" } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ApiError" } } }, "headers": { "X-Helpspot-Request-Id": { "description": "Correlation ID matching error.request_id. Include it when contacting support.", "schema": { "type": "string" } } } }, "503": { "description": "Service Unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ApiError" } } }, "headers": { "X-Helpspot-Request-Id": { "description": "Correlation ID matching error.request_id. Include it when contacting support.", "schema": { "type": "string" } } } } }, "security": [ { "bearerAuth": [] }, { "basicAuth": [] } ] } }, "/knowledge-books/{book}/table-of-contents": { "get": { "operationId": "v2.knowledge-books.table-of-contents", "summary": "Retrieve a knowledge book's chapters and pages", "tags": [ "Knowledge base" ], "parameters": [ { "name": "book", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "include_page_html", "in": "query", "schema": { "type": "boolean" } } ], "responses": { "422": { "$ref": "#/components/responses/ValidationException" }, "200": { "description": "Knowledge-base resource. See the Knowledge base guide.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/KnowledgeChapterResource" } } }, "required": [ "data" ] } }, "application/xml": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/KnowledgeChapterResource" } } }, "required": [ "data" ] } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ApiError" } } }, "headers": { "X-Helpspot-Request-Id": { "description": "Correlation ID matching error.request_id. Include it when contacting support.", "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ApiError" } } }, "headers": { "X-Helpspot-Request-Id": { "description": "Correlation ID matching error.request_id. Include it when contacting support.", "schema": { "type": "string" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ApiError" } } }, "headers": { "X-Helpspot-Request-Id": { "description": "Correlation ID matching error.request_id. Include it when contacting support.", "schema": { "type": "string" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ApiError" } } }, "headers": { "X-Helpspot-Request-Id": { "description": "Correlation ID matching error.request_id. Include it when contacting support.", "schema": { "type": "string" } } } }, "405": { "description": "Method Not Allowed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ApiError" } } }, "headers": { "X-Helpspot-Request-Id": { "description": "Correlation ID matching error.request_id. Include it when contacting support.", "schema": { "type": "string" } } } }, "406": { "description": "Not Acceptable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } }, "headers": { "X-Helpspot-Request-Id": { "description": "Correlation ID matching error.request_id. Include it when contacting support.", "schema": { "type": "string" } } } }, "413": { "description": "Content Too Large", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ApiError" } } }, "headers": { "X-Helpspot-Request-Id": { "description": "Correlation ID matching error.request_id. Include it when contacting support.", "schema": { "type": "string" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ApiError" } } }, "headers": { "X-Helpspot-Request-Id": { "description": "Correlation ID matching error.request_id. Include it when contacting support.", "schema": { "type": "string" } }, "Retry-After": { "description": "Seconds to wait before retrying.", "schema": { "type": "string" }, "example": "60" } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ApiError" } } }, "headers": { "X-Helpspot-Request-Id": { "description": "Correlation ID matching error.request_id. Include it when contacting support.", "schema": { "type": "string" } } } }, "503": { "description": "Service Unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ApiError" } } }, "headers": { "X-Helpspot-Request-Id": { "description": "Correlation ID matching error.request_id. Include it when contacting support.", "schema": { "type": "string" } } } } }, "security": [ { "bearerAuth": [] }, { "basicAuth": [] } ] } }, "/knowledge-books/{book}": { "get": { "operationId": "v2.knowledge-books.show", "summary": "Retrieve a knowledge book", "tags": [ "Knowledge base" ], "parameters": [ { "name": "book", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Knowledge-base resource. See the Knowledge base guide.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/KnowledgeBookResource" } }, "required": [ "data" ] } }, "application/xml": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/KnowledgeBookResource" } }, "required": [ "data" ] } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ApiError" } } }, "headers": { "X-Helpspot-Request-Id": { "description": "Correlation ID matching error.request_id. Include it when contacting support.", "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ApiError" } } }, "headers": { "X-Helpspot-Request-Id": { "description": "Correlation ID matching error.request_id. Include it when contacting support.", "schema": { "type": "string" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ApiError" } } }, "headers": { "X-Helpspot-Request-Id": { "description": "Correlation ID matching error.request_id. Include it when contacting support.", "schema": { "type": "string" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ApiError" } } }, "headers": { "X-Helpspot-Request-Id": { "description": "Correlation ID matching error.request_id. Include it when contacting support.", "schema": { "type": "string" } } } }, "405": { "description": "Method Not Allowed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ApiError" } } }, "headers": { "X-Helpspot-Request-Id": { "description": "Correlation ID matching error.request_id. Include it when contacting support.", "schema": { "type": "string" } } } }, "406": { "description": "Not Acceptable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } }, "headers": { "X-Helpspot-Request-Id": { "description": "Correlation ID matching error.request_id. Include it when contacting support.", "schema": { "type": "string" } } } }, "413": { "description": "Content Too Large", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ApiError" } } }, "headers": { "X-Helpspot-Request-Id": { "description": "Correlation ID matching error.request_id. Include it when contacting support.", "schema": { "type": "string" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ApiError" } } }, "headers": { "X-Helpspot-Request-Id": { "description": "Correlation ID matching error.request_id. Include it when contacting support.", "schema": { "type": "string" } }, "Retry-After": { "description": "Seconds to wait before retrying.", "schema": { "type": "string" }, "example": "60" } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ApiError" } } }, "headers": { "X-Helpspot-Request-Id": { "description": "Correlation ID matching error.request_id. Include it when contacting support.", "schema": { "type": "string" } } } }, "503": { "description": "Service Unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ApiError" } } }, "headers": { "X-Helpspot-Request-Id": { "description": "Correlation ID matching error.request_id. Include it when contacting support.", "schema": { "type": "string" } } } } }, "security": [ { "bearerAuth": [] }, { "basicAuth": [] } ] } }, "/knowledge-pages": { "get": { "operationId": "v2.knowledge-pages.index", "summary": "Search knowledge pages", "tags": [ "Knowledge base" ], "parameters": [ { "name": "query", "in": "query", "required": true, "schema": { "type": "string", "maxLength": 500 } } ], "responses": { "422": { "$ref": "#/components/responses/ValidationException" }, "200": { "description": "Knowledge-base resource. See the Knowledge base guide.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/KnowledgeSearchResult" } } }, "required": [ "data" ] } }, "application/xml": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/KnowledgeSearchResult" } } }, "required": [ "data" ] } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ApiError" } } }, "headers": { "X-Helpspot-Request-Id": { "description": "Correlation ID matching error.request_id. Include it when contacting support.", "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ApiError" } } }, "headers": { "X-Helpspot-Request-Id": { "description": "Correlation ID matching error.request_id. Include it when contacting support.", "schema": { "type": "string" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ApiError" } } }, "headers": { "X-Helpspot-Request-Id": { "description": "Correlation ID matching error.request_id. Include it when contacting support.", "schema": { "type": "string" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ApiError" } } }, "headers": { "X-Helpspot-Request-Id": { "description": "Correlation ID matching error.request_id. Include it when contacting support.", "schema": { "type": "string" } } } }, "405": { "description": "Method Not Allowed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ApiError" } } }, "headers": { "X-Helpspot-Request-Id": { "description": "Correlation ID matching error.request_id. Include it when contacting support.", "schema": { "type": "string" } } } }, "406": { "description": "Not Acceptable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } }, "headers": { "X-Helpspot-Request-Id": { "description": "Correlation ID matching error.request_id. Include it when contacting support.", "schema": { "type": "string" } } } }, "413": { "description": "Content Too Large", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ApiError" } } }, "headers": { "X-Helpspot-Request-Id": { "description": "Correlation ID matching error.request_id. Include it when contacting support.", "schema": { "type": "string" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ApiError" } } }, "headers": { "X-Helpspot-Request-Id": { "description": "Correlation ID matching error.request_id. Include it when contacting support.", "schema": { "type": "string" } }, "Retry-After": { "description": "Seconds to wait before retrying.", "schema": { "type": "string" }, "example": "60" } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ApiError" } } }, "headers": { "X-Helpspot-Request-Id": { "description": "Correlation ID matching error.request_id. Include it when contacting support.", "schema": { "type": "string" } } } }, "503": { "description": "Service Unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ApiError" } } }, "headers": { "X-Helpspot-Request-Id": { "description": "Correlation ID matching error.request_id. Include it when contacting support.", "schema": { "type": "string" } } } } }, "security": [ { "bearerAuth": [] }, { "basicAuth": [] } ] } }, "/knowledge-pages/{page}": { "get": { "operationId": "v2.knowledge-pages.show", "summary": "Retrieve a knowledge page", "tags": [ "Knowledge base" ], "parameters": [ { "name": "page", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Knowledge-base resource. See the Knowledge base guide.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/KnowledgePageResource" } }, "required": [ "data" ] } }, "application/xml": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/KnowledgePageResource" } }, "required": [ "data" ] } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ApiError" } } }, "headers": { "X-Helpspot-Request-Id": { "description": "Correlation ID matching error.request_id. Include it when contacting support.", "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ApiError" } } }, "headers": { "X-Helpspot-Request-Id": { "description": "Correlation ID matching error.request_id. Include it when contacting support.", "schema": { "type": "string" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ApiError" } } }, "headers": { "X-Helpspot-Request-Id": { "description": "Correlation ID matching error.request_id. Include it when contacting support.", "schema": { "type": "string" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ApiError" } } }, "headers": { "X-Helpspot-Request-Id": { "description": "Correlation ID matching error.request_id. Include it when contacting support.", "schema": { "type": "string" } } } }, "405": { "description": "Method Not Allowed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ApiError" } } }, "headers": { "X-Helpspot-Request-Id": { "description": "Correlation ID matching error.request_id. Include it when contacting support.", "schema": { "type": "string" } } } }, "406": { "description": "Not Acceptable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } }, "headers": { "X-Helpspot-Request-Id": { "description": "Correlation ID matching error.request_id. Include it when contacting support.", "schema": { "type": "string" } } } }, "413": { "description": "Content Too Large", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ApiError" } } }, "headers": { "X-Helpspot-Request-Id": { "description": "Correlation ID matching error.request_id. Include it when contacting support.", "schema": { "type": "string" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ApiError" } } }, "headers": { "X-Helpspot-Request-Id": { "description": "Correlation ID matching error.request_id. Include it when contacting support.", "schema": { "type": "string" } }, "Retry-After": { "description": "Seconds to wait before retrying.", "schema": { "type": "string" }, "example": "60" } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ApiError" } } }, "headers": { "X-Helpspot-Request-Id": { "description": "Correlation ID matching error.request_id. Include it when contacting support.", "schema": { "type": "string" } } } }, "503": { "description": "Service Unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ApiError" } } }, "headers": { "X-Helpspot-Request-Id": { "description": "Correlation ID matching error.request_id. Include it when contacting support.", "schema": { "type": "string" } } } } }, "security": [ { "bearerAuth": [] }, { "basicAuth": [] } ] } }, "/knowledge-pages/{page}/helpful-votes": { "post": { "operationId": "v2.knowledge-pages.helpful-votes.store", "summary": "Record a helpful vote for a knowledge page", "tags": [ "Knowledge base" ], "parameters": [ { "name": "page", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Operation result.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "helpful_count": { "type": "integer" } }, "required": [ "helpful_count" ] } }, "required": [ "data" ] } }, "application/xml": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "helpful_count": { "type": "integer" } }, "required": [ "helpful_count" ] } }, "required": [ "data" ] } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ApiError" } } }, "headers": { "X-Helpspot-Request-Id": { "description": "Correlation ID matching error.request_id. Include it when contacting support.", "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ApiError" } } }, "headers": { "X-Helpspot-Request-Id": { "description": "Correlation ID matching error.request_id. Include it when contacting support.", "schema": { "type": "string" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ApiError" } } }, "headers": { "X-Helpspot-Request-Id": { "description": "Correlation ID matching error.request_id. Include it when contacting support.", "schema": { "type": "string" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ApiError" } } }, "headers": { "X-Helpspot-Request-Id": { "description": "Correlation ID matching error.request_id. Include it when contacting support.", "schema": { "type": "string" } } } }, "405": { "description": "Method Not Allowed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ApiError" } } }, "headers": { "X-Helpspot-Request-Id": { "description": "Correlation ID matching error.request_id. Include it when contacting support.", "schema": { "type": "string" } } } }, "406": { "description": "Not Acceptable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } }, "headers": { "X-Helpspot-Request-Id": { "description": "Correlation ID matching error.request_id. Include it when contacting support.", "schema": { "type": "string" } } } }, "413": { "description": "Content Too Large", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ApiError" } } }, "headers": { "X-Helpspot-Request-Id": { "description": "Correlation ID matching error.request_id. Include it when contacting support.", "schema": { "type": "string" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ApiError" } } }, "headers": { "X-Helpspot-Request-Id": { "description": "Correlation ID matching error.request_id. Include it when contacting support.", "schema": { "type": "string" } }, "Retry-After": { "description": "Seconds to wait before retrying.", "schema": { "type": "string" }, "example": "60" } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ApiError" } } }, "headers": { "X-Helpspot-Request-Id": { "description": "Correlation ID matching error.request_id. Include it when contacting support.", "schema": { "type": "string" } } } }, "503": { "description": "Service Unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ApiError" } } }, "headers": { "X-Helpspot-Request-Id": { "description": "Correlation ID matching error.request_id. Include it when contacting support.", "schema": { "type": "string" } } } } }, "security": [ { "bearerAuth": [] }, { "basicAuth": [] } ] } }, "/knowledge-pages/{page}/unhelpful-votes": { "post": { "operationId": "v2.knowledge-pages.unhelpful-votes.store", "summary": "Record an unhelpful vote for a knowledge page", "tags": [ "Knowledge base" ], "parameters": [ { "name": "page", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Operation result.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "unhelpful_count": { "type": "integer" } }, "required": [ "unhelpful_count" ] } }, "required": [ "data" ] } }, "application/xml": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "unhelpful_count": { "type": "integer" } }, "required": [ "unhelpful_count" ] } }, "required": [ "data" ] } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ApiError" } } }, "headers": { "X-Helpspot-Request-Id": { "description": "Correlation ID matching error.request_id. Include it when contacting support.", "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ApiError" } } }, "headers": { "X-Helpspot-Request-Id": { "description": "Correlation ID matching error.request_id. Include it when contacting support.", "schema": { "type": "string" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ApiError" } } }, "headers": { "X-Helpspot-Request-Id": { "description": "Correlation ID matching error.request_id. Include it when contacting support.", "schema": { "type": "string" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ApiError" } } }, "headers": { "X-Helpspot-Request-Id": { "description": "Correlation ID matching error.request_id. Include it when contacting support.", "schema": { "type": "string" } } } }, "405": { "description": "Method Not Allowed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ApiError" } } }, "headers": { "X-Helpspot-Request-Id": { "description": "Correlation ID matching error.request_id. Include it when contacting support.", "schema": { "type": "string" } } } }, "406": { "description": "Not Acceptable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } }, "headers": { "X-Helpspot-Request-Id": { "description": "Correlation ID matching error.request_id. Include it when contacting support.", "schema": { "type": "string" } } } }, "413": { "description": "Content Too Large", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ApiError" } } }, "headers": { "X-Helpspot-Request-Id": { "description": "Correlation ID matching error.request_id. Include it when contacting support.", "schema": { "type": "string" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ApiError" } } }, "headers": { "X-Helpspot-Request-Id": { "description": "Correlation ID matching error.request_id. Include it when contacting support.", "schema": { "type": "string" } }, "Retry-After": { "description": "Seconds to wait before retrying.", "schema": { "type": "string" }, "example": "60" } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ApiError" } } }, "headers": { "X-Helpspot-Request-Id": { "description": "Correlation ID matching error.request_id. Include it when contacting support.", "schema": { "type": "string" } } } }, "503": { "description": "Service Unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ApiError" } } }, "headers": { "X-Helpspot-Request-Id": { "description": "Correlation ID matching error.request_id. Include it when contacting support.", "schema": { "type": "string" } } } } }, "security": [ { "bearerAuth": [] }, { "basicAuth": [] } ] } }, "/categories": { "get": { "operationId": "v2.categories.index", "summary": "List request categories and their assignment metadata", "tags": [ "Lookups" ], "responses": { "200": { "description": "Unpaginated lookup collection. See this resource group for field definitions.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/CategoryResource" } } }, "required": [ "data" ] } }, "application/xml": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/CategoryResource" } } }, "required": [ "data" ] } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ApiError" } } }, "headers": { "X-Helpspot-Request-Id": { "description": "Correlation ID matching error.request_id. Include it when contacting support.", "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ApiError" } } }, "headers": { "X-Helpspot-Request-Id": { "description": "Correlation ID matching error.request_id. Include it when contacting support.", "schema": { "type": "string" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ApiError" } } }, "headers": { "X-Helpspot-Request-Id": { "description": "Correlation ID matching error.request_id. Include it when contacting support.", "schema": { "type": "string" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ApiError" } } }, "headers": { "X-Helpspot-Request-Id": { "description": "Correlation ID matching error.request_id. Include it when contacting support.", "schema": { "type": "string" } } } }, "405": { "description": "Method Not Allowed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ApiError" } } }, "headers": { "X-Helpspot-Request-Id": { "description": "Correlation ID matching error.request_id. Include it when contacting support.", "schema": { "type": "string" } } } }, "406": { "description": "Not Acceptable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } }, "headers": { "X-Helpspot-Request-Id": { "description": "Correlation ID matching error.request_id. Include it when contacting support.", "schema": { "type": "string" } } } }, "413": { "description": "Content Too Large", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ApiError" } } }, "headers": { "X-Helpspot-Request-Id": { "description": "Correlation ID matching error.request_id. Include it when contacting support.", "schema": { "type": "string" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ApiError" } } }, "headers": { "X-Helpspot-Request-Id": { "description": "Correlation ID matching error.request_id. Include it when contacting support.", "schema": { "type": "string" } }, "Retry-After": { "description": "Seconds to wait before retrying.", "schema": { "type": "string" }, "example": "60" } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ApiError" } } }, "headers": { "X-Helpspot-Request-Id": { "description": "Correlation ID matching error.request_id. Include it when contacting support.", "schema": { "type": "string" } } } }, "503": { "description": "Service Unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ApiError" } } }, "headers": { "X-Helpspot-Request-Id": { "description": "Correlation ID matching error.request_id. Include it when contacting support.", "schema": { "type": "string" } } } } }, "security": [ { "bearerAuth": [] }, { "basicAuth": [] } ] } }, "/mailboxes": { "get": { "operationId": "v2.mailboxes.index", "summary": "List mailboxes", "tags": [ "Lookups" ], "parameters": [ { "name": "include_inactive", "in": "query", "schema": { "type": "boolean" } } ], "responses": { "422": { "$ref": "#/components/responses/ValidationException" }, "200": { "description": "Unpaginated lookup collection. See this resource group for field definitions.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/MailboxResource" } } }, "required": [ "data" ] } }, "application/xml": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/MailboxResource" } } }, "required": [ "data" ] } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ApiError" } } }, "headers": { "X-Helpspot-Request-Id": { "description": "Correlation ID matching error.request_id. Include it when contacting support.", "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ApiError" } } }, "headers": { "X-Helpspot-Request-Id": { "description": "Correlation ID matching error.request_id. Include it when contacting support.", "schema": { "type": "string" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ApiError" } } }, "headers": { "X-Helpspot-Request-Id": { "description": "Correlation ID matching error.request_id. Include it when contacting support.", "schema": { "type": "string" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ApiError" } } }, "headers": { "X-Helpspot-Request-Id": { "description": "Correlation ID matching error.request_id. Include it when contacting support.", "schema": { "type": "string" } } } }, "405": { "description": "Method Not Allowed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ApiError" } } }, "headers": { "X-Helpspot-Request-Id": { "description": "Correlation ID matching error.request_id. Include it when contacting support.", "schema": { "type": "string" } } } }, "406": { "description": "Not Acceptable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } }, "headers": { "X-Helpspot-Request-Id": { "description": "Correlation ID matching error.request_id. Include it when contacting support.", "schema": { "type": "string" } } } }, "413": { "description": "Content Too Large", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ApiError" } } }, "headers": { "X-Helpspot-Request-Id": { "description": "Correlation ID matching error.request_id. Include it when contacting support.", "schema": { "type": "string" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ApiError" } } }, "headers": { "X-Helpspot-Request-Id": { "description": "Correlation ID matching error.request_id. Include it when contacting support.", "schema": { "type": "string" } }, "Retry-After": { "description": "Seconds to wait before retrying.", "schema": { "type": "string" }, "example": "60" } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ApiError" } } }, "headers": { "X-Helpspot-Request-Id": { "description": "Correlation ID matching error.request_id. Include it when contacting support.", "schema": { "type": "string" } } } }, "503": { "description": "Service Unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ApiError" } } }, "headers": { "X-Helpspot-Request-Id": { "description": "Correlation ID matching error.request_id. Include it when contacting support.", "schema": { "type": "string" } } } } }, "security": [ { "bearerAuth": [] }, { "basicAuth": [] } ] } }, "/request-statuses": { "get": { "operationId": "v2.request-statuses.index", "summary": "List request statuses", "tags": [ "Lookups" ], "parameters": [ { "name": "include_inactive", "in": "query", "schema": { "type": "boolean" } } ], "responses": { "422": { "$ref": "#/components/responses/ValidationException" }, "200": { "description": "Unpaginated lookup collection. See this resource group for field definitions.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/StatusResource" } } }, "required": [ "data" ] } }, "application/xml": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/StatusResource" } } }, "required": [ "data" ] } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ApiError" } } }, "headers": { "X-Helpspot-Request-Id": { "description": "Correlation ID matching error.request_id. Include it when contacting support.", "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ApiError" } } }, "headers": { "X-Helpspot-Request-Id": { "description": "Correlation ID matching error.request_id. Include it when contacting support.", "schema": { "type": "string" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ApiError" } } }, "headers": { "X-Helpspot-Request-Id": { "description": "Correlation ID matching error.request_id. Include it when contacting support.", "schema": { "type": "string" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ApiError" } } }, "headers": { "X-Helpspot-Request-Id": { "description": "Correlation ID matching error.request_id. Include it when contacting support.", "schema": { "type": "string" } } } }, "405": { "description": "Method Not Allowed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ApiError" } } }, "headers": { "X-Helpspot-Request-Id": { "description": "Correlation ID matching error.request_id. Include it when contacting support.", "schema": { "type": "string" } } } }, "406": { "description": "Not Acceptable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } }, "headers": { "X-Helpspot-Request-Id": { "description": "Correlation ID matching error.request_id. Include it when contacting support.", "schema": { "type": "string" } } } }, "413": { "description": "Content Too Large", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ApiError" } } }, "headers": { "X-Helpspot-Request-Id": { "description": "Correlation ID matching error.request_id. Include it when contacting support.", "schema": { "type": "string" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ApiError" } } }, "headers": { "X-Helpspot-Request-Id": { "description": "Correlation ID matching error.request_id. Include it when contacting support.", "schema": { "type": "string" } }, "Retry-After": { "description": "Seconds to wait before retrying.", "schema": { "type": "string" }, "example": "60" } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ApiError" } } }, "headers": { "X-Helpspot-Request-Id": { "description": "Correlation ID matching error.request_id. Include it when contacting support.", "schema": { "type": "string" } } } }, "503": { "description": "Service Unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ApiError" } } }, "headers": { "X-Helpspot-Request-Id": { "description": "Correlation ID matching error.request_id. Include it when contacting support.", "schema": { "type": "string" } } } } }, "security": [ { "bearerAuth": [] }, { "basicAuth": [] } ] } }, "/custom-fields": { "get": { "operationId": "v2.custom-fields.index", "summary": "List request custom fields, optionally scoped to a category", "tags": [ "Custom fields" ], "parameters": [ { "name": "category_id", "in": "query", "schema": { "type": "integer", "minimum": 1 } } ], "responses": { "404": { "$ref": "#/components/responses/ModelNotFoundException" }, "422": { "$ref": "#/components/responses/ValidationException" }, "200": { "description": "Unpaginated lookup collection. See this resource group for field definitions.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/CustomFieldResource" } } }, "required": [ "data" ] } }, "application/xml": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/CustomFieldResource" } } }, "required": [ "data" ] } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ApiError" } } }, "headers": { "X-Helpspot-Request-Id": { "description": "Correlation ID matching error.request_id. Include it when contacting support.", "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ApiError" } } }, "headers": { "X-Helpspot-Request-Id": { "description": "Correlation ID matching error.request_id. Include it when contacting support.", "schema": { "type": "string" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ApiError" } } }, "headers": { "X-Helpspot-Request-Id": { "description": "Correlation ID matching error.request_id. Include it when contacting support.", "schema": { "type": "string" } } } }, "405": { "description": "Method Not Allowed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ApiError" } } }, "headers": { "X-Helpspot-Request-Id": { "description": "Correlation ID matching error.request_id. Include it when contacting support.", "schema": { "type": "string" } } } }, "406": { "description": "Not Acceptable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } }, "headers": { "X-Helpspot-Request-Id": { "description": "Correlation ID matching error.request_id. Include it when contacting support.", "schema": { "type": "string" } } } }, "413": { "description": "Content Too Large", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ApiError" } } }, "headers": { "X-Helpspot-Request-Id": { "description": "Correlation ID matching error.request_id. Include it when contacting support.", "schema": { "type": "string" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ApiError" } } }, "headers": { "X-Helpspot-Request-Id": { "description": "Correlation ID matching error.request_id. Include it when contacting support.", "schema": { "type": "string" } }, "Retry-After": { "description": "Seconds to wait before retrying.", "schema": { "type": "string" }, "example": "60" } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ApiError" } } }, "headers": { "X-Helpspot-Request-Id": { "description": "Correlation ID matching error.request_id. Include it when contacting support.", "schema": { "type": "string" } } } }, "503": { "description": "Service Unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ApiError" } } }, "headers": { "X-Helpspot-Request-Id": { "description": "Correlation ID matching error.request_id. Include it when contacting support.", "schema": { "type": "string" } } } } }, "security": [ { "bearerAuth": [] }, { "basicAuth": [] } ] } }, "/request-field-labels": { "get": { "operationId": "v2.request-field-labels.index", "summary": "List request field labels", "tags": [ "Lookups" ], "responses": { "200": { "description": "A map of original request field identifiers to display labels, including configured custom fields. An empty JSON map is {}.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "additionalProperties": { "type": "string" } } }, "required": [ "data" ] } }, "application/xml": { "schema": { "type": "object", "properties": { "data": { "type": "object", "additionalProperties": { "type": "string" } } }, "required": [ "data" ] } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ApiError" } } }, "headers": { "X-Helpspot-Request-Id": { "description": "Correlation ID matching error.request_id. Include it when contacting support.", "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ApiError" } } }, "headers": { "X-Helpspot-Request-Id": { "description": "Correlation ID matching error.request_id. Include it when contacting support.", "schema": { "type": "string" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ApiError" } } }, "headers": { "X-Helpspot-Request-Id": { "description": "Correlation ID matching error.request_id. Include it when contacting support.", "schema": { "type": "string" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ApiError" } } }, "headers": { "X-Helpspot-Request-Id": { "description": "Correlation ID matching error.request_id. Include it when contacting support.", "schema": { "type": "string" } } } }, "405": { "description": "Method Not Allowed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ApiError" } } }, "headers": { "X-Helpspot-Request-Id": { "description": "Correlation ID matching error.request_id. Include it when contacting support.", "schema": { "type": "string" } } } }, "406": { "description": "Not Acceptable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } }, "headers": { "X-Helpspot-Request-Id": { "description": "Correlation ID matching error.request_id. Include it when contacting support.", "schema": { "type": "string" } } } }, "413": { "description": "Content Too Large", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ApiError" } } }, "headers": { "X-Helpspot-Request-Id": { "description": "Correlation ID matching error.request_id. Include it when contacting support.", "schema": { "type": "string" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ApiError" } } }, "headers": { "X-Helpspot-Request-Id": { "description": "Correlation ID matching error.request_id. Include it when contacting support.", "schema": { "type": "string" } }, "Retry-After": { "description": "Seconds to wait before retrying.", "schema": { "type": "string" }, "example": "60" } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ApiError" } } }, "headers": { "X-Helpspot-Request-Id": { "description": "Correlation ID matching error.request_id. Include it when contacting support.", "schema": { "type": "string" } } } }, "503": { "description": "Service Unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ApiError" } } }, "headers": { "X-Helpspot-Request-Id": { "description": "Correlation ID matching error.request_id. Include it when contacting support.", "schema": { "type": "string" } } } } }, "security": [ { "bearerAuth": [] }, { "basicAuth": [] } ] } }, "/reports/{report}/results": { "get": { "operationId": "v2.reports.results.show", "summary": "Run a saved report, optionally overriding its date range", "tags": [ "Report" ], "parameters": [ { "name": "report", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "from", "in": "query", "schema": { "type": "string", "format": "date" } }, { "name": "to", "in": "query", "schema": { "type": "string", "format": "date" } } ], "responses": { "403": { "$ref": "#/components/responses/AuthorizationException" }, "422": { "$ref": "#/components/responses/ValidationException" }, "200": { "description": "Saved report results. data contains list rows, series, a matrix, or fallback label/value pairs depending on the saved report. Values and report-specific metadata retain their report-defined types. date_range uses inclusive from and exclusive to Unix seconds in the reported timezone.", "content": { "application/json": { "schema": { "type": "object", "properties": { "metadata": { "type": "object", "properties": { "report_name": { "type": "string" }, "timezone": { "type": "string" }, "date_range": { "type": "object", "properties": { "from": { "type": "integer" }, "to": { "type": "integer" } }, "required": [ "from", "to" ] } }, "required": [ "report_name", "timezone", "date_range" ], "additionalProperties": {} }, "data": { "anyOf": [ { "type": "array", "items": { "type": "array", "items": { "type": "object", "properties": { "column_type": { "type": [ "string", "null" ] }, "column_label": { "type": [ "string", "null" ] }, "value": {} }, "required": [ "column_type", "column_label", "value" ] } } }, { "type": "array", "items": { "type": "object", "properties": { "meta": { "anyOf": [ { "type": "object", "additionalProperties": {} }, { "type": "array", "items": { "type": "string" } } ] }, "datapoints": { "type": "array", "items": { "type": "object", "properties": { "label": {}, "value": {} }, "required": [ "label", "value" ] } } }, "required": [ "meta", "datapoints" ] } }, { "type": "object", "properties": { "x_axis_type": { "type": "string" }, "y_axis_type": { "type": "string" }, "x_axis_totals": { "type": "array", "items": { "type": "object", "properties": { "label": {}, "value": {} }, "required": [ "label", "value" ] } }, "y_axis_totals": { "type": "array", "items": { "type": "object", "properties": { "label": {}, "value": {} }, "required": [ "label", "value" ] } }, "datapoints": { "type": "array", "items": { "type": "object", "properties": { "x_axis_label": {}, "y_axis_label": {}, "value": {} }, "required": [ "x_axis_label", "y_axis_label", "value" ] } } }, "required": [ "x_axis_type", "y_axis_type", "x_axis_totals", "y_axis_totals", "datapoints" ] }, { "type": "array", "items": { "type": "object", "properties": { "label": {}, "value": {} }, "required": [ "label", "value" ] } } ] } }, "required": [ "metadata", "data" ] } }, "application/xml": { "schema": { "type": "object", "properties": { "metadata": { "type": "object", "properties": { "report_name": { "type": "string" }, "timezone": { "type": "string" }, "date_range": { "type": "object", "properties": { "from": { "type": "integer" }, "to": { "type": "integer" } }, "required": [ "from", "to" ] } }, "required": [ "report_name", "timezone", "date_range" ], "additionalProperties": {} }, "data": { "anyOf": [ { "type": "array", "items": { "type": "array", "items": { "type": "object", "properties": { "column_type": { "type": [ "string", "null" ] }, "column_label": { "type": [ "string", "null" ] }, "value": {} }, "required": [ "column_type", "column_label", "value" ] } } }, { "type": "array", "items": { "type": "object", "properties": { "meta": { "anyOf": [ { "type": "object", "additionalProperties": {} }, { "type": "array", "items": { "type": "string" } } ] }, "datapoints": { "type": "array", "items": { "type": "object", "properties": { "label": {}, "value": {} }, "required": [ "label", "value" ] } } }, "required": [ "meta", "datapoints" ] } }, { "type": "object", "properties": { "x_axis_type": { "type": "string" }, "y_axis_type": { "type": "string" }, "x_axis_totals": { "type": "array", "items": { "type": "object", "properties": { "label": {}, "value": {} }, "required": [ "label", "value" ] } }, "y_axis_totals": { "type": "array", "items": { "type": "object", "properties": { "label": {}, "value": {} }, "required": [ "label", "value" ] } }, "datapoints": { "type": "array", "items": { "type": "object", "properties": { "x_axis_label": {}, "y_axis_label": {}, "value": {} }, "required": [ "x_axis_label", "y_axis_label", "value" ] } } }, "required": [ "x_axis_type", "y_axis_type", "x_axis_totals", "y_axis_totals", "datapoints" ] }, { "type": "array", "items": { "type": "object", "properties": { "label": {}, "value": {} }, "required": [ "label", "value" ] } } ] } }, "required": [ "metadata", "data" ] } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ApiError" } } }, "headers": { "X-Helpspot-Request-Id": { "description": "Correlation ID matching error.request_id. Include it when contacting support.", "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ApiError" } } }, "headers": { "X-Helpspot-Request-Id": { "description": "Correlation ID matching error.request_id. Include it when contacting support.", "schema": { "type": "string" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ApiError" } } }, "headers": { "X-Helpspot-Request-Id": { "description": "Correlation ID matching error.request_id. Include it when contacting support.", "schema": { "type": "string" } } } }, "405": { "description": "Method Not Allowed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ApiError" } } }, "headers": { "X-Helpspot-Request-Id": { "description": "Correlation ID matching error.request_id. Include it when contacting support.", "schema": { "type": "string" } } } }, "406": { "description": "Not Acceptable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } }, "headers": { "X-Helpspot-Request-Id": { "description": "Correlation ID matching error.request_id. Include it when contacting support.", "schema": { "type": "string" } } } }, "413": { "description": "Content Too Large", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ApiError" } } }, "headers": { "X-Helpspot-Request-Id": { "description": "Correlation ID matching error.request_id. Include it when contacting support.", "schema": { "type": "string" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ApiError" } } }, "headers": { "X-Helpspot-Request-Id": { "description": "Correlation ID matching error.request_id. Include it when contacting support.", "schema": { "type": "string" } }, "Retry-After": { "description": "Seconds to wait before retrying.", "schema": { "type": "string" }, "example": "60" } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ApiError" } } }, "headers": { "X-Helpspot-Request-Id": { "description": "Correlation ID matching error.request_id. Include it when contacting support.", "schema": { "type": "string" } } } }, "503": { "description": "Service Unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ApiError" } } }, "headers": { "X-Helpspot-Request-Id": { "description": "Correlation ID matching error.request_id. Include it when contacting support.", "schema": { "type": "string" } } } } }, "security": [ { "bearerAuth": [] }, { "basicAuth": [] } ] } }, "/requests/search": { "get": { "operationId": "v2.requests.search", "description": "Omit `reporting_tags` to search without a tag filter. When supplied, it must contain 1\u2013100 distinct tag names; an empty array returns 422.", "summary": "Search requests using customer, assignment, date, status, and custom-field filters", "tags": [ "Requests" ], "parameters": [ { "name": "query", "in": "query", "schema": { "type": "string", "maxLength": 500 } }, { "name": "match", "in": "query", "schema": { "type": "string", "enum": [ "any", "all" ] } }, { "name": "request_id", "in": "query", "schema": { "type": "integer", "minimum": 1 } }, { "name": "customer_id", "in": "query", "schema": { "type": "string", "maxLength": 255 } }, { "name": "first_name", "in": "query", "schema": { "type": "string", "maxLength": 100 } }, { "name": "last_name", "in": "query", "schema": { "type": "string", "maxLength": 100 } }, { "name": "email", "in": "query", "schema": { "type": "string", "format": "email", "maxLength": 100 } }, { "name": "phone", "in": "query", "schema": { "type": "string", "maxLength": 100 } }, { "name": "open", "in": "query", "schema": { "type": "boolean" } }, { "name": "category_id", "in": "query", "schema": { "type": "integer", "minimum": 0 } }, { "name": "assigned_staff_id", "in": "query", "schema": { "type": "integer", "minimum": 0 } }, { "name": "status_id", "in": "query", "schema": { "type": "integer", "minimum": 0 } }, { "name": "reporting_tags[]", "in": "query", "schema": { "type": "array", "items": { "type": "string", "maxLength": 255 } } }, { "name": "custom_fields[]", "in": "query", "schema": { "type": "array", "items": { "type": "string" }, "maxItems": 100 } }, { "name": "before_date", "in": "query", "schema": { "type": "integer", "minimum": 0 } }, { "name": "after_date", "in": "query", "schema": { "type": "integer", "minimum": 0 } }, { "name": "closed_before_date", "in": "query", "schema": { "type": "integer", "minimum": 0 } }, { "name": "closed_after_date", "in": "query", "schema": { "type": "integer", "minimum": 0 } }, { "name": "relative_date", "in": "query", "schema": { "type": "string", "enum": [ "today", "tomorrow", "yesterday", "past_7", "past_14", "past_30", "past_60", "past_90", "past_365", "this_week", "this_month", "this_year", "last_week", "last_month", "last_year", "next_7", "next_14", "next_30", "next_90", "next_365", "next_week", "next_month", "next_year", "date_is_set", "date_is_not_set" ] } }, { "name": "order_by", "in": "query", "schema": { "type": "string" } }, { "name": "direction", "in": "query", "schema": { "type": "string", "enum": [ "asc", "desc" ] } }, { "name": "offset", "in": "query", "schema": { "type": "integer", "minimum": 0 } }, { "name": "per_page", "in": "query", "schema": { "type": "integer", "minimum": 1, "maximum": 100 } }, { "name": "include_time_total", "in": "query", "schema": { "type": "boolean" } } ], "responses": { "422": { "$ref": "#/components/responses/ValidationException" }, "200": { "description": "Request resource. Fields depend on visibility and endpoint; see the Requests guide.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/RequestResource" } }, "meta": { "type": "object", "properties": { "offset": { "type": "integer" }, "per_page": { "type": "integer" }, "count": { "type": "integer" }, "has_more": { "type": "boolean" }, "next_offset": { "type": [ "integer", "null" ] } }, "required": [ "offset", "per_page", "count", "has_more", "next_offset" ] } }, "required": [ "data" ] } }, "application/xml": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/RequestResource" } }, "meta": { "type": "object", "properties": { "offset": { "type": "integer" }, "per_page": { "type": "integer" }, "count": { "type": "integer" }, "has_more": { "type": "boolean" }, "next_offset": { "type": [ "integer", "null" ] } }, "required": [ "offset", "per_page", "count", "has_more", "next_offset" ] } }, "required": [ "data" ] } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ApiError" } } }, "headers": { "X-Helpspot-Request-Id": { "description": "Correlation ID matching error.request_id. Include it when contacting support.", "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ApiError" } } }, "headers": { "X-Helpspot-Request-Id": { "description": "Correlation ID matching error.request_id. Include it when contacting support.", "schema": { "type": "string" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ApiError" } } }, "headers": { "X-Helpspot-Request-Id": { "description": "Correlation ID matching error.request_id. Include it when contacting support.", "schema": { "type": "string" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ApiError" } } }, "headers": { "X-Helpspot-Request-Id": { "description": "Correlation ID matching error.request_id. Include it when contacting support.", "schema": { "type": "string" } } } }, "405": { "description": "Method Not Allowed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ApiError" } } }, "headers": { "X-Helpspot-Request-Id": { "description": "Correlation ID matching error.request_id. Include it when contacting support.", "schema": { "type": "string" } } } }, "406": { "description": "Not Acceptable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } }, "headers": { "X-Helpspot-Request-Id": { "description": "Correlation ID matching error.request_id. Include it when contacting support.", "schema": { "type": "string" } } } }, "413": { "description": "Content Too Large", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ApiError" } } }, "headers": { "X-Helpspot-Request-Id": { "description": "Correlation ID matching error.request_id. Include it when contacting support.", "schema": { "type": "string" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ApiError" } } }, "headers": { "X-Helpspot-Request-Id": { "description": "Correlation ID matching error.request_id. Include it when contacting support.", "schema": { "type": "string" } }, "Retry-After": { "description": "Seconds to wait before retrying.", "schema": { "type": "string" }, "example": "60" } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ApiError" } } }, "headers": { "X-Helpspot-Request-Id": { "description": "Correlation ID matching error.request_id. Include it when contacting support.", "schema": { "type": "string" } } } }, "503": { "description": "Service Unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ApiError" } } }, "headers": { "X-Helpspot-Request-Id": { "description": "Correlation ID matching error.request_id. Include it when contacting support.", "schema": { "type": "string" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ApiError" } } }, "headers": { "X-Helpspot-Request-Id": { "description": "Correlation ID matching error.request_id. Include it when contacting support.", "schema": { "type": "string" } } } } }, "security": [ { "bearerAuth": [] }, { "basicAuth": [] } ] } }, "/requests/changes": { "get": { "operationId": "v2.requests.changes", "summary": "List request IDs changed after a Unix timestamp", "tags": [ "Requests" ], "parameters": [ { "name": "after", "in": "query", "required": true, "schema": { "type": "integer", "minimum": 0 } } ], "responses": { "422": { "$ref": "#/components/responses/ValidationException" }, "200": { "description": "Unique accessible request IDs in ascending numeric order. Unpaginated; after is an exclusive Unix-second boundary, not a cursor or snapshot.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "integer" } } }, "required": [ "data" ] } }, "application/xml": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "integer" } } }, "required": [ "data" ] } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ApiError" } } }, "headers": { "X-Helpspot-Request-Id": { "description": "Correlation ID matching error.request_id. Include it when contacting support.", "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ApiError" } } }, "headers": { "X-Helpspot-Request-Id": { "description": "Correlation ID matching error.request_id. Include it when contacting support.", "schema": { "type": "string" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ApiError" } } }, "headers": { "X-Helpspot-Request-Id": { "description": "Correlation ID matching error.request_id. Include it when contacting support.", "schema": { "type": "string" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ApiError" } } }, "headers": { "X-Helpspot-Request-Id": { "description": "Correlation ID matching error.request_id. Include it when contacting support.", "schema": { "type": "string" } } } }, "405": { "description": "Method Not Allowed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ApiError" } } }, "headers": { "X-Helpspot-Request-Id": { "description": "Correlation ID matching error.request_id. Include it when contacting support.", "schema": { "type": "string" } } } }, "406": { "description": "Not Acceptable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } }, "headers": { "X-Helpspot-Request-Id": { "description": "Correlation ID matching error.request_id. Include it when contacting support.", "schema": { "type": "string" } } } }, "413": { "description": "Content Too Large", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ApiError" } } }, "headers": { "X-Helpspot-Request-Id": { "description": "Correlation ID matching error.request_id. Include it when contacting support.", "schema": { "type": "string" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ApiError" } } }, "headers": { "X-Helpspot-Request-Id": { "description": "Correlation ID matching error.request_id. Include it when contacting support.", "schema": { "type": "string" } }, "Retry-After": { "description": "Seconds to wait before retrying.", "schema": { "type": "string" }, "example": "60" } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ApiError" } } }, "headers": { "X-Helpspot-Request-Id": { "description": "Correlation ID matching error.request_id. Include it when contacting support.", "schema": { "type": "string" } } } }, "503": { "description": "Service Unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ApiError" } } }, "headers": { "X-Helpspot-Request-Id": { "description": "Correlation ID matching error.request_id. Include it when contacting support.", "schema": { "type": "string" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ApiError" } } }, "headers": { "X-Helpspot-Request-Id": { "description": "Correlation ID matching error.request_id. Include it when contacting support.", "schema": { "type": "string" } } } } }, "security": [ { "bearerAuth": [] }, { "basicAuth": [] } ] } }, "/requests": { "get": { "operationId": "v2.requests.index", "summary": "List requests, or retrieve several requests by ID", "tags": [ "Requests" ], "parameters": [ { "name": "request_ids[]", "in": "query", "schema": { "type": "array", "items": { "type": "integer", "minimum": 1, "maximum": 2147483647 } } }, { "name": "offset", "in": "query", "schema": { "type": "integer", "minimum": 0 } }, { "name": "per_page", "in": "query", "schema": { "type": "integer", "minimum": 1, "maximum": 100 } }, { "name": "direction", "in": "query", "schema": { "type": "string", "enum": [ "asc", "desc" ] } }, { "name": "inline_images", "in": "query", "schema": { "type": "boolean" } }, { "name": "include_time_total", "in": "query", "schema": { "type": "boolean" } } ], "responses": { "422": { "$ref": "#/components/responses/ValidationException" }, "200": { "description": "Request resource. Fields depend on visibility and endpoint; see the Requests guide.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/RequestResource" } }, "meta": { "type": "object", "properties": { "offset": { "type": "integer" }, "per_page": { "type": "integer" }, "count": { "type": "integer" }, "has_more": { "type": "boolean" }, "next_offset": { "type": [ "integer", "null" ] } }, "required": [ "offset", "per_page", "count", "has_more", "next_offset" ] } }, "required": [ "data" ] } }, "application/xml": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/RequestResource" } }, "meta": { "type": "object", "properties": { "offset": { "type": "integer" }, "per_page": { "type": "integer" }, "count": { "type": "integer" }, "has_more": { "type": "boolean" }, "next_offset": { "type": [ "integer", "null" ] } }, "required": [ "offset", "per_page", "count", "has_more", "next_offset" ] } }, "required": [ "data" ] } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ApiError" } } }, "headers": { "X-Helpspot-Request-Id": { "description": "Correlation ID matching error.request_id. Include it when contacting support.", "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ApiError" } } }, "headers": { "X-Helpspot-Request-Id": { "description": "Correlation ID matching error.request_id. Include it when contacting support.", "schema": { "type": "string" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ApiError" } } }, "headers": { "X-Helpspot-Request-Id": { "description": "Correlation ID matching error.request_id. Include it when contacting support.", "schema": { "type": "string" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ApiError" } } }, "headers": { "X-Helpspot-Request-Id": { "description": "Correlation ID matching error.request_id. Include it when contacting support.", "schema": { "type": "string" } } } }, "405": { "description": "Method Not Allowed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ApiError" } } }, "headers": { "X-Helpspot-Request-Id": { "description": "Correlation ID matching error.request_id. Include it when contacting support.", "schema": { "type": "string" } } } }, "406": { "description": "Not Acceptable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } }, "headers": { "X-Helpspot-Request-Id": { "description": "Correlation ID matching error.request_id. Include it when contacting support.", "schema": { "type": "string" } } } }, "413": { "description": "Content Too Large", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ApiError" } } }, "headers": { "X-Helpspot-Request-Id": { "description": "Correlation ID matching error.request_id. Include it when contacting support.", "schema": { "type": "string" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ApiError" } } }, "headers": { "X-Helpspot-Request-Id": { "description": "Correlation ID matching error.request_id. Include it when contacting support.", "schema": { "type": "string" } }, "Retry-After": { "description": "Seconds to wait before retrying.", "schema": { "type": "string" }, "example": "60" } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ApiError" } } }, "headers": { "X-Helpspot-Request-Id": { "description": "Correlation ID matching error.request_id. Include it when contacting support.", "schema": { "type": "string" } } } }, "503": { "description": "Service Unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ApiError" } } }, "headers": { "X-Helpspot-Request-Id": { "description": "Correlation ID matching error.request_id. Include it when contacting support.", "schema": { "type": "string" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ApiError" } } }, "headers": { "X-Helpspot-Request-Id": { "description": "Correlation ID matching error.request_id. Include it when contacting support.", "schema": { "type": "string" } } } } }, "security": [ { "bearerAuth": [] }, { "basicAuth": [] } ] }, "post": { "operationId": "v2.requests.store", "description": "### Safe retries\n\n`POST /requests` accepts an optional `Idempotency-Key` header. Generate a unique key for each new request, for example a UUID. Keys are case-sensitive, scoped to the authenticated staff member and this endpoint, and contain 1\u2013128 ASCII letters, digits, dots, underscores, colons or hyphens, starting with a letter or digit. Without a key, each call creates a new request.\n\n```http\nPOST /api/v2/requests\nIdempotency-Key: 550e8400-e29b-41d4-a716-446655440000\nContent-Type: application/json\n\n{\n \"note\": \"Cannot sign in\",\n \"email\": \"customer@example.com\",\n \"category_id\": 1\n}\n```\n\n- Retry with the **same key and payload** after a network failure. A completed operation returns its original HTTP 201 response with `Idempotency-Replayed: true`, without running creation, triggers, or notifications again. JSON and XML are both supported; changing `Accept` or `format` does not change the operation.\n- Completed responses are available for **24 hours after completion**. After that, the key can create a new request. Never reuse keys for unrelated operations.\n- A different payload with the same retained key returns **409 `idempotency_conflict`**. Object-key order does not matter; array order, explicit nulls, and omitted fields do. Send the same field values and types on retries.\n- Authentication and input validation run on every call. Validation failures do not reserve a key. If access to the created request is subsequently lost, a replay returns only `data.id`, not the cached customer fields.\n- A running operation, an execution failure, or an interrupted operation without a recorded result returns **409 `idempotency_unresolved`** on retry. These keys do not automatically expire. A request or notifications may already exist: do not switch to a new key or omit the key to force a retry. Contact support with the response request ID, the idempotency key, and the staff account if the conflict persists.\n\nIdempotency prevents re-execution for retained keys; it does not make request creation, file storage, and delivery of external notifications one atomic operation. Successful response bodies are stored encrypted. Other write endpoints do not support idempotency keys.", "summary": "Create a request", "tags": [ "Requests" ], "parameters": [ { "name": "Idempotency-Key", "in": "header", "description": "Optional unique operation key. Replays completed responses for 24 hours. See Safe retries for conflicts and interrupted operations.", "schema": { "type": "string", "pattern": "^[A-Za-z0-9][A-Za-z0-9._:-]{0,127}$", "minLength": 1, "maxLength": 128 } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StoreRequestRequest" } } } }, "responses": { "422": { "$ref": "#/components/responses/ValidationException" }, "201": { "description": "Request resource. Fields depend on visibility and endpoint; see the Requests guide.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/RequestResource" } }, "required": [ "data" ] } }, "application/xml": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/RequestResource" } }, "required": [ "data" ] } } }, "headers": { "Idempotency-Replayed": { "description": "Present with value true when replaying a completed operation.", "schema": { "type": "string" }, "example": "true" } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ApiError" } } }, "headers": { "X-Helpspot-Request-Id": { "description": "Correlation ID matching error.request_id. Include it when contacting support.", "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ApiError" } } }, "headers": { "X-Helpspot-Request-Id": { "description": "Correlation ID matching error.request_id. Include it when contacting support.", "schema": { "type": "string" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ApiError" } } }, "headers": { "X-Helpspot-Request-Id": { "description": "Correlation ID matching error.request_id. Include it when contacting support.", "schema": { "type": "string" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ApiError" } } }, "headers": { "X-Helpspot-Request-Id": { "description": "Correlation ID matching error.request_id. Include it when contacting support.", "schema": { "type": "string" } } } }, "405": { "description": "Method Not Allowed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ApiError" } } }, "headers": { "X-Helpspot-Request-Id": { "description": "Correlation ID matching error.request_id. Include it when contacting support.", "schema": { "type": "string" } } } }, "406": { "description": "Not Acceptable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } }, "headers": { "X-Helpspot-Request-Id": { "description": "Correlation ID matching error.request_id. Include it when contacting support.", "schema": { "type": "string" } } } }, "413": { "description": "Content Too Large", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ApiError" } } }, "headers": { "X-Helpspot-Request-Id": { "description": "Correlation ID matching error.request_id. Include it when contacting support.", "schema": { "type": "string" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ApiError" } } }, "headers": { "X-Helpspot-Request-Id": { "description": "Correlation ID matching error.request_id. Include it when contacting support.", "schema": { "type": "string" } }, "Retry-After": { "description": "Seconds to wait before retrying.", "schema": { "type": "string" }, "example": "60" } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ApiError" } } }, "headers": { "X-Helpspot-Request-Id": { "description": "Correlation ID matching error.request_id. Include it when contacting support.", "schema": { "type": "string" } } } }, "503": { "description": "Service Unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ApiError" } } }, "headers": { "X-Helpspot-Request-Id": { "description": "Correlation ID matching error.request_id. Include it when contacting support.", "schema": { "type": "string" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ApiError" } } }, "headers": { "X-Helpspot-Request-Id": { "description": "Correlation ID matching error.request_id. Include it when contacting support.", "schema": { "type": "string" } } } } }, "security": [ { "bearerAuth": [] }, { "basicAuth": [] } ] } }, "/requests/{request}": { "get": { "operationId": "v2.requests.show", "summary": "Retrieve a request with its history and related data", "tags": [ "Requests" ], "parameters": [ { "name": "request", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "inline_images", "in": "query", "schema": { "type": "boolean" } }, { "name": "include_time_total", "in": "query", "schema": { "type": "boolean" } } ], "responses": { "422": { "$ref": "#/components/responses/ValidationException" }, "200": { "description": "Request resource. Fields depend on visibility and endpoint; see the Requests guide.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/RequestResource" } }, "required": [ "data" ] } }, "application/xml": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/RequestResource" } }, "required": [ "data" ] } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ApiError" } } }, "headers": { "X-Helpspot-Request-Id": { "description": "Correlation ID matching error.request_id. Include it when contacting support.", "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ApiError" } } }, "headers": { "X-Helpspot-Request-Id": { "description": "Correlation ID matching error.request_id. Include it when contacting support.", "schema": { "type": "string" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ApiError" } } }, "headers": { "X-Helpspot-Request-Id": { "description": "Correlation ID matching error.request_id. Include it when contacting support.", "schema": { "type": "string" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ApiError" } } }, "headers": { "X-Helpspot-Request-Id": { "description": "Correlation ID matching error.request_id. Include it when contacting support.", "schema": { "type": "string" } } } }, "405": { "description": "Method Not Allowed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ApiError" } } }, "headers": { "X-Helpspot-Request-Id": { "description": "Correlation ID matching error.request_id. Include it when contacting support.", "schema": { "type": "string" } } } }, "406": { "description": "Not Acceptable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } }, "headers": { "X-Helpspot-Request-Id": { "description": "Correlation ID matching error.request_id. Include it when contacting support.", "schema": { "type": "string" } } } }, "413": { "description": "Content Too Large", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ApiError" } } }, "headers": { "X-Helpspot-Request-Id": { "description": "Correlation ID matching error.request_id. Include it when contacting support.", "schema": { "type": "string" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ApiError" } } }, "headers": { "X-Helpspot-Request-Id": { "description": "Correlation ID matching error.request_id. Include it when contacting support.", "schema": { "type": "string" } }, "Retry-After": { "description": "Seconds to wait before retrying.", "schema": { "type": "string" }, "example": "60" } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ApiError" } } }, "headers": { "X-Helpspot-Request-Id": { "description": "Correlation ID matching error.request_id. Include it when contacting support.", "schema": { "type": "string" } } } }, "503": { "description": "Service Unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ApiError" } } }, "headers": { "X-Helpspot-Request-Id": { "description": "Correlation ID matching error.request_id. Include it when contacting support.", "schema": { "type": "string" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ApiError" } } }, "headers": { "X-Helpspot-Request-Id": { "description": "Correlation ID matching error.request_id. Include it when contacting support.", "schema": { "type": "string" } } } } }, "security": [ { "bearerAuth": [] }, { "basicAuth": [] } ] }, "patch": { "operationId": "v2.requests.update", "summary": "Update a request and optionally add a note", "tags": [ "Requests" ], "parameters": [ { "name": "request", "in": "path", "required": true, "schema": { "type": "integer" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateRequestRequest" } } } }, "responses": { "422": { "$ref": "#/components/responses/ValidationException" }, "200": { "description": "Request resource. Fields depend on visibility and endpoint; see the Requests guide.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/RequestResource" } }, "required": [ "data" ] } }, "application/xml": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/RequestResource" } }, "required": [ "data" ] } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ApiError" } } }, "headers": { "X-Helpspot-Request-Id": { "description": "Correlation ID matching error.request_id. Include it when contacting support.", "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ApiError" } } }, "headers": { "X-Helpspot-Request-Id": { "description": "Correlation ID matching error.request_id. Include it when contacting support.", "schema": { "type": "string" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ApiError" } } }, "headers": { "X-Helpspot-Request-Id": { "description": "Correlation ID matching error.request_id. Include it when contacting support.", "schema": { "type": "string" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ApiError" } } }, "headers": { "X-Helpspot-Request-Id": { "description": "Correlation ID matching error.request_id. Include it when contacting support.", "schema": { "type": "string" } } } }, "405": { "description": "Method Not Allowed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ApiError" } } }, "headers": { "X-Helpspot-Request-Id": { "description": "Correlation ID matching error.request_id. Include it when contacting support.", "schema": { "type": "string" } } } }, "406": { "description": "Not Acceptable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } }, "headers": { "X-Helpspot-Request-Id": { "description": "Correlation ID matching error.request_id. Include it when contacting support.", "schema": { "type": "string" } } } }, "413": { "description": "Content Too Large", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ApiError" } } }, "headers": { "X-Helpspot-Request-Id": { "description": "Correlation ID matching error.request_id. Include it when contacting support.", "schema": { "type": "string" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ApiError" } } }, "headers": { "X-Helpspot-Request-Id": { "description": "Correlation ID matching error.request_id. Include it when contacting support.", "schema": { "type": "string" } }, "Retry-After": { "description": "Seconds to wait before retrying.", "schema": { "type": "string" }, "example": "60" } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ApiError" } } }, "headers": { "X-Helpspot-Request-Id": { "description": "Correlation ID matching error.request_id. Include it when contacting support.", "schema": { "type": "string" } } } }, "503": { "description": "Service Unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ApiError" } } }, "headers": { "X-Helpspot-Request-Id": { "description": "Correlation ID matching error.request_id. Include it when contacting support.", "schema": { "type": "string" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ApiError" } } }, "headers": { "X-Helpspot-Request-Id": { "description": "Correlation ID matching error.request_id. Include it when contacting support.", "schema": { "type": "string" } } } } }, "security": [ { "bearerAuth": [] }, { "basicAuth": [] } ] } }, "/requests/{request}/merges": { "post": { "operationId": "v2.request-merges.store", "summary": "Merge a source request into this target request", "tags": [ "Request actions" ], "parameters": [ { "name": "request", "in": "path", "required": true, "schema": { "type": "integer" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MergeRequestRequest" } } } }, "responses": { "403": { "description": "An error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ApiError" } } }, "headers": { "X-Helpspot-Request-Id": { "description": "Correlation ID matching error.request_id. Include it when contacting support.", "schema": { "type": "string" } } } }, "422": { "$ref": "#/components/responses/ValidationException" }, "200": { "description": "Operation result.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "request_id": { "type": "integer" } }, "required": [ "request_id" ] } }, "required": [ "data" ] } }, "application/xml": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "request_id": { "type": "integer" } }, "required": [ "request_id" ] } }, "required": [ "data" ] } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ApiError" } } }, "headers": { "X-Helpspot-Request-Id": { "description": "Correlation ID matching error.request_id. Include it when contacting support.", "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ApiError" } } }, "headers": { "X-Helpspot-Request-Id": { "description": "Correlation ID matching error.request_id. Include it when contacting support.", "schema": { "type": "string" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ApiError" } } }, "headers": { "X-Helpspot-Request-Id": { "description": "Correlation ID matching error.request_id. Include it when contacting support.", "schema": { "type": "string" } } } }, "405": { "description": "Method Not Allowed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ApiError" } } }, "headers": { "X-Helpspot-Request-Id": { "description": "Correlation ID matching error.request_id. Include it when contacting support.", "schema": { "type": "string" } } } }, "406": { "description": "Not Acceptable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } }, "headers": { "X-Helpspot-Request-Id": { "description": "Correlation ID matching error.request_id. Include it when contacting support.", "schema": { "type": "string" } } } }, "413": { "description": "Content Too Large", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ApiError" } } }, "headers": { "X-Helpspot-Request-Id": { "description": "Correlation ID matching error.request_id. Include it when contacting support.", "schema": { "type": "string" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ApiError" } } }, "headers": { "X-Helpspot-Request-Id": { "description": "Correlation ID matching error.request_id. Include it when contacting support.", "schema": { "type": "string" } }, "Retry-After": { "description": "Seconds to wait before retrying.", "schema": { "type": "string" }, "example": "60" } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ApiError" } } }, "headers": { "X-Helpspot-Request-Id": { "description": "Correlation ID matching error.request_id. Include it when contacting support.", "schema": { "type": "string" } } } }, "503": { "description": "Service Unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ApiError" } } }, "headers": { "X-Helpspot-Request-Id": { "description": "Correlation ID matching error.request_id. Include it when contacting support.", "schema": { "type": "string" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ApiError" } } }, "headers": { "X-Helpspot-Request-Id": { "description": "Correlation ID matching error.request_id. Include it when contacting support.", "schema": { "type": "string" } } } } }, "security": [ { "bearerAuth": [] }, { "basicAuth": [] } ] } }, "/requests/{request}/read-state": { "put": { "operationId": "v2.request-read-state.update", "summary": "Mark a request read for its assigned staff member", "tags": [ "Request actions" ], "parameters": [ { "name": "request", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "403": { "description": "An error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ApiError" } } }, "headers": { "X-Helpspot-Request-Id": { "description": "Correlation ID matching error.request_id. Include it when contacting support.", "schema": { "type": "string" } } } }, "200": { "description": "Operation result.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "unread": { "type": "boolean" } }, "required": [ "unread" ] } }, "required": [ "data" ] } }, "application/xml": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "unread": { "type": "boolean" } }, "required": [ "unread" ] } }, "required": [ "data" ] } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ApiError" } } }, "headers": { "X-Helpspot-Request-Id": { "description": "Correlation ID matching error.request_id. Include it when contacting support.", "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ApiError" } } }, "headers": { "X-Helpspot-Request-Id": { "description": "Correlation ID matching error.request_id. Include it when contacting support.", "schema": { "type": "string" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ApiError" } } }, "headers": { "X-Helpspot-Request-Id": { "description": "Correlation ID matching error.request_id. Include it when contacting support.", "schema": { "type": "string" } } } }, "405": { "description": "Method Not Allowed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ApiError" } } }, "headers": { "X-Helpspot-Request-Id": { "description": "Correlation ID matching error.request_id. Include it when contacting support.", "schema": { "type": "string" } } } }, "406": { "description": "Not Acceptable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } }, "headers": { "X-Helpspot-Request-Id": { "description": "Correlation ID matching error.request_id. Include it when contacting support.", "schema": { "type": "string" } } } }, "413": { "description": "Content Too Large", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ApiError" } } }, "headers": { "X-Helpspot-Request-Id": { "description": "Correlation ID matching error.request_id. Include it when contacting support.", "schema": { "type": "string" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ApiError" } } }, "headers": { "X-Helpspot-Request-Id": { "description": "Correlation ID matching error.request_id. Include it when contacting support.", "schema": { "type": "string" } }, "Retry-After": { "description": "Seconds to wait before retrying.", "schema": { "type": "string" }, "example": "60" } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ApiError" } } }, "headers": { "X-Helpspot-Request-Id": { "description": "Correlation ID matching error.request_id. Include it when contacting support.", "schema": { "type": "string" } } } }, "503": { "description": "Service Unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ApiError" } } }, "headers": { "X-Helpspot-Request-Id": { "description": "Correlation ID matching error.request_id. Include it when contacting support.", "schema": { "type": "string" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ApiError" } } }, "headers": { "X-Helpspot-Request-Id": { "description": "Correlation ID matching error.request_id. Include it when contacting support.", "schema": { "type": "string" } } } } }, "security": [ { "bearerAuth": [] }, { "basicAuth": [] } ] }, "delete": { "operationId": "v2.request-read-state.destroy", "summary": "Mark a request unread for its assigned staff member", "tags": [ "Request actions" ], "parameters": [ { "name": "request", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "403": { "description": "An error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ApiError" } } }, "headers": { "X-Helpspot-Request-Id": { "description": "Correlation ID matching error.request_id. Include it when contacting support.", "schema": { "type": "string" } } } }, "200": { "description": "Operation result.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "unread": { "type": "boolean" } }, "required": [ "unread" ] } }, "required": [ "data" ] } }, "application/xml": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "unread": { "type": "boolean" } }, "required": [ "unread" ] } }, "required": [ "data" ] } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ApiError" } } }, "headers": { "X-Helpspot-Request-Id": { "description": "Correlation ID matching error.request_id. Include it when contacting support.", "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ApiError" } } }, "headers": { "X-Helpspot-Request-Id": { "description": "Correlation ID matching error.request_id. Include it when contacting support.", "schema": { "type": "string" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ApiError" } } }, "headers": { "X-Helpspot-Request-Id": { "description": "Correlation ID matching error.request_id. Include it when contacting support.", "schema": { "type": "string" } } } }, "405": { "description": "Method Not Allowed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ApiError" } } }, "headers": { "X-Helpspot-Request-Id": { "description": "Correlation ID matching error.request_id. Include it when contacting support.", "schema": { "type": "string" } } } }, "406": { "description": "Not Acceptable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } }, "headers": { "X-Helpspot-Request-Id": { "description": "Correlation ID matching error.request_id. Include it when contacting support.", "schema": { "type": "string" } } } }, "413": { "description": "Content Too Large", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ApiError" } } }, "headers": { "X-Helpspot-Request-Id": { "description": "Correlation ID matching error.request_id. Include it when contacting support.", "schema": { "type": "string" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ApiError" } } }, "headers": { "X-Helpspot-Request-Id": { "description": "Correlation ID matching error.request_id. Include it when contacting support.", "schema": { "type": "string" } }, "Retry-After": { "description": "Seconds to wait before retrying.", "schema": { "type": "string" }, "example": "60" } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ApiError" } } }, "headers": { "X-Helpspot-Request-Id": { "description": "Correlation ID matching error.request_id. Include it when contacting support.", "schema": { "type": "string" } } } }, "503": { "description": "Service Unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ApiError" } } }, "headers": { "X-Helpspot-Request-Id": { "description": "Correlation ID matching error.request_id. Include it when contacting support.", "schema": { "type": "string" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ApiError" } } }, "headers": { "X-Helpspot-Request-Id": { "description": "Correlation ID matching error.request_id. Include it when contacting support.", "schema": { "type": "string" } } } } }, "security": [ { "bearerAuth": [] }, { "basicAuth": [] } ] } }, "/requests/{request}/trash": { "put": { "operationId": "v2.request-trash.update", "summary": "Move a request to trash", "tags": [ "Request actions" ], "parameters": [ { "name": "request", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "403": { "description": "An error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ApiError" } } }, "headers": { "X-Helpspot-Request-Id": { "description": "Correlation ID matching error.request_id. Include it when contacting support.", "schema": { "type": "string" } } } }, "200": { "description": "Operation result.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "request_id": { "type": "integer" }, "trashed": { "type": "boolean" } }, "required": [ "request_id", "trashed" ] } }, "required": [ "data" ] } }, "application/xml": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "request_id": { "type": "integer" }, "trashed": { "type": "boolean" } }, "required": [ "request_id", "trashed" ] } }, "required": [ "data" ] } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ApiError" } } }, "headers": { "X-Helpspot-Request-Id": { "description": "Correlation ID matching error.request_id. Include it when contacting support.", "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ApiError" } } }, "headers": { "X-Helpspot-Request-Id": { "description": "Correlation ID matching error.request_id. Include it when contacting support.", "schema": { "type": "string" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ApiError" } } }, "headers": { "X-Helpspot-Request-Id": { "description": "Correlation ID matching error.request_id. Include it when contacting support.", "schema": { "type": "string" } } } }, "405": { "description": "Method Not Allowed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ApiError" } } }, "headers": { "X-Helpspot-Request-Id": { "description": "Correlation ID matching error.request_id. Include it when contacting support.", "schema": { "type": "string" } } } }, "406": { "description": "Not Acceptable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } }, "headers": { "X-Helpspot-Request-Id": { "description": "Correlation ID matching error.request_id. Include it when contacting support.", "schema": { "type": "string" } } } }, "413": { "description": "Content Too Large", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ApiError" } } }, "headers": { "X-Helpspot-Request-Id": { "description": "Correlation ID matching error.request_id. Include it when contacting support.", "schema": { "type": "string" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ApiError" } } }, "headers": { "X-Helpspot-Request-Id": { "description": "Correlation ID matching error.request_id. Include it when contacting support.", "schema": { "type": "string" } }, "Retry-After": { "description": "Seconds to wait before retrying.", "schema": { "type": "string" }, "example": "60" } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ApiError" } } }, "headers": { "X-Helpspot-Request-Id": { "description": "Correlation ID matching error.request_id. Include it when contacting support.", "schema": { "type": "string" } } } }, "503": { "description": "Service Unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ApiError" } } }, "headers": { "X-Helpspot-Request-Id": { "description": "Correlation ID matching error.request_id. Include it when contacting support.", "schema": { "type": "string" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ApiError" } } }, "headers": { "X-Helpspot-Request-Id": { "description": "Correlation ID matching error.request_id. Include it when contacting support.", "schema": { "type": "string" } } } } }, "security": [ { "bearerAuth": [] }, { "basicAuth": [] } ] } }, "/requests/{request}/spam": { "put": { "operationId": "v2.request-spam.update", "summary": "Mark an eligible email or form request as spam", "tags": [ "Request actions" ], "parameters": [ { "name": "request", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "403": { "description": "An error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ApiError" } } }, "headers": { "X-Helpspot-Request-Id": { "description": "Correlation ID matching error.request_id. Include it when contacting support.", "schema": { "type": "string" } } } }, "422": { "description": "An error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ApiError" } } }, "headers": { "X-Helpspot-Request-Id": { "description": "Correlation ID matching error.request_id. Include it when contacting support.", "schema": { "type": "string" } } } }, "200": { "description": "Operation result.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "request_id": { "type": "integer" }, "spammed": { "type": "boolean" } }, "required": [ "request_id", "spammed" ] } }, "required": [ "data" ] } }, "application/xml": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "request_id": { "type": "integer" }, "spammed": { "type": "boolean" } }, "required": [ "request_id", "spammed" ] } }, "required": [ "data" ] } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ApiError" } } }, "headers": { "X-Helpspot-Request-Id": { "description": "Correlation ID matching error.request_id. Include it when contacting support.", "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ApiError" } } }, "headers": { "X-Helpspot-Request-Id": { "description": "Correlation ID matching error.request_id. Include it when contacting support.", "schema": { "type": "string" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ApiError" } } }, "headers": { "X-Helpspot-Request-Id": { "description": "Correlation ID matching error.request_id. Include it when contacting support.", "schema": { "type": "string" } } } }, "405": { "description": "Method Not Allowed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ApiError" } } }, "headers": { "X-Helpspot-Request-Id": { "description": "Correlation ID matching error.request_id. Include it when contacting support.", "schema": { "type": "string" } } } }, "406": { "description": "Not Acceptable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } }, "headers": { "X-Helpspot-Request-Id": { "description": "Correlation ID matching error.request_id. Include it when contacting support.", "schema": { "type": "string" } } } }, "413": { "description": "Content Too Large", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ApiError" } } }, "headers": { "X-Helpspot-Request-Id": { "description": "Correlation ID matching error.request_id. Include it when contacting support.", "schema": { "type": "string" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ApiError" } } }, "headers": { "X-Helpspot-Request-Id": { "description": "Correlation ID matching error.request_id. Include it when contacting support.", "schema": { "type": "string" } }, "Retry-After": { "description": "Seconds to wait before retrying.", "schema": { "type": "string" }, "example": "60" } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ApiError" } } }, "headers": { "X-Helpspot-Request-Id": { "description": "Correlation ID matching error.request_id. Include it when contacting support.", "schema": { "type": "string" } } } }, "503": { "description": "Service Unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ApiError" } } }, "headers": { "X-Helpspot-Request-Id": { "description": "Correlation ID matching error.request_id. Include it when contacting support.", "schema": { "type": "string" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ApiError" } } }, "headers": { "X-Helpspot-Request-Id": { "description": "Correlation ID matching error.request_id. Include it when contacting support.", "schema": { "type": "string" } } } } }, "security": [ { "bearerAuth": [] }, { "basicAuth": [] } ] } }, "/requests/{request}/subscribers/{staff}": { "put": { "operationId": "v2.request-subscribers.store", "summary": "Subscribe a staff member to a request", "tags": [ "Request actions" ], "parameters": [ { "name": "request", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "staff", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "403": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ApiError" } } }, "headers": { "X-Helpspot-Request-Id": { "description": "Correlation ID matching error.request_id. Include it when contacting support.", "schema": { "type": "string" } } } }, "422": { "description": "An error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ApiError" } } }, "headers": { "X-Helpspot-Request-Id": { "description": "Correlation ID matching error.request_id. Include it when contacting support.", "schema": { "type": "string" } } } }, "200": { "description": "Operation result.", "content": { "application/json": { "schema": { "type": "object", "properties": { "subscribed": { "type": "boolean" } }, "required": [ "subscribed" ] } }, "application/xml": { "schema": { "type": "object", "properties": { "subscribed": { "type": "boolean" } }, "required": [ "subscribed" ] } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ApiError" } } }, "headers": { "X-Helpspot-Request-Id": { "description": "Correlation ID matching error.request_id. Include it when contacting support.", "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ApiError" } } }, "headers": { "X-Helpspot-Request-Id": { "description": "Correlation ID matching error.request_id. Include it when contacting support.", "schema": { "type": "string" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ApiError" } } }, "headers": { "X-Helpspot-Request-Id": { "description": "Correlation ID matching error.request_id. Include it when contacting support.", "schema": { "type": "string" } } } }, "405": { "description": "Method Not Allowed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ApiError" } } }, "headers": { "X-Helpspot-Request-Id": { "description": "Correlation ID matching error.request_id. Include it when contacting support.", "schema": { "type": "string" } } } }, "406": { "description": "Not Acceptable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } }, "headers": { "X-Helpspot-Request-Id": { "description": "Correlation ID matching error.request_id. Include it when contacting support.", "schema": { "type": "string" } } } }, "413": { "description": "Content Too Large", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ApiError" } } }, "headers": { "X-Helpspot-Request-Id": { "description": "Correlation ID matching error.request_id. Include it when contacting support.", "schema": { "type": "string" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ApiError" } } }, "headers": { "X-Helpspot-Request-Id": { "description": "Correlation ID matching error.request_id. Include it when contacting support.", "schema": { "type": "string" } }, "Retry-After": { "description": "Seconds to wait before retrying.", "schema": { "type": "string" }, "example": "60" } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ApiError" } } }, "headers": { "X-Helpspot-Request-Id": { "description": "Correlation ID matching error.request_id. Include it when contacting support.", "schema": { "type": "string" } } } }, "503": { "description": "Service Unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ApiError" } } }, "headers": { "X-Helpspot-Request-Id": { "description": "Correlation ID matching error.request_id. Include it when contacting support.", "schema": { "type": "string" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ApiError" } } }, "headers": { "X-Helpspot-Request-Id": { "description": "Correlation ID matching error.request_id. Include it when contacting support.", "schema": { "type": "string" } } } } }, "security": [ { "bearerAuth": [] }, { "basicAuth": [] } ] }, "delete": { "operationId": "v2.request-subscribers.destroy", "summary": "Unsubscribe a staff member from a request", "tags": [ "Request actions" ], "parameters": [ { "name": "request", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "staff", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "403": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ApiError" } } }, "headers": { "X-Helpspot-Request-Id": { "description": "Correlation ID matching error.request_id. Include it when contacting support.", "schema": { "type": "string" } } } }, "200": { "description": "Operation result.", "content": { "application/json": { "schema": { "type": "object", "properties": { "unsubscribed": { "type": "boolean" } }, "required": [ "unsubscribed" ] } }, "application/xml": { "schema": { "type": "object", "properties": { "unsubscribed": { "type": "boolean" } }, "required": [ "unsubscribed" ] } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ApiError" } } }, "headers": { "X-Helpspot-Request-Id": { "description": "Correlation ID matching error.request_id. Include it when contacting support.", "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ApiError" } } }, "headers": { "X-Helpspot-Request-Id": { "description": "Correlation ID matching error.request_id. Include it when contacting support.", "schema": { "type": "string" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ApiError" } } }, "headers": { "X-Helpspot-Request-Id": { "description": "Correlation ID matching error.request_id. Include it when contacting support.", "schema": { "type": "string" } } } }, "405": { "description": "Method Not Allowed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ApiError" } } }, "headers": { "X-Helpspot-Request-Id": { "description": "Correlation ID matching error.request_id. Include it when contacting support.", "schema": { "type": "string" } } } }, "406": { "description": "Not Acceptable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } }, "headers": { "X-Helpspot-Request-Id": { "description": "Correlation ID matching error.request_id. Include it when contacting support.", "schema": { "type": "string" } } } }, "413": { "description": "Content Too Large", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ApiError" } } }, "headers": { "X-Helpspot-Request-Id": { "description": "Correlation ID matching error.request_id. Include it when contacting support.", "schema": { "type": "string" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ApiError" } } }, "headers": { "X-Helpspot-Request-Id": { "description": "Correlation ID matching error.request_id. Include it when contacting support.", "schema": { "type": "string" } }, "Retry-After": { "description": "Seconds to wait before retrying.", "schema": { "type": "string" }, "example": "60" } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ApiError" } } }, "headers": { "X-Helpspot-Request-Id": { "description": "Correlation ID matching error.request_id. Include it when contacting support.", "schema": { "type": "string" } } } }, "503": { "description": "Service Unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ApiError" } } }, "headers": { "X-Helpspot-Request-Id": { "description": "Correlation ID matching error.request_id. Include it when contacting support.", "schema": { "type": "string" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ApiError" } } }, "headers": { "X-Helpspot-Request-Id": { "description": "Correlation ID matching error.request_id. Include it when contacting support.", "schema": { "type": "string" } } } } }, "security": [ { "bearerAuth": [] }, { "basicAuth": [] } ] } }, "/requests/{request}/time-events": { "get": { "operationId": "v2.request-time-events.index", "summary": "List time events recorded against a request", "tags": [ "Time tracking" ], "parameters": [ { "name": "request", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "422": { "$ref": "#/components/responses/ValidationException" }, "200": { "description": "Time event resource. See the Time tracking guide.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/TimeEventResource" } } }, "required": [ "data" ] } }, "application/xml": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/TimeEventResource" } } }, "required": [ "data" ] } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ApiError" } } }, "headers": { "X-Helpspot-Request-Id": { "description": "Correlation ID matching error.request_id. Include it when contacting support.", "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ApiError" } } }, "headers": { "X-Helpspot-Request-Id": { "description": "Correlation ID matching error.request_id. Include it when contacting support.", "schema": { "type": "string" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ApiError" } } }, "headers": { "X-Helpspot-Request-Id": { "description": "Correlation ID matching error.request_id. Include it when contacting support.", "schema": { "type": "string" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ApiError" } } }, "headers": { "X-Helpspot-Request-Id": { "description": "Correlation ID matching error.request_id. Include it when contacting support.", "schema": { "type": "string" } } } }, "405": { "description": "Method Not Allowed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ApiError" } } }, "headers": { "X-Helpspot-Request-Id": { "description": "Correlation ID matching error.request_id. Include it when contacting support.", "schema": { "type": "string" } } } }, "406": { "description": "Not Acceptable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } }, "headers": { "X-Helpspot-Request-Id": { "description": "Correlation ID matching error.request_id. Include it when contacting support.", "schema": { "type": "string" } } } }, "413": { "description": "Content Too Large", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ApiError" } } }, "headers": { "X-Helpspot-Request-Id": { "description": "Correlation ID matching error.request_id. Include it when contacting support.", "schema": { "type": "string" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ApiError" } } }, "headers": { "X-Helpspot-Request-Id": { "description": "Correlation ID matching error.request_id. Include it when contacting support.", "schema": { "type": "string" } }, "Retry-After": { "description": "Seconds to wait before retrying.", "schema": { "type": "string" }, "example": "60" } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ApiError" } } }, "headers": { "X-Helpspot-Request-Id": { "description": "Correlation ID matching error.request_id. Include it when contacting support.", "schema": { "type": "string" } } } }, "503": { "description": "Service Unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ApiError" } } }, "headers": { "X-Helpspot-Request-Id": { "description": "Correlation ID matching error.request_id. Include it when contacting support.", "schema": { "type": "string" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ApiError" } } }, "headers": { "X-Helpspot-Request-Id": { "description": "Correlation ID matching error.request_id. Include it when contacting support.", "schema": { "type": "string" } } } } }, "security": [ { "bearerAuth": [] }, { "basicAuth": [] } ] }, "post": { "operationId": "v2.request-time-events.store", "summary": "Record time against a request", "tags": [ "Time tracking" ], "parameters": [ { "name": "request", "in": "path", "required": true, "schema": { "type": "integer" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StoreTimeEventRequest" } } } }, "responses": { "403": { "description": "An error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ApiError" } } }, "headers": { "X-Helpspot-Request-Id": { "description": "Correlation ID matching error.request_id. Include it when contacting support.", "schema": { "type": "string" } } } }, "422": { "$ref": "#/components/responses/ValidationException" }, "201": { "description": "Time event resource. See the Time tracking guide.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/TimeEventResource" } }, "required": [ "data" ] } }, "application/xml": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/TimeEventResource" } }, "required": [ "data" ] } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ApiError" } } }, "headers": { "X-Helpspot-Request-Id": { "description": "Correlation ID matching error.request_id. Include it when contacting support.", "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ApiError" } } }, "headers": { "X-Helpspot-Request-Id": { "description": "Correlation ID matching error.request_id. Include it when contacting support.", "schema": { "type": "string" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ApiError" } } }, "headers": { "X-Helpspot-Request-Id": { "description": "Correlation ID matching error.request_id. Include it when contacting support.", "schema": { "type": "string" } } } }, "405": { "description": "Method Not Allowed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ApiError" } } }, "headers": { "X-Helpspot-Request-Id": { "description": "Correlation ID matching error.request_id. Include it when contacting support.", "schema": { "type": "string" } } } }, "406": { "description": "Not Acceptable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } }, "headers": { "X-Helpspot-Request-Id": { "description": "Correlation ID matching error.request_id. Include it when contacting support.", "schema": { "type": "string" } } } }, "413": { "description": "Content Too Large", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ApiError" } } }, "headers": { "X-Helpspot-Request-Id": { "description": "Correlation ID matching error.request_id. Include it when contacting support.", "schema": { "type": "string" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ApiError" } } }, "headers": { "X-Helpspot-Request-Id": { "description": "Correlation ID matching error.request_id. Include it when contacting support.", "schema": { "type": "string" } }, "Retry-After": { "description": "Seconds to wait before retrying.", "schema": { "type": "string" }, "example": "60" } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ApiError" } } }, "headers": { "X-Helpspot-Request-Id": { "description": "Correlation ID matching error.request_id. Include it when contacting support.", "schema": { "type": "string" } } } }, "503": { "description": "Service Unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ApiError" } } }, "headers": { "X-Helpspot-Request-Id": { "description": "Correlation ID matching error.request_id. Include it when contacting support.", "schema": { "type": "string" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ApiError" } } }, "headers": { "X-Helpspot-Request-Id": { "description": "Correlation ID matching error.request_id. Include it when contacting support.", "schema": { "type": "string" } } } } }, "security": [ { "bearerAuth": [] }, { "basicAuth": [] } ] } }, "/responses": { "get": { "operationId": "v2.responses.index", "summary": "List predefined responses visible to the current staff member", "tags": [ "Predefined responses" ], "responses": { "200": { "description": "Predefined response resource. See the Predefined responses guide.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/PredefinedResponseResource" } } }, "required": [ "data" ] } }, "application/xml": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/PredefinedResponseResource" } } }, "required": [ "data" ] } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ApiError" } } }, "headers": { "X-Helpspot-Request-Id": { "description": "Correlation ID matching error.request_id. Include it when contacting support.", "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ApiError" } } }, "headers": { "X-Helpspot-Request-Id": { "description": "Correlation ID matching error.request_id. Include it when contacting support.", "schema": { "type": "string" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ApiError" } } }, "headers": { "X-Helpspot-Request-Id": { "description": "Correlation ID matching error.request_id. Include it when contacting support.", "schema": { "type": "string" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ApiError" } } }, "headers": { "X-Helpspot-Request-Id": { "description": "Correlation ID matching error.request_id. Include it when contacting support.", "schema": { "type": "string" } } } }, "405": { "description": "Method Not Allowed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ApiError" } } }, "headers": { "X-Helpspot-Request-Id": { "description": "Correlation ID matching error.request_id. Include it when contacting support.", "schema": { "type": "string" } } } }, "406": { "description": "Not Acceptable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } }, "headers": { "X-Helpspot-Request-Id": { "description": "Correlation ID matching error.request_id. Include it when contacting support.", "schema": { "type": "string" } } } }, "413": { "description": "Content Too Large", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ApiError" } } }, "headers": { "X-Helpspot-Request-Id": { "description": "Correlation ID matching error.request_id. Include it when contacting support.", "schema": { "type": "string" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ApiError" } } }, "headers": { "X-Helpspot-Request-Id": { "description": "Correlation ID matching error.request_id. Include it when contacting support.", "schema": { "type": "string" } }, "Retry-After": { "description": "Seconds to wait before retrying.", "schema": { "type": "string" }, "example": "60" } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ApiError" } } }, "headers": { "X-Helpspot-Request-Id": { "description": "Correlation ID matching error.request_id. Include it when contacting support.", "schema": { "type": "string" } } } }, "503": { "description": "Service Unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ApiError" } } }, "headers": { "X-Helpspot-Request-Id": { "description": "Correlation ID matching error.request_id. Include it when contacting support.", "schema": { "type": "string" } } } } }, "security": [ { "bearerAuth": [] }, { "basicAuth": [] } ] } }, "/responses/{response}": { "get": { "operationId": "v2.responses.show", "summary": "Retrieve a predefined response", "tags": [ "Predefined responses" ], "parameters": [ { "name": "response", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Predefined response resource. See the Predefined responses guide.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/PredefinedResponseResource" } }, "required": [ "data" ] } }, "application/xml": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/PredefinedResponseResource" } }, "required": [ "data" ] } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ApiError" } } }, "headers": { "X-Helpspot-Request-Id": { "description": "Correlation ID matching error.request_id. Include it when contacting support.", "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ApiError" } } }, "headers": { "X-Helpspot-Request-Id": { "description": "Correlation ID matching error.request_id. Include it when contacting support.", "schema": { "type": "string" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ApiError" } } }, "headers": { "X-Helpspot-Request-Id": { "description": "Correlation ID matching error.request_id. Include it when contacting support.", "schema": { "type": "string" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ApiError" } } }, "headers": { "X-Helpspot-Request-Id": { "description": "Correlation ID matching error.request_id. Include it when contacting support.", "schema": { "type": "string" } } } }, "405": { "description": "Method Not Allowed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ApiError" } } }, "headers": { "X-Helpspot-Request-Id": { "description": "Correlation ID matching error.request_id. Include it when contacting support.", "schema": { "type": "string" } } } }, "406": { "description": "Not Acceptable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } }, "headers": { "X-Helpspot-Request-Id": { "description": "Correlation ID matching error.request_id. Include it when contacting support.", "schema": { "type": "string" } } } }, "413": { "description": "Content Too Large", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ApiError" } } }, "headers": { "X-Helpspot-Request-Id": { "description": "Correlation ID matching error.request_id. Include it when contacting support.", "schema": { "type": "string" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ApiError" } } }, "headers": { "X-Helpspot-Request-Id": { "description": "Correlation ID matching error.request_id. Include it when contacting support.", "schema": { "type": "string" } }, "Retry-After": { "description": "Seconds to wait before retrying.", "schema": { "type": "string" }, "example": "60" } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ApiError" } } }, "headers": { "X-Helpspot-Request-Id": { "description": "Correlation ID matching error.request_id. Include it when contacting support.", "schema": { "type": "string" } } } }, "503": { "description": "Service Unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ApiError" } } }, "headers": { "X-Helpspot-Request-Id": { "description": "Correlation ID matching error.request_id. Include it when contacting support.", "schema": { "type": "string" } } } } }, "security": [ { "bearerAuth": [] }, { "basicAuth": [] } ] } }, "/staff": { "get": { "operationId": "v2.staff.index", "summary": "List active staff, or include historical staff", "tags": [ "Lookups" ], "parameters": [ { "name": "include_inactive", "in": "query", "schema": { "type": "boolean" } } ], "responses": { "422": { "$ref": "#/components/responses/ValidationException" }, "200": { "description": "Unpaginated lookup collection. See this resource group for field definitions.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/StaffResource" } } }, "required": [ "data" ] } }, "application/xml": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/StaffResource" } } }, "required": [ "data" ] } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ApiError" } } }, "headers": { "X-Helpspot-Request-Id": { "description": "Correlation ID matching error.request_id. Include it when contacting support.", "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ApiError" } } }, "headers": { "X-Helpspot-Request-Id": { "description": "Correlation ID matching error.request_id. Include it when contacting support.", "schema": { "type": "string" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ApiError" } } }, "headers": { "X-Helpspot-Request-Id": { "description": "Correlation ID matching error.request_id. Include it when contacting support.", "schema": { "type": "string" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ApiError" } } }, "headers": { "X-Helpspot-Request-Id": { "description": "Correlation ID matching error.request_id. Include it when contacting support.", "schema": { "type": "string" } } } }, "405": { "description": "Method Not Allowed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ApiError" } } }, "headers": { "X-Helpspot-Request-Id": { "description": "Correlation ID matching error.request_id. Include it when contacting support.", "schema": { "type": "string" } } } }, "406": { "description": "Not Acceptable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } }, "headers": { "X-Helpspot-Request-Id": { "description": "Correlation ID matching error.request_id. Include it when contacting support.", "schema": { "type": "string" } } } }, "413": { "description": "Content Too Large", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ApiError" } } }, "headers": { "X-Helpspot-Request-Id": { "description": "Correlation ID matching error.request_id. Include it when contacting support.", "schema": { "type": "string" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ApiError" } } }, "headers": { "X-Helpspot-Request-Id": { "description": "Correlation ID matching error.request_id. Include it when contacting support.", "schema": { "type": "string" } }, "Retry-After": { "description": "Seconds to wait before retrying.", "schema": { "type": "string" }, "example": "60" } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ApiError" } } }, "headers": { "X-Helpspot-Request-Id": { "description": "Correlation ID matching error.request_id. Include it when contacting support.", "schema": { "type": "string" } } } }, "503": { "description": "Service Unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ApiError" } } }, "headers": { "X-Helpspot-Request-Id": { "description": "Correlation ID matching error.request_id. Include it when contacting support.", "schema": { "type": "string" } } } } }, "security": [ { "bearerAuth": [] }, { "basicAuth": [] } ] } }, "/staff/{staff}/photo": { "get": { "operationId": "v2.staff.photo.show", "summary": "Retrieve a staff member's custom photo as base64", "tags": [ "Staff" ], "parameters": [ { "name": "staff", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Base64-encoded custom staff photo. An empty string means no custom photo.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "string", "format": "byte" } }, "required": [ "data" ] } }, "application/xml": { "schema": { "type": "object", "properties": { "data": { "type": "string", "format": "byte" } }, "required": [ "data" ] } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ApiError" } } }, "headers": { "X-Helpspot-Request-Id": { "description": "Correlation ID matching error.request_id. Include it when contacting support.", "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ApiError" } } }, "headers": { "X-Helpspot-Request-Id": { "description": "Correlation ID matching error.request_id. Include it when contacting support.", "schema": { "type": "string" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ApiError" } } }, "headers": { "X-Helpspot-Request-Id": { "description": "Correlation ID matching error.request_id. Include it when contacting support.", "schema": { "type": "string" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ApiError" } } }, "headers": { "X-Helpspot-Request-Id": { "description": "Correlation ID matching error.request_id. Include it when contacting support.", "schema": { "type": "string" } } } }, "405": { "description": "Method Not Allowed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ApiError" } } }, "headers": { "X-Helpspot-Request-Id": { "description": "Correlation ID matching error.request_id. Include it when contacting support.", "schema": { "type": "string" } } } }, "406": { "description": "Not Acceptable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } }, "headers": { "X-Helpspot-Request-Id": { "description": "Correlation ID matching error.request_id. Include it when contacting support.", "schema": { "type": "string" } } } }, "413": { "description": "Content Too Large", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ApiError" } } }, "headers": { "X-Helpspot-Request-Id": { "description": "Correlation ID matching error.request_id. Include it when contacting support.", "schema": { "type": "string" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ApiError" } } }, "headers": { "X-Helpspot-Request-Id": { "description": "Correlation ID matching error.request_id. Include it when contacting support.", "schema": { "type": "string" } }, "Retry-After": { "description": "Seconds to wait before retrying.", "schema": { "type": "string" }, "example": "60" } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ApiError" } } }, "headers": { "X-Helpspot-Request-Id": { "description": "Correlation ID matching error.request_id. Include it when contacting support.", "schema": { "type": "string" } } } }, "503": { "description": "Service Unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ApiError" } } }, "headers": { "X-Helpspot-Request-Id": { "description": "Correlation ID matching error.request_id. Include it when contacting support.", "schema": { "type": "string" } } } } }, "security": [ { "bearerAuth": [] }, { "basicAuth": [] } ] } }, "/staff/{staff}/request-subscriptions": { "get": { "operationId": "v2.staff.request-subscriptions.index", "summary": "List open requests to which a staff member is subscribed", "tags": [ "Staff" ], "parameters": [ { "name": "staff", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "403": { "description": "An error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ApiError" } } }, "headers": { "X-Helpspot-Request-Id": { "description": "Correlation ID matching error.request_id. Include it when contacting support.", "schema": { "type": "string" } } } }, "200": { "description": "Accessible open-request subscriptions ordered by request ID. id identifies the subscription, request_id identifies the request. Unpaginated; an empty result is data: [].", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer" }, "request_id": { "type": "integer" } }, "required": [ "id", "request_id" ] } } }, "required": [ "data" ] } }, "application/xml": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer" }, "request_id": { "type": "integer" } }, "required": [ "id", "request_id" ] } } }, "required": [ "data" ] } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ApiError" } } }, "headers": { "X-Helpspot-Request-Id": { "description": "Correlation ID matching error.request_id. Include it when contacting support.", "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ApiError" } } }, "headers": { "X-Helpspot-Request-Id": { "description": "Correlation ID matching error.request_id. Include it when contacting support.", "schema": { "type": "string" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ApiError" } } }, "headers": { "X-Helpspot-Request-Id": { "description": "Correlation ID matching error.request_id. Include it when contacting support.", "schema": { "type": "string" } } } }, "405": { "description": "Method Not Allowed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ApiError" } } }, "headers": { "X-Helpspot-Request-Id": { "description": "Correlation ID matching error.request_id. Include it when contacting support.", "schema": { "type": "string" } } } }, "406": { "description": "Not Acceptable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } }, "headers": { "X-Helpspot-Request-Id": { "description": "Correlation ID matching error.request_id. Include it when contacting support.", "schema": { "type": "string" } } } }, "413": { "description": "Content Too Large", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ApiError" } } }, "headers": { "X-Helpspot-Request-Id": { "description": "Correlation ID matching error.request_id. Include it when contacting support.", "schema": { "type": "string" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ApiError" } } }, "headers": { "X-Helpspot-Request-Id": { "description": "Correlation ID matching error.request_id. Include it when contacting support.", "schema": { "type": "string" } }, "Retry-After": { "description": "Seconds to wait before retrying.", "schema": { "type": "string" }, "example": "60" } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ApiError" } } }, "headers": { "X-Helpspot-Request-Id": { "description": "Correlation ID matching error.request_id. Include it when contacting support.", "schema": { "type": "string" } } } }, "503": { "description": "Service Unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ApiError" } } }, "headers": { "X-Helpspot-Request-Id": { "description": "Correlation ID matching error.request_id. Include it when contacting support.", "schema": { "type": "string" } } } } }, "security": [ { "bearerAuth": [] }, { "basicAuth": [] } ] } }, "/version": { "get": { "operationId": "v2.version", "summary": "Retrieve the private API version", "tags": [ "System" ], "responses": { "200": { "description": "Current and minimum supported API version strings, not the HelpSpot application release.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "examples": [ { "version": "2.0", "min_version": "1.7" } ], "properties": { "version": { "type": "string" }, "min_version": { "type": "string" } }, "required": [ "version", "min_version" ] } }, "required": [ "data" ] } }, "application/xml": { "schema": { "type": "object", "properties": { "data": { "type": "object", "examples": [ { "version": "2.0", "min_version": "1.7" } ], "properties": { "version": { "type": "string" }, "min_version": { "type": "string" } }, "required": [ "version", "min_version" ] } }, "required": [ "data" ] } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ApiError" } } }, "headers": { "X-Helpspot-Request-Id": { "description": "Correlation ID matching error.request_id. Include it when contacting support.", "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ApiError" } } }, "headers": { "X-Helpspot-Request-Id": { "description": "Correlation ID matching error.request_id. Include it when contacting support.", "schema": { "type": "string" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ApiError" } } }, "headers": { "X-Helpspot-Request-Id": { "description": "Correlation ID matching error.request_id. Include it when contacting support.", "schema": { "type": "string" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ApiError" } } }, "headers": { "X-Helpspot-Request-Id": { "description": "Correlation ID matching error.request_id. Include it when contacting support.", "schema": { "type": "string" } } } }, "405": { "description": "Method Not Allowed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ApiError" } } }, "headers": { "X-Helpspot-Request-Id": { "description": "Correlation ID matching error.request_id. Include it when contacting support.", "schema": { "type": "string" } } } }, "406": { "description": "Not Acceptable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } }, "headers": { "X-Helpspot-Request-Id": { "description": "Correlation ID matching error.request_id. Include it when contacting support.", "schema": { "type": "string" } } } }, "413": { "description": "Content Too Large", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ApiError" } } }, "headers": { "X-Helpspot-Request-Id": { "description": "Correlation ID matching error.request_id. Include it when contacting support.", "schema": { "type": "string" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ApiError" } } }, "headers": { "X-Helpspot-Request-Id": { "description": "Correlation ID matching error.request_id. Include it when contacting support.", "schema": { "type": "string" } }, "Retry-After": { "description": "Seconds to wait before retrying.", "schema": { "type": "string" }, "example": "60" } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ApiError" } } }, "headers": { "X-Helpspot-Request-Id": { "description": "Correlation ID matching error.request_id. Include it when contacting support.", "schema": { "type": "string" } } } }, "503": { "description": "Service Unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ApiError" } } }, "headers": { "X-Helpspot-Request-Id": { "description": "Correlation ID matching error.request_id. Include it when contacting support.", "schema": { "type": "string" } } } } }, "security": [ { "bearerAuth": [] }, { "basicAuth": [] } ] } }, "/meta": { "get": { "operationId": "v2.meta.show", "summary": "Retrieve installation metadata", "tags": [ "System" ], "responses": { "200": { "description": "Organization name, installation URL and customer identifier. The identifier is a string, preserving leading zeros.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "url": { "type": "string" }, "id": { "type": [ "string", "null" ] } }, "required": [ "name", "url", "id" ] } }, "required": [ "data" ] } }, "application/xml": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "url": { "type": "string" }, "id": { "type": [ "string", "null" ] } }, "required": [ "name", "url", "id" ] } }, "required": [ "data" ] } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ApiError" } } }, "headers": { "X-Helpspot-Request-Id": { "description": "Correlation ID matching error.request_id. Include it when contacting support.", "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ApiError" } } }, "headers": { "X-Helpspot-Request-Id": { "description": "Correlation ID matching error.request_id. Include it when contacting support.", "schema": { "type": "string" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ApiError" } } }, "headers": { "X-Helpspot-Request-Id": { "description": "Correlation ID matching error.request_id. Include it when contacting support.", "schema": { "type": "string" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ApiError" } } }, "headers": { "X-Helpspot-Request-Id": { "description": "Correlation ID matching error.request_id. Include it when contacting support.", "schema": { "type": "string" } } } }, "405": { "description": "Method Not Allowed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ApiError" } } }, "headers": { "X-Helpspot-Request-Id": { "description": "Correlation ID matching error.request_id. Include it when contacting support.", "schema": { "type": "string" } } } }, "406": { "description": "Not Acceptable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } }, "headers": { "X-Helpspot-Request-Id": { "description": "Correlation ID matching error.request_id. Include it when contacting support.", "schema": { "type": "string" } } } }, "413": { "description": "Content Too Large", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ApiError" } } }, "headers": { "X-Helpspot-Request-Id": { "description": "Correlation ID matching error.request_id. Include it when contacting support.", "schema": { "type": "string" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ApiError" } } }, "headers": { "X-Helpspot-Request-Id": { "description": "Correlation ID matching error.request_id. Include it when contacting support.", "schema": { "type": "string" } }, "Retry-After": { "description": "Seconds to wait before retrying.", "schema": { "type": "string" }, "example": "60" } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ApiError" } } }, "headers": { "X-Helpspot-Request-Id": { "description": "Correlation ID matching error.request_id. Include it when contacting support.", "schema": { "type": "string" } } } }, "503": { "description": "Service Unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ApiError" } } }, "headers": { "X-Helpspot-Request-Id": { "description": "Correlation ID matching error.request_id. Include it when contacting support.", "schema": { "type": "string" } } } } }, "security": [ { "bearerAuth": [] }, { "basicAuth": [] } ] } }, "/audit-logs": { "get": { "operationId": "v2.audit-logs.index", "summary": "List audit log entries. Administrators only", "tags": [ "System" ], "parameters": [ { "name": "offset", "in": "query", "schema": { "type": "integer", "minimum": 0 } }, { "name": "per_page", "in": "query", "schema": { "type": "integer", "minimum": 1, "maximum": 100 } } ], "responses": { "403": { "description": "An error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ApiError" } } }, "headers": { "X-Helpspot-Request-Id": { "description": "Correlation ID matching error.request_id. Include it when contacting support.", "schema": { "type": "string" } } } }, "422": { "$ref": "#/components/responses/ValidationException" }, "200": { "description": "Administrator-only audit records, newest ID first. created_at is UTC ISO 8601 (null for unset timestamps). staff_id preserves 0 (no staff) and -1 (system). string_value, decimal_value and details preserve stored text, including empty strings; details is not automatically decoded as JSON. Decimal values are strings to avoid precision loss.", "content": { "application/json": { "schema": { "type": "object", "examples": [ { "data": [ { "id": 42, "action": "update", "object": "HS_Request", "staff_id": 7, "request_id": 123, "created_at": "2023-11-14T22:13:20Z", "integer_value": null, "string_value": "Status changed", "decimal_value": null, "ip_address": "192.0.2.1", "details": "{\"xStatus\":2}" } ], "meta": { "offset": 0, "per_page": 10, "count": 1, "has_more": false, "next_offset": null } } ], "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer" }, "action": { "type": [ "string", "null" ] }, "object": { "type": [ "string", "null" ] }, "staff_id": { "type": "integer" }, "request_id": { "type": [ "integer", "null" ] }, "created_at": { "type": [ "string", "null" ], "format": "date-time" }, "integer_value": { "type": [ "integer", "null" ] }, "string_value": { "type": [ "string", "null" ] }, "decimal_value": { "type": [ "string", "null" ] }, "ip_address": { "type": [ "string", "null" ] }, "details": { "type": [ "string", "null" ] } } } }, "meta": { "type": "object", "properties": { "offset": { "type": "integer" }, "per_page": { "type": "integer" }, "count": { "type": "integer" }, "has_more": { "type": "boolean" }, "next_offset": { "type": [ "integer", "null" ] } }, "required": [ "offset", "per_page", "count", "has_more", "next_offset" ] } }, "required": [ "data", "meta" ] } }, "application/xml": { "schema": { "type": "object", "examples": [ { "data": [ { "id": 42, "action": "update", "object": "HS_Request", "staff_id": 7, "request_id": 123, "created_at": "2023-11-14T22:13:20Z", "integer_value": null, "string_value": "Status changed", "decimal_value": null, "ip_address": "192.0.2.1", "details": "{\"xStatus\":2}" } ], "meta": { "offset": 0, "per_page": 10, "count": 1, "has_more": false, "next_offset": null } } ], "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer" }, "action": { "type": [ "string", "null" ] }, "object": { "type": [ "string", "null" ] }, "staff_id": { "type": "integer" }, "request_id": { "type": [ "integer", "null" ] }, "created_at": { "type": [ "string", "null" ], "format": "date-time" }, "integer_value": { "type": [ "integer", "null" ] }, "string_value": { "type": [ "string", "null" ] }, "decimal_value": { "type": [ "string", "null" ] }, "ip_address": { "type": [ "string", "null" ] }, "details": { "type": [ "string", "null" ] } } } }, "meta": { "type": "object", "properties": { "offset": { "type": "integer" }, "per_page": { "type": "integer" }, "count": { "type": "integer" }, "has_more": { "type": "boolean" }, "next_offset": { "type": [ "integer", "null" ] } }, "required": [ "offset", "per_page", "count", "has_more", "next_offset" ] } }, "required": [ "data", "meta" ] } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ApiError" } } }, "headers": { "X-Helpspot-Request-Id": { "description": "Correlation ID matching error.request_id. Include it when contacting support.", "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ApiError" } } }, "headers": { "X-Helpspot-Request-Id": { "description": "Correlation ID matching error.request_id. Include it when contacting support.", "schema": { "type": "string" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ApiError" } } }, "headers": { "X-Helpspot-Request-Id": { "description": "Correlation ID matching error.request_id. Include it when contacting support.", "schema": { "type": "string" } } } }, "405": { "description": "Method Not Allowed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ApiError" } } }, "headers": { "X-Helpspot-Request-Id": { "description": "Correlation ID matching error.request_id. Include it when contacting support.", "schema": { "type": "string" } } } }, "406": { "description": "Not Acceptable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } }, "headers": { "X-Helpspot-Request-Id": { "description": "Correlation ID matching error.request_id. Include it when contacting support.", "schema": { "type": "string" } } } }, "413": { "description": "Content Too Large", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ApiError" } } }, "headers": { "X-Helpspot-Request-Id": { "description": "Correlation ID matching error.request_id. Include it when contacting support.", "schema": { "type": "string" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ApiError" } } }, "headers": { "X-Helpspot-Request-Id": { "description": "Correlation ID matching error.request_id. Include it when contacting support.", "schema": { "type": "string" } }, "Retry-After": { "description": "Seconds to wait before retrying.", "schema": { "type": "string" }, "example": "60" } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ApiError" } } }, "headers": { "X-Helpspot-Request-Id": { "description": "Correlation ID matching error.request_id. Include it when contacting support.", "schema": { "type": "string" } } } }, "503": { "description": "Service Unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ApiError" } } }, "headers": { "X-Helpspot-Request-Id": { "description": "Correlation ID matching error.request_id. Include it when contacting support.", "schema": { "type": "string" } } } } }, "security": [ { "bearerAuth": [] }, { "basicAuth": [] } ] } }, "/time-events": { "get": { "operationId": "v2.time-events.index", "summary": "Search time events across requests and customers", "tags": [ "Time tracking" ], "parameters": [ { "name": "customer_id", "in": "query", "schema": { "type": "string", "maxLength": 255 } }, { "name": "email", "in": "query", "schema": { "type": "string", "format": "email", "maxLength": 100 } }, { "name": "first_name", "in": "query", "schema": { "type": "string", "maxLength": 100 } }, { "name": "last_name", "in": "query", "schema": { "type": "string", "maxLength": 100 } }, { "name": "open", "in": "query", "schema": { "type": "boolean" } }, { "name": "status_id", "in": "query", "schema": { "type": "integer", "minimum": 0 } }, { "name": "mailbox_id", "in": "query", "schema": { "type": "integer", "minimum": 0 } }, { "name": "opened_via", "in": "query", "schema": { "type": "integer", "enum": [ "1", "2", "3", "4", "5", "6", "7", "8", "9", "10", "11", "12", "13", "14" ] } }, { "name": "category_id", "in": "query", "schema": { "type": "integer", "minimum": 0 } }, { "name": "urgent", "in": "query", "schema": { "type": "boolean" } }, { "name": "assigned_staff_id", "in": "query", "schema": { "type": "integer", "minimum": 0 } }, { "name": "opened_by_staff_id", "in": "query", "schema": { "type": "integer", "minimum": 0 } }, { "name": "custom_fields[]", "in": "query", "schema": { "type": "array", "items": { "type": "string" }, "maxItems": 100 } }, { "name": "start_time", "in": "query", "schema": { "type": "integer", "minimum": 0 } }, { "name": "end_time", "in": "query", "schema": { "type": "integer", "minimum": 0 } }, { "name": "order_by", "in": "query", "schema": { "type": "string" } }, { "name": "direction", "in": "query", "schema": { "type": "string", "enum": [ "asc", "desc" ] } } ], "responses": { "422": { "$ref": "#/components/responses/ValidationException" }, "200": { "description": "Time event resource. See the Time tracking guide.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/TimeEventSearchResult" } } }, "required": [ "data" ] } }, "application/xml": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/TimeEventSearchResult" } } }, "required": [ "data" ] } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ApiError" } } }, "headers": { "X-Helpspot-Request-Id": { "description": "Correlation ID matching error.request_id. Include it when contacting support.", "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ApiError" } } }, "headers": { "X-Helpspot-Request-Id": { "description": "Correlation ID matching error.request_id. Include it when contacting support.", "schema": { "type": "string" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ApiError" } } }, "headers": { "X-Helpspot-Request-Id": { "description": "Correlation ID matching error.request_id. Include it when contacting support.", "schema": { "type": "string" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ApiError" } } }, "headers": { "X-Helpspot-Request-Id": { "description": "Correlation ID matching error.request_id. Include it when contacting support.", "schema": { "type": "string" } } } }, "405": { "description": "Method Not Allowed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ApiError" } } }, "headers": { "X-Helpspot-Request-Id": { "description": "Correlation ID matching error.request_id. Include it when contacting support.", "schema": { "type": "string" } } } }, "406": { "description": "Not Acceptable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } }, "headers": { "X-Helpspot-Request-Id": { "description": "Correlation ID matching error.request_id. Include it when contacting support.", "schema": { "type": "string" } } } }, "413": { "description": "Content Too Large", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ApiError" } } }, "headers": { "X-Helpspot-Request-Id": { "description": "Correlation ID matching error.request_id. Include it when contacting support.", "schema": { "type": "string" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ApiError" } } }, "headers": { "X-Helpspot-Request-Id": { "description": "Correlation ID matching error.request_id. Include it when contacting support.", "schema": { "type": "string" } }, "Retry-After": { "description": "Seconds to wait before retrying.", "schema": { "type": "string" }, "example": "60" } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ApiError" } } }, "headers": { "X-Helpspot-Request-Id": { "description": "Correlation ID matching error.request_id. Include it when contacting support.", "schema": { "type": "string" } } } }, "503": { "description": "Service Unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ApiError" } } }, "headers": { "X-Helpspot-Request-Id": { "description": "Correlation ID matching error.request_id. Include it when contacting support.", "schema": { "type": "string" } } } } }, "security": [ { "bearerAuth": [] }, { "basicAuth": [] } ] } }, "/time-events/{timeEvent}": { "delete": { "operationId": "v2.time-events.destroy", "summary": "Delete a time event", "tags": [ "Time tracking" ], "parameters": [ { "name": "timeEvent", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "403": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ApiError" } } }, "headers": { "X-Helpspot-Request-Id": { "description": "Correlation ID matching error.request_id. Include it when contacting support.", "schema": { "type": "string" } } } }, "200": { "description": "Operation result.", "content": { "application/json": { "schema": { "type": "object", "properties": { "deleted": { "type": "boolean" } }, "required": [ "deleted" ] } }, "application/xml": { "schema": { "type": "object", "properties": { "deleted": { "type": "boolean" } }, "required": [ "deleted" ] } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ApiError" } } }, "headers": { "X-Helpspot-Request-Id": { "description": "Correlation ID matching error.request_id. Include it when contacting support.", "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ApiError" } } }, "headers": { "X-Helpspot-Request-Id": { "description": "Correlation ID matching error.request_id. Include it when contacting support.", "schema": { "type": "string" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ApiError" } } }, "headers": { "X-Helpspot-Request-Id": { "description": "Correlation ID matching error.request_id. Include it when contacting support.", "schema": { "type": "string" } } } }, "405": { "description": "Method Not Allowed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ApiError" } } }, "headers": { "X-Helpspot-Request-Id": { "description": "Correlation ID matching error.request_id. Include it when contacting support.", "schema": { "type": "string" } } } }, "406": { "description": "Not Acceptable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } }, "headers": { "X-Helpspot-Request-Id": { "description": "Correlation ID matching error.request_id. Include it when contacting support.", "schema": { "type": "string" } } } }, "413": { "description": "Content Too Large", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ApiError" } } }, "headers": { "X-Helpspot-Request-Id": { "description": "Correlation ID matching error.request_id. Include it when contacting support.", "schema": { "type": "string" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ApiError" } } }, "headers": { "X-Helpspot-Request-Id": { "description": "Correlation ID matching error.request_id. Include it when contacting support.", "schema": { "type": "string" } }, "Retry-After": { "description": "Seconds to wait before retrying.", "schema": { "type": "string" }, "example": "60" } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ApiError" } } }, "headers": { "X-Helpspot-Request-Id": { "description": "Correlation ID matching error.request_id. Include it when contacting support.", "schema": { "type": "string" } } } }, "503": { "description": "Service Unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ApiError" } } }, "headers": { "X-Helpspot-Request-Id": { "description": "Correlation ID matching error.request_id. Include it when contacting support.", "schema": { "type": "string" } } } } }, "security": [ { "bearerAuth": [] }, { "basicAuth": [] } ] } }, "/webhooks": { "post": { "operationId": "v2.webhooks.store", "summary": "Subscribe a URL to request-created or request-updated events", "tags": [ "Webhooks" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StoreWebhookRequest" } } } }, "responses": { "403": { "description": "An error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ApiError" } } }, "headers": { "X-Helpspot-Request-Id": { "description": "Correlation ID matching error.request_id. Include it when contacting support.", "schema": { "type": "string" } } } }, "422": { "$ref": "#/components/responses/ValidationException" }, "201": { "description": "Operation result.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "integer" } }, "required": [ "id" ] } }, "required": [ "data" ] } }, "application/xml": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "integer" } }, "required": [ "id" ] } }, "required": [ "data" ] } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ApiError" } } }, "headers": { "X-Helpspot-Request-Id": { "description": "Correlation ID matching error.request_id. Include it when contacting support.", "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ApiError" } } }, "headers": { "X-Helpspot-Request-Id": { "description": "Correlation ID matching error.request_id. Include it when contacting support.", "schema": { "type": "string" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ApiError" } } }, "headers": { "X-Helpspot-Request-Id": { "description": "Correlation ID matching error.request_id. Include it when contacting support.", "schema": { "type": "string" } } } }, "405": { "description": "Method Not Allowed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ApiError" } } }, "headers": { "X-Helpspot-Request-Id": { "description": "Correlation ID matching error.request_id. Include it when contacting support.", "schema": { "type": "string" } } } }, "406": { "description": "Not Acceptable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } }, "headers": { "X-Helpspot-Request-Id": { "description": "Correlation ID matching error.request_id. Include it when contacting support.", "schema": { "type": "string" } } } }, "413": { "description": "Content Too Large", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ApiError" } } }, "headers": { "X-Helpspot-Request-Id": { "description": "Correlation ID matching error.request_id. Include it when contacting support.", "schema": { "type": "string" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ApiError" } } }, "headers": { "X-Helpspot-Request-Id": { "description": "Correlation ID matching error.request_id. Include it when contacting support.", "schema": { "type": "string" } }, "Retry-After": { "description": "Seconds to wait before retrying.", "schema": { "type": "string" }, "example": "60" } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ApiError" } } }, "headers": { "X-Helpspot-Request-Id": { "description": "Correlation ID matching error.request_id. Include it when contacting support.", "schema": { "type": "string" } } } }, "503": { "description": "Service Unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ApiError" } } }, "headers": { "X-Helpspot-Request-Id": { "description": "Correlation ID matching error.request_id. Include it when contacting support.", "schema": { "type": "string" } } } } }, "security": [ { "bearerAuth": [] }, { "basicAuth": [] } ] } }, "/webhooks/{webhook}": { "delete": { "operationId": "v2.webhooks.destroy", "summary": "Delete a webhook subscription", "tags": [ "Webhooks" ], "parameters": [ { "name": "webhook", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Operation result.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "integer" }, "deleted": { "type": "boolean" } }, "required": [ "id", "deleted" ] } }, "required": [ "data" ] } }, "application/xml": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "integer" }, "deleted": { "type": "boolean" } }, "required": [ "id", "deleted" ] } }, "required": [ "data" ] } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ApiError" } } }, "headers": { "X-Helpspot-Request-Id": { "description": "Correlation ID matching error.request_id. Include it when contacting support.", "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ApiError" } } }, "headers": { "X-Helpspot-Request-Id": { "description": "Correlation ID matching error.request_id. Include it when contacting support.", "schema": { "type": "string" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ApiError" } } }, "headers": { "X-Helpspot-Request-Id": { "description": "Correlation ID matching error.request_id. Include it when contacting support.", "schema": { "type": "string" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ApiError" } } }, "headers": { "X-Helpspot-Request-Id": { "description": "Correlation ID matching error.request_id. Include it when contacting support.", "schema": { "type": "string" } } } }, "405": { "description": "Method Not Allowed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ApiError" } } }, "headers": { "X-Helpspot-Request-Id": { "description": "Correlation ID matching error.request_id. Include it when contacting support.", "schema": { "type": "string" } } } }, "406": { "description": "Not Acceptable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } }, "headers": { "X-Helpspot-Request-Id": { "description": "Correlation ID matching error.request_id. Include it when contacting support.", "schema": { "type": "string" } } } }, "413": { "description": "Content Too Large", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ApiError" } } }, "headers": { "X-Helpspot-Request-Id": { "description": "Correlation ID matching error.request_id. Include it when contacting support.", "schema": { "type": "string" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ApiError" } } }, "headers": { "X-Helpspot-Request-Id": { "description": "Correlation ID matching error.request_id. Include it when contacting support.", "schema": { "type": "string" } }, "Retry-After": { "description": "Seconds to wait before retrying.", "schema": { "type": "string" }, "example": "60" } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ApiError" } } }, "headers": { "X-Helpspot-Request-Id": { "description": "Correlation ID matching error.request_id. Include it when contacting support.", "schema": { "type": "string" } } } }, "503": { "description": "Service Unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ApiError" } } }, "headers": { "X-Helpspot-Request-Id": { "description": "Correlation ID matching error.request_id. Include it when contacting support.", "schema": { "type": "string" } } } } }, "security": [ { "bearerAuth": [] }, { "basicAuth": [] } ] } } }, "components": { "securitySchemes": { "bearerAuth": { "type": "http", "scheme": "bearer" }, "basicAuth": { "type": "http", "scheme": "basic" } }, "schemas": { "ApiError": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "fields": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } }, "request_id": { "type": "string" }, "details": { "type": "object" } }, "required": [ "code", "message", "fields", "request_id" ] } }, "required": [ "error" ], "title": "ApiError" }, "CategoryResource": { "type": "object", "properties": { "id": { "type": "integer" }, "name": { "type": [ "string", "null" ] }, "group": { "type": [ "string", "null" ] }, "inactive": { "type": "boolean" }, "allows_public_submit": { "type": "boolean" }, "default_staff_id": { "type": [ "integer", "null" ] }, "assignment_mode": { "type": "integer" }, "custom_field_ids": { "type": "array", "items": { "type": "integer" } }, "staff": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer" }, "name": { "type": [ "string", "null" ] }, "assigned_request_count": { "type": "integer" } } } }, "reporting_tags": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer" }, "name": { "type": "string" } } } } }, "title": "CategoryResource" }, "CustomFieldOption": { "type": "object", "properties": { "value": { "type": "string" }, "label": { "type": "string" }, "children": { "type": "array", "items": { "$ref": "#/components/schemas/CustomFieldOption" } } }, "required": [ "value", "label", "children" ], "title": "CustomFieldOption" }, "CustomFieldResource": { "type": "object", "properties": { "id": { "type": "integer" }, "name": { "type": [ "string", "null" ] }, "type": { "type": [ "string", "null" ] }, "required": { "type": "boolean" }, "always_visible": { "type": "boolean" }, "position": { "type": "integer" }, "max_length": { "type": "integer" }, "decimal_places": { "type": "integer" }, "pattern": { "type": [ "string", "null" ] }, "options": { "type": "array", "items": { "$ref": "#/components/schemas/CustomFieldOption" } }, "public": { "type": "boolean" } }, "title": "CustomFieldResource" }, "FilterResource": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": [ "string", "null" ] }, "global": { "type": "boolean" }, "folder": { "type": [ "string", "null" ] }, "request_count": { "type": "integer" }, "unread_count": { "type": [ "integer", "null" ] }, "last_public_update_at": { "type": [ "string", "null" ], "format": "date-time" }, "columns": { "type": "array", "items": { "type": "object", "properties": { "key": { "type": "string" }, "label": { "type": "string" } } } } }, "title": "FilterResource" }, "KnowledgeBookResource": { "type": "object", "properties": { "id": { "type": "integer" }, "name": { "type": [ "string", "null" ] }, "description": { "type": [ "string", "null" ] }, "position": { "type": "integer" } }, "title": "KnowledgeBookResource" }, "KnowledgeChapterResource": { "type": "object", "properties": { "id": { "type": "integer" }, "book_id": { "type": "integer" }, "name": { "type": [ "string", "null" ] }, "position": { "type": "integer" }, "appendix": { "type": "boolean" }, "pages": { "type": "array", "items": { "$ref": "#/components/schemas/KnowledgePageResource" } } }, "title": "KnowledgeChapterResource" }, "KnowledgePageResource": { "type": "object", "properties": { "id": { "type": "integer" }, "chapter_id": { "type": "integer" }, "name": { "type": [ "string", "null" ] }, "body_html": { "type": [ "string", "null" ] }, "created_by_staff_id": { "type": [ "integer", "null" ] }, "updated_by_staff_id": { "type": [ "integer", "null" ] }, "created_at": { "type": [ "string", "null" ], "format": "date-time" }, "updated_at": { "type": [ "string", "null" ], "format": "date-time" }, "position": { "type": "integer" }, "highlighted": { "type": "boolean" }, "helpful_votes": { "type": "integer" }, "unhelpful_votes": { "type": "integer" }, "related_pages": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer" }, "name": { "type": [ "string", "null" ] }, "chapter_name": { "type": [ "string", "null" ] }, "book_id": { "type": "integer" }, "book_name": { "type": [ "string", "null" ] } } } }, "tags": { "type": "array", "items": { "type": "string" } }, "attachment_urls": { "type": "array", "items": { "type": "string" } } }, "title": "KnowledgePageResource" }, "KnowledgeSearchResult": { "type": "object", "properties": { "id": { "type": "integer" }, "name": { "type": [ "string", "null" ] }, "book_id": { "type": "integer" }, "book_name": { "type": [ "string", "null" ] }, "excerpt": { "type": [ "string", "null" ] }, "url": { "type": [ "string", "null" ] } }, "title": "KnowledgeSearchResult" }, "MailboxResource": { "type": "object", "properties": { "id": { "type": "integer" }, "reply_name": { "type": [ "string", "null" ] }, "reply_email": { "type": [ "string", "null" ] } }, "title": "MailboxResource" }, "MergeRequestRequest": { "type": "object", "properties": { "source_request_id": { "type": "integer", "minimum": 1 } }, "required": [ "source_request_id" ], "title": "MergeRequestRequest" }, "MostUsedResponseResource": { "type": "object", "properties": { "id": { "type": "integer" }, "title": { "type": [ "string", "null" ] }, "usage_count": { "type": "integer" } }, "title": "MostUsedResponseResource" }, "PredefinedResponseResource": { "type": "object", "properties": { "id": { "type": "integer" }, "title": { "type": [ "string", "null" ] }, "folder": { "type": [ "string", "null" ] }, "body_html": { "type": [ "string", "null" ] }, "owner_staff_id": { "type": "integer" } }, "title": "PredefinedResponseResource" }, "RequestResource": { "type": "object", "properties": { "id": { "type": "integer" }, "title": { "type": [ "string", "null" ] }, "customer_id": { "type": [ "string", "null" ] }, "first_name": { "type": [ "string", "null" ] }, "last_name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "phone": { "type": [ "string", "null" ] }, "category_id": { "type": [ "integer", "null" ] }, "status_id": { "type": [ "integer", "null" ] }, "assigned_staff_id": { "type": [ "integer", "null" ] }, "opened_by_staff_id": { "type": [ "integer", "null" ] }, "portal_id": { "type": [ "integer", "null" ] }, "opened_via": { "type": "integer" }, "opened_via_id": { "type": [ "integer", "null" ] }, "email_from_mailbox_id": { "type": [ "integer", "null" ] }, "open": { "type": "boolean" }, "urgent": { "type": "boolean" }, "trashed": { "type": "boolean" }, "opened_at": { "type": [ "string", "null" ], "format": "date-time" }, "closed_at": { "type": [ "string", "null" ], "format": "date-time" }, "trashed_at": { "type": [ "string", "null" ], "format": "date-time" }, "last_reply_by_staff_id": { "type": [ "integer", "null" ] }, "time_total_seconds": { "type": "integer" }, "unread": { "type": "boolean" }, "summary": { "type": [ "string", "null" ] }, "access_key": { "type": [ "string", "null" ] }, "ai_summary": { "type": [ "string", "null" ] }, "out_of_office_detected": { "type": "boolean" }, "auto_categorized": { "type": "boolean" }, "custom_fields": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer" }, "value": { "anyOf": [ { "type": "string" }, { "type": "integer" }, { "type": "boolean" }, { "type": "null" } ] } }, "required": [ "id", "value" ] } }, "history": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer" }, "request_id": { "type": "integer" }, "author_id": { "type": "integer" }, "created_at": { "type": [ "string", "null" ], "format": "date-time" }, "body_html": { "type": [ "string", "null" ] }, "public": { "type": "boolean" }, "initial": { "type": "boolean" }, "pinned": { "type": "boolean" }, "external": { "type": "boolean" }, "attachments": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer" }, "filename": { "type": [ "string", "null" ] }, "mime_type": { "type": [ "string", "null" ] }, "content_id": { "type": [ "string", "null" ] }, "public_url": { "type": [ "string", "null" ] }, "private_url": { "type": [ "string", "null" ] } } } } } } }, "reporting_tags": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer" }, "name": { "type": "string" } } } }, "subscriber_ids": { "type": "array", "items": { "type": "integer" } }, "survey_responses": { "type": "array", "items": { "type": "object", "properties": { "survey_id": { "type": "integer" }, "name": { "type": [ "string", "null" ] }, "scoring_type": { "type": [ "string", "null" ] }, "score": { "type": [ "integer", "null" ] }, "comment": { "type": [ "string", "null" ] }, "responded_at": { "type": [ "string", "null" ], "format": "date-time" } } } } }, "title": "RequestResource" }, "StaffResource": { "type": "object", "properties": { "id": { "type": "integer" }, "first_name": { "type": [ "string", "null" ] }, "last_name": { "type": [ "string", "null" ] }, "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "phone": { "type": [ "string", "null" ] }, "permission_group_id": { "type": [ "integer", "null" ] }, "inactive": { "type": "boolean" } }, "title": "StaffResource" }, "StatusResource": { "type": "object", "properties": { "id": { "type": "integer" }, "name": { "type": [ "string", "null" ] } }, "title": "StatusResource" }, "StoreContactRequest": { "type": "object", "properties": { "first_name": { "type": "string", "maxLength": 100 }, "last_name": { "type": "string", "maxLength": 100 }, "email": { "type": "string", "format": "email", "maxLength": 255 }, "title": { "type": [ "string", "null" ], "maxLength": 255 }, "description": { "type": [ "string", "null" ], "maxLength": 255 }, "highlight": { "type": "boolean" } }, "required": [ "first_name", "last_name", "email" ], "title": "StoreContactRequest" }, "StoreRequestRequest": { "type": "object", "properties": { "note": { "type": "string" }, "category_id": { "type": "integer", "minimum": 1 }, "opened_at": { "type": "integer", "minimum": 0, "maximum": 2147483647 }, "note_type": { "type": "integer", "enum": [ "0", "1", "2" ] }, "note_is_html": { "type": "boolean" }, "reporting_tags": { "type": "array", "items": { "type": "string", "maxLength": 255 }, "maxItems": 100 }, "title": { "type": "string", "maxLength": 255 }, "opened_by_staff_id": { "type": "integer", "minimum": 0 }, "assigned_staff_id": { "type": "integer", "minimum": 0 }, "open": { "type": "boolean" }, "status_id": { "type": "integer", "minimum": 0 }, "portal_id": { "type": "integer", "minimum": 0 }, "customer_id": { "type": [ "string", "null" ], "maxLength": 80 }, "first_name": { "type": [ "string", "null" ], "maxLength": 40 }, "last_name": { "type": [ "string", "null" ], "maxLength": 40 }, "email": { "type": [ "string", "null" ], "format": "email", "maxLength": 100 }, "phone": { "type": [ "string", "null" ], "maxLength": 40 }, "urgent": { "type": "boolean" }, "opened_via": { "type": "integer", "minimum": 1, "maximum": 14 }, "skip_custom_checks": { "type": "boolean" }, "email_from_mailbox_id": { "type": "integer", "minimum": 0 }, "email_cc": { "type": [ "string", "null" ] }, "email_bcc": { "type": [ "string", "null" ] }, "email_to": { "type": [ "string", "null" ] }, "notify_staff_ids": { "type": "array", "items": { "type": "integer", "minimum": 1 }, "maxItems": 100 }, "custom_fields": { "type": "array", "items": { "type": "string" } }, "attachments": { "type": "array", "items": { "type": "object", "properties": { "filename": { "type": "string", "maxLength": 255 }, "mime_type": { "type": "string", "maxLength": 255 }, "content_base64": { "type": "string" } }, "required": [ "filename", "mime_type", "content_base64" ] }, "maxItems": 9 } }, "required": [ "note", "category_id" ], "title": "StoreRequestRequest" }, "StoreTimeEventRequest": { "type": "object", "properties": { "staff_id": { "type": "integer", "minimum": 1 }, "month": { "type": "integer", "minimum": 1, "maximum": 12 }, "day": { "type": "integer", "minimum": 1, "maximum": 31 }, "year": { "type": "integer", "minimum": 1970, "maximum": 2038 }, "description": { "type": "string" }, "time": { "type": "string", "pattern": "^(?:\\d+|\\d*\\.\\d+|\\d+:[0-5]?\\d(?::[0-5]?\\d)?)$", "maxLength": 30 }, "added_at": { "type": "integer", "minimum": 0, "maximum": 2147483647 }, "billable": { "type": "boolean" } }, "required": [ "staff_id", "month", "day", "year", "description", "time" ], "title": "StoreTimeEventRequest" }, "StoreWebhookRequest": { "type": "object", "properties": { "url": { "type": "string", "format": "uri", "maxLength": 2048 }, "event": { "type": "string", "enum": [ "request_created", "request_updated" ] } }, "required": [ "url", "event" ], "title": "StoreWebhookRequest" }, "TimeEventResource": { "type": "object", "properties": { "id": { "type": "integer" }, "request_id": { "type": "integer" }, "staff_id": { "type": "integer" }, "duration_seconds": { "type": "integer" }, "billable": { "type": "boolean" }, "created_at": { "type": [ "string", "null" ], "format": "date-time" }, "description": { "type": [ "string", "null" ] }, "work_date": { "type": [ "string", "null" ], "format": "date" } }, "title": "TimeEventResource" }, "TimeEventSearchResult": { "type": "object", "properties": { "id": { "type": "integer" }, "request_id": { "type": "integer" }, "staff_id": { "type": "integer" }, "duration_seconds": { "type": "integer" }, "billable": { "type": "boolean" }, "created_at": { "type": [ "string", "null" ], "format": "date-time" }, "description": { "type": [ "string", "null" ] }, "customer_id": { "type": [ "string", "null" ] }, "first_name": { "type": [ "string", "null" ] }, "last_name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "work_date": { "type": [ "string", "null" ], "format": "date" } }, "title": "TimeEventSearchResult" }, "UpdatePortalPasswordRequest": { "type": "object", "properties": { "password": { "type": "string", "maxLength": 72 } }, "required": [ "password" ], "title": "UpdatePortalPasswordRequest" }, "UpdateRequestRequest": { "type": "object", "properties": { "note": { "type": [ "string", "null" ] }, "changed_at": { "type": "integer", "minimum": 0, "maximum": 2147483647 }, "note_type": { "type": "integer", "enum": [ "0", "1", "2" ] }, "note_is_html": { "type": "boolean" }, "reporting_tags": { "type": "array", "items": { "type": "string", "maxLength": 255 }, "maxItems": 100 }, "title": { "type": "string", "maxLength": 255 }, "acting_staff_id": { "type": "integer", "minimum": 0 }, "assigned_staff_id": { "type": "integer", "minimum": 0 }, "open": { "type": "boolean" }, "status_id": { "type": "integer", "minimum": 0 }, "category_id": { "type": "integer", "minimum": 0 }, "customer_id": { "type": [ "string", "null" ], "maxLength": 80 }, "first_name": { "type": [ "string", "null" ], "maxLength": 40 }, "last_name": { "type": [ "string", "null" ], "maxLength": 40 }, "email": { "type": [ "string", "null" ], "format": "email", "maxLength": 100 }, "phone": { "type": [ "string", "null" ], "maxLength": 40 }, "urgent": { "type": "boolean" }, "skip_reopen": { "type": "boolean" }, "skip_custom_checks": { "type": "boolean" }, "email_from_mailbox_id": { "type": "integer", "minimum": 0 }, "email_cc": { "type": [ "string", "null" ] }, "email_bcc": { "type": [ "string", "null" ] }, "email_to": { "type": [ "string", "null" ] }, "notify_staff_ids": { "type": "array", "items": { "type": "integer", "minimum": 1 }, "maxItems": 100 }, "custom_fields": { "type": "array", "items": { "type": "string" } }, "attachments": { "type": "array", "items": { "type": "object", "properties": { "filename": { "type": "string", "maxLength": 255 }, "mime_type": { "type": "string", "maxLength": 255 }, "content_base64": { "type": "string" } }, "required": [ "filename", "mime_type", "content_base64" ] }, "maxItems": 9 } }, "title": "UpdateRequestRequest" } }, "responses": { "ValidationException": { "description": "Validation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ApiError" } } }, "headers": { "X-Helpspot-Request-Id": { "description": "Correlation ID matching error.request_id. Include it when contacting support.", "schema": { "type": "string" } } } }, "ModelNotFoundException": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ApiError" } } }, "headers": { "X-Helpspot-Request-Id": { "description": "Correlation ID matching error.request_id. Include it when contacting support.", "schema": { "type": "string" } } } }, "AuthorizationException": { "description": "Authorization error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ApiError" } } }, "headers": { "X-Helpspot-Request-Id": { "description": "Correlation ID matching error.request_id. Include it when contacting support.", "schema": { "type": "string" } } } } } } }