Get a list of sessions | Airtop

import { AirtopClient } from "@airtop/sdk";
const client = new AirtopClient({ apiKey: "YOUR_API_KEY" });
await client.sessions.list({
    offset: 1,
    limit: 10
});

{
  "data": {
    "pagination": {
      "currentLimit": 1000000,
      "currentPage": 1000000,
      "finalCount": 1000000,
      "hasMore": true,
      "initialCount": 1000000,
      "nextOffset": 1000000,
      "numberOfPages": 1000000,
      "totalItems": 1000000
    },
    "sessions": [
      {
        "configuration": {
          "baseProfileId": "a13c6f73-bd89-4a76-ab32-5a6c422e8224",
          "persistProfile": true,
          "timeoutMinutes": 10
        },
        "id": "6aac6f73-bd89-4a76-ab32-5a6c422e8b0b",
        "status": "active",
        "profileId": "427c6f73-bd89-4a76-ab32-5a6c422e8b0b"
      }
    ]
  },
  "meta": {
    "requestId": "requestId"
  },
  "errors": [
    {
      "message": "message",
      "code": "code",
      "details": {
        "key": "value"
      },
      "reason": "reason"
    }
  ],
  "warnings": [
    {
      "message": "message",
      "code": "code",
      "details": {
        "key": "value"
      },
      "reason": "reason"
    }
  ]
}

Get a paginated list of sessions filtered by ID or status

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Query parameters

sessionIdsstringOptional

A comma-separated list of IDs of the sessions to retrieve.

statusenumOptional

Status of the session to get.

offsetlongOptionalDefaults to -1

Offset for pagination.

limitlongOptionalDefaults to 10

Limit for pagination.

Response

dataobject

metaobject

errorslist of objects

warningslist of objects

Errors

404

Sessions List Request Not Found Error

422

Sessions List Request Unprocessable Entity Error

500

Sessions List Request Internal Server Error