Skip to main content
GET
/
witnesses
cURL
curl --request GET \
  --url https://api.plumaa.id/rest/v1/witnesses \
  --header 'Authorization: Bearer <token>'
{
  "id": "<string>",
  "info": {
    "id": "<string>",
    "count": "<unknown>",
    "pages": "<unknown>",
    "next": "<unknown>",
    "prev": "<unknown>"
  },
  "results": [
    {
      "id": "<unknown>",
      "hash": "<unknown>",
      "algorithm": "SHA256",
      "organization": {
        "id": "<unknown>",
        "name": "<string>",
        "logo": "<unknown>",
        "emailAddress": "<unknown>",
        "createdAt": "<unknown>",
        "updatedAt": "<unknown>",
        "quota": {
          "id": "<unknown>",
          "API": true,
          "groupedNOM151": 123,
          "nom151": 123
        },
        "policies": {
          "signatureRequest": {
            "conservation": "NOM151"
          }
        }
      },
      "createdAt": "<unknown>",
      "updatedAt": "<unknown>",
      "initialOwner": {
        "id": "<unknown>",
        "commonName": "<string>",
        "serialNumber": "<string>",
        "RFC": "<string>",
        "EVMAddress": "<unknown>",
        "createdAt": "<unknown>",
        "updatedAt": "<unknown>",
        "country": "<unknown>",
        "emailAddress": "<unknown>",
        "certificate": {
          "id": "<unknown>",
          "serialNumber": "<unknown>",
          "issuer": {
            "id": "<unknown>",
            "hash": "<unknown>",
            "commonName": "<string>",
            "publicKey": {
              "exponent": "<unknown>",
              "modulus": "<unknown>"
            },
            "certificatePem": "<string>",
            "createdAt": "<unknown>",
            "updatedAt": "<unknown>",
            "RFC": "<string>",
            "organization": "<string>",
            "organizationalUnitName": "<string>",
            "emailAddress": "<unknown>",
            "streetAddress": "<string>",
            "postalCode": 123,
            "country": "<unknown>",
            "stateOrProvinceName": "<string>",
            "localityName": "<string>"
          },
          "notBefore": "<unknown>",
          "notAfter": "<unknown>",
          "subject": "<unknown>",
          "publicKey": {
            "exponent": "<unknown>",
            "modulus": "<unknown>"
          },
          "version": "<unknown>",
          "hash": "<unknown>",
          "certificatePem": "<string>",
          "revoked": true,
          "createdAt": "<unknown>",
          "updatedAt": "<unknown>"
        },
        "termsInvite": {
          "id": "<unknown>",
          "signatureRequest": {
            "id": "<unknown>",
            "draft": true,
            "finalized": true,
            "name": "<string>",
            "content": {
              "id": "<unknown>",
              "raw": "<unknown>"
            },
            "anonymousKey": "<string>",
            "organization": {
              "id": "<unknown>",
              "name": "<string>",
              "logo": "<unknown>",
              "emailAddress": "<unknown>",
              "createdAt": "<unknown>",
              "updatedAt": "<unknown>",
              "quota": {
                "id": "<unknown>",
                "API": true,
                "groupedNOM151": 123,
                "nom151": 123
              },
              "policies": {
                "signatureRequest": {
                  "conservation": "NOM151"
                }
              }
            },
            "witness": "<unknown>",
            "invites": "<array>",
            "signed": "<unknown>",
            "pending": "<unknown>",
            "rejected": "<unknown>",
            "createdAt": "<unknown>",
            "updatedAt": "<unknown>",
            "rejectedAt": "<unknown>"
          },
          "subject": "<unknown>",
          "status": "PENDING",
          "createdAt": "<unknown>",
          "updatedAt": "<unknown>",
          "certificate": {
            "id": "<unknown>",
            "serialNumber": "<unknown>",
            "issuer": {
              "id": "<unknown>",
              "hash": "<unknown>",
              "commonName": "<string>",
              "publicKey": {
                "exponent": "<unknown>",
                "modulus": "<unknown>"
              },
              "certificatePem": "<string>",
              "createdAt": "<unknown>",
              "updatedAt": "<unknown>",
              "RFC": "<string>",
              "organization": "<string>",
              "organizationalUnitName": "<string>",
              "emailAddress": "<unknown>",
              "streetAddress": "<string>",
              "postalCode": 123,
              "country": "<unknown>",
              "stateOrProvinceName": "<string>",
              "localityName": "<string>"
            },
            "notBefore": "<unknown>",
            "notAfter": "<unknown>",
            "subject": "<unknown>",
            "publicKey": {
              "exponent": "<unknown>",
              "modulus": "<unknown>"
            },
            "version": "<unknown>",
            "hash": "<unknown>",
            "certificatePem": "<string>",
            "revoked": true,
            "createdAt": "<unknown>",
            "updatedAt": "<unknown>"
          },
          "signature": "<unknown>",
          "ocspResponse": "<unknown>",
          "witness": "<unknown>",
          "rejectedAt": "<unknown>",
          "signedAt": "<unknown>"
        },
        "pushNotificationToken": "<string>",
        "wallet": {
          "id": "<string>",
          "endorsables": {
            "items": [
              {
                "id": "<unknown>",
                "ownerId": "<string>",
                "timestamp": 123,
                "network": 123,
                "owner": "<unknown>",
                "endorseEvents": {
                  "items": [
                    {
                      "id": "<string>",
                      "timestamp": 123,
                      "fromId": "<string>",
                      "toId": "<string>",
                      "digest": "<unknown>",
                      "network": 123,
                      "from": "<unknown>",
                      "to": "<unknown>",
                      "token": "<unknown>"
                    }
                  ],
                  "pageInfo": {
                    "hasNextPage": true,
                    "hasPreviousPage": true,
                    "startCursor": "<string>",
                    "endCursor": "<string>"
                  }
                },
                "witness": "<unknown>"
              }
            ],
            "pageInfo": {
              "hasNextPage": true,
              "hasPreviousPage": true,
              "startCursor": "<string>",
              "endCursor": "<string>"
            }
          },
          "endorseFromEvents": {
            "items": [
              {
                "id": "<string>",
                "timestamp": 123,
                "fromId": "<string>",
                "toId": "<string>",
                "digest": "<unknown>",
                "network": 123,
                "from": "<unknown>",
                "to": "<unknown>",
                "token": "<unknown>"
              }
            ],
            "pageInfo": {
              "hasNextPage": true,
              "hasPreviousPage": true,
              "startCursor": "<string>",
              "endCursor": "<string>"
            }
          },
          "endorseToEvents": {
            "items": [
              {
                "id": "<string>",
                "timestamp": 123,
                "fromId": "<string>",
                "toId": "<string>",
                "digest": "<unknown>",
                "network": 123,
                "from": "<unknown>",
                "to": "<unknown>",
                "token": "<unknown>"
              }
            ],
            "pageInfo": {
              "hasNextPage": true,
              "hasPreviousPage": true,
              "startCursor": "<string>",
              "endCursor": "<string>"
            }
          },
          "subject": "<unknown>"
        }
      },
      "claiming": {
        "id": "<unknown>",
        "authorizer": "<unknown>",
        "signature": "<unknown>",
        "claimer": "<unknown>",
        "network": "<unknown>",
        "createdAt": "<unknown>",
        "updatedAt": "<unknown>"
      },
      "claimed": true,
      "signatureRequest": {
        "id": "<unknown>",
        "draft": true,
        "finalized": true,
        "name": "<string>",
        "content": {
          "id": "<unknown>",
          "raw": "<unknown>"
        },
        "anonymousKey": "<string>",
        "organization": {
          "id": "<unknown>",
          "name": "<string>",
          "logo": "<unknown>",
          "emailAddress": "<unknown>",
          "createdAt": "<unknown>",
          "updatedAt": "<unknown>",
          "quota": {
            "id": "<unknown>",
            "API": true,
            "groupedNOM151": 123,
            "nom151": 123
          },
          "policies": {
            "signatureRequest": {
              "conservation": "NOM151"
            }
          }
        },
        "witness": "<unknown>",
        "invites": "<array>",
        "signed": "<unknown>",
        "pending": "<unknown>",
        "rejected": "<unknown>",
        "createdAt": "<unknown>",
        "updatedAt": "<unknown>",
        "rejectedAt": "<unknown>"
      },
      "nom151": {
        "createdAt": "<unknown>",
        "updatedAt": "<unknown>",
        "provider": "CINCEL"
      },
      "merkleized": {
        "createdAt": "<unknown>",
        "updatedAt": "<unknown>",
        "txHash": "<unknown>",
        "network": "<unknown>",
        "merkleProof": [
          "<unknown>"
        ],
        "merkleRoot": "<unknown>",
        "nom151Provider": "CINCEL",
        "algorithm": "SHA256"
      },
      "witnessCo": {
        "timestamp": "<unknown>",
        "leafIndex": "<unknown>",
        "leftHashes": [
          "<unknown>"
        ],
        "rightHashes": [
          "<unknown>"
        ],
        "targetRootHash": "<unknown>",
        "createdAt": "<unknown>",
        "updatedAt": "<unknown>"
      },
      "timestampedAt": "<unknown>",
      "endorsable": {
        "id": "<unknown>",
        "ownerId": "<string>",
        "timestamp": 123,
        "network": 123,
        "owner": "<unknown>",
        "endorseEvents": {
          "items": [
            {
              "id": "<string>",
              "timestamp": 123,
              "fromId": "<string>",
              "toId": "<string>",
              "digest": "<unknown>",
              "network": 123,
              "from": "<unknown>",
              "to": "<unknown>",
              "token": "<unknown>"
            }
          ],
          "pageInfo": {
            "hasNextPage": true,
            "hasPreviousPage": true,
            "startCursor": "<string>",
            "endCursor": "<string>"
          }
        },
        "witness": "<unknown>"
      }
    }
  ]
}

