Team / Integrations /

Get VCS link session

Gets the status of a version control link session, for polling until completion.

Required permission

Account > Git > General > Manage

Path parameters

Response body

status
string required
Current status of the link session.
one of
pending, completed, failed
vcsLinkId
string
ID of the created version control link. Present when `status` is `completed`.
error
string
Reason the link failed. Present when `status` is `failed`.

API

CLI

JS Client

GET /v1/integrations/vcs/link-sessions/{linkSessionId}

GET /v1/teams/{teamId}/integrations/vcs/link-sessions/{linkSessionId}

Example response

200 OK

The status of the link session.

JSON

{
  "data": {
    "status": "pending",
    "vcsLinkId": "63ebb6ce2ccc6c7affdbf253",
    "error": "Failed to link version control account"
  }
}