A work location is a site belonging to a single employer, either a Public office or a Remote location. Work-location endpoints are read-only, search-based, and nested under the parent employer resource.

Before you begin

Explore Employer API to learn about employers and work locations in Bob and how to use the API.

Required permissions

To use the Work locations API, make sure the service user or OAuth app has the following access:

Authentication	Permission or scope
Service user (Basic Auth)	`Settings > Employers > View` or `Settings > Employers > Manage`
Marketplace app (OAuth)	`employers:read`

If the caller lacks the required permission or scope, or its source IP is not on the company IP trust list, the API returns 403 Forbidden. To learn more, see Permissions.

Work locations API endpoints

Resource	Endpoint
Metadata	Get work location metadata
Work location details	Search work locations

Work-location metadata is employer-agnostic. Work-location search requires the parent {employerId} in the path. To list employers first, see Employers.

Rate limiting

Rate limits are restrictions that our API imposes on the number of times a user can access our endpoints within a specified period of time. To learn more about rate limiting best practices, see Rate limiting.

Method	Endpoint	Limit per minute
POST	Get work location metadata	60
POST	Search work locations	60