Bindbee · Schema

HrisEmployeeResponse

ATSHR IntegrationHRISWorkforceUnified APIPayrollLMSEmployee DataIntegrations

Properties

Name	Type	Description
id	string
remote_id	object	The third-party API ID of the matching object.
modified_at	string	This is the datetime that this object was last updated by Bindbee
raw_data	object	This is the Raw data
custom_fields	object	The custom fields related to the model
employee_number	object	The employee's number that appears in the third-party integration's UI.
company	object	The ID of the employee's company.
first_name	object	The employee's first name.
middle_name	object	The employee's middle name.
last_name	object	The employee's last name.
preferred_name	object	The employee's preferred first name.
display_full_name	object	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.
username	object	The employee's username that appears in the remote UI.
designation	object	The employee's current designation/title
groups	object	The IDs of the groups that the employee belongs to.
department	object	The employee's department
division	object	The employee's division
work_email	object	The employee's work email.
personal_email	object	The employee's personal email.
mobile_phone_number	object	The employee's mobile phone number.
home_phone_number	object	The employee's home phone number.
country_code	object	The employee's country code
home_location	object	The employee's home address.
work_location	object	The employee's work address.
work_locations	object	The IDs of the work locations that the employee belongs to.
manager	object	The employee ID of the employee's manager.
pay_group	object	The employee's pay group
ssn	object	The employee's social security number.
gender	object	The employee's gender. If the value is not one of the defined enum values, the original value passed through will be returned.
ethnicity	object	The employee's ethnicity. If the value is not one of the defined enum values, the original value passed through will be returned.
marital_status	object	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.
tobacco_use	object	Indicates whether the employee uses tobacco or is a smoker.
date_of_birth	object	The employee's date of birth.
start_date	object	The date that the employee started working. If an employee was rehired, the most recent start date will be returned.
remote_created_at	object	When the third party's employee was created.
employment_status	object	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.
termination_date	object	The employee's termination date.
termination_reason	object	The employee's termination reason.
avatar	object	The URL of the employee's avatar image.
payroll_run_calendar	object	The employee's payroll calendar

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/bindbee/main/json-schema/bindbee-employee-schema.json",
  "title": "HrisEmployeeResponse",
  "x-provenance": {
    "generated": "2026-09-04",
    "method": "derived",
    "source": "openapi/_original/bindbee-openapi.json",
    "source_url": "https://api.bindbee.dev/openapi.json",
    "note": "Extracted verbatim from the provider-published contract, with $refs rewritten from #/components/schemas to #/$defs. Replaces a scaffold whose envelope (data/next_cursor/has_more) does not exist in the Bindbee API \u2014 the real one is cursor/page_size/items."
  },
  "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": "#/$defs/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": "#/$defs/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"
        }
      ],
      "enum": [
        "MALE",
        "FEMALE",
        "NON-BINARY",
        "OTHER",
        "PREFER_NOT_TO_DISCLOSE",
        "-"
      ],
      "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"
      ]
    },
    "ethnicity": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "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",
        "-"
      ],
      "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"
      ]
    },
    "marital_status": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "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",
        "-"
      ],
      "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"
      ]
    },
    "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"
        }
      ],
      "enum": [
        "ACTIVE",
        "PENDING",
        "INACTIVE",
        "ACTIVE_EXTERNAL",
        "INACTIVE_EXTERNAL",
        "-",
        "LEAVE",
        "DECEASED",
        "RETIRED"
      ],
      "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"
      ]
    },
    "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"
      ]
    }
  },
  "type": "object",
  "required": [
    "id",
    "remote_id",
    "modified_at",
    "custom_fields"
  ],
  "$defs": {
    "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"
    }
  }
}

Work with this as data

Every JSON Schema here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for schemas

4 MCP tools reach this

find_json_schemasBrowse and filter every JSON Schema in the catalog.
apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
resolveTurn a domain, URL or GitHub org into the provider it belongs to.
find_cohortsEvery scored population of providers in the catalog.

All 92 tools →

Call it yourself

curl for this page

This JSON Schema

curl "https://apis.io/api/v1/json-schemas/bindbee-employee"

All schemas

curl "https://apis.io/api/v1/json-schemas?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.