> For clean Markdown of any page, append .md to the page URL. > For a complete documentation index, see https://docs.cail.health/llms.txt. > For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.cail.health/_mcp/server. # List navigation sessions GET https://staging.cail.health/v1/navigation-sessions Returns cursor-paginated navigation sessions for the operator’s organisation. Filter by lifecycle state, device platform, or start-timestamp window. Sessions are anonymous; only lifecycle and analytics metadata are recorded. Reference: https://docs.cail.health/api-references/api-reference/navigate-to-care/list ## OpenAPI Specification ```yaml openapi: 3.1.0 info: title: cail-api version: 1.0.0 paths: /v1/navigation-sessions: get: operationId: list summary: List navigation sessions description: >- Returns cursor-paginated navigation sessions for the operator’s organisation. Filter by lifecycle state, device platform, or start-timestamp window. Sessions are anonymous; only lifecycle and analytics metadata are recorded. tags: - subpackage_navigateToCare parameters: - name: cursor in: query description: Opaque cursor returned from a prior call. required: false schema: type: string - name: limit in: query description: Maximum number of results to return. Defaults to 20. required: false schema: type: number format: double - name: sortBy in: query description: Sort field. required: false schema: type: string - name: sortOrder in: query description: Sort order. required: false schema: $ref: '#/components/schemas/V1NavigationSessionsGetParametersSortOrder' - name: outcomeCode in: query description: Filter by session lifecycle state. required: false schema: $ref: '#/components/schemas/V1NavigationSessionsGetParametersOutcomeCode' - name: devicePlatform in: query description: Filter by member device platform. required: false schema: $ref: >- #/components/schemas/V1NavigationSessionsGetParametersDevicePlatform - name: after in: query description: ISO 8601 lower bound for the session start timestamp. required: false schema: type: string - name: before in: query description: ISO 8601 upper bound for the session start timestamp. required: false schema: type: string - name: Authorization in: header description: Bearer authentication required: true schema: type: string responses: '200': description: Cursor-paginated sessions. content: application/json: schema: $ref: '#/components/schemas/ListNavigationSessionsResponse' servers: - url: https://staging.cail.health description: https://staging.cail.health components: schemas: V1NavigationSessionsGetParametersSortOrder: type: string enum: - asc - desc title: V1NavigationSessionsGetParametersSortOrder V1NavigationSessionsGetParametersOutcomeCode: type: string enum: - in-progress - completed - abandoned title: V1NavigationSessionsGetParametersOutcomeCode V1NavigationSessionsGetParametersDevicePlatform: type: string enum: - ios - android - web title: V1NavigationSessionsGetParametersDevicePlatform NavigationSessionListItemStatus: type: string enum: - in-progress - completed - abandoned description: Lifecycle state of the session. title: NavigationSessionListItemStatus NavigationSessionListItem: type: object properties: id: type: string description: Stable identifier of the session. planDefinitionId: type: string description: Identifier of the pathway this session was pinned to. status: $ref: '#/components/schemas/NavigationSessionListItemStatus' description: Lifecycle state of the session. outcomeCode: type: string description: Outcome code when status is completed. devicePlatform: type: string description: Member device platform recorded at start. startedAt: type: string description: ISO 8601 timestamp the session started. endedAt: type: string description: >- ISO 8601 timestamp the session ended. Present when status is not `in-progress`. required: - id - planDefinitionId - status - devicePlatform - startedAt title: NavigationSessionListItem ListNavigationSessionsPaginationCursor: type: object properties: {} title: ListNavigationSessionsPaginationCursor ListNavigationSessionsPagination: type: object properties: cursor: oneOf: - $ref: '#/components/schemas/ListNavigationSessionsPaginationCursor' - type: 'null' hasMore: type: boolean limit: type: number format: double required: - cursor - hasMore - limit title: ListNavigationSessionsPagination ListNavigationSessionsResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/NavigationSessionListItem' description: Sessions for this page, ordered by startedAt descending by default. pagination: $ref: '#/components/schemas/ListNavigationSessionsPagination' description: Cursor metadata for paging forward. required: - data - pagination title: ListNavigationSessionsResponse securitySchemes: auth0Bearer: type: http scheme: bearer ``` ## Examples **Response** ```json { "data": [ { "id": "3a4b5c6d-7e8f-4901-92b3-c4d5e6f7a8b9", "planDefinitionId": "a1b2c3d4-e5f6-4789-9abc-def012345678", "status": "completed", "devicePlatform": "ios", "startedAt": "2026-05-13T14:21:00.000Z", "outcomeCode": "pharmacy", "endedAt": "2026-05-13T14:23:00.000Z" }, { "id": "sess_02HZX9P3Q5R7S9T1V3W5Y7Z9A1", "planDefinitionId": "a1b2c3d4-e5f6-4789-9abc-def012345678", "status": "abandoned", "devicePlatform": "android", "startedAt": "2026-05-13T13:55:00.000Z", "endedAt": "2026-05-13T13:55:42.000Z" } ], "pagination": { "cursor": null, "hasMore": false, "limit": 20 } } ``` **SDK Code** ```python Two completed sessions import requests url = "https://staging.cail.health/v1/navigation-sessions" headers = {"Authorization": "Bearer "} response = requests.get(url, headers=headers) print(response.json()) ``` ```javascript Two completed sessions const url = 'https://staging.cail.health/v1/navigation-sessions'; 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 Two completed sessions package main import ( "fmt" "net/http" "io" ) func main() { url := "https://staging.cail.health/v1/navigation-sessions" 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 Two completed sessions require 'uri' require 'net/http' url = URI("https://staging.cail.health/v1/navigation-sessions") 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 Two completed sessions import com.mashape.unirest.http.HttpResponse; import com.mashape.unirest.http.Unirest; HttpResponse response = Unirest.get("https://staging.cail.health/v1/navigation-sessions") .header("Authorization", "Bearer ") .asString(); ``` ```php Two completed sessions request('GET', 'https://staging.cail.health/v1/navigation-sessions', [ 'headers' => [ 'Authorization' => 'Bearer ', ], ]); echo $response->getBody(); ``` ```csharp Two completed sessions using RestSharp; var client = new RestClient("https://staging.cail.health/v1/navigation-sessions"); var request = new RestRequest(Method.GET); request.AddHeader("Authorization", "Bearer "); IRestResponse response = client.Execute(request); ``` ```swift Two completed sessions import Foundation let headers = ["Authorization": "Bearer "] let request = NSMutableURLRequest(url: NSURL(string: "https://staging.cail.health/v1/navigation-sessions")! 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() ```