{"openapi":"3.1.0","info":{"title":"JobNimbus Setup (BYOK) API","version":"0.1.0","description":"JobNimbus Setup (BYOK) lets an AI assistant read your own JobNimbus Setup data through the JobNimbus Setup API with a key you supply (JobNimbus API key). Read-only: 8 tools (get_account_settings, list_workflows, list_lead_sources, list_task_types, list_activity_types, list_file_types, list_groups, list_units_of_measure). The BYOK key travels with each request, is used for that one call only and...\n\nEvery operation is read-only or compute-only. The same tools are available over MCP (streamable HTTP) at https://byok-jobnimbus-account-setup.connectorbay.com/mcp.","contact":{"name":"Unify Dynamics LLC","email":"agent@connectorbay.com","url":"https://connectorbay.com/byok-jobnimbus-account-setup/docs"},"termsOfService":"https://connectorbay.com/byok-jobnimbus-account-setup/terms"},"servers":[{"url":"https://byok-jobnimbus-account-setup.connectorbay.com"}],"externalDocs":{"url":"https://connectorbay.com/byok-jobnimbus-account-setup/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_account_settings":{"post":{"operationId":"get_account_settings","summary":"Get the account configuration lists in one answer: workflows with their statuses, file types, task types, activity types","description":"Get the account configuration lists in one answer: workflows with their statuses, file types, task types, activity types and lead sources. Use for \"What workflows, task types and lead sources are configured in JobNimbus\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{},"title":"get_account_settingsArguments","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_workflows":{"post":{"operationId":"list_workflows","summary":"List workflows (contact, job and other pipelines) with name, object type, active flag and their statuses. Use for \"Which","description":"List workflows (contact, job and other pipelines) with name, object type, active flag and their statuses. Use for \"Which statuses does the JobNimbus job workflow have\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"field":{"anyOf":[{"const":"workflows","type":"string"},{"type":"null"}],"default":"workflows","description":"Fixed value 'workflows'; selects the workflow list.","title":"Field"}},"title":"list_workflowsArguments","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_sources":{"post":{"operationId":"list_lead_sources","summary":"List lead sources (where jobs and contacts came from) with id, name and active flag. Use for \"What lead sources are set ","description":"List lead sources (where jobs and contacts came from) with id, name and active flag. Use for \"What lead sources are set up in JobNimbus\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"field":{"anyOf":[{"const":"sources","type":"string"},{"type":"null"}],"default":"sources","description":"Fixed value 'sources'; selects the lead source list.","title":"Field"}},"title":"list_lead_sourcesArguments","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_task_types":{"post":{"operationId":"list_task_types","summary":"List task types with id, name, default task name, icon and whether they are hidden from the task list or calendar. Use f","description":"List task types with id, name, default task name, icon and whether they are hidden from the task list or calendar. Use for \"Which task types can I use in JobNimbus\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"field":{"anyOf":[{"const":"taskTypes","type":"string"},{"type":"null"}],"default":"taskTypes","description":"Fixed value 'taskTypes'; selects the task type list.","title":"Field"}},"title":"list_task_typesArguments","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_activity_types":{"post":{"operationId":"list_activity_types","summary":"List activity types (note, call, email and so on) with id, name and whether they show in job share. Use for \"What activi","description":"List activity types (note, call, email and so on) with id, name and whether they show in job share. Use for \"What activity types does JobNimbus track\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"field":{"anyOf":[{"const":"activityTypes","type":"string"},{"type":"null"}],"default":"activityTypes","description":"Fixed value 'activityTypes'; selects the activity type list.","title":"Field"}},"title":"list_activity_typesArguments","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_file_types":{"post":{"operationId":"list_file_types","summary":"List file types (document, photo and so on) with id, name and active flag. Use for \"What file types can be attached in J","description":"List file types (document, photo and so on) with id, name and active flag. Use for \"What file types can be attached in JobNimbus\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"field":{"anyOf":[{"const":"fileTypes","type":"string"},{"type":"null"}],"default":"fileTypes","description":"Fixed value 'fileTypes'; selects the file type list.","title":"Field"}},"title":"list_file_typesArguments","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_groups":{"post":{"operationId":"list_groups","summary":"List team groups with their name (member and manager ids are left out). Use for \"Which sales groups exist in JobNimbus\".","description":"List team groups with their name (member and manager ids are left out). Use for \"Which sales groups exist in JobNimbus\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"field":{"anyOf":[{"const":"groups","type":"string"},{"type":"null"}],"default":"groups","description":"Fixed value 'groups'; selects the group list.","title":"Field"}},"title":"list_groupsArguments","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_units_of_measure":{"post":{"operationId":"list_units_of_measure","summary":"List the units of measure available for products, as plain codes such as SQ. Use for \"Which units of measure does JobNim","description":"List the units of measure available for products, as plain codes such as SQ. Use for \"Which units of measure does JobNimbus support\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{},"title":"list_units_of_measureArguments","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}}}}