Skip to main content
Relation fields on a unified model return as Bindbee IDs by default. On the Employee model that includes manager, company, groups, work_locations, pay_group and payroll_run_calendar. Getting a manager’s name would normally mean a second call to Get Employee By Id. expand removes that round trip by returning the related object inline.

​
How expand works

  • Pass one or more relation names, comma separated, with no spaces anywhere in the value.
  • Optionally restrict which fields come back for a relation by listing them in square brackets.

​
Example

Default response, relations as IDs:
The same request with expand=manager[first_name,last_name],company:

​
Limits

  • If you only need a manager’s name to render a row, ask for the name, not the whole employee record.
  • If you still need the related record’s identifier after selecting fields, include id in the bracket list.
  • A relation that is null on the record stays null when expanded.

Reading data

How expand combines with filters, modified_after and pagination.

Filters

Narrow the result set before you expand it.

Pagination

Why expanded responses want a smaller page_size.

Record identity

Relations resolve through Bindbee IDs, not remote_id.