# Introduction

> Welcome to the TickOS API. Build support tickets, transactional email and customer flows in minutes.

Source: https://tickos.dev/docs

The TickOS API is organized around REST. It uses predictable resource-oriented URLs, accepts JSON-encoded request bodies, returns JSON responses, and uses standard HTTP response codes.

## Base URL

All API requests should be made to:

```bash
https://api.tickos.dev
```

Every endpoint lives under the /v1 namespace, e.g. https://api.tickos.dev/v1/tickets.

## Resources

| Resource | What it covers |
|---|---|
| /v1/tickets | Support tickets, messages, drafts, tags, management actions (status, assignment...) and ticket stats. |
| /v1/messages | Attachments of a ticket message. |
| /v1/customers | Customers (contacts) linked to tickets and emails. |
| /v1/contact-groups | Contact groups and their members. |
| /v1/surveys | Customer satisfaction (CSAT) survey responses and stats. |
| /v1/emails | Transactional email sending (raw or from a template), scheduling and stats. |
| /v1/campaigns | Broadcast email campaigns, test sends, settings and unsubscribes. |
| /v1/uploads | Image uploads for broadcast content and the workspace logo. |
| /v1/inboxes | Inboxes (channels), their settings and webhooks. |
| /v1/tags | Labels you can assign to tickets. |
| /v1/connections | Email domain connections and outbound domain verification. |
| /v1/automations | Automation flows, steps, enrollments and manual or API triggers. |
| /v1/changelog | Product changelog entries published on your help center. |
| /v1/users | Workspace members (agents), e.g. to assign tickets. |
| /v1/members | Add members to the workspace or remove them. |
| /v1/invitations | Invite people to the workspace by email. |
| /v1/accounts | Workspaces the API key owner belongs to (GET). |
| /v1/keys | API key management. |

Some products have their own guides: the help center (knowledge base and changelog), scheduling (booking pages) and the SMTP relay for sending email from any SMTP client.

> **Try it out:** Every endpoint in these docs is also available in the Playground, with a Send button and live code snippets.