Certificates

get

Authorizations

Authorization

AuthorizationstringRequired

API Token based authentication. Use format: Token token="your-api-key"

Query parameters

listing_idintegerRequired

Id of the Listing

Responses

200

Getting a listing certificate

application/json

get

/api/v1/certificates

HTTPcURLJavaScriptPython

GET /api/v1/certificates?listing_id=1 HTTP/1.1
Host: REPLACE_ME
Authorization: YOUR_API_KEY
Accept: */*

200

Getting a listing certificate

{
  "certificate": {
    "id": 2,
    "listing_id": 48,
    "name": "Certificate of Training",
    "active": true,
    "template": "Congrats, {{student_name}}!",
    "pdf_settings": {},
    "created_at": "2024/01/01 00:00:00 +0000",
    "updated_at": "2024/01/01 00:00:00 +0000",
    "days_to_expire": null,
    "expires_at": null
  }
}

post

Authorizations

Authorization

AuthorizationstringRequired

API Token based authentication. Use format: Token token="your-api-key"

Body

application/json

days_to_expirestringOptional

Days until the certificate expires after it is awarded. Defaults to null. Must not be present when expires_at is present.

expires_atstringOptional

Date of certificate expiration. Defaults to null. Must not be present when days_to_expire is present.

Responses

201

Creating a certificate

application/json

post

/api/v1/certificates

HTTPcURLJavaScriptPython

POST /api/v1/certificates HTTP/1.1
Host: REPLACE_ME
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 180

{
  "certificate": {
    "listing_id": "text",
    "name": "text",
    "active": "text",
    "template": "text"
  },
  "certificate[pdf_settings]": {
    "orientation": "text"
  },
  "days_to_expire": "text",
  "expires_at": "text"
}

201

Creating a certificate

{
  "certificate": {
    "id": 5,
    "listing_id": 51,
    "name": "API Name",
    "active": true,
    "template": "<H1>This is a template</h1>",
    "pdf_settings": {
      "orientation": "Landscape"
    },
    "created_at": "2024/01/01 00:00:00 +0000",
    "updated_at": "2024/01/01 00:00:00 +0000",
    "days_to_expire": null,
    "expires_at": null
  }
}

delete

Authorizations

Authorization

AuthorizationstringRequired

API Token based authentication. Use format: Token token="your-api-key"

Body

application/json

nullify_requirements_completed_atstringOptional

Should nullify the requirements_completed_at for the enrollments, defaults to false

Responses

204

Deleting a certificate

*/*

delete

/api/v1/certificates

HTTPcURLJavaScriptPython

DELETE /api/v1/certificates HTTP/1.1
Host: REPLACE_ME
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 80

{
  "certificate": {
    "listing_id": "text"
  },
  "nullify_requirements_completed_at": "text"
}

204

Deleting a certificate

{}

put

Authorizations

Authorization

AuthorizationstringRequired

API Token based authentication. Use format: Token token="your-api-key"

Body

application/json

Responses

200

Revoking users certificate

application/json

put

/api/v1/certificates/revoke_users_certificate

HTTPcURLJavaScriptPython

PUT /api/v1/certificates/revoke_users_certificate HTTP/1.1
Host: REPLACE_ME
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 62

{
  "certificate": {
    "listing_id": "text",
    "canvas_user_ids": "text"
  }
}

200

Revoking users certificate

{
  "revoked_certificates": [
    {
      "canvas_user_id": 1,
      "canvas_course_id": 1001,
      "listing_id": 50
    }
  ]
}