Skip to main content
GET /api/v1/forward/sessions Lists sessions under the authenticated account. Archived sessions are excluded by default.

​
Headers

HeaderRequiredDescription
AuthorizationYesBearer <PAT>

​
Query parameters

ParameterTypeRequiredDefaultDescription
identity_idsstring or arrayNo-Filter by one or more Identity IDs. Comma-separated strings are supported.
template_idstringNo-Filter by Forward Template ID.
source_typestringNo-Filter by api, im, or schedule.
created_at[gt]stringNo-Created strictly after this RFC 3339 timestamp.
created_at[gte]stringNo-Created at or after this RFC 3339 timestamp.
created_at[lt]stringNo-Created strictly before this RFC 3339 timestamp.
created_at[lte]stringNo-Created at or before this RFC 3339 timestamp.
updated_at[gt]stringNo-Updated strictly after this RFC 3339 timestamp.
updated_at[gte]stringNo-Updated at or after this RFC 3339 timestamp.
updated_at[lt]stringNo-Updated strictly before this RFC 3339 timestamp.
updated_at[lte]stringNo-Updated at or before this RFC 3339 timestamp.
limitintegerNo20Items per page. Maximum 100.
after_idstringNo-Cursor for records after the given Session ID. Cannot be used with before_id.
before_idstringNo-Cursor for records before the given Session ID. Cannot be used with after_id.
orderstringNodescSort order: desc or asc.
include_archivedbooleanNofalseInclude archived sessions.

​
Example request

curl -s -X GET 'https://api.qoder.com/api/v1/forward/sessions?identity_ids=idn_xxx,idn_yyy&template_id=tmpl_support&source_type=im&created_at[gte]=2026-06-01T00:00:00Z&limit=20' \
  -H "Authorization: Bearer $QODER_PAT"

​
Example response

HTTP 200 OK 
{
  "data": [
    {
      "id": "sess_xxx",
      "type": "session",
      "identity_id": "idn_xxx",
      "template": {
        "id": "tmpl_support",
        "type": "template",
        "name": "Support assistant",
        "model": "ultimate",
        "version": 3
      },
      "source_type": "im",
      "status": "idle",
      "title": "Customer support session",
      "incremental_streaming_enabled": true,
      "metadata": {
        "source": "dingtalk"
      },
      "config": {
        "environment_variables": {
          "API_KEY": "sk-xxx"
        }
      },
      "stats": {
        "active_seconds": 30,
        "duration_seconds": 3600
      },
      "usage": {
        "credits": 12.5
      },
      "archived_at": null,
      "created_at": "2026-06-22T10:00:00Z",
      "updated_at": "2026-06-22T11:00:00Z"
    }
  ],
  "first_id": "sess_xxx",
  "last_id": "sess_xxx",
  "has_more": false
}

​
Response fields

FieldTypeDescription
dataarraySession objects on the current page.
first_idstring|nullID of the first record on this page.
last_idstring|nullID of the last record on this page.
has_morebooleanWhether more records remain.

​
Errors

HTTPTypeCodeTrigger
400invalid_request_errorinvalid_time_rangeTime filters are invalid.
400invalid_request_errorinvalid_paginationPagination parameters are invalid.
401authentication_errorauthentication_requiredPAT invalid or expired.

​
Notes

  • after_id and before_id cannot be used together.
  • Current design does not support filtering by status.
  • usage.credits may be omitted if the credits module is not enabled.

Create a session

Get a session