---
updatedAt: 2025-05-14T20:42:49.000Z
agentTools:
  siteIndex: https://developers.klaxoon.com/llms.txt
  projectIndex: https://developers.klaxoon.com/klaxoon/llms.txt
---

# List sessions

# OpenAPI definition

```json
{
  "openapi": "3.0.0",
  "info": {
    "title": "Activity",
    "description": "Klaxoon Activity API",
    "contact": {
      "name": "Klaxoon PHP Team"
    },
    "version": "1.0.0"
  },
  "servers": [
    {
      "url": "https://api.klaxoon.com",
      "description": "API Klaxoon"
    }
  ],
  "tags": [
    {
      "name": "Session"
    }
  ],
  "paths": {
    "/v1/sessions": {
      "get": {
        "summary": "List sessions",
        "tags": [
          "Session"
        ],
        "parameters": [
          {
            "name": "page",
            "description": "The collection page number",
            "required": false,
            "in": "query",
            "schema": {
              "type": "integer",
              "minimum": 1,
              "default": 1
            }
          },
          {
            "name": "perPage",
            "description": "The number of items per page",
            "required": false,
            "in": "query",
            "schema": {
              "type": "integer",
              "minimum": 0,
              "maximum": 100,
              "default": 20
            }
          },
          {
            "name": "sort",
            "description": "A comma-separated list of sort field, to indicate sorting direction, fields may be prefixed with + (ascending) or - (descending). Default ordering is ascending",
            "required": false,
            "style": "form",
            "explode": false,
            "in": "query",
            "schema": {
              "type": "array",
              "items": {
                "type": "string",
                "enum": [
                  "createdAt",
                  "updatedAt"
                ]
              },
              "example": "-updatedAt,-createdAt"
            }
          },
          {
            "name": "q",
            "description": "Filters sessions by title and author's first and last name. Partial match applies.",
            "required": false,
            "in": "query",
            "schema": {
              "type": "string"
            }
          }
        ],
        "security": [
          {
            "oauth2": []
          }
        ],
        "responses": {
          "200": {
            "description": "Operation success",
            "content": {
              "application/json": {
                "schema": {
                  "allOf": [
                    {
                      "$ref": "#/components/schemas/Pagination"
                    },
                    {
                      "$ref": "#/components/schemas/ActivitiesView"
                    }
                  ]
                }
              }
            }
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "default": {
            "$ref": "#/components/responses/Default"
          }
        }
      }
    }
  },
  "components": {
    "securitySchemes": {
      "oauth2": {
        "flows": {},
        "type": "oauth2"
      }
    },
    "schemas": {
      "Error": {
        "type": "object",
        "properties": {
          "type": {
            "type": "string",
            "description": "The problem type",
            "example": "about:blank"
          },
          "title": {
            "type": "string",
            "description": "A short, human-readable summary of the problem type",
            "example": "Bad Request"
          },
          "detail": {
            "type": "string",
            "description": "Error details"
          },
          "instance": {
            "type": "string",
            "description": "A URI reference that identifies the specific occurrence of the problem",
            "example": "/138d9bea-4edf-4e9c-86f7-43672e42c5dc"
          }
        },
        "required": [
          "type",
          "title"
        ]
      },
      "ActivityView": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "description": "Unique identifier for the activity",
            "example": "d16f8914-388d-4714-a259-b183de50d448",
            "readOnly": true
          },
          "title": {
            "type": "string",
            "description": "Title of the activity",
            "example": "My first activity",
            "maxLength": 250
          },
          "description": {
            "description": "Short description of the activity",
            "type": "string",
            "nullable": true,
            "example": "My awesome activity"
          },
          "accessCode": {
            "description": "Unique access code use to join the activity in Klaxoon",
            "type": "string",
            "nullable": true,
            "example": "ABCDEF",
            "readOnly": true
          },
          "state": {
            "description": "Current activity state",
            "type": "string",
            "example": "draft",
            "readOnly": true,
            "enum": [
              "draft",
              "publish",
              "closed"
            ]
          },
          "author": {
            "type": "object",
            "description": "Author of the activity",
            "readOnly": true,
            "properties": {
              "id": {
                "type": "string",
                "description": "Unique identifier for the author",
                "example": "6a8cc66c-32fd-4588-9323-90d10bdbbf03"
              }
            }
          },
          "createdAt": {
            "type": "string",
            "format": "date-time",
            "readOnly": true
          },
          "updatedAt": {
            "type": "string",
            "format": "date-time",
            "readOnly": true
          }
        }
      },
      "Pagination": {
        "type": "object",
        "properties": {
          "self": {
            "type": "string",
            "example": "https://klaxoon.com/api/path?page=3&perPage=10"
          },
          "first": {
            "type": "string",
            "example": "https://klaxoon.com/api/path?page=1&perPage=10"
          },
          "prev": {
            "type": "string",
            "example": "https://klaxoon.com/api/path?page=2&perPage=10",
            "nullable": true
          },
          "next": {
            "type": "string",
            "example": "https://klaxoon.com/api/path?page=4&perPage=10",
            "nullable": true
          },
          "total": {
            "type": "integer",
            "format": "int32",
            "example": 200,
            "minimum": 0
          }
        }
      },
      "ActivitiesView": {
        "type": "object",
        "properties": {
          "items": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/ActivityView"
            }
          }
        }
      }
    },
    "responses": {
      "BadRequest": {
        "description": "Bad Request",
        "content": {
          "application/problem+json": {
            "schema": {
              "allOf": [
                {
                  "$ref": "#/components/schemas/Error"
                },
                {
                  "type": "object",
                  "properties": {
                    "title": {
                      "example": "Bad Request"
                    },
                    "detail": {
                      "example": "Expecting a string, got number."
                    }
                  }
                }
              ]
            }
          }
        }
      },
      "Unauthorized": {
        "description": "The user is not authorized to access this resource",
        "content": {
          "application/problem+json": {
            "schema": {
              "allOf": [
                {
                  "$ref": "#/components/schemas/Error"
                },
                {
                  "type": "object",
                  "properties": {
                    "title": {
                      "example": "No valid authentication provided."
                    },
                    "detail": {
                      "example": "The user is not authorized to access to this resource."
                    }
                  }
                }
              ]
            }
          }
        }
      },
      "Forbidden": {
        "description": "The user does not have the required permissions to access this resource",
        "content": {
          "application/problem+json": {
            "schema": {
              "allOf": [
                {
                  "$ref": "#/components/schemas/Error"
                },
                {
                  "type": "object",
                  "properties": {
                    "title": {
                      "example": "You do not have access to this resource."
                    },
                    "detail": {
                      "example": "You tried to access to a resource that does not belong to you"
                    }
                  }
                }
              ]
            }
          }
        }
      },
      "Default": {
        "description": "Operation in error",
        "content": {
          "application/problem+json": {
            "schema": {
              "$ref": "#/components/schemas/Error"
            }
          }
        }
      }
    }
  },
  "x-readme": {
    "explorer-enabled": true,
    "proxy-enabled": true
  }
}
```