> ## Documentation Index > Fetch the complete documentation index at: https://docs.bindbee.dev/llms.txt > Use this file to discover all available pages before exploring further. # Get Employees > Returns a list of Employee objects. export const IntegrationSupport = ({category = "HRIS", model, direction = "read"}) => { const SHEET_BASE = "https://docs.google.com/spreadsheets/d/e/2PACX-1vTx0G0yItXlZKO4Zep8wstZuvvO7bgOxFXBVK_1vvQnxpG8H2hP9n9M8kmZMfIoo7ZO4e7_utrz3_XB/pub"; const SHEET_GIDS = { HRIS: { read: "0", write: "1626747715" }, ATS: { read: "1962490874" }, LMS: { read: "1106223511" } }; const LOGO_ROW = "logo link"; const HEADER_ROW = "model"; const TYPE_ROW = "connection type"; const parseCsv = text => { const rows = []; let row = []; let field = ""; let quoted = false; for (let i = 0; i < text.length; i++) { const c = text[i]; if (quoted) { if (c === '"') { if (text[i + 1] === '"') { field += '"'; i++; } else { quoted = false; } } else { field += c; } } else if (c === '"') { quoted = true; } else if (c === ",") { row.push(field); field = ""; } else if (c === "\n" || c === "\r") { if (c === "\r" && text[i + 1] === "\n") i++; row.push(field); rows.push(row); row = []; field = ""; } else { field += c; } } if (field !== "" || row.length) { row.push(field); rows.push(row); } return rows; }; const cell = (row, i) => (row && row[i] || "").trim(); const parseSheet = (csv, wanted) => { const rows = parseCsv(csv); let header = null; let labelCol = -1; rows.slice(0, 12).forEach(r => { if (header) return; for (let i = 0; i < Math.min(r.length, 6); i++) { if (cell(r, i).toLowerCase() === HEADER_ROW) { header = r; labelCol = i; return; } } }); const find = label => rows.find(r => cell(r, labelCol).toLowerCase() === label); const types = header ? find(TYPE_ROW) : null; const logos = header ? find(LOGO_ROW) : null; if (!header || !types) return null; const providers = []; for (let i = labelCol + 1; i < header.length; i++) { const name = cell(header, i); const t = cell(types, i).toUpperCase(); if (!name || t !== "A" && t !== "S") continue; providers.push({ name, type: t === "S" ? "SFTP" : "API", col: i, uid: name + "#" + i, logo: cell(logos, i) }); } const target = String(wanted || "").toLowerCase(); const row = rows.find(r => cell(r, labelCol).toLowerCase() === target); if (!providers.length || !row) return null; const pool = providers; const supported = []; pool.forEach(p => { const v = cell(row, p.col).toUpperCase(); if (v === "Y" || v === "B") supported.push({ ...p }); }); if (!supported.length) return { none: true }; return { total: pool.length, supported }; }; const CSS = ` .bb-is { --bb-border: #e5e3df; --bb-border-strong: #d4d1cc; --bb-bg: #fcfcfb; --bb-bg-sub: #f5f4f3; --bb-text: #1c1b1a; --bb-text-dim: #6e6c68; --bb-accent: #f57e21; --bb-chip: #eceae7; font-size: 14px; color: var(--bb-text); border: 1px solid var(--bb-border); border-radius: 6px; background: var(--bb-bg); margin: 1.5rem 0; overflow: hidden; } html.dark .bb-is { --bb-border: #242424; --bb-border-strong: #333333; --bb-bg: #090909; --bb-bg-sub: #141414; --bb-text: #ededed; --bb-text-dim: #a1a1a1; --bb-chip: #1b1b1b; } .bb-is-head { display: flex; flex-wrap: wrap; align-items: baseline; justify-content: space-between; gap: 8px; padding: 11px 14px; background: var(--bb-bg-sub); border-bottom: 1px solid var(--bb-border); } .bb-is-title { display: inline-flex; align-items: center; gap: 7px; font-weight: 600; font-size: 16px; } /* Mintlify's paints itself via a mask, so this makes it take the title's colour instead of staying its own. */ .bb-is-title .icon { background-color: currentColor !important; } .bb-is-count { font-size: 12px; color: var(--bb-text-dim); } .bb-is-chips { display: flex; flex-wrap: wrap; align-items: center; gap: 6px; padding: 12px 14px; } /* Collapsed by default: one row of chips, the next row fading out under a gradient so it reads as "there is more" rather than as a hard crop. The wrapper does the clipping so the chips keep their own padding. */ .bb-is-chips-wrap { position: relative; } .bb-is-chips-wrap[data-open="false"] .bb-is-chips { max-height: 47px; overflow: hidden; } .bb-is-fade { position: absolute; left: 0; right: 0; bottom: 0; height: 28px; pointer-events: none; background: linear-gradient(to bottom, rgba(252, 252, 251, 0), var(--bb-bg)); } html.dark .bb-is-fade { background: linear-gradient(to bottom, rgba(9, 9, 9, 0), var(--bb-bg)); } .bb-is-toggle { display: inline-flex; align-items: center; gap: 5px; padding: 4px 10px; border: 1px solid var(--bb-border-strong); border-radius: 999px; background: var(--bb-bg); color: var(--bb-text-dim); font-size: 12.5px; font-weight: 500; line-height: 1.5; cursor: pointer; } .bb-is-toggle:hover { color: var(--bb-text); border-color: var(--bb-text-dim); } .bb-is-headright { display: inline-flex; align-items: center; gap: 10px; } .bb-is-chip { display: inline-flex; align-items: center; gap: 6px; padding: 4px 9px; border: 1px solid var(--bb-border); border-radius: 999px; background: var(--bb-bg-sub); font-size: 12.5px; line-height: 1.4; white-space: nowrap; } .bb-is-logo { width: 15px; height: 15px; object-fit: contain; border-radius: 3px; flex: none; } .bb-is-badge { font-size: 9.5px; font-weight: 600; letter-spacing: 0.03em; padding: 1px 5px; border-radius: 3px; background: var(--bb-chip); color: var(--bb-text-dim); } /* Muted on purpose - the provider name should catch the eye in this list, not its connection-type badge. --bb-chip sat too close to the chip's own --bb-bg-sub to read as a separate shape, so the fill is a step further from it in each theme - darker in light mode, and lighter (not literally "darker") in dark mode, since going darker there would fade it into the near-black page instead of separating it. */ .bb-is-badge[data-type="SFTP"] { color: var(--bb-text-dim); background: #ddd9d3; } html.dark .bb-is-badge[data-type="SFTP"] { background: #292929; } .bb-is-foot { padding: 9px 14px; border-top: 1px solid var(--bb-border); font-size: 14px; color: var(--bb-text-dim); } .bb-is-foot a { color: var(--bb-accent); text-decoration: none; } .bb-is-foot a:hover { text-decoration: underline; } .bb-is-none { padding: 16px 14px; font-size: 14px; line-height: 1.5; color: var(--bb-text-dim); } .bb-is-none a { color: var(--bb-accent); text-decoration: none; } .bb-is-none a:hover { text-decoration: underline; } .bb-is-loading { display: flex; align-items: center; justify-content: center; gap: 10px; padding: 28px 14px; font-size: 12.5px; color: var(--bb-text-dim); } .bb-is-spinner { width: 18px; height: 18px; border: 2px solid var(--bb-border); border-top-color: var(--bb-accent); border-radius: 50%; animation: bb-is-spin 0.7s linear infinite; flex: none; } @keyframes bb-is-spin { to { transform: rotate(360deg); } } /* Keep a motion cue for anyone who asked for less of it, just a calmer one. */ @media (prefers-reduced-motion: reduce) { .bb-is-spinner { animation-duration: 2.4s; } } `; const [data, setData] = useState(null); const [open, setOpen] = useState(false); useEffect(() => { let live = true; const tabs = SHEET_GIDS[category] || ({}); const gid = tabs[direction]; if (!gid) return; const url = SHEET_BASE + "?gid=" + encodeURIComponent(gid) + "&single=true&output=csv&_=" + Date.now(); fetch(url, { cache: "no-store" }).then(res => res.ok ? res.text() : Promise.reject(res.status)).then(text => { if (live) setData(parseSheet(text, model) || ({ hide: true })); }).catch(() => { if (live) setData({ hide: true }); }); return () => { live = false; }; }, [category, model, direction]); if (data && data.hide) return null; const none = !!(data && data.none); const verb = direction === "write" ? "writing" : "reading"; const mailto = "mailto:support@bindbee.dev?subject=" + encodeURIComponent("Integration request: " + verb + " " + model + " (" + category + ")"); const collapsible = !!(data && !none && data.supported.length > 4); return
Supported integrations {data && !none ? {data.supported.length} integration{data.supported.length === 1 ? "" : "s"} {collapsible ? : null} : null}
{!data ?
: none ?
No integration supports {verb} {model} yet.{" "} Tell us which one you need
:
{data.supported.map(p => {p.logo ? { e.currentTarget.style.display = "none"; }} /> : null} {p.name} {p.type === "SFTP" ? SFTP : null} )}
{collapsible && !open ? : null}
}
Coverage varies by integrations {" "} See the full availability matrix
; }; * [Identify a Employee Termination](/get-started/use-cases/identify-a-termination) - react to an employee leaving by revoking access, ending coverage, and notifying downstream vendors * [Sync Census Data for Quoting](/get-started/use-cases/sync-census-data) - pull a clean employee census with the demographics carriers need, without over-collecting ## OpenAPI ````yaml get /api/hris/v1/employees openapi: 3.1.0 info: title: Bindbee APIs version: 0.1.0 servers: - url: https://api.bindbee.dev - url: https://api-eu.bindbee.dev security: [] paths: /api/hris/v1/employees: get: tags: - Employee summary: Get Employees description: Returns a list of Employee objects. operationId: get_employees_api_hris_v1_employees_get parameters: - name: ids in: query required: false schema: anyOf: - type: string - type: 'null' description: The ID of employees to fetch examples: - >- 01931edf-04b6-7391-8a5c-93ac4b395316,01931edf-04c8-7649-a470-d85f6161bd1a title: Ids description: The ID of employees to fetch - name: manager_id in: query required: false schema: anyOf: - type: string - type: 'null' description: The ID of managers to fetch employees for examples: - >- 01931edf-04b6-7391-8a5c-93ac4b395316,01931edf-04c8-7649-a470-d85f6161bd1a title: Manager Id description: The ID of managers to fetch employees for - name: remote_id in: query required: false schema: anyOf: - type: string - type: 'null' description: The third-party API ID of the matching object. examples: - '3235005483341316245' title: Remote Id description: The third-party API ID of the matching object. - name: company_id in: query required: false schema: anyOf: - type: string - type: 'null' description: The ID of companies to fetch employees for examples: - >- 01931edf-04b6-7391-8a5c-93ac4b395316,01931edf-04c8-7649-a470-d85f6161bd1a title: Company Id description: The ID of companies to fetch employees for - name: include_raw_data in: query required: false schema: type: boolean description: >- Whether to include the original data Bindbee fetched from the third-party to produce these models. examples: - false default: false title: Include Raw Data description: >- Whether to include the original data Bindbee fetched from the third-party to produce these models. - name: include_custom_fields in: query required: false schema: type: boolean description: Whether to include custom fields in the response. examples: - false default: false title: Include Custom Fields description: Whether to include custom fields in the response. - name: employment_status in: query required: false schema: anyOf: - type: string - type: 'null' description: >- If provided, will only return employees with this employment status. Along with the standard values, any connector specific value returned in the response can be passed as well. Pass several values, comma-separated, to match any of them. examples: - ACTIVE - PENDING - INACTIVE - ACTIVE_EXTERNAL - INACTIVE_EXTERNAL - '-' - LEAVE - DECEASED - RETIRED title: Employment Status description: >- If provided, will only return employees with this employment status. Along with the standard values, any connector specific value returned in the response can be passed as well. Pass several values, comma-separated, to match any of them. - name: employee_number in: query required: false schema: anyOf: - type: string - type: 'null' description: If provided, will only return employees for this employee number examples: - '000000168' title: Employee Number description: If provided, will only return employees for this employee number - name: first_name in: query required: false schema: anyOf: - type: string - type: 'null' description: >- If provided, will only return employees with this first name (case-insensitive) examples: - Jane title: First Name description: >- If provided, will only return employees with this first name (case-insensitive) - name: last_name in: query required: false schema: anyOf: - type: string - type: 'null' description: >- If provided, will only return employees with this last name (case-insensitive) examples: - Doe title: Last Name description: >- If provided, will only return employees with this last name (case-insensitive) - name: work_email in: query required: false schema: anyOf: - type: string - type: 'null' description: >- If provided, will only return employees with this work email (case-insensitive) examples: - jane.doe@acme.com title: Work Email description: >- If provided, will only return employees with this work email (case-insensitive) - name: groups in: query required: false schema: anyOf: - type: string - type: 'null' description: The ID of groups to fetch employees for examples: - >- 01931edf-04b6-7391-8a5c-93ac4b395316,01931edf-04c8-7649-a470-d85f6161bd1a title: Groups description: The ID of groups to fetch employees for - name: work_locations in: query required: false schema: anyOf: - type: string - type: 'null' description: The ID of locations to fetch employees for examples: - >- 01931edf-04b6-7391-8a5c-93ac4b395316,01931edf-04c8-7649-a470-d85f6161bd1a title: Work Locations description: The ID of locations to fetch employees for - name: pay_group_id in: query required: false schema: anyOf: - type: string - type: 'null' description: The ID of pay groups to fetch employees for examples: - >- 01931edf-04b6-7391-8a5c-93ac4b395316,01931edf-04c8-7649-a470-d85f6161bd1a title: Pay Group Id description: The ID of pay groups to fetch employees for - name: page_size in: query required: false schema: type: integer maximum: 200 minimum: 1 description: Number of results to return per page. Maximum size is 200. default: 50 title: Page Size description: Number of results to return per page. Maximum size is 200. - name: cursor in: query required: false schema: anyOf: - type: string - type: 'null' description: The pagination cursor value. title: Cursor description: The pagination cursor value. - name: modified_after in: query required: false schema: anyOf: - type: string - type: 'null' description: >- If provided, only objects synced by Bindbee after this date time will be returned. Format: DateTime (ISO 8601). If no timezone offset is supplied, the value is interpreted as UTC. examples: - '2024-02-21T21:22:12.993Z' title: Modified After description: >- If provided, only objects synced by Bindbee after this date time will be returned. Format: DateTime (ISO 8601). If no timezone offset is supplied, the value is interpreted as UTC. - name: expand in: query required: false schema: anyOf: - type: string - type: 'null' description: >- Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. You can also specify required fields in [] for each relation name. examples: - manager[first_name,last_name] title: Expand description: >- Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. You can also specify required fields in [] for each relation name. responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/PaginatedResponse_HrisEmployeeResponse_' headers: X-RateLimit-Limit: description: Maximum requests allowed in the current window. schema: type: integer X-RateLimit-Remaining: description: Requests remaining in the current window. schema: type: integer X-RateLimit-Reset: description: >- Unix timestamp (seconds since epoch) at which the current rate-limit window resets. schema: type: integer '401': description: Missing or invalid bearer authentication credentials. headers: WWW-Authenticate: description: Bearer authentication challenge. schema: type: string content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '403': description: >- The credentials are valid but do not permit access to this resource, e.g. a connector token used on a different API category or a model whose writes are disabled. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' '429': description: Rate limit exceeded. headers: X-RateLimit-Limit: description: Maximum requests allowed in the current window. schema: type: integer X-RateLimit-Remaining: description: Requests remaining in the current window. schema: type: integer X-RateLimit-Reset: description: >- Unix timestamp (seconds since epoch) at which the current rate-limit window resets. schema: type: integer Retry-After: description: Seconds to wait before retrying the request. schema: type: integer content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' security: - HTTPBearer: [] ConnectorToken: [] components: schemas: PaginatedResponse_HrisEmployeeResponse_: properties: cursor: anyOf: - type: string - type: 'null' title: Cursor description: Cursor value to fetch next set of items examples: - MDE4YjE4ZWYtYzk5Yy03YTg2LTk5NDYtN2I3YzlkNTQzM2U1 page_size: type: integer title: Page Size description: >- The page size the request was served with (0 on an empty page). `items` can be shorter on the last page; `cursor` says whether another page exists. examples: - 50 items: items: $ref: '#/components/schemas/HrisEmployeeResponse' type: array title: Items description: List of items in the current response type: object required: - cursor - page_size - items title: PaginatedResponse[HrisEmployeeResponse] ErrorResponse: type: object required: - detail properties: detail: type: string HTTPValidationError: properties: detail: items: $ref: '#/components/schemas/ValidationError' type: array title: Detail type: object title: HTTPValidationError HrisEmployeeResponse: properties: id: type: string format: uuid title: Id examples: - 018b18ef-c487-703c-afd9-0ca478ccd9d6 remote_id: anyOf: - type: string - type: 'null' title: Remote Id description: The third-party API ID of the matching object. examples: - '123321' modified_at: type: string format: date-time title: Modified At description: This is the datetime that this object was last updated by Bindbee examples: - '2021-10-16T00:00:00Z' raw_data: anyOf: - additionalProperties: true type: object - type: 'null' title: Raw Data description: This is the Raw data examples: - key_1: Platform dependent data 1 key_2: Platform dependent data 2 custom_fields: anyOf: - additionalProperties: true type: object - type: 'null' title: Custom Fields description: The custom fields related to the model examples: - category_group: REG disability_type: ASBERG hire_date: '1991-03-16T00:00:00' hire_source: REFER nationality: USA original_hire_date: '1991-03-16T00:00:00' employee_number: anyOf: - type: string - type: 'null' title: Employee Number description: >- The employee's number that appears in the third-party integration's UI. examples: - '1' company: anyOf: - {} - type: 'null' title: Company description: The ID of the employee's company. examples: - 018af1fe-1250-772d-87c5-6f725a579e8a first_name: anyOf: - type: string - type: 'null' title: First Name description: The employee's first name. examples: - Kunal middle_name: anyOf: - type: string - type: 'null' title: Middle Name description: The employee's middle name. examples: - Christopher last_name: anyOf: - type: string - type: 'null' title: Last Name description: The employee's last name. examples: - Tyagi preferred_name: anyOf: - type: string - type: 'null' title: Preferred Name description: The employee's preferred first name. examples: - Dark Knight display_full_name: anyOf: - type: string - type: 'null' title: Display Full Name description: >- The employee's full name, to use for display purposes. If a preferred first name is available, the full name will include the preferred first name. examples: - Kunal Tyagi username: anyOf: - type: string - type: 'null' title: Username description: The employee's username that appears in the remote UI. examples: - kunaltyagi designation: anyOf: - type: string - type: 'null' title: Designation description: The employee's current designation/title examples: - Chief Technology Officer groups: anyOf: - items: {} type: array - type: 'null' title: Groups description: The IDs of the groups that the employee belongs to. examples: - - 018af1fe-1250-772d-87c5-6f725a579e8a - 018af1fe-1250-772d-87c5-6f725a579e8b department: anyOf: - type: string - type: 'null' title: Department description: The employee's department examples: - Engineering division: anyOf: - type: string - type: 'null' title: Division description: The employee's division examples: - Bangalore Division work_email: anyOf: - type: string - type: 'null' title: Work Email description: The employee's work email. examples: - kunal@bindbee.dev personal_email: anyOf: - type: string - type: 'null' title: Personal Email description: The employee's personal email. examples: - kunaltyagi77@gmail.com mobile_phone_number: anyOf: - type: string - type: 'null' title: Mobile Phone Number description: The employee's mobile phone number. examples: - '+1234567890' home_phone_number: anyOf: - type: string - type: 'null' title: Home Phone Number description: The employee's home phone number. examples: - '+1234567890' country_code: anyOf: - type: string - type: 'null' title: Country Code description: The employee's country code examples: - '+91' home_location: anyOf: - $ref: '#/components/schemas/HrisAddress' - type: 'null' description: The employee's home address. examples: - city: London country: UK location: UK-HO-London name: UK-HO-London postal_code: '56273' state: LND street_1: '1011' street_2: Lane number 4, Golden Villa work_location: anyOf: - $ref: '#/components/schemas/HrisAddress' - type: 'null' description: The employee's work address. examples: - city: London country: UK location: UK-HO-London name: UK-HO-London postal_code: '56273' state: LND street_1: '1011' street_2: Lane number 4, Golden Villa work_locations: anyOf: - items: {} type: array - type: 'null' title: Work Locations description: The IDs of the work locations that the employee belongs to. examples: - - 018af1fe-1250-772d-87c5-6f725a579e8a - 018af1fe-1250-772d-87c5-6f725a579e8b manager: anyOf: - {} - type: 'null' title: Manager description: The employee ID of the employee's manager. examples: - 018aeaff-cc7c-7837-988a-965762bd63c1 pay_group: anyOf: - {} - type: 'null' title: Pay Group description: The employee's pay group examples: - 018af1fe-1250-77c5-9fcd-4bca1e4568f4 ssn: anyOf: - type: string - type: 'null' title: Ssn description: The employee's social security number. examples: - '1234567890' gender: anyOf: - type: string - type: 'null' title: Gender description: >- The employee's gender. If the value is not one of the defined enum values, the original value passed through will be returned. examples: - MALE x-extensible-enum: - MALE - FEMALE - NON-BINARY - OTHER - PREFER_NOT_TO_DISCLOSE - '-' ethnicity: anyOf: - type: string - type: 'null' title: Ethnicity description: >- The employee's ethnicity. If the value is not one of the defined enum values, the original value passed through will be returned. examples: - ASIAN_OR_INDIAN_SUBCONTINENT x-extensible-enum: - AMERICAN_INDIAN_OR_ALASKA_NATIVE - ASIAN_OR_INDIAN_SUBCONTINENT - BLACK_OR_AFRICAN_AMERICAN - HISPANIC_OR_LATINO - NATIVE_HAWAIIAN_OR_OTHER_PACIFIC_ISLANDER - TWO_OR_MORE_RACES - WHITE - PREFER_NOT_TO_DISCLOSE - OTHER - '-' marital_status: anyOf: - type: string - type: 'null' title: Marital Status description: >- The employee's filing status as related to marital status. If the value is not one of the defined enum values, the original value passed through will be returned. examples: - SINGLE x-extensible-enum: - SINGLE - MARRIED - DIVORCED - SEPARATED - COMMON_LAW - DOMESTIC_PARTNERSHIP - WIDOWED - HEAD_OF_HOUSEHOLD - QUALIFYING_WIDOW_OR_WIDOWER_WITH_DEPENDENT_CHILD - IN_A_RELATIONSHIP - CIVIL_PARTNERSHIP - OTHER - '-' tobacco_use: anyOf: - type: boolean - type: 'null' title: Tobacco Use description: Indicates whether the employee uses tobacco or is a smoker. examples: - true date_of_birth: anyOf: - type: string - type: 'null' title: Date Of Birth description: The employee's date of birth. examples: - '1986-10-27T00:00:00Z' start_date: anyOf: - type: string - type: 'null' title: Start Date description: >- The date that the employee started working. If an employee was rehired, the most recent start date will be returned. examples: - '2023-03-05T00:00:00Z' remote_created_at: anyOf: - type: string - type: 'null' title: Remote Created At description: When the third party's employee was created. examples: - '2023-03-01T00:00:00Z' employment_status: anyOf: - type: string - type: 'null' title: Employment Status description: >- The employment status of the employee. If the value is not one of the defined enum values, the original value passed through will be returned. examples: - INACTIVE x-extensible-enum: - ACTIVE - PENDING - INACTIVE - ACTIVE_EXTERNAL - INACTIVE_EXTERNAL - '-' - LEAVE - DECEASED - RETIRED termination_date: anyOf: - type: string - type: 'null' title: Termination Date description: The employee's termination date. examples: - '2023-06-05T00:00:00Z' termination_reason: anyOf: - type: string - type: 'null' title: Termination Reason description: The employee's termination reason. examples: - >- Lorem ipsum dolor sit amet, consectetur adipiscing elit. Sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. avatar: anyOf: - type: string - type: 'null' title: Avatar description: The URL of the employee's avatar image. examples: - http://alturl.com/h2h8m payroll_run_calendar: anyOf: - {} - type: 'null' title: Payroll Run Calendar description: The employee's payroll calendar examples: - 018af1fe-1250-77c5-9fcd-4bca1e4568f4 employment_type: anyOf: - type: string - type: 'null' title: Employment Type description: >- The employee's type of employment. If the value is not one of the defined enum values, the original value passed through will be returned. examples: - FULL_TIME x-extensible-enum: - FULL_TIME - PART_TIME - INTERN - CONTRACTOR - FREELANCE - REGULAR - FURLOUGHED - TERMINATED - '-' type: object required: - id - remote_id - modified_at - custom_fields title: HrisEmployeeResponse ValidationError: properties: loc: items: anyOf: - type: string - type: integer type: array title: Location msg: type: string title: Message type: type: string title: Error Type input: title: Input ctx: type: object title: Context type: object required: - loc - msg - type title: ValidationError HrisAddress: properties: name: anyOf: - type: string - type: 'null' title: Name description: Name of the location examples: - UK-HO-London location: anyOf: - type: string - type: 'null' title: Location description: Location examples: - UK-HO-London street_1: anyOf: - type: string - type: 'null' title: Street 1 description: Street 1 examples: - '1011' street_2: anyOf: - type: string - type: 'null' title: Street 2 description: Street 2 examples: - Lane number 4, Golden Villa city: anyOf: - type: string - type: 'null' title: City description: City examples: - London state: anyOf: - type: string - type: 'null' title: State description: State examples: - LND postal_code: anyOf: - type: string - type: 'null' title: Postal Code description: Postal Code examples: - '56273' country: anyOf: - type: string - type: 'null' title: Country description: Country examples: - UK type: object title: HrisAddress securitySchemes: HTTPBearer: type: http scheme: bearer x-default: description: >- Your Bindbee API key, sent as `Authorization: Bearer `. Required on every request. ConnectorToken: type: apiKey in: header name: X-Connector-Token x-default: description: >- The connector token for one customer's connection. This is not your Bindbee API key. Required on requests that read or write a single customer's data. ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.