Documentation Index

Fetch the complete documentation index at: https://docs.plumaa.id/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

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

Query Parameters

​
_id
object

ObjectID matching arguments.

​
hash
object

Hexadecimal matching arguments.

​
algorithm
object

WitnessHashingAlgorithm matching arguments.

​
claimable
boolean
​
claimed
boolean
​
initialOwner
object

ObjectID matching arguments.

​
organization
object

ObjectID matching arguments.

​
nom151
object

Witness NOM151 Strategy matching arguments.

​
merkleized
object

Witness Merkleized Strategy matching arguments.

​
createdAt
object

Date range arguments.

​
updatedAt
object

Date range arguments.

​
sort
object
​
pagination
object

Pagination arguments.

​
witnesses_results_results_endorsable_endorsable_owner_owner_endorsables_where
object
​
witnesses_results_results_endorsable_endorsable_owner_owner_endorsables_orderBy
string
​
witnesses_results_results_endorsable_endorsable_owner_owner_endorsables_orderDirection
string
​
witnesses_results_results_endorsable_endorsable_owner_owner_endorsables_before
string
​
witnesses_results_results_endorsable_endorsable_owner_owner_endorsables_after
string
​
witnesses_results_results_endorsable_endorsable_owner_owner_endorsables_limit
integer<int32>
​
witnesses_results_results_endorsable_endorsable_owner_owner_endorseFromEvents_where
object
​
witnesses_results_results_endorsable_endorsable_owner_owner_endorseFromEvents_orderBy
string
​
witnesses_results_results_endorsable_endorsable_owner_owner_endorseFromEvents_orderDirection
string
​
witnesses_results_results_endorsable_endorsable_owner_owner_endorseFromEvents_before
string
​
witnesses_results_results_endorsable_endorsable_owner_owner_endorseFromEvents_after
string
​
witnesses_results_results_endorsable_endorsable_owner_owner_endorseFromEvents_limit
integer<int32>
​
witnesses_results_results_endorsable_endorsable_owner_owner_endorseToEvents_where
object
​
witnesses_results_results_endorsable_endorsable_owner_owner_endorseToEvents_orderBy
string
​
witnesses_results_results_endorsable_endorsable_owner_owner_endorseToEvents_orderDirection
string
​
witnesses_results_results_endorsable_endorsable_owner_owner_endorseToEvents_before
string
​
witnesses_results_results_endorsable_endorsable_owner_owner_endorseToEvents_after
string
​
witnesses_results_results_endorsable_endorsable_owner_owner_endorseToEvents_limit
integer<int32>
​
witnesses_results_results_endorsable_endorsable_endorseEvents_where
object
​
witnesses_results_results_endorsable_endorsable_endorseEvents_orderBy
string
​
witnesses_results_results_endorsable_endorsable_endorseEvents_orderDirection
string
​
witnesses_results_results_endorsable_endorsable_endorseEvents_before
string
​
witnesses_results_results_endorsable_endorsable_endorseEvents_after
string
​
witnesses_results_results_endorsable_endorsable_endorseEvents_limit
integer<int32>
​
witnesses_results_results_endorsable_endorsable_endorseEvents_endorseEvents_items_items_from_from_endorsables_where
object
​
witnesses_results_results_endorsable_endorsable_endorseEvents_endorseEvents_items_items_from_from_endorsables_orderBy
string
​
witnesses_results_results_endorsable_endorsable_endorseEvents_endorseEvents_items_items_from_from_endorsables_orderDirection
string
​
witnesses_results_results_endorsable_endorsable_endorseEvents_endorseEvents_items_items_from_from_endorsables_before
string
​
witnesses_results_results_endorsable_endorsable_endorseEvents_endorseEvents_items_items_from_from_endorsables_after
string
​
witnesses_results_results_endorsable_endorsable_endorseEvents_endorseEvents_items_items_from_from_endorsables_limit
integer<int32>
​
witnesses_results_results_endorsable_endorsable_endorseEvents_endorseEvents_items_items_to_to_endorsables_where
object
​
witnesses_results_results_endorsable_endorsable_endorseEvents_endorseEvents_items_items_to_to_endorsables_orderBy
string
​
witnesses_results_results_endorsable_endorsable_endorseEvents_endorseEvents_items_items_to_to_endorsables_orderDirection
string
​
witnesses_results_results_endorsable_endorsable_endorseEvents_endorseEvents_items_items_to_to_endorsables_before
string
​
witnesses_results_results_endorsable_endorsable_endorseEvents_endorseEvents_items_items_to_to_endorsables_after
string
​
witnesses_results_results_endorsable_endorsable_endorseEvents_endorseEvents_items_items_to_to_endorsables_limit
integer<int32>

Response

200 - application/json

Results of a Witnesses query.

​
id
string
required
​
info
object
required

Pagination info.

​
results
object[]
required

List of Witnesses.