{"openapi":"3.1.0","info":{"title":"noCRM (BYOK) API","version":"0.1.0","description":"noCRM (BYOK) lets an AI assistant read your own noCRM data through the noCRM API with a key you supply (noCRM API key (created by an administrator)). Read-only: 12 tools (list_leads, get_lead, list_unassigned_leads, list_lead_comments, list_steps, list_pipelines, list_client_folders, get_client_folder, list_fields, list_users, list_teams, list_follow_ups). The BYOK key travels with each request,...\n\nEvery operation is read-only or compute-only. The same tools are available over MCP (streamable HTTP) at https://byok-nocrm.connectorbay.com/mcp.","contact":{"name":"Unify Dynamics LLC","email":"agent@connectorbay.com","url":"https://connectorbay.com/byok-nocrm/docs"},"termsOfService":"https://connectorbay.com/byok-nocrm/terms"},"servers":[{"url":"https://byok-nocrm.connectorbay.com"}],"externalDocs":{"url":"https://connectorbay.com/byok-nocrm/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/list_leads":{"post":{"operationId":"list_leads","summary":"List leads with title, status, step, amount, probability, next action date, tags, owner and description. Filter by statu","description":"List leads with title, status, step, amount, probability, next action date, tags, owner and description. Filter by status, step, tag, owner or update date. Up to 100 per request; page with offset. Use for \"Which noCRM leads are still open and were updated this month\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"subdomain":{"description":"Your noCRM account subdomain: the part before .nocrm.io, for example 'mycompany' for mycompany.nocrm.io.","maxLength":200,"pattern":"^[a-z0-9]([a-z0-9-]{0,61}[a-z0-9])?$","title":"Subdomain","type":"string"},"status":{"anyOf":[{"maxLength":200,"type":"string"},{"type":"null"}],"default":null,"description":"Comma-separated statuses to keep: todo, standby, won, cancelled, lost.","title":"Status"},"step":{"anyOf":[{"maxLength":200,"type":"string"},{"type":"null"}],"default":null,"description":"Comma-separated step names or step IDs (not mixed) to keep.","title":"Step"},"tags":{"anyOf":[{"maxLength":200,"type":"string"},{"type":"null"}],"default":null,"description":"Comma-separated tags; only leads having all of them are returned.","title":"Tags"},"user_id":{"anyOf":[{"maxLength":200,"type":"string"},{"type":"null"}],"default":null,"description":"User ID or email: only that user's leads.","title":"User Id"},"email":{"anyOf":[{"maxLength":200,"type":"string"},{"type":"null"}],"default":null,"description":"Only leads whose description or comments contain this email address.","title":"Email"},"updated_after":{"anyOf":[{"maxLength":200,"type":"string"},{"type":"null"}],"default":null,"description":"Only leads updated after this date (YYYY-MM-DD).","title":"Updated After"},"order":{"anyOf":[{"enum":["id","creation_date","last_update","next_action","sale_step","amount","probability","probalized_amount","alphabetically"],"type":"string"},{"type":"null"}],"default":"id","description":"Sort field.","title":"Order"},"direction":{"anyOf":[{"enum":["asc","desc"],"type":"string"},{"type":"null"}],"default":"desc","description":"Sort direction: asc or desc.","title":"Direction"},"limit":{"anyOf":[{"maximum":100,"minimum":1,"type":"integer"},{"type":"null"}],"default":100,"description":"Maximum number of leads (1 to 100).","title":"Limit"},"offset":{"anyOf":[{"maximum":100000,"minimum":0,"type":"integer"},{"type":"null"}],"default":0,"description":"Number of leads to skip, for paging.","title":"Offset"}},"required":["subdomain"],"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/get_lead":{"post":{"operationId":"get_lead","summary":"Get one lead by ID with its status, step, amount, probability, dates, tags, description and the contact fields found in ","description":"Get one lead by ID with its status, step, amount, probability, dates, tags, description and the contact fields found in it. Use for \"Show noCRM lead 8113\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"subdomain":{"description":"Your noCRM account subdomain: the part before .nocrm.io, for example 'mycompany' for mycompany.nocrm.io.","maxLength":200,"pattern":"^[a-z0-9]([a-z0-9-]{0,61}[a-z0-9])?$","title":"Subdomain","type":"string"},"lead_id":{"description":"Lead ID.","title":"Lead Id","type":"integer"}},"required":["subdomain","lead_id"],"title":"get_leadArguments","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_unassigned_leads":{"post":{"operationId":"list_unassigned_leads","summary":"List leads that belong to nobody yet (the Unassigned tab). Use for \"Which noCRM leads are unassigned\".","description":"List leads that belong to nobody yet (the Unassigned tab). Use for \"Which noCRM leads are unassigned\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"subdomain":{"description":"Your noCRM account subdomain: the part before .nocrm.io, for example 'mycompany' for mycompany.nocrm.io.","maxLength":200,"pattern":"^[a-z0-9]([a-z0-9-]{0,61}[a-z0-9])?$","title":"Subdomain","type":"string"},"limit":{"anyOf":[{"maximum":100,"minimum":1,"type":"integer"},{"type":"null"}],"default":100,"description":"Maximum number of leads (1 to 100).","title":"Limit"}},"required":["subdomain"],"title":"list_unassigned_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_lead_comments":{"post":{"operationId":"list_lead_comments","summary":"List the activity feed of one lead (notes, calls, emails) with author, activity type and date, newest first by default. ","description":"List the activity feed of one lead (notes, calls, emails) with author, activity type and date, newest first by default. Use for \"What happened on noCRM lead 8113\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"subdomain":{"description":"Your noCRM account subdomain: the part before .nocrm.io, for example 'mycompany' for mycompany.nocrm.io.","maxLength":200,"pattern":"^[a-z0-9]([a-z0-9-]{0,61}[a-z0-9])?$","title":"Subdomain","type":"string"},"lead_id":{"description":"Lead ID.","title":"Lead Id","type":"integer"},"direction":{"anyOf":[{"enum":["asc","desc"],"type":"string"},{"type":"null"}],"default":"desc","description":"Sort direction: asc or desc.","title":"Direction"}},"required":["subdomain","lead_id"],"title":"list_lead_commentsArguments","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_steps":{"post":{"operationId":"list_steps","summary":"List pipeline steps in position order with the pipeline each belongs to. Use for \"What steps does my noCRM pipeline have","description":"List pipeline steps in position order with the pipeline each belongs to. Use for \"What steps does my noCRM pipeline have\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"subdomain":{"description":"Your noCRM account subdomain: the part before .nocrm.io, for example 'mycompany' for mycompany.nocrm.io.","maxLength":200,"pattern":"^[a-z0-9]([a-z0-9-]{0,61}[a-z0-9])?$","title":"Subdomain","type":"string"},"direction":{"anyOf":[{"enum":["asc","desc"],"type":"string"},{"type":"null"}],"default":"asc","description":"Sort direction: asc or desc.","title":"Direction"}},"required":["subdomain"],"title":"list_stepsArguments","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_pipelines":{"post":{"operationId":"list_pipelines","summary":"List pipelines (a single one when multiple pipelines are not enabled on the plan). Use for \"Which pipelines exist in noC","description":"List pipelines (a single one when multiple pipelines are not enabled on the plan). Use for \"Which pipelines exist in noCRM\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"subdomain":{"description":"Your noCRM account subdomain: the part before .nocrm.io, for example 'mycompany' for mycompany.nocrm.io.","maxLength":200,"pattern":"^[a-z0-9]([a-z0-9-]{0,61}[a-z0-9])?$","title":"Subdomain","type":"string"}},"required":["subdomain"],"title":"list_pipelinesArguments","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_client_folders":{"post":{"operationId":"list_client_folders","summary":"List client folders that group leads, with name, description and active flag. Use for \"List my noCRM client folders\".","description":"List client folders that group leads, with name, description and active flag. Use for \"List my noCRM client folders\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"subdomain":{"description":"Your noCRM account subdomain: the part before .nocrm.io, for example 'mycompany' for mycompany.nocrm.io.","maxLength":200,"pattern":"^[a-z0-9]([a-z0-9-]{0,61}[a-z0-9])?$","title":"Subdomain","type":"string"},"order":{"anyOf":[{"enum":["name","id"],"type":"string"},{"type":"null"}],"default":"name","description":"Sort field: name or id.","title":"Order"},"direction":{"anyOf":[{"enum":["asc","desc"],"type":"string"},{"type":"null"}],"default":"asc","description":"Sort direction: asc or desc.","title":"Direction"}},"required":["subdomain"],"title":"list_client_foldersArguments","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/get_client_folder":{"post":{"operationId":"get_client_folder","summary":"Get one client folder by ID. Use for \"Show noCRM client folder 12\".","description":"Get one client folder by ID. Use for \"Show noCRM client folder 12\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"subdomain":{"description":"Your noCRM account subdomain: the part before .nocrm.io, for example 'mycompany' for mycompany.nocrm.io.","maxLength":200,"pattern":"^[a-z0-9]([a-z0-9-]{0,61}[a-z0-9])?$","title":"Subdomain","type":"string"},"client_id":{"description":"Client folder ID.","title":"Client Id","type":"integer"}},"required":["subdomain","client_id"],"title":"get_client_folderArguments","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_fields":{"post":{"operationId":"list_fields","summary":"List the lead and client fields defined in the account, with type and position. Use for \"Which fields do my noCRM leads ","description":"List the lead and client fields defined in the account, with type and position. Use for \"Which fields do my noCRM leads have\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"subdomain":{"description":"Your noCRM account subdomain: the part before .nocrm.io, for example 'mycompany' for mycompany.nocrm.io.","maxLength":200,"pattern":"^[a-z0-9]([a-z0-9-]{0,61}[a-z0-9])?$","title":"Subdomain","type":"string"},"type":{"anyOf":[{"enum":["lead","client"],"type":"string"},{"type":"null"}],"default":null,"description":"Restrict to lead or client fields.","title":"Type"}},"required":["subdomain"],"title":"list_fieldsArguments","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 users with name, email, job title, admin flag, activation and disabled state. Use for \"Who are the users of my noCR","description":"List users with name, email, job title, admin flag, activation and disabled state. Use for \"Who are the users of my noCRM account\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"subdomain":{"description":"Your noCRM account subdomain: the part before .nocrm.io, for example 'mycompany' for mycompany.nocrm.io.","maxLength":200,"pattern":"^[a-z0-9]([a-z0-9-]{0,61}[a-z0-9])?$","title":"Subdomain","type":"string"},"status":{"anyOf":[{"enum":["all","activated","deactivated"],"type":"string"},{"type":"null"}],"default":"all","description":"Which users: all, activated or deactivated.","title":"Status"},"role":{"anyOf":[{"enum":["all","admin","non-admin"],"type":"string"},{"type":"null"}],"default":"all","description":"Which role: all, admin or non-admin.","title":"Role"},"email":{"anyOf":[{"maxLength":200,"type":"string"},{"type":"null"}],"default":null,"description":"Only the user with this email address.","title":"Email"},"direction":{"anyOf":[{"enum":["asc","desc"],"type":"string"},{"type":"null"}],"default":"asc","description":"Sort direction: asc or desc.","title":"Direction"}},"required":["subdomain"],"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_teams":{"post":{"operationId":"list_teams","summary":"List teams (needs the Teams feature, otherwise a 403 comes back). Use for \"Which teams exist in noCRM\".","description":"List teams (needs the Teams feature, otherwise a 403 comes back). Use for \"Which teams exist in noCRM\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"subdomain":{"description":"Your noCRM account subdomain: the part before .nocrm.io, for example 'mycompany' for mycompany.nocrm.io.","maxLength":200,"pattern":"^[a-z0-9]([a-z0-9-]{0,61}[a-z0-9])?$","title":"Subdomain","type":"string"}},"required":["subdomain"],"title":"list_teamsArguments","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_follow_ups":{"post":{"operationId":"list_follow_ups","summary":"List post-sales tasks (follow-ups) of one lead or one user with status, counts and next action date. Give lead_id or use","description":"List post-sales tasks (follow-ups) of one lead or one user with status, counts and next action date. Give lead_id or user_id. Use for \"What post-sales follow-ups does noCRM user 10 have to do\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"subdomain":{"description":"Your noCRM account subdomain: the part before .nocrm.io, for example 'mycompany' for mycompany.nocrm.io.","maxLength":200,"pattern":"^[a-z0-9]([a-z0-9-]{0,61}[a-z0-9])?$","title":"Subdomain","type":"string"},"lead_id":{"anyOf":[{"minimum":1,"type":"integer"},{"type":"null"}],"default":null,"description":"Lead ID; use this or user_id.","title":"Lead Id"},"user_id":{"anyOf":[{"maxLength":200,"type":"string"},{"type":"null"}],"default":null,"description":"User ID or email; use this or lead_id.","title":"User Id"},"status":{"anyOf":[{"maxLength":40,"type":"string"},{"type":"null"}],"default":null,"description":"Comma-separated statuses: todo, standby, done.","title":"Status"}},"required":["subdomain"],"title":"list_follow_upsArguments","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}}}}