Skip to main content
GET
/
v3
/
assessment-definitions
cURL
curl --request GET \
  --url https://api.ctrl-hub.com/v3/assessment-definitions \
  --header 'X-Session-Token: <api-key>'
{
  "data": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "type": "<string>",
      "attributes": {
        "name": "<string>",
        "code": "<string>",
        "timing": "prior_to_starting_work",
        "description": "<string>"
      },
      "relationships": {
        "organisation": {
          "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>"
  }
}

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:

  • eq(id,xxx): Filter assessment definitions by ID.
  • eq(name,xxx): Filter assessment definitions by name.
  • contains(name,xxx): Filter assessment definitions where name contains value.
  • eq(code,xxx): Filter assessment definitions by code.
  • contains(code,xxx): Filter assessment definitions where code contains value.
  • eq(organisation,xxx): Filter assessment definitions by organisation ID.
  • eq(created_at,xxx): Filter assessment definitions by created date.

For more information on using named filters, see the docs

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 assessment definitions.

JSON API response object

data
A list of assessment definitions · object[]
required
meta
object
required
jsonapi
object
required