{ "components": { "securitySchemes": { "sec0": { "description": "Send the API key signature as `Authorization: Basic `.", "in": "header", "name": "Authorization", "type": "apiKey" } } }, "info": { "title": "leexi-public-api", "version": "1.0" }, "openapi": "3.1.0", "paths": { "/calls": { "get": { "description": "List all calls and meetings within the API key's access scope. Keys with whole-company access list every call; scoped keys list only the calls they can access.", "operationId": "list-calls", "parameters": [ { "in": "query", "name": "page", "schema": { "default": 1, "format": "int32", "type": "integer" } }, { "description": "min: 1, max: 100", "in": "query", "name": "items", "schema": { "default": 10, "format": "int32", "type": "integer" } }, { "in": "query", "name": "order", "schema": { "default": "created_at desc", "enum": [ "created_at desc", "created_at asc", "performed_at desc", "performed_at asc", "updated_at desc", "updated_at asc" ], "type": "string" } }, { "description": "from/to filter date", "in": "query", "name": "date_filter", "schema": { "default": "created_at", "enum": [ "created_at", "performed_at", "updated_at" ], "type": "string" } }, { "description": "YYYY-MM-DDTHH:MM:SS.000Z, this filters on the call creation date in Leexi (created_at)", "in": "query", "name": "from", "schema": { "type": "string" } }, { "description": "YYYY-MM-DDTHH:MM:SS.000Z, this filters on the call creation date in Leexi (created_at)", "in": "query", "name": "to", "schema": { "type": "string" } }, { "description": "Integration slug", "in": "query", "name": "source", "schema": { "type": "string" } }, { "description": "source_id[]=abc&source_id[]=xyz ", "in": "query", "name": "source_id", "schema": { "items": { "type": "string" }, "type": "array" } }, { "description": "owner_uuid[]=aaa-bbb&owner_uuid[]=ccc-ddd", "in": "query", "name": "owner_uuid", "schema": { "items": { "type": "string" }, "type": "array" } }, { "description": "participating_user_uuid[]=aaa-bbb&owner_uuid[]=aaa-bbb&owner_uuid[]=ccc-ddd[]=ccc-ddd", "in": "query", "name": "participating_user_uuid", "schema": { "items": { "type": "string" }, "type": "array" } }, { "description": "Filter by conversation type uuid", "in": "query", "name": "conversation_type_uuid", "schema": { "type": "string" } }, { "description": "customer_phone_number[]=+32474000000&customer_phone_number[]=+33476824768", "in": "query", "name": "customer_phone_number", "schema": { "items": { "type": "string" }, "type": "array" } }, { "description": "customer_email_address[]=admin@leexi.ai&customer_email_address[]=support@leexi.ai", "in": "query", "name": "customer_email_address", "schema": { "items": { "type": "string" }, "type": "array" } }, { "description": "Get transcript as a string", "in": "query", "name": "with_simple_transcript", "schema": { "default": false, "type": "boolean" } } ], "responses": { "200": { "content": { "application/json": { "examples": { "Result": { "value": "{\n \"data\": [\n {\n \"audio_archived_at\": \"2024-06-14T11:00:33.534Z\",\n \"chapters\": [\n {\n \"uuid\": \"b1c2d3e4-f5a6-7b8c-9d0e-f1a2b3c4d5e6\",\n \"index\": 0,\n \"title\": \"Chapter 1: Intro\",\n \"text\": \"Content for chapter 1\",\n \"start_time\": 10\n },\n {\n \"uuid\": \"b1c2d3e4-f5a6-7b8c-9d0e-f1a2b3c4d5e6\",\n \"index\": 0,\n \"title\": \"Chapter 2: Details\",\n \"text\": \"Content for chapter 2\",\n \"start_time\": 10\n }\n ],\n \"completions_archived_at\": null,\n \"conversation_type\": {\n \"uuid\": \"79af83f0-467c-4f65-8320-401c74978dff\",\n \"slug\": \"sales_visio_onboarding\",\n \"active\": true\n },\n \"created_at\": \"2024-06-13T10:52:26.579Z\",\n \"customer_email_addresses\": [],\n \"customer_phone_numbers\": [\n \"+1...\"\n ],\n \"customers\": [\n {\n \"uuid\": \"f1a2b3c4-d5e6-7f8a-9b0c-d1e2f3a4b5c6\",\n \"name\": \"Wei Kemmer\",\n \"email\": null,\n \"phone_number\": \"+1...\"\n }\n ],\n \"custom_fields\": {},\n \"deal\": null,\n \"description\": \"Morbi imperdiet dignissim interdum. Donec vestibulum lacus ipsum.\",\n \"direction\": \"outbound\",\n \"duration\": 123.716,\n \"feedbacks\": [],\n \"is_video\": false,\n \"leexi_url\": \"...\",\n \"locale\": \"en-US\",\n \"meeting_event\": null,\n \"owner\": {\n \"email\": \"philippe@leexi.ai\",\n \"name\": \"Philippe\",\n \"uuid\": \"a4ce7181-07f3-451c-8593-c067209efe4c\"\n },\n \"participating_users\": [\n {\n \"email\": \"philippe@leexi.ai\",\n \"name\": \"Philippe\",\n \"uuid\": \"a4ce7181-07f3-451c-8593-c067209efe4c\"\n }\n ],\n \"performed_at\": \"2024-06-13T10:49:47.000Z\",\n \"prompts\": [\n {\n \"category\": \"summary\",\n \"completions\": [\n \"Modi sint ea aliquam.\"\n ],\n \"title\": \"summary\",\n \"uuid\": \"5e7f2976-3da1-4bd9-ac61-1109f175a28f\"\n }\n ],\n \"recording_url\": \"...\",\n \"scorecards\": [],\n \"simple_transcript\": \"Bob (00:00 - 00:10)\\nHello, how are you?\\nAlice (00:10 - 00:20)\\nI'm fine, thank you.\",\n \"source\": \"aircall\",\n \"source_id\": \"4231481288\",\n \"speakers\": [\n {\n \"email_address\": \"philippe@leexi.ai\",\n \"index\": 0,\n \"is_user\": true,\n \"name\": \"Philippe\",\n \"phone_number\": null,\n \"uuid\": \"22cd0302-e459-468d-9e03-54532d996552\",\n \"duration\": 100.3,\n \"longest_monologue\": 10.2\n },\n {\n \"email_address\": null,\n \"index\": 1,\n \"is_user\": false,\n \"name\": \"Wei Kemmer\",\n \"phone_number\": \"+1...\",\n \"uuid\": \"6f9edfb7-dc61-4f27-9c99-3e42f4bb1de0\",\n \"duration\": 70.3,\n \"longest_monologue\": 5.2\n }\n ],\n \"tasks\": [\n {\n \"active\": true,\n \"created_at\": \"2024-06-13T10:49:47.000Z\",\n \"description\": \"Description of Task 1\",\n \"done\": false,\n \"last_editor\": {\n \"uuid\": \"user1_uuid\",\n \"name\": \"user\",\n \"email\": \"user@user.com\",\n \"active\": true\n },\n \"speaker\": {\n \"duration\": 10,\n \"longest_monologue\": 5,\n \"uuid\": \"6f9edfb7-dc61-4f27-9c99-3e42f4bb1de0\",\n \"name\": \"user\",\n \"is_user\": true,\n \"index\": 0,\n \"phone_number\": \"+1..\",\n \"email_address\": \"user@user.com\"\n },\n \"subject\": \"Task 1\",\n \"updated_at\": \"2024-06-13T10:49:47.000Z\",\n \"uuid\": \"6f9edfb7-dc61-4f27-9c99-3e42f4bb1de0\"\n }\n ],\n \"title\": \"Aliquam pretium ut arcu id\",\n \"transcript_archived_at\": null,\n \"transcript_url\": \"...\",\n \"updated_at\": \"2024-06-13T11:00:33.534Z\",\n \"uuid\": \"422dda3c-6e1b-4868-b96e-acd12fdf9139\",\n \"video_archived_at\": \"2024-06-14T11:00:33.534Z\",\n \"visible\": true\n }\n ],\n \"pagination\": {\n \"count\": 42,\n \"items\": 10,\n \"page\": 1,\n \"pages\": 5\n }\n}" } }, "schema": { "properties": { "data": { "items": { "properties": { "audio_archived_at": { "example": "2024-06-14T11:00:33.534Z", "type": "string" }, "chapters": { "items": { "properties": { "index": { "default": 0, "example": 0, "type": "integer" }, "start_time": { "default": 0, "example": 10, "type": "integer" }, "text": { "example": "Content for chapter 1", "type": "string" }, "title": { "example": "Chapter 1: Intro", "type": "string" }, "uuid": { "example": "b1c2d3e4-f5a6-7b8c-9d0e-f1a2b3c4d5e6", "type": "string" } }, "type": "object" }, "type": "array" }, "completions_archived_at": {}, "conversation_type": { "properties": { "active": { "default": true, "example": true, "type": "boolean" }, "slug": { "example": "sales_visio_onboarding", "type": "string" }, "uuid": { "example": "79af83f0-467c-4f65-8320-401c74978dff", "type": "string" } }, "type": "object" }, "created_at": { "example": "2024-06-13T10:52:26.579Z", "type": "string" }, "custom_fields": { "type": "object", "description": "Free-form key/value pairs sent at creation for custom integrations agreed with Leexi. Empty for every other call.", "additionalProperties": { "type": [ "string", "number", "boolean", "null" ] }, "example": {} }, "customer_email_addresses": { "deprecated": true, "description": "⚠️ DEPRECATED — kept for backward compatibility only. Use the `customers` array instead (read its `email` attribute).", "items": { "type": "string" }, "type": "array" }, "customer_phone_numbers": { "deprecated": true, "description": "⚠️ DEPRECATED — kept for backward compatibility only. Use the `customers` array instead (read its `phone_number` attribute).", "items": { "example": "+1...", "type": "string" }, "type": "array" }, "customers": { "description": "The external participants (customers) of the call. Replaces the deprecated `customer_email_addresses` and `customer_phone_numbers`.", "items": { "properties": { "email": { "example": "wei.kemmer@example.com", "type": "string" }, "name": { "example": "Wei Kemmer", "type": "string" }, "phone_number": { "example": "+1...", "type": "string" }, "uuid": { "example": "f1a2b3c4-d5e6-7f8a-9b0c-d1e2f3a4b5c6", "type": "string" } }, "type": "object" }, "type": "array" }, "deal": {}, "description": { "example": "Morbi imperdiet dignissim interdum. Donec vestibulum lacus ipsum.", "type": "string" }, "direction": { "example": "outbound", "type": "string" }, "duration": { "default": 0, "example": 123.716, "type": "number" }, "feedbacks": { "items": { "properties": {}, "type": "object" }, "type": "array" }, "is_video": { "default": true, "example": false, "type": "boolean" }, "leexi_url": { "example": "...", "type": "string" }, "locale": { "example": "en-US", "type": "string" }, "meeting_event": {}, "owner": { "properties": { "email": { "example": "philippe@leexi.ai", "type": "string" }, "name": { "example": "Philippe", "type": "string" }, "uuid": { "example": "a4ce7181-07f3-451c-8593-c067209efe4c", "type": "string" } }, "type": "object" }, "participating_users": { "items": { "properties": { "email": { "example": "philippe@leexi.ai", "type": "string" }, "name": { "example": "Philippe", "type": "string" }, "uuid": { "example": "a4ce7181-07f3-451c-8593-c067209efe4c", "type": "string" } }, "type": "object" }, "type": "array" }, "performed_at": { "example": "2024-06-13T10:49:47.000Z", "type": "string" }, "prompts": { "items": { "properties": { "category": { "example": "summary", "type": "string" }, "completions": { "items": { "example": "Modi sint ea aliquam.", "type": "string" }, "type": "array" }, "title": { "example": "summary", "type": "string" }, "uuid": { "example": "5e7f2976-3da1-4bd9-ac61-1109f175a28f", "type": "string" } }, "type": "object" }, "type": "array" }, "recording_url": { "description": "Signed URL of the call recording. `null` when the recording has been archived or when the company has disabled audio/video retention.", "example": "...", "type": [ "string", "null" ] }, "scorecards": { "items": { "properties": {}, "type": "object" }, "type": "array" }, "simple_transcript": { "example": "Bob (00:00 - 00:10)\nHello, how are you?\nAlice (00:10 - 00:20)\nI'm fine, thank you.", "type": "string" }, "source": { "example": "aircall", "type": "string" }, "source_id": { "example": "4231481288", "type": "string" }, "speakers": { "items": { "properties": { "duration": { "default": 0, "example": 100.3, "type": "number" }, "email_address": { "example": "philippe@leexi.ai", "type": "string" }, "index": { "default": 0, "example": 0, "type": "integer" }, "is_user": { "default": true, "example": true, "type": "boolean" }, "longest_monologue": { "default": 0, "example": 10.2, "type": "number" }, "name": { "example": "Philippe", "type": "string" }, "phone_number": {}, "uuid": { "example": "22cd0302-e459-468d-9e03-54532d996552", "type": "string" } }, "type": "object" }, "type": "array" }, "summary": { "example": "Modi sint ea aliquam.", "type": "string" }, "tags": { "items": { "properties": { "color": { "type": "string" }, "name": { "type": "string" }, "uuid": { "type": "string" } }, "type": "object" }, "type": "array" }, "tasks": { "items": { "properties": { "active": { "default": true, "example": true, "type": "boolean" }, "created_at": { "example": "2024-06-13T10:49:47.000Z", "type": "string" }, "description": { "example": "Description of Task 1", "type": "string" }, "done": { "default": true, "example": false, "type": "boolean" }, "last_editor": { "properties": { "active": { "default": true, "example": true, "type": "boolean" }, "email": { "example": "user@user.com", "type": "string" }, "name": { "example": "user", "type": "string" }, "uuid": { "example": "user1_uuid", "type": "string" } }, "type": "object" }, "speaker": { "properties": { "duration": { "default": 0, "example": 10, "type": "integer" }, "email_address": { "example": "user@user.com", "type": "string" }, "index": { "default": 0, "example": 0, "type": "integer" }, "is_user": { "default": true, "example": true, "type": "boolean" }, "longest_monologue": { "default": 0, "example": 5, "type": "integer" }, "name": { "example": "user", "type": "string" }, "phone_number": { "example": "+1..", "type": "string" }, "uuid": { "example": "6f9edfb7-dc61-4f27-9c99-3e42f4bb1de0", "type": "string" } }, "type": "object" }, "subject": { "example": "Task 1", "type": "string" }, "updated_at": { "example": "2024-06-13T10:49:47.000Z", "type": "string" }, "uuid": { "example": "6f9edfb7-dc61-4f27-9c99-3e42f4bb1de0", "type": "string" } }, "type": "object" }, "type": "array" }, "title": { "example": "Aliquam pretium ut arcu id", "type": "string" }, "transcript_archived_at": {}, "transcript_url": { "example": "...", "type": "string" }, "updated_at": { "example": "2024-06-13T11:00:33.534Z", "type": "string" }, "uuid": { "example": "422dda3c-6e1b-4868-b96e-acd12fdf9139", "type": "string" }, "video_archived_at": { "example": "2024-06-14T11:00:33.534Z", "type": "string" }, "visible": { "default": true, "example": true, "type": "boolean" } }, "type": "object" }, "type": "array" }, "pagination": { "properties": { "count": { "default": 0, "example": 42, "type": "integer" }, "items": { "default": 0, "example": 10, "type": "integer" }, "page": { "default": 0, "example": 1, "type": "integer" }, "pages": { "example": 5, "type": "integer" } }, "type": "object" } }, "type": "object" } } }, "description": "200" }, "400": { "content": { "application/json": { "examples": { "Result": { "value": "{\n \"success\": false,\n \"message\": \"An error occurred\"\n}" } }, "schema": { "properties": { "message": { "example": "An error occurred", "type": "string" }, "success": { "example": false, "type": "boolean" } }, "type": "object" } } }, "description": "400" } }, "summary": "List calls" }, "post": { "description": "Create a call or meeting asynchronously (creation time is typically a few minutes). You must first finish uploading the recording of the call using a presigned recording url retrieved with the [Request a presigned url](/reference/request-a-presigned-url) endpoint. Use the [LIST users](/reference/list-users) endpoint to find the user_uuid to use in this request.", "operationId": "create-a-call", "requestBody": { "content": { "application/json": { "schema": { "properties": { "custom_fields": { "type": "object", "description": "Free-form key/value pairs stored on the call and returned as-is by the [LIST calls](/reference/list-calls) and [GET call](/reference/get-call) endpoints. Only for custom integrations agreed with Leexi: the keys and their meaning must be defined with the Leexi team beforehand, otherwise the values are stored but never used. Values must be scalars (string, number, boolean or null).", "additionalProperties": { "type": [ "string", "number", "boolean", "null" ] }, "example": { "siret": "00012345678901" } }, "customers": { "description": "The external participants (customers) of the call. An array of objects, each accepting any of `name`, `email`, `phone_number` and `uuid` (only one attribute is required per object). When `uuid` is set it links an existing customer and the other attributes are ignored; unknown uuids are skipped. The provided names are used to help identify the speakers in the transcript. Prefer this over the deprecated `emails` and `raw_phone_number` params. ⚠️ Cannot be combined with the deprecated `emails` or `raw_phone_number` params in the same request (returns a 400).", "items": { "properties": { "email": { "example": "wei.kemmer@example.com", "type": "string" }, "name": { "example": "Wei Kemmer", "type": "string" }, "phone_number": { "example": "+1...", "type": "string" }, "uuid": { "description": "uuid of an existing customer to link", "type": "string" } }, "type": "object" }, "type": "array" }, "description": { "type": "string" }, "direction": { "default": "outbound", "description": "inbound or outbound", "type": "string" }, "emails": { "deprecated": true, "description": "⚠️ DEPRECATED — kept for backward compatibility only. A list of emails of other participants in the call. Use `participating_user_uuids` (for fellow Leexi users) and the `customers` array (for external participants) instead. Cannot be combined with `customers` or `participating_user_uuids` in the same request (returns a 400).", "items": { "type": "string" }, "type": "array" }, "external_id": { "default": "123", "description": "the id of the call in your system", "type": "string" }, "locale": { "description": "fr-FR en-US de-DE es-ES nl-NL ar-AE da-DK hi-IN id-ID it-IT ja-JP ko-KR nb-NO pl-PL pt-PT ru-RU sv-SE tr-TR uk-UA zh-CN fr-CA he-IL th-TH bg-BG cs-CZ el-GR et-EE fi-FI hr-HR hu-HU lt-LT lv-LV ro-RO vi-VN en-AU en-GB en-NZ en-IN ca-ES", "type": "string" }, "participating_user_uuids": { "description": "uuids of fellow Leexi users participating in the call (in addition to the owner set via `user_uuid`). Use the [LIST users](/reference/list-users) endpoint to find them. ⚠️ Cannot be combined with the deprecated `emails` or `raw_phone_number` params in the same request (returns a 400).", "items": { "type": "string" }, "type": "array" }, "performed_at": { "default": "2024-10-18T16:19:22+02:00", "description": "iso8601 format", "type": "string" }, "raw_phone_number": { "deprecated": true, "description": "⚠️ DEPRECATED — kept for backward compatibility only. A string representation of the customer's phone_number. Use the `customers` array instead (set its `phone_number` attribute). Cannot be combined with `customers` or `participating_user_uuids` in the same request (returns a 400).", "type": "string" }, "recording_s3_key": { "default": "leexi/recordings/upload/b969bec6-c572-466b-99cd-37b4bb7d8b4f.mp3", "description": "the recording_s3_key returned by the [Request a presigned url](/reference/request-a-presigned-url) endpoint", "type": "string" }, "tags": { "description": "an array of tag names", "items": { "type": "string" }, "type": "array" }, "title": { "default": "Meeting XYZ", "description": "The title of the call or meeting", "type": "string" }, "user_uuid": { "default": "ee4c0057-5c1f-45a6-a0ba-8e2356fa137a", "description": "The uuid of the user associated to the call, must have an active license.", "type": "string" } }, "required": [ "recording_s3_key", "external_id", "direction", "performed_at", "user_uuid" ], "type": "object" } } } }, "responses": { "200": { "content": { "application/json": { "examples": { "Result": { "value": "{\n \"message\": \"successfully submitted call for creation\"\n}" } }, "schema": { "properties": { "message": { "example": "successfully submitted call for creation", "type": "string" } }, "type": "object" } } }, "description": "200" }, "400": { "content": { "application/json": { "examples": { "Result": { "value": "{\n \"success\": false,\n \"message\": \"external_id must be set\"\n}" } }, "schema": { "properties": { "message": { "example": "external_id must be set", "type": "string" }, "success": { "example": false, "type": "boolean" } }, "type": "object" } } }, "description": "400" } }, "summary": "Create a call" } }, "/calls/{uuid}": { "get": { "description": "Getting a single call or meeting. This returns the same attributes as the [LIST calls](/reference/list-calls) endpoint with additionally the call topics and the call transcript. The simple_transcript has paragraph-level timestamps, while the transcript also has word-level timestamps. The call must be within the API key's access scope, otherwise the endpoint responds with 404.", "operationId": "get-call", "parameters": [ { "in": "path", "name": "uuid", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "examples": { "Result": { "value": "{\n \"data\": {\n \"audio_archived_at\": \"2024-06-14T11:00:33.534Z\",\n \"call_ai_topics\": [\n {\n \"ai_topics\": [\n {\n \"color\": \"blue\",\n \"name\": \"pricing\",\n \"uuid\": \"aa3cb38c-a0a1-40aa-b273-7c8618fb5534\"\n }\n ],\n \"created_at\": \"2024-06-13T11:00:32.379Z\",\n \"end_time\": 26.56,\n \"sentence\": \"The price would be 100 a month.\",\n \"speaker\": {\n \"email_address\": null,\n \"index\": 1,\n \"is_user\": false,\n \"name\": \"Wei Kemmer\",\n \"phone_number\": \"+35841760286113555\",\n \"uuid\": \"fg9edfb7-dc61-fg27-9c99-3e42f4bb1de0\"\n },\n \"start_time\": 26.32,\n \"updated_at\": \"2024-06-13T11:00:32.379Z\",\n \"uuid\": \"fg3cb38c-a0a1-40fg-b273-7c8618fb5534\"\n }\n ],\n \"call_topics\": [],\n \"chapters\": [\n {\n \"uuid\": \"b1c2d3e4-f5a6-7b8c-9d0e-f1a2b3c4d5e6\",\n \"index\": 0,\n \"title\": \"Chapter 1: Intro\",\n \"text\": \"Content for chapter 1\",\n \"start_time\": 10\n },\n {\n \"uuid\": \"b1c2d3e4-f5a6-7b8c-9d0e-f1a2b3c4d5e6\",\n \"index\": 0,\n \"title\": \"Chapter 2: Details\",\n \"text\": \"Content for chapter 2\",\n \"start_time\": 10\n }\n ],\n \"completions_archived_at\": null,\n \"conversation_type\": {\n \"uuid\": \"79af83f0-467c-4f65-8320-401c74978dff\",\n \"slug\": \"sales_visio_onboarding\",\n \"active\": true\n },\n \"created_at\": \"2024-06-13T10:52:26.579Z\",\n \"customer_email_addresses\": [],\n \"customer_phone_numbers\": [\n \"+1...\"\n ],\n \"customers\": [\n {\n \"uuid\": \"f1a2b3c4-d5e6-7f8a-9b0c-d1e2f3a4b5c6\",\n \"name\": \"Wei Kemmer\",\n \"email\": null,\n \"phone_number\": \"+1...\"\n }\n ],\n \"custom_fields\": {},\n \"deal\": null,\n \"description\": \"Morbi imperdiet dignissim interdum. Donec vestibulum lacus ipsum.\",\n \"direction\": \"outbound\",\n \"duration\": 123.716,\n \"feedbacks\": [],\n \"is_video\": false,\n \"leexi_url\": \"...\",\n \"locale\": \"en-US\",\n \"meeting_event\": null,\n \"owner\": {\n \"email\": \"philippe@leexi.ai\",\n \"name\": \"Philippe\",\n \"uuid\": \"a4ce7181-07f3-451c-8593-c067209efe4c\"\n },\n \"participating_users\": [\n {\n \"email\": \"philippe@leexi.ai\",\n \"name\": \"Philippe\",\n \"uuid\": \"a4ce7181-07f3-451c-8593-c067209efe4c\"\n }\n ],\n \"performed_at\": \"2024-06-13T10:49:47.000Z\",\n \"prompts\": [\n {\n \"category\": \"summary\",\n \"completions\": [\n \"Modi sint ea aliquam.\"\n ],\n \"title\": \"summary\",\n \"uuid\": \"5e7f2976-3da1-4bd9-ac61-1109f175a28f\"\n }\n ],\n \"recording_url\": \"...\",\n \"scorecards\": [],\n \"simple_transcript:\": \"Bob (00:00 - 00:10)\\nHi, how are you?\\nAlice (00:10 - 00:20)\\nI'm good, how are you?\",\n \"source\": \"aircall\",\n \"source_id\": \"4231481288\",\n \"speakers\": [\n {\n \"email_address\": \"philippe@leexi.ai\",\n \"index\": 0,\n \"is_user\": true,\n \"name\": \"Philippe\",\n \"phone_number\": null,\n \"uuid\": \"22cd0302-e459-468d-9e03-54532d996552\",\n \"duration\": 100.3,\n \"longest_monologue\": 10.2\n },\n {\n \"email_address\": null,\n \"index\": 1,\n \"is_user\": false,\n \"name\": \"Wei Kemmer\",\n \"phone_number\": \"+1...\",\n \"uuid\": \"6f9edfb7-dc61-4f27-9c99-3e42f4bb1de0\",\n \"duration\": 70.3,\n \"longest_monologue\": 5.2\n }\n ],\n \"tasks\": [\n {\n \"active\": true,\n \"created_at\": \"2024-06-13T10:49:47.000Z\",\n \"description\": \"Description of Task 1\",\n \"done\": false,\n \"last_editor\": {\n \"uuid\": \"user1_uuid\",\n \"name\": \"user\",\n \"email\": \"user@user.com\",\n \"active\": true\n },\n \"speaker\": {\n \"duration\": 10,\n \"longest_monologue\": 5,\n \"uuid\": \"6f9edfb7-dc61-4f27-9c99-3e42f4bb1de0\",\n \"name\": \"user\",\n \"is_user\": true,\n \"index\": 0,\n \"phone_number\": \"+1..\",\n \"email_address\": \"user@user.com\"\n },\n \"subject\": \"Task 1\",\n \"updated_at\": \"2024-06-13T10:49:47.000Z\",\n \"uuid\": \"6f9edfb7-dc61-4f27-9c99-3e42f4bb1de0\"\n }\n ],\n \"title\": \"Aliquam pretium ut arcu id\",\n \"transcript\": [\n {\n \"end_time\": 16.773,\n \"items\": [\n {\n \"content\": \"How\",\n \"end_time\": 3.8,\n \"start_time\": 3.05\n }\n ],\n \"speaker_index\": 0,\n \"start_time\": 3.05\n }\n ],\n \"transcript_archived_at\": null,\n \"transcript_url\": \"...\",\n \"updated_at\": \"2024-06-13T11:00:33.534Z\",\n \"uuid\": \"422dda3c-6e1b-4868-b96e-acd12fdf9139\",\n \"video_archived_at\": \"2024-06-14T11:00:33.534Z\",\n \"visible\": true\n }\n}" } }, "schema": { "properties": { "data": { "properties": { "audio_archived_at": { "example": "2024-06-14T11:00:33.534Z", "type": "string" }, "call_ai_topics": { "description": "AI-detected topic occurrences in the call, ordered by start_time.", "items": { "properties": { "ai_topics": { "items": { "properties": { "color": { "example": "blue", "type": "string" }, "name": { "example": "pricing", "type": "string" }, "uuid": { "example": "aa3cb38c-a0a1-40aa-b273-7c8618fb5534", "type": "string" } }, "type": "object" }, "type": "array" }, "created_at": { "example": "2024-06-13T11:00:32.379Z", "type": "string" }, "end_time": { "default": 0, "example": 26.56, "type": "number" }, "sentence": { "example": "The price would be 100 a month.", "type": "string" }, "speaker": { "properties": { "email_address": {}, "index": { "default": 0, "example": 1, "type": "integer" }, "is_user": { "default": true, "example": false, "type": "boolean" }, "name": { "example": "Wei Kemmer", "type": "string" }, "phone_number": { "example": "+35841760286113555", "type": "string" }, "uuid": { "example": "fg9edfb7-dc61-fg27-9c99-3e42f4bb1de0", "type": "string" } }, "type": "object" }, "start_time": { "default": 0, "example": 26.32, "type": "number" }, "updated_at": { "example": "2024-06-13T11:00:32.379Z", "type": "string" }, "uuid": { "example": "fg3cb38c-a0a1-40fg-b273-7c8618fb5534", "type": "string" } }, "type": "object" }, "type": "array" }, "call_topics": { "deprecated": true, "description": "Legacy keyword-based topics were removed; always an empty array. Use `call_ai_topics` instead.", "items": {}, "type": "array" }, "chapters": { "items": { "properties": { "index": { "default": 0, "example": 0, "type": "integer" }, "start_time": { "default": 0, "example": 10, "type": "integer" }, "text": { "example": "Content for chapter 1", "type": "string" }, "title": { "example": "Chapter 1: Intro", "type": "string" }, "uuid": { "example": "b1c2d3e4-f5a6-7b8c-9d0e-f1a2b3c4d5e6", "type": "string" } }, "type": "object" }, "type": "array" }, "completions_archived_at": {}, "conversation_type": { "properties": { "active": { "default": true, "example": true, "type": "boolean" }, "slug": { "example": "sales_visio_onboarding", "type": "string" }, "uuid": { "example": "79af83f0-467c-4f65-8320-401c74978dff", "type": "string" } }, "type": "object" }, "created_at": { "example": "2024-06-13T10:52:26.579Z", "type": "string" }, "custom_fields": { "type": "object", "description": "Free-form key/value pairs sent at creation for custom integrations agreed with Leexi. Empty for every other call.", "additionalProperties": { "type": [ "string", "number", "boolean", "null" ] }, "example": {} }, "customer_email_addresses": { "deprecated": true, "description": "⚠️ DEPRECATED — kept for backward compatibility only. Use the `customers` array instead (read its `email` attribute).", "items": { "type": "string" }, "type": "array" }, "customer_phone_numbers": { "deprecated": true, "description": "⚠️ DEPRECATED — kept for backward compatibility only. Use the `customers` array instead (read its `phone_number` attribute).", "items": { "example": "+1...", "type": "string" }, "type": "array" }, "customers": { "description": "The external participants (customers) of the call. Replaces the deprecated `customer_email_addresses` and `customer_phone_numbers`.", "items": { "properties": { "email": { "example": "wei.kemmer@example.com", "type": "string" }, "name": { "example": "Wei Kemmer", "type": "string" }, "phone_number": { "example": "+1...", "type": "string" }, "uuid": { "example": "f1a2b3c4-d5e6-7f8a-9b0c-d1e2f3a4b5c6", "type": "string" } }, "type": "object" }, "type": "array" }, "deal": {}, "description": { "example": "Morbi imperdiet dignissim interdum. Donec vestibulum lacus ipsum.", "type": "string" }, "direction": { "example": "outbound", "type": "string" }, "duration": { "default": 0, "example": 123.716, "type": "number" }, "feedbacks": { "items": { "properties": {}, "type": "object" }, "type": "array" }, "is_video": { "default": true, "example": false, "type": "boolean" }, "leexi_url": { "example": "...", "type": "string" }, "locale": { "example": "en-US", "type": "string" }, "meeting_event": {}, "owner": { "properties": { "email": { "example": "philippe@leexi.ai", "type": "string" }, "name": { "example": "Philippe", "type": "string" }, "uuid": { "example": "a4ce7181-07f3-451c-8593-c067209efe4c", "type": "string" } }, "type": "object" }, "participating_users": { "items": { "properties": { "email": { "example": "philippe@leexi.ai", "type": "string" }, "name": { "example": "Philippe", "type": "string" }, "uuid": { "example": "a4ce7181-07f3-451c-8593-c067209efe4c", "type": "string" } }, "type": "object" }, "type": "array" }, "performed_at": { "example": "2024-06-13T10:49:47.000Z", "type": "string" }, "prompts": { "items": { "properties": { "category": { "example": "summary", "type": "string" }, "completions": { "items": { "example": "Modi sint ea aliquam.", "type": "string" }, "type": "array" }, "title": { "example": "summary", "type": "string" }, "uuid": { "example": "5e7f2976-3da1-4bd9-ac61-1109f175a28f", "type": "string" } }, "type": "object" }, "type": "array" }, "recording_url": { "description": "Signed URL of the call recording. `null` when the recording has been archived or when the company has disabled audio/video retention.", "example": "...", "type": [ "string", "null" ] }, "scorecards": { "items": { "properties": {}, "type": "object" }, "type": "array" }, "simple_transcript": { "example": "Bob (00:00 - 00:10)\nHi, how are you?\nAlice (00:10 - 00:20)\nI'm good, how are you?", "type": "string" }, "source": { "example": "aircall", "type": "string" }, "source_id": { "example": "4231481288", "type": "string" }, "speakers": { "items": { "properties": { "duration": { "default": 0, "example": 100.3, "type": "number" }, "email_address": { "example": "philippe@leexi.ai", "type": "string" }, "index": { "default": 0, "example": 0, "type": "integer" }, "is_user": { "default": true, "example": true, "type": "boolean" }, "longest_monologue": { "default": 0, "example": 10.2, "type": "number" }, "name": { "example": "Philippe", "type": "string" }, "phone_number": {}, "uuid": { "example": "22cd0302-e459-468d-9e03-54532d996552", "type": "string" } }, "type": "object" }, "type": "array" }, "summary": { "example": "Modi sint ea aliquam.", "type": "string" }, "tags": { "items": { "properties": { "color": { "type": "string" }, "name": { "type": "string" }, "uuid": { "type": "string" } }, "type": "object" }, "type": "array" }, "tasks": { "items": { "properties": { "active": { "default": true, "example": true, "type": "boolean" }, "created_at": { "example": "2024-06-13T10:49:47.000Z", "type": "string" }, "description": { "example": "Description of Task 1", "type": "string" }, "done": { "default": true, "example": false, "type": "boolean" }, "last_editor": { "properties": { "active": { "default": true, "example": true, "type": "boolean" }, "email": { "example": "user@user.com", "type": "string" }, "name": { "example": "user", "type": "string" }, "uuid": { "example": "user1_uuid", "type": "string" } }, "type": "object" }, "speaker": { "properties": { "duration": { "default": 0, "example": 10, "type": "integer" }, "email_address": { "example": "user@user.com", "type": "string" }, "index": { "default": 0, "example": 0, "type": "integer" }, "is_user": { "default": true, "example": true, "type": "boolean" }, "longest_monologue": { "default": 0, "example": 5, "type": "integer" }, "name": { "example": "user", "type": "string" }, "phone_number": { "example": "+1..", "type": "string" }, "uuid": { "example": "6f9edfb7-dc61-4f27-9c99-3e42f4bb1de0", "type": "string" } }, "type": "object" }, "subject": { "example": "Task 1", "type": "string" }, "updated_at": { "example": "2024-06-13T10:49:47.000Z", "type": "string" }, "uuid": { "example": "6f9edfb7-dc61-4f27-9c99-3e42f4bb1de0", "type": "string" } }, "type": "object" }, "type": "array" }, "title": { "example": "Aliquam pretium ut arcu id", "type": "string" }, "transcript": { "items": { "properties": { "end_time": { "default": 0, "example": 16.773, "type": "number" }, "items": { "items": { "properties": { "content": { "example": "How", "type": "string" }, "end_time": { "default": 0, "example": 3.8, "type": "number" }, "start_time": { "default": 0, "example": 3.05, "type": "number" } }, "type": "object" }, "type": "array" }, "speaker_index": { "default": 0, "example": 0, "type": "integer" }, "start_time": { "default": 0, "example": 3.05, "type": "number" } }, "type": "object" }, "type": "array" }, "transcript_archived_at": {}, "transcript_url": { "example": "...", "type": "string" }, "updated_at": { "example": "2024-06-13T11:00:33.534Z", "type": "string" }, "uuid": { "example": "422dda3c-6e1b-4868-b96e-acd12fdf9139", "type": "string" }, "video_archived_at": { "example": "2024-06-14T11:00:33.534Z", "type": "string" }, "visible": { "default": true, "example": true, "type": "boolean" } }, "type": "object" } }, "type": "object" } } }, "description": "200" } }, "summary": "Get call" } }, "/calls/presign_recording_url": { "post": { "description": "Request a presigned URL to upload a call recording, before creating the call. To upload the file you must send a PUT request to the returned url, with the headers provided by the endpoint (single-part upload). This uploaded file automatically expires after 3 days unless used to create a call.", "operationId": "request-a-presigned-url", "requestBody": { "content": { "application/json": { "schema": { "properties": { "extension": { "default": ".mp4", "description": "VIDEO: .mp4 .mkv .avi .webm .mov .wmv .mpg .mpeg .m4v AUDIO: .mp3 .wav .aac .flac .ogg .m4a .wma .opus .aiff .alac .amr .ape .dts .ac3 .mid .mp2 .mpc .ra .tta .vox", "type": "string" } }, "required": [ "extension" ], "type": "object" } } } }, "responses": { "200": { "content": { "application/json": { "examples": { "Result": { "value": "{\n \"success\": true,\n \"data\": {\n \"recording_s3_key\": \"acme/recordings/upload/bec9d04c-ba91-43c1-8a46-79f690a844c1.mp3\",\n \"url\": \"https://foo.s3.eu-west-3.amazonaws.com/acme/recordings/upload/bec9d04c-ba91-43c1-8a46-79f690a844c1.mp3?X-Amz-Algorithm=AWS4-HMAC-SHA256\",\n \"headers\": {\n \"x-amz-tagging\": \"temporary=true\"\n }\n },\n \"message\": \"recording url presigned\"\n}" } }, "schema": { "properties": { "data": { "properties": { "headers": { "properties": { "x-amz-tagging": { "example": "temporary=true", "type": "string" } }, "type": "object" }, "recording_s3_key": { "example": "acme/recordings/upload/bec9d04c-ba91-43c1-8a46-79f690a844c1.mp3", "type": "string" }, "url": { "example": "https://foo.s3.eu-west-3.amazonaws.com/acme/recordings/upload/bec9d04c-ba91-43c1-8a46-79f690a844c1.mp3?X-Amz-Algorithm=AWS4-HMAC-SHA256", "type": "string" } }, "type": "object" }, "message": { "example": "recording url presigned", "type": "string" }, "success": { "example": true, "type": "boolean" } }, "type": "object" } } }, "description": "200" }, "400": { "content": { "application/json": { "examples": { "Result": { "value": "{\n \"success\": false,\n \"message\": \"Invalid extension\"\n}" } }, "schema": { "properties": { "message": { "example": "Invalid extension", "type": "string" }, "success": { "example": false, "type": "boolean" } }, "type": "object" } } }, "description": "400" } }, "summary": "Request a presigned url" } }, "/call_notes": { "get": { "deprecated": false, "description": "List call notes for a given call. `call_uuid` is required. You can optionally filter by `prompt_uuid`. Only call notes generated from prompts in the `summary` or `text` categories are returned. The call must be within the API key's access scope, otherwise no notes are returned.", "operationId": "list-call-notes", "parameters": [ { "in": "query", "name": "page", "schema": { "default": 1, "format": "int32", "type": "integer" } }, { "description": "min: 1, max: 100", "in": "query", "name": "items", "schema": { "default": 10, "format": "int32", "type": "integer" } }, { "description": "The uuid of the call whose notes you want to list.", "in": "query", "name": "call_uuid", "required": true, "schema": { "type": "string" } }, { "description": "Optional prompt uuid to filter call notes to a single prompt.", "in": "query", "name": "prompt_uuid", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "examples": { "Result": { "value": "{\n \"data\": [\n {\n \"uuid\": \"note-latest\",\n \"created_at\": \"2026-04-13T11:00:00.000Z\",\n \"updated_at\": \"2026-04-13T11:30:00.000Z\",\n \"call\": {\n \"uuid\": \"call-1\",\n \"created_at\": \"2026-04-12T09:00:00.000Z\",\n \"updated_at\": \"2026-04-13T11:30:00.000Z\",\n \"performed_at\": \"2026-04-13T10:00:00.000Z\",\n \"locale\": \"en-US\",\n \"duration\": 184.007,\n \"direction\": \"outbound\",\n \"is_video\": false,\n \"visible\": true,\n \"leexi_url\": \"...\",\n \"video_archived_at\": null,\n \"audio_archived_at\": null,\n \"transcript_archived_at\": null,\n \"completions_archived_at\": null\n },\n \"prompt\": {\n \"uuid\": \"prompt-summary\",\n \"title\": \"Summary\",\n \"category\": \"summary\"\n },\n \"translations\": [\n {\n \"uuid\": \"translation-en-us\",\n \"locale\": \"en-US\",\n \"text\": \"Translated newest note\",\n \"original_text\": \"Newest note\",\n \"updated_at\": \"2026-04-13T11:50:00.000Z\"\n }\n ]\n },\n {\n \"uuid\": \"note-old\",\n \"created_at\": \"2026-04-11T12:00:00.000Z\",\n \"updated_at\": \"2026-04-12T12:00:00.000Z\",\n \"call\": {\n \"uuid\": \"call-1\",\n \"created_at\": \"2026-04-12T09:00:00.000Z\",\n \"updated_at\": \"2026-04-13T11:30:00.000Z\",\n \"performed_at\": \"2026-04-13T10:00:00.000Z\",\n \"locale\": \"en-US\",\n \"duration\": 184.007,\n \"direction\": \"outbound\",\n \"is_video\": false,\n \"visible\": true,\n \"leexi_url\": \"...\",\n \"video_archived_at\": null,\n \"audio_archived_at\": null,\n \"transcript_archived_at\": null,\n \"completions_archived_at\": null\n },\n \"prompt\": {\n \"uuid\": \"prompt-text\",\n \"title\": \"CRM note\",\n \"category\": \"text\"\n },\n \"translations\": []\n }\n ],\n \"pagination\": {\n \"page\": 1,\n \"items\": 20,\n \"count\": 2,\n \"pages\": 1\n }\n}" } }, "schema": { "properties": { "data": { "items": { "properties": { "call": { "properties": { "audio_archived_at": {}, "completions_archived_at": {}, "created_at": { "example": "2026-04-12T09:00:00.000Z", "type": "string" }, "direction": { "example": "outbound", "type": "string" }, "duration": { "example": 184.007, "type": "number" }, "is_video": { "example": false, "type": "boolean" }, "leexi_url": { "example": "...", "type": "string" }, "locale": { "example": "en-US", "type": "string" }, "performed_at": { "example": "2026-04-13T10:00:00.000Z", "type": "string" }, "transcript_archived_at": {}, "updated_at": { "example": "2026-04-13T11:30:00.000Z", "type": "string" }, "uuid": { "example": "call-1", "type": "string" }, "video_archived_at": {}, "visible": { "example": true, "type": "boolean" } }, "type": "object" }, "created_at": { "example": "2026-04-13T11:00:00.000Z", "type": "string" }, "prompt": { "properties": { "category": { "example": "summary", "type": "string" }, "title": { "example": "Summary", "type": "string" }, "uuid": { "example": "prompt-summary", "type": "string" } }, "type": "object" }, "translations": { "items": { "properties": { "locale": { "example": "en-US", "type": "string" }, "original_text": { "example": "Newest note", "type": "string" }, "text": { "example": "Translated newest note", "type": "string" }, "updated_at": { "example": "2026-04-13T11:50:00.000Z", "type": "string" }, "uuid": { "example": "translation-en-us", "type": "string" } }, "type": "object" }, "type": "array" }, "updated_at": { "example": "2026-04-13T11:30:00.000Z", "type": "string" }, "uuid": { "example": "note-latest", "type": "string" } }, "type": "object" }, "type": "array" }, "pagination": { "properties": { "count": { "example": 2, "type": "integer" }, "items": { "example": 10, "type": "integer" }, "page": { "example": 1, "type": "integer" }, "pages": { "example": 1, "type": "integer" } }, "type": "object" } }, "type": "object" } } }, "description": "200" }, "400": { "content": { "application/json": { "examples": { "Result": { "value": "{\n \"success\": false,\n \"message\": \"call_uuid is required\"\n}" } }, "schema": { "properties": { "message": { "example": "call_uuid is required", "type": "string" }, "success": { "example": false, "type": "boolean" } }, "type": "object" } } }, "description": "400" }, "404": { "content": { "application/json": { "examples": { "Result": { "value": "{\n \"success\": false,\n \"message\": \"Call not found\"\n}" } }, "schema": { "properties": { "message": { "example": "Call not found", "type": "string" }, "success": { "example": false, "type": "boolean" } }, "type": "object" } } }, "description": "404" }, "422": { "content": { "application/json": { "examples": { "Result": { "value": "{\n \"success\": false,\n \"message\": \"The prompt associated with the call note must be of category summary or text\"\n}" } }, "schema": { "properties": { "message": { "example": "The prompt associated with the call note must be of category summary or text", "type": "string" }, "success": { "example": false, "type": "boolean" } }, "type": "object" } } }, "description": "422" } }, "summary": "List call notes" } }, "/call_notes/{uuid}": { "delete": { "description": "Delete a call note", "operationId": "delete-a-call-note", "parameters": [ { "in": "path", "name": "uuid", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "examples": { "Result": { "value": "{\n \"success\": true,\n \"data\": {},\n \"message\": \"Call note successfully deleted\"\n}" } }, "schema": { "properties": { "data": { "properties": {}, "type": "object" }, "message": { "example": "Call note successfully deleted", "type": "string" }, "success": { "example": true, "type": "boolean" } }, "type": "object" } } }, "description": "200" }, "403": { "content": { "application/json": { "examples": { "Result": { "value": "{\n \"success\": false,\n \"message\": \"The API key has no write_calls access\"\n}" } }, "schema": { "properties": { "message": { "example": "The API key has no write_calls access", "type": "string" }, "success": { "example": false, "type": "boolean" } }, "type": "object" } } }, "description": "403" }, "404": { "content": { "application/json": { "examples": { "Result": { "value": "{\n \"success\": false,\n \"message\": \"Call note not found\"\n}" } }, "schema": { "properties": { "message": { "example": "Call note not found", "type": "string" }, "success": { "example": false, "type": "boolean" } }, "type": "object" } } }, "description": "404" } }, "summary": "Delete a call note" }, "get": { "description": "Retrieve a single call note", "operationId": "get-a-call-note", "parameters": [ { "in": "path", "name": "uuid", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "examples": { "Result": { "value": "{\n \"success\": true,\n \"data\": {\n \"uuid\": \"note-show\",\n \"created_at\": \"2026-04-13T11:00:00.000Z\",\n \"updated_at\": \"2026-04-13T11:30:00.000Z\",\n \"call\": {\n \"uuid\": \"call-1\",\n \"created_at\": \"2026-04-12T09:00:00.000Z\",\n \"updated_at\": \"2026-04-13T11:30:00.000Z\",\n \"performed_at\": \"2026-04-13T10:00:00.000Z\",\n \"locale\": \"en-US\",\n \"duration\": 184.007,\n \"direction\": \"outbound\",\n \"is_video\": false,\n \"visible\": true,\n \"leexi_url\": \"...\",\n \"video_archived_at\": null,\n \"audio_archived_at\": null,\n \"transcript_archived_at\": null,\n \"completions_archived_at\": null\n },\n \"prompt\": {\n \"uuid\": \"prompt-summary\",\n \"title\": \"Summary\",\n \"category\": \"summary\"\n },\n \"translations\": [\n {\n \"uuid\": \"translation-en-us\",\n \"locale\": \"en-US\",\n \"text\": \"Translated newest note\",\n \"original_text\": \"Newest note\",\n \"updated_at\": \"2026-04-13T11:50:00.000Z\"\n }\n ]\n },\n \"message\": \"Call note successfully retrieved\"\n}" } }, "schema": { "properties": { "data": { "properties": { "call": { "properties": { "audio_archived_at": {}, "completions_archived_at": {}, "created_at": { "example": "2026-04-12T09:00:00.000Z", "type": "string" }, "direction": { "example": "outbound", "type": "string" }, "duration": { "example": 184.007, "type": "number" }, "is_video": { "example": false, "type": "boolean" }, "leexi_url": { "example": "...", "type": "string" }, "locale": { "example": "en-US", "type": "string" }, "performed_at": { "example": "2026-04-13T10:00:00.000Z", "type": "string" }, "transcript_archived_at": {}, "updated_at": { "example": "2026-04-13T11:30:00.000Z", "type": "string" }, "uuid": { "example": "call-1", "type": "string" }, "video_archived_at": {}, "visible": { "example": true, "type": "boolean" } }, "type": "object" }, "created_at": { "example": "2026-04-13T11:00:00.000Z", "type": "string" }, "prompt": { "properties": { "category": { "example": "summary", "type": "string" }, "title": { "example": "Summary", "type": "string" }, "uuid": { "example": "prompt-summary", "type": "string" } }, "type": "object" }, "translations": { "items": { "properties": { "locale": { "example": "en-US", "type": "string" }, "original_text": { "example": "Newest note", "type": "string" }, "text": { "example": "Translated newest note", "type": "string" }, "updated_at": { "example": "2026-04-13T11:50:00.000Z", "type": "string" }, "uuid": { "example": "translation-en-us", "type": "string" } }, "type": "object" }, "type": "array" }, "updated_at": { "example": "2026-04-13T11:30:00.000Z", "type": "string" }, "uuid": { "example": "note-show", "type": "string" } }, "type": "object" }, "message": { "example": "Call note successfully retrieved", "type": "string" }, "success": { "example": true, "type": "boolean" } }, "type": "object" } } }, "description": "200" }, "404": { "content": { "application/json": { "examples": { "Result": { "value": "{\n \"success\": false,\n \"message\": \"Call note not found\"\n}" } }, "schema": { "properties": { "message": { "example": "Call note not found", "type": "string" }, "success": { "example": false, "type": "boolean" } }, "type": "object" } } }, "description": "404" } }, "summary": "Get a call note" }, "patch": { "description": "Update a note for a given call", "operationId": "update-a-call-note", "parameters": [ { "in": "path", "name": "uuid", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "locale": { "description": "The locale of the translation to update, for example `en-US`.", "type": "string" }, "text": { "description": "The new translated text.", "type": "string" } }, "required": [ "locale", "text" ], "type": "object" } } } }, "responses": { "200": { "content": { "application/json": { "examples": { "Result": { "value": "{\n \"success\": true,\n \"data\": {\n \"uuid\": \"note-update\",\n \"created_at\": \"2026-04-13T11:00:00.000Z\",\n \"updated_at\": \"2026-04-13T11:30:00.000Z\",\n \"call\": {\n \"uuid\": \"call-1\",\n \"created_at\": \"2026-04-12T09:00:00.000Z\",\n \"updated_at\": \"2026-04-13T11:30:00.000Z\",\n \"performed_at\": \"2026-04-13T10:00:00.000Z\",\n \"locale\": \"en-US\",\n \"duration\": 184.007,\n \"direction\": \"outbound\",\n \"is_video\": false,\n \"visible\": true,\n \"leexi_url\": \"...\",\n \"video_archived_at\": null,\n \"audio_archived_at\": null,\n \"transcript_archived_at\": null,\n \"completions_archived_at\": null\n },\n \"prompt\": {\n \"uuid\": \"prompt-summary\",\n \"title\": \"Summary\",\n \"category\": \"summary\"\n },\n \"translations\": [\n {\n \"uuid\": \"translation-en-us\",\n \"locale\": \"en-US\",\n \"text\": \"After translated text\",\n \"original_text\": \"Before text\",\n \"updated_at\": \"2026-04-13T12:00:00.000Z\"\n }\n ]\n },\n \"message\": \"Call note successfully updated\"\n}" } }, "schema": { "properties": { "data": { "properties": { "call": { "properties": { "audio_archived_at": {}, "completions_archived_at": {}, "created_at": { "example": "2026-04-12T09:00:00.000Z", "type": "string" }, "direction": { "example": "outbound", "type": "string" }, "duration": { "example": 184.007, "type": "number" }, "is_video": { "example": false, "type": "boolean" }, "leexi_url": { "example": "...", "type": "string" }, "locale": { "example": "en-US", "type": "string" }, "performed_at": { "example": "2026-04-13T10:00:00.000Z", "type": "string" }, "transcript_archived_at": {}, "updated_at": { "example": "2026-04-13T11:30:00.000Z", "type": "string" }, "uuid": { "example": "call-1", "type": "string" }, "video_archived_at": {}, "visible": { "example": true, "type": "boolean" } }, "type": "object" }, "created_at": { "example": "2026-04-13T11:00:00.000Z", "type": "string" }, "prompt": { "properties": { "category": { "example": "summary", "type": "string" }, "title": { "example": "Summary", "type": "string" }, "uuid": { "example": "prompt-summary", "type": "string" } }, "type": "object" }, "translations": { "items": { "properties": { "locale": { "example": "en-US", "type": "string" }, "original_text": { "example": "Before text", "type": "string" }, "text": { "example": "After translated text", "type": "string" }, "updated_at": { "example": "2026-04-13T12:00:00.000Z", "type": "string" }, "uuid": { "example": "translation-en-us", "type": "string" } }, "type": "object" }, "type": "array" }, "updated_at": { "example": "2026-04-13T11:30:00.000Z", "type": "string" }, "uuid": { "example": "note-update", "type": "string" } }, "type": "object" }, "message": { "example": "Call note successfully updated", "type": "string" }, "success": { "example": true, "type": "boolean" } }, "type": "object" } } }, "description": "200" }, "403": { "content": { "application/json": { "examples": { "Result": { "value": "{\n \"success\": false,\n \"message\": \"The API key has no write_calls access\"\n}" } }, "schema": { "properties": { "message": { "example": "The API key has no write_calls access", "type": "string" }, "success": { "example": false, "type": "boolean" } }, "type": "object" } } }, "description": "403" }, "404": { "content": { "application/json": { "examples": { "Result": { "value": "{\n \"success\": false,\n \"message\": \"Call note translation not found\"\n}" } }, "schema": { "properties": { "message": { "example": "Call note translation not found", "type": "string" }, "success": { "example": false, "type": "boolean" } }, "type": "object" } } }, "description": "404" } }, "summary": "Update a call note" } }, "/meeting_events": { "get": { "description": "", "operationId": "list-meeting-events", "parameters": [ { "in": "query", "name": "page", "schema": { "default": 1, "format": "int32", "type": "integer" } }, { "description": "min: 1, max: 100", "in": "query", "name": "items", "schema": { "default": 10, "format": "int32", "type": "integer" } }, { "in": "query", "name": "order", "schema": { "default": "start_time desc", "enum": [ "created_at desc", "created_at asc", "start_time desc", "start_time asc", "end_time desc", "end_time asc" ], "type": "string" } }, { "description": "Filter by meeting event origin", "in": "query", "name": "origin", "schema": { "enum": [ "calendar", "manual", "api" ], "type": "string" } }, { "description": "from/to filter date", "in": "query", "name": "date_filter", "schema": { "default": "start_time", "enum": [ "start_time", "end_time" ], "type": "string" } }, { "description": "YYYY-MM-DDTHH:MM:SS.000Z, this filters on the meetings start_time (or other date_filter)", "in": "query", "name": "from", "schema": { "type": "string" } }, { "description": "YYYY-MM-DDTHH:MM:SS.000Z, this filters on the meetings start_time (or other date_filter)", "in": "query", "name": "to", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "examples": { "Result": { "value": "{\n \"data\": [\n {\n \"uuid\": \"bcdvde61-b4b5-4c93-96be-aa5162086f4d\",\n \"title\": \"Nihil tenetur dolore illum.\",\n \"organizer\": {\n \"email\": \"philippe@leexi.ai\"\n },\n \"attendees\": [\n {\n \"email\": \"bob@test.com\"\n },\n {\n \"email\": \"alice@test.com\"\n }\n ],\n \"meeting_url\": \"https://teams.microsoft.com/l/meetup-join/...\",\n \"meeting_provider\": \"teams_meeting\",\n \"internal\": false,\n \"direction\": \"outbound\",\n \"start_time\": \"2024-06-20T09:30:00.000Z\",\n \"end_time\": \"2024-06-20T10:00:00.000Z\",\n \"description\": \"Maxime pariatur vitae. Pariatur ea reprehenderit. Et omnis id.\",\n \"owned\": true,\n \"to_record\": true,\n \"bot_scheduled\": false,\n \"bot_running\": false,\n \"bot_runs\" : [\n {\n \"uuid\": \"f3d6e1d4-aa2c-489b-9b73-6db6b0e5089a\",\n \"start_time\": \"2024-06-20T09:30:00.000Z\",\n \"end_time\": \"2024-06-20T10:30:00.000Z\",\n \"recording_start_time\": \"2024-06-20T09:35:00.000Z\",\n \"end_reason\": \"participants_left\"\n }\n ],\n \"origin\": \"api\",\n \"created_at\": \"2024-06-13T11:40:12.759Z\",\n \"updated_at\": \"2024-06-13T11:40:12.759Z\",\n \"recording_notified\": false,\n \"active\": true\n },\n {\n \"uuid\": \"bgd3gh77-9e4f-4928-8f96-e531d029e196\",\n \"title\": \"Ipsam omnis ullam est.\",\n \"organizer\": {\n \"email\": \"martin@leexi.ai\"\n },\n \"attendees\": [\n {\n \"email\": \"carole@test.com\"\n }\n ],\n \"meeting_url\": \"https://meet.google.com/abc-defg-hij\",\n \"meeting_provider\": \"google_meeting\",\n \"internal\": false,\n \"direction\": \"outbound\",\n \"start_time\": \"2024-06-20T10:30:00.000Z\",\n \"end_time\": \"2024-06-20T11:00:00.000Z\",\n \"description\": \"Ut hic libero. Dolores repellat beatae. Placeat provident repellendus.\",\n \"owned\": true,\n \"to_record\": true,\n \"bot_scheduled\": false,\n \"bot_running\": false,\n \"bot_runs\": [],\n \"origin\": \"api\",\n \"created_at\": \"2024-06-13T12:40:12.688Z\",\n \"updated_at\": \"2024-06-13T12:40:12.688Z\",\n \"recording_notified\": false,\n \"active\": true\n }\n ],\n \"pagination\": {\n \"page\": 2,\n \"items\": 10,\n \"count\": 12,\n \"pages\": 2\n }\n}" } }, "schema": { "properties": { "data": { "items": { "properties": { "active": { "default": true, "example": true, "type": "boolean" }, "attendees": { "items": { "properties": { "email": { "example": "bob@test.com", "type": "string" } }, "type": "object" }, "type": "array" }, "bot_running": { "default": true, "example": false, "type": "boolean" }, "bot_runs": { "items": { "properties": { "end_reason": { "example": "participants_left", "type": "string" }, "end_time": { "example": "2024-06-20T10:30:00.000Z", "type": "string" }, "recording_start_time": { "example": "2024-06-20T09:35:00.000Z", "type": "string" }, "start_time": { "example": "2024-06-20T09:30:00.000Z", "type": "string" }, "uuid": { "example": "f3d6e1d4-aa2c-489b-9b73-6db6b0e5089a", "type": "string" } }, "type": "object" }, "type": "array" }, "bot_scheduled": { "default": true, "example": false, "type": "boolean" }, "created_at": { "example": "2024-06-13T11:40:12.759Z", "type": "string" }, "description": { "example": "Maxime pariatur vitae. Pariatur ea reprehenderit. Et omnis id.", "type": "string" }, "direction": { "example": "outbound", "type": "string" }, "end_time": { "example": "2024-06-20T10:00:00.000Z", "type": "string" }, "internal": { "default": true, "example": false, "type": "boolean" }, "meeting_provider": { "example": "teams_meeting", "type": "string" }, "meeting_url": { "example": "https://teams.microsoft.com/l/meetup-join/...", "type": "string" }, "organizer": { "properties": { "email": { "example": "philippe@leexi.ai", "type": "string" } }, "type": "object" }, "origin": { "example": "api", "type": "string" }, "owned": { "default": true, "example": true, "type": "boolean" }, "recording_notified": { "default": true, "example": false, "type": "boolean" }, "start_time": { "example": "2024-06-20T09:30:00.000Z", "type": "string" }, "title": { "example": "Nihil tenetur dolore illum.", "type": "string" }, "to_record": { "default": true, "example": true, "type": "boolean" }, "updated_at": { "example": "2024-06-13T11:40:12.759Z", "type": "string" }, "uuid": { "example": "bcdvde61-b4b5-4c93-96be-aa5162086f4d", "type": "string" } }, "type": "object" }, "type": "array" }, "pagination": { "properties": { "count": { "default": 0, "example": 12, "type": "integer" }, "items": { "default": 0, "example": 10, "type": "integer" }, "page": { "default": 0, "example": 2, "type": "integer" }, "pages": { "example": 2, "type": "integer" } }, "type": "object" } }, "type": "object" } } }, "description": "200" }, "400": { "content": { "application/json": { "examples": { "Result": { "value": "{\n \"success\": false,\n \"message\": \"An error occurred\"\n}" } }, "schema": { "properties": { "message": { "example": "An error occurred", "type": "string" }, "success": { "example": false, "type": "boolean" } }, "type": "object" } } }, "description": "400" } }, "summary": "list meeting events" }, "post": { "description": "", "operationId": "create-a-meeting-event", "requestBody": { "content": { "application/json": { "schema": { "properties": { "attendees": { "description": "[alice@test.com, bob@test.com]", "items": { "type": "string" }, "type": "array" }, "description": { "type": "string" }, "direction": { "enum": [ "inbound", "outbound" ], "type": "string" }, "end_time": { "description": "YYYY-MM-DDTHH:MM:SS.000Z", "format": "date", "type": "string" }, "internal": { "default": false, "type": "boolean" }, "meeting_url": { "description": "Zoom, Teams or Google meet", "type": "string" }, "organizer": { "description": "foo@bar.com", "type": "string" }, "owned": { "default": false, "type": "boolean" }, "start_time": { "description": "YYYY-MM-DDTHH:MM:SS.000Z", "format": "date", "type": "string" }, "title": { "type": "string" }, "to_record": { "type": "boolean" }, "user_uuid": { "description": "Leexi user associated with the meeting. (Use the LIST users endpoint)", "type": "string" } }, "required": [ "meeting_url", "user_uuid", "start_time", "end_time", "internal", "owned", "organizer", "to_record" ], "type": "object" } } } }, "responses": { "200": { "content": { "application/json": { "examples": { "Result": { "value": "{\n \"success\": true,\n \"data\": {\n \"uuid\": \"b980db78-sdsd-dfdf-8c97-fb3a0c3d4e49\",\n \"title\": null,\n \"organizer\": null,\n \"attendees\": [],\n \"meeting_url\": \"https://meet.google.com/abc-dsfs-mar\",\n \"meeting_provider\": null,\n \"internal\": false,\n \"direction\": null,\n \"start_time\": \"2024-06-13T11:00:00.000Z\",\n \"end_time\": \"2024-06-13T11:30:00.000Z\",\n \"description\": null,\n \"owned\": false,\n \"to_record\": false,\n \"bot_scheduled\": false,\n \"bot_running\": false,\n \"bot_runs\": [],\n \"origin\": \"api\",\n \"created_at\": \"2024-07-02T15:58:58.494+02:00\",\n \"updated_at\": \"2024-07-02T15:58:58.494+02:00\",\n \"recording_notified\": false,\n \"active\": true,\n \"integration_user\": null\n },\n \"message\": \"Meeting event successfully created\"\n}" } }, "schema": { "properties": { "data": { "properties": { "active": { "default": true, "example": true, "type": "boolean" }, "attendees": { "items": { "properties": {}, "type": "object" }, "type": "array" }, "bot_running": { "default": true, "example": false, "type": "boolean" }, "bot_runs": { "items": { "properties": {}, "type": "object" }, "type": "array" }, "bot_scheduled": { "default": true, "example": false, "type": "boolean" }, "created_at": { "example": "2024-07-02T15:58:58.494+02:00", "type": "string" }, "description": {}, "direction": {}, "end_time": { "example": "2024-06-13T11:30:00.000Z", "type": "string" }, "integration_user": {}, "internal": { "default": true, "example": false, "type": "boolean" }, "meeting_provider": {}, "meeting_url": { "example": "https://meet.google.com/abc-dsfs-mar", "type": "string" }, "organizer": {}, "origin": { "example": "api", "type": "string" }, "owned": { "default": true, "example": false, "type": "boolean" }, "recording_notified": { "default": true, "example": false, "type": "boolean" }, "start_time": { "example": "2024-06-13T11:00:00.000Z", "type": "string" }, "title": {}, "to_record": { "default": true, "example": false, "type": "boolean" }, "updated_at": { "example": "2024-07-02T15:58:58.494+02:00", "type": "string" }, "uuid": { "example": "b980db78-sdsd-dfdf-8c97-fb3a0c3d4e49", "type": "string" } }, "type": "object" }, "message": { "example": "Meeting event successfully created", "type": "string" }, "success": { "default": true, "example": true, "type": "boolean" } }, "type": "object" } } }, "description": "200" }, "400": { "content": { "application/json": { "examples": { "Result": { "value": "{\n \"success\": false,\n \"message\": \"text is required\"\n}" } }, "schema": { "properties": { "message": { "example": "text is required", "type": "string" }, "success": { "example": false, "type": "boolean" } }, "type": "object" } } }, "description": "400" }, "403": { "content": { "application/json": { "examples": { "Result": { "value": "{\n \"success\": false,\n \"message\": \"This user does not have a transcription license\"\n}" } }, "schema": { "properties": { "message": { "example": "This user does not have a transcription license", "type": "string" }, "success": { "default": true, "example": false, "type": "boolean" } }, "type": "object" } } }, "description": "403" }, "409": { "content": { "application/json": { "examples": { "Result": { "value": "{\n \"success\": false,\n \"message\": \"A meeting event with this URL and start time already exists\"\n}" } }, "schema": { "properties": { "message": { "example": "A meeting event with this URL and start time already exists", "type": "string" }, "success": { "default": true, "example": false, "type": "boolean" } }, "type": "object" } } }, "description": "409" } }, "summary": "Create a meeting event" } }, "/meeting_events/{uuid}": { "delete": { "description": "", "operationId": "delete-a-meeting-event", "parameters": [ { "in": "path", "name": "uuid", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "examples": { "Result": { "value": "{\n \"success\": true,\n \"data\": {},\n \"message\": \"Meeting event successfully deleted\"\n}" } }, "schema": { "properties": { "data": { "properties": {}, "type": "object" }, "message": { "example": "Meeting event successfully deleted", "type": "string" }, "success": { "default": true, "example": true, "type": "boolean" } }, "type": "object" } } }, "description": "200" }, "404": { "content": { "application/json": { "examples": { "Result": { "value": "{\n \"success\": false,\n \"message\": \"event not found\"\n}" } }, "schema": { "properties": { "message": { "example": "event not found", "type": "string" }, "success": { "default": true, "example": false, "type": "boolean" } }, "type": "object" } } }, "description": "404" } }, "summary": "Delete a meeting event" }, "get": { "description": "", "operationId": "get-a-meeting-event", "parameters": [ { "in": "path", "name": "uuid", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "examples": { "Result": { "value": "{\n \"success\": true,\n \"data\": {\n \"uuid\": \"dfghj586-01c4-dfdf-8a56-bb3c10b153b6\",\n \"title\": \"Aperiam ab consequatur culpa.\",\n \"organizer\": {\n \"email\": \"baptiste@leexi.ai\"\n },\n \"attendees\": [\n {\n \"email\": \"matthieu@leexi.ai\"\n }\n ],\n \"meeting_url\": \"https://meet.google.com/abc-behz-cyt\",\n \"meeting_provider\": \"google_meeting\",\n \"internal\": true,\n \"direction\": \"outbound\",\n \"start_time\": \"2024-06-13T12:00:00.000Z\",\n \"end_time\": \"2024-06-13T12:30:00.000Z\",\n \"description\": \"Nesciunt deleniti adipisci. Adipisci saepe provident. In nulla et.\",\n \"owned\": true,\n \"to_record\": false,\n \"bot_scheduled\": false,\n \"bot_running\": false,\n \"bot_runs\" : [\n {\n \"uuid\": \"f3d6e1d4-aa2c-489b-9b73-6db6b0e5089a\",\n \"start_time\": \"2024-06-20T09:30:00.000Z\",\n \"end_time\": \"2024-06-20T10:30:00.000Z\",\n \"recording_start_time\": \"2024-06-20T09:35:00.000Z\",\n \"end_reason\": \"participants_left\"\n }\n ],\n \"origin\": \"api\",\n \"created_at\": \"2024-06-13T12:55:06.153+02:00\",\n \"updated_at\": \"2024-06-13T12:55:06.153+02:00\",\n \"recording_notified\": false,\n \"active\": true,\n \"integration_user\": {\n \"uuid\": \"df1a64f1-dfdf-4429-85c0-f77f18321a78\",\n \"name\": \"Baptiste\",\n \"email\": \"baptiste@leexi.ai\",\n \"active\": true,\n \"user\": {\n \"uuid\": \"97b312f5-dfdf-dfdf-a651-157976424fa7\",\n \"name\": \"Baptiste\",\n \"email\": \"baptiste@leexi.ai\"\n },\n \"integration\": {\n \"active\": true,\n \"category\": \"calendar\",\n \"logo\": \"...\",\n \"name\": \"Google Calendar\",\n \"slug\": \"google_calendar\",\n \"url\": \"https://calendar.google.com/\",\n \"uuid\": \"dfbd9f34-dfdf-dfdf-8860-d38050c3cf8c\"\n },\n \"calls\": [\n {\n \"uuid\": \"bb21867f-9f82-4a0e-bd36-62c7f0c6a3b2\",\n \"source\": \"gmeet_bot\",\n \"source_id\": \"784783982\",\n \"created_at\": \"2022-03-08T13:21:53.134Z\",\n \"updated_at\": \"2024-07-02T15:00:55.066Z\",\n \"performed_at\": \"2022-03-08T11:49:23.000Z\",\n \"locale\": \"fr-FR\",\n \"duration\": 184.007,\n \"direction\": \"outbound\",\n \"is_video\": false,\n \"visible\": true,\n \"recording_url\": null,\n \"transcript_url\": \"...\",\n \"leexi_url\": \"...\"\n \t\t}\n ]\n }\n },\n \"message\": \"Meeting event successfully retrieved\"\n}" } }, "schema": { "properties": { "data": { "properties": { "active": { "default": true, "example": true, "type": "boolean" }, "attendees": { "items": { "properties": { "email": { "example": "matthieu@leexi.ai", "type": "string" } }, "type": "object" }, "type": "array" }, "bot_running": { "default": true, "example": false, "type": "boolean" }, "bot_runs": { "items": { "properties": { "end_reason": { "example": "participants_left", "type": "string" }, "end_time": { "example": "2024-06-20T10:30:00.000Z", "type": "string" }, "recording_start_time": { "example": "2024-06-20T09:35:00.000Z", "type": "string" }, "start_time": { "example": "2024-06-20T09:30:00.000Z", "type": "string" }, "uuid": { "example": "f3d6e1d4-aa2c-489b-9b73-6db6b0e5089a", "type": "string" } }, "type": "object" }, "type": "array" }, "bot_scheduled": { "default": true, "example": false, "type": "boolean" }, "calls": { "items": { "properties": { "created_at": { "example": "2022-03-08T13:21:53.134Z", "type": "string" }, "direction": { "example": "outbound", "type": "string" }, "duration": { "default": 0, "example": 184.007, "type": "number" }, "is_video": { "default": true, "example": false, "type": "boolean" }, "leexi_url": { "example": "...", "type": "string" }, "locale": { "example": "fr-FR", "type": "string" }, "performed_at": { "example": "2022-03-08T11:49:23.000Z", "type": "string" }, "recording_url": {}, "source": { "example": "gmeet_bot", "type": "string" }, "source_id": { "example": "784783982", "type": "string" }, "transcript_url": { "example": "...", "type": "string" }, "updated_at": { "example": "2024-07-02T15:00:55.066Z", "type": "string" }, "uuid": { "example": "bb21867f-9f82-4a0e-bd36-62c7f0c6a3b2", "type": "string" }, "visible": { "default": true, "example": true, "type": "boolean" } }, "type": "object" }, "type": "array" }, "created_at": { "example": "2024-06-13T12:55:06.153+02:00", "type": "string" }, "description": { "example": "Nesciunt deleniti adipisci. Adipisci saepe provident. In nulla et.", "type": "string" }, "direction": { "example": "outbound", "type": "string" }, "end_time": { "example": "2024-06-13T12:30:00.000Z", "type": "string" }, "integration_user": { "properties": { "active": { "default": true, "example": true, "type": "boolean" }, "email": { "example": "baptiste@leexi.ai", "type": "string" }, "integration": { "properties": { "active": { "default": true, "example": true, "type": "boolean" }, "category": { "example": "calendar", "type": "string" }, "logo": { "example": "...", "type": "string" }, "name": { "example": "Google Calendar", "type": "string" }, "slug": { "example": "google_calendar", "type": "string" }, "url": { "example": "https://calendar.google.com/", "type": "string" }, "uuid": { "example": "dfbd9f34-dfdf-dfdf-8860-d38050c3cf8c", "type": "string" } }, "type": "object" }, "name": { "example": "Baptiste", "type": "string" }, "user": { "properties": { "email": { "example": "baptiste@leexi.ai", "type": "string" }, "name": { "example": "Baptiste", "type": "string" }, "uuid": { "example": "97b312f5-dfdf-dfdf-a651-157976424fa7", "type": "string" } }, "type": "object" }, "uuid": { "example": "df1a64f1-dfdf-4429-85c0-f77f18321a78", "type": "string" } }, "type": "object" }, "internal": { "default": true, "example": true, "type": "boolean" }, "meeting_provider": { "example": "google_meeting", "type": "string" }, "meeting_url": { "example": "https://meet.google.com/abc-behz-cyt", "type": "string" }, "organizer": { "properties": { "email": { "example": "baptiste@leexi.ai", "type": "string" } }, "type": "object" }, "origin": { "example": "api", "type": "string" }, "owned": { "default": true, "example": true, "type": "boolean" }, "recording_notified": { "default": true, "example": false, "type": "boolean" }, "start_time": { "example": "2024-06-13T12:00:00.000Z", "type": "string" }, "title": { "example": "Aperiam ab consequatur culpa.", "type": "string" }, "to_record": { "default": true, "example": false, "type": "boolean" }, "updated_at": { "example": "2024-06-13T12:55:06.153+02:00", "type": "string" }, "uuid": { "example": "dfghj586-01c4-dfdf-8a56-bb3c10b153b6", "type": "string" } }, "type": "object" }, "message": { "example": "Meeting event successfully retrieved", "type": "string" }, "success": { "default": true, "example": true, "type": "boolean" } }, "type": "object" } } }, "description": "200" }, "400": { "content": { "application/json": { "examples": { "Result": { "value": "{}" } }, "schema": { "properties": {}, "type": "object" } } }, "description": "400" } }, "summary": "Get a meeting event" } }, "/meeting_events/{uuid}/launch_bot": { "post": { "description": "", "operationId": "launch-a-meeting-assistant", "parameters": [ { "in": "path", "name": "uuid", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "stop_task": { "default": false, "description": "Stop the ongoing bot", "type": "boolean" } }, "type": "object" } } } }, "responses": { "200": { "content": { "application/json": { "examples": { "Result": { "value": "{\n \"success\": true,\n \"data\": {\n \"uuid\": \"dfghj586-01c4-dfdf-8a56-bb3c10b153b6\",\n \"title\": \"Quarterly business review\",\n \"organizer\": {\n \"email\": \"ops@acme.com\"\n },\n \"attendees\": [\n {\n \"email\": \"alice@acme.com\"\n }\n ],\n \"meeting_url\": \"https://meet.google.com/abc-behz-cyt\",\n \"meeting_provider\": \"google_meeting\",\n \"internal\": true,\n \"direction\": \"outbound\",\n \"start_time\": \"2024-06-13T12:00:00.000Z\",\n \"end_time\": \"2024-06-13T12:30:00.000Z\",\n \"description\": \"Quarterly business review\",\n \"owned\": true,\n \"to_record\": true,\n \"bot_scheduled\": false,\n \"bot_running\": false,\n \"bot_runs\": [],\n \"origin\": \"api\",\n \"created_at\": \"2024-06-13T12:55:06.153Z\",\n \"updated_at\": \"2024-06-13T12:55:06.153Z\",\n \"recording_notified\": false,\n \"active\": true\n },\n \"message\": \"Meeting event bot launched\"\n}" } }, "schema": { "properties": { "data": { "properties": { "active": { "example": true, "type": "boolean" }, "attendees": { "items": { "properties": { "email": { "example": "alice@acme.com", "type": "string" } }, "type": "object" }, "type": "array" }, "bot_running": { "example": false, "type": "boolean" }, "bot_runs": { "items": { "properties": {}, "type": "object" }, "type": "array" }, "bot_scheduled": { "example": false, "type": "boolean" }, "created_at": { "example": "2024-06-13T12:55:06.153Z", "type": "string" }, "description": { "example": "Quarterly business review", "type": "string" }, "direction": { "example": "outbound", "type": "string" }, "end_time": { "example": "2024-06-13T12:30:00.000Z", "type": "string" }, "internal": { "example": true, "type": "boolean" }, "meeting_provider": { "example": "google_meeting", "type": "string" }, "meeting_url": { "example": "https://meet.google.com/abc-behz-cyt", "type": "string" }, "organizer": { "properties": { "email": { "example": "ops@acme.com", "type": "string" } }, "type": "object" }, "origin": { "example": "api", "type": "string" }, "owned": { "example": true, "type": "boolean" }, "recording_notified": { "example": false, "type": "boolean" }, "start_time": { "example": "2024-06-13T12:00:00.000Z", "type": "string" }, "title": { "example": "Quarterly business review", "type": "string" }, "to_record": { "example": true, "type": "boolean" }, "updated_at": { "example": "2024-06-13T12:55:06.153Z", "type": "string" }, "uuid": { "example": "dfghj586-01c4-dfdf-8a56-bb3c10b153b6", "type": "string" } }, "type": "object" }, "message": { "example": "Meeting event bot launched", "type": "string" }, "success": { "example": true, "type": "boolean" } }, "type": "object" } } }, "description": "200" }, "400": { "content": { "application/json": { "examples": { "Result": { "value": "{\n \"success\": false,\n \"message\": \"Meeting provider is invalid\"\n}" } }, "schema": { "properties": { "message": { "example": "Meeting provider is invalid", "type": "string" }, "success": { "example": false, "type": "boolean" } }, "type": "object" } } }, "description": "400" }, "404": { "description": "404" }, "409": { "description": "409" }, "429": { "description": "429" } }, "summary": "Launch a meeting assistant" } }, "/teams": { "get": { "description": "List all teams in your workspace", "operationId": "list-teams", "parameters": [ { "in": "query", "name": "page", "schema": { "default": 1, "format": "int32", "type": "integer" } }, { "description": "min: 1, max: 100", "in": "query", "name": "items", "schema": { "default": 10, "format": "int32", "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "examples": { "Result": { "value": "{\n \"data\": [\n {\n \"uuid\": \"5290728d-b3c4-4330-918d-d8f153e9500d\",\n \"name\": \"Sales Team\",\n \"active\": true,\n \"created_at\": \"2024-06-14T11:00:33.534Z\",\n \"updated_at\": \"2024-06-14T11:00:33.534Z\"\n }\n ],\n \"pagination\": {\n \"page\": 1,\n \"items\": 10,\n \"count\": 1,\n \"pages\": 1\n }\n}" } }, "schema": { "properties": { "data": { "items": { "properties": { "active": { "default": true, "example": true, "type": "boolean" }, "created_at": { "example": "2024-06-14T11:00:33.534Z", "type": "string" }, "name": { "example": "Sales Team", "type": "string" }, "updated_at": { "example": "2024-06-14T11:00:33.534Z", "type": "string" }, "uuid": { "example": "5290728d-b3c4-4330-918d-d8f153e9500d", "type": "string" } }, "type": "object" }, "type": "array" }, "pagination": { "properties": { "count": { "default": 0, "example": 1, "type": "integer" }, "items": { "default": 0, "example": 1, "type": "integer" }, "page": { "default": 0, "example": 1, "type": "integer" }, "pages": { "example": 1, "type": "integer" } }, "type": "object" } }, "type": "object" } } }, "description": "200" }, "401": { "description": "401" }, "402": { "description": "402" }, "403": { "description": "403" }, "429": { "description": "429" } }, "summary": "List teams" }, "post": { "description": "Create a team in your workspace. The team inherits your company settings and gets the default email templates.", "operationId": "create-a-team", "requestBody": { "content": { "application/json": { "schema": { "properties": { "active": { "description": "Defaults to `true` on creation. A team can only be deactivated once it has no active users.", "type": "boolean" }, "name": { "description": "The team name. It must be unique within your workspace.", "type": "string" } }, "required": [ "name" ], "type": "object" } } } }, "responses": { "200": { "content": { "application/json": { "examples": { "Result": { "value": "{\n \"success\": true,\n \"data\": {\n \"uuid\": \"5290728d-b3c4-4330-918d-d8f153e9500d\",\n \"name\": \"Sales Team\",\n \"active\": true,\n \"created_at\": \"2024-06-14T11:00:33.534Z\",\n \"updated_at\": \"2024-06-14T11:00:33.534Z\"\n },\n \"message\": \"Team successfully created\"\n}" } }, "schema": { "properties": { "data": { "properties": { "active": { "example": true, "type": "boolean" }, "created_at": { "example": "2024-06-14T11:00:33.534Z", "type": "string" }, "name": { "example": "Sales Team", "type": "string" }, "updated_at": { "example": "2024-06-14T11:00:33.534Z", "type": "string" }, "uuid": { "example": "5290728d-b3c4-4330-918d-d8f153e9500d", "type": "string" } }, "type": "object" }, "message": { "example": "Team successfully created", "type": "string" }, "success": { "example": true, "type": "boolean" } }, "type": "object" } } }, "description": "200" }, "400": { "content": { "application/json": { "examples": { "Result": { "value": "{\n \"success\": false,\n \"message\": \"Missing required params: name\"\n}" } }, "schema": { "properties": { "message": { "example": "Missing required params: name", "type": "string" }, "success": { "example": false, "type": "boolean" } }, "type": "object" } } }, "description": "400" }, "403": { "content": { "application/json": { "examples": { "Result": { "value": "{\n \"success\": false,\n \"message\": \"The API key has no write_teams access\"\n}" } }, "schema": { "properties": { "message": { "example": "The API key has no write_teams access", "type": "string" }, "success": { "example": false, "type": "boolean" } }, "type": "object" } } }, "description": "403" }, "409": { "content": { "application/json": { "examples": { "Result": { "value": "{\n \"success\": false,\n \"message\": \"A team with this name already exists\"\n}" } }, "schema": { "properties": { "message": { "example": "A team with this name already exists", "type": "string" }, "success": { "example": false, "type": "boolean" } }, "type": "object" } } }, "description": "409" } }, "summary": "Create a team" } }, "/teams/{uuid}": { "delete": { "description": "Delete a team. Only a team with no users and no calls can be deleted; deactivate it instead with a `PATCH` setting `active` to `false`.", "operationId": "delete-a-team", "parameters": [ { "in": "path", "name": "uuid", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "examples": { "Result": { "value": "{\n \"success\": true,\n \"data\": {},\n \"message\": \"Team successfully deleted\"\n}" } }, "schema": { "properties": { "data": { "properties": {}, "type": "object" }, "message": { "example": "Team successfully deleted", "type": "string" }, "success": { "example": true, "type": "boolean" } }, "type": "object" } } }, "description": "200" }, "403": { "content": { "application/json": { "examples": { "Result": { "value": "{\n \"success\": false,\n \"message\": \"The API key has no write_teams access\"\n}" } }, "schema": { "properties": { "message": { "example": "The API key has no write_teams access", "type": "string" }, "success": { "example": false, "type": "boolean" } }, "type": "object" } } }, "description": "403" }, "404": { "content": { "application/json": { "examples": { "Result": { "value": "{\n \"success\": false,\n \"message\": \"Team not found\"\n}" } }, "schema": { "properties": { "message": { "example": "Team not found", "type": "string" }, "success": { "example": false, "type": "boolean" } }, "type": "object" } } }, "description": "404" }, "422": { "content": { "application/json": { "examples": { "Result": { "value": "{\n \"success\": false,\n \"message\": \"This team still has users or calls and cannot be deleted\"\n}" } }, "schema": { "properties": { "message": { "example": "This team still has users or calls and cannot be deleted", "type": "string" }, "success": { "example": false, "type": "boolean" } }, "type": "object" } } }, "description": "422" } }, "summary": "Delete a team" }, "get": { "description": "Retrieve a single team of your workspace.", "operationId": "get-a-team", "parameters": [ { "in": "path", "name": "uuid", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "examples": { "Result": { "value": "{\n \"success\": true,\n \"data\": {\n \"uuid\": \"5290728d-b3c4-4330-918d-d8f153e9500d\",\n \"name\": \"Sales Team\",\n \"active\": true,\n \"created_at\": \"2024-06-14T11:00:33.534Z\",\n \"updated_at\": \"2024-06-14T11:00:33.534Z\"\n },\n \"message\": \"Teams successfully retrieved\"\n}" } }, "schema": { "properties": { "data": { "properties": { "active": { "example": true, "type": "boolean" }, "created_at": { "example": "2024-06-14T11:00:33.534Z", "type": "string" }, "name": { "example": "Sales Team", "type": "string" }, "updated_at": { "example": "2024-06-14T11:00:33.534Z", "type": "string" }, "uuid": { "example": "5290728d-b3c4-4330-918d-d8f153e9500d", "type": "string" } }, "type": "object" }, "message": { "example": "Teams successfully retrieved", "type": "string" }, "success": { "example": true, "type": "boolean" } }, "type": "object" } } }, "description": "200" }, "403": { "content": { "application/json": { "examples": { "Result": { "value": "{\n \"success\": false,\n \"message\": \"The API key has no read_teams access\"\n}" } }, "schema": { "properties": { "message": { "example": "The API key has no read_teams access", "type": "string" }, "success": { "example": false, "type": "boolean" } }, "type": "object" } } }, "description": "403" }, "404": { "content": { "application/json": { "examples": { "Result": { "value": "{\n \"success\": false,\n \"message\": \"Team not found\"\n}" } }, "schema": { "properties": { "message": { "example": "Team not found", "type": "string" }, "success": { "example": false, "type": "boolean" } }, "type": "object" } } }, "description": "404" } }, "summary": "Get a team" }, "patch": { "description": "Update a team. Only the attributes present in the body are updated.", "operationId": "update-a-team", "parameters": [ { "in": "path", "name": "uuid", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "active": { "description": "Defaults to `true` on creation. A team can only be deactivated once it has no active users.", "type": "boolean" }, "name": { "description": "The team name. It must be unique within your workspace.", "type": "string" } }, "type": "object" } } } }, "responses": { "200": { "content": { "application/json": { "examples": { "Result": { "value": "{\n \"success\": true,\n \"data\": {\n \"uuid\": \"5290728d-b3c4-4330-918d-d8f153e9500d\",\n \"name\": \"Sales Team\",\n \"active\": true,\n \"created_at\": \"2024-06-14T11:00:33.534Z\",\n \"updated_at\": \"2024-06-14T11:00:33.534Z\"\n },\n \"message\": \"Team successfully updated\"\n}" } }, "schema": { "properties": { "data": { "properties": { "active": { "example": true, "type": "boolean" }, "created_at": { "example": "2024-06-14T11:00:33.534Z", "type": "string" }, "name": { "example": "Sales Team", "type": "string" }, "updated_at": { "example": "2024-06-14T11:00:33.534Z", "type": "string" }, "uuid": { "example": "5290728d-b3c4-4330-918d-d8f153e9500d", "type": "string" } }, "type": "object" }, "message": { "example": "Team successfully updated", "type": "string" }, "success": { "example": true, "type": "boolean" } }, "type": "object" } } }, "description": "200" }, "403": { "content": { "application/json": { "examples": { "Result": { "value": "{\n \"success\": false,\n \"message\": \"The API key has no write_teams access\"\n}" } }, "schema": { "properties": { "message": { "example": "The API key has no write_teams access", "type": "string" }, "success": { "example": false, "type": "boolean" } }, "type": "object" } } }, "description": "403" }, "404": { "content": { "application/json": { "examples": { "Result": { "value": "{\n \"success\": false,\n \"message\": \"Team not found\"\n}" } }, "schema": { "properties": { "message": { "example": "Team not found", "type": "string" }, "success": { "example": false, "type": "boolean" } }, "type": "object" } } }, "description": "404" }, "409": { "content": { "application/json": { "examples": { "Result": { "value": "{\n \"success\": false,\n \"message\": \"A team with this name already exists\"\n}" } }, "schema": { "properties": { "message": { "example": "A team with this name already exists", "type": "string" }, "success": { "example": false, "type": "boolean" } }, "type": "object" } } }, "description": "409" }, "422": { "content": { "application/json": { "examples": { "Result": { "value": "{\n \"success\": false,\n \"message\": \"Team still has active users\"\n}" } }, "schema": { "properties": { "message": { "example": "Team still has active users", "type": "string" }, "success": { "example": false, "type": "boolean" } }, "type": "object" } } }, "description": "422" } }, "summary": "Update a team" } }, "/users": { "get": { "description": "List all users in your workspace", "operationId": "list-users", "parameters": [ { "in": "query", "name": "page", "schema": { "default": 1, "format": "int32", "type": "integer" } }, { "description": "min: 1, max: 100", "in": "query", "name": "items", "schema": { "default": 10, "format": "int32", "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "examples": { "Result": { "value": "{\n \"data\": [\n {\n \"uuid\": \"befb9860-8661-442a-9496-8743de9e17cd\",\n \"name\": \"John Smith\",\n \"email\": \"john.smith@acme.com\",\n \"active\": true,\n \"license\": \"business\",\n \"roles\": [\n \"member\"\n ],\n \"team\": {\n \"uuid\": \"5290728d-b3c4-4330-918d-d8f153e9500d\",\n \"name\": \"Sales Team\",\n \"active\": true\n },\n \"created_at\": \"2024-06-14T11:00:33.534Z\",\n \"updated_at\": \"2024-06-14T11:00:33.534Z\"\n }\n ],\n \"pagination\": {\n \"page\": 1,\n \"items\": 10,\n \"count\": 1,\n \"pages\": 1\n }\n}" } }, "schema": { "properties": { "data": { "items": { "properties": { "active": { "example": true, "type": "boolean" }, "created_at": { "example": "2024-06-14T11:00:33.534Z", "type": "string" }, "email": { "example": "john.smith@acme.com", "type": "string" }, "license": { "example": "business", "type": "string" }, "name": { "example": "John Smith", "type": "string" }, "roles": { "items": { "example": "member", "type": "string" }, "type": "array" }, "team": { "properties": { "active": { "example": true, "type": "boolean" }, "name": { "example": "Sales Team", "type": "string" }, "uuid": { "example": "5290728d-b3c4-4330-918d-d8f153e9500d", "type": "string" } }, "type": "object" }, "updated_at": { "example": "2024-06-14T11:00:33.534Z", "type": "string" }, "uuid": { "example": "befb9860-8661-442a-9496-8743de9e17cd", "type": "string" } }, "type": "object" }, "type": "array" }, "pagination": { "properties": { "count": { "example": 1, "type": "integer" }, "items": { "example": 10, "type": "integer" }, "page": { "example": 1, "type": "integer" }, "pages": { "example": 1, "type": "integer" } }, "type": "object" } }, "type": "object" } } }, "description": "200" }, "401": { "description": "401" }, "402": { "description": "402" }, "403": { "description": "403" }, "429": { "description": "429" } }, "summary": "List Users" }, "post": { "description": "Create a user in your workspace. The user receives a welcome email with a link to set their password, unless `send_welcome_email` is `false`.", "operationId": "create-a-user", "requestBody": { "content": { "application/json": { "schema": { "properties": { "active": { "description": "Defaults to `true` on creation. Set to `false` to deactivate the user.", "type": "boolean" }, "email": { "description": "The user's email address. It must be deliverable and not already used in any Leexi company.", "type": "string" }, "license": { "description": "Either `free` or your company's own license category. Any other value is ignored.", "type": "string" }, "name": { "description": "The user's full name.", "type": "string" }, "roles": { "description": "Role names. Defaults to `[\"member\"]` on creation. Privileged roles (`super_admin`, `system_admin`, `billing_manager`) cannot be assigned through the API; grant them from Leexi > Settings > Users.", "items": { "type": "string" }, "type": "array" }, "send_welcome_email": { "description": "Defaults to `true`. Set to `false` to create the user without sending them the welcome email.", "type": "boolean" }, "team_uuid": { "description": "The uuid of the team the user belongs to.", "type": "string" } }, "required": [ "name", "email", "team_uuid" ], "type": "object" } } } }, "responses": { "200": { "content": { "application/json": { "examples": { "Result": { "value": "{\n \"success\": true,\n \"data\": {\n \"uuid\": \"befb9860-8661-442a-9496-8743de9e17cd\",\n \"name\": \"John Smith\",\n \"email\": \"john.smith@acme.com\",\n \"active\": true,\n \"license\": \"business\",\n \"roles\": [\n \"member\"\n ],\n \"team\": {\n \"uuid\": \"5290728d-b3c4-4330-918d-d8f153e9500d\",\n \"name\": \"Sales Team\",\n \"active\": true\n },\n \"created_at\": \"2024-06-14T11:00:33.534Z\",\n \"updated_at\": \"2024-06-14T11:00:33.534Z\"\n },\n \"message\": \"User successfully created\"\n}" } }, "schema": { "properties": { "data": { "properties": { "active": { "example": true, "type": "boolean" }, "created_at": { "example": "2024-06-14T11:00:33.534Z", "type": "string" }, "email": { "example": "john.smith@acme.com", "type": "string" }, "license": { "example": "business", "type": "string" }, "name": { "example": "John Smith", "type": "string" }, "roles": { "items": { "example": "member", "type": "string" }, "type": "array" }, "team": { "properties": { "active": { "example": true, "type": "boolean" }, "name": { "example": "Sales Team", "type": "string" }, "uuid": { "example": "5290728d-b3c4-4330-918d-d8f153e9500d", "type": "string" } }, "type": "object" }, "updated_at": { "example": "2024-06-14T11:00:33.534Z", "type": "string" }, "uuid": { "example": "befb9860-8661-442a-9496-8743de9e17cd", "type": "string" } }, "type": "object" }, "message": { "example": "User successfully created", "type": "string" }, "success": { "example": true, "type": "boolean" } }, "type": "object" } } }, "description": "200" }, "400": { "content": { "application/json": { "examples": { "Result": { "value": "{\n \"success\": false,\n \"message\": \"Missing required params: team_uuid\"\n}" } }, "schema": { "properties": { "message": { "example": "Missing required params: team_uuid", "type": "string" }, "success": { "example": false, "type": "boolean" } }, "type": "object" } } }, "description": "400" }, "403": { "content": { "application/json": { "examples": { "Result": { "value": "{\n \"success\": false,\n \"message\": \"The API key has no write_users access\"\n}" } }, "schema": { "properties": { "message": { "example": "The API key has no write_users access", "type": "string" }, "success": { "example": false, "type": "boolean" } }, "type": "object" } } }, "description": "403" }, "404": { "content": { "application/json": { "examples": { "Result": { "value": "{\n \"success\": false,\n \"message\": \"Team not found\"\n}" } }, "schema": { "properties": { "message": { "example": "Team not found", "type": "string" }, "success": { "example": false, "type": "boolean" } }, "type": "object" } } }, "description": "404" }, "409": { "content": { "application/json": { "examples": { "Result": { "value": "{\n \"success\": false,\n \"message\": \"A user with this email already exists\"\n}" } }, "schema": { "properties": { "message": { "example": "A user with this email already exists", "type": "string" }, "success": { "example": false, "type": "boolean" } }, "type": "object" } } }, "description": "409" } }, "summary": "Create a user" } }, "/users/{uuid}": { "delete": { "description": "Deactivate a user. Users are never permanently deleted: their calls and history are kept, their sessions are revoked and they stop consuming a license. Reactivate them with a `PATCH` setting `active` to `true`.", "operationId": "deactivate-a-user", "parameters": [ { "in": "path", "name": "uuid", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "examples": { "Result": { "value": "{\n \"success\": true,\n \"data\": {},\n \"message\": \"User successfully deactivated\"\n}" } }, "schema": { "properties": { "data": { "properties": {}, "type": "object" }, "message": { "example": "User successfully deactivated", "type": "string" }, "success": { "example": true, "type": "boolean" } }, "type": "object" } } }, "description": "200" }, "403": { "content": { "application/json": { "examples": { "Result": { "value": "{\n \"success\": false,\n \"message\": \"You must keep one active user with a paying license.\"\n}" } }, "schema": { "properties": { "message": { "example": "You must keep one active user with a paying license.", "type": "string" }, "success": { "example": false, "type": "boolean" } }, "type": "object" } } }, "description": "403" }, "404": { "content": { "application/json": { "examples": { "Result": { "value": "{\n \"success\": false,\n \"message\": \"User not found\"\n}" } }, "schema": { "properties": { "message": { "example": "User not found", "type": "string" }, "success": { "example": false, "type": "boolean" } }, "type": "object" } } }, "description": "404" } }, "summary": "Deactivate a user" }, "get": { "description": "Retrieve a single user of your workspace.", "operationId": "get-a-user", "parameters": [ { "in": "path", "name": "uuid", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "examples": { "Result": { "value": "{\n \"success\": true,\n \"data\": {\n \"uuid\": \"befb9860-8661-442a-9496-8743de9e17cd\",\n \"name\": \"John Smith\",\n \"email\": \"john.smith@acme.com\",\n \"active\": true,\n \"license\": \"business\",\n \"roles\": [\n \"member\"\n ],\n \"team\": {\n \"uuid\": \"5290728d-b3c4-4330-918d-d8f153e9500d\",\n \"name\": \"Sales Team\",\n \"active\": true\n },\n \"created_at\": \"2024-06-14T11:00:33.534Z\",\n \"updated_at\": \"2024-06-14T11:00:33.534Z\"\n },\n \"message\": \"User successfully retrieved\"\n}" } }, "schema": { "properties": { "data": { "properties": { "active": { "example": true, "type": "boolean" }, "created_at": { "example": "2024-06-14T11:00:33.534Z", "type": "string" }, "email": { "example": "john.smith@acme.com", "type": "string" }, "license": { "example": "business", "type": "string" }, "name": { "example": "John Smith", "type": "string" }, "roles": { "items": { "example": "member", "type": "string" }, "type": "array" }, "team": { "properties": { "active": { "example": true, "type": "boolean" }, "name": { "example": "Sales Team", "type": "string" }, "uuid": { "example": "5290728d-b3c4-4330-918d-d8f153e9500d", "type": "string" } }, "type": "object" }, "updated_at": { "example": "2024-06-14T11:00:33.534Z", "type": "string" }, "uuid": { "example": "befb9860-8661-442a-9496-8743de9e17cd", "type": "string" } }, "type": "object" }, "message": { "example": "User successfully retrieved", "type": "string" }, "success": { "example": true, "type": "boolean" } }, "type": "object" } } }, "description": "200" }, "403": { "content": { "application/json": { "examples": { "Result": { "value": "{\n \"success\": false,\n \"message\": \"The API key has no read_users access\"\n}" } }, "schema": { "properties": { "message": { "example": "The API key has no read_users access", "type": "string" }, "success": { "example": false, "type": "boolean" } }, "type": "object" } } }, "description": "403" }, "404": { "content": { "application/json": { "examples": { "Result": { "value": "{\n \"success\": false,\n \"message\": \"User not found\"\n}" } }, "schema": { "properties": { "message": { "example": "User not found", "type": "string" }, "success": { "example": false, "type": "boolean" } }, "type": "object" } } }, "description": "404" } }, "summary": "Get a user" }, "patch": { "description": "Update a user. Only the attributes present in the body are updated.", "operationId": "update-a-user", "parameters": [ { "in": "path", "name": "uuid", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "active": { "description": "Defaults to `true` on creation. Set to `false` to deactivate the user.", "type": "boolean" }, "email": { "description": "The user's email address. It must be deliverable and not already used in any Leexi company.", "type": "string" }, "license": { "description": "Either `free` or your company's own license category. Any other value is ignored.", "type": "string" }, "name": { "description": "The user's full name.", "type": "string" }, "roles": { "description": "Role names. Defaults to `[\"member\"]` on creation. Privileged roles (`super_admin`, `system_admin`, `billing_manager`) cannot be assigned through the API; grant them from Leexi > Settings > Users.", "items": { "type": "string" }, "type": "array" }, "team_uuid": { "description": "The uuid of the team the user belongs to.", "type": "string" } }, "type": "object" } } } }, "responses": { "200": { "content": { "application/json": { "examples": { "Result": { "value": "{\n \"success\": true,\n \"data\": {\n \"uuid\": \"befb9860-8661-442a-9496-8743de9e17cd\",\n \"name\": \"John Smith\",\n \"email\": \"john.smith@acme.com\",\n \"active\": true,\n \"license\": \"business\",\n \"roles\": [\n \"member\"\n ],\n \"team\": {\n \"uuid\": \"5290728d-b3c4-4330-918d-d8f153e9500d\",\n \"name\": \"Sales Team\",\n \"active\": true\n },\n \"created_at\": \"2024-06-14T11:00:33.534Z\",\n \"updated_at\": \"2024-06-14T11:00:33.534Z\"\n },\n \"message\": \"User successfully updated\"\n}" } }, "schema": { "properties": { "data": { "properties": { "active": { "example": true, "type": "boolean" }, "created_at": { "example": "2024-06-14T11:00:33.534Z", "type": "string" }, "email": { "example": "john.smith@acme.com", "type": "string" }, "license": { "example": "business", "type": "string" }, "name": { "example": "John Smith", "type": "string" }, "roles": { "items": { "example": "member", "type": "string" }, "type": "array" }, "team": { "properties": { "active": { "example": true, "type": "boolean" }, "name": { "example": "Sales Team", "type": "string" }, "uuid": { "example": "5290728d-b3c4-4330-918d-d8f153e9500d", "type": "string" } }, "type": "object" }, "updated_at": { "example": "2024-06-14T11:00:33.534Z", "type": "string" }, "uuid": { "example": "befb9860-8661-442a-9496-8743de9e17cd", "type": "string" } }, "type": "object" }, "message": { "example": "User successfully updated", "type": "string" }, "success": { "example": true, "type": "boolean" } }, "type": "object" } } }, "description": "200" }, "400": { "content": { "application/json": { "examples": { "Result": { "value": "{\n \"success\": false,\n \"message\": \"Unknown roles: wizard\"\n}" } }, "schema": { "properties": { "message": { "example": "Unknown roles: wizard", "type": "string" }, "success": { "example": false, "type": "boolean" } }, "type": "object" } } }, "description": "400" }, "403": { "content": { "application/json": { "examples": { "Result": { "value": "{\n \"success\": false,\n \"message\": \"You cannot remove the last super admin\"\n}" } }, "schema": { "properties": { "message": { "example": "You cannot remove the last super admin", "type": "string" }, "success": { "example": false, "type": "boolean" } }, "type": "object" } } }, "description": "403" }, "404": { "content": { "application/json": { "examples": { "Result": { "value": "{\n \"success\": false,\n \"message\": \"User not found\"\n}" } }, "schema": { "properties": { "message": { "example": "User not found", "type": "string" }, "success": { "example": false, "type": "boolean" } }, "type": "object" } } }, "description": "404" }, "422": { "content": { "application/json": { "examples": { "Result": { "value": "{\n \"success\": false,\n \"message\": \"You cannot change a user's email when SSO is enforced for your company\"\n}" } }, "schema": { "properties": { "message": { "example": "You cannot change a user's email when SSO is enforced for your company", "type": "string" }, "success": { "example": false, "type": "boolean" } }, "type": "object" } } }, "description": "422" } }, "summary": "Update a user" } }, "/reseller/companies": { "get": { "description": "List the client companies attached to your reseller account.", "operationId": "list-client-companies", "parameters": [ { "in": "query", "name": "page", "schema": { "default": 1, "format": "int32", "type": "integer" } }, { "description": "min: 1, max: 100", "in": "query", "name": "items", "schema": { "default": 10, "format": "int32", "type": "integer" } }, { "description": "Only return the client company carrying this external id.", "in": "query", "name": "reseller_external_id", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "examples": { "Result": { "value": "{\n \"data\": [\n {\n \"uuid\": \"c1f4b7a2-3d2e-4f0a-9b1c-6e7d8a9f0b12\",\n \"name\": \"Client One\",\n \"reseller_external_id\": \"CLIENT-1\",\n \"active\": true,\n \"industry\": \"consulting\",\n \"created_at\": \"2024-06-14T11:00:33.534Z\",\n \"updated_at\": \"2024-06-14T11:00:33.534Z\",\n \"subscription\": {\n \"status\": \"leexi_trialing\",\n \"active\": true,\n \"license\": \"business\",\n \"interval\": \"year\",\n \"currency\": \"eur\",\n \"trial_end\": 1767222000,\n \"seats\": {\n \"billed\": 4,\n \"min\": 2,\n \"max\": 10\n },\n \"manual_payment\": false,\n \"subscription_required\": true\n }\n }\n ],\n \"pagination\": {\n \"page\": 1,\n \"items\": 10,\n \"count\": 1,\n \"pages\": 1\n }\n}" } }, "schema": { "properties": { "data": { "items": { "properties": { "active": { "example": true, "type": "boolean" }, "created_at": { "example": "2024-06-14T11:00:33.534Z", "type": "string" }, "industry": { "description": "Industry of the client company. Null when not set.", "example": "consulting", "type": [ "string", "null" ] }, "name": { "example": "Client One", "type": "string" }, "reseller_external_id": { "description": "Your own reference for this client company. Null when not set.", "example": "CLIENT-1", "type": [ "string", "null" ] }, "updated_at": { "example": "2024-06-14T11:00:33.534Z", "type": "string" }, "uuid": { "example": "c1f4b7a2-3d2e-4f0a-9b1c-6e7d8a9f0b12", "type": "string" }, "subscription": { "description": "Billing state of the client company. There is no separate subscription object.", "properties": { "status": { "description": "Stripe status (active, trialing, incomplete, past_due, not_started, incomplete_expired, canceled, unpaid, paused) or Leexi trial status (leexi_trialing, leexi_trial_ended).", "example": "leexi_trialing", "type": "string" }, "active": { "description": "Whether the client can currently use Leexi.", "example": true, "type": "boolean" }, "license": { "description": "free, starter, ai_meeting or business.", "example": "business", "type": [ "string", "null" ] }, "interval": { "description": "month or year.", "example": "year", "type": "string" }, "currency": { "example": "eur", "type": "string" }, "trial_end": { "description": "Unix timestamp. Null when the client is not on a trial.", "example": 1767222000, "type": [ "integer", "null" ] }, "seats": { "properties": { "billed": { "description": "Number of seats currently billed.", "example": 4, "type": "integer" }, "max": { "description": "Maximum number of paid users. Null when unlimited.", "example": 10, "type": [ "integer", "null" ] }, "min": { "description": "Minimum billed seats. Null when not enforced.", "example": 2, "type": [ "integer", "null" ] } }, "type": "object" }, "manual_payment": { "example": false, "type": "boolean" }, "subscription_required": { "example": true, "type": "boolean" } }, "type": "object" } }, "type": "object" }, "type": "array" }, "pagination": { "properties": { "count": { "example": 1, "type": "integer" }, "items": { "example": 10, "type": "integer" }, "page": { "example": 1, "type": "integer" }, "pages": { "example": 1, "type": "integer" } }, "type": "object" } }, "type": "object" } } }, "description": "200" }, "401": { "description": "401" }, "402": { "description": "402" }, "403": { "content": { "application/json": { "examples": { "Result": { "value": "{\n \"success\": false,\n \"message\": \"The API key has no read_clients access\"\n}" } }, "schema": { "properties": { "message": { "example": "The API key has no read_clients access", "type": "string" }, "success": { "example": false, "type": "boolean" } }, "type": "object" } } }, "description": "403" }, "429": { "description": "429" } }, "summary": "List client companies" }, "post": { "description": "Create a client company attached to your reseller account. The company is created with its settings and the license you choose, and starts a Leexi trial ending at `trial_end`.", "operationId": "create-a-client-company", "requestBody": { "content": { "application/json": { "schema": { "properties": { "company_setting": { "properties": { "license_category": { "description": "License of the client company. Required on creation. `starter` caps the seats at 5.", "enum": [ "free", "starter", "ai_meeting", "business" ], "type": "string" }, "max_seats": { "description": "Maximum number of licensed users. Null for no limit.", "type": [ "integer", "null" ] }, "min_seats": { "description": "Minimum number of seats billed.", "type": [ "integer", "null" ] } }, "required": [ "license_category" ], "type": "object" }, "industry": { "description": "Industry of the client company.", "type": "string" }, "name": { "description": "Name of the client company. Must not contain `#` or `_`.", "type": "string" }, "reseller_external_id": { "description": "Your own reference for this client company. Must be unique among your client companies.", "type": "string" }, "setting": { "properties": { "locale": { "description": "Default locale of the client company, for example `en-US` or `fr-FR`.", "type": "string" }, "time_zone": { "description": "Time zone of the client company, for example `Europe/Paris`.", "type": "string" } }, "type": "object" }, "subscription_currency": { "description": "Billing currency, for example `eur`. Locked while a Stripe subscription is active.", "type": "string" }, "subscription_interval": { "description": "Billing interval, `month` or `year`.", "enum": [ "month", "year" ], "type": "string" }, "trial_end": { "description": "End of the Leexi trial as a Unix timestamp (seconds). Required. A date in the past creates the company with an ended trial.", "type": "integer" } }, "required": [ "company_setting", "name", "trial_end" ], "type": "object" } } } }, "responses": { "200": { "content": { "application/json": { "examples": { "Result": { "value": "{\n \"success\": true,\n \"data\": {\n \"uuid\": \"e7a1c2d4-5b6f-4a8e-9c0d-1f2e3a4b5c6d\",\n \"name\": \"New Client\",\n \"reseller_external_id\": \"CLIENT-9\",\n \"active\": true,\n \"industry\": null,\n \"created_at\": \"2024-06-14T11:00:33.534Z\",\n \"updated_at\": \"2024-06-14T11:00:33.534Z\",\n \"subscription\": {\n \"status\": \"leexi_trialing\",\n \"active\": true,\n \"license\": \"business\",\n \"interval\": \"year\",\n \"currency\": \"eur\",\n \"trial_end\": 1767222000,\n \"seats\": {\n \"billed\": 4,\n \"min\": 2,\n \"max\": 10\n },\n \"manual_payment\": false,\n \"subscription_required\": true\n }\n },\n \"message\": \"Company successfully created\"\n}" } }, "schema": { "properties": { "data": { "properties": { "active": { "example": true, "type": "boolean" }, "created_at": { "example": "2024-06-14T11:00:33.534Z", "type": "string" }, "industry": { "description": "Industry of the client company. Null when not set.", "example": "consulting", "type": [ "string", "null" ] }, "name": { "example": "Client One", "type": "string" }, "reseller_external_id": { "description": "Your own reference for this client company. Null when not set.", "example": "CLIENT-1", "type": [ "string", "null" ] }, "updated_at": { "example": "2024-06-14T11:00:33.534Z", "type": "string" }, "uuid": { "example": "c1f4b7a2-3d2e-4f0a-9b1c-6e7d8a9f0b12", "type": "string" }, "subscription": { "description": "Billing state of the client company. There is no separate subscription object.", "properties": { "status": { "description": "Stripe status (active, trialing, incomplete, past_due, not_started, incomplete_expired, canceled, unpaid, paused) or Leexi trial status (leexi_trialing, leexi_trial_ended).", "example": "leexi_trialing", "type": "string" }, "active": { "description": "Whether the client can currently use Leexi.", "example": true, "type": "boolean" }, "license": { "description": "free, starter, ai_meeting or business.", "example": "business", "type": [ "string", "null" ] }, "interval": { "description": "month or year.", "example": "year", "type": "string" }, "currency": { "example": "eur", "type": "string" }, "trial_end": { "description": "Unix timestamp. Null when the client is not on a trial.", "example": 1767222000, "type": [ "integer", "null" ] }, "seats": { "properties": { "billed": { "description": "Number of seats currently billed.", "example": 4, "type": "integer" }, "max": { "description": "Maximum number of paid users. Null when unlimited.", "example": 10, "type": [ "integer", "null" ] }, "min": { "description": "Minimum billed seats. Null when not enforced.", "example": 2, "type": [ "integer", "null" ] } }, "type": "object" }, "manual_payment": { "example": false, "type": "boolean" }, "subscription_required": { "example": true, "type": "boolean" } }, "type": "object" } }, "type": "object" }, "message": { "example": "Company successfully created", "type": "string" }, "success": { "example": true, "type": "boolean" } }, "type": "object" } } }, "description": "200" }, "400": { "content": { "application/json": { "examples": { "Result": { "value": "{\n \"success\": false,\n \"message\": \"The trial end date must be set\"\n}" } }, "schema": { "properties": { "message": { "example": "The trial end date must be set", "type": "string" }, "success": { "example": false, "type": "boolean" } }, "type": "object" } } }, "description": "400" }, "401": { "description": "401" }, "402": { "description": "402" }, "403": { "content": { "application/json": { "examples": { "Result": { "value": "{\n \"success\": false,\n \"message\": \"The API key has no write_clients access\"\n}" } }, "schema": { "properties": { "message": { "example": "The API key has no write_clients access", "type": "string" }, "success": { "example": false, "type": "boolean" } }, "type": "object" } } }, "description": "403" }, "409": { "content": { "application/json": { "examples": { "Result": { "value": "{\n \"success\": false,\n \"message\": \"This external id is already used by another company of this reseller\"\n}" } }, "schema": { "properties": { "message": { "example": "This external id is already used by another company of this reseller", "type": "string" }, "success": { "example": false, "type": "boolean" } }, "type": "object" } } }, "description": "409" }, "422": { "content": { "application/json": { "examples": { "Result": { "value": "{\n \"success\": false,\n \"message\": \"The license category must be one of: free, starter, ai_meeting, business\"\n}" } }, "schema": { "properties": { "message": { "example": "The license category must be one of: free, starter, ai_meeting, business", "type": "string" }, "success": { "example": false, "type": "boolean" } }, "type": "object" } } }, "description": "422" }, "429": { "description": "429" } }, "summary": "Create a client company" } }, "/reseller/companies/{uuid}": { "patch": { "description": "Update a client company attached to your reseller account. Only the attributes you send are changed. Setting `active` to `false` deactivates the company, see Deactivate a client company.", "operationId": "update-a-client-company", "parameters": [ { "description": "UUID of one of your client companies.", "in": "path", "name": "uuid", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "active": { "description": "Set to `false` to deactivate the client company. Deactivation cancels its subscription and deactivates every user. Setting it back to `true` only reopens the company record: users and subscription are not restored.", "type": "boolean" }, "company_setting": { "properties": { "license_category": { "description": "License of the client company. Omit it to keep the current license. `starter` caps the seats at 5.", "enum": [ "free", "starter", "ai_meeting", "business" ], "type": "string" }, "max_seats": { "description": "Maximum number of licensed users. Null for no limit.", "type": [ "integer", "null" ] }, "min_seats": { "description": "Minimum number of seats billed.", "type": [ "integer", "null" ] } }, "type": "object" }, "industry": { "description": "Industry of the client company.", "type": "string" }, "name": { "description": "Name of the client company. Must not contain `#` or `_`.", "type": "string" }, "reseller_external_id": { "description": "Your own reference for this client company. Must be unique among your client companies.", "type": "string" }, "setting": { "properties": { "locale": { "description": "Default locale of the client company, for example `en-US` or `fr-FR`.", "type": "string" }, "time_zone": { "description": "Time zone of the client company, for example `Europe/Paris`.", "type": "string" } }, "type": "object" }, "subscription_currency": { "description": "Billing currency, for example `eur`. Locked while a Stripe subscription is active.", "type": "string" }, "subscription_interval": { "description": "Billing interval, `month` or `year`.", "enum": [ "month", "year" ], "type": "string" }, "trial_end": { "description": "End of the Leexi trial as a Unix timestamp (seconds). A date in the past marks the trial as ended, a date in the future (re)starts it. Locked while the client has an open Stripe subscription (active, trialing, incomplete, past_due, unpaid or paused).", "type": "integer" } }, "type": "object" } } } }, "responses": { "200": { "content": { "application/json": { "examples": { "Result": { "value": "{\n \"success\": true,\n \"data\": {\n \"uuid\": \"c1f4b7a2-3d2e-4f0a-9b1c-6e7d8a9f0b12\",\n \"name\": \"Client One\",\n \"reseller_external_id\": \"CLIENT-1\",\n \"active\": true,\n \"industry\": \"consulting\",\n \"created_at\": \"2024-06-14T11:00:33.534Z\",\n \"updated_at\": \"2024-06-14T11:00:33.534Z\",\n \"subscription\": {\n \"status\": \"leexi_trialing\",\n \"active\": true,\n \"license\": \"business\",\n \"interval\": \"year\",\n \"currency\": \"eur\",\n \"trial_end\": 1767222000,\n \"seats\": {\n \"billed\": 4,\n \"min\": 2,\n \"max\": 10\n },\n \"manual_payment\": false,\n \"subscription_required\": true\n }\n },\n \"message\": \"Company successfully updated\"\n}" } }, "schema": { "properties": { "data": { "properties": { "active": { "example": true, "type": "boolean" }, "created_at": { "example": "2024-06-14T11:00:33.534Z", "type": "string" }, "industry": { "description": "Industry of the client company. Null when not set.", "example": "consulting", "type": [ "string", "null" ] }, "name": { "example": "Client One", "type": "string" }, "reseller_external_id": { "description": "Your own reference for this client company. Null when not set.", "example": "CLIENT-1", "type": [ "string", "null" ] }, "updated_at": { "example": "2024-06-14T11:00:33.534Z", "type": "string" }, "uuid": { "example": "c1f4b7a2-3d2e-4f0a-9b1c-6e7d8a9f0b12", "type": "string" }, "subscription": { "description": "Billing state of the client company. There is no separate subscription object.", "properties": { "status": { "description": "Stripe status (active, trialing, incomplete, past_due, not_started, incomplete_expired, canceled, unpaid, paused) or Leexi trial status (leexi_trialing, leexi_trial_ended).", "example": "leexi_trialing", "type": "string" }, "active": { "description": "Whether the client can currently use Leexi.", "example": true, "type": "boolean" }, "license": { "description": "free, starter, ai_meeting or business.", "example": "business", "type": [ "string", "null" ] }, "interval": { "description": "month or year.", "example": "year", "type": "string" }, "currency": { "example": "eur", "type": "string" }, "trial_end": { "description": "Unix timestamp. Null when the client is not on a trial.", "example": 1767222000, "type": [ "integer", "null" ] }, "seats": { "properties": { "billed": { "description": "Number of seats currently billed.", "example": 4, "type": "integer" }, "max": { "description": "Maximum number of paid users. Null when unlimited.", "example": 10, "type": [ "integer", "null" ] }, "min": { "description": "Minimum billed seats. Null when not enforced.", "example": 2, "type": [ "integer", "null" ] } }, "type": "object" }, "manual_payment": { "example": false, "type": "boolean" }, "subscription_required": { "example": true, "type": "boolean" } }, "type": "object" } }, "type": "object" }, "message": { "example": "Company successfully updated", "type": "string" }, "success": { "example": true, "type": "boolean" } }, "type": "object" } } }, "description": "200" }, "400": { "content": { "application/json": { "examples": { "Result": { "value": "{\n \"success\": false,\n \"message\": \"name must not contain # or _\"\n}" } }, "schema": { "properties": { "message": { "example": "name must not contain # or _", "type": "string" }, "success": { "example": false, "type": "boolean" } }, "type": "object" } } }, "description": "400" }, "401": { "description": "401" }, "402": { "description": "402" }, "403": { "content": { "application/json": { "examples": { "Result": { "value": "{\n \"success\": false,\n \"message\": \"The API key has no write_clients access\"\n}" } }, "schema": { "properties": { "message": { "example": "The API key has no write_clients access", "type": "string" }, "success": { "example": false, "type": "boolean" } }, "type": "object" } } }, "description": "403" }, "404": { "content": { "application/json": { "examples": { "Result": { "value": "{\n \"success\": false,\n \"message\": \"Company not found\"\n}" } }, "schema": { "properties": { "message": { "example": "Company not found", "type": "string" }, "success": { "example": false, "type": "boolean" } }, "type": "object" } } }, "description": "404" }, "409": { "content": { "application/json": { "examples": { "Result": { "value": "{\n \"success\": false,\n \"message\": \"This external id is already used by another company of this reseller\"\n}" } }, "schema": { "properties": { "message": { "example": "This external id is already used by another company of this reseller", "type": "string" }, "success": { "example": false, "type": "boolean" } }, "type": "object" } } }, "description": "409" }, "422": { "content": { "application/json": { "examples": { "Result": { "value": "{\n \"success\": false,\n \"message\": \"A company with an active subscription cannot be deactivated\"\n}" } }, "schema": { "properties": { "message": { "example": "A company with an active subscription cannot be deactivated", "type": "string" }, "success": { "example": false, "type": "boolean" } }, "type": "object" } } }, "description": "422" }, "429": { "description": "429" } }, "summary": "Update a client company" }, "delete": { "description": "Deactivate a client company attached to your reseller account. Its subscription is canceled, every user is deactivated and the company can no longer be used. Setting `active` back to `true` only reopens the company record: users and subscription are not restored.", "operationId": "deactivate-a-client-company", "parameters": [ { "description": "UUID of one of your client companies.", "in": "path", "name": "uuid", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "examples": { "Result": { "value": "{\n \"success\": true,\n \"data\": {\n \"uuid\": \"c1f4b7a2-3d2e-4f0a-9b1c-6e7d8a9f0b12\",\n \"name\": \"Client One\",\n \"reseller_external_id\": \"CLIENT-1\",\n \"active\": false,\n \"industry\": \"consulting\",\n \"created_at\": \"2024-06-14T11:00:33.534Z\",\n \"updated_at\": \"2024-06-14T11:00:33.534Z\",\n \"subscription\": {\n \"status\": \"leexi_trial_ended\",\n \"active\": false,\n \"license\": \"business\",\n \"interval\": \"year\",\n \"currency\": \"eur\",\n \"trial_end\": null,\n \"seats\": {\n \"billed\": 4,\n \"min\": 2,\n \"max\": 10\n },\n \"manual_payment\": false,\n \"subscription_required\": true\n }\n },\n \"message\": \"Company successfully updated\"\n}" } }, "schema": { "properties": { "data": { "properties": { "active": { "example": true, "type": "boolean" }, "created_at": { "example": "2024-06-14T11:00:33.534Z", "type": "string" }, "industry": { "description": "Industry of the client company. Null when not set.", "example": "consulting", "type": [ "string", "null" ] }, "name": { "example": "Client One", "type": "string" }, "reseller_external_id": { "description": "Your own reference for this client company. Null when not set.", "example": "CLIENT-1", "type": [ "string", "null" ] }, "updated_at": { "example": "2024-06-14T11:00:33.534Z", "type": "string" }, "uuid": { "example": "c1f4b7a2-3d2e-4f0a-9b1c-6e7d8a9f0b12", "type": "string" }, "subscription": { "description": "Billing state of the client company. There is no separate subscription object.", "properties": { "status": { "description": "Stripe status (active, trialing, incomplete, past_due, not_started, incomplete_expired, canceled, unpaid, paused) or Leexi trial status (leexi_trialing, leexi_trial_ended).", "example": "leexi_trialing", "type": "string" }, "active": { "description": "Whether the client can currently use Leexi.", "example": true, "type": "boolean" }, "license": { "description": "free, starter, ai_meeting or business.", "example": "business", "type": [ "string", "null" ] }, "interval": { "description": "month or year.", "example": "year", "type": "string" }, "currency": { "example": "eur", "type": "string" }, "trial_end": { "description": "Unix timestamp. Null when the client is not on a trial.", "example": 1767222000, "type": [ "integer", "null" ] }, "seats": { "properties": { "billed": { "description": "Number of seats currently billed.", "example": 4, "type": "integer" }, "max": { "description": "Maximum number of paid users. Null when unlimited.", "example": 10, "type": [ "integer", "null" ] }, "min": { "description": "Minimum billed seats. Null when not enforced.", "example": 2, "type": [ "integer", "null" ] } }, "type": "object" }, "manual_payment": { "example": false, "type": "boolean" }, "subscription_required": { "example": true, "type": "boolean" } }, "type": "object" } }, "type": "object" }, "message": { "example": "Company successfully updated", "type": "string" }, "success": { "example": true, "type": "boolean" } }, "type": "object" } } }, "description": "200" }, "401": { "description": "401" }, "402": { "description": "402" }, "403": { "content": { "application/json": { "examples": { "Result": { "value": "{\n \"success\": false,\n \"message\": \"The API key has no write_clients access\"\n}" } }, "schema": { "properties": { "message": { "example": "The API key has no write_clients access", "type": "string" }, "success": { "example": false, "type": "boolean" } }, "type": "object" } } }, "description": "403" }, "404": { "content": { "application/json": { "examples": { "Result": { "value": "{\n \"success\": false,\n \"message\": \"Company not found\"\n}" } }, "schema": { "properties": { "message": { "example": "Company not found", "type": "string" }, "success": { "example": false, "type": "boolean" } }, "type": "object" } } }, "description": "404" }, "422": { "content": { "application/json": { "examples": { "Result": { "value": "{\n \"success\": false,\n \"message\": \"A company with an active subscription cannot be deactivated\"\n}" } }, "schema": { "properties": { "message": { "example": "A company with an active subscription cannot be deactivated", "type": "string" }, "success": { "example": false, "type": "boolean" } }, "type": "object" } } }, "description": "422" }, "429": { "description": "429" } }, "summary": "Deactivate a client company" } }, "/reseller/companies/{company_uuid}/teams": { "get": { "description": "List the teams of a client company.", "operationId": "list-client-teams", "parameters": [ { "description": "UUID of one of your client companies.", "in": "path", "name": "company_uuid", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "page", "schema": { "default": 1, "format": "int32", "type": "integer" } }, { "description": "min: 1, max: 100", "in": "query", "name": "items", "schema": { "default": 10, "format": "int32", "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "examples": { "Result": { "value": "{\n \"data\": [\n {\n \"uuid\": \"5290728d-b3c4-4330-918d-d8f153e9500d\",\n \"name\": \"Sales Team\",\n \"active\": true,\n \"created_at\": \"2024-06-14T11:00:33.534Z\",\n \"updated_at\": \"2024-06-14T11:00:33.534Z\"\n }\n ],\n \"pagination\": {\n \"page\": 1,\n \"items\": 10,\n \"count\": 1,\n \"pages\": 1\n }\n}" } }, "schema": { "properties": { "data": { "items": { "properties": { "active": { "example": true, "type": "boolean" }, "created_at": { "example": "2024-06-14T11:00:33.534Z", "type": "string" }, "name": { "example": "Sales Team", "type": "string" }, "updated_at": { "example": "2024-06-14T11:00:33.534Z", "type": "string" }, "uuid": { "example": "5290728d-b3c4-4330-918d-d8f153e9500d", "type": "string" } }, "type": "object" }, "type": "array" }, "pagination": { "properties": { "count": { "example": 1, "type": "integer" }, "items": { "example": 10, "type": "integer" }, "page": { "example": 1, "type": "integer" }, "pages": { "example": 1, "type": "integer" } }, "type": "object" } }, "type": "object" } } }, "description": "200" }, "401": { "description": "401" }, "402": { "description": "402" }, "403": { "content": { "application/json": { "examples": { "Result": { "value": "{\n \"success\": false,\n \"message\": \"The API key has no read_clients access\"\n}" } }, "schema": { "properties": { "message": { "example": "The API key has no read_clients access", "type": "string" }, "success": { "example": false, "type": "boolean" } }, "type": "object" } } }, "description": "403" }, "404": { "content": { "application/json": { "examples": { "Result": { "value": "{\n \"success\": false,\n \"message\": \"Company not found\"\n}" } }, "schema": { "properties": { "message": { "example": "Company not found", "type": "string" }, "success": { "example": false, "type": "boolean" } }, "type": "object" } } }, "description": "404" }, "429": { "description": "429" } }, "summary": "List client teams" }, "post": { "description": "Create a team in a client company. The team inherits the client company settings and is added to the default Meddic and SPICED scorecard templates.", "operationId": "create-a-client-team", "requestBody": { "content": { "application/json": { "schema": { "properties": { "active": { "description": "Defaults to `true` on creation. A team can only be deactivated once it has no active users.", "type": "boolean" }, "name": { "description": "The team name. It must be unique within the client company.", "type": "string" } }, "required": [ "name" ], "type": "object" } } } }, "responses": { "200": { "content": { "application/json": { "examples": { "Result": { "value": "{\n \"success\": true,\n \"data\": {\n \"uuid\": \"5290728d-b3c4-4330-918d-d8f153e9500d\",\n \"name\": \"Sales Team\",\n \"active\": true,\n \"created_at\": \"2024-06-14T11:00:33.534Z\",\n \"updated_at\": \"2024-06-14T11:00:33.534Z\"\n },\n \"message\": \"Team successfully created\"\n}" } }, "schema": { "properties": { "data": { "properties": { "active": { "example": true, "type": "boolean" }, "created_at": { "example": "2024-06-14T11:00:33.534Z", "type": "string" }, "name": { "example": "Sales Team", "type": "string" }, "updated_at": { "example": "2024-06-14T11:00:33.534Z", "type": "string" }, "uuid": { "example": "5290728d-b3c4-4330-918d-d8f153e9500d", "type": "string" } }, "type": "object" }, "message": { "example": "Team successfully created", "type": "string" }, "success": { "example": true, "type": "boolean" } }, "type": "object" } } }, "description": "200" }, "400": { "content": { "application/json": { "examples": { "Result": { "value": "{\n \"success\": false,\n \"message\": \"Missing required params: name\"\n}" } }, "schema": { "properties": { "message": { "example": "Missing required params: name", "type": "string" }, "success": { "example": false, "type": "boolean" } }, "type": "object" } } }, "description": "400" }, "401": { "description": "401" }, "402": { "description": "402" }, "403": { "content": { "application/json": { "examples": { "Result": { "value": "{\n \"success\": false,\n \"message\": \"The API key has no write_clients access\"\n}" } }, "schema": { "properties": { "message": { "example": "The API key has no write_clients access", "type": "string" }, "success": { "example": false, "type": "boolean" } }, "type": "object" } } }, "description": "403" }, "404": { "content": { "application/json": { "examples": { "Result": { "value": "{\n \"success\": false,\n \"message\": \"Company not found\"\n}" } }, "schema": { "properties": { "message": { "example": "Company not found", "type": "string" }, "success": { "example": false, "type": "boolean" } }, "type": "object" } } }, "description": "404" }, "409": { "content": { "application/json": { "examples": { "Result": { "value": "{\n \"success\": false,\n \"message\": \"A team with this name already exists\"\n}" } }, "schema": { "properties": { "message": { "example": "A team with this name already exists", "type": "string" }, "success": { "example": false, "type": "boolean" } }, "type": "object" } } }, "description": "409" }, "429": { "description": "429" } }, "summary": "Create a team", "parameters": [ { "description": "UUID of one of your client companies.", "in": "path", "name": "company_uuid", "required": true, "schema": { "type": "string" } } ] } }, "/reseller/companies/{company_uuid}/teams/{uuid}": { "get": { "description": "Retrieve a single team of a client company.", "operationId": "get-a-client-team", "parameters": [ { "description": "UUID of one of your client companies.", "in": "path", "name": "company_uuid", "required": true, "schema": { "type": "string" } }, { "description": "UUID of the team.", "in": "path", "name": "uuid", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "examples": { "Result": { "value": "{\n \"success\": true,\n \"data\": {\n \"uuid\": \"5290728d-b3c4-4330-918d-d8f153e9500d\",\n \"name\": \"Sales Team\",\n \"active\": true,\n \"created_at\": \"2024-06-14T11:00:33.534Z\",\n \"updated_at\": \"2024-06-14T11:00:33.534Z\"\n },\n \"message\": \"Teams successfully retrieved\"\n}" } }, "schema": { "properties": { "data": { "properties": { "active": { "example": true, "type": "boolean" }, "created_at": { "example": "2024-06-14T11:00:33.534Z", "type": "string" }, "name": { "example": "Sales Team", "type": "string" }, "updated_at": { "example": "2024-06-14T11:00:33.534Z", "type": "string" }, "uuid": { "example": "5290728d-b3c4-4330-918d-d8f153e9500d", "type": "string" } }, "type": "object" }, "message": { "example": "Teams successfully retrieved", "type": "string" }, "success": { "example": true, "type": "boolean" } }, "type": "object" } } }, "description": "200" }, "401": { "description": "401" }, "402": { "description": "402" }, "403": { "content": { "application/json": { "examples": { "Result": { "value": "{\n \"success\": false,\n \"message\": \"The API key has no read_clients access\"\n}" } }, "schema": { "properties": { "message": { "example": "The API key has no read_clients access", "type": "string" }, "success": { "example": false, "type": "boolean" } }, "type": "object" } } }, "description": "403" }, "404": { "content": { "application/json": { "examples": { "Result": { "value": "{\n \"success\": false,\n \"message\": \"Team not found\"\n}" } }, "schema": { "properties": { "message": { "example": "Team not found", "type": "string" }, "success": { "example": false, "type": "boolean" } }, "type": "object" } } }, "description": "404" }, "429": { "description": "429" } }, "summary": "Get a client team" }, "patch": { "description": "Update a team of a client company. Only the attributes present in the body are updated.", "operationId": "update-a-client-team", "parameters": [ { "description": "UUID of one of your client companies.", "in": "path", "name": "company_uuid", "required": true, "schema": { "type": "string" } }, { "description": "UUID of the team.", "in": "path", "name": "uuid", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "active": { "description": "Defaults to `true` on creation. A team can only be deactivated once it has no active users.", "type": "boolean" }, "name": { "description": "The team name. It must be unique within the client company.", "type": "string" } }, "type": "object" } } } }, "responses": { "200": { "content": { "application/json": { "examples": { "Result": { "value": "{\n \"success\": true,\n \"data\": {\n \"uuid\": \"5290728d-b3c4-4330-918d-d8f153e9500d\",\n \"name\": \"Sales Team\",\n \"active\": true,\n \"created_at\": \"2024-06-14T11:00:33.534Z\",\n \"updated_at\": \"2024-06-14T11:00:33.534Z\"\n },\n \"message\": \"Team successfully updated\"\n}" } }, "schema": { "properties": { "data": { "properties": { "active": { "example": true, "type": "boolean" }, "created_at": { "example": "2024-06-14T11:00:33.534Z", "type": "string" }, "name": { "example": "Sales Team", "type": "string" }, "updated_at": { "example": "2024-06-14T11:00:33.534Z", "type": "string" }, "uuid": { "example": "5290728d-b3c4-4330-918d-d8f153e9500d", "type": "string" } }, "type": "object" }, "message": { "example": "Team successfully updated", "type": "string" }, "success": { "example": true, "type": "boolean" } }, "type": "object" } } }, "description": "200" }, "401": { "description": "401" }, "402": { "description": "402" }, "403": { "content": { "application/json": { "examples": { "Result": { "value": "{\n \"success\": false,\n \"message\": \"The API key has no write_clients access\"\n}" } }, "schema": { "properties": { "message": { "example": "The API key has no write_clients access", "type": "string" }, "success": { "example": false, "type": "boolean" } }, "type": "object" } } }, "description": "403" }, "404": { "content": { "application/json": { "examples": { "Result": { "value": "{\n \"success\": false,\n \"message\": \"Team not found\"\n}" } }, "schema": { "properties": { "message": { "example": "Team not found", "type": "string" }, "success": { "example": false, "type": "boolean" } }, "type": "object" } } }, "description": "404" }, "409": { "content": { "application/json": { "examples": { "Result": { "value": "{\n \"success\": false,\n \"message\": \"A team with this name already exists\"\n}" } }, "schema": { "properties": { "message": { "example": "A team with this name already exists", "type": "string" }, "success": { "example": false, "type": "boolean" } }, "type": "object" } } }, "description": "409" }, "422": { "content": { "application/json": { "examples": { "Result": { "value": "{\n \"success\": false,\n \"message\": \"Team still has active users\"\n}" } }, "schema": { "properties": { "message": { "example": "Team still has active users", "type": "string" }, "success": { "example": false, "type": "boolean" } }, "type": "object" } } }, "description": "422" }, "429": { "description": "429" } }, "summary": "Update a team" }, "delete": { "description": "Delete a team of a client company. Only a team with no users and no calls can be deleted; deactivate it instead with a `PATCH` setting `active` to `false`.", "operationId": "delete-a-client-team", "parameters": [ { "description": "UUID of one of your client companies.", "in": "path", "name": "company_uuid", "required": true, "schema": { "type": "string" } }, { "description": "UUID of the team.", "in": "path", "name": "uuid", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "examples": { "Result": { "value": "{\n \"success\": true,\n \"data\": {},\n \"message\": \"Team successfully deleted\"\n}" } }, "schema": { "properties": { "data": { "properties": {}, "type": "object" }, "message": { "example": "Team successfully deleted", "type": "string" }, "success": { "example": true, "type": "boolean" } }, "type": "object" } } }, "description": "200" }, "401": { "description": "401" }, "402": { "description": "402" }, "403": { "content": { "application/json": { "examples": { "Result": { "value": "{\n \"success\": false,\n \"message\": \"The API key has no write_clients access\"\n}" } }, "schema": { "properties": { "message": { "example": "The API key has no write_clients access", "type": "string" }, "success": { "example": false, "type": "boolean" } }, "type": "object" } } }, "description": "403" }, "404": { "content": { "application/json": { "examples": { "Result": { "value": "{\n \"success\": false,\n \"message\": \"Team not found\"\n}" } }, "schema": { "properties": { "message": { "example": "Team not found", "type": "string" }, "success": { "example": false, "type": "boolean" } }, "type": "object" } } }, "description": "404" }, "422": { "content": { "application/json": { "examples": { "Result": { "value": "{\n \"success\": false,\n \"message\": \"This team still has users or calls and cannot be deleted\"\n}" } }, "schema": { "properties": { "message": { "example": "This team still has users or calls and cannot be deleted", "type": "string" }, "success": { "example": false, "type": "boolean" } }, "type": "object" } } }, "description": "422" }, "429": { "description": "429" } }, "summary": "Delete a team" } }, "/reseller/companies/{company_uuid}/users": { "get": { "description": "List the users of a client company.", "operationId": "list-client-users", "parameters": [ { "description": "UUID of one of your client companies.", "in": "path", "name": "company_uuid", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "page", "schema": { "default": 1, "format": "int32", "type": "integer" } }, { "description": "min: 1, max: 100", "in": "query", "name": "items", "schema": { "default": 10, "format": "int32", "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "examples": { "Result": { "value": "{\n \"data\": [\n {\n \"uuid\": \"befb9860-8661-442a-9496-8743de9e17cd\",\n \"name\": \"John Smith\",\n \"email\": \"john.smith@client-one.com\",\n \"active\": true,\n \"license\": \"business\",\n \"roles\": [\n \"member\"\n ],\n \"team\": {\n \"uuid\": \"5290728d-b3c4-4330-918d-d8f153e9500d\",\n \"name\": \"Sales Team\",\n \"active\": true\n },\n \"created_at\": \"2024-06-14T11:00:33.534Z\",\n \"updated_at\": \"2024-06-14T11:00:33.534Z\"\n }\n ],\n \"pagination\": {\n \"page\": 1,\n \"items\": 10,\n \"count\": 1,\n \"pages\": 1\n }\n}" } }, "schema": { "properties": { "data": { "items": { "properties": { "active": { "example": true, "type": "boolean" }, "created_at": { "example": "2024-06-14T11:00:33.534Z", "type": "string" }, "email": { "example": "john.smith@client-one.com", "type": "string" }, "license": { "example": "business", "type": "string" }, "name": { "example": "John Smith", "type": "string" }, "roles": { "items": { "example": "member", "type": "string" }, "type": "array" }, "team": { "properties": { "active": { "example": true, "type": "boolean" }, "name": { "example": "Sales Team", "type": "string" }, "uuid": { "example": "5290728d-b3c4-4330-918d-d8f153e9500d", "type": "string" } }, "type": "object" }, "updated_at": { "example": "2024-06-14T11:00:33.534Z", "type": "string" }, "uuid": { "example": "befb9860-8661-442a-9496-8743de9e17cd", "type": "string" } }, "type": "object" }, "type": "array" }, "pagination": { "properties": { "count": { "example": 1, "type": "integer" }, "items": { "example": 10, "type": "integer" }, "page": { "example": 1, "type": "integer" }, "pages": { "example": 1, "type": "integer" } }, "type": "object" } }, "type": "object" } } }, "description": "200" }, "401": { "description": "401" }, "402": { "description": "402" }, "403": { "content": { "application/json": { "examples": { "Result": { "value": "{\n \"success\": false,\n \"message\": \"The API key has no read_clients access\"\n}" } }, "schema": { "properties": { "message": { "example": "The API key has no read_clients access", "type": "string" }, "success": { "example": false, "type": "boolean" } }, "type": "object" } } }, "description": "403" }, "404": { "content": { "application/json": { "examples": { "Result": { "value": "{\n \"success\": false,\n \"message\": \"Company not found\"\n}" } }, "schema": { "properties": { "message": { "example": "Company not found", "type": "string" }, "success": { "example": false, "type": "boolean" } }, "type": "object" } } }, "description": "404" }, "429": { "description": "429" } }, "summary": "List client users" }, "post": { "description": "Create a user in a client company. When the client company has no active super admin, the new user becomes its super admin. The user receives a welcome email with a link to set their password, unless `send_welcome_email` is `false`.", "operationId": "create-a-client-user", "requestBody": { "content": { "application/json": { "schema": { "properties": { "active": { "description": "Defaults to `true` on creation. Set to `false` to deactivate the user.", "type": "boolean" }, "email": { "description": "The user's email address. It must be deliverable and not already used in any Leexi company.", "type": "string" }, "license": { "description": "Either `free` or the client company's own license category. Any other value is ignored.", "type": "string" }, "name": { "description": "The user's full name.", "type": "string" }, "roles": { "description": "Role names. Defaults to `[\"member\"]` on creation. Unlike the regular endpoints, a reseller key may assign every role, `super_admin` and `system_admin` included, and advanced roles do not require the Governance add-on of the client company.", "items": { "type": "string" }, "type": "array" }, "send_welcome_email": { "description": "Defaults to `true`. Set to `false` to create the user without sending them the welcome email.", "type": "boolean" }, "team_uuid": { "description": "The uuid of the team the user belongs to.", "type": "string" } }, "required": [ "name", "email", "team_uuid" ], "type": "object" } } } }, "responses": { "200": { "content": { "application/json": { "examples": { "Result": { "value": "{\n \"success\": true,\n \"data\": {\n \"uuid\": \"befb9860-8661-442a-9496-8743de9e17cd\",\n \"name\": \"John Smith\",\n \"email\": \"john.smith@acme.com\",\n \"active\": true,\n \"license\": \"business\",\n \"roles\": [\n \"member\"\n ],\n \"team\": {\n \"uuid\": \"5290728d-b3c4-4330-918d-d8f153e9500d\",\n \"name\": \"Sales Team\",\n \"active\": true\n },\n \"created_at\": \"2024-06-14T11:00:33.534Z\",\n \"updated_at\": \"2024-06-14T11:00:33.534Z\"\n },\n \"message\": \"User successfully created\"\n}" } }, "schema": { "properties": { "data": { "properties": { "active": { "example": true, "type": "boolean" }, "created_at": { "example": "2024-06-14T11:00:33.534Z", "type": "string" }, "email": { "example": "john.smith@acme.com", "type": "string" }, "license": { "example": "business", "type": "string" }, "name": { "example": "John Smith", "type": "string" }, "roles": { "items": { "example": "member", "type": "string" }, "type": "array" }, "team": { "properties": { "active": { "example": true, "type": "boolean" }, "name": { "example": "Sales Team", "type": "string" }, "uuid": { "example": "5290728d-b3c4-4330-918d-d8f153e9500d", "type": "string" } }, "type": "object" }, "updated_at": { "example": "2024-06-14T11:00:33.534Z", "type": "string" }, "uuid": { "example": "befb9860-8661-442a-9496-8743de9e17cd", "type": "string" } }, "type": "object" }, "message": { "example": "User successfully created", "type": "string" }, "success": { "example": true, "type": "boolean" } }, "type": "object" } } }, "description": "200" }, "400": { "content": { "application/json": { "examples": { "Result": { "value": "{\n \"success\": false,\n \"message\": \"Missing required params: team_uuid\"\n}" } }, "schema": { "properties": { "message": { "example": "Missing required params: team_uuid", "type": "string" }, "success": { "example": false, "type": "boolean" } }, "type": "object" } } }, "description": "400" }, "401": { "description": "401" }, "402": { "description": "402" }, "403": { "content": { "application/json": { "examples": { "Result": { "value": "{\n \"success\": false,\n \"message\": \"The API key has no write_clients access\"\n}" } }, "schema": { "properties": { "message": { "example": "The API key has no write_clients access", "type": "string" }, "success": { "example": false, "type": "boolean" } }, "type": "object" } } }, "description": "403" }, "404": { "content": { "application/json": { "examples": { "Result": { "value": "{\n \"success\": false,\n \"message\": \"Team not found\"\n}" } }, "schema": { "properties": { "message": { "example": "Team not found", "type": "string" }, "success": { "example": false, "type": "boolean" } }, "type": "object" } } }, "description": "404" }, "409": { "content": { "application/json": { "examples": { "Result": { "value": "{\n \"success\": false,\n \"message\": \"A user with this email already exists\"\n}" } }, "schema": { "properties": { "message": { "example": "A user with this email already exists", "type": "string" }, "success": { "example": false, "type": "boolean" } }, "type": "object" } } }, "description": "409" }, "429": { "description": "429" } }, "summary": "Create a user", "parameters": [ { "description": "UUID of one of your client companies.", "in": "path", "name": "company_uuid", "required": true, "schema": { "type": "string" } } ] } }, "/reseller/companies/{company_uuid}/users/{uuid}": { "get": { "description": "Retrieve a single user of a client company.", "operationId": "get-a-client-user", "parameters": [ { "description": "UUID of one of your client companies.", "in": "path", "name": "company_uuid", "required": true, "schema": { "type": "string" } }, { "description": "UUID of the user.", "in": "path", "name": "uuid", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "examples": { "Result": { "value": "{\n \"success\": true,\n \"data\": {\n \"uuid\": \"befb9860-8661-442a-9496-8743de9e17cd\",\n \"name\": \"John Smith\",\n \"email\": \"john.smith@client-one.com\",\n \"active\": true,\n \"license\": \"business\",\n \"roles\": [\n \"member\"\n ],\n \"team\": {\n \"uuid\": \"5290728d-b3c4-4330-918d-d8f153e9500d\",\n \"name\": \"Sales Team\",\n \"active\": true\n },\n \"created_at\": \"2024-06-14T11:00:33.534Z\",\n \"updated_at\": \"2024-06-14T11:00:33.534Z\"\n },\n \"message\": \"User successfully retrieved\"\n}" } }, "schema": { "properties": { "data": { "properties": { "active": { "example": true, "type": "boolean" }, "created_at": { "example": "2024-06-14T11:00:33.534Z", "type": "string" }, "email": { "example": "john.smith@client-one.com", "type": "string" }, "license": { "example": "business", "type": "string" }, "name": { "example": "John Smith", "type": "string" }, "roles": { "items": { "example": "member", "type": "string" }, "type": "array" }, "team": { "properties": { "active": { "example": true, "type": "boolean" }, "name": { "example": "Sales Team", "type": "string" }, "uuid": { "example": "5290728d-b3c4-4330-918d-d8f153e9500d", "type": "string" } }, "type": "object" }, "updated_at": { "example": "2024-06-14T11:00:33.534Z", "type": "string" }, "uuid": { "example": "befb9860-8661-442a-9496-8743de9e17cd", "type": "string" } }, "type": "object" }, "message": { "example": "User successfully retrieved", "type": "string" }, "success": { "example": true, "type": "boolean" } }, "type": "object" } } }, "description": "200" }, "401": { "description": "401" }, "402": { "description": "402" }, "403": { "content": { "application/json": { "examples": { "Result": { "value": "{\n \"success\": false,\n \"message\": \"The API key has no read_clients access\"\n}" } }, "schema": { "properties": { "message": { "example": "The API key has no read_clients access", "type": "string" }, "success": { "example": false, "type": "boolean" } }, "type": "object" } } }, "description": "403" }, "404": { "content": { "application/json": { "examples": { "Result": { "value": "{\n \"success\": false,\n \"message\": \"User not found\"\n}" } }, "schema": { "properties": { "message": { "example": "User not found", "type": "string" }, "success": { "example": false, "type": "boolean" } }, "type": "object" } } }, "description": "404" }, "429": { "description": "429" } }, "summary": "Get a client user" }, "patch": { "description": "Update a user of a client company. Only the attributes present in the body are updated. Unlike the regular endpoint, the email of a super admin or of a user whose company enforces SSO can be changed.", "operationId": "update-a-client-user", "parameters": [ { "description": "UUID of one of your client companies.", "in": "path", "name": "company_uuid", "required": true, "schema": { "type": "string" } }, { "description": "UUID of the user.", "in": "path", "name": "uuid", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "active": { "description": "Defaults to `true` on creation. Set to `false` to deactivate the user.", "type": "boolean" }, "email": { "description": "The user's email address. It must be deliverable and not already used in any Leexi company.", "type": "string" }, "license": { "description": "Either `free` or the client company's own license category. Any other value is ignored.", "type": "string" }, "name": { "description": "The user's full name.", "type": "string" }, "roles": { "description": "Role names. Defaults to `[\"member\"]` on creation. Unlike the regular endpoints, a reseller key may assign every role, `super_admin` and `system_admin` included, and advanced roles do not require the Governance add-on of the client company.", "items": { "type": "string" }, "type": "array" }, "team_uuid": { "description": "The uuid of the team the user belongs to.", "type": "string" } }, "type": "object" } } } }, "responses": { "200": { "content": { "application/json": { "examples": { "Result": { "value": "{\n \"success\": true,\n \"data\": {\n \"uuid\": \"befb9860-8661-442a-9496-8743de9e17cd\",\n \"name\": \"John Smith\",\n \"email\": \"john.smith@acme.com\",\n \"active\": true,\n \"license\": \"business\",\n \"roles\": [\n \"member\"\n ],\n \"team\": {\n \"uuid\": \"5290728d-b3c4-4330-918d-d8f153e9500d\",\n \"name\": \"Sales Team\",\n \"active\": true\n },\n \"created_at\": \"2024-06-14T11:00:33.534Z\",\n \"updated_at\": \"2024-06-14T11:00:33.534Z\"\n },\n \"message\": \"User successfully updated\"\n}" } }, "schema": { "properties": { "data": { "properties": { "active": { "example": true, "type": "boolean" }, "created_at": { "example": "2024-06-14T11:00:33.534Z", "type": "string" }, "email": { "example": "john.smith@acme.com", "type": "string" }, "license": { "example": "business", "type": "string" }, "name": { "example": "John Smith", "type": "string" }, "roles": { "items": { "example": "member", "type": "string" }, "type": "array" }, "team": { "properties": { "active": { "example": true, "type": "boolean" }, "name": { "example": "Sales Team", "type": "string" }, "uuid": { "example": "5290728d-b3c4-4330-918d-d8f153e9500d", "type": "string" } }, "type": "object" }, "updated_at": { "example": "2024-06-14T11:00:33.534Z", "type": "string" }, "uuid": { "example": "befb9860-8661-442a-9496-8743de9e17cd", "type": "string" } }, "type": "object" }, "message": { "example": "User successfully updated", "type": "string" }, "success": { "example": true, "type": "boolean" } }, "type": "object" } } }, "description": "200" }, "400": { "content": { "application/json": { "examples": { "Result": { "value": "{\n \"success\": false,\n \"message\": \"Unknown roles: wizard\"\n}" } }, "schema": { "properties": { "message": { "example": "Unknown roles: wizard", "type": "string" }, "success": { "example": false, "type": "boolean" } }, "type": "object" } } }, "description": "400" }, "401": { "description": "401" }, "402": { "description": "402" }, "403": { "content": { "application/json": { "examples": { "Result": { "value": "{\n \"success\": false,\n \"message\": \"You cannot remove the last super admin\"\n}" } }, "schema": { "properties": { "message": { "example": "You cannot remove the last super admin", "type": "string" }, "success": { "example": false, "type": "boolean" } }, "type": "object" } } }, "description": "403" }, "404": { "content": { "application/json": { "examples": { "Result": { "value": "{\n \"success\": false,\n \"message\": \"User not found\"\n}" } }, "schema": { "properties": { "message": { "example": "User not found", "type": "string" }, "success": { "example": false, "type": "boolean" } }, "type": "object" } } }, "description": "404" }, "422": { "content": { "application/json": { "examples": { "Result": { "value": "{\n \"success\": false,\n \"message\": \"You cannot change a user's email when SSO is enforced for your company\"\n}" } }, "schema": { "properties": { "message": { "example": "You cannot change a user's email when SSO is enforced for your company", "type": "string" }, "success": { "example": false, "type": "boolean" } }, "type": "object" } } }, "description": "422" }, "429": { "description": "429" } }, "summary": "Update a user" }, "delete": { "description": "Deactivate a user of a client company. Users are never permanently deleted: their calls and history are kept, their sessions are revoked and they stop consuming a license. Reactivate them with a `PATCH` setting `active` to `true`.", "operationId": "deactivate-a-client-user", "parameters": [ { "description": "UUID of one of your client companies.", "in": "path", "name": "company_uuid", "required": true, "schema": { "type": "string" } }, { "description": "UUID of the user.", "in": "path", "name": "uuid", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "examples": { "Result": { "value": "{\n \"success\": true,\n \"data\": {},\n \"message\": \"User successfully deactivated\"\n}" } }, "schema": { "properties": { "data": { "properties": {}, "type": "object" }, "message": { "example": "User successfully deactivated", "type": "string" }, "success": { "example": true, "type": "boolean" } }, "type": "object" } } }, "description": "200" }, "401": { "description": "401" }, "402": { "description": "402" }, "403": { "content": { "application/json": { "examples": { "Result": { "value": "{\n \"success\": false,\n \"message\": \"You must keep one active user with a paying license.\"\n}" } }, "schema": { "properties": { "message": { "example": "You must keep one active user with a paying license.", "type": "string" }, "success": { "example": false, "type": "boolean" } }, "type": "object" } } }, "description": "403" }, "404": { "content": { "application/json": { "examples": { "Result": { "value": "{\n \"success\": false,\n \"message\": \"User not found\"\n}" } }, "schema": { "properties": { "message": { "example": "User not found", "type": "string" }, "success": { "example": false, "type": "boolean" } }, "type": "object" } } }, "description": "404" }, "429": { "description": "429" } }, "summary": "Deactivate a user" } }, "/reseller/companies/{company_uuid}/subscription": { "post": { "description": "End the Leexi trial of a client company and start its paid Stripe subscription, with the plan, interval, currency and seats currently set on the company. Only available when you bill your clients yourself (independent reseller); otherwise billing goes through Leexi and the endpoint answers `422`. A client whose Stripe subscription is still open (active, trialing, incomplete, past_due, unpaid or paused) answers `409`: cancel it first. The request body is ignored.", "operationId": "start-a-client-subscription", "parameters": [ { "description": "UUID of one of your client companies.", "in": "path", "name": "company_uuid", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "examples": { "Result": { "value": "{\n \"success\": true,\n \"data\": {\n \"uuid\": \"c1f4b7a2-3d2e-4f0a-9b1c-6e7d8a9f0b12\",\n \"name\": \"Client One\",\n \"reseller_external_id\": \"CLIENT-1\",\n \"active\": true,\n \"industry\": \"consulting\",\n \"created_at\": \"2024-06-14T11:00:33.534Z\",\n \"updated_at\": \"2024-06-14T11:00:33.534Z\",\n \"subscription\": {\n \"status\": \"active\",\n \"active\": true,\n \"license\": \"business\",\n \"interval\": \"year\",\n \"currency\": \"eur\",\n \"trial_end\": null,\n \"seats\": {\n \"billed\": 4,\n \"min\": 2,\n \"max\": 10\n },\n \"manual_payment\": false,\n \"subscription_required\": true\n }\n },\n \"message\": \"Subscription successfully started\"\n}" } }, "schema": { "properties": { "data": { "properties": { "active": { "example": true, "type": "boolean" }, "created_at": { "example": "2024-06-14T11:00:33.534Z", "type": "string" }, "industry": { "description": "Industry of the client company. Null when not set.", "example": "consulting", "type": [ "string", "null" ] }, "name": { "example": "Client One", "type": "string" }, "reseller_external_id": { "description": "Your own reference for this client company. Null when not set.", "example": "CLIENT-1", "type": [ "string", "null" ] }, "updated_at": { "example": "2024-06-14T11:00:33.534Z", "type": "string" }, "uuid": { "example": "c1f4b7a2-3d2e-4f0a-9b1c-6e7d8a9f0b12", "type": "string" }, "subscription": { "description": "Billing state of the client company. There is no separate subscription object.", "properties": { "status": { "description": "Stripe status (active, trialing, incomplete, past_due, not_started, incomplete_expired, canceled, unpaid, paused) or Leexi trial status (leexi_trialing, leexi_trial_ended).", "example": "leexi_trialing", "type": "string" }, "active": { "description": "Whether the client can currently use Leexi.", "example": true, "type": "boolean" }, "license": { "description": "free, starter, ai_meeting or business.", "example": "business", "type": [ "string", "null" ] }, "interval": { "description": "month or year.", "example": "year", "type": "string" }, "currency": { "example": "eur", "type": "string" }, "trial_end": { "description": "Unix timestamp. Null when the client is not on a trial.", "example": 1767222000, "type": [ "integer", "null" ] }, "seats": { "properties": { "billed": { "description": "Number of seats currently billed.", "example": 4, "type": "integer" }, "max": { "description": "Maximum number of paid users. Null when unlimited.", "example": 10, "type": [ "integer", "null" ] }, "min": { "description": "Minimum billed seats. Null when not enforced.", "example": 2, "type": [ "integer", "null" ] } }, "type": "object" }, "manual_payment": { "example": false, "type": "boolean" }, "subscription_required": { "example": true, "type": "boolean" } }, "type": "object" } }, "type": "object" }, "message": { "example": "Company successfully updated", "type": "string" }, "success": { "example": true, "type": "boolean" } }, "type": "object" } } }, "description": "200" }, "401": { "description": "401" }, "402": { "description": "402" }, "403": { "content": { "application/json": { "examples": { "Result": { "value": "{\n \"success\": false,\n \"message\": \"The API key has no write_clients access\"\n}" } }, "schema": { "properties": { "message": { "example": "The API key has no write_clients access", "type": "string" }, "success": { "example": false, "type": "boolean" } }, "type": "object" } } }, "description": "403" }, "404": { "content": { "application/json": { "examples": { "Result": { "value": "{\n \"success\": false,\n \"message\": \"Company not found\"\n}" } }, "schema": { "properties": { "message": { "example": "Company not found", "type": "string" }, "success": { "example": false, "type": "boolean" } }, "type": "object" } } }, "description": "404" }, "409": { "content": { "application/json": { "examples": { "Result": { "value": "{\n \"success\": false,\n \"message\": \"This client already has a Stripe subscription: cancel it before starting a new one\"\n}" } }, "schema": { "properties": { "message": { "example": "This client already has a Stripe subscription: cancel it before starting a new one", "type": "string" }, "success": { "example": false, "type": "boolean" } }, "type": "object" } } }, "description": "409" }, "422": { "content": { "application/json": { "examples": { "Result": { "value": "{\n \"success\": false,\n \"message\": \"Billing for this client goes through Leexi on your reseller contract: its subscription cannot be started or canceled through the API\"\n}" } }, "schema": { "properties": { "message": { "example": "Billing for this client goes through Leexi on your reseller contract: its subscription cannot be started or canceled through the API", "type": "string" }, "success": { "example": false, "type": "boolean" } }, "type": "object" } } }, "description": "422" }, "429": { "description": "429" } }, "summary": "Start a client subscription" }, "delete": { "description": "Cancel the subscription of a client company. A client on a Leexi trial has its trial ended immediately; an open Stripe subscription (active, trialing, incomplete, past_due, unpaid or paused) is canceled with proration when you bill your clients yourself (independent reseller), and answers `422` when billing goes through Leexi. A client with nothing to cancel is left untouched and answers `200` with the message `No subscription to cancel`. The request body is ignored.", "operationId": "cancel-a-client-subscription", "parameters": [ { "description": "UUID of one of your client companies.", "in": "path", "name": "company_uuid", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "examples": { "Result": { "value": "{\n \"success\": true,\n \"data\": {\n \"uuid\": \"c1f4b7a2-3d2e-4f0a-9b1c-6e7d8a9f0b12\",\n \"name\": \"Client One\",\n \"reseller_external_id\": \"CLIENT-1\",\n \"active\": true,\n \"industry\": \"consulting\",\n \"created_at\": \"2024-06-14T11:00:33.534Z\",\n \"updated_at\": \"2024-06-14T11:00:33.534Z\",\n \"subscription\": {\n \"status\": \"leexi_trial_ended\",\n \"active\": false,\n \"license\": \"business\",\n \"interval\": \"year\",\n \"currency\": \"eur\",\n \"trial_end\": 1767222000,\n \"seats\": {\n \"billed\": 4,\n \"min\": 2,\n \"max\": 10\n },\n \"manual_payment\": false,\n \"subscription_required\": true\n }\n },\n \"message\": \"Subscription successfully canceled\"\n}" } }, "schema": { "properties": { "data": { "properties": { "active": { "example": true, "type": "boolean" }, "created_at": { "example": "2024-06-14T11:00:33.534Z", "type": "string" }, "industry": { "description": "Industry of the client company. Null when not set.", "example": "consulting", "type": [ "string", "null" ] }, "name": { "example": "Client One", "type": "string" }, "reseller_external_id": { "description": "Your own reference for this client company. Null when not set.", "example": "CLIENT-1", "type": [ "string", "null" ] }, "updated_at": { "example": "2024-06-14T11:00:33.534Z", "type": "string" }, "uuid": { "example": "c1f4b7a2-3d2e-4f0a-9b1c-6e7d8a9f0b12", "type": "string" }, "subscription": { "description": "Billing state of the client company. There is no separate subscription object.", "properties": { "status": { "description": "Stripe status (active, trialing, incomplete, past_due, not_started, incomplete_expired, canceled, unpaid, paused) or Leexi trial status (leexi_trialing, leexi_trial_ended).", "example": "leexi_trialing", "type": "string" }, "active": { "description": "Whether the client can currently use Leexi.", "example": true, "type": "boolean" }, "license": { "description": "free, starter, ai_meeting or business.", "example": "business", "type": [ "string", "null" ] }, "interval": { "description": "month or year.", "example": "year", "type": "string" }, "currency": { "example": "eur", "type": "string" }, "trial_end": { "description": "Unix timestamp. Null when the client is not on a trial.", "example": 1767222000, "type": [ "integer", "null" ] }, "seats": { "properties": { "billed": { "description": "Number of seats currently billed.", "example": 4, "type": "integer" }, "max": { "description": "Maximum number of paid users. Null when unlimited.", "example": 10, "type": [ "integer", "null" ] }, "min": { "description": "Minimum billed seats. Null when not enforced.", "example": 2, "type": [ "integer", "null" ] } }, "type": "object" }, "manual_payment": { "example": false, "type": "boolean" }, "subscription_required": { "example": true, "type": "boolean" } }, "type": "object" } }, "type": "object" }, "message": { "example": "Company successfully updated", "type": "string" }, "success": { "example": true, "type": "boolean" } }, "type": "object" } } }, "description": "200" }, "401": { "description": "401" }, "402": { "description": "402" }, "403": { "content": { "application/json": { "examples": { "Result": { "value": "{\n \"success\": false,\n \"message\": \"The API key has no write_clients access\"\n}" } }, "schema": { "properties": { "message": { "example": "The API key has no write_clients access", "type": "string" }, "success": { "example": false, "type": "boolean" } }, "type": "object" } } }, "description": "403" }, "404": { "content": { "application/json": { "examples": { "Result": { "value": "{\n \"success\": false,\n \"message\": \"Company not found\"\n}" } }, "schema": { "properties": { "message": { "example": "Company not found", "type": "string" }, "success": { "example": false, "type": "boolean" } }, "type": "object" } } }, "description": "404" }, "422": { "content": { "application/json": { "examples": { "Result": { "value": "{\n \"success\": false,\n \"message\": \"Billing for this client goes through Leexi on your reseller contract: its subscription cannot be started or canceled through the API\"\n}" } }, "schema": { "properties": { "message": { "example": "Billing for this client goes through Leexi on your reseller contract: its subscription cannot be started or canceled through the API", "type": "string" }, "success": { "example": false, "type": "boolean" } }, "type": "object" } } }, "description": "422" }, "429": { "description": "429" } }, "summary": "Cancel a client subscription" } } }, "security": [ { "sec0": [] } ], "servers": [ { "url": "https://public-api.leexi.ai/v1" } ], "x-readme": { "explorer-enabled": true, "headers": [], "proxy-enabled": true }, "x-readme-fauxas": true }