Ctrl+K

List touchpoints

get/api/policy/v1/enterprises/{enterpriseId}/scopes/{scopeId}/touchpoints

Lists all touchpoints for a given scope.

Path Parameters

  • enterpriseIdstringRequired
    Your Enterprise Id.
  • scopeIdstringRequired
    The id of the scope.

200 Response

page integer required
Page number. Page numbers start at 1.
totalPages integer required
Total number of pages. Total pages start at 1.
totalElements integer required
Total number of elements across all pages.
touchpoints array[object]
id string required
Id of the Touchpoint. A UUID.
Example: 306258df-dcab-489e-a9fe-ff28ce9fa312
name string required
Name of the Touchpoint.
Allowed values: wallet.segregated.transfer policies.management.edit
Example: wallet.segregated.transfer
label string required
A label for the Touchpoint which can be shown to an end user.
Example: Transfer from a Segregated Wallet
description string required
A description for the Touchpoint which can be shown to an end user.
Example: When transferring from a BitGo Segregated Wallet
status string required
Status of the Touchpoint. Indicates if the Touchpoint is usable "ACTIVE" or not "INACTIVE". * "ACTIVE" - The Touchpoint is available for use. * "INACTIVE" - The Touchpoint is NOT available for use.
Allowed values: ACTIVE INACTIVE
Example: ACTIVE
adminOnly boolean required
true, if this is an internal Touchpoint, false otherwise.
Example: false

401 Response

code string
message string
status integer

403 Response

code string
message string
status integer

404 Response

code string
message string
status integer

500 Response

code string
message string
status integer