Get All Links

Retrieves all links within a specified workspace.

HTTP Request

GET https://dev.calry.app/api/v1/link

Headers

Header	Value
Authorization	Bearer YOUR_ACCESS_TOKEN

Query Parameters

Parameter	Required	Type	Description
workspaceId	Yes	string	Unique identifier for Workspace.

Link Status

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

Response

The response is a array of 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.
• expired (boolean): Tells if the link is expired or not.
• IntegrationDefinitionId (string): A unique identifier for the Integration Definition.
• accountIdentifier (string): Identifier for the account.
• redirectUrl (string): URL to redirect to after authentication.
• status (string): Status of the link (SUCCEEDED, PENDING, or FAILED).

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?workspaceId=73aa50de-0cb2-4f4e-99b7-7bf37f257ca6' \
--header 'Authorization: Bearer eyJraWQiOiJzLTc2Mjc5OGM2LTkzYmEtNGNhMC1hZDNlLWEwMWM2ODIyODMyNiIsInR5cCI6IkpXVCIsImFsZyI6IlJTMjU2In0.eyJpc3MiOiJodHRwOi8vbG9jYWxob3N0OjMwMDAvYXV0aCIsInVzZXJJZCI6IjY5MmZiYTg2LTJkMzgtNDAzOC04MWY2LTBkZmVkYWRkY2Q5YiIsIndvcmtzcGFjZUlkIjoiNzNhYTUwZGUtMGNiMi00ZjRlLTk5YjctN2JmMzdmMjU3Y2E2IiwibmFtZSI6IndlZnJ3ZSIsInNvdXJjZSI6Im1pY3Jvc2VydmljZSIsImlhdCI6MTcwNjI4ODQ1OCwiZXhwIjoxNzI4NTEwNjgwfQ.Z4bZJuRBQymkSmZoQzqjwjOTxqpzJVLcSV_DLBHMSv61bgZy3lr-ZMz61drgoAWaH8pXb77sw8mfTCfyVc_2RCxeMeKQJMPBeGyivS4IUyc0N-fBdEeTGb5bff6AVC-YGPPOIWpM2dRpye7pX5B2V_9CUcEi9ZMKxWLJTKr5uHpIkUBQfXg35HcRfvaNVl8CPzc7GfRq7aBK-YtT-9DUDsYvlRXM0FQcqiwgoR4pNeTZh7VvYOhgNAaaJo-Zm5SvLkUnlRG6eHcg6pYe0Ackv5ZZLAzyIAMVXHVUdwuwYUjqE7cLEDSMtSWdeMxs0RiJc2a19XPF8TxhnQNy7485xQ'

Response

[
    {
        "expired": false,
        "linkId": "b4c35000-d1a2-4c6e-ae25-9c7ffe8c620d",
        "linkName": "Guest Link",
        "canExpire": false,
        "expiresIn": 3600,
        "integrationDefinitionId": "505ce0cc-b06b-454f-81ab-b6793a394db0",
        "workspaceId": "1fe8897a-795c-47e7-ad4a-7adb82027bc7",
        "createdAt": "2024-02-01T07:30:22.502Z",
        "updatedAt": "2024-02-01T07:31:35.613Z",
        "status": "SUCCEEDED",
        "accountIdentifier": "Random-323433761-4216-9d0f",
        "redirectUrl": "https://nevada.poperties.com"
    },
    {
        "expired": false,
        "linkId": "b97251ef-9fbe-4504-8e3d-bd4b842e56e3",
        "linkName": "New Link",
        "canExpire": false,
        "expiresIn": 3600,
        "integrationDefinitionId": "505ce0cc-b06b-454f-81ab-b6793a394db0",
        "workspaceId": "1fe8897a-795c-47e7-ad4a-7adb82027bc7",
        "createdAt": "2024-02-01T08:04:33.856Z",
        "updatedAt": "2024-02-01T08:04:33.856Z",
        "status": "PENDING",
        "accountIdentifier": "New-323433761-4216-9d0f",
        "redirectUrl": "https://calry.app"
    },
]