# Circe Links

> HTTP API + MCP for Circe deeplinks, bio pages, groups, and analytics.

Base URL: https://api.circe.links/v1
Docs: https://linkdev.circe.systems/docs/api
Full docs dump: https://linkdev.circe.systems/llms-full.txt
Design system: https://linkdev.circe.systems/design.md

## Get started

- [Introduction](https://linkdev.circe.systems/docs/api.md): Welcome to the Circe API — automate deeplinks, bio pages, groups, and analytics.
- [Quickstart](https://linkdev.circe.systems/docs/api/quickstart.md): Create an API key and make your first Circe API request in minutes.
- [Authentication](https://linkdev.circe.systems/docs/api/authentication.md): Authenticate Circe API requests with Bearer crc_ API keys.

## Guides

- [Creating links](https://linkdev.circe.systems/docs/api/guides/creating-links.md): How to create Circe deeplinks and direct links via the API.
- [Analytics](https://linkdev.circe.systems/docs/api/guides/analytics.md): Pull Circe link and account analytics over the API.
- [Error handling](https://linkdev.circe.systems/docs/api/guides/error-handling.md): Error response shape and common Circe API error codes.

## API Reference

- [Endpoints index](https://linkdev.circe.systems/docs/api/reference.md): Browse all Circe API endpoints

### Account

- [GET Get account overview](https://linkdev.circe.systems/docs/api/reference/account/get-account.md): High-level snapshot of your Circe account: link counts, websites, and top links by clicks.

### Links

- [GET List links](https://linkdev.circe.systems/docs/api/reference/links/list-links.md): Retrieve all deeplinks and direct links on your account.
- [POST Create link](https://linkdev.circe.systems/docs/api/reference/links/create-link.md): Create a new Circe deeplink or direct link.
- [GET Get link](https://linkdev.circe.systems/docs/api/reference/links/get-link.md): Retrieve a single link by id.
- [PATCH Update link](https://linkdev.circe.systems/docs/api/reference/links/update-link.md): Update destination, name, behavior, group, or active state.
- [POST Pause link](https://linkdev.circe.systems/docs/api/reference/links/pause-link.md): Disable a link without deleting it.
- [POST Activate link](https://linkdev.circe.systems/docs/api/reference/links/activate-link.md): Re-enable a paused link.
- [DELETE Delete link](https://linkdev.circe.systems/docs/api/reference/links/delete-link.md): Permanently delete a link.
- [GET Get link analytics](https://linkdev.circe.systems/docs/api/reference/links/link-analytics.md): Clicks, views, CTR, countries, devices, and sources for a link.

### Groups

- [GET List groups](https://linkdev.circe.systems/docs/api/reference/groups/list-groups.md): Retrieve all link groups with link counts.
- [POST Create group](https://linkdev.circe.systems/docs/api/reference/groups/create-group.md): Create a new group to organize your links.
- [DELETE Delete group](https://linkdev.circe.systems/docs/api/reference/groups/delete-group.md): Delete a group. Links are not deleted — they are simply ungrouped later when reassigned.
- [POST Assign links to group](https://linkdev.circe.systems/docs/api/reference/groups/assign-links.md): Add or remove links from a group.

### Websites

- [GET List bio pages](https://linkdev.circe.systems/docs/api/reference/websites/list-websites.md): List all Circe bio / website pages.
- [POST Create bio page](https://linkdev.circe.systems/docs/api/reference/websites/create-website.md): Create a new Circe bio / link-in-bio website.
- [GET Get bio page](https://linkdev.circe.systems/docs/api/reference/websites/get-website.md): Retrieve a bio page by id.
- [PATCH Update bio page](https://linkdev.circe.systems/docs/api/reference/websites/update-website.md): Update copy or publish/unpublish a bio page.
- [DELETE Delete bio page](https://linkdev.circe.systems/docs/api/reference/websites/delete-website.md): Permanently delete a bio page and its slug.
- [GET Get bio page analytics](https://linkdev.circe.systems/docs/api/reference/websites/website-analytics.md): Analytics for a bio / website page.

### Analytics

- [GET Get summary analytics](https://linkdev.circe.systems/docs/api/reference/analytics/get-summary.md): Aggregated clicks/views across a sample of your links.

## Design

- [Design system](https://linkdev.circe.systems/design.md): Brand, color, typography, and UI rules