DEVELOPER DOCUMENTATION

Get Project Link

Retrieve one project link by ID.

GET/api/partner/v1/project-links/{linkId}

Retrieves one project link on the calling token’s install.

Requirements: project-links:read scope (implied by project-links:write).

Request

linkIdstringpathrequired

The project link ID, from create or list.

Response

projectLinkobject

ProjectLink fields

idstring

Link ID.

jobIdstring | null

The linked OpenTrain job, or null if the link is not job-bound yet.

externalProjectIdstring

Your project’s identifier — unique per install.

externalProjectNamestring | null

Human-readable project name.

externalProjectUrlstring | null

Deep link to the project in your platform.

provisioningModestring

PARTNER_WEBHOOK or MANAGED_ADAPTER — see provisioning modes.

createdAtstring

ISO 8601 creation timestamp.

Errors

Status	`code`	Meaning
`401`	`UNAUTHORIZED`	Missing, invalid, or revoked token
`403`	`FORBIDDEN`	Token lacks `project-links:read`
`404`	`NOT_FOUND`	No link with this ID on this install

Request examples

curl -sS https://app.opentrain.ai/api/partner/v1/project-links/<LINK_ID> \
  -H "Authorization: Bearer $OT_PARTNER_TOKEN"

Response examples

{
  "projectLink": {
    "id": "<LINK_ID>",
    "jobId": "<OPENTRAIN_JOB_ID>",
    "externalProjectId": "42",
    "externalProjectName": "Traffic signs batch 3",
    "externalProjectUrl": "https://your-platform.example.com/projects/42",
    "provisioningMode": "PARTNER_WEBHOOK",
    "createdAt": "2026-06-12T10:00:00.000Z"
  }
}