Skip to content

Get a record dependency

Schedule module

GET/record-dependencies/{id}recordDependencies.get

A dependency between two records. Returns one record dependency with its `ETag`. A record dependency the caller may not see returns 404.

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

Path and query parameters

recordDependencies.get: Path and query parameters
FieldTypeRequiredDescription
idstring (uuid)YesIdentifier of the record dependency.
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: RecordDependency

recordDependencies.get: RecordDependency
FieldTypeRequiredDescription
idstring (uuid)YesIdentifier of the record dependency.
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.
predecessor_idstring (uuid)YesIdentifier of the predecessor record.
successor_idstring (uuid)YesIdentifier of the successor record.
dependency_typestringYesDependency type.Constraints: pattern ^[A-Za-z0-9][A-Za-z0-9._-]{0,63}$
lag_minutesintegerYesLag in minutes; negative for lead.Constraints: range -100000 to any
{
  "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",
  "predecessor_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "successor_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "dependency_type": "finish_to_start",
  "lag_minutes": 0
}

Code samples

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