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

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.

​
organization
object

ObjectID matching arguments.

​
search
object

Search arguments for Subjects query.

​
country
object

ID matching arguments.

​
serialNumber
object

ID matching arguments.

​
RFC
object

ID matching arguments.

​
EVMAddress
object

Hexadecimal matching arguments.

​
createdAt
object

Date range arguments.

​
updatedAt
object

Date range arguments.

​
sort
object

Sort arguments for Subjects query.

​
pagination
object

Pagination arguments.

​
accessScope
enum<string>
Available options:
Organization,
Subject
​
subjects_results_results_wallet_wallet_endorsables_where
object
​
subjects_results_results_wallet_wallet_endorsables_orderBy
string
​
subjects_results_results_wallet_wallet_endorsables_orderDirection
string
​
subjects_results_results_wallet_wallet_endorsables_before
string
​
subjects_results_results_wallet_wallet_endorsables_after
string
​
subjects_results_results_wallet_wallet_endorsables_limit
integer
​
subjects_results_results_wallet_wallet_endorsables_endorsables_items_items_endorseEvents_where
object
​
subjects_results_results_wallet_wallet_endorsables_endorsables_items_items_endorseEvents_orderBy
string
​
subjects_results_results_wallet_wallet_endorsables_endorsables_items_items_endorseEvents_orderDirection
string
​
subjects_results_results_wallet_wallet_endorsables_endorsables_items_items_endorseEvents_before
string
​
subjects_results_results_wallet_wallet_endorsables_endorsables_items_items_endorseEvents_after
string
​
subjects_results_results_wallet_wallet_endorsables_endorsables_items_items_endorseEvents_limit
integer
​
subjects_results_results_wallet_wallet_endorseFromEvents_where
object
​
subjects_results_results_wallet_wallet_endorseFromEvents_orderBy
string
​
subjects_results_results_wallet_wallet_endorseFromEvents_orderDirection
string
​
subjects_results_results_wallet_wallet_endorseFromEvents_before
string
​
subjects_results_results_wallet_wallet_endorseFromEvents_after
string
​
subjects_results_results_wallet_wallet_endorseFromEvents_limit
integer
​
subjects_results_results_wallet_wallet_endorseToEvents_where
object
​
subjects_results_results_wallet_wallet_endorseToEvents_orderBy
string
​
subjects_results_results_wallet_wallet_endorseToEvents_orderDirection
string
​
subjects_results_results_wallet_wallet_endorseToEvents_before
string
​
subjects_results_results_wallet_wallet_endorseToEvents_after
string
​
subjects_results_results_wallet_wallet_endorseToEvents_limit
integer

Response

200 - application/json

Results of an Subjects query.

​
id
string
required
​
info
object
required

Pagination info.

​
results
object[]
required

List of Subjects.