Get Integration Accounts

Retrieves all integration accounts within a specified workspace.

HTTP Request

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

Headers

Header	Value
Authorization	Bearer YOUR_ACCESS_TOKEN

Query Parameters

Parameter	Required	Type	Description
workspaceId	Yes	string	The unique identifier for the workspace.
accountIdentifier	No	string	Identifier for the account from your system.

Example Request

curl --location 'https://dev.calry.app/api/v1/integration_account?workspaceId=0340a5ee-426b-4bdc-91ac-7a3150a03e47' \
--header 'Authorization: Bearer eyJraWQiOiJzLWYzZDhkZTUzLTlhOWYtNDY4NC1hODVhLTY1YjFjMDg0N2MwOCIsInR5cCI6IkpXVCIsImFsZyI6IlJTMjU2In0.eyJpc3MiOiJodHRwOi8vbG9jYWxob3N0OjMwMDAvYXV0aCIsInVzZXJJZCI6IjM2ZTgwNTY4LTkwYTItNDE1OS1iMWI4LTVmNzgwNjY3YWYyMiIsIndvcmtzcGFjZUlkIjoiMDM0MGE1ZWUtNDI2Yi00YmRjLTkxYWMtN2EzMTUwYTAzZTQ3IiwibmFtZSI6InRlc3QiLCJzb3VyY2UiOiJtaWNyb3NlcnZpY2UiLCJpYXQiOjE3MDYxOTg4MzUsImV4cCI6MTcwOTc5ODgzNX0.JEEFXzHl1CikDzkKyzOXYNd-adUWwF1RLljBA99px4FehOADxFz1nYC-7lVl1tgnIPwVt7BUKXDLE-1adNgpNposMvie1a703V_jYXy9J7jrIUBUcPZ8aK4PIDej-wapyApJU-WKkatZp7mSvxeBO3_IqVvxNbHu_TheZpJCxxcu3Em3NVjFynu9JWrlzF-8iiSF6ye7iZlORX-M9YZtdUJ8RWTd46ZUjX2PUV7Uvi8bCRaMaFlAgE04wRpcCb8_8nxVmysJztt9e89WlYWyBIfypBlBSoBSgEKcHoKofbeL7CGgCMltzbmcVi_iI836-esMOzcAiUAQCsrqIwNhpw'

Response

The response is a JSON array with objects containing the following properties:

• integrationAccountId (string): A unique identifier for the Integration Account.
• integrationDefinitionId (string): A unique identifier for the Integration Definition.
• workspaceId (string): A unique identifier for the Workspace.
• integrationAccountName (string): A name for the account to be displayed in the UI.
• deleted (string|null): Indicates if the account is deleted.
• createdAt (string): Timestamp of when the integration account was created.
• updatedAt (string): Timestamp of when the integration account was last updated.
• accountIdentifier (string): Identifier for the account from your system.
• pmsAccountIdentifier (string|null): Identifier for the account generated by hashing the API key.
• syncEnabled (boolean): Indicates if the account is enabled for syncing.
• syncPeriod (string): Indicates the frequency of syncing.
• linkId (string|null): The identifier of the link used to create this account.
• integrationDefinition (object): Integration Definition object.

Example Response

[
    {
        "integrationAccountId": "43e13f0a-017a-4a03-a476-10888cf23097",
        "integrationDefinitionId": "552ccf2b-61f9-4549-b71f-ca9bf5fd7bc1",
        "workspaceId": "1fe8897a-795c-47e7-ad4a-7adb82027bc7",
        "integrationAccountName": "qwert Link_wp6zq",
        "deleted": null,
        "createdAt": "2024-02-01T16:07:31.846Z",
        "updatedAt": "2024-02-01T16:07:31.846Z",
        "accountIdentifier": "sdfwasf",
        "syncEnabled": true,
        "syncPeriod": "EVERY_HOUR",
        "linkId": "a635b284-2509-4e79-8c8d-6f7a9a862415",
        "integrationDefinition": {
            "integrationDefinitionId": "552ccf2b-61f9-4549-b71f-ca9bf5fd7bc1",
            "name": "OwnerRez",
            "key": "ownerrez",
            "icon": "ownerrez.svg",
            "integrationType": "VRS"
        }
    }
    {
        "integrationAccountId": "18404352-8c25-4a34-a0b9-1faaee53bacc",
        "integrationDefinitionId": "1c579b3e-2e49-4b13-bafb-227cd9116add",
        "workspaceId": "0340a5ee-426b-4bdc-91ac-7a3150a03e47",
        "integrationAccountName": "Calry Link_rv2bo",
        "deleted": null,
        "createdAt": "2024-01-25T20:11:50.826Z",
        "updatedAt": "2024-01-25T20:11:50.826Z",
        "accountIdentifier": "123456",
        "syncEnabled": true,
        "syncPeriod": "EVERY_HOUR",
        "linkId": "593fd71b-101a-4094-9d05-b53781d3f3fe",
        "integrationDefinition": {
            "integrationDefinitionId": "1c579b3e-2e49-4b13-bafb-227cd9116add",
            "name": "Hostaway",
            "key": "hostaway",
            "icon": "hostaway.svg",
            "integrationType": "VRS",
        }
    }
]

Response Codes

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