---
title: "List all Collect Sessions"
method: GET
path: "/collect/sessions"
tags: ["Collect Sessions"]
---

# List all Collect Sessions

`GET /collect/sessions`

Retrieve a paginated list of collect sessions for your organization.

## Query parameters

- `page` string
- `expired` boolean
- `customer_id` string

## Response `200`

Successfully retrieved collect sessions.

- CollectSessions
  - `data` CollectSession[] — A list of collect session objects.
    - `id` string, uuid — Unique identifier for the object.
    - `url` string — The URL for the session. The first UUID in the URL is a unique identifier for your organisation that will be static accross Collect sessions. The second UUID in the URL is the session id.
    - `customer_id` string, uuid — Unique identifier for the associated customer.
    - `created_at` string, date-time — Time at which the session was created. In the format: yyyy-MM-dd'T'HH:mm:ssZ
    - `completed_at` string, nullable — Time at which the session was completed. This will be null if the session has not been completed. In the format: yyyy-MM-dd'T'HH:mm:ssZ
    - `success_url` string — The URL the user will be redirected to when they complete the session.
    - `cancel_url` string — The URL the user will be redirected to when they abort or cancel the session.
    - `logo_url` string — A link to the logo displayed in the collect session.
    - `display_name` string — The name of the company being displayed in the collect session.
    - `expired` boolean — States if the session is active
  - `metadata` object
    - `pagination` object
      - `limit` integer — The limit on the number of collect sessions that can be returned per page.
      - `current_page` integer — The current page number.
      - `number_of_pages` integer — The total number of pages available with the current query parameters.
      - `total` integer — The total number of collect sessions available with the current query parameters.

## Other responses

- `400` — You have provided incorrect data.
- `403` — You do not have permission to access this resource.
- `404` — The specified resource was not found.
- `429` — Too many requests. The request has been rate limited. For more information, visit our [documentation on rate limiting](https://docs.inscribe.ai/docs/are-the-endpoints-rate-limited).

---

[API](https://skmtc.dev/inscribe/apis/core-resources.md) · [All operations](https://skmtc.dev/inscribe/apis/core-resources/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/inscribe/core-resources/revisions/6489b36eb60f/schema)
