Get single connection

GET

Path parameters

connectedAccountIdstringRequired

Headers

x-org-api-keystringRequired

Response

Retrieve details of a specific connected account by its ID

integrationIdstringformat: "uuid"

The ID of the integration to which the connected account belongs. You can get this from the /api/v1/integrations endpoint.

appUniqueIdstring

The unique ID of the app to which the connected account belongs. To get the full app info, you can use the /api/v1/apps endpoint.

idstringformat: "uuid"

The unique identifier for this connected account.

appNamestring

The name of the app this account is connected to. You can get the list of available apps from the /api/v1/apps endpoint.

entityIdstring

The entity ID associated with the connection. Learn more about entities here.

statusenum
Allowed values: INITIATEDACTIVEFAILEDEXPIRED

The current status of the connection (e.g. ‘active’, ‘inactive’, ‘pending’).

createdAtstring

The date and time when the connected account was created.

updatedAtstring

The date and time when the connected account was last updated.

clientUniqueUserIdstringDeprecated

The entityId to which the connected account belongs. **Deprecated: ** Please use the entityId field instead.

memberInfoobjectOptional

Team Member information

metaobjectOptional

Additional information related to the connected account.

isDisabledbooleanOptional

Flag to indicate if the connected account is disabled. If this is true, the connected account will not be able to be used for any actions.

enabledbooleanOptional

Flag to indicate if the connected account is enabled. This will be true if the connected account is active and can be used to perform actions.

Errors

Built with