Skip to main content
GET
/
v3
/
grants
cURL
curl --request GET \
  --url https://api.ctrl-hub.com/v3/grants \
  --header 'X-Session-Token: <api-key>'
{
  "data": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "type": "<string>",
      "attributes": {
        "type": "role",
        "subject": "<string>",
        "scope": {
          "attributes": [
            {
              "name": "<string>",
              "operation": "=",
              "value": "<string>"
            }
          ],
          "patterns": [
            {
              "name": "<string>",
              "matcher": "prefix",
              "operation": "=",
              "value": "<string>"
            }
          ]
        },
        "reason": "<string>",
        "expires_at": "2023-11-07T05:31:56Z",
        "starts_at": "2023-11-07T05:31:56Z"
      },
      "meta": {
        "created_at": "2023-11-07T05:31:56Z",
        "grantee_type": "groups"
      },
      "relationships": {
        "organisation": {
          "data": {
            "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "type": "<string>"
          }
        },
        "authoriser": {
          "data": {
            "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "type": "<string>"
          }
        },
        "principal_job_role": {
          "data": {
            "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "type": "<string>"
          }
        },
        "principal_role_group": {
          "data": {
            "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "type": "<string>"
          }
        },
        "principal_service_account": {
          "data": {
            "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "type": "<string>"
          }
        },
        "principal_scheme_share": {
          "data": {
            "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "type": "<string>"
          }
        },
        "principal_team": {
          "data": {
            "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "type": "<string>"
          }
        },
        "principal_user": {
          "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": {
        "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

​
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
​
sort
enum<string>[]

A comma separated list of fields to sort by.

Available options:
created_at,
-created_at
​
filter
string
default:""

Filters the response data based on the value provided.

Available filters:

  • grantee_type: Filter grants by the grantee type
  • grantee_id: Filter grants by the grantee ID
  • organisation_in: Filter grants by the organisation ID
  • type: Filter grants by the grant type
  • subject: Filter grants by the subject
  • grantor_id: Filter grants by the grantor ID

For more information on using named filters, see the docs

​
include
enum<string>[]

A comma separated list of related resources to include.

Available options:
grantee_job_role,
grantee_role_group,
grantee_service_account,
grantee_scheme_share,
grantee_team,
grantee_user,
grantor,
organisation

Response

Get a list of grants.

JSON API response object

​
data
object[]
required
​
meta
object
required
​
jsonapi
object
required
​
included
object[]

Related resources that can be included when a grant is returned

An organisation