01.software Docs

List Events

Use the SDK for application integration. This read-only reference covers Commerce, Customer Auth, Membership and Events.

All HTTP operations
GET
/api/events

List documents from this collection. For generated application code, prefer the TypeScript SDK; use this REST contract for direct HTTP clients and GPT Actions.

Authorization

publishableKey
headerX-Publishable-Key<token>

Tenant publishable key for authentication (sent via X-Publishable-Key header)

Query Parameters

limit?integer

Number of documents to return

Range1 <= value <= 100
Default10
page?integer

Page number

Range1 <= value
Default1
sort?string

Sort field. Prefix with - for descending (e.g. -createdAt)

depth*0

Relationship population depth. Browser publishable-key reads must send depth=0 exactly once; any other value, a repeated key, or an omitted key is rejected. Relationship expansion requires a server credential.

Default0
Value in0
joins*"false"

Join field population. Browser publishable-key reads must send joins=false exactly once; any other value, a repeated key, or an omitted key is rejected. Join expansion requires a server credential.

Default"false"
Value in"false"
where?

Query filter (qs-encoded). Example: where[status][equals]=published

Response Body

List of Events

application/json
  1. response
docs*array<>
totalDocs*integer
limit*integer
totalPages*integer
page*integer
pagingCounter*integer
hasPrevPage*boolean
hasNextPage*boolean
prevPage?integer|null
nextPage?integer|null

Examples may be generated from schemas; they are illustrative, not recorded successful API calls. Example snippets may omit required authentication headers.

Example Request
curl -X GET 'https://api.01.software/api/events?depth=0&joins=false'
Example Response
{  "docs": [    {      "id": "doc_123"    }  ],  "totalDocs": 1,  "limit": 10,  "totalPages": 1,  "page": 1,  "pagingCounter": 1,  "hasPrevPage": false,  "hasNextPage": false,  "prevPage": null,  "nextPage": null}