Get Link

Retrieves details from a specific link, used in public API calls.

HTTP Request

GET https://dev.calry.app/api/v1/link/{linkId}

Headers

Header	Value
Authorization	Bearer YOUR_ACCESS_TOKEN

Path Parameters

Parameter	Required	Type	Description
LinkId	Yes	string	A unique identifier for the Link.

Link Status

SUCCEEDED = 'SUCCEEDED',
FAILED = 'FAILED',
PENDING = 'PENDING',

Response

The response is a JSON object containing the following properties:

• LinkId (string): A unique identifier for the Link.
• LinkName (string): Name of the link, mainly used to easily search for this link in UI.
• canExpire (boolean): To tell if the link can expire.
• expiresIn (number): If canExpire is set to true, this indicates seconds in which the link will expire.
• workspaceId (string): Unique identifier for Workspace.
• createdAt (string): When the Link was created.
• updatedAt (string): When the Link was updated last.
• IntegrationAccount (object[]): Array of associated Integration Accounts.
• expired (boolean): Tells if the link is expired or not.
• status (string): Status of the link (e.g., SUCCEEDED, FAILED, etc.).
• accountIdentifier (string): Identifier for the account.
• redirectUrl (string): URL to redirect to after authentication.
• integrationDefinitionKey (string): The integration definition key associated with this link.
• IntegrationDefinitionId (string): A unique identifier for the Integration Definition.
• IntegrationDefinitions (object[]): Array of associated Integration Definitions.

Response Codes

• 200 OK: Successfully retrieved the link details.
• 400 Bad Request: The request was invalid or missing parameters.
• 401 Unauthorized: The request lacks valid authentication credentials.

Example cURL Request

curl --location 'https://dev.calry.app/api/v1/link/43f579b0-faa9-436f-b976-23cb0701e74d' \
--header 'Authorization: Bearer eyJraWQiOiJzLTc2Mjc5OGM2LTkzYmEtNGNhMC1hZDNlLWEwMWM2ODIyODMyNiIsInR5cCI6IkpXVCIsImFsZyI6IlJTMjU2In0.eyJpc3MiOiJodHRwOi8vbG9jYWxob3N0OjMwMDAvYXV0aCIsInVzZXJJZCI6IjY5MmZiYTg2LTJkMzgtNDAzOC04MWY2LTBkZmVkYWRkY2Q5YiIsIndvcmtzcGFjZUlkIjoiNzNhYTUwZGUtMGNiMi00ZjRlLTk5YjctN2JmMzdmMjU3Y2E2IiwibmFtZSI6IndlZnJ3ZSIsInNvdXJjZSI6Im1pY3Jvc2VydmljZSIsImlhdCI6MTcwNjI4ODQ1OCwiZXhwIjoxNzI4NTEwNjgwfQ.Z4bZJuRBQymkSmZoQzqjwjOTxqpzJVLcSV_DLBHMSv61bgZy3lr-ZMz61drgoAWaH8pXb77sw8mfTCfyVc_2RCxeMeKQJMPBeGyivS4IUyc0N-fBdEeTGb5bff6AVC-YGPPOIWpM2dRpye7pX5B2V_9CUcEi9ZMKxWLJTKr5uHpIkUBQfXg35HcRfvaNVl8CPzc7GfRq7aBK-YtT-9DUDsYvlRXM0FQcqiwgoR4pNeTZh7VvYOhgNAaaJo-Zm5SvLkUnlRG6eHcg6pYe0Ackv5ZZLAzyIAMVXHVUdwuwYUjqE7cLEDSMtSWdeMxs0RiJc2a19XPF8TxhnQNy7485xQ'

Response

{
    "expired": false,
    "linkId": "43f579b0-faa9-436f-b976-23cb0701e74d",
    "linkName": "12qwert",
    "canExpire": false,
    "expiresIn": 0,
    "integrationDefinitionId": "552ccf2b-61f9-4549-b71f-ca9bf5fd7bc1",
    "workspaceId": "1fe8897a-795c-47e7-ad4a-7adb82027bc7",
    "createdAt": "2024-02-01T16:11:07.823Z",
    "updatedAt": "2024-02-01T16:11:29.872Z",
    "status": "SUCCEEDED",
    "accountIdentifier": "qazqazqaz",
    "redirectUrl": "https://calry.app",
    "integrationDefinitionKey": "ownerrez",
    "integrationAccounts": [
        {
            "integrationAccountId": "a2c27400-d956-453f-933c-9245e26cf48f",
            "integrationDefinitionId": "552ccf2b-61f9-4549-b71f-ca9bf5fd7bc1",
            "integrationDefinitionName": "OwnerRez",
            "integrationDefinitionKey": "ownerrez"
        }
    ],
    "integrationDefinitions": [
        {
            "integrationDefinitionId": "552ccf2b-61f9-4549-b71f-ca9bf5fd7bc1",
            "name": "OwnerRez",
            "key": "ownerrez",
            "icon": "ownerrez.svg",
            "integrationType": "VRS"
        }
    ]
}