{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"46140d6e-d451-4957-8c84-3bbbb438e781","name":"Claritalk API","description":"This documentation describes the Claritalk API endpoints. In case you have any feedback or miss certain functionality, let us know via [support@claritalk.com](https://support.claritalk.com/).\n\n# API endpoint\n\n- The base API endpoint for all requests (excluding the authentication calls) is:\n    - **Production environment:** [https://app.claritalk.com/api/](https://app.claritalk.com/api/)\n    - **Staging environment:** [https://staging.claritalk.com/api/](https://staging.claritalk.com/api/)\n\n# Status codes\n\n- `200` OK: the request was processed successfully\n- `201` Created: the resource was created successfully\n- `204` No Content: the request was processed successfully with no response body\n- `400` Bad request: the endpoint was called using invalid data\n- `401` Unauthorized: invalid or missing access token\n- `403` Forbidden: insufficient permissions for this action\n- `404` Resource not found: make sure the correct URL was used\n- `409` Conflict: resource state conflict (e.g., active recording already exists)\n- `422` Unprocessable entity: validation failed or integration error\n- `429` Too many requests: the rate limit is currently set at 480 calls/min. Except for the upload/recordings call. That one allows for 50 calls/min.\n- `500` Internal Server Error: an unexpected error occurred. Contact support if this problem keeps occurring.\n- `503` Service Unavailable: Claritalk Connect desktop client is not connected\n\n# Authentication\n\nThe Claritalk API uses **OAuth 2.0** (via Laravel Passport) for authentication. There are three ways to authenticate:\n\n1. **OAuth with callback URL** — for end user authentication (recommended for integrations)\n2. **Personal Access Token (PAT)** — for individual user API access\n3. **Service Account (Client Credentials)** — for server-to-server integrations\n\nWhichever method is used, the token always has to be added to the `Authorization` header with a `Bearer` prefix. Example: `Authorization: Bearer xyz`\n\n## OAuth with callback URL (recommended)\n\nFor 3rd party integrators who want to build an API integration for multiple organisations, contact [support@claritalk.com](mailto:support@claritalk.com) to request a `client_id` and `client_secret`. Tell us about your use case and which redirect URL(s) you want to use.\n\nYou will need to register a `redirect URL` that will be called after the user logs in.\n\nExample: `https://yourcompany.com/claritalk/callback`\n\n### 1. Setup the authorization URL\n\nThe authorization URL is: `https://app.claritalk.com/oauth/authorize`\n\nThe following query string parameters should be added (make sure to use URL encoding):\n\n| Parameter | Description |\n|-----------|-------------|\n| `client_id` | The client ID received from the Claritalk team |\n| `response_type` | Must be `code` |\n| `scope` | `api.connect` (add `offline_access` for refresh tokens) |\n| `redirect_uri` | Your registered callback URL |\n| `state` | Optional state parameter returned in the callback |\n\n### 2. Obtaining an access token\n\nAfter the user logs in, your callback URL receives a `GET` request with a `code` query parameter.\n\nThe token endpoint is: `https://app.claritalk.com/oauth/token`\n\nMake a `POST` call with `Content-Type: application/x-www-form-urlencoded`:\n\n| Parameter | Value |\n|-----------|-------|\n| `code` | The authorization code from the callback |\n| `redirect_uri` | Your registered callback URL |\n| `grant_type` | `authorization_code` |\n| `client_id` | Your client ID |\n| `client_secret` | Your client secret |\n\nResponse:\n```json\n{\n  \"access_token\": \"eyJ0eXAi...\",\n  \"token_type\": \"Bearer\",\n  \"expires_in\": 3600,\n  \"refresh_token\": \"def50200...\"\n}\n```\n\n- `access_token`: valid for **1 hour**\n- `refresh_token`: valid for **7 days** since last use. If not used within 7 days, the user must re-authenticate.\n\n### 3. Refreshing an access token\n\nEndpoint: `https://app.claritalk.com/oauth/token`\n\nMake a `POST` call with `Content-Type: application/x-www-form-urlencoded`:\n\n| Parameter | Value |\n|-----------|-------|\n| `refresh_token` | Your stored refresh token |\n| `grant_type` | `refresh_token` |\n| `client_id` | Your client ID |\n| `client_secret` | Your client secret |\n\nReturns a new access token and refresh token (same structure as above).\n\n## Personal Access Token (PAT)\n\nFor individual users who need API access for their own tools or scripts. PATs are scoped to the user who created them.\n\n**To create a PAT:**\n1. Log in to Claritalk\n2. Go to **Settings** > **API Tokens** > **Personal Access Tokens**\n3. Click **Create Token**, give it a name\n4. Copy the token immediately — it will not be shown again\n\nUse the token in the `Authorization` header: `Authorization: Bearer {your-pat-token}`\n\n**Characteristics:**\n- Scoped to the creating user — sees only data that user has access to\n- Does not expire (but can be revoked at any time from the settings page)\n- End user permissions apply: can only access own meetings, cannot manage other users\n- Rate limited: max 10 token creations per minute\n\n## Service Account (Client Credentials)\n\nFor server-to-server integrations that need tenant-wide access without a specific user context. Service accounts have elevated permissions.\n\n**To create a Service Account:**\n1. Log in to Claritalk as an **Organisation Admin**\n2. Go to **Settings** > **API Tokens** > **Service Accounts**\n3. Click **Create Service Account**, give it a name\n4. Copy the `client_id` and `client_secret` immediately — the secret will not be shown again\n\n**To obtain a token:**\n\nEndpoint: `https://app.claritalk.com/oauth/token`\n\n| Parameter | Value |\n|-----------|-------|\n| `grant_type` | `client_credentials` |\n| `client_id` | Your service account client ID |\n| `client_secret` | Your service account client secret |\n| `scope` | `api.connect` |\n\nResponse:\n```json\n{\n  \"access_token\": \"eyJ0eXAi...\",\n  \"token_type\": \"Bearer\",\n  \"expires_in\": 3600\n}\n```\n\n> **Note:** Client credentials grant does not return a refresh token. Request a new token when the current one expires.\n\n**Characteristics:**\n- Tenant-wide access: sees all meetings, users, teams, and dossiers in the organisation\n- Can create/delete users, invite users, create organisations\n- Can create meetings on behalf of any user\n- Rate limited: max 5 service account creations per minute\n- Only Organisation Admins can create service accounts\n\n# Authorization Scoping\n\nThe API enforces a **two-tier access model** based on the caller type:\n\n| Capability | End User (PAT / OAuth) | Service Account |\n|-----------|----------------------|-----------------|\n| List meetings | Own + shared + team-linked only | All in organisation |\n| Create meeting | For self only | For any user |\n| Update user | Own profile only (no role changes) | Any user in organisation |\n| Delete user | Not allowed | Allowed |\n| Invite user | Not allowed | Allowed |\n| Create organisation | Not allowed | Allowed |\n| List teams/dossiers | Accessible only | All in organisation |\n\n# Multi-Tenancy\n\nAll authenticated requests are scoped to the tenant (organisation) associated with the Bearer token. The tenant is extracted from the token automatically.\n\n# Rate Limits\n\n- Default: **480 requests/minute**\n- Upload/recording endpoints: **50 requests/minute**\n- Token creation: **10/minute** (PAT), **5/minute** (Service Account)\n\n# Webhooks\n\nWebhooks provide real-time notifications when events occur. Claritalk sends a `POST` request to your registered URL.\n\n**Supported events:**\n\n| Event | Trigger | Data |\n|-------|---------|------|\n| `meeting.status.changed` | Meeting status transitions | Meeting object |\n| `meeting.processed` | All AI processing complete (summary, questions, topics, coaching) | Full meeting data + PDF report |\n| `users.created` | New user created | User object |\n\n### `meeting.processed` payload\n\nFires after all post-processing steps complete. Includes the full meeting with summary, themed questions, discussion topics, todos, metadata, and a base64-encoded PDF summary report.\n\n```json\n{\n  \"event\": \"meeting.processed\",\n  \"timestamp\": \"2025-01-15T11:00:00Z\",\n  \"data\": {\n    \"userId\": \"550e8400-e29b-41d4-a716-446655440000\",\n    \"meetingId\": \"660e8400-e29b-41d4-a716-446655440000\",\n    \"title\": \"Weekly standup\",\n    \"status\": \"Meeting processed\",\n    \"summaryQualityFlag\": false,\n    \"createdAt\": \"2025-01-15 10:00:00\",\n    \"updatedAt\": \"2025-01-15 11:00:00\",\n    \"locale\": \"en\",\n    \"themes\": [...],\n    \"summary\": {\n      \"general\": { \"type\": \"general\", \"content\": \"...\" }\n    },\n    \"todos\": [...],\n    \"metadata\": {},\n    \"discussionTopics\": [...],\n    \"files\": {\n      \"filename\": \"weekly-standup-summary-report.pdf\",\n      \"content\": \"<base64-encoded PDF>\"\n    }\n  },\n  \"meta\": {\n    \"source\": \"claritalk\",\n    \"version\": \"1.0\"\n  }\n}\n```\n\n### Generic payload\n\n```json\n{\n  \"event\": \"meeting.status.changed\",\n  \"timestamp\": \"2025-01-15T10:00:00Z\",\n  \"data\": { ... },\n  \"meta\": {\n    \"source\": \"claritalk\",\n    \"version\": \"1.0\"\n  }\n}\n```\n\nRegister your webhook URL via the `POST /client/webhook` endpoint or by providing a `webhook_url` when creating an organisation.\n\n---\n\n*Contact [support@claritalk.com](mailto:support@claritalk.com) for questions or API access.*","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":true,"owner":"37292144","team":6368307,"collectionId":"46140d6e-d451-4957-8c84-3bbbb438e781","publishedId":"2sB2qi9xwo","public":true,"publicUrl":"https://apidocs.claritalk.com","privateUrl":"https://go.postman.co/documentation/37292144-46140d6e-d451-4957-8c84-3bbbb438e781","customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"682577"},"documentationLayout":"classic-double-column","customisation":{"metaTags":[{"name":"description","value":""},{"name":"title","value":"Claritalk API documentation"}],"appearance":{"default":"light","themes":[{"name":"dark","logo":"https://content.pstmn.io/7d9fc6f9-ad46-4e49-9186-2d67c121fdeb/X0xPR09fQ0xBUklUQUxLX0xPR09fQUxULnBuZw==","colors":{"top-bar":"212121","right-sidebar":"303030","highlight":"FCF4DE"}},{"name":"light","logo":"https://content.pstmn.io/154e83ad-2542-44c4-83c6-7746d0554a28/X0xPR09fQ0xBUklUQUxLX0hPT0ZETE9HTyAoMykucG5n","colors":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"682577"}}]}},"version":"8.10.0","publishDate":"2025-06-04T12:44:42.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{"title":"Claritalk API documentation","description":""},"logos":{"logoLight":"https://content.pstmn.io/154e83ad-2542-44c4-83c6-7746d0554a28/X0xPR09fQ0xBUklUQUxLX0hPT0ZETE9HTyAoMykucG5n","logoDark":"https://content.pstmn.io/7d9fc6f9-ad46-4e49-9186-2d67c121fdeb/X0xPR09fQ0xBUklUQUxLX0xPR09fQUxULnBuZw=="}},"statusCode":200},"environments":[],"user":{"authenticated":false,"permissions":{"publish":false}},"run":{"button":{"js":"https://run.pstmn.io/button.js","css":"https://run.pstmn.io/button.css"}},"web":"https://www.getpostman.com/","team":{"logo":"https://res.cloudinary.com/postman/image/upload/t_team_logo_pubdoc/v1/team/02a0bd8e428d4f608ab6cc5977b49e2081b359e94dc13610acb0209a0f92f48a","favicon":"https://claritalk.com/favicon.ico"},"isEnvFetchError":false,"languages":"[{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"HttpClient\"},{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"RestSharp\"},{\"key\":\"curl\",\"label\":\"cURL\",\"variant\":\"cURL\"},{\"key\":\"dart\",\"label\":\"Dart\",\"variant\":\"http\"},{\"key\":\"go\",\"label\":\"Go\",\"variant\":\"Native\"},{\"key\":\"http\",\"label\":\"HTTP\",\"variant\":\"HTTP\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"OkHttp\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"Unirest\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"Fetch\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"jQuery\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"XHR\"},{\"key\":\"c\",\"label\":\"C\",\"variant\":\"libcurl\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Axios\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Native\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Request\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Unirest\"},{\"key\":\"objective-c\",\"label\":\"Objective-C\",\"variant\":\"NSURLSession\"},{\"key\":\"ocaml\",\"label\":\"OCaml\",\"variant\":\"Cohttp\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"cURL\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"Guzzle\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"HTTP_Request2\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"pecl_http\"},{\"key\":\"powershell\",\"label\":\"PowerShell\",\"variant\":\"RestMethod\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"http.client\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"Requests\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"httr\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"RCurl\"},{\"key\":\"ruby\",\"label\":\"Ruby\",\"variant\":\"Net::HTTP\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"Httpie\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"wget\"},{\"key\":\"swift\",\"label\":\"Swift\",\"variant\":\"URLSession\"}]","languageSettings":[{"key":"csharp","label":"C#","variant":"HttpClient"},{"key":"csharp","label":"C#","variant":"RestSharp"},{"key":"curl","label":"cURL","variant":"cURL"},{"key":"dart","label":"Dart","variant":"http"},{"key":"go","label":"Go","variant":"Native"},{"key":"http","label":"HTTP","variant":"HTTP"},{"key":"java","label":"Java","variant":"OkHttp"},{"key":"java","label":"Java","variant":"Unirest"},{"key":"javascript","label":"JavaScript","variant":"Fetch"},{"key":"javascript","label":"JavaScript","variant":"jQuery"},{"key":"javascript","label":"JavaScript","variant":"XHR"},{"key":"c","label":"C","variant":"libcurl"},{"key":"nodejs","label":"NodeJs","variant":"Axios"},{"key":"nodejs","label":"NodeJs","variant":"Native"},{"key":"nodejs","label":"NodeJs","variant":"Request"},{"key":"nodejs","label":"NodeJs","variant":"Unirest"},{"key":"objective-c","label":"Objective-C","variant":"NSURLSession"},{"key":"ocaml","label":"OCaml","variant":"Cohttp"},{"key":"php","label":"PHP","variant":"cURL"},{"key":"php","label":"PHP","variant":"Guzzle"},{"key":"php","label":"PHP","variant":"HTTP_Request2"},{"key":"php","label":"PHP","variant":"pecl_http"},{"key":"powershell","label":"PowerShell","variant":"RestMethod"},{"key":"python","label":"Python","variant":"http.client"},{"key":"python","label":"Python","variant":"Requests"},{"key":"r","label":"R","variant":"httr"},{"key":"r","label":"R","variant":"RCurl"},{"key":"ruby","label":"Ruby","variant":"Net::HTTP"},{"key":"shell","label":"Shell","variant":"Httpie"},{"key":"shell","label":"Shell","variant":"wget"},{"key":"swift","label":"Swift","variant":"URLSession"}],"languageOptions":[{"label":"C# - HttpClient","value":"csharp - HttpClient - C#"},{"label":"C# - RestSharp","value":"csharp - RestSharp - C#"},{"label":"cURL - cURL","value":"curl - cURL - cURL"},{"label":"Dart - http","value":"dart - http - Dart"},{"label":"Go - Native","value":"go - Native - Go"},{"label":"HTTP - HTTP","value":"http - HTTP - HTTP"},{"label":"Java - OkHttp","value":"java - OkHttp - Java"},{"label":"Java - Unirest","value":"java - Unirest - Java"},{"label":"JavaScript - Fetch","value":"javascript - Fetch - JavaScript"},{"label":"JavaScript - jQuery","value":"javascript - jQuery - JavaScript"},{"label":"JavaScript - XHR","value":"javascript - XHR - JavaScript"},{"label":"C - libcurl","value":"c - libcurl - C"},{"label":"NodeJs - Axios","value":"nodejs - Axios - NodeJs"},{"label":"NodeJs - Native","value":"nodejs - Native - NodeJs"},{"label":"NodeJs - Request","value":"nodejs - Request - NodeJs"},{"label":"NodeJs - Unirest","value":"nodejs - Unirest - NodeJs"},{"label":"Objective-C - NSURLSession","value":"objective-c - NSURLSession - Objective-C"},{"label":"OCaml - Cohttp","value":"ocaml - Cohttp - OCaml"},{"label":"PHP - cURL","value":"php - cURL - PHP"},{"label":"PHP - Guzzle","value":"php - Guzzle - PHP"},{"label":"PHP - HTTP_Request2","value":"php - HTTP_Request2 - PHP"},{"label":"PHP - pecl_http","value":"php - pecl_http - PHP"},{"label":"PowerShell - RestMethod","value":"powershell - RestMethod - PowerShell"},{"label":"Python - http.client","value":"python - http.client - Python"},{"label":"Python - Requests","value":"python - Requests - Python"},{"label":"R - httr","value":"r - httr - R"},{"label":"R - RCurl","value":"r - RCurl - R"},{"label":"Ruby - Net::HTTP","value":"ruby - Net::HTTP - Ruby"},{"label":"Shell - Httpie","value":"shell - Httpie - Shell"},{"label":"Shell - wget","value":"shell - wget - Shell"},{"label":"Swift - URLSession","value":"swift - URLSession - Swift"}],"layoutOptions":[{"value":"classic-single-column","label":"Single Column"},{"value":"classic-double-column","label":"Double Column"}],"versionOptions":[],"environmentOptions":[{"value":"0","label":"No Environment"}],"canonicalUrl":"https://apidocs.claritalk.com/view/metadata/2sB2qi9xwo"}