Get Objective
GET /v2/partner/objectives/{id}
Required scopes
partner:objectives:read
Tokens missing any required scope return 401 scope_missing.
See Auth & Scopes for issuance.
Operation
| Operation ID | getObjective |
| Tags | Outcomes |
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| id * | path | id |
Responses
200
OK
object
| Field | Type | Description |
|---|---|---|
| id * | id | UUID v4. |
| type * | enum (1) | objective |
| team_id * | id | UUID v4. |
| name * | string | |
| key * | string | |
| description | string | |
| benchmark | number | |
| benchmark_kind | enum (2) | ratecount |
| driver_id | string (uuid) | |
| value_cents | integer | |
| is_archived * | boolean | |
| inserted_at * | updated_at | RFC 3339 / ISO 8601 timestamp. |
| updated_at * | updated_at | RFC 3339 / ISO 8601 timestamp. |
| template_ids * | id[] |
Example request
GET https://api.digitalonboarding.com/v2/partner/objectives/{id}
Authorization: Bearer <partner-token>