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

# Introduction

> Connect your own systems to your social media and messaging workspace.

These docs cover the APIs and webhooks available on your platform. Everything here works the same way whichever brand you sign in under. Wherever you see `app.example.com`, use the domain you normally sign in to.

> [card] [Quickstart](https://workspace.guide/quickstart.md)
>
> Create an API key and make your first request in a few minutes.

> [card] [Authentication](https://workspace.guide/authentication.md)
>
> Workspace API keys, headers and permissions.

> [card] [Messaging API](https://workspace.guide/messaging/account/get-the-authenticated-workspace.md)
>
> Contacts, conversations, messages, broadcasts and automations.

> [card] [Publishing API](https://workspace.guide/publishing/diagnostics/check-your-key.md)
>
> Social accounts, posts, scheduling and media.

> [card] [Link in Bio API](https://workspace.guide/biolinks/pages/list-pages.md)
>
> Bio pages, short links, QR codes and custom domains.

> [card] [Webhooks](https://workspace.guide/webhooks/overview.md)
>
> Get notified when posts publish, contacts are created or messages arrive.

> [card] [Zapier](https://workspace.guide/zapier.md)
>
> Connect without writing code.

## The APIs

| | Messaging API | Publishing API | Link in Bio API |
| - | - | - | - |
| Covers | Contacts, tags, segments, conversations, messages, broadcasts, automations, media | Social accounts, posts, scheduling, approval, tags, media, analytics | Bio pages and blocks, short links, QR codes, pixels, form submissions, analytics, custom domains |
| Base URL | `https://app.example.com/api/v1` | `https://app.example.com/os/api/{workspace-uuid}` | `https://app.example.com/api/v1/biolinks` |
| Workspace | Chosen by the API key | In the URL, and must match the API key | Chosen by the API key |

One workspace API key can call every API, as long as you give it the permissions for each when you create it.

> [!NOTE]
>
> Some features depend on your plan and on what your platform has turned on. If an endpoint returns `404` even with a valid key, the feature is not available on your workspace yet.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.