This documentation describes the Claritalk API endpoints. In case you have any feedback or miss certain functionality, let us know via support@claritalk.com.
\n200 OK: the request was processed successfully201 Created: the resource was created successfully204 No Content: the request was processed successfully with no response body400 Bad request: the endpoint was called using invalid data401 Unauthorized: invalid or missing access token403 Forbidden: insufficient permissions for this action (or the user's licence is blocked, see Licensing)404 Resource not found: make sure the correct URL was used409 Conflict: resource state conflict (e.g., active recording already exists)422 Unprocessable entity: validation failed or integration error429 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.500 Internal Server Error: an unexpected error occurred. Contact support if this problem keeps occurring.503 Service Unavailable: Claritalk Connect desktop client is not connectedThe Claritalk API uses OAuth 2.0 (via Laravel Passport) for authentication. There are three ways to authenticate:
\nWhichever method is used, the token always has to be added to the Authorization header with a Bearer prefix. Example: Authorization: Bearer xyz
For 3rd party integrators who want to build an API integration for multiple organisations, contact 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.
You will need to register a redirect URL that will be called after the user logs in.
Example: https://yourcompany.com/claritalk/callback
The authorization URL is: https://app.claritalk.com/oauth/authorize
The following query string parameters should be added (make sure to use URL encoding):
\nAfter the user logs in, your callback URL receives a GET request with a code query parameter.
The token endpoint is: https://app.claritalk.com/oauth/token
Make a POST call with Content-Type: application/x-www-form-urlencoded:
Response:
\n{\n \"access_token\": \"eyJ0eXAi...\",\n \"token_type\": \"Bearer\",\n \"expires_in\": 3600,\n \"refresh_token\": \"def50200...\"\n}\naccess_token: valid for 1 hourrefresh_token: valid for 7 days since last use. If not used within 7 days, the user must re-authenticate.Endpoint: https://app.claritalk.com/oauth/token
Make a POST call with Content-Type: application/x-www-form-urlencoded:
Returns a new access token and refresh token (same structure as above).
\nFor individual users who need API access for their own tools or scripts. PATs are scoped to the user who created them.
\nTo create a PAT:
\nUse the token in the Authorization header: Authorization: Bearer {your-pat-token}
Characteristics:
\nFor server-to-server integrations that need tenant-wide access without a specific user context. Service accounts have elevated permissions.
\nTo create a Service Account:
\nclient_id and client_secret immediately — the secret will not be shown againTo obtain a token:
\nEndpoint: https://app.claritalk.com/oauth/token
Response:
\n{\n \"access_token\": \"eyJ0eXAi...\",\n \"token_type\": \"Bearer\",\n \"expires_in\": 3600\n}\n\n\nNote: Client credentials grant does not return a refresh token. Request a new token when the current one expires.
\n
Characteristics:
\nThe API enforces a two-tier access model based on the caller type:
\nAll authenticated requests are scoped to the tenant (organisation) associated with the Bearer token. The tenant is extracted from the token automatically.
\nWhen an end user's trial has expired or their licence has lapsed, every API endpoint refuses the request with:
\n403 Forbidden
\n{\n \"message\": \"Your trial has ended\",\n \"billing_blocked\": true\n}\nmessage is translated to the user's language; rely on the billing_blocked flag, not the text.
These endpoints stay available to a blocked user, so a client can explain why access is blocked:
\nGET /user/meGET /user/me/billingDo not treat this 403 as an invalid session: logging the user out hides the reason from them.
\nWebhooks provide real-time notifications when events occur. Claritalk sends a POST request to your registered URL.
Supported events:
\nmeeting.processed payloadFires 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 \"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 \"event\": \"meeting.status.changed\",\n \"timestamp\": \"2025-01-15T10:00:00Z\",\n \"data\": { ... },\n \"meta\": {\n \"source\": \"claritalk\",\n \"version\": \"1.0\"\n }\n}\nRegister your webhook URL via the POST /client/webhook endpoint or by providing a webhook_url when creating an organisation.
Contact support@claritalk.com for questions or API access.
\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[{"content":"API endpoint","slug":"api-endpoint"},{"content":"Status codes","slug":"status-codes"},{"content":"Authentication","slug":"authentication"},{"content":"Authorization Scoping","slug":"authorization-scoping"},{"content":"Multi-Tenancy","slug":"multi-tenancy"},{"content":"Licensing","slug":"licensing"},{"content":"Rate Limits","slug":"rate-limits"},{"content":"Webhooks","slug":"webhooks"}],"owner":"37292144","collectionId":"46140d6e-d451-4957-8c84-3bbbb438e781","publishedId":"2sB2qi9xwo","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"682577"},"publishDate":"2025-06-04T12:44:42.000Z"},"item":[{"name":"Users","item":[{"name":"Get current user","id":"62caeed7-0c66-4386-a0b1-6eae2ee5f22c","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://app.claritalk.com/api/user/me","description":"Retrieve the currently authenticated user's profile, including role and permission scopes.
\nNone.
\n200 OK
\n{\n \"user\": {\n \"id\": 1,\n \"uuid\": \"550e8400-e29b-41d4-a716-446655440000\",\n \"name\": \"Jane Doe\",\n \"email\": \"jane@company.com\",\n \"locale\": \"en\",\n \"role\": \"admin\",\n \"scopes\": [\n \"organisation_settings_meeting_question_viewlist\",\n \"organisation_settings_meeting_question_delete\"\n ],\n \"organisation\": { \"uuid\": \"...\", \"name\": \"Acme\" },\n \"transcription_provider\": \"gladia\",\n \"local_transcription\": { \"enabled\": false, \"model\": null },\n \"ai_chat_enabled\": true\n }\n}\nList all users in the authenticated tenant's organisation.
\n200 OK
\n[\n {\n \"id\": \"550e8400-e29b-41d4-a716-446655440000\",\n \"name\": \"Jane Doe\",\n \"email\": \"jane@company.com\",\n \"locale\": \"en\",\n \"createdAt\": \"2025-01-15 10:00:00\",\n \"updatedAt\": \"2025-01-15 10:00:00\"\n }\n]\nRetrieve a specific user by UUID or email address. At least one filter is required.
\n\n\n*At least one of
\nuuidor
200 OK
\n{\n \"id\": \"550e8400-e29b-41d4-a716-446655440000\",\n \"name\": \"Jane Doe\",\n \"email\": \"jane@company.com\",\n \"locale\": \"en\",\n \"createdAt\": \"2025-01-15 10:00:00\",\n \"updatedAt\": \"2025-01-15 10:00:00\"\n}\nUser UUID
\n","type":"text/plain"},"key":"uuid","value":""},{"description":{"content":"User email address
\n","type":"text/plain"},"key":"email","value":"jane@company.com"}],"variable":[]}},"response":[],"_postman_id":"cc6bbc14-5dcb-4bec-a8e0-7ea352597c91"},{"name":"Update user","id":"bb24f001-7a6b-44a5-837a-6059e9d01cd2","request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"name\": \"Jane Smith\",\n \"email\": \"jane.smith@company.com\"\n}"},"url":"https://app.claritalk.com/api/users/:uuid","description":"Update a user's profile.
\n204 No Content
\nfirstName is present, lastName is used as given (omitting it sets it to null). Otherwise name is split on the first space.User UUID
\n","type":"text/plain"},"type":"any","value":"","key":"uuid"}]}},"response":[],"_postman_id":"bb24f001-7a6b-44a5-837a-6059e9d01cd2"},{"name":"Delete user","id":"05201fb0-40ba-44b0-8046-ca38efbe6a7e","request":{"method":"DELETE","header":[{"key":"Accept","value":"application/json"}],"url":"https://app.claritalk.com/api/users/:uuid/delete","description":"Remove a user from the organisation.
\n202 Accepted — deletion is queued and runs asynchronously.
\n{ \"message\": \"User deletion started\" }\n409 body
\n{\n \"code\": 409,\n \"error\": \"This person is your billing admin. Transfer billing to someone else before deleting them.\",\n \"reason\": \"billing_admin_must_be_transferred\"\n}\nBranch on reason, not on error: the message is localised.
User UUID
\n","type":"text/plain"},"type":"any","value":"","key":"uuid"}]}},"response":[],"_postman_id":"05201fb0-40ba-44b0-8046-ca38efbe6a7e"},{"name":"Invite user","id":"f8bda0ca-44c6-4325-b0cb-5240e8a1e67a","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"name\": \"John Doe\",\n \"email\": \"john@company.com\",\n \"role\": \"user\",\n \"bypass\": false\n}"},"url":"https://app.claritalk.com/api/users/invite","description":"Invite a new user to the organisation. An invitation email is sent automatically.
\n200 OK
\n{\n \"message\": \"Invitation sent\",\n \"user\": {\n \"id\": \"550e8400-e29b-41d4-a716-446655440000\",\n \"name\": \"John Doe\",\n \"email\": \"john@company.com\",\n \"locale\": \"en\",\n \"createdAt\": \"2025-01-15 10:00:00\",\n \"updatedAt\": \"2025-01-15 10:00:00\"\n }\n}\nManage users within your organisation. The /user/me endpoint returns the authenticated user's profile including role and permissions.
List all organisations accessible to the authenticated user, including child organisations.
\n200 OK
\n[\n {\n \"id\": 1,\n \"uuid\": \"550e8400-e29b-41d4-a716-446655440000\",\n \"name\": \"Acme Corp\",\n \"domain\": \"acme.com\",\n \"children\": []\n }\n]\nCreate a new child organisation. Optionally register a webhook URL (creates an OAuth client).
\n201 Created
\n{ \"message\": \"Organisation created\" }\nwebhook_url; look them up afterwards.Manage organisations and their settings.
\n","_postman_id":"281a567e-dcd2-4bec-8675-08d1dc057410","auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"accessTokenUrl","value":"List all meeting types for the organisation.
\n200 OK
\n[\n { \"id\": 1, \"name\": \"Sales Call\", \"is_default\": true },\n { \"id\": 2, \"name\": \"Interview\", \"is_default\": false }\n]\nCreate a new meeting type or update an existing one.
\n200 OK — The meeting type object.
\nDelete a meeting type.
\n200 OK — Empty JSON response.
\nMeeting type ID
\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[],"_postman_id":"1ce547a4-b6c3-40e7-aa8e-e83be2e85072"}],"id":"22936c8e-e5ad-4744-b63d-fe0f90759513","description":"Meeting types categorize meetings within your organisation (e.g., Sales Call, Interview).
\n","_postman_id":"22936c8e-e5ad-4744-b63d-fe0f90759513","auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"accessTokenUrl","value":"List all meeting themes for the organisation.
\n200 OK — Array of theme objects.
\nCreate a new theme or update an existing one.
\n200 OK — The theme object.
\nDelete a meeting theme.
\n200 OK — Empty JSON response.
\nTheme ID
\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[],"_postman_id":"e90e8016-516c-4492-b347-4d0e15f12444"}],"id":"d0efd9b5-0258-4400-af46-591e41334f18","description":"Themes group questions under a meeting type.
\n","_postman_id":"d0efd9b5-0258-4400-af46-591e41334f18","auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"accessTokenUrl","value":"List all questions linked to a theme.
\n200 OK — Array of question objects.
\norganisation_settings_meeting_question_viewlist permission.Theme ID
\n","type":"text/plain"},"type":"any","value":"","key":"themeId"}]}},"response":[],"_postman_id":"456260f7-5c6f-4b97-8847-f861aa8c0e4c"},{"name":"Create or update question","id":"c908fede-94f1-4b8c-b91b-95529cbbc50d","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"id\": 0,\n \"question\": \"What is the client's main pain point?\",\n \"output_type\": \"single_line\"\n}"},"url":"https://app.claritalk.com/api/themes/:themeId/questions","description":"Create or update a question under a theme.
\n200 OK — The question object.
\nTheme ID
\n","type":"text/plain"},"type":"any","value":"","key":"themeId"}]}},"response":[],"_postman_id":"c908fede-94f1-4b8c-b91b-95529cbbc50d"},{"name":"Delete question","id":"93759585-5491-48cf-8353-97f5e68225b7","request":{"method":"DELETE","header":[{"key":"Accept","value":"application/json"}],"url":"https://app.claritalk.com/api/themes/:themeId/questions/:questionId","description":"Delete a question from a theme.
\n200 OK — Empty JSON response.
\norganisation_settings_meeting_question_delete permission.Theme ID
\n","type":"text/plain"},"type":"any","value":"","key":"themeId"},{"description":{"content":"Question ID
\n","type":"text/plain"},"type":"any","value":"","key":"questionId"}]}},"response":[],"_postman_id":"93759585-5491-48cf-8353-97f5e68225b7"}],"id":"e51c5c43-063b-48ff-9762-82b174bae15b","description":"Questions linked to meeting themes. Questions are automatically copied to meetings when created.
\n","_postman_id":"e51c5c43-063b-48ff-9762-82b174bae15b","auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"accessTokenUrl","value":"List meetings with pagination and optional filters.
\n200 OK
\n[\n {\n \"id\": \"550e8400-e29b-41d4-a716-446655440000\",\n \"userId\": 1,\n \"userUuid\": \"...\",\n \"name\": \"Weekly standup\",\n \"status\": \"finished\",\n \"summary_quality_flag\": false,\n \"locale\": \"en\",\n \"createdAt\": \"2025-01-15 10:00:00\",\n \"updatedAt\": \"2025-01-15 11:00:00\"\n }\n]\nq searches within the meetings the caller can access; it does not widen access.Max results (default: 10)
\n","type":"text/plain"},"key":"limit","value":"10"},{"description":{"content":"Pagination offset (default: 0)
\n","type":"text/plain"},"key":"offset","value":"0"},{"description":{"content":"Sort order: asc or desc (default: desc)
\n","type":"text/plain"},"key":"order","value":"desc"},{"disabled":true,"description":{"content":"Filter from date (ISO format)
\n","type":"text/plain"},"key":"date_start","value":""},{"disabled":true,"description":{"content":"Filter to date (ISO format)
\n","type":"text/plain"},"key":"date_end","value":""},{"disabled":true,"description":{"content":"Filter by status (comma-separated)
\n","type":"text/plain"},"key":"status","value":""},{"disabled":true,"description":{"content":"Search meeting names (contains match, case-insensitive). Trimmed, max 255 characters.
\n","type":"text/plain"},"key":"q","value":"standup"}],"variable":[]}},"response":[],"_postman_id":"85e08fc8-6097-4bca-9278-31c8e68f6163"},{"name":"Retrieve meeting","id":"699c2f73-d3dd-4509-849c-b69fb4d713dd","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://app.claritalk.com/api/meetings/:id","description":"Retrieve a single meeting by UUID or numeric ID.
\n200 OK
\n{\n \"id\": \"550e8400-e29b-41d4-a716-446655440000\",\n \"userId\": \"...\",\n \"name\": \"Weekly standup\",\n \"status\": \"finished\",\n \"phase\": \"processed\",\n \"upload\": null,\n \"locale\": \"en\",\n \"summary\": \"...\",\n \"summary_quality_flag\": false,\n \"summaries\": [\n { \"type\": \"general\", \"content\": \"...\" }\n ],\n \"todos\": [\n { \"id\": 1, \"task\": \"Send the proposal\", \"is_completed\": false, \"topics\": [], \"attendee\": [], \"due_date\": null }\n ],\n \"questions\": [],\n \"discussionTopics\": [],\n \"attendees\": [],\n \"type_id\": 1,\n \"dossier_id\": \"\",\n \"team_ids\": [],\n \"createdAt\": \"2025-01-15 10:00:00\",\n \"updatedAt\": \"2025-01-15 11:00:00\",\n \"metadata\": {},\n \"allow_audio_recording\": true\n}\nphase values
status values
status is kept for existing clients; new integrations should use phase. Ignore response fields you do not recognise, as fields may be added.
Include full metadata
\n","type":"text/plain"},"key":"detail","value":"true"}],"variable":[{"description":{"content":"Meeting UUID or numeric ID
\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[],"_postman_id":"699c2f73-d3dd-4509-849c-b69fb4d713dd"},{"name":"Create or update meeting","id":"16fc60b2-0da2-4bcc-b594-196cb66cd8c2","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"name\": \"Weekly standup\",\n \"user_id\": \"550e8400-e29b-41d4-a716-446655440000\",\n \"type_id\": 1,\n \"theme_ids\": [],\n \"attendees\": [\n { \"name\": \"Jane Doe\", \"integration_id\": \"ext-123\" }\n ],\n \"discussion_topics\": [\n { \"topic\": \"Q1 revenue targets\", \"integration_id\": \"topic-1\", \"description\": \"Review progress\" }\n ],\n \"locale\": \"en\",\n \"allow_audio_recording\": true\n}"},"url":"https://app.claritalk.com/api/meetings","description":"Create a new meeting or update an existing one.
\n200 OK
\n{\n \"id\": \"550e8400-e29b-41d4-a716-446655440000\",\n \"userId\": \"...\",\n \"name\": \"Weekly standup\",\n \"status\": \"draft\",\n \"phase\": \"draft\",\n \"upload\": null,\n \"locale\": \"en\",\n \"questions\": [],\n \"discussionTopics\": [],\n \"attendees\": [],\n \"summary_quality_flag\": false,\n \"summary\": \"\",\n \"summaries\": [],\n \"todos\": [],\n \"type_id\": 1,\n \"dossier_id\": null,\n \"team_ids\": null,\n \"createdAt\": \"2025-01-15 10:00:00\",\n \"updatedAt\": \"2025-01-15 10:00:00\",\n \"metadata\": {},\n \"allow_audio_recording\": true\n}\nphase values
status values
status is kept for existing clients; new integrations should use phase. Ignore response fields you do not recognise, as fields may be added.
phase: uploading), a status that would move the meeting back (e.g. to draft or ongoing) is ignored.team_ids is always null in this response; read the linked teams from GET /meetings/:id.allow_audio_recording in the response is the resolved value: always false when the organisation has audio recording disabled.type_id falls back to the organisation's default type.Delete a meeting.
\n204 No Content
\n204.204; the meeting keeps existing under the new owner.204 therefore means \"you no longer have this meeting\", not always \"the meeting was deleted\".Meeting UUID
\n","type":"text/plain"},"type":"any","value":"","key":"meetingId"}]}},"response":[],"_postman_id":"6b0baf6a-727c-4d22-b137-5481a7156062"},{"name":"Upload audio chunk","id":"306ac86b-004a-42dd-9411-63011f00d3f2","request":{"method":"POST","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"key":"audio_chunk","type":"file","description":"Audio file chunk (max 5MB)
\n","value":null},{"key":"chunk_number","value":"1","type":"text","description":"Current chunk number (1-based)
\n"},{"key":"total_chunks","value":"1","type":"text","description":"Total chunks (constant for the whole upload)
\n"},{"key":"checksum","value":"","type":"text","description":"SHA256 checksum
\n","disabled":true},{"key":"duration_in_seconds","value":"","type":"text","description":"Duration (send with every chunk)
\n","disabled":true},{"key":"stop_time","value":"","type":"text","description":"Stop time ISO (send with every chunk)
\n","disabled":true}]},"url":"https://app.claritalk.com/api/meetings/:id/upload","description":"Upload the audio of a recording in chunks. Processing starts automatically once every chunk from 1 to total_chunks has been received.
200 OK — chunk stored. Returns the current phase and the upload progress.
{\n \"phase\": \"uploading\",\n \"upload\": {\n \"total_chunks\": 3,\n \"received_count\": 2,\n \"received_chunks\": [\n { \"number\": 1, \"checksum\": \"9f86d081884c7d659a2feaa0c55ad015a3bf4f1b2b0b822cd15d6c15b0f00a08\" },\n { \"number\": 2, \"checksum\": \"60303ae22b998861bce3b28f33eec1be758a213c86c93c076dbe9f558c11c752\" }\n ],\n \"missing_chunks\": [3],\n \"complete\": false\n }\n}\nWhen the request completes the set, upload.complete is true and phase becomes processing.
upload object
upload is null when no upload is being tracked.
200 OK — audio already received (the meeting is in processing or processed). The chunk is ignored; treat the upload as done and do not retry.
{\n \"message\": \"Meeting audio already uploaded\",\n \"phase\": \"processing\"\n}\nphase values
upload.missing_chunks to finish.total_chunks mid-upload discards the chunks tracked so far and starts a new upload.upload from GET /meetings/:id (or from the last upload response) and send only the missing chunks.Meeting UUID
\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[],"_postman_id":"306ac86b-004a-42dd-9411-63011f00d3f2"},{"name":"List meeting questions","id":"50307d24-0b6a-4729-a04e-b065f9d049ce","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://app.claritalk.com/api/meeting/:meetingHashedId/questions","description":"List the meeting's themes with their questions — including each question's numeric id, its current answer, output_type and keywords.
Bearer token required (inherited collection-level OAuth2). Include Authorization: Bearer {token}.
Requires a user-bound token (authorization code / personal token). A service-account (client_credentials) token passes the bearer gate but has no user, so it is refused.
200 OK — array of meeting themes, each with a questions array. Empty array when the meeting has no themes.
[\n {\n \"id\": 731,\n \"meeting_id\": 4512,\n \"name\": \"Discovery\",\n \"type_id\": 12,\n \"created_at\": \"2026-09-30T09:12:44.000000Z\",\n \"updated_at\": \"2026-09-30T09:12:44.000000Z\",\n \"questions\": [\n {\n \"id\": 88231,\n \"meeting_id\": 4512,\n \"meeting_theme_id\": 731,\n \"question\": \"What budget is available for this project?\",\n \"answer\": \"Around EUR 50,000 for phase one.\",\n \"created_at\": \"2026-09-30T09:12:44.000000Z\",\n \"updated_at\": \"2026-09-30T10:01:02.000000Z\",\n \"output_type\": \"single_line\",\n \"keywords\": [\n \"budget\",\n \"available\",\n \"project\"\n ]\n }\n ]\n }\n]\nGET /meetings/:id returns questions with id removed.id with MD5.output_type is one of single_line, multi_line, long_text, date, integer, number, boolean, email.CanUserSeeThisMeeting).Hashed meeting id: the lowercase MD5 hex of the meeting's numeric id (e.g. md5(\"4512\")). Not the meeting UUID.
Add a new question to one of the meeting's themes. Keywords for live discussion tracking are extracted immediately (runs an AI model).
\nBearer token required (inherited collection-level OAuth2). Include Authorization: Bearer {token}.
Requires a user-bound token (authorization code / personal token). A service-account (client_credentials) token passes the bearer gate but has no user, so it is refused.
{\n \"question\": \"What is the expected go-live date?\",\n \"theme_id\": 731,\n \"answer\": \"\",\n \"output_type\": \"date\"\n}\n201 Created — the created meeting question.
\n{\n \"meeting_id\": 4512,\n \"meeting_theme_id\": 731,\n \"question\": \"What is the expected go-live date?\",\n \"output_type\": \"date\",\n \"answer\": \"\",\n \"updated_at\": \"2026-10-01T08:30:00.000000Z\",\n \"created_at\": \"2026-10-01T08:30:00.000000Z\",\n \"id\": 88240,\n \"keywords\": [\n \"expected\",\n \"go-live\",\n \"date\"\n ]\n}\n400 even for an unknown meeting.keywords field); the error is reported server-side.ai-write 30 calls/min per caller, plus the group's 60/min.Hashed meeting id: the lowercase MD5 hex of the meeting's numeric id (e.g. md5(\"4512\")). Not the meeting UUID.
Get the keywords for every question of the meeting, keyed by question id, for client-side live discussion tracking. Questions without stored keywords get them extracted on the fly (runs an AI model).
\nBearer token required (inherited collection-level OAuth2). Include Authorization: Bearer {token}.
Requires a user-bound token (authorization code / personal token). A service-account (client_credentials) token passes the bearer gate but has no user, so it is refused.
200 OK — object keyed by the question's numeric id (as a string).
\n{\n \"88231\": {\n \"keywords\": [\n \"budget\",\n \"available\",\n \"project\"\n ],\n \"title\": \"What budget is available for this project?\"\n },\n \"88240\": {\n \"keywords\": [\n \"expected\",\n \"go-live\",\n \"date\"\n ],\n \"title\": \"What is the expected go-live date?\"\n }\n}\n[], not {}.keywords is []; the request still succeeds.meeting-keywords 10 calls/min per caller per meeting, plus the group's 60/min.Hashed meeting id: the lowercase MD5 hex of the meeting's numeric id (e.g. md5(\"4512\")). Not the meeting UUID.
Save the answer to a meeting question. If no question of this meeting matches questionHashedId, a new question is created under theme_id instead (legacy web behaviour — use POST /meeting/:meetingHashedId/questions to create).
Bearer token required (inherited collection-level OAuth2). Include Authorization: Bearer {token}.
Requires a user-bound token (authorization code / personal token). A service-account (client_credentials) token passes the bearer gate but has no user, so it is refused.
{\n \"question\": \"What budget is available for this project?\",\n \"theme_id\": 731,\n \"answer\": \"Around EUR 50,000 for phase one.\",\n \"output_type\": \"single_line\"\n}\n200 OK — the meeting question.
\n{\n \"id\": 88231,\n \"meeting_id\": 4512,\n \"meeting_theme_id\": 731,\n \"question\": \"What budget is available for this project?\",\n \"answer\": \"Around EUR 50,000 for phase one.\",\n \"created_at\": \"2026-09-30T09:12:44.000000Z\",\n \"updated_at\": \"2026-09-30T10:01:02.000000Z\",\n \"output_type\": \"single_line\",\n \"keywords\": [\n \"budget\",\n \"available\",\n \"project\"\n ]\n}\nai-write 30 calls/min per caller, plus the group's 60/min.Hashed meeting id: the lowercase MD5 hex of the meeting's numeric id (e.g. md5(\"4512\")). Not the meeting UUID.
Hashed question id: lowercase MD5 hex of the question's numeric id (as returned by GET /meeting/:meetingHashedId/questions).
Generate an answer to one question from the meeting's transcript with AI, save it, and return the updated question. No request body.
\nBearer token required (inherited collection-level OAuth2). Include Authorization: Bearer {token}.
Requires a user-bound token (authorization code / personal token). A service-account (client_credentials) token passes the bearer gate but has no user, so it is refused.
200 OK — the updated meeting question.
\n{\n \"id\": 88231,\n \"meeting_id\": 4512,\n \"meeting_theme_id\": 731,\n \"question\": \"What budget is available for this project?\",\n \"answer\": \"The client has roughly EUR 50,000 available for phase one.\",\n \"created_at\": \"2026-09-30T09:12:44.000000Z\",\n \"updated_at\": \"2026-09-30T10:01:02.000000Z\",\n \"output_type\": \"single_line\",\n \"keywords\": [\n \"budget\",\n \"available\",\n \"project\"\n ]\n}\nai-turn 20 calls/min per caller, plus the group's 60/min.Hashed meeting id: the lowercase MD5 hex of the meeting's numeric id (e.g. md5(\"4512\")). Not the meeting UUID.
Hashed question id: lowercase MD5 hex of the question's numeric id (as returned by GET /meeting/:meetingHashedId/questions).
List the meeting's discussion topics, ordered by position.
Bearer token required (inherited collection-level OAuth2). Include Authorization: Bearer {token}.
Requires a user-bound token (authorization code / personal token). A service-account (client_credentials) token passes the bearer gate but has no user, so it is refused.
200 OK — array of discussion topics (empty array when none).
\n[\n {\n \"id\": \"5f0c2d1e-7a8b-4c9d-8e0f-1a2b3c4d5e6f\",\n \"integration_id\": null,\n \"title\": \"Q1 revenue targets\",\n \"description\": \"Review progress against plan\",\n \"meeting_id\": 4512,\n \"created_at\": \"2026-09-30T09:12:44.000000Z\",\n \"updated_at\": \"2026-09-30T09:12:44.000000Z\",\n \"report\": null,\n \"position\": 0,\n \"metadata\": null,\n \"keywords\": [\n \"revenue\",\n \"targets\",\n \"Q1\"\n ],\n \"meeting_type_discussion_topic_template_id\": null\n }\n]\nid is a UUID. keywords is an array or null. metadata is returned as stored (not decoded).Hashed meeting id: the lowercase MD5 hex of the meeting's numeric id (e.g. md5(\"4512\")). Not the meeting UUID.
Get the keywords for every discussion topic of the meeting, keyed by topic UUID, for client-side live discussion tracking. Topics without stored keywords get them extracted on the fly (runs an AI model).
\nBearer token required (inherited collection-level OAuth2). Include Authorization: Bearer {token}.
Requires a user-bound token (authorization code / personal token). A service-account (client_credentials) token passes the bearer gate but has no user, so it is refused.
200 OK — object mapping topic UUID to an array of keywords.
\n{\n \"5f0c2d1e-7a8b-4c9d-8e0f-1a2b3c4d5e6f\": [\n \"revenue\",\n \"targets\",\n \"Q1\"\n ]\n}\n[], not {}.[]; the request still succeeds.meeting-keywords 10 calls/min per caller per meeting, plus the group's 60/min.Hashed meeting id: the lowercase MD5 hex of the meeting's numeric id (e.g. md5(\"4512\")). Not the meeting UUID.
Create, retrieve, and manage meetings — the core resource of the Claritalk platform.
\n","_postman_id":"45f7a294-5c78-48ce-82f2-2dd04c4b10e7","auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"accessTokenUrl","value":"Opens the app and starts recording the prepared meeting identified by meeting. Title, type, dossier and discussion topics come from the meeting; the uploaded audio is attached to it.
Not an HTTP request: open this URL on the phone.
\nUUID of a meeting in draft status, as returned by POST /meetings.
Opens the app and starts a new recording with the given title. A new meeting is created on upload, as with a manual recording.
\nNot an HTTP request: open this URL on the phone.
\nMeeting title, URL-encoded.
\n","type":"text/plain"},"key":"title","value":"Weekly%20standup"}],"variable":[]}},"response":[],"_postman_id":"5f7168a6-f937-4a75-ab04-c0130f616f2f"},{"name":"Start a new meeting","id":"6f08de74-c941-4864-8855-882739b6d6bc","request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[],"url":"claritalk://record","description":"Opens the app and starts a new recording with the default title (Conversation: <date> - <time>).
Not an HTTP request: open this URL on the phone.
\n","urlObject":{"protocol":"claritalk","host":["record"],"query":[],"variable":[]}},"response":[],"_postman_id":"6f08de74-c941-4864-8855-882739b6d6bc"}],"id":"44e59ea8-6961-4e22-ad8d-cef1f8dc7a2f","description":"Open the Claritalk mobile app (iOS and Android) and start a recording from a link. Available from app version 1.3.36.
\nThese are not HTTP calls: the link is opened on the phone (from a calendar note, a message, a QR code, an Apple Shortcuts automation or a script) and is handled by the installed app. They are listed here so integrations know how to hand a prepared meeting over to the app.
\nPOST /meetings (name, user_id, type_id, dossier_id, discussion_topics, ...). The id in the response is the meeting UUID and the meeting is in draft status.claritalk://record?meeting={id} and hand it to the user: calendar invite, QR code, chat message.GET /meetings/{id}), fills in title, type, dossier and discussion topics, and starts recording immediately.recording_type becomes mobile.draft. Otherwise the app shows a message and opens the recording screen without starting.Per-user meeting reporting metrics for the authenticated tenant within a period. Intended for service-account integrations (e.g. Titeca) that pull Claritalk activity into their own reporting.
\nBearer token required (inherited from the collection's OAuth2 config).
\nX-Tenant-ID header is ignored.X-Tenant-ID header (organisation UUID). Without a resolvable tenant the request returns 404.200 OK
\n{\n \"organisation\": {\n \"uuid\": \"550e8400-e29b-41d4-a716-446655440000\",\n \"name\": \"Acme Accountants\"\n },\n \"period\": {\n \"start\": \"2026-06-01 00:00:00\",\n \"end\": \"2026-06-30 23:59:59\"\n },\n \"totals\": {\n \"meetings_total\": 128,\n \"meetings_processed\": 120,\n \"meetings_not_final\": 8,\n \"total_duration_seconds\": 274500,\n \"tasks_created\": 96,\n \"crm_pushes\": 41,\n \"approved_reports\": 110\n },\n \"users\": [\n {\n \"user_id\": 12,\n \"name\": \"Jane Doe\",\n \"email\": \"jane@acme.example\",\n \"meetings_total\": 34,\n \"meetings_processed\": 33,\n \"meetings_not_final\": 1,\n \"meetings_failed\": 0,\n \"meetings_stuck\": 1,\n \"total_duration_seconds\": 71400,\n \"tasks_created\": 28,\n \"crm_pushes\": 12,\n \"approved_reports\": 31\n }\n ]\n}\napproved_reports is null (both in totals and per user) when the tenant does not have the approval-flow feature enabled.
date_start/date_end ranges are clamped to a maximum window of 366 days (the start is pulled forward toward the end date if the range is wider).App\\Http\\Controllers\\Api\\Reporting\\RetrieveAction (SANO-2814).Named window: today, last_7_days, last_week, this_month, last_month, last_30_days, this_quarter, this_year. Default: this_month.
\n","type":"text/plain"},"key":"period","value":"this_month"},{"disabled":true,"description":{"content":"Explicit range start (YYYY-MM-DD). Overrides period when paired with date_end.
\n","type":"text/plain"},"key":"date_start","value":""},{"disabled":true,"description":{"content":"Explicit range end (YYYY-MM-DD).
\n","type":"text/plain"},"key":"date_end","value":""}],"variable":[]}},"response":[{"id":"44230fc4-a0c4-4595-a29e-5fc5e4078cfe","name":"200 OK","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"key":"X-Tenant-ID","value":"","description":"Organisation UUID. Required for service-account (client_credentials) tokens; ignored for end-user tokens.","disabled":true}],"url":{"raw":"https://app.claritalk.com/api/reporting/meetings?period=this_month","host":["https://app.claritalk.com/api"],"path":["reporting","meetings"],"query":[{"key":"period","value":"this_month","description":"Named window: today, last_7_days, last_week, this_month, last_month, last_30_days, this_quarter, this_year. Default: this_month."},{"key":"date_start","value":"","description":"Explicit range start (YYYY-MM-DD). Overrides period when paired with date_end.","disabled":true},{"key":"date_end","value":"","description":"Explicit range end (YYYY-MM-DD).","disabled":true}]},"description":"Per-user meeting reporting metrics for the authenticated tenant within a period. Intended for service-account integrations (e.g. Titeca) that pull Claritalk activity into their own reporting.\n\n### Authentication\nBearer token required (inherited from the collection's OAuth2 config).\n- **End users** (PAT / authorization code): the organisation is derived from the authenticated user; the `X-Tenant-ID` header is ignored.\n- **Service accounts** (client credentials): the organisation is selected via the `X-Tenant-ID` header (organisation UUID). Without a resolvable tenant the request returns `404`.\n\n### Parameters\n| Name | In | Type | Required | Description |\n|------|----|------|----------|-------------|\n| X-Tenant-ID | header | string (UUID) | Service accounts only | Organisation UUID to report on. Ignored for end-user tokens. |\n| period | query | string | No | Named window. One of `today`, `last_7_days`, `last_week`, `this_month`, `last_month`, `last_30_days`, `this_quarter`, `this_year`. Defaults to `this_month`. Ignored when both `date_start` and `date_end` are supplied. |\n| date_start | query | string (date) | No | Explicit range start (`YYYY-MM-DD`). Takes precedence over `period` when paired with `date_end`. |\n| date_end | query | string (date) | No | Explicit range end (`YYYY-MM-DD`). |\n\n### Response\n**200 OK**\n```json\n{\n \"organisation\": {\n \"uuid\": \"550e8400-e29b-41d4-a716-446655440000\",\n \"name\": \"Acme Accountants\"\n },\n \"period\": {\n \"start\": \"2026-06-01 00:00:00\",\n \"end\": \"2026-06-30 23:59:59\"\n },\n \"totals\": {\n \"meetings_total\": 128,\n \"meetings_processed\": 120,\n \"meetings_not_final\": 8,\n \"total_duration_seconds\": 274500,\n \"tasks_created\": 96,\n \"crm_pushes\": 41,\n \"approved_reports\": 110\n },\n \"users\": [\n {\n \"user_id\": 12,\n \"name\": \"Jane Doe\",\n \"email\": \"jane@acme.example\",\n \"meetings_total\": 34,\n \"meetings_processed\": 33,\n \"meetings_not_final\": 1,\n \"meetings_failed\": 0,\n \"meetings_stuck\": 1,\n \"total_duration_seconds\": 71400,\n \"tasks_created\": 28,\n \"crm_pushes\": 12,\n \"approved_reports\": 31\n }\n ]\n}\n```\n\n`approved_reports` is `null` (both in `totals` and per user) when the tenant does not have the approval-flow feature enabled.\n\n### Error Responses\n| Status | Condition | Body |\n|--------|-----------|------|\n| 401 | Missing/invalid token | `{\"message\": \"Unauthenticated.\"}` |\n| 404 | Tenant could not be resolved (service account with unknown/absent `X-Tenant-ID`, or user without an organisation) | `{\"message\": \"Organisation not found\"}` |\n\n### Notes\n- Rate limit: **60 requests/min** — each call fans out into several org-wide aggregation queries.\n- Explicit `date_start`/`date_end` ranges are clamped to a **maximum window of 366 days** (the start is pulled forward toward the end date if the range is wider).\n- Auto-documented from `App\\Http\\Controllers\\Api\\Reporting\\RetrieveAction` (SANO-2814)."},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"organisation\": {\n \"uuid\": \"550e8400-e29b-41d4-a716-446655440000\",\n \"name\": \"Acme Accountants\"\n },\n \"period\": {\n \"start\": \"2026-06-01 00:00:00\",\n \"end\": \"2026-06-30 23:59:59\"\n },\n \"totals\": {\n \"meetings_total\": 128,\n \"meetings_processed\": 120,\n \"meetings_not_final\": 8,\n \"total_duration_seconds\": 274500,\n \"tasks_created\": 96,\n \"crm_pushes\": 41,\n \"approved_reports\": 110\n },\n \"users\": [\n {\n \"user_id\": 12,\n \"name\": \"Jane Doe\",\n \"email\": \"jane@acme.example\",\n \"meetings_total\": 34,\n \"meetings_processed\": 33,\n \"meetings_not_final\": 1,\n \"meetings_failed\": 0,\n \"meetings_stuck\": 1,\n \"total_duration_seconds\": 71400,\n \"tasks_created\": 28,\n \"crm_pushes\": 12,\n \"approved_reports\": 31\n },\n {\n \"user_id\": 15,\n \"name\": \"John Smith\",\n \"email\": \"john@acme.example\",\n \"meetings_total\": 22,\n \"meetings_processed\": 21,\n \"meetings_not_final\": 1,\n \"meetings_failed\": 1,\n \"meetings_stuck\": 0,\n \"total_duration_seconds\": 48120,\n \"tasks_created\": 17,\n \"crm_pushes\": 6,\n \"approved_reports\": 20\n }\n ]\n}"},{"id":"f67a1867-1828-4db8-8ad8-ff3e6a05c969","name":"404 Organisation not found","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"key":"X-Tenant-ID","value":"","description":"Organisation UUID. Required for service-account (client_credentials) tokens; ignored for end-user tokens.","disabled":true}],"url":{"raw":"https://app.claritalk.com/api/reporting/meetings?period=this_month","host":["https://app.claritalk.com/api"],"path":["reporting","meetings"],"query":[{"key":"period","value":"this_month","description":"Named window: today, last_7_days, last_week, this_month, last_month, last_30_days, this_quarter, this_year. Default: this_month."},{"key":"date_start","value":"","description":"Explicit range start (YYYY-MM-DD). Overrides period when paired with date_end.","disabled":true},{"key":"date_end","value":"","description":"Explicit range end (YYYY-MM-DD).","disabled":true}]},"description":"Per-user meeting reporting metrics for the authenticated tenant within a period. Intended for service-account integrations (e.g. Titeca) that pull Claritalk activity into their own reporting.\n\n### Authentication\nBearer token required (inherited from the collection's OAuth2 config).\n- **End users** (PAT / authorization code): the organisation is derived from the authenticated user; the `X-Tenant-ID` header is ignored.\n- **Service accounts** (client credentials): the organisation is selected via the `X-Tenant-ID` header (organisation UUID). Without a resolvable tenant the request returns `404`.\n\n### Parameters\n| Name | In | Type | Required | Description |\n|------|----|------|----------|-------------|\n| X-Tenant-ID | header | string (UUID) | Service accounts only | Organisation UUID to report on. Ignored for end-user tokens. |\n| period | query | string | No | Named window. One of `today`, `last_7_days`, `last_week`, `this_month`, `last_month`, `last_30_days`, `this_quarter`, `this_year`. Defaults to `this_month`. Ignored when both `date_start` and `date_end` are supplied. |\n| date_start | query | string (date) | No | Explicit range start (`YYYY-MM-DD`). Takes precedence over `period` when paired with `date_end`. |\n| date_end | query | string (date) | No | Explicit range end (`YYYY-MM-DD`). |\n\n### Response\n**200 OK**\n```json\n{\n \"organisation\": {\n \"uuid\": \"550e8400-e29b-41d4-a716-446655440000\",\n \"name\": \"Acme Accountants\"\n },\n \"period\": {\n \"start\": \"2026-06-01 00:00:00\",\n \"end\": \"2026-06-30 23:59:59\"\n },\n \"totals\": {\n \"meetings_total\": 128,\n \"meetings_processed\": 120,\n \"meetings_not_final\": 8,\n \"total_duration_seconds\": 274500,\n \"tasks_created\": 96,\n \"crm_pushes\": 41,\n \"approved_reports\": 110\n },\n \"users\": [\n {\n \"user_id\": 12,\n \"name\": \"Jane Doe\",\n \"email\": \"jane@acme.example\",\n \"meetings_total\": 34,\n \"meetings_processed\": 33,\n \"meetings_not_final\": 1,\n \"meetings_failed\": 0,\n \"meetings_stuck\": 1,\n \"total_duration_seconds\": 71400,\n \"tasks_created\": 28,\n \"crm_pushes\": 12,\n \"approved_reports\": 31\n }\n ]\n}\n```\n\n`approved_reports` is `null` (both in `totals` and per user) when the tenant does not have the approval-flow feature enabled.\n\n### Error Responses\n| Status | Condition | Body |\n|--------|-----------|------|\n| 401 | Missing/invalid token | `{\"message\": \"Unauthenticated.\"}` |\n| 404 | Tenant could not be resolved (service account with unknown/absent `X-Tenant-ID`, or user without an organisation) | `{\"message\": \"Organisation not found\"}` |\n\n### Notes\n- Rate limit: **60 requests/min** — each call fans out into several org-wide aggregation queries.\n- Explicit `date_start`/`date_end` ranges are clamped to a **maximum window of 366 days** (the start is pulled forward toward the end date if the range is wider).\n- Auto-documented from `App\\Http\\Controllers\\Api\\Reporting\\RetrieveAction` (SANO-2814)."},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Organisation not found\"\n}"}],"_postman_id":"020e1325-17d4-48b5-9298-060d9d84d8ed"}],"id":"9ab43d34-d999-4da5-a768-5f3a67139b7a","_postman_id":"9ab43d34-d999-4da5-a768-5f3a67139b7a","description":"","auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"accessTokenUrl","value":"List all dossiers accessible to the authenticated user, with optional filters and cursor pagination.
\n200 OK, no query parameters — bare array of dossier objects (no relations).
\n200 OK, end-user token with any filter or pagination parameter — paginated envelope:
\n{\n \"data\": [\n {\n \"id\": \"550e8400-e29b-41d4-a716-446655440000\",\n \"title\": \"Acme\",\n \"description\": null,\n \"logo\": null,\n \"metadata\": {},\n \"created_at\": \"2026-09-01T10:00:00.000000Z\",\n \"updated_at\": \"2026-09-01T10:00:00.000000Z\",\n \"teams\": [],\n \"users\": [],\n \"organisations\": []\n }\n ],\n \"meta\": { \"per_page\": 15, \"has_pages\": true, \"has_more_pages\": true },\n \"links\": {\n \"prev\": null,\n \"next\": \"https://app.claritalk.com/api/dossiers/list?cursor=...\",\n \"path\": \"https://app.claritalk.com/api/dossiers/list\"\n }\n}\nMatches title or description (contains)
\n","type":"text/plain"},"key":"q","value":"acme"},{"disabled":true,"description":{"content":"Only dossiers linked to this team UUID
\n","type":"text/plain"},"key":"team_id","value":""},{"disabled":true,"description":{"content":"local or integration
adminpulse | silverfin | fid_manager | brokercloud | o365_onenote
\n","type":"text/plain"},"key":"integration","value":"silverfin"},{"disabled":true,"description":{"content":"created_at (default) | updated_at | title
\n","type":"text/plain"},"key":"sort","value":"created_at"},{"disabled":true,"description":{"content":"asc | desc (default)
\n","type":"text/plain"},"key":"dir","value":"desc"},{"disabled":true,"description":{"content":"1-100, default 15 (end-user tokens only)
\n","type":"text/plain"},"key":"per_page","value":"15"},{"disabled":true,"description":{"content":"Cursor from links.next (end-user tokens only)
\n","type":"text/plain"},"key":"cursor","value":""}],"variable":[]}},"response":[],"_postman_id":"91cb8811-87c9-447e-96ab-02665435fafb"}],"id":"c35af466-1c70-4d5b-b902-b4487e3cc6da","description":"Dossiers group related meetings together.
\n","_postman_id":"c35af466-1c70-4d5b-b902-b4487e3cc6da","auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"accessTokenUrl","value":"List the caller's tasks, grouped by meeting, with cursor pagination. Only meetings the caller can access are included.
\nBearer token required (inherited collection-level OAuth2). Include Authorization: Bearer {token}.
Requires a user-bound token (authorization code / personal token). A service-account (client_credentials) token passes the bearer gate but has no user, so it is refused.
200 OK
\n{\n \"data\": [\n {\n \"id\": 4512,\n \"uuid\": \"550e8400-e29b-41d4-a716-446655440000\",\n \"user_id\": 27,\n \"dossier_id\": \"0b7d9a52-1f3e-4c6a-9d8b-2e4f6a8c0e1d\",\n \"name\": \"Weekly standup\",\n \"tasks\": [\n {\n \"id\": 901,\n \"meeting_id\": 4512,\n \"task\": \"Send the revised proposal\",\n \"is_completed\": 0,\n \"topics\": \"Proposal\",\n \"attendee\": [\n 27,\n -1\n ],\n \"due_date\": \"2026-10-07\",\n \"created_at\": \"2026-09-30T11:00:00.000000Z\",\n \"updated_at\": \"2026-09-30T11:00:00.000000Z\",\n \"assignees\": [\n {\n \"id\": 27,\n \"name\": \"Jane Doe\"\n }\n ]\n }\n ]\n }\n ],\n \"meta\": {\n \"per_page\": 15,\n \"has_pages\": true,\n \"has_more_pages\": true\n },\n \"links\": {\n \"prev\": null,\n \"next\": \"https://app.claritalk.com/api/tasks/list?per_page=15&cursor=eyJjcmVhdGVkX2F0Ijo...\",\n \"path\": \"https://app.claritalk.com/api/tasks/list\"\n }\n}\nsort and dir apply to meetings, not tasks; each meeting carries only its tasks that match the filters.attendee holds numeric user ids (-1 = external person); assignees resolves them to {id, name} within the caller's organisation.is_completed is returned as 0/1.Search in task text and topics (contains match)
\n","type":"text/plain"},"key":"q","value":""},{"disabled":true,"description":{"content":"Due date from (date)
\n","type":"text/plain"},"key":"from","value":""},{"disabled":true,"description":{"content":"Due date until (date)
\n","type":"text/plain"},"key":"to","value":""},{"disabled":true,"description":{"content":"Meeting column to sort by: created_at (default), updated_at, name
\n","type":"text/plain"},"key":"sort","value":"created_at"},{"disabled":true,"description":{"content":"asc or desc (default: desc)
\n","type":"text/plain"},"key":"dir","value":"desc"},{"disabled":true,"description":{"content":"Meetings per page, 1-100 (default: 15)
\n","type":"text/plain"},"key":"per_page","value":"15"},{"disabled":true,"description":{"content":"Filter tasks by completion (boolean: 1/0/true/false)
\n","type":"text/plain"},"key":"is_completed","value":""},{"disabled":true,"description":{"content":"Narrow to a dossier (id)
\n","type":"text/plain"},"key":"dossier","value":""},{"disabled":true,"description":{"content":"Narrow to a team
\n","type":"text/plain"},"key":"team","value":""},{"disabled":true,"description":{"content":"Only tasks assigned to the caller (boolean)
\n","type":"text/plain"},"key":"assigned_to_me","value":""},{"disabled":true,"description":{"content":"Cursor from links.next / links.prev
\n","type":"text/plain"},"key":"cursor","value":""}],"variable":[]}},"response":[{"id":"c955f272-e7d6-47a2-a512-88a3127151a7","name":"200 OK","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"https://app.claritalk.com/api/tasks/list","host":["https://app.claritalk.com/api"],"path":["tasks","list"],"query":[{"key":"q","value":"","description":"Search in task text and topics (contains match)","disabled":true},{"key":"from","value":"","description":"Due date from (date)","disabled":true},{"key":"to","value":"","description":"Due date until (date)","disabled":true},{"key":"sort","value":"created_at","description":"Meeting column to sort by: created_at (default), updated_at, name","disabled":true},{"key":"dir","value":"desc","description":"asc or desc (default: desc)","disabled":true},{"key":"per_page","value":"15","description":"Meetings per page, 1-100 (default: 15)","disabled":true},{"key":"is_completed","value":"","description":"Filter tasks by completion (boolean: 1/0/true/false)","disabled":true},{"key":"dossier","value":"","description":"Narrow to a dossier (id)","disabled":true},{"key":"team","value":"","description":"Narrow to a team","disabled":true},{"key":"assigned_to_me","value":"","description":"Only tasks assigned to the caller (boolean)","disabled":true},{"key":"cursor","value":"","description":"Cursor from links.next / links.prev","disabled":true}]},"description":"List the caller's tasks, grouped by meeting, with cursor pagination. Only meetings the caller can access are included.\n\n### Authentication\nBearer token required (inherited collection-level OAuth2). Include `Authorization: Bearer {token}`.\n\nRequires a **user-bound** token (authorization code / personal token). A service-account (`client_credentials`) token passes the bearer gate but has no user, so it is refused.\n\n### Parameters\n| Name | In | Type | Required | Description |\n|------|----|------|----------|-------------|\n| q | query | string | No | Search task text and topics |\n| from | query | date | No | Task due date from |\n| to | query | date | No | Task due date until |\n| sort | query | string | No | Meeting column: `created_at` (default), `updated_at`, `name` |\n| dir | query | string | No | `asc` or `desc` (default `desc`) |\n| per_page | query | integer | No | Meetings per page, 1–100 (default `15`) |\n| is_completed | query | boolean | No | Filter tasks by completion |\n| dossier | query | string | No | Narrow to one dossier (never widens access) |\n| team | query | string | No | Narrow to one team (never widens access) |\n| assigned_to_me | query | boolean | No | Only tasks whose `attendee` contains the caller |\n| cursor | query | string | No | Opaque cursor from `links` |\n\n### Response\n**200 OK**\n```json\n{\n \"data\": [\n {\n \"id\": 4512,\n \"uuid\": \"550e8400-e29b-41d4-a716-446655440000\",\n \"user_id\": 27,\n \"dossier_id\": \"0b7d9a52-1f3e-4c6a-9d8b-2e4f6a8c0e1d\",\n \"name\": \"Weekly standup\",\n \"tasks\": [\n {\n \"id\": 901,\n \"meeting_id\": 4512,\n \"task\": \"Send the revised proposal\",\n \"is_completed\": 0,\n \"topics\": \"Proposal\",\n \"attendee\": [\n 27,\n -1\n ],\n \"due_date\": \"2026-10-07\",\n \"created_at\": \"2026-09-30T11:00:00.000000Z\",\n \"updated_at\": \"2026-09-30T11:00:00.000000Z\",\n \"assignees\": [\n {\n \"id\": 27,\n \"name\": \"Jane Doe\"\n }\n ]\n }\n ]\n }\n ],\n \"meta\": {\n \"per_page\": 15,\n \"has_pages\": true,\n \"has_more_pages\": true\n },\n \"links\": {\n \"prev\": null,\n \"next\": \"https://app.claritalk.com/api/tasks/list?per_page=15&cursor=eyJjcmVhdGVkX2F0Ijo...\",\n \"path\": \"https://app.claritalk.com/api/tasks/list\"\n }\n}\n```\n\n### Error Responses\n| Status | Condition | Body |\n|--------|-----------|------|\n| 403 | Service-account token (no user) | `{\"code\": 403, \"error\": \"This endpoint requires a user-bound access token.\"}` |\n| 404 | Caller has no organisation | `{\"message\": \"Organisation not found\"}` |\n| 422 | Invalid filter (e.g. `sort=due_date`, `per_page=500`) | `{\"message\": \"...\", \"errors\": {\"sort\": [\"The selected sort is invalid.\"]}}` |\n| 401 | Missing/invalid bearer token | `{\"code\": 401, \"error\": \"Unauthorized\"}` |\n| 403 | Caller's licence is blocked (trial expired) while billing enforcement is on | `{\"message\": \"Your trial has ended\", \"billing_blocked\": true}` |\n| 403 | Organisation requires 2FA and the caller has not enabled it | `{\"message\": \"...\"}` |\n| 429 | Rate limit exceeded | `{\"message\": \"Too Many Attempts.\"}` |\n\n### Notes\n- Pagination, `sort` and `dir` apply to **meetings**, not tasks; each meeting carries only its tasks that match the filters.\n- `attendee` holds numeric user ids (`-1` = external person); `assignees` resolves them to `{id, name}` within the caller's organisation.\n- `is_completed` is returned as `0`/`1`.\n- Rate limit: 60 calls/min per caller.\n- _Auto-documented from source (routes/api.php + controller)._"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": [\n {\n \"id\": 4512,\n \"uuid\": \"550e8400-e29b-41d4-a716-446655440000\",\n \"user_id\": 27,\n \"dossier_id\": \"0b7d9a52-1f3e-4c6a-9d8b-2e4f6a8c0e1d\",\n \"name\": \"Weekly standup\",\n \"tasks\": [\n {\n \"id\": 901,\n \"meeting_id\": 4512,\n \"task\": \"Send the revised proposal\",\n \"is_completed\": 0,\n \"topics\": \"Proposal\",\n \"attendee\": [\n 27,\n -1\n ],\n \"due_date\": \"2026-10-07\",\n \"created_at\": \"2026-09-30T11:00:00.000000Z\",\n \"updated_at\": \"2026-09-30T11:00:00.000000Z\",\n \"assignees\": [\n {\n \"id\": 27,\n \"name\": \"Jane Doe\"\n }\n ]\n }\n ]\n }\n ],\n \"meta\": {\n \"per_page\": 15,\n \"has_pages\": true,\n \"has_more_pages\": true\n },\n \"links\": {\n \"prev\": null,\n \"next\": \"https://app.claritalk.com/api/tasks/list?per_page=15&cursor=eyJjcmVhdGVkX2F0Ijo...\",\n \"path\": \"https://app.claritalk.com/api/tasks/list\"\n }\n}"},{"id":"5fc947ae-62d6-4fd3-b32a-19dd7f810141","name":"403 Service account","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"https://app.claritalk.com/api/tasks/list","host":["https://app.claritalk.com/api"],"path":["tasks","list"],"query":[{"key":"q","value":"","description":"Search in task text and topics (contains match)","disabled":true},{"key":"from","value":"","description":"Due date from (date)","disabled":true},{"key":"to","value":"","description":"Due date until (date)","disabled":true},{"key":"sort","value":"created_at","description":"Meeting column to sort by: created_at (default), updated_at, name","disabled":true},{"key":"dir","value":"desc","description":"asc or desc (default: desc)","disabled":true},{"key":"per_page","value":"15","description":"Meetings per page, 1-100 (default: 15)","disabled":true},{"key":"is_completed","value":"","description":"Filter tasks by completion (boolean: 1/0/true/false)","disabled":true},{"key":"dossier","value":"","description":"Narrow to a dossier (id)","disabled":true},{"key":"team","value":"","description":"Narrow to a team","disabled":true},{"key":"assigned_to_me","value":"","description":"Only tasks assigned to the caller (boolean)","disabled":true},{"key":"cursor","value":"","description":"Cursor from links.next / links.prev","disabled":true}]},"description":"List the caller's tasks, grouped by meeting, with cursor pagination. Only meetings the caller can access are included.\n\n### Authentication\nBearer token required (inherited collection-level OAuth2). Include `Authorization: Bearer {token}`.\n\nRequires a **user-bound** token (authorization code / personal token). A service-account (`client_credentials`) token passes the bearer gate but has no user, so it is refused.\n\n### Parameters\n| Name | In | Type | Required | Description |\n|------|----|------|----------|-------------|\n| q | query | string | No | Search task text and topics |\n| from | query | date | No | Task due date from |\n| to | query | date | No | Task due date until |\n| sort | query | string | No | Meeting column: `created_at` (default), `updated_at`, `name` |\n| dir | query | string | No | `asc` or `desc` (default `desc`) |\n| per_page | query | integer | No | Meetings per page, 1–100 (default `15`) |\n| is_completed | query | boolean | No | Filter tasks by completion |\n| dossier | query | string | No | Narrow to one dossier (never widens access) |\n| team | query | string | No | Narrow to one team (never widens access) |\n| assigned_to_me | query | boolean | No | Only tasks whose `attendee` contains the caller |\n| cursor | query | string | No | Opaque cursor from `links` |\n\n### Response\n**200 OK**\n```json\n{\n \"data\": [\n {\n \"id\": 4512,\n \"uuid\": \"550e8400-e29b-41d4-a716-446655440000\",\n \"user_id\": 27,\n \"dossier_id\": \"0b7d9a52-1f3e-4c6a-9d8b-2e4f6a8c0e1d\",\n \"name\": \"Weekly standup\",\n \"tasks\": [\n {\n \"id\": 901,\n \"meeting_id\": 4512,\n \"task\": \"Send the revised proposal\",\n \"is_completed\": 0,\n \"topics\": \"Proposal\",\n \"attendee\": [\n 27,\n -1\n ],\n \"due_date\": \"2026-10-07\",\n \"created_at\": \"2026-09-30T11:00:00.000000Z\",\n \"updated_at\": \"2026-09-30T11:00:00.000000Z\",\n \"assignees\": [\n {\n \"id\": 27,\n \"name\": \"Jane Doe\"\n }\n ]\n }\n ]\n }\n ],\n \"meta\": {\n \"per_page\": 15,\n \"has_pages\": true,\n \"has_more_pages\": true\n },\n \"links\": {\n \"prev\": null,\n \"next\": \"https://app.claritalk.com/api/tasks/list?per_page=15&cursor=eyJjcmVhdGVkX2F0Ijo...\",\n \"path\": \"https://app.claritalk.com/api/tasks/list\"\n }\n}\n```\n\n### Error Responses\n| Status | Condition | Body |\n|--------|-----------|------|\n| 403 | Service-account token (no user) | `{\"code\": 403, \"error\": \"This endpoint requires a user-bound access token.\"}` |\n| 404 | Caller has no organisation | `{\"message\": \"Organisation not found\"}` |\n| 422 | Invalid filter (e.g. `sort=due_date`, `per_page=500`) | `{\"message\": \"...\", \"errors\": {\"sort\": [\"The selected sort is invalid.\"]}}` |\n| 401 | Missing/invalid bearer token | `{\"code\": 401, \"error\": \"Unauthorized\"}` |\n| 403 | Caller's licence is blocked (trial expired) while billing enforcement is on | `{\"message\": \"Your trial has ended\", \"billing_blocked\": true}` |\n| 403 | Organisation requires 2FA and the caller has not enabled it | `{\"message\": \"...\"}` |\n| 429 | Rate limit exceeded | `{\"message\": \"Too Many Attempts.\"}` |\n\n### Notes\n- Pagination, `sort` and `dir` apply to **meetings**, not tasks; each meeting carries only its tasks that match the filters.\n- `attendee` holds numeric user ids (`-1` = external person); `assignees` resolves them to `{id, name}` within the caller's organisation.\n- `is_completed` is returned as `0`/`1`.\n- Rate limit: 60 calls/min per caller.\n- _Auto-documented from source (routes/api.php + controller)._"},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": 403,\n \"error\": \"This endpoint requires a user-bound access token.\"\n}"},{"id":"15854472-c798-4cc2-ab8c-964ee54c993c","name":"422 Validation error","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"https://app.claritalk.com/api/tasks/list","host":["https://app.claritalk.com/api"],"path":["tasks","list"],"query":[{"key":"q","value":"","description":"Search in task text and topics (contains match)","disabled":true},{"key":"from","value":"","description":"Due date from (date)","disabled":true},{"key":"to","value":"","description":"Due date until (date)","disabled":true},{"key":"sort","value":"created_at","description":"Meeting column to sort by: created_at (default), updated_at, name","disabled":true},{"key":"dir","value":"desc","description":"asc or desc (default: desc)","disabled":true},{"key":"per_page","value":"15","description":"Meetings per page, 1-100 (default: 15)","disabled":true},{"key":"is_completed","value":"","description":"Filter tasks by completion (boolean: 1/0/true/false)","disabled":true},{"key":"dossier","value":"","description":"Narrow to a dossier (id)","disabled":true},{"key":"team","value":"","description":"Narrow to a team","disabled":true},{"key":"assigned_to_me","value":"","description":"Only tasks assigned to the caller (boolean)","disabled":true},{"key":"cursor","value":"","description":"Cursor from links.next / links.prev","disabled":true}]},"description":"List the caller's tasks, grouped by meeting, with cursor pagination. Only meetings the caller can access are included.\n\n### Authentication\nBearer token required (inherited collection-level OAuth2). Include `Authorization: Bearer {token}`.\n\nRequires a **user-bound** token (authorization code / personal token). A service-account (`client_credentials`) token passes the bearer gate but has no user, so it is refused.\n\n### Parameters\n| Name | In | Type | Required | Description |\n|------|----|------|----------|-------------|\n| q | query | string | No | Search task text and topics |\n| from | query | date | No | Task due date from |\n| to | query | date | No | Task due date until |\n| sort | query | string | No | Meeting column: `created_at` (default), `updated_at`, `name` |\n| dir | query | string | No | `asc` or `desc` (default `desc`) |\n| per_page | query | integer | No | Meetings per page, 1–100 (default `15`) |\n| is_completed | query | boolean | No | Filter tasks by completion |\n| dossier | query | string | No | Narrow to one dossier (never widens access) |\n| team | query | string | No | Narrow to one team (never widens access) |\n| assigned_to_me | query | boolean | No | Only tasks whose `attendee` contains the caller |\n| cursor | query | string | No | Opaque cursor from `links` |\n\n### Response\n**200 OK**\n```json\n{\n \"data\": [\n {\n \"id\": 4512,\n \"uuid\": \"550e8400-e29b-41d4-a716-446655440000\",\n \"user_id\": 27,\n \"dossier_id\": \"0b7d9a52-1f3e-4c6a-9d8b-2e4f6a8c0e1d\",\n \"name\": \"Weekly standup\",\n \"tasks\": [\n {\n \"id\": 901,\n \"meeting_id\": 4512,\n \"task\": \"Send the revised proposal\",\n \"is_completed\": 0,\n \"topics\": \"Proposal\",\n \"attendee\": [\n 27,\n -1\n ],\n \"due_date\": \"2026-10-07\",\n \"created_at\": \"2026-09-30T11:00:00.000000Z\",\n \"updated_at\": \"2026-09-30T11:00:00.000000Z\",\n \"assignees\": [\n {\n \"id\": 27,\n \"name\": \"Jane Doe\"\n }\n ]\n }\n ]\n }\n ],\n \"meta\": {\n \"per_page\": 15,\n \"has_pages\": true,\n \"has_more_pages\": true\n },\n \"links\": {\n \"prev\": null,\n \"next\": \"https://app.claritalk.com/api/tasks/list?per_page=15&cursor=eyJjcmVhdGVkX2F0Ijo...\",\n \"path\": \"https://app.claritalk.com/api/tasks/list\"\n }\n}\n```\n\n### Error Responses\n| Status | Condition | Body |\n|--------|-----------|------|\n| 403 | Service-account token (no user) | `{\"code\": 403, \"error\": \"This endpoint requires a user-bound access token.\"}` |\n| 404 | Caller has no organisation | `{\"message\": \"Organisation not found\"}` |\n| 422 | Invalid filter (e.g. `sort=due_date`, `per_page=500`) | `{\"message\": \"...\", \"errors\": {\"sort\": [\"The selected sort is invalid.\"]}}` |\n| 401 | Missing/invalid bearer token | `{\"code\": 401, \"error\": \"Unauthorized\"}` |\n| 403 | Caller's licence is blocked (trial expired) while billing enforcement is on | `{\"message\": \"Your trial has ended\", \"billing_blocked\": true}` |\n| 403 | Organisation requires 2FA and the caller has not enabled it | `{\"message\": \"...\"}` |\n| 429 | Rate limit exceeded | `{\"message\": \"Too Many Attempts.\"}` |\n\n### Notes\n- Pagination, `sort` and `dir` apply to **meetings**, not tasks; each meeting carries only its tasks that match the filters.\n- `attendee` holds numeric user ids (`-1` = external person); `assignees` resolves them to `{id, name}` within the caller's organisation.\n- `is_completed` is returned as `0`/`1`.\n- Rate limit: 60 calls/min per caller.\n- _Auto-documented from source (routes/api.php + controller)._"},"status":"Unprocessable Content","code":422,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"The selected sort is invalid.\",\n \"errors\": {\n \"sort\": [\n \"The selected sort is invalid.\"\n ]\n }\n}"}],"_postman_id":"e39ce032-22d7-47f5-a0ae-c68c13a8ab33"},{"name":"Complete tasks","id":"3ad942b4-60af-4b2c-8aec-d6c36d669a61","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"meetingTaskIds\": [\n 901\n ],\n \"isCompleted\": true\n}","options":{"raw":{"language":"json"}}},"url":"https://app.claritalk.com/api/tasks/complete","description":"Mark one or more tasks complete or incomplete. All-or-nothing: if any id is not accessible to the caller, nothing is written.
\nBearer token required (inherited collection-level OAuth2). Include Authorization: Bearer {token}.
Requires a user-bound token (authorization code / personal token). A service-account (client_credentials) token passes the bearer gate but has no user, so it is refused.
{\n \"meetingTaskIds\": [\n 901\n ],\n \"isCompleted\": true\n}\n200 OK — updated is the number of rows actually written.
{\n \"message\": \"Success\",\n \"updated\": 1\n}\ntasks-write 30 calls/min per caller, plus the group's 60/min.List all teams accessible to the authenticated user.
\n200 OK — Array of team objects.
\nTeams organize users within an organisation.
\n","_postman_id":"3554f6b0-dea4-44fb-93c9-06785d44535d","auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"accessTokenUrl","value":"List all available integrations.
\n200 OK — Array of integration objects.
\nRetrieve a specific integration.
\n200 OK — Integration object.
\nIntegration ID
\n","type":"text/plain"},"type":"any","value":"","key":"integrationId"}]}},"response":[],"_postman_id":"2d1e8752-5f9b-481b-8418-01e3fd392029"},{"name":"Retrieve integration data","id":"8d466571-369d-4663-a5f7-75bcdf9bf128","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://app.claritalk.com/api/integration/data?integration_id=1","description":"Retrieve data from an integration. Optionally filter by search term.
\n200 OK
\n{ \"data\": [...], \"id\": 42 }\nIntegration ID (required)
\n","type":"text/plain"},"key":"integration_id","value":"1"},{"disabled":true,"description":{"content":"Search filter
\n","type":"text/plain"},"key":"term","value":""}],"variable":[]}},"response":[],"_postman_id":"8d466571-369d-4663-a5f7-75bcdf9bf128"},{"name":"Communicate with integration","id":"449cb1af-b33e-4212-a892-352e4f98922c","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"integration_id\": 1,\n \"user_uuid\": \"550e8400-e29b-41d4-a716-446655440000\",\n \"action\": \"relations.search\",\n \"data\": { \"term\": \"Acme\" }\n}"},"url":"https://app.claritalk.com/api/integrations/communicate","description":"Execute an action on a third-party integration.
\n200 OK
\n{ \"data\": [{ \"id\": \"ext-123\", \"label\": \"Acme Corp\" }] }\nsync triggers a full data sync from the provider.Manage third-party integrations and their data. You can retrieve a user's connections by calling /user/me.
Send a command to the Claritalk Connect desktop application via Socket.IO.
\n