Ctrlk
For the complete documentation index, see llms.txt. This page is also available as Markdown.

Grant Requests

List grant requests

get

Returns grant requests visible to the current user, optionally filtered by group, user, status, or action.

Path parameters
grant_request_group_idintegerOptional

Grant request group ID (required only when accessing from group route)

Query parameters
userstring · enumOptional

Filter by current user (use 'me')

Possible values:
statusstringOptional

Filter by status

actionstringOptional

Filter by action (e.g., 'approve')

Responses
200

List of grant requests

application/json
permissionsstring[] · nullableOptional
get/api/grant_requests
GET /api/grant_requests HTTP/1.1
Accept: */*

{
  "data": [
    {
      "_embedded": {
        "data_structure": {
          "external_id": "ds_1",
          "id": 1,
          "name": "DS",
          "type": "table"
        },
        "group": {
          "_embedded": {
            "user": {
              "full_name": "User Name",
              "id": 3,
              "user_name": "u"
            }
          },
          "id": 2,
          "type": "grant_request_group"
        }
      },
      "dynamic_content": {
        "foo": "bar"
      },
      "filters": {
        "status": [
          "pending"
        ]
      },
      "id": 456,
      "inserted_at": "2020-01-01T00:00:00Z",
      "metadata": {
        "grant_meta": "bar"
      },
      "status": "pending",
      "type": "grant_creation"
    }
  ],
  "permissions": [
    "approver"
  ]
}

Bulk approve grant requests

post

Approves or rejects multiple grant requests in bulk according to the provided approval parameters and returns created approvals.

Body
commentstring · nullableOptional

Optional comment

is_rejectionbooleanOptional

Whether this is a rejection

Default: false
rolestringRequired

Approval role

Responses
201

Grant request approvals created

application/json
post/api/grant_requests/bulk_approval
POST /api/grant_requests/bulk_approval HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 99

{
  "comment": "Bulk approval",
  "filters": {
    "status": [
      "pending"
    ]
  },
  "is_rejection": false,
  "role": "approver"
}
{
  "data": [
    {
      "comment": "Bulk approval",
      "id": 789,
      "inserted_at": "2026-06-16T09:43:18.491754Z",
      "is_rejection": false,
      "role": "approver"
    }
  ]
}

Reindex all grant requests

get

Triggers a full reindex of grant requests for search.

Responses
202

Reindexing accepted

No content
get/api/grant_requests/search/reindex_all
GET /api/grant_requests/search/reindex_all HTTP/1.1
Accept: */*

No content

List grant request groups

get

Returns grant request groups available to the current user, optionally filtered by a comma-separated list of IDs.

Query parameters
idsstringOptional

Comma-separated list of group IDs to filter

Responses
200

List of grant request groups

application/json
get/api/grant_request_groups
GET /api/grant_request_groups HTTP/1.1
Accept: */*

{
  "data": [
    {
      "_embedded": {
        "requests": [
          {
            "id": 789,
            "type": "grant_creation"
          }
        ]
      },
      "id": 123,
      "status": "pending",
      "type": "grant_request",
      "user_id": 456
    }
  ]
}

List grant requests

get

Returns grant requests visible to the current user, optionally filtered by group, user, status, or action.

Path parameters
grant_request_group_idintegerOptional

Grant request group ID (required only when accessing from group route)

Query parameters
userstring · enumOptional

Filter by current user (use 'me')

Possible values:
statusstringOptional

Filter by status

actionstringOptional

Filter by action (e.g., 'approve')

Responses
200

List of grant requests

application/json
permissionsstring[] · nullableOptional
get/api/grant_request_groups/{grant_request_group_id}/grant_requests
GET /api/grant_request_groups/{grant_request_group_id}/grant_requests HTTP/1.1
Accept: */*

