Skip to main content
GET
/
v3
/
qualification-awards
cURL
curl --request GET \
  --url https://api.ctrl-hub.com/v3/qualification-awards \
  --header 'X-Session-Token: <api-key>'
{
  "data": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "type": "<string>",
      "attributes": {
        "status": "assigned",
        "due": "2023-11-07T05:31:56Z",
        "awarded_at": "2023-11-07T05:31:56Z"
      },
      "meta": {
        "created_at": "2023-11-07T05:31:56Z",
        "risks": {
          "current": "none",
          "thresholds": {
            "none": "2023-11-07T05:31:56Z",
            "low": "2023-11-07T05:31:56Z",
            "medium": "2023-11-07T05:31:56Z",
            "high": "2023-11-07T05:31:56Z",
            "critical": "2023-11-07T05:31:56Z"
          },
          "next_check": "2023-11-07T05:31:56Z"
        },
        "is_valid": true,
        "is_latest": true,
        "updated_at": "2023-11-07T05:31:56Z",
        "modified_at": "2023-11-07T05:31:56Z",
        "expires_at": "2023-11-07T05:31:56Z"
      },
      "relationships": {
        "user": {
          "data": {
            "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "type": "<string>"
          }
        },
        "author": {
          "data": {
            "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "type": "<string>"
          }
        },
        "qualification": {
          "data": {
            "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "type": "<string>"
          }
        },
        "assessments": [
          {
            "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "type": "<string>"
          }
        ],
        "renewed_by": {
          "data": {
            "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "type": "<string>"
          }
        },
        "renews": {
          "data": {
            "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "type": "<string>"
          }
        },
        "folder": {
          "data": {
            "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "type": "<string>"
          }
        }
      }
    }
  ],
  "meta": {
    "pagination": {
      "counts": {
        "pages": 123,
        "resources": 123
      },
      "current_page": 123,
      "offsets": {
        "next": 123,
        "previous": 123
      },
      "requested": {
        "limit": 123,
        "offset": 123
      }
    },
    "features": {
      "include": {
        "options": [
          "<string>"
        ]
      }
    }
  },
  "jsonapi": {
    "version": "<string>"
  },
  "included": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "type": "<string>",
      "attributes": {
        "email": "[email protected]",
        "identities": [
          {
            "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "platform": "<string>",
            "meta": {}
          }
        ],
        "profile": {
          "work": {
            "occupation": "<string>",
            "cscs": "<string>",
            "eusr": "<string>",
            "start_date": "2023-12-25"
          },
          "personal": {
            "first_name": "<string>",
            "last_name": "<string>",
            "dob": "2023-12-25",
            "username": "<string>"
          },
          "contact": {
            "mobile": "<string>",
            "landline": "<string>"
          },
          "address": {
            "number": "",
            "street": "<string>",
            "area": "<string>",
            "town": "<string>",
            "county": "<string>",
            "postcode": "<string>",
            "country_code": "<string>",
            "what3words": "<string>"
          },
          "settings": {
            "preferred_language": "en-GB",
            "timezone": "<string>"
          }
        }
      },
      "meta": {
        "grants": [
          "<string>"
        ]
      },
      "relationships": {
        "organisations": {
          "data": [
            {
              "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
              "type": "<string>"
            }
          ]
        },
        "teams": {
          "data": [
            {
              "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
              "type": "<string>"
            }
          ]
        }
      }
    }
  ]
}

Authorizations

​
X-Session-Token
string
header
required

Session token for authentication.

Query Parameters

​
filter
string
default:""

Filters the response data based on the value provided.

Available filters:

  • id_in: Filter qualification awards by ID(s)
  • organisation_in: Filter qualification awards by organisation ID(s)
  • qualification_in: Filter qualification awards by qualification ID(s)
  • risk_in: Filter qualification awards by risk level(s)
  • latest_only: Filter qualification awards to only include the latest awards (useful when awards are renewable)
  • user_in: Filter qualification awards by user ID(s)

For more information on using named filters, see the docs

​
sort
enum<string>[]

A comma separated list of fields to sort by.

Available options:
risk_status,
-risk_status,
awarded_at,
-awarded_at,
expires_at,
-expires_at,
created_at,
-created_at
​
include
enum<string>[]

A comma separated list of related resources to include.

Available options:
organisation,
user,
author,
folder,
qualification,
renews,
renewed_by,
assessments
​
limit
integer<int64>
default:100

Limit the number of resources returned by the API

Required range: x >= 1
​
offset
integer<int64>
default:0

Offset the resources returned by the API

Required range: x >= 0

Response

Get a list of Qualification Awards.

JSON API response object

​
data
A list of qualification awards · object[]
required
​
meta
object
required
​
jsonapi
object
required
​
included
object[]

Related resources that can be included when a qualification award is returned

A user