# Clarity Admin API

**Canonical:** https://apis.io/apis/onclarity-com/onclarity-com-admin-api/  
**Provider:** Clarity — https://apis.io/providers/onclarity-com/  
**Base URL:** https://api.onclarity.com  
**Documentation:** https://api.onclarity.com

Clarity Admin API is one of 101 APIs that [Clarity](https://apis.io/providers/onclarity-com/) publishes on the [APIs.io](https://apis.io/) network, described by a machine-readable OpenAPI specification. This API exposes 6 JSON Schema definitions. Tagged areas include admin. The published artifact set on APIs.io includes an OpenAPI specification and 6 JSON Schemas.

The admin API from Clarity — 92 operation(s) for admin.

## Operations (60 of 136)

| Method | Path | Summary |
|---|---|---|
| GET | `/api/v1/admin/customers` | List Customers |
| GET | `/api/v1/admin/accounts` | List Accounts |
| POST | `/api/v1/admin/accounts` | Add Account |
| DELETE | `/api/v1/admin/accounts/{account_id}` | Delete Account |
| PUT | `/api/v1/admin/accounts/{account_id}` | Update Account |
| GET | `/api/v1/admin/accounts/{account_id}` | Get Account Info |
| POST | `/api/v1/admin/accounts/{account_id}/users` | Add User |
| GET | `/api/v1/admin/accounts/{account_id}/users` | List Users By Account |
| DELETE | `/api/v1/admin/accounts/{account_id}/users/{user_id}` | Delete User |
| GET | `/api/v1/admin/accounts/{account_id}/users/{user_id}` | Get User Info By Account |
| POST | `/api/v1/admin/accounts/{account_id}/projects` | Add Project |
| GET | `/api/v1/admin/accounts/{account_id}/projects` | List Projects By Account |
| POST | `/api/v1/admin/accounts/{account_id}/projects/{project_id}/link` | Add Project Link |
| DELETE | `/api/v1/admin/accounts/{account_id}/projects/{project_id}/link` | Delete Project Link |
| PUT | `/api/v1/admin/accounts/{account_id}/projects/{project_id}` | Update Project |
| DELETE | `/api/v1/admin/accounts/{account_id}/projects/{project_id}` | Delete Project |
| GET | `/api/v1/admin/accounts/{account_id}/projects/{project_id}` | Get Project Info By Account |
| POST | `/api/v1/admin/accounts/{account_id}/demo-project/link` | Add Demo Project Link |
| DELETE | `/api/v1/admin/accounts/{account_id}/demo-project/link` | Delete Demo Project Link |
| GET | `/api/v1/admin/projects` | List Projects |
| GET | `/api/v1/admin/projects/{project_id}` | Get Project Info |
| POST | `/api/v1/admin/projects/lookup-by-psk` | Lookup Project By Psk |
| GET | `/api/v1/admin/projects/{project_id}/accounts` | List Accounts By Project |
| GET | `/api/v1/admin/projects/{project_id}/accounts/{account_id}` | Get Account Info By Project |
| POST | `/api/v1/admin/projects/{project_id}/sources` | Add Source |
| GET | `/api/v1/admin/projects/{project_id}/sources` | List Sources By Project |
| PUT | `/api/v1/admin/projects/{project_id}/sources/{source_id}` | Update Source |
| DELETE | `/api/v1/admin/projects/{project_id}/sources/{source_id}` | Delete Source |
| GET | `/api/v1/admin/projects/{project_id}/sources/{source_id}` | Get Source Info |
| POST | `/api/v1/admin/projects/{project_id}/sources/{source_id}/jobs` | Run Sync Job |
| GET | `/api/v1/admin/projects/{project_id}/sources/{source_id}/jobs/last` | Get Last Sync Job Info |
| GET | `/api/v1/admin/projects/{project_id}/sources/{source_id}/jobs/last/info` | Get Last Sync Job Detailed Info |
| GET | `/api/v1/admin/projects/{project_id}/custom_prompts` | Get Custom Prompts |
| POST | `/api/v1/admin/projects/{project_id}/custom_prompts` | Add Custom Prompt |
| GET | `/api/v1/admin/projects/{project_id}/custom_prompts/{custom_prompt_id}` | Get Custom Prompt By Id |
| DELETE | `/api/v1/admin/projects/{project_id}/custom_prompts/{custom_prompt_id}` | Delete Custom Prompt By Id |
| PUT | `/api/v1/admin/projects/{project_id}/custom_prompts/{custom_prompt_id}` | Update Custom Prompt |
| GET | `/api/v1/admin/projects/{project_id}/integrations/{integration_id}` | Get Integration Info |
| GET | `/api/v1/admin/projects/{project_id}/integrations` | List Integrations By Project |
| GET | `/api/v1/admin/projects/{project_id}/sources/{source_id}/surveys` | List Surveys By Project And Source |
| GET | `/api/v1/admin/projects/{project_id}/sources/{source_id}/surveys/{survey_id}` | Get Survey By Project And Source |
| POST | `/api/v1/admin/projects/{project_id}/sources/{source_id}/surveys/{survey_id}` | Add Survey |
| PUT | `/api/v1/admin/projects/{project_id}/sources/{source_id}/surveys/{survey_id}` | Update Survey |
| DELETE | `/api/v1/admin/projects/{project_id}/sources/{source_id}/surveys/{survey_id}` | Delete Survey |
| POST | `/api/v1/admin/projects/{project_id}/sources/{source_id}/surveys/{survey_id}/responses` | Get Survey Responses |
| GET | `/api/v1/admin/projects/{project_id}/surveys` | List Surveys By Project |
| GET | `/api/v1/admin/projects/{project_id}/surveys/{survey_id}` | Get Survey By Project |
| PUT | `/api/v1/admin/projects/{project_id}/surveys/{survey_id}` | Update Survey |
| POST | `/api/v1/admin/projects/{project_id}/anecdote-surveys/{anecdote_survey_id}/email` | Send Anecdote Survey Email Admin |
| GET | `/api/v1/admin/projects/{project_id}/configs` | List Configs By Project |
| POST | `/api/v1/admin/projects/{project_id}/configs` | Add Config |
| GET | `/api/v1/admin/projects/{project_id}/configs/active` | Get Active Config |
| GET | `/api/v1/admin/projects/{project_id}/configs/latest` | Get Latest Config |
| POST | `/api/v1/admin/projects/{project_id}/configs/{config_id}/activate` | Activate Config |
| GET | `/api/v1/admin/projects/{project_id}/configs/{config_id}` | Get Config By Id |
| DELETE | `/api/v1/admin/projects/{project_id}/configs/{config_id}` | Delete Config |
| PATCH | `/api/v1/admin/projects/{project_id}/anecdotes` | Validate Anecdotes |
| POST | `/api/v1/admin/projects/{project_id}/anecdotes` | Add Anecdotes |
| GET | `/api/v1/admin/projects/{project_id}/anecdotes` | Get Anecdotes Info |
| GET | `/api/v1/admin/projects/{project_id}/taxonomies` | List Taxonomies |

…and 76 more operations. They are listed in full on the page.

## Machine-readable artifacts (7)

- **OpenAPI** — https://artifacts.apis.io/onclarity-com/openapi/onclarity-com-admin-api-openapi.yml
- **JSONSchema** — https://artifacts.apis.io/onclarity-com/json-schema/onclarity-com-dashboard-element-schema.json
- **JSONSchema** — https://artifacts.apis.io/onclarity-com/json-schema/onclarity-com-admin-build-table-request-schema.json
- **JSONSchema** — https://artifacts.apis.io/onclarity-com/json-schema/onclarity-com-update-dashboard-element-request-schema.json
- **JSONSchema** — https://artifacts.apis.io/onclarity-com/json-schema/onclarity-com-admin-deeper-search-request-schema.json
- **JSONSchema** — https://artifacts.apis.io/onclarity-com/json-schema/onclarity-com-src-routers-admin-admin-search-request-schema.json
- **JSONSchema** — https://artifacts.apis.io/onclarity-com/json-schema/onclarity-com-agent-response-schema.json

## Other Clarity APIs (12)

- [Clarity Accounts API](https://apis.io/apis/onclarity-com/onclarity-com-accounts-api/)
- [Clarity Agent Costs API](https://apis.io/apis/onclarity-com/onclarity-com-agent-costs-api/)
- [Clarity Agent Qa API](https://apis.io/apis/onclarity-com/onclarity-com-agent-qa-api/)
- [Clarity Agent Store Admin API](https://apis.io/apis/onclarity-com/onclarity-com-agent-store-admin-api/)
- [Clarity Agent Store API](https://apis.io/apis/onclarity-com/onclarity-com-agent-store-api/)
- [Clarity Agent Usage API](https://apis.io/apis/onclarity-com/onclarity-com-agent-usage-api/)
- [Clarity Anecdote Surveys API](https://apis.io/apis/onclarity-com/onclarity-com-anecdote-surveys-api/)
- [Clarity Anomalies API](https://apis.io/apis/onclarity-com/onclarity-com-anomalies-api/)
- [Clarity Asana API](https://apis.io/apis/onclarity-com/onclarity-com-asana-api/)
- [Clarity Bugs API](https://apis.io/apis/onclarity-com/onclarity-com-bugs-api/)
- [Clarity Classifications Admin API](https://apis.io/apis/onclarity-com/onclarity-com-classifications-admin-api/)
- [Clarity Classifications API](https://apis.io/apis/onclarity-com/onclarity-com-classifications-api/)

## Tags

admin

---

Profiled by [API Evangelist](https://apievangelist.com) and published on [APIs.io](https://apis.io/apis/onclarity-com/onclarity-com-admin-api/). The API's provider profile, Kin Score and agent-readiness rating are at https://apis.io/providers/onclarity-com/.