{
  "data": [
    {
      "_embedded": {
        "data_structure": {
          "external_id": "ds_1",
          "id": 1,
          "name": "DS",
          "type": "table"
        },
        "group": {
          "_embedded": {
            "user": {
              "full_name": "User Name",
              "id": 3,
              "user_name": "u"
            }
          },
          "id": 2,
          "type": "grant_request_group"
        }
      },
      "dynamic_content": {
        "foo": "bar"
      },
      "filters": {
        "status": [
          "pending"
        ]
      },
      "id": 456,
      "inserted_at": "2020-01-01T00:00:00Z",
      "metadata": {
        "grant_meta": "bar"
      },
      "status": "pending",
      "type": "grant_creation"
    }
  ],
  "permissions": [
    "approver"
  ]
}

Download grant requests as XLSX

post

Generates an XLSX file containing grant requests matching the request filters.

The payload mirrors POST /api/grant_requests/search so that the active view (Approve or Search) can be reused as-is. As in the search endpoint, the Approve view filters (Search.apply_approve_filters/1) are applied whenever the payload carries them, and the payload is used verbatim otherwise. Results are always restricted to the domains and structures the user can see, regardless of the payload.

Every record matching the query is exported, so the pagination and cursor properties of the search payload are ignored.

Body

Request body for POST /api/grant_requests/xlsx/download.

Mirrors GrantRequestSearchRequest so that the payload sent by the Manage grant requests view (Search or Approve) can be forwarded verbatim. Dynamic template fields are not listed here because the schema depends on the active templates at runtime; the headers for each dynamic column are returned in the same order produced by the server, prefixed by the eight fixed columns.

The download always exports every record matching the query, so the pagination and cursor properties of the search payload (page, size, scroll, scroll_id) are accepted but ignored.

langstring · nullableOptional

Locale used to translate the status and request type columns and the template fields. Defaults to the default locale.

Example: es
pageinteger · nullableOptional

Accepted and ignored.

querystring · nullableOptional
scrollstring · nullableOptional

Accepted and ignored.

scroll_idstring · nullableOptional

Accepted and ignored.

search_bystring · enumOptional

Accepted and ignored. The Approve view filters are applied whenever the payload carries them, as in the search endpoint.

Default: allPossible values:
sizeinteger · nullableOptional

Accepted and ignored.

Responses
200

XLSX file downloaded

application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
string · binaryOptional
post/api/grant_requests/xlsx/download
POST /api/grant_requests/xlsx/download HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 305

{
  "filters": {
    "status": [
      "pending"
    ]
  },
  "header_labels": {
    "created_by_full_name": "Created by",
    "current_status": "Status",
    "domains": "Domains",
    "request_type": "Request type",
    "structure_external_id": "Structure",
    "structure_path": "Path",
    "system_name": "System",
    "user_full_name": "User"
  },
  "lang": "en",
  "search_by": "approve"
}
binary

Get grant request by ID

get

Retrieves the grant request with the specified ID.

Path parameters
idintegerRequired

Grant request ID

Responses
200

Grant request retrieved

application/json
get/api/grant_requests/{id}
GET /api/grant_requests/{id} HTTP/1.1
Accept: */*

{
  "data": {
    "_embedded": {
      "data_structure": {
        "external_id": "ds_1",
        "id": 1,
        "name": "DS"
      }
    },
    "data_structure_id": 789,
    "id": 456,
    "status": "pending",
    "type": "grant_creation"
  }
}

Delete grant request

delete

Deletes the grant request identified by the provided ID.

Path parameters
idintegerRequired

Grant request ID

Responses
204

Grant request deleted

No content
delete/api/grant_requests/{id}
DELETE /api/grant_requests/{id} HTTP/1.1
Accept: */*

No content

Get available grant request filters

post

Returns the set of available filters for grant requests according to caller permissions and provided parameters.

Body
pageinteger · nullableOptional

Page number (0-indexed)

Default: 0
querystring · nullableOptional

Search query string

scrollstring · nullableOptional

Scroll ID for pagination (e.g., '1m' for 1 minute)

scroll_idstring · nullableOptional

Scroll ID to continue a previous search

sizeinteger · min: 1 · max: 100 · nullableOptional

Page size

Default: 20
Responses
200

Available filters

application/json
post/api/grant_requests_filters/search
POST /api/grant_requests_filters/search HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 73

