This method uses pagination so you might need to request additional pages to retrieve all sessions.
project_ididrequired
ID of the project.
Request
pageinteger
Number of page to return (default: first page)
per_pageinteger
Maximum number of sessions to return (supported: 15, 25, 50, 100; default: 100)
sortstring
Sort field for the list of sessions (supported: sessions:created_at, sessions:closed_at; default: sessions:created_at)
orderstring
Sort order (ascending or descending) (supported: asc, desc; default: desc)
assignee_idstring
Comma-separated list of assignees to filter by.
closed_afterstring
Limit result to sessions closed after (in ISO8601 format and UTC time zone).
closed_beforestring
Limit result to sessions closed before (in ISO8601 format and UTC time zone).
config_idstring
Comma-separated list of configurations to filter by.
created_afterstring
Limit result to sessions created after (in ISO8601 format and UTC time zone).
created_beforestring
Limit result to sessions created before (in ISO8601 format and UTC time zone).
created_bystring
Comma-separated list of users to filter by.
is_closedboolean
Limit result to active or closed sessions only.
milestone_idstring
Comma-separated list of milestones to filter by.
state_idstring
Comma-separated list of workflow states to filter by.
tagsstring
Comma-separated list of tags to filter by.
template_idstring
Comma-separated list of templates to filter by.
expandsstring
Comma-separated list of expands to return.
"page": {"type":"integer","format":"int64","description":"Number of page (default: first page)."},"per_page": {"type":"integer","format":"int64","enum": [15,25,50,100 ],"description":"Maximum number of items to return per page (default: 100)."},"sort": {"type":"string","enum": ["sessions:created_at","sessions:closed_at" ],"description":"Sort field for the list of sessions."},"order": {"type":"string","enum": ["asc","desc" ],"description":"Sort order (ascending or descending)."},"assignee_id": {"type":"string","description":"Comma-separated list of assignees to filter by."},"closed_after": {"type":"string","format":"date-time","description":"Limit result to sessions closed after (in ISO8601 format and UTC time zone)."},"closed_before": {"type":"string","format":"date-time","description":"Limit result to sessions closed before (in ISO8601 format and UTC time zone)."},"config_id": {"type":"string","description":"Comma-separated list of configurations to filter by."},"created_after": {"type":"string","format":"date-time","description":"Limit result to sessions created after (in ISO8601 format and UTC time zone)."},"created_before": {"type":"string","format":"date-time","description":"Limit result to sessions created before (in ISO8601 format and UTC time zone)."},"created_by": {"type":"string","description":"Comma-separated list of users to filter by."},"is_closed": {"type":"boolean","description":"Limit result to active or closed sessions only."},"milestone_id": {"type":"string","description":"Comma-separated list of milestones to filter by."},"state_id": {"type":"string","description":"Comma-separated list of workflow states to filter by."},"tags": {"type":"string","description":"Comma-separated list of tags to filter by."},"template_id": {"type":"string","description":"Comma-separated list of templates to filter by."},"expands": {"type":"string","description":"Comma-separated list of expands to return."}
This method supports the following expands so you can automatically include additional information for referenced objects:
// Get latest 100 sessions for project with ID 5GET/api/v1/projects/5/sessions// Get second result page (pagination)GET/api/v1/projects/5/sessions?page=2// Get latest 100 active sessionsGET/api/v1/projects/5/sessions?is_closed=0// Get latest 100 closed sessions, ordered by close dateGET/api/v1/projects/5/sessions?is_closed=1&sort=sessions:closed_at// Get latest sessions created after a certain date & timeGET/api/v1/projects/5/sessions?created_after=2023-02-15T00:00:00.000Z// Get sessions and include expandsGET/api/v1/projects/5/sessions?expands=configs,issues,users