GET
/
v1
/
link
/
{linkId}
curl --request GET \
  --url http://localhost:8000/api/v1/link/{linkId}
{
  "linkId": "<string>",
  "linkName": "<string>",
  "canExpire": true,
  "preferOAuth": true,
  "expiresIn": 123,
  "category": [
    {}
  ],
  "workspaceId": "<string>",
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z",
  "IntegrationAccount": [
    {
      "integrationAccountId": "<string>",
      "integrationDefinitionId": "<string>",
      "integrationConfiguration": {},
      "authType": "<string>",
      "workspaceId": "<string>",
      "integrationAccountName": "<string>",
      "deleted": "2023-11-07T05:31:56Z",
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z",
      "linkId": "<string>"
    }
  ],
  "expired": true,
  "integrationAccounts": [
    {
      "integrationAccountId": "<string>",
      "integrationDefinitionId": "<string>",
      "integrationConfiguration": {},
      "authType": "<string>",
      "workspaceId": "<string>",
      "integrationAccountName": "<string>",
      "deleted": "2023-11-07T05:31:56Z",
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z",
      "linkId": "<string>"
    }
  ],
  "integrationDefinitions": [
    {
      "integrationDefinitionId": "<string>",
      "name": "<string>",
      "key": "<string>",
      "icon": "<string>",
      "version": "<string>",
      "releaseStage": {},
      "sourceUrl": "<string>",
      "integrationType": {},
      "workspaceId": "<string>",
      "deleted": "2023-11-07T05:31:56Z",
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z"
    }
  ]
}

Path Parameters

​
linkId
string
required

A unique identifier for the Link Object

Query Parameters

​
accountIdentifier
string
required

A unique identifier can be passed to identify a group of Accounts. Example: You can pass user_id or random hash.

Response

200
application/json

The response is of type object.