{"openapi":"3.1.0","info":{"title":"Bitrix24 (BYOK) API","version":"0.1.0","description":"Bitrix24 (BYOK) lets an AI assistant read your own Bitrix24 data through the Bitrix24 API with a key you supply (Bitrix24 incoming webhook code (the long code after your user number in the webhook URL)). Read-only: 8 tools (get_current_user, list_users, list_deals, list_leads, list_contacts, list_companies, list_statuses, list_tasks). The BYOK key travels with each request, is used for that one...\n\nEvery operation is read-only or compute-only. The same tools are available over MCP (streamable HTTP) at https://byok-bitrix24.connectorbay.com/mcp.","contact":{"name":"Unify Dynamics LLC","email":"agent@connectorbay.com","url":"https://connectorbay.com/byok-bitrix24/docs"},"termsOfService":"https://connectorbay.com/byok-bitrix24/terms"},"servers":[{"url":"https://byok-bitrix24.connectorbay.com"}],"externalDocs":{"url":"https://connectorbay.com/byok-bitrix24/docs"},"security":[{"upstreamKey":[]}],"components":{"securitySchemes":{"bearer":{"type":"http","scheme":"bearer","description":"Optional. A Pro API key raises rate limits; no credentials are required."},"upstreamKey":{"type":"apiKey","in":"header","name":"X-Upstream-Key","description":"Your own key for the service this connector wraps (bring your own key). Used for that one call only; never stored, logged or cached."}},"schemas":{"Error":{"type":"object","properties":{"ok":{"const":false},"error":{"type":"object"}}}}},"paths":{"/v1/tools/get_current_user":{"post":{"operationId":"get_current_user","summary":"Show the Bitrix24 user the webhook acts as: id, name, email, position, department and last activity. Use for \"Which Bitr","description":"Show the Bitrix24 user the webhook acts as: id, name, email, position, department and last activity. Use for \"Which Bitrix24 user does my webhook belong to\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"portal":{"description":"Your Bitrix24 account name: the part before .bitrix24.com in your address (a single word, for example 'mycompany').","maxLength":63,"pattern":"^[a-z0-9]([a-z0-9-]{0,61}[a-z0-9])?$","title":"Portal","type":"string"}},"required":["portal"],"title":"get_current_userArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/list_users":{"post":{"operationId":"list_users","summary":"List Bitrix24 users (employees) with name, email, position and department; filter by active status or a name search. 50 ","description":"List Bitrix24 users (employees) with name, email, position and department; filter by active status or a name search. 50 per page. Use for \"Who works at my Bitrix24 account\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"portal":{"description":"Your Bitrix24 account name: the part before .bitrix24.com in your address (a single word, for example 'mycompany').","maxLength":63,"pattern":"^[a-z0-9]([a-z0-9-]{0,61}[a-z0-9])?$","title":"Portal","type":"string"},"active":{"anyOf":[{"type":"boolean"},{"type":"null"}],"default":null,"description":"True lists only active users, false only dismissed ones; leave empty for both.","title":"Active"},"name_search":{"anyOf":[{"maxLength":100,"type":"string"},{"type":"null"}],"default":null,"description":"Quick search by name or other personal data.","title":"Name Search"},"start":{"anyOf":[{"maximum":1000000,"minimum":0,"type":"integer"},{"type":"null"}],"default":0,"description":"Pagination offset: 0 for the first page, then 50, 100 and so on (pages hold 50 records).","title":"Start"}},"required":["portal"],"title":"list_usersArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/list_deals":{"post":{"operationId":"list_deals","summary":"List CRM deals with title, pipeline, stage, amount, owner and creation date; filter by stage, pipeline, owner or created","description":"List CRM deals with title, pipeline, stage, amount, owner and creation date; filter by stage, pipeline, owner or created-after date. 50 per page, newest first. Use for \"What deals are in stage NEW in my Bitrix24 CRM\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"portal":{"description":"Your Bitrix24 account name: the part before .bitrix24.com in your address (a single word, for example 'mycompany').","maxLength":63,"pattern":"^[a-z0-9]([a-z0-9-]{0,61}[a-z0-9])?$","title":"Portal","type":"string"},"stage_id":{"anyOf":[{"maxLength":60,"type":"string"},{"type":"null"}],"default":null,"description":"Only deals in this stage id, for example 'NEW' or 'C1:WON' (see list_statuses with entity_id DEAL_STAGE).","title":"Stage Id"},"category_id":{"anyOf":[{"minimum":0,"type":"integer"},{"type":"null"}],"default":null,"description":"Only deals in this pipeline id (0 is the default pipeline).","title":"Category Id"},"assigned_by_id":{"anyOf":[{"minimum":1,"type":"integer"},{"type":"null"}],"default":null,"description":"Only deals owned by this user id.","title":"Assigned By Id"},"created_from":{"anyOf":[{"maxLength":30,"type":"string"},{"type":"null"}],"default":null,"description":"Only deals created on or after this date (YYYY-MM-DD).","title":"Created From"},"start":{"anyOf":[{"maximum":1000000,"minimum":0,"type":"integer"},{"type":"null"}],"default":0,"description":"Pagination offset: 0 for the first page, then 50, 100 and so on (pages hold 50 records).","title":"Start"}},"required":["portal"],"title":"list_dealsArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/list_leads":{"post":{"operationId":"list_leads","summary":"List CRM leads with title, name, status, source, expected amount, owner and dates; filter by status, source or owner. 50","description":"List CRM leads with title, name, status, source, expected amount, owner and dates; filter by status, source or owner. 50 per page, newest first. Use for \"Which new leads came in to Bitrix24 this week\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"portal":{"description":"Your Bitrix24 account name: the part before .bitrix24.com in your address (a single word, for example 'mycompany').","maxLength":63,"pattern":"^[a-z0-9]([a-z0-9-]{0,61}[a-z0-9])?$","title":"Portal","type":"string"},"status_id":{"anyOf":[{"maxLength":60,"type":"string"},{"type":"null"}],"default":null,"description":"Only leads with this status id, for example 'NEW' (see list_statuses with entity_id STATUS).","title":"Status Id"},"source_id":{"anyOf":[{"maxLength":60,"type":"string"},{"type":"null"}],"default":null,"description":"Only leads from this source id.","title":"Source Id"},"assigned_by_id":{"anyOf":[{"minimum":1,"type":"integer"},{"type":"null"}],"default":null,"description":"Only leads owned by this user id.","title":"Assigned By Id"},"created_from":{"anyOf":[{"maxLength":30,"type":"string"},{"type":"null"}],"default":null,"description":"Only leads created on or after this date (YYYY-MM-DD).","title":"Created From"},"start":{"anyOf":[{"maximum":1000000,"minimum":0,"type":"integer"},{"type":"null"}],"default":0,"description":"Pagination offset: 0 for the first page, then 50, 100 and so on (pages hold 50 records).","title":"Start"}},"required":["portal"],"title":"list_leadsArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/list_contacts":{"post":{"operationId":"list_contacts","summary":"List CRM contacts (names, owner, creation date), optionally only those created after a date or owned by one user. 50 per","description":"List CRM contacts (names, owner, creation date), optionally only those created after a date or owned by one user. 50 per page, newest first. Use for \"Which contacts were added to Bitrix24 this month\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"portal":{"description":"Your Bitrix24 account name: the part before .bitrix24.com in your address (a single word, for example 'mycompany').","maxLength":63,"pattern":"^[a-z0-9]([a-z0-9-]{0,61}[a-z0-9])?$","title":"Portal","type":"string"},"assigned_by_id":{"anyOf":[{"minimum":1,"type":"integer"},{"type":"null"}],"default":null,"description":"Only contacts owned by this user id.","title":"Assigned By Id"},"created_from":{"anyOf":[{"maxLength":30,"type":"string"},{"type":"null"}],"default":null,"description":"Only contacts created on or after this date (YYYY-MM-DD).","title":"Created From"},"start":{"anyOf":[{"maximum":1000000,"minimum":0,"type":"integer"},{"type":"null"}],"default":0,"description":"Pagination offset: 0 for the first page, then 50, 100 and so on (pages hold 50 records).","title":"Start"}},"required":["portal"],"title":"list_contactsArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/list_companies":{"post":{"operationId":"list_companies","summary":"List CRM companies (title, owner), optionally only those owned by one user. 50 per page, newest first. Use for \"Which co","description":"List CRM companies (title, owner), optionally only those owned by one user. 50 per page, newest first. Use for \"Which companies are in my Bitrix24 CRM\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"portal":{"description":"Your Bitrix24 account name: the part before .bitrix24.com in your address (a single word, for example 'mycompany').","maxLength":63,"pattern":"^[a-z0-9]([a-z0-9-]{0,61}[a-z0-9])?$","title":"Portal","type":"string"},"assigned_by_id":{"anyOf":[{"minimum":1,"type":"integer"},{"type":"null"}],"default":null,"description":"Only companies owned by this user id.","title":"Assigned By Id"},"start":{"anyOf":[{"maximum":1000000,"minimum":0,"type":"integer"},{"type":"null"}],"default":0,"description":"Pagination offset: 0 for the first page, then 50, 100 and so on (pages hold 50 records).","title":"Start"}},"required":["portal"],"title":"list_companiesArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/list_statuses":{"post":{"operationId":"list_statuses","summary":"List CRM directory items such as deal stages, lead statuses and sources, with id, name, order and colour; filter by dire","description":"List CRM directory items such as deal stages, lead statuses and sources, with id, name, order and colour; filter by directory (entity_id). Use for \"What stages does my Bitrix24 deal pipeline have\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"portal":{"description":"Your Bitrix24 account name: the part before .bitrix24.com in your address (a single word, for example 'mycompany').","maxLength":63,"pattern":"^[a-z0-9]([a-z0-9-]{0,61}[a-z0-9])?$","title":"Portal","type":"string"},"entity_id":{"anyOf":[{"maxLength":60,"type":"string"},{"type":"null"}],"default":null,"description":"Directory to list, for example DEAL_STAGE (deal stages), STATUS (lead statuses) or SOURCE (lead sources).","title":"Entity Id"}},"required":["portal"],"title":"list_statusesArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/list_tasks":{"post":{"operationId":"list_tasks","summary":"List tasks visible to the webhook user (title, status, responsible, deadline, creation date), 50 per page. Task fields u","description":"List tasks visible to the webhook user (title, status, responsible, deadline, creation date), 50 per page. Task fields use lower-case names. Use for \"Which Bitrix24 tasks are in progress\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"portal":{"description":"Your Bitrix24 account name: the part before .bitrix24.com in your address (a single word, for example 'mycompany').","maxLength":63,"pattern":"^[a-z0-9]([a-z0-9-]{0,61}[a-z0-9])?$","title":"Portal","type":"string"},"status":{"anyOf":[{"maximum":6,"minimum":2,"type":"integer"},{"type":"null"}],"default":null,"description":"Only tasks with this status: 2 waiting, 3 in progress, 4 awaiting control, 5 completed, 6 postponed.","title":"Status"},"responsible_id":{"anyOf":[{"minimum":1,"type":"integer"},{"type":"null"}],"default":null,"description":"Only tasks whose responsible user has this id.","title":"Responsible Id"},"start":{"anyOf":[{"maximum":1000000,"minimum":0,"type":"integer"},{"type":"null"}],"default":0,"description":"Pagination offset: 0 for the first page, then 50, 100 and so on (pages hold 50 records).","title":"Start"}},"required":["portal"],"title":"list_tasksArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}}}}