Get a project objective

Módulo Projects

GET/project-objectives/{id}projectObjectives.get

A measurable objective recorded at gate 1 (canon criterion G1.OBJECTIVES_STATED): one target per metric and project, which gate 8 measures against. Once gate 1 is passed only a gate approver (projects.gate.transition) sets, changes or withdraws one; every change is in the audit ledger. Returns one project objective with its `ETag`. A project objective the caller may not see returns 404.

Requiere la capacidad projects.gate.read.
Alcances de OAuth: projects.
Estados de error: 400, 401, 404, 429. Los errores son detalles de problema RFC 9457.

Parámetros de ruta y de consulta

projectObjectives.get: Parámetros de ruta y de consulta
Campo	Tipo	Obligatorio	Descripción
id	string (uuid)	Sí	Identifier of the project objective.
fields	Fields	No	Sparse fieldset: a comma-separated list of top-level fields to return. `id` is always returned.Restricciones: pattern ^[a-z_][a-z0-9_](,[a-z_][a-z0-9_])*$

Respuesta 200: ProjectObjective

projectObjectives.get: ProjectObjective
Campo	Tipo	Obligatorio	Descripción
id	string (uuid)	Sí	Identifier of the project objective.
org_id	string (uuid)	Sí	Identifier of the owning organization, derived from the parent row and never accepted from the caller.
created_at	string (date-time)	Sí	When the row was created.
created_by	string (uuid) \| null	Sí	Identifier of the person who created the row.
updated_at	string (date-time)	Sí	When the row was last updated.
updated_by	string (uuid) \| null	Sí	Identifier of the person who last updated the row.
project_id	string (uuid)	Sí	Identifier of the project.
metric_code	string	Sí	Metric (app.measurement_metrics).Restricciones: pattern ^[a-z][a-z0-9_]*$
direction	"At Least" \| "At Most"	Sí	Met by reaching the target (At Least) or by staying within it (At Most).
target_value	number	Sí	Target figure, in unit_code.
unit_code	string	Sí	Unit of the target, of the metric's dimension.Restricciones: pattern ^[a-z][a-z0-9_]*$
note	string \| null	Sí	Note.Restricciones: length 1 to 2000

{
  "id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "org_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "created_at": "2026-10-08T14:30:00Z",
  "created_by": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "updated_at": "2026-10-08T14:30:00Z",
  "updated_by": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "project_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "metric_code": "waste_generated",
  "direction": "At Most",
  "target_value": 2,
  "unit_code": "kg",
  "note": "Two roll-off containers."
}

Ejemplos de código

curl -X GET "$XOS_BASE_URL/project-objectives/0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f" \
  -H "Authorization: Bearer $XOS_API_KEY"

const { data, etag } = await xos.projectObjectives.get("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f");

response = xos.project_objectives.get("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f")

xos project-objectives get 0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f