{"openapi":"3.1.0","info":{"title":"Rentman (BYOK) API","version":"0.1.0","description":"Rentman (BYOK) lets an AI assistant read your own Rentman data through the Rentman API with a key you supply (Rentman API token (JWT)). Read-only: 10 tools (list_projects, list_contacts, list_crew, list_equipment, list_quotes, list_invoices, list_project_equipment, list_project_crew, list_stock_locations, list_subrentals). 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-rentman.connectorbay.com/mcp.","contact":{"name":"Unify Dynamics LLC","email":"agent@connectorbay.com","url":"https://connectorbay.com/byok-rentman/docs"},"termsOfService":"https://connectorbay.com/byok-rentman/terms"},"servers":[{"url":"https://byok-rentman.connectorbay.com"}],"externalDocs":{"url":"https://connectorbay.com/byok-rentman/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_projects":{"post":{"operationId":"list_projects","summary":"List rental projects with name, number, customer link, planning and usage periods, status prices and cost totals. Use fo","description":"List rental projects with name, number, customer link, planning and usage periods, status prices and cost totals. Use for \"Which Rentman projects are coming up\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"limit":{"anyOf":[{"maximum":1500,"minimum":1,"type":"integer"},{"type":"null"}],"default":50,"description":"How many items to return per page (1 to 1500).","title":"Limit"},"cursor":{"anyOf":[{"maxLength":500,"type":"string"},{"type":"null"}],"default":null,"description":"Opaque paging cursor: the value of the cursor query parameter inside next_page_url from the previous answer.","title":"Cursor"}},"title":"list_projectsArguments","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 customer and supplier contacts (companies or private persons) with name, type, city and country. Use for \"Who are m","description":"List customer and supplier contacts (companies or private persons) with name, type, city and country. Use for \"Who are my Rentman customers\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"limit":{"anyOf":[{"maximum":1500,"minimum":1,"type":"integer"},{"type":"null"}],"default":50,"description":"How many items to return per page (1 to 1500).","title":"Limit"},"cursor":{"anyOf":[{"maxLength":500,"type":"string"},{"type":"null"}],"default":null,"description":"Opaque paging cursor: the value of the cursor query parameter inside next_page_url from the previous answer.","title":"Cursor"}},"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_crew":{"post":{"operationId":"list_crew","summary":"List crew members with name, e-mail, phone, active flag and tags. Use for \"Which crew members are active in Rentman\".","description":"List crew members with name, e-mail, phone, active flag and tags. Use for \"Which crew members are active in Rentman\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"limit":{"anyOf":[{"maximum":1500,"minimum":1,"type":"integer"},{"type":"null"}],"default":50,"description":"How many items to return per page (1 to 1500).","title":"Limit"},"cursor":{"anyOf":[{"maxLength":500,"type":"string"},{"type":"null"}],"default":null,"description":"Opaque paging cursor: the value of the cursor query parameter inside next_page_url from the previous answer.","title":"Cursor"}},"title":"list_crewArguments","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_equipment":{"post":{"operationId":"list_equipment","summary":"List the equipment catalogue with code, name, type, rental or sale, price, unit and archive flag. Use for \"What equipmen","description":"List the equipment catalogue with code, name, type, rental or sale, price, unit and archive flag. Use for \"What equipment is in my Rentman catalogue and what does it cost\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"limit":{"anyOf":[{"maximum":1500,"minimum":1,"type":"integer"},{"type":"null"}],"default":50,"description":"How many items to return per page (1 to 1500).","title":"Limit"},"cursor":{"anyOf":[{"maxLength":500,"type":"string"},{"type":"null"}],"default":null,"description":"Opaque paging cursor: the value of the cursor query parameter inside next_page_url from the previous answer.","title":"Cursor"}},"title":"list_equipmentArguments","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_quotes":{"post":{"operationId":"list_quotes","summary":"List quotes with number, subject, customer link, dates, version and price totals. Use for \"Which quotes did I send in Re","description":"List quotes with number, subject, customer link, dates, version and price totals. Use for \"Which quotes did I send in Rentman\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"limit":{"anyOf":[{"maximum":1500,"minimum":1,"type":"integer"},{"type":"null"}],"default":50,"description":"How many items to return per page (1 to 1500).","title":"Limit"},"cursor":{"anyOf":[{"maxLength":500,"type":"string"},{"type":"null"}],"default":null,"description":"Opaque paging cursor: the value of the cursor query parameter inside next_page_url from the previous answer.","title":"Cursor"}},"title":"list_quotesArguments","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_invoices":{"post":{"operationId":"list_invoices","summary":"List invoices with number, subject, dates, amounts, paid flag and outstanding balance. Use for \"Which Rentman invoices a","description":"List invoices with number, subject, dates, amounts, paid flag and outstanding balance. Use for \"Which Rentman invoices are still unpaid\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"limit":{"anyOf":[{"maximum":1500,"minimum":1,"type":"integer"},{"type":"null"}],"default":50,"description":"How many items to return per page (1 to 1500).","title":"Limit"},"cursor":{"anyOf":[{"maxLength":500,"type":"string"},{"type":"null"}],"default":null,"description":"Opaque paging cursor: the value of the cursor query parameter inside next_page_url from the previous answer.","title":"Cursor"}},"title":"list_invoicesArguments","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_project_equipment":{"post":{"operationId":"list_project_equipment","summary":"List the equipment planned in one project with quantity, unit price, discount and usage period. Use for \"What equipment ","description":"List the equipment planned in one project with quantity, unit price, discount and usage period. Use for \"What equipment is planned for Rentman project 42\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"id":{"description":"Numeric Rentman project id.","title":"Id","type":"integer"},"limit":{"anyOf":[{"maximum":1500,"minimum":1,"type":"integer"},{"type":"null"}],"default":50,"description":"How many items to return per page (1 to 1500).","title":"Limit"},"cursor":{"anyOf":[{"maxLength":500,"type":"string"},{"type":"null"}],"default":null,"description":"Opaque paging cursor: the value of the cursor query parameter inside next_page_url from the previous answer.","title":"Cursor"}},"required":["id"],"title":"list_project_equipmentArguments","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_project_crew":{"post":{"operationId":"list_project_crew","summary":"List the crew assigned to one project with their function links and planning periods. Use for \"Who is crewed on Rentman ","description":"List the crew assigned to one project with their function links and planning periods. Use for \"Who is crewed on Rentman project 42\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"id":{"description":"Numeric Rentman project id.","title":"Id","type":"integer"},"limit":{"anyOf":[{"maximum":1500,"minimum":1,"type":"integer"},{"type":"null"}],"default":50,"description":"How many items to return per page (1 to 1500).","title":"Limit"},"cursor":{"anyOf":[{"maxLength":500,"type":"string"},{"type":"null"}],"default":null,"description":"Opaque paging cursor: the value of the cursor query parameter inside next_page_url from the previous answer.","title":"Cursor"}},"required":["id"],"title":"list_project_crewArguments","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_stock_locations":{"post":{"operationId":"list_stock_locations","summary":"List warehouse stock locations with name, city, country, type and active flag. Use for \"Which stock locations does my Re","description":"List warehouse stock locations with name, city, country, type and active flag. Use for \"Which stock locations does my Rentman account have\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"limit":{"anyOf":[{"maximum":1500,"minimum":1,"type":"integer"},{"type":"null"}],"default":50,"description":"How many items to return per page (1 to 1500).","title":"Limit"},"cursor":{"anyOf":[{"maxLength":500,"type":"string"},{"type":"null"}],"default":null,"description":"Opaque paging cursor: the value of the cursor query parameter inside next_page_url from the previous answer.","title":"Cursor"}},"title":"list_stock_locationsArguments","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_subrentals":{"post":{"operationId":"list_subrentals","summary":"List subrentals from suppliers with name, supplier link, usage period, cost, type and status. Use for \"What equipment am","description":"List subrentals from suppliers with name, supplier link, usage period, cost, type and status. Use for \"What equipment am I subrenting from suppliers\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"limit":{"anyOf":[{"maximum":1500,"minimum":1,"type":"integer"},{"type":"null"}],"default":50,"description":"How many items to return per page (1 to 1500).","title":"Limit"},"cursor":{"anyOf":[{"maxLength":500,"type":"string"},{"type":"null"}],"default":null,"description":"Opaque paging cursor: the value of the cursor query parameter inside next_page_url from the previous answer.","title":"Cursor"}},"title":"list_subrentalsArguments","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}}}}