> For the complete documentation index, see [llms.txt](https://docs.ilert.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.ilert.com/developer-docs/rest-api/api-reference/call-flow-sessions.md).
# Call Flow Sessions
## List call flow sessions.
> Returns one entry per incoming call that was handled by a call flow, most recent call first.
```json
{"openapi":"3.0.1","info":{"title":"ilert REST API","version":"v2.2026.9-r.4"},"tags":[{"name":"Call Flow Sessions"}],"servers":[{"url":"/api"}],"security":[{"apiKey":[]}],"components":{"securitySchemes":{"apiKey":{"type":"apiKey","description":"The Bearer API key of your user more info.","name":"Authorization","in":"header"}},"schemas":{"CallFlowSession":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"callSid":{"type":"string","description":"The identifier of the call at the telephony provider."},"createdAt":{"type":"string","format":"date-time","description":"The point in time the call came in."},"updatedAt":{"type":"string","format":"date-time"},"callEndedAt":{"type":"string","format":"date-time","description":"The point in time the caller hung up."},"flowEndedAt":{"type":"string","format":"date-time","description":"The point in time the call flow finished running."},"callFlowId":{"type":"integer","format":"int64","description":"The call flow that handled the call."},"numberId":{"type":"integer","format":"int64","description":"The call flow number the call came in on."},"status":{"type":"string","enum":["DEFAULT","ONGOING","ENDED","BLOCKED"]},"toNumber":{"type":"string","description":"The number that was called, in E.164 format."},"connectedToUserId":{"type":"integer","format":"int64","description":"The user the call was connected to, if it was routed to one."},"fromNumber":{"type":"string","description":"The number the call was made from, in E.164 format."},"fromCity":{"type":"string"},"fromZip":{"type":"string"},"fromState":{"type":"string"},"fromCountry":{"type":"string"},"recordedMessageUrl":{"type":"string","description":"Link to the voicemail recording, if the caller left one."}}}}},"paths":{"/call-flow-sessions":{"get":{"tags":["Call Flow Sessions"],"summary":"List call flow sessions.","description":"Returns one entry per incoming call that was handled by a call flow, most recent call first.","parameters":[{"name":"start-index","in":"query","description":"an integer specifying the starting point (beginning with 0) when paging through a list of entities","schema":{"type":"integer","format":"int32","default":0}},{"name":"max-results","in":"query","description":"the maximum number of results when paging through a list of entities.","schema":{"maximum":100,"type":"integer","format":"int32","default":50}},{"name":"states","in":"query","description":"state of the call flow session. Only a single state can be given, filtering by more than one is not supported.","style":"form","explode":true,"schema":{"type":"array","items":{"type":"string","enum":["DEFAULT","ONGOING","ENDED","BLOCKED"]},"maxItems":1}},{"name":"call-flows","in":"query","description":"call flow IDs of the call flow that handled the call","style":"form","explode":true,"schema":{"type":"array","items":{"type":"integer","format":"int64"}}},{"name":"call-flow-numbers","in":"query","description":"call flow number IDs of the number the call came in on","style":"form","explode":true,"schema":{"type":"array","items":{"type":"integer","format":"int64"}}},{"name":"from-number","in":"query","description":"the phone number the call was made from, in E.164 format","schema":{"type":"string"}},{"name":"from","in":"query","description":"only return calls that started at or after this point in time","schema":{"type":"string","format":"date-time"}},{"name":"until","in":"query","description":"only return calls that started before this point in time","schema":{"type":"string","format":"date-time"}}],"responses":{"200":{"description":"The call flow sessions","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/CallFlowSession"}}}}}}}}}}
```
## GET /call-flow-sessions/{id}
> Get a call flow session.
```json
{"openapi":"3.0.1","info":{"title":"ilert REST API","version":"v2.2026.9-r.4"},"tags":[{"name":"Call Flow Sessions"}],"servers":[{"url":"/api"}],"security":[{"apiKey":[]}],"components":{"securitySchemes":{"apiKey":{"type":"apiKey","description":"The Bearer API key of your user more info.","name":"Authorization","in":"header"}},"schemas":{"CallFlowSession":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"callSid":{"type":"string","description":"The identifier of the call at the telephony provider."},"createdAt":{"type":"string","format":"date-time","description":"The point in time the call came in."},"updatedAt":{"type":"string","format":"date-time"},"callEndedAt":{"type":"string","format":"date-time","description":"The point in time the caller hung up."},"flowEndedAt":{"type":"string","format":"date-time","description":"The point in time the call flow finished running."},"callFlowId":{"type":"integer","format":"int64","description":"The call flow that handled the call."},"numberId":{"type":"integer","format":"int64","description":"The call flow number the call came in on."},"status":{"type":"string","enum":["DEFAULT","ONGOING","ENDED","BLOCKED"]},"toNumber":{"type":"string","description":"The number that was called, in E.164 format."},"connectedToUserId":{"type":"integer","format":"int64","description":"The user the call was connected to, if it was routed to one."},"fromNumber":{"type":"string","description":"The number the call was made from, in E.164 format."},"fromCity":{"type":"string"},"fromZip":{"type":"string"},"fromState":{"type":"string"},"fromCountry":{"type":"string"},"recordedMessageUrl":{"type":"string","description":"Link to the voicemail recording, if the caller left one."}}}}},"paths":{"/call-flow-sessions/{id}":{"get":{"tags":["Call Flow Sessions"],"summary":"Get a call flow session.","parameters":[{"name":"id","in":"path","description":"entity ID","required":true,"schema":{"type":"number"}}],"responses":{"200":{"description":"The requested call flow session","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CallFlowSession"}}}}}}}}}
```
## Get the data that was collected during a call flow session.
> Returns the values the call flow collected while the call was running, for example a menu selection or a transcription. Which properties are present depends on the nodes the call passed through.
```json
{"openapi":"3.0.1","info":{"title":"ilert REST API","version":"v2.2026.9-r.4"},"tags":[{"name":"Call Flow Sessions"}],"servers":[{"url":"/api"}],"security":[{"apiKey":[]}],"components":{"securitySchemes":{"apiKey":{"type":"apiKey","description":"The Bearer API key of your user more info.","name":"Authorization","in":"header"}}},"paths":{"/call-flow-sessions/{id}/data":{"get":{"tags":["Call Flow Sessions"],"summary":"Get the data that was collected during a call flow session.","description":"Returns the values the call flow collected while the call was running, for example a menu selection or a transcription. Which properties are present depends on the nodes the call passed through.","parameters":[{"name":"id","in":"path","description":"entity ID","required":true,"schema":{"type":"number"}}],"responses":{"200":{"description":"The collected data","content":{"application/json":{"schema":{"type":"object","description":"The collected values, keyed by name."}}}}}}}}}
```
---
# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.
## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.
Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:
```
GET https://docs.ilert.com/developer-docs/rest-api/api-reference/call-flow-sessions.md?ask=&goal=
```
`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.
Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.