{"openapi":"3.1.0","info":{"title":"Deel HR Setup (BYOK) API","version":"0.1.0","description":"Deel HR Setup (BYOK) lets an AI assistant read your own Deel HR Setup data through the Deel HR Setup API with a key you supply (Deel API token (scopes organizations:read, people:read, contracts:read, legal-entity:read as needed)). Read-only: 9 tools (list_organization_structures, list_people_custom_fields, list_contract_custom_fields, list_legal_entity_cost_centers, list_job_titles,...\n\nEvery operation is read-only or compute-only. The same tools are available over MCP (streamable HTTP) at https://byok-deel-hr-setup.connectorbay.com/mcp.","contact":{"name":"Unify Dynamics LLC","email":"agent@connectorbay.com","url":"https://connectorbay.com/byok-deel-hr-setup/docs"},"termsOfService":"https://connectorbay.com/byok-deel-hr-setup/terms"},"servers":[{"url":"https://byok-deel-hr-setup.connectorbay.com"}],"externalDocs":{"url":"https://connectorbay.com/byok-deel-hr-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/list_organization_structures":{"post":{"operationId":"list_organization_structures","summary":"List the organization structures (departments, groups and similar) with their teams, roles and team counts. Use for \"Wha","description":"List the organization structures (departments, groups and similar) with their teams, roles and team counts. Use for \"What departments and teams are defined in my Deel organization\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"limit":{"anyOf":[{"minimum":1,"type":"integer"},{"type":"null"}],"default":null,"description":"Maximum number of structures to return.","title":"Limit"},"offset":{"anyOf":[{"minimum":0,"type":"integer"},{"type":"null"}],"default":0,"description":"Number of records to skip, starting at 0.","title":"Offset"}},"title":"list_organization_structuresArguments","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_people_custom_fields":{"post":{"operationId":"list_people_custom_fields","summary":"List the custom field definitions for workers (name, type, options, required flag, who provides it); no worker values ar","description":"List the custom field definitions for workers (name, type, options, required flag, who provides it); no worker values are returned. Use for \"Which custom fields does my Deel organization define for people\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{},"title":"list_people_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_contract_custom_fields":{"post":{"operationId":"list_contract_custom_fields","summary":"List the custom field definitions for contracts (name, type, options, required flag); no contract values are returned. U","description":"List the custom field definitions for contracts (name, type, options, required flag); no contract values are returned. Use for \"Which custom fields does my Deel organization define for contracts\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{},"title":"list_contract_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_legal_entity_cost_centers":{"post":{"operationId":"list_legal_entity_cost_centers","summary":"List the cost centers (name and code) defined for one legal entity. Use for \"What cost centers does Deel legal entity ce","description":"List the cost centers (name and code) defined for one legal entity. Use for \"What cost centers does Deel legal entity ce652eb3 have\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"legal_entity_id":{"description":"Legal entity id from the legal entities list of the Deel connector.","maxLength":200,"title":"Legal Entity Id","type":"string"}},"required":["legal_entity_id"],"title":"list_legal_entity_cost_centersArguments","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_job_titles":{"post":{"operationId":"list_job_titles","summary":"List the predefined job titles Deel accepts when creating contracts. Use for \"Which job titles does Deel offer\".","description":"List the predefined job titles Deel accepts when creating contracts. Use for \"Which job titles does Deel offer\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"after_cursor":{"anyOf":[{"maxLength":200,"type":"string"},{"type":"null"}],"default":null,"description":"Cursor from page.cursor of the previous answer; leave empty for the first page.","title":"After Cursor"}},"title":"list_job_titlesArguments","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_seniority_levels":{"post":{"operationId":"list_seniority_levels","summary":"List the predefined seniority levels with their numeric rank. Use for \"Which seniority levels does Deel support\".","description":"List the predefined seniority levels with their numeric rank. Use for \"Which seniority levels does Deel support\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"is_eor_contract":{"anyOf":[{"type":"boolean"},{"type":"null"}],"default":true,"description":"True (the default) hides C-level seniorities that EOR contracts cannot use; false returns all.","title":"Is Eor Contract"}},"title":"list_seniority_levelsArguments","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 countries Deel knows with their states or regions, whether EOR and visa support exist, and the default currency. Us","description":"List countries Deel knows with their states or regions, whether EOR and visa support exist, and the default currency. Use for \"In which countries does Deel offer employer of record support\".","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_currencies":{"post":{"operationId":"list_currencies","summary":"List the currencies Deel supports (ISO 4217 code and name). Use for \"Which currencies can I use in Deel\".","description":"List the currencies Deel supports (ISO 4217 code and name). Use for \"Which currencies can I use in Deel\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{},"title":"list_currenciesArguments","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_time_off_types":{"post":{"operationId":"list_time_off_types","summary":"List the time-off types Deel registers (vacation, sick leave, unpaid leave, other). Use for \"Which time-off types does D","description":"List the time-off types Deel registers (vacation, sick leave, unpaid leave, other). Use for \"Which time-off types does Deel support\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{},"title":"list_time_off_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}}}}