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
linkId
string
required

A unique identifier for Link

linkName
string
required

Name of the link. Majorly used to easily search for this in UI Example: You can use customer name: Poozle

canExpire
boolean
required

Boolean to tell if the link can expire

preferOAuth
boolean
required

Boolean to tell if only OAuth should be accepted as authentication process

expiresIn
number
required

If canExpire is set to true. This indicates seconds in which the link will expire.

category
object[]
required

Category integration belongs to Example: Ticketing, Documentation etc

workspaceId
string
required

Unique identifier for Workspace.

createdAt
string
required

When the Link was created.

updatedAt
string
required

When the Link was updated last.

IntegrationAccount
object[]

Integration Accounts

expired
boolean
required

Tells if the link is expired or not

integrationAccounts
object[]
integrationDefinitions
object[]