{"openapi":"3.1.0","info":{"title":"Remote (BYOK) API","version":"0.1.0","description":"Remote (BYOK) lets an AI assistant read your own Remote data through the Remote API with a key you supply (Remote customer API token (starts with ra_live_)). Read-only: 5 tools (get_company_identity, list_company_departments, list_custom_fields, list_countries, list_country_holidays). The BYOK key travels with each request, is used for that one call only and is never stored, logged or cached; it...\n\nEvery operation is read-only or compute-only. The same tools are available over MCP (streamable HTTP) at https://byok-remote-company.connectorbay.com/mcp.","contact":{"name":"Unify Dynamics LLC","email":"agent@connectorbay.com","url":"https://connectorbay.com/byok-remote-company/docs"},"termsOfService":"https://connectorbay.com/byok-remote-company/terms"},"servers":[{"url":"https://byok-remote-company.connectorbay.com"}],"externalDocs":{"url":"https://connectorbay.com/byok-remote-company/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_company_identity":{"post":{"operationId":"get_company_identity","summary":"Show which Remote company the token belongs to (company id and name); the id is needed by list_company_departments. Use ","description":"Show which Remote company the token belongs to (company id and name); the id is needed by list_company_departments. Use for \"Which Remote company is my API token for\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{},"title":"get_company_identityArguments","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_company_departments":{"post":{"operationId":"list_company_departments","summary":"List the departments defined for a company (id and name). Use for \"What departments does my Remote company have\".","description":"List the departments defined for a company (id and name). Use for \"What departments does my Remote company have\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"company_id":{"description":"Company id from get_company_identity.","maxLength":64,"title":"Company Id","type":"string"},"paginate":{"anyOf":[{"type":"boolean"},{"type":"null"}],"default":true,"description":"False returns all departments in one answer instead of pages.","title":"Paginate"},"page":{"anyOf":[{"maximum":10000,"minimum":1,"type":"integer"},{"type":"null"}],"default":1,"description":"Page number, starting at 1.","title":"Page"},"page_size":{"anyOf":[{"maximum":100,"minimum":1,"type":"integer"},{"type":"null"}],"default":20,"description":"Items per page (1 to 100, default 20).","title":"Page Size"}},"required":["company_id"],"title":"list_company_departmentsArguments","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_custom_fields":{"post":{"operationId":"list_custom_fields","summary":"List the definitions of the company's custom fields (name, type, whether required and who can see or edit them); field v","description":"List the definitions of the company's custom fields (name, type, whether required and who can see or edit them); field values are not returned. Use for \"What custom fields has my Remote company defined\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"company_id":{"anyOf":[{"maxLength":64,"type":"string"},{"type":"null"}],"default":null,"description":"Company id when the token covers several companies; usually left empty.","title":"Company Id"},"page":{"anyOf":[{"maximum":10000,"minimum":1,"type":"integer"},{"type":"null"}],"default":1,"description":"Page number, starting at 1.","title":"Page"},"page_size":{"anyOf":[{"maximum":100,"minimum":1,"type":"integer"},{"type":"null"}],"default":20,"description":"Items per page (1 to 100, default 20).","title":"Page Size"}},"title":"list_custom_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_countries":{"post":{"operationId":"list_countries","summary":"List the countries Remote supports with region, code, whether employer-of-record onboarding and global payroll are avail","description":"List the countries Remote supports with region, code, whether employer-of-record onboarding and global payroll are available, and contractor products. Use for \"Which countries does Remote support for employer of record\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{},"title":"list_countriesArguments","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_country_holidays":{"post":{"operationId":"list_country_holidays","summary":"List the public holidays of a country for one year, optionally for a subdivision. Use for \"What are the public holidays ","description":"List the public holidays of a country for one year, optionally for a subdivision. Use for \"What are the public holidays in Portugal in 2027 according to Remote\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"country_code":{"description":"Three-letter ISO 3166-1 country code such as PRT or DEU (the code field of list_countries).","maxLength":200,"title":"Country Code","type":"string"},"year":{"description":"Four-digit year, for example 2027.","maxLength":200,"title":"Year","type":"string"},"country_subdivision_code":{"anyOf":[{"maxLength":12,"type":"string"},{"type":"null"}],"default":null,"description":"ISO 3166-2 subdivision code to include regional holidays, for example PT-11.","title":"Country Subdivision Code"}},"required":["country_code","year"],"title":"list_country_holidaysArguments","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}}}}