{
  "filters": {
    "status": [
      "pending"
    ]
  },
  "page": 0,
  "query": "user name",
  "size": 20
}
{
  "data": {
    "status": [
      {
        "count": 10,
        "key": "pending"
      }
    ],
    "type": [
      {
        "count": 5,
        "key": "grant_creation"
      }
    ]
  }
}

Create grant request status

post

Creates or updates the status of a grant request for the given request ID.

Path parameters
grant_request_idintegerRequired

Grant request ID

Body
reasonstring · nullableOptional
statusstring · enumRequiredPossible values:
Responses
201

Grant request status created

application/json
post/api/grant_requests/{grant_request_id}/status
POST /api/grant_requests/{grant_request_id}/status HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 49

{
  "reason": "Request approved",
  "status": "approved"
}
{
  "data": {
    "_embedded": {
      "approvals": [],
      "data_structure": {
        "external_id": "ds_1",
        "id": 1,
        "name": "DS"
      },
      "group": {
        "created_by_id": 123,
        "id": 1
      }
    },
    "all_pending_roles": [],
    "data_structure_id": 789,
    "domain_ids": [
      123
    ],
    "dynamic_content": {
      "foo": "bar"
    },
    "filters": {
      "status": [
        "pending"
      ]
    },
    "id": 456,
    "inserted_at": "2026-06-16T13:40:56.464111Z",
    "metadata": {
      "grant_meta": "bar"
    },
    "pending_roles": [],
    "request_type": "grant_access",
    "status": "processing",
    "status_reason": "Processing the request",
    "type": "grant_request",
    "updated_at": "2026-06-16T13:40:56.468406Z"
  }
}

Search grant requests

post

Searches grant requests using the provided criteria and returns paginated results with total count and optional filters.

Body
pageinteger · nullableOptional

Page number (0-indexed)

Default: 0
querystring · nullableOptional

Search query string

scrollstring · nullableOptional

Scroll ID for pagination (e.g., '1m' for 1 minute)

scroll_idstring · nullableOptional

Scroll ID to continue a previous search

sizeinteger · min: 1 · max: 100 · nullableOptional

Page size

Default: 20
Responses
200

Grant request search response

application/json
_permissionsstring[] · nullableOptional

User permissions for the search results

scroll_idstring · nullableOptional

Scroll ID for pagination

post/api/grant_requests/search
POST /api/grant_requests/search HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 73

{
  "filters": {
    "status": [
      "pending"
    ]
  },
  "page": 0,
  "query": "user name",
  "size": 20
}
{
  "_permissions": [],
  "data": [
    {
      "created_by": {
        "email": "email325",
        "full_name": "",
        "user_name": "joe"
      },
      "created_by_id": 666498,
      "current_status": "pending",
      "data_structure_id": 2735267,
      "data_structure_version": {
        "data_structure_id": 2735267,
        "description": "data_structure_version_description100",
        "domain": null,
        "external_id": "ds_external_id398",
        "metadata": {
          "description": "some description"
        },
        "mutable_metadata": null,
        "name": "data_structure_version_name100",
        "note": null,
        "path": []
      },
      "domain_ids": [],
      "grant": null,
      "group_id": 1130,
      "id": 48207,
      "inserted_at": "2026-06-16T17:13:15.241941Z",
      "metadata": {},
      "modification_grant_id": null,
      "request_type": "grant_access",
      "user": {
        "email": "email325",
        "full_name": "",
        "user_name": "joe"
      },
      "user_id": 666498
    }
  ],
  "filters": null,
  "scroll_id": null
}

Create grant request approval

post

Creates an approval record for the specified grant request.

Path parameters
grant_request_idintegerRequired

Grant request ID

Body
Responses
201

Grant request approval created

application/json
post/api/grant_requests/{grant_request_id}/approvals
POST /api/grant_requests/{grant_request_id}/approvals HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 53

{
  "approval": {
    "comment": "Approved",
    "role": "approver"
  }
}
{
  "data": {
    "_embedded": {
      "user": {
        "id": 1,
        "user_name": "admin"
      }
    },
    "comment": "Approved",
    "id": 789,
    "inserted_at": "2026-06-16T09:43:18.491754Z",
    "is_rejection": false,
    "role": "approver"
  }
}

Last updated