Core API
This section documents the GraphQL API for the Core module.
Types
User
Fields:
| Name | Type | Description |
|---|---|---|
| id | ID! | Unique identifier |
| firstName | String! | User’s first name |
| lastName | String! | User’s last name |
String! | User’s email address | |
| uiLanguage | String! | Preferred UI language |
| updatedAt | Time! | Last update timestamp |
| createdAt | Time! | Creation timestamp |
PaginatedUsers
Fields:
| Name | Type | Description |
|---|---|---|
| data | [User!]! | List of users |
| total | Int64! | Total user count |
Upload
Represents a file upload in the system.
Fields (align with schema):
| Name | Type | Description |
|---|---|---|
| id | ID! | Unique identifier |
| name | String! | File name |
| url | String! | File access URL |
| path | String! | Storage path |
| hash | String! | Content hash |
| slug | String! | Slug |
| mimetype | String! | MIME type |
| type | UploadType! | Upload type |
| size | Int! | File size in bytes |
| geoPoint | GeoPoint! | Geo data |
Queries
user
Fetch a single user by ID.
user(id: ID!): Userusers
Fetch a paginated list of users.
users(offset: Int!, limit: Int!, sortBy: [Int!], ascending: Boolean!): PaginatedUsers!Arguments:
| Name | Type | Description |
|---|---|---|
| offset | Int! | Pagination offset |
| limit | Int! | Number of results to return |
| sortBy | [Int!] | Sort field indices |
| ascending | Boolean! | Sort direction |
uploads
Fetch uploads with an optional filter. (There is no me or single-upload upload(id) query in the current Core schema; use user(id) with the current user ID if needed.)
uploads(filter: UploadFilter!): [Upload!]!Arguments:
| Name | Type | Description |
|---|---|---|
| filter | UploadFilter! | Filter by mimeType, mimeTypePrefix, type, sort |
Mutations
User create/update/delete are not exposed in the Core GraphQL schema; use REST endpoints (e.g. POST/GET/DELETE /users, /users/:id) for user management.
uploadFile
Upload a new file.
uploadFile(file: File, opts: UploadFileOpts): Upload!uploadFileWithSlug
Upload a file with a custom slug.
uploadFileWithSlug(file: File, slug: String!, opts: UploadFileOpts): Upload!authenticate
Authenticate a user (GraphQL). Session is returned; end session via REST GET /logout or cookie.
authenticate(email: String!, password: String!): Session!Subscriptions
counter
Real-time counter for testing subscriptions.
counter: Int!Scalars
Time
ISO 8601 timestamp.
Int64
64-bit integer for large numbers.
This documentation is auto-generated from GraphQL schema files. Last updated: 2026-01-31