---
updatedAt: 2026-04-21T13:55:31.000Z
agentTools:
  projectIndex: https://developer.operations1.com/llms.txt
---

# List classes

# OpenAPI definition

```json
{
  "openapi": "3.1.0",
  "info": {
    "title": "Operations1 REST API",
    "description": "Operations1 REST API documentation",
    "version": "2025-04-21"
  },
  "components": {
    "securitySchemes": {
      "bearerAuth": {
        "type": "http",
        "scheme": "bearer"
      }
    }
  },
  "paths": {
    "/tenants/{tenantId}/classes": {
      "get": {
        "operationId": "listOfClasses",
        "summary": "List classes",
        "tags": [
          "Classes"
        ],
        "parameters": [
          {
            "schema": {
              "type": "integer",
              "minimum": 10,
              "maximum": 200,
              "default": 10
            },
            "in": "query",
            "name": "pageSize",
            "required": true
          },
          {
            "schema": {
              "anyOf": [
                {
                  "type": "integer",
                  "minimum": 0
                },
                {
                  "type": "string",
                  "enum": [
                    "last"
                  ]
                }
              ],
              "default": 0
            },
            "in": "query",
            "name": "pageIndex",
            "required": true
          },
          {
            "schema": {
              "type": "boolean"
            },
            "in": "query",
            "name": "archived",
            "required": false
          },
          {
            "schema": {
              "type": "string",
              "minLength": 1,
              "maxLength": 100
            },
            "in": "path",
            "name": "tenantId",
            "required": true,
            "description": "Consists of the subdomain. The `tenantId` for `https://company.operations1.app/` is `company`."
          },
          {
            "schema": {
              "anyOf": [
                {
                  "type": "string",
                  "examples": [
                    "2025-04-21",
                    "unstable"
                  ],
                  "format": "date",
                  "description": "Specifies the API version in date format (e.g., \"2024-01-01\"). Allowed values include 2025-04-21"
                },
                {
                  "type": "string",
                  "examples": [
                    "latest"
                  ],
                  "description": "Indicates the most recent stable API version.",
                  "enum": [
                    "latest"
                  ]
                },
                {
                  "type": "string",
                  "examples": [
                    "unstable"
                  ],
                  "description": "Indicates the unstable API version.",
                  "enum": [
                    "unstable"
                  ]
                }
              ]
            },
            "examples": {
              "2025-04-21": {
                "value": "2025-04-21"
              },
              "unstable": {
                "value": "unstable"
              }
            },
            "in": "header",
            "name": "accept-version",
            "required": true,
            "description": "Defines the API version. Using a date is recommended for stability. Avoid using `latest` in production, as it refers to the most up-to-date functionality, which may include breaking changes. For more details, see our article on [versioning](https://developer.operations1.com/reference/versioning)."
          }
        ],
        "responses": {
          "200": {
            "description": "Default Response",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "required": [
                    "totalItemCount",
                    "pageIndex",
                    "pageSize",
                    "items"
                  ],
                  "properties": {
                    "totalItemCount": {
                      "type": "integer",
                      "minimum": 0
                    },
                    "pageIndex": {
                      "type": "integer",
                      "minimum": 0
                    },
                    "pageSize": {
                      "type": "integer",
                      "minimum": 10,
                      "maximum": 200,
                      "default": 10
                    },
                    "items": {
                      "type": "array",
                      "items": {
                        "type": "object",
                        "required": [
                          "id",
                          "name",
                          "position",
                          "displayProperty",
                          "identificationProperty",
                          "createdAt",
                          "createdBy",
                          "createdByUserName",
                          "updatedAt",
                          "updatedBy",
                          "updatedByUserName",
                          "archived"
                        ],
                        "properties": {
                          "id": {
                            "type": "integer",
                            "minimum": 1,
                            "maximum": 9007199254740991
                          },
                          "name": {
                            "type": "string"
                          },
                          "position": {
                            "anyOf": [
                              {
                                "type": "integer",
                                "minimum": 1
                              },
                              {
                                "type": "null"
                              }
                            ]
                          },
                          "displayProperty": {
                            "anyOf": [
                              {
                                "type": "string"
                              },
                              {
                                "type": "null"
                              }
                            ]
                          },
                          "identificationProperty": {
                            "anyOf": [
                              {
                                "type": "string"
                              },
                              {
                                "type": "null"
                              }
                            ]
                          },
                          "additionalProperties": {
                            "type": "array",
                            "items": {
                              "type": "string"
                            }
                          },
                          "createdAt": {
                            "type": "string",
                            "format": "date-time"
                          },
                          "createdBy": {
                            "anyOf": [
                              {
                                "type": "integer",
                                "minimum": 1,
                                "maximum": 9007199254740991
                              },
                              {
                                "type": "null"
                              }
                            ]
                          },
                          "createdByUserName": {
                            "anyOf": [
                              {
                                "type": "string",
                                "minLength": 1,
                                "maxLength": 255
                              },
                              {
                                "type": "null"
                              }
                            ]
                          },
                          "updatedAt": {
                            "type": "string",
                            "format": "date-time"
                          },
                          "updatedBy": {
                            "anyOf": [
                              {
                                "type": "integer",
                                "minimum": 1,
                                "maximum": 9007199254740991
                              },
                              {
                                "type": "null"
                              }
                            ]
                          },
                          "updatedByUserName": {
                            "anyOf": [
                              {
                                "type": "string",
                                "minLength": 1,
                                "maxLength": 255
                              },
                              {
                                "type": "null"
                              }
                            ]
                          },
                          "archived": {
                            "type": "boolean"
                          }
                        }
                      }
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "This error ist returned if authentication of the request was not successful. For more information read our article about [authentication](https://developer.operations1.com/reference/authentication).",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "required": [
                    "message",
                    "errorCode"
                  ],
                  "properties": {
                    "message": {
                      "type": "string",
                      "description": "Error message"
                    },
                    "errorCode": {
                      "type": "string",
                      "enum": [
                        "UNAUTHENTICATED"
                      ]
                    }
                  },
                  "description": "This error ist returned if authentication of the request was not successful. For more information read our article about [authentication](https://developer.operations1.com/reference/authentication)."
                }
              }
            }
          },
          "403": {
            "description": "This error is returned if you do not have the necessary permissions for the endpoint.",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "required": [
                    "message",
                    "errorCode"
                  ],
                  "properties": {
                    "message": {
                      "type": "string",
                      "description": "Error message"
                    },
                    "errorCode": {
                      "type": "string",
                      "enum": [
                        "ACCESS_FORBIDDEN"
                      ]
                    }
                  },
                  "description": "This error is returned if you do not have the necessary permissions for the endpoint."
                }
              }
            }
          },
          "429": {
            "description": "This error is returned if your request was not executed due to rate limit. For more information read our article about [rate limiting](https://developer.operations1.com/reference/rate-limiting).",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "required": [
                    "message",
                    "errorCode"
                  ],
                  "properties": {
                    "message": {
                      "type": "string",
                      "description": "Error message"
                    },
                    "errorCode": {
                      "type": "string",
                      "enum": [
                        "TOO_MANY_REQUESTS"
                      ]
                    }
                  },
                  "description": "This error is returned if your request was not executed due to rate limit. For more information read our article about [rate limiting](https://developer.operations1.com/reference/rate-limiting)."
                }
              }
            }
          },
          "default": {
            "description": "General errors",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "required": [
                    "message",
                    "errorCode"
                  ],
                  "properties": {
                    "message": {
                      "type": "string",
                      "description": "Error message"
                    },
                    "errorCode": {
                      "enum": [
                        "SERVER_ERROR",
                        "ROUTE_NOT_FOUND",
                        "NOT_FOUND",
                        "API_VERSION_NOT_SET",
                        "TOO_MANY_REQUESTS",
                        "UNAUTHENTICATED",
                        "ACCESS_FORBIDDEN",
                        "VALIDATION_ERR",
                        "INVALID_TENANT",
                        "MALFORMED_AUTHORIZATION_HEADER",
                        "BAD_REQUEST"
                      ],
                      "type": "string",
                      "description": "Error code"
                    }
                  },
                  "description": "General errors"
                }
              }
            }
          }
        }
      }
    }
  },
  "servers": [
    {
      "url": "https://api.operations1.app"
    }
  ],
  "security": [
    {
      "bearerAuth": []
    }
  ]
}
```