HIhibob
Employee Tables

List equity grants for a list of employees

Changed on

Returns equity table entries for all employees or a specific list of employees. Each entry in <code>values</code> uses the same schema as <a href="https://apidocs.hibob.com/reference/get_people-id-equities" target="_blank">List the employee's equity grants</a>.<br /> <br /> You can fetch employee IDs using the <a href="https://apidocs.hibob.com/reference/post_people-search" target="_blank">People search</a> endpoint.<br /> <br /> <b>Required permissions</b> <br /> People's Data > People's fields > Payroll / Equity — View (or the equivalent table-level permission under People's fields).<br /> For the employees: People's Data > Access data for > Make sure the employees are in the list. Employees that are not listed and were specifically requested will be listed under <code>errors</code> in the response. <br /> <br /> <b>Pagination</b> <br /> This endpoint uses cursor-based pagination to handle large numbers of table entries. To learn more, see <a href="https://apidocs.hibob.com/docs/pagination" target="_blank">Pagination in Bob's API</a>

get/bulk/people/equities

Request

  • Base URL
    https://api.hibob.com/v1
  • URL
    https://api.hibob.com/v1/bulk/people/equities
  • Auth
    • HTTP basic
    • or HTTP bearer

Query parameters

limitnumber

Specifies the number of table entries to include on each page of the results.

cursorstring

A marker representing the first item on the next page to read. Make sure to URL encode this value before you send it as a query parameter. To learn more, see <a href="https://apidocs.hibob.com/docs/pagination" target="_blank">Pagination in Bob's API</a>.

employeeIdsstring

Comma separated list of employee ids. Maximum employees per request: 200. If this parameter is not passed, the API will return table entries for all the employees for which the service user has the permission for. You can fetch employee IDs using the <a href="https://apidocs.hibob.com/reference/post_people-search" target="_blank">People search</a> endpoint.

includeArchivedboolean

By default (false), archived columns are excluded from the response. When set to true, archived columns are included.

Response

Equity table entries.

Example response

{
  "errors": [
    {
      "error": "MISSING_PERMISSION"
    }
  ]
}

Changes