> For clean Markdown of any page, append .md to the page URL. > For a complete documentation index, see https://docs.kota.io/api-reference/enrolment-intents/list-enrolment-intent-requirements/llms.txt. > For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.kota.io/_mcp/server. # List requirements for an enrolment intent GET https://test.api.kota.io/enrolment_intents/{enrolment_intent_id}/requirements Returns a paginated list of adaptive requirements for an `enrolment_intent`. Requirements must be fulfilled before enrolment can proceed. Reference: https://docs.kota.io/api-reference/enrolment-intents/list-enrolment-intent-requirements ## Authentication - `Authorization` header (bearer token, required) — Authorization header using the Bearer scheme ## Servers - `https://test.api.kota.io` (test, default) - `https://api.kota.io` (production) ## Request ### Path parameters - `enrolment_intent_id` (string, required) ### Query parameters - `object_type` (enum, optional) — Filter by object type (employee or employer) - Allowed values: `employee`, `employer`, `associated_person` - `object_id` (string, optional) — Filter by object ID (employee ID or employer ID) - `page` (integer, optional) — The page of results to return. Defaults to 1 if not provided. - `page_size` (integer, optional) — The number of results to return per page. Defaults to 10 if not provided. Maximum value is 100. ### Headers - `X-Platform-Id` (string, optional) — The target platform id. Required only when calling with a dashboard (WorkOS AuthKit) access token instead of a platform API key — the token carries no platform claim, so the caller must say which platform it means. Ignored for platform API key / embed session token callers. ## Response ### 200 OK - `items` (list of EnrolmentIntentRequirementResponse, required) — A paginated array containing the response elements - `page` (integer, required) — The current page of the results - `page_size` (integer, required) — The number of results on this page. This can be different from the requested page size if the total number of results is less than the requested page size - `total_count` (integer, required) — The total number of elements available in the response. This is the total number of elements available across all pages, not just the current page. - `has_next_page` (boolean, optional) — Whether there are more pages available after this page - `has_previous_page` (boolean, optional) — Whether there are more pages available before this page ## Errors ### 404 Not Found Error Not Found - `type` (string, optional, nullable) - `title` (string, optional, nullable) - `status` (integer, optional, nullable) - `detail` (string, optional, nullable) - `instance` (string, optional, nullable) ## Types ### EnrolmentIntentRequirementResponse - `id` (string, required) — Identifier of the requirement. Take it to the Adaptive Requirements public routes as-is: an `ar_` id is one requirement, an `ars_` id is a set of requirements composed into one form. - `object_type` (enum, required) — Type of object this requirement is for (employee or employer) - Allowed values: `employee`, `employer`, `associated_person` - `object_id` (string, required) — Identifier of the object (employee ID or employer ID) - `is_fulfilled` (boolean, required) — Whether the requirement has been fulfilled - `requirement_type` (enum, required) — Type of requirement - Allowed values: `group_quote_intent`, `group_policy_intent`, `dependent_management_intent`, `policy_amendment_intent`, `enrolment_intent` - `object` (string, optional) — Object type identifier ## Examples **Response** ```json { "items": [ { "id": "ar_3b1333d87d9d4fd6ad83ba7f6b0e951a", "object_type": "employee", "object_id": "string", "is_fulfilled": true, "requirement_type": "group_quote_intent", "object": "string" } ], "page": 123, "page_size": 123, "total_count": 123, "has_next_page": true, "has_previous_page": true } ``` **SDK Code** ```python import requests url = "https://test.api.kota.io/enrolment_intents/ei_3b1333d87d9d4fd6ad83ba7f6b0e951a/requirements" headers = {"Authorization": "Bearer "} response = requests.get(url, headers=headers) print(response.json()) ``` ```javascript const url = 'https://test.api.kota.io/enrolment_intents/ei_3b1333d87d9d4fd6ad83ba7f6b0e951a/requirements'; const options = {method: 'GET', headers: {Authorization: 'Bearer '}}; try { const response = await fetch(url, options); const data = await response.json(); console.log(data); } catch (error) { console.error(error); } ``` ```go package main import ( "fmt" "net/http" "io" ) func main() { url := "https://test.api.kota.io/enrolment_intents/ei_3b1333d87d9d4fd6ad83ba7f6b0e951a/requirements" req, _ := http.NewRequest("GET", url, nil) req.Header.Add("Authorization", "Bearer ") res, _ := http.DefaultClient.Do(req) defer res.Body.Close() body, _ := io.ReadAll(res.Body) fmt.Println(res) fmt.Println(string(body)) } ``` ```ruby require 'uri' require 'net/http' url = URI("https://test.api.kota.io/enrolment_intents/ei_3b1333d87d9d4fd6ad83ba7f6b0e951a/requirements") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true request = Net::HTTP::Get.new(url) request["Authorization"] = 'Bearer ' response = http.request(request) puts response.read_body ``` ```java import com.mashape.unirest.http.HttpResponse; import com.mashape.unirest.http.Unirest; HttpResponse response = Unirest.get("https://test.api.kota.io/enrolment_intents/ei_3b1333d87d9d4fd6ad83ba7f6b0e951a/requirements") .header("Authorization", "Bearer ") .asString(); ``` ```php request('GET', 'https://test.api.kota.io/enrolment_intents/ei_3b1333d87d9d4fd6ad83ba7f6b0e951a/requirements', [ 'headers' => [ 'Authorization' => 'Bearer ', ], ]); echo $response->getBody(); ``` ```csharp using RestSharp; var client = new RestClient("https://test.api.kota.io/enrolment_intents/ei_3b1333d87d9d4fd6ad83ba7f6b0e951a/requirements"); var request = new RestRequest(Method.GET); request.AddHeader("Authorization", "Bearer "); IRestResponse response = client.Execute(request); ``` ```swift import Foundation let headers = ["Authorization": "Bearer "] let request = NSMutableURLRequest(url: NSURL(string: "https://test.api.kota.io/enrolment_intents/ei_3b1333d87d9d4fd6ad83ba7f6b0e951a/requirements")! as URL, cachePolicy: .useProtocolCachePolicy, timeoutInterval: 10.0) request.httpMethod = "GET" request.allHTTPHeaderFields = headers let session = URLSession.shared let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in if (error != nil) { print(error as Any) } else { let httpResponse = response as? HTTPURLResponse print(httpResponse) } }) dataTask.resume() ```