Skip to content

Read certificate

Reads one certificate issued to the customer.

Needs the read scope.

Call

  • Tool: get_certificate
  • Scope: read
  • Reads only.
  • Acts on a store.

Arguments

Name Type Required Description
product object Yes
certificate object Yes
{
  "type": "object",
  "properties": {
    "product": {
      "anyOf": [
        {
          "type": "object",
          "properties": {
            "id": {
              "type": "string",
              "minLength": 1,
              "maxLength": 512
            }
          },
          "required": [
            "id"
          ],
          "additionalProperties": false
        },
        {
          "type": "object",
          "properties": {
            "slug": {
              "type": "string",
              "minLength": 1,
              "maxLength": 512
            }
          },
          "required": [
            "slug"
          ],
          "additionalProperties": false
        }
      ]
    },
    "certificate": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string",
          "minLength": 1,
          "maxLength": 512
        }
      },
      "required": [
        "id"
      ],
      "additionalProperties": false
    }
  },
  "required": [
    "product",
    "certificate"
  ],
  "additionalProperties": false
}

Answer

Name Type Required Description
holder string or null Yes
certificate object Yes
product object or null Yes
id string Yes
product_id string Yes
certificate_id string Yes
score number or null Yes
attempt number or null Yes
issued_at string Yes

The answer’s full shape is on its API reference page.

Type to search…

↑↓ navigate↵ selectEsc close