Get Integration Account

Retrieves a specific integration account by ID within a workspace.

HTTP Request

GET https://dev.calry.app/api/v1/integration_account/{integrationAccountId}

Headers

Header	Value
Authorization	Bearer YOUR_ACCESS_TOKEN

Path Parameters

Parameter	Required	Type	Description
integrationAccountId	Yes	string	The unique identifier for the integration account.

Example Request

curl --location 'https://dev.calry.app/api/v1/integration_account/18404352-8c25-4a34-a0b9-1faaee53bacc' \
--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 object 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|null): Identifier for the account from your syste,.
• pmsAccountIdentifier (string|null): Identifier for the account generated by hashing the API key.
• syncEnabled (boolean): Indicates if the account is enabled for sync.
• syncPeriod (string): Indicates the sync period for the account.
• linkId (string|null): The identifier of the link used to create this account.
• integrationDefinition (object): The integration definition associated with this account.

Example Response

{
    "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": "12345",
    "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: The integration account information was successfully retrieved.
• 400 Bad Request: The request was invalid or the integrationAccountId was not provided.
• 401 Unauthorized: The request lacks valid authentication credentials.