Sign in
latestOpenAPI 3.0.32026-08-224982,0272.8 MB

e445c15e5bee

Policy Builder

List organization policy rules

Lists all policy rules for an organization.

Authorization: Organization admins can access their organization's rules. BitGo admins have access to all organizations.

get/api/policy/v1/organizations/{organizationId}/rules

Path parameters

organizationIdstring required

The organization ID

Query parameters

touchpointsstring

The Touchpoints of the returned policy rules. One or more may be provided. For example, the Transfer from a Wallet Touchpoint. See also the List scope Touchpoints API.

status'PENDING' | 'ACTIVE' | 'INACTIVE' | 'INACTIVE_HIDDEN' | 'DENIED' | 'PENDING_APPROVAL' | 'UNLOCK_PENDING'

Statuses of the returned policy rules, one or more may be provided.

pageinteger

Page number (1-based)

pageSizeinteger

Number of results per page

Response

List of organization policy rules

nextBatchPrevIdstring required

The value to pass as the prevId to the API for getting the next page.

Example response

{
  "rules": [
    {
      "id": "306258df-dcab-489e-a9fe-ff28ce9fa312",
      "uniqueId": "cb4e0a0a-2768-4024-904a-178ca6d2cd54",
      "name": "My first policy rule",
      "status": "ACTIVE",
      "version": 1,
      "touchpointId": "0a244ae3-26cf-48ed-9854-edd5b9751f3e",
      "touchpointLabel": "Transfer from a Wallet",
      "scopeId": "08a3f714-c330-41e6-bd83-bad3a8d37188",
      "scopeLabel": "All Wallets",
      "clauses": [
        {
          "actions": [
            {
              "name": "approvals.always.deny"
            }
          ],
          "conditions": [
            {
              "name": "transfer.amount",
              "parameters": {
                "operator": ">",
                "amount": "100000000",
                "coin": "btc"
              },
              "operator": "AND"
            }
          ]
        }
      ],
      "filteringConditions": [
        {
          "name": "wallet.type"
        }
      ],
      "lockType": "PERMANENT",
      "lockDate": "2023-11-13T14:49:48.830522Z",
      "enterpriseId": "5d1a5f2c8f0a9c001a5f2c8f0ad00000",
      "organizationId": "5d1a5f2c8f0a9c001a5f2c8f0ad00000",
      "lastTriggeredDate": "2023-11-13T14:49:48.830522Z",
      "lastTriggeredEvaluationId": "306258df-dcab-489e-a9fe-ff28ce9fa312",
      "createdBy": "5d1a5f2c8f0a9c001a5f2c8f0ad00000",
      "modifiedBy": "5d1a5f2c8f0a9c001a5f2c8f0ad00000",
      "createdDate": "2023-11-13T14:49:48.830522Z",
      "modifiedDate": "2023-11-13T14:49:48.830522Z",
      "lockModifiedBy": "5d1a5f2c8f0a9c001a5f2c8f0ad00000",
      "evaluationId": "306258df-dcab-489e-a9fe-ff28ce9fa312"
    }
  ]
}