List whitelisted contracts

GET

https://your-protect-instance.example.com/api/rest/v1/whitelists/contracts

GET

/api/rest/v1/whitelists/contracts

curl https://your-protect-instance.example.com/api/rest/v1/whitelists/contracts \
     -H "Authorization: Bearer <token>"

{
  "result": [
    {
      "id": "string",
      "tenantId": "string",
      "signedContractAddress": {
        "signatures": [
          {
            "signature": {
              "userId": "string",
              "signature": "string",
              "comment": "string"
            },
            "hashes": [
              "string"
            ]
          }
        ],
        "payload": "string"
      },
      "metadata": {
        "hash": "string",
        "payloadAsString": "string"
      },
      "action": "string",
      "trails": [
        {
          "id": "string",
          "userId": "string",
          "externalUserId": "string",
          "action": "string",
          "comment": "string",
          "date": "2024-01-15T09:30:00Z"
        }
      ],
      "rulesContainer": "string",
      "rule": "string",
      "approvers": {
        "parallel": [
          {
            "sequential": [
              {
                "externalGroupID": "string",
                "minimumSignatures": 1
              }
            ]
          }
        ]
      },
      "attributes": [
        {
          "id": "string",
          "key": "string",
          "value": "string",
          "contentType": "string",
          "owner": "string",
          "type": "string",
          "subtype": "string",
          "isfile": true
        }
      ],
      "status": "string",
      "blockchain": "string",
      "network": "string",
      "businessRuleEnabled": true
    }
  ],
  "totalItems": "string"
}

This endpoint returns a list of whitelisted contracts

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Query parameters

limitlongOptional

uint64; Return maximum limit items for a query; Max 100.

offsetlongOptional

uint64; Start retrieving items starting at offset id

querystringOptional

Will find a match in any part of the value. Filter applies to the following fields: customerid, address, blockchain, label, memo, addresstype

blockchainstringOptional

Symbol of the blockchain on which to whitelist an address

includeForApprovalbooleanOptional

If true, include also addresses waiting for approval in the results.

networkstringOptional

Name of the blockchain network, eg. mainnet, testnet, or sepolia

isNFTbooleanOptional

Deprecated: use the kindTypes parameter with 'nft' instead

whitelistedContractAddressIdslist of stringsOptional

uint64; The whitelisted contract IDs to retrieve

kindTypeslist of stringsOptional

Filter on contract kind type, can be nft or token. An empty list means no filtering.

Response

A successful response.

resultlist of objectsOptional

totalItemsstringOptionalformat: "uint64"

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

500

Internal Server Error

503

Service Unavailable Error