Policy Engine

Lists the policies belonging to the developer's CDP Project. Use the scope parameter to filter the policies by scope. The response is paginated, and by default, returns 20 policies per page.

get/v2/policy-engine/policies

Request

  • Base URL: https://api.cdp.coinbase.com/platform
  • URL: https://api.cdp.coinbase.com/platform/v2/policy-engine/policies
  • Auth: HTTP bearer

Query parameters

pageSizeinteger

The number of resources to return per page.

pageTokenstring

The token for the next page of resources, if any.

scope'project' | 'account'

The scope of the policies to return. If project, the response will include exactly one policy, which is the project-level policy. If account, the response will include all account-level policies for the developer's CDP Project.

Response

Successfully listed policies.

nextPageTokenstring

The token for the next page of items, if any.

Example response

{
  "policies": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "description": "Default policy",
      "scope": "project",
      "rules": [
        {
          "action": "accept",
          "operation": "signEvmTransaction",
          "criteria": [
            {
              "type": "ethValue",
              "ethValue": "1000000000000000000",
              "operator": "<="
            },
            {
              "type": "evmAddress",
              "addresses": [
                "0x742d35Cc6634C0532925a3b844Bc454e4438f44e",
                "0x1234567890123456789012345678901234567890"
              ],
              "operator": "in"
            }
          ]
        },
        {
          "action": "accept",
          "operation": "signSolTransaction",
          "criteria": [
            {
              "type": "solAddress",
              "addresses": [
                "HpabPRRCFbBKSuJr5PdkVvQc85FyxyTWkFM2obBRSvHT"
              ],
              "operator": "in"
            }
          ]
        }
      ],
      "createdAt": "2025-03-25T12:00:00Z",
      "updatedAt": "2025-03-26T12:00:00Z"
    }
  ],
  "nextPageToken": "eyJsYXN0X2lkIjogImFiYzEyMyIsICJ0aW1lc3RhbXAiOiAxNzA3ODIzNzAxfQ=="
}

Changes

    • warning

      added the new incompatible_event_types enum value to the response property for the response status

    • warning

      added the new incompatible_event_types enum value to the response property for the response status

    • warning

      added the new incompatible_event_types enum value to the response property for the response status

    • warning

      added the new invalid_webhook_headers enum value to the response property for the response status

    • warning

      added the new invalid_webhook_headers enum value to the response property for the response status

    • warning

      added the new invalid_webhook_headers enum value to the response property for the response status

    • warning

      added the new invalid_webhook_url enum value to the response property for the response status

    • warning

      added the new invalid_webhook_url enum value to the response property for the response status

    • warning

      added the new invalid_webhook_url enum value to the response property for the response status

    • warning

      added the new mandate_action_pending enum value to the response property for the response status

    • warning

      added the new mandate_action_pending enum value to the response property for the response status

    • warning

      added the new mandate_action_pending enum value to the response property for the response status

    • warning

      added the new mandate_canceled enum value to the response property for the response status

    • warning

      added the new mandate_canceled enum value to the response property for the response status

    • warning

      added the new mandate_canceled enum value to the response property for the response status

    • warning

      added the new mandate_expired enum value to the response property for the response status

    • warning

      added the new mandate_expired enum value to the response property for the response status

    • warning

      added the new mandate_expired enum value to the response property for the response status

    • warning

      added the new mandate_invalid_status enum value to the response property for the response status

    • warning

      added the new mandate_invalid_status enum value to the response property for the response status

    • warning

      added the new mandate_invalid_status enum value to the response property for the response status

    • warning

      added the new mandate_policy_violation enum value to the response property for the response status

    • warning

      added the new mandate_policy_violation enum value to the response property for the response status

    • warning

      added the new mandate_policy_violation enum value to the response property for the response status

    • warning

      added the new mandate_revoked enum value to the response property for the response status

    • warning

      added the new mandate_revoked enum value to the response property for the response status

    • warning

      added the new mandate_revoked enum value to the response property for the response status

    • warning

      added the new subscription_limit_exceeded enum value to the response property for the response status

    • warning

      added the new subscription_limit_exceeded enum value to the response property for the response status

    • warning

      added the new subscription_limit_exceeded enum value to the response property for the response status

    • warning

      added the new mfa_challenge_not_found enum value to the response property for the response status

    • warning

      added the new mfa_challenge_not_found enum value to the response property for the response status

    • warning

      added the new mfa_challenge_not_found enum value to the response property for the response status

    • warning

      added the new operation_in_progress enum value to the response property for the response status

    • warning

      added the new operation_in_progress enum value to the response property for the response status

    • warning

      added the new operation_in_progress enum value to the response property for the response status