Collect Sessions

List all Collect Sessions

Retrieve a paginated list of collect sessions for your organization.

get/collect/sessions

Request

  • Base URL
    https://api.inscribe.ai/api/v2
  • Auth
    API key in header Authorization

Query parameters

pagestring

Indicate which page of the session list to return, the default is 1.

expiredboolean

Filter the returned collect sessions from the expired state. If omitted, both expired and active sessions will be returned.

customer_idstring

Filter the returned collect sessions by a given customer ID. If omitted, sessions for all customers will be returned.

Response

Successfully retrieved collect sessions.

Example response

{
  "data": [
    {
      "id": "0efae611-b3eb-4b84-8ed0-a4e92ad3bf4b",
      "url": "https://collect.inscribe.ai/#/fa207be0-b4da-4234-a350-fbbfe3b3298c/d1e07ab9-36a6-43eb-a550-2bc77dce8afc",
      "customer_id": "0efae611-b3eb-4b84-8ed0-a4e92ad3bf4b",
      "created_at": "2019-12-12T15:35:08.460Z",
      "completed_at": "2019-12-12T15:35:08.460Z",
      "success_url": "https://example.com/#success?session_id=0efae611-b3eb-4b84-8ed0-a4e92ad3bf4b",
      "cancel_url": "https://example.com/#cancel?session_id=0efae611-b3eb-4b84-8ed0-a4e92ad3bf4b",
      "logo_url": "https://assets.website-files.com/5ea61a1bf0e208bb1c5737ac/5ec69023b5341a114ab26bc7_inscribe_logo.svg",
      "display_name": "Inscribe"
    }
  ],
  "metadata": {
    "pagination": {
      "limit": 10,
      "current_page": 1,
      "number_of_pages": 1,
      "total": 1
    }
  }
}

Changes

No recorded changes to this operation across all 2 revisions of this API.