Link
Get link
GET
/
v1
/
link
/
{linkId}
Path Parameters
linkId
string
requiredA unique identifier for the Link Object
Query Parameters
accountIdentifier
string
requiredA 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
requiredA unique identifier for Link
linkName
string
requiredName of the link. Majorly used to easily search for this in UI Example: You can use customer name: Poozle
canExpire
boolean
requiredBoolean to tell if the link can expire
preferOAuth
boolean
requiredBoolean to tell if only OAuth should be accepted as authentication process
expiresIn
number
requiredIf canExpire is set to true. This indicates seconds in which the link will expire.
category
object[]
requiredCategory integration belongs to Example: Ticketing, Documentation etc
workspaceId
string
requiredUnique identifier for Workspace.
createdAt
string
requiredWhen the Link was created.
updatedAt
string
requiredWhen the Link was updated last.
expired
boolean
requiredTells if the link is expired or not
IntegrationAccount
object[]
Integration Accounts
integrationAccounts
object[]
integrationDefinitions
object[]