Skip to content

Get a scope node

Projects module

GET/scope-nodes/{id}scopeNodes.get

A node of the project scope tree: engagement root, standing venue or show. Returns one scope node with its `ETag`. A scope node the caller may not see returns 404.

  • Requires the capability projects.project.read.
  • OAuth scopes: projects.
  • Error statuses: 400, 401, 404, 429. Errors are RFC 9457 problem details.

Path and query parameters

scopeNodes.get: Path and query parameters
FieldTypeRequiredDescription
idstring (uuid)YesIdentifier of the scope node.
fieldsFieldsNoSparse fieldset: a comma-separated list of top-level fields to return. `id` is always returned.Constraints: pattern ^[a-z_][a-z0-9_]*(,[a-z_][a-z0-9_]*)*$

Response 200: ScopeNode

scopeNodes.get: ScopeNode
FieldTypeRequiredDescription
idstring (uuid)YesIdentifier of the scope node.
org_idstring (uuid)YesIdentifier of the owning organization, derived from the parent row and never accepted from the caller.
created_atstring (date-time)YesWhen the row was created.
created_bystring (uuid) | nullYesIdentifier of the person who created the row; null when a seed, platform or system process created it.
updated_atstring (date-time)YesWhen the row was last updated.
updated_bystring (uuid) | nullYesIdentifier of the person who last updated the row; null when a seed, platform or system process updated it.
project_idstring (uuid)YesIdentifier of the project.
parent_idstring (uuid) | nullYesIdentifier of the parent scope node.
scope_codestringYesScope code, unique in the project.Constraints: pattern ^[A-Za-z0-9][A-Za-z0-9._-]{0,63}$
namestringYesScope node name.Constraints: length 1 to 300
node_kindstringYesKind of node. A Title Case value from the lifecycle's database enum.Constraints: pattern ^[A-Z0-9][A-Za-z0-9&'/.()-]*( [A-Za-z0-9&'/.()-]+)*$
pathstringYesMaterialized ltree path, derived.Constraints: pattern ^[A-Za-z0-9][A-Za-z0-9._-]{0,63}$
{
  "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",
  "parent_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "scope_code": "E01",
  "name": "Opening Weekend",
  "node_kind": "Show",
  "path": "root.e01"
}

Code samples

curl -X GET "$XOS_BASE_URL/scope-nodes/0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f" \
  -H "Authorization: Bearer $XOS_API_KEY"
const { data, etag } = await xos.scopeNodes.get("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f");
response = xos.scope_nodes.get("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f")
xos scope-nodes get 0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f