# initdesk API

> initdesk public API docs and reference

## Docs

- [List custom preset filters](https://developers.initdesk.com/api-reference/custom-preset-filters/list-custom-preset-filters.md): Return saved ticket search filters visible to the caller. Integration tokens receive organization-shared filters only.
- [Retrieve custom preset filter](https://developers.initdesk.com/api-reference/custom-preset-filters/retrieve-custom-preset-filter.md): Return a saved ticket search filter by ID. Integration tokens may only retrieve organization-shared filters.
- [Create customer](https://developers.initdesk.com/api-reference/customers/create-customer.md): Create a requester (customer) in the organization.
- [List customers](https://developers.initdesk.com/api-reference/customers/list-customers.md): Return requesters (customers) for the organization.
- [Retrieve customer](https://developers.initdesk.com/api-reference/customers/retrieve-customer.md): Return a requester by ID.
- [Update customer](https://developers.initdesk.com/api-reference/customers/update-customer.md): Replace requester fields (full update).
- [Create article](https://developers.initdesk.com/api-reference/help-center/create-article.md): Create a knowledge base article.
- [Create collection](https://developers.initdesk.com/api-reference/help-center/create-collection.md): Create a knowledge base collection.
- [Delete article](https://developers.initdesk.com/api-reference/help-center/delete-article.md): Delete an article. Address the article by ID or slug.
- [Delete collection](https://developers.initdesk.com/api-reference/help-center/delete-collection.md): Delete a collection.
- [Get portal favicon URL](https://developers.initdesk.com/api-reference/help-center/get-portal-favicon-url.md): Retrieve the portal favicon URL for the given size (pixels).
- [Get portal logo URL](https://developers.initdesk.com/api-reference/help-center/get-portal-logo-url.md): Retrieve the portal logo URL for the given size. Use a number for a square image (e.g. 128), or a number with 'h'/'w' suffix to constrain height or width while preserving aspect ratio (e.g. 100h or 100w).
- [Get portal settings](https://developers.initdesk.com/api-reference/help-center/get-portal-settings.md): Return the organization's support portal settings. Creates a portal record if one does not exist yet.
- [List articles](https://developers.initdesk.com/api-reference/help-center/list-articles.md): Return knowledge base articles for the organization. Filter by collection or publication status with query parameters.
- [List collection tree](https://developers.initdesk.com/api-reference/help-center/list-collection-tree.md): Return collections as a nested tree. Use include_articles to embed articles per collection node.
- [List collections](https://developers.initdesk.com/api-reference/help-center/list-collections.md): Return knowledge base collections for the organization's portal.
- [Partially update article](https://developers.initdesk.com/api-reference/help-center/partially-update-article.md): Update selected article fields. Address the article by ID or slug.
- [Partially update collection](https://developers.initdesk.com/api-reference/help-center/partially-update-collection.md): Update selected collection fields.
- [Replace portal settings](https://developers.initdesk.com/api-reference/help-center/replace-portal-settings.md): Replace all portal settings for the organization (full update).
- [Retrieve article](https://developers.initdesk.com/api-reference/help-center/retrieve-article.md): Return an article by ID or slug.
- [Retrieve collection](https://developers.initdesk.com/api-reference/help-center/retrieve-collection.md): Return a collection by ID.
- [Search knowledge base articles](https://developers.initdesk.com/api-reference/help-center/search-knowledge-base-articles.md): Search articles by title, excerpt, and markdown content. Results are limited by the limit query parameter.
- [Update article](https://developers.initdesk.com/api-reference/help-center/update-article.md): Replace article fields (full update). Address the article by ID or slug.
- [Update collection](https://developers.initdesk.com/api-reference/help-center/update-collection.md): Replace collection fields (full update).
- [Update portal settings](https://developers.initdesk.com/api-reference/help-center/update-portal-settings.md): Partially update portal settings for the organization.
- [List inboxes](https://developers.initdesk.com/api-reference/inboxes/list-inboxes.md): Return all inboxes for the organization. On ticket create, inbox_id is optional: omit to route to the default inbox (is_default: true), or provide an inbox ID from this list to target a specific mailbox.
- [Retrieve inbox](https://developers.initdesk.com/api-reference/inboxes/retrieve-inbox.md): Return inbox details, including email prefix and whether it is the default inbox for the organization.
- [List organizations](https://developers.initdesk.com/api-reference/organizations/list-organizations.md): List organizations the authenticated user belongs to. Use the organization ID in subsequent API paths. Filter by name with `search`.
- [Retrieve organization](https://developers.initdesk.com/api-reference/organizations/retrieve-organization.md): Retrieve an organization by its internal ID or public_id.
- [List organization tags](https://developers.initdesk.com/api-reference/tags/list-organization-tags.md): Return all tags defined for the organization, including id, name, and color.
- [Retrieve organization tag](https://developers.initdesk.com/api-reference/tags/retrieve-organization-tag.md): Return a single organization tag by ID.
- [Create ticket](https://developers.initdesk.com/api-reference/tickets/create-ticket.md): Create a ticket. Optional `inbox_id` targets a specific inbox; when omitted, the ticket routes to the organization's default inbox (is_default: true). Use `created_by_role` to choose associate-on-behalf (agent logs a ticket for a requester; always emails the customer) versus customer self-service (r…
- [Download ticket attachment](https://developers.initdesk.com/api-reference/tickets/download-ticket-attachment.md): Redirects to the attachment file URL in storage (HTTP redirect response).
- [List ticket messages](https://developers.initdesk.com/api-reference/tickets/list-ticket-messages.md): Return messages for a ticket.
- [List ticket statuses](https://developers.initdesk.com/api-reference/tickets/list-ticket-statuses.md): Return all ticket status values with human-readable labels (enum value and description per entry).
- [List tickets](https://developers.initdesk.com/api-reference/tickets/list-tickets.md): Return tickets for the organization. By default only non-spam tickets are included; pass `is_spam=true` to list spam tickets. Filter by requester with `customer_id`.
- [Reply or create internal note](https://developers.initdesk.com/api-reference/tickets/reply-or-create-internal-note.md): Add a reply or internal note to the ticket. For customer-visible replies, optional `external_recipient_emails` sets CC recipients for that message; omit or null to reuse CC recipients from the previous customer-visible message or from ticket creation. Internal notes ignore this field.
- [Retrieve ticket](https://developers.initdesk.com/api-reference/tickets/retrieve-ticket.md): Return full ticket details for the given ticket ID. To retrieve its messages (replies and internal notes), use the `messages` endpoint.
- [Search tickets](https://developers.initdesk.com/api-reference/tickets/search-tickets.md): Performs full text & faceted search over tickets. Use `preset_filter` to apply one of the predefined filter sets. Use `custom_preset_filter` (UUID) to apply a saved custom filter. Filter by tag with `tags` (repeat for OR matching). Filter by assignee with `assignee` (organization user ID).
- [Unassign ticket](https://developers.initdesk.com/api-reference/tickets/unassign-ticket.md): Removes the current assignee from the ticket (sets assignee to null) and returns updated ticket details.
- [Authentication and limits](https://developers.initdesk.com/authentication.md)
- [initdesk API](https://developers.initdesk.com/endpoints.md)
- [Entities and relationships](https://developers.initdesk.com/main-entities.md)

## OpenAPI Specs

- [schema](https://api.initdesk.com/schema.yaml)