Skip to main content
GET
/
v3
/
whoami
cURL
curl --request GET \
  --url https://api.ctrl-hub.com/v3/whoami \
  --header 'X-Session-Token: <api-key>'
{
  "data": {
    "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>"
          }
        ]
      }
    }
  },
  "jsonapi": {
    "version": "<string>"
  },
  "included": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "type": "<string>",
      "attributes": {
        "name": "<string>",
        "slug": "<string>",
        "sandbox": true,
        "settings": {
          "nomenclature": {
            "governance": {
              "schemes": [
                {
                  "singular": "<string>",
                  "plural": "<string>",
                  "language": "<string>"
                }
              ],
              "work_orders": [
                {
                  "singular": "<string>",
                  "plural": "<string>",
                  "language": "<string>"
                }
              ],
              "operations": [
                {
                  "singular": "<string>",
                  "plural": "<string>",
                  "language": "<string>"
                }
              ]
            }
          }
        },
        "description": "<string>"
      },
      "meta": {
        "v3": true,
        "status": "active",
        "created_at": "2023-11-07T05:31:56Z",
        "updated_at": "2023-11-07T05:31:56Z",
        "features": [
          {
            "name": "<string>",
            "enabled": true,
            "limit": 123
          }
        ]
      },
      "relationships": {
        "users": {
          "data": [
            {
              "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
              "type": "<string>"
            }
          ]
        },
        "service_accounts": {
          "data": [
            {
              "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
              "type": "<string>"
            }
          ]
        },
        "groups": {
          "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

include
enum<string>[]

A comma separated list of related resources to include.

Available options:
teams,
organisations

Response

A principal object representing the currently authenticated user.

JSON API response object

data
object
required

A user

jsonapi
object
required
included
object[]

Related resources that can be included when a user is returned

An organisation