Bob's Goals API provide powerful tools for accessing and managing goals and key results in Bob. These endpoints enable searching, creating, updating, and retrieving goals.

Before you begin

Read Explore Goals API to learn how the goals data is organized in Bob and how to use the API, and other Bob APIs to fetch all the information you will need.
Read object-based API model, which introduces our new approach to the APIs, with AI-ready, consistent data structures, predictable references, and self-describing metadata. The Goals API is fully object-based to help you dynamically build requests, making integrations more robust and future-proof

Goals endpoints

Action	Endpoints
Metadata	Get metadata for Goal Types Get metadata for Goals Get metadata for Key Results
Search	Search Goal Types Search Goals Search Key Results
Goals Write	Create Goal Update Goal Delete Goal Update Goal Status
Key-results Write	Create Key Results Update Key Results Details Delete Key Result Update Key Results Progress

Required permissions

The service user accessing the api should be granted the relevant permissions based on the data they need to access. Goals have granular permissions based on the goal type. The service user should be granted the permissions for all the goal types you want to access via the API.

This includes:

Scope	Permission	Notes
Metadata	None	No permissions are required to read the metadata details
Basic access to goals	Features > Goals	Grants access to view, create, edit, and check in goals. This is required for the service user to access goals in general. Must be granted for each goal type explicitly
People's goals	People’s Data > Goals	Grants access to view, create, edit, or check-in goals owned by other employees. This is required for the service user to access people’s goals. Must be granted for each goal type explicitly
Whose goals to access	People’s Data > Access data for	Specify the audience for which this service user will have access. For example, the service user may have permission to access goals owned by other employees, but they still need to define who is included in their scope.

Features > Goals: Grants access to view, create, edit, and check in goals. This is required for the service user to access goals in general. Must be granted for each goal type explicitly.
People’s Data > Goals: Grants access to view, create, edit, or check-in goals owned by other employees. This is required for the service user to access people’s goals. Must be granted for each goal type explicitly.
People’s Data > Access data for: Specify the audience for which this service user will have access. For example, the service user may have permission to access “goals owned by other employees” but they still need to define who is included in their scope.

Notes:

Each permission should be set separately for each goal type, including custom goal types you add.
No need to grant “my own” permissions because the service user is not an employee.

To learn more about how to set permissions for a service user, see Permissions.

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.

Below is a table detailing the rate limits for each endpoint in the Time off endpoints.

Method	Limit request/minute per company
Metadata endpoints	200
Search endpoints	40
Goals create	50
Goal update/status update	100
Key results create	50
Key results update	100
Key results progress update	75
Delete endpoints	50