Get a Link account

get/link/api/link/v1/enterprises/{enterpriseId}/accounts/{accountId}

Retrieves a single Link account by id for an enterprise.

Path Parameters

  • enterpriseIdstringRequired
    Your enterprise id.
    Example: 59cd72485007a239fb00282ed480da1f
    Pattern: ^[0-9a-f]{32}$
    Min length: >= 1 characters
  • accountIdstringRequired
    The account ID to retrieve.
    Example: aba3a693-4f28-4523-8e53-85a3df22a608

200 Response

subAccounts array[object]
id string required
venueId string required
Min length: >= 1 characters
credentials array[object] required
status string required
Allowed values: active inactive deleted pending_credentials
name string required
Min length: >= 1 characters
description string required
Min length: >= 1 characters
whitelistingEnabled boolean required
parentAccount string
users array[object]
createdDate string <date-time>required
modifiedDate string <date-time>required
id string required
venueId string required
Min length: >= 1 characters
credentials array[object] required
id string required
accessLevels array[string] required
Allowed values: read write read_write
expirationDate string
Min length: >= 1 characters
status string required
Allowed values: active inactive deleted pending_credentials
name string required
Min length: >= 1 characters
description string required
Min length: >= 1 characters
whitelistingEnabled boolean required
parentAccount string
users array[object]
permissions array[string] required
Allowed values: link.account.admin link.account.transfer link.account.view
userId string required
Min length: >= 1 characters
createdDate string <date-time>required
modifiedDate string <date-time>required

400 Response

401 Response

errorName string required
error string required

404 Response

errorName string required
error string required

500 Response

errorName string required
error string required