Factuarea APIDevelopers

List all events

List events in your event log with cursor-based pagination.

  • Each event records something that happened in your account (an invoice was paid, a quote accepted, …) and is the same object delivered to your webhook endpoints.
  • Supports filtering by type[in] and created[gte|lte].
GET
/events
AuthorizationBearer <token>

In: header

Query Parameters

limit?integer

Number of objects to return. Integer between 1 and 100. Defaults to 25.

Default25
Range1 <= value <= 100
starting_after?string

Cursor for forward pagination. Use the uuid of the last object on the previous page.

Formatuuid
ending_before?string

Cursor for backward pagination. Use the uuid of the first object on the current page.

Formatuuid
type?string

Event type (e.g. invoice.created). Exact match on type.

type[in]?string

Event type (e.g. invoice.created). Comma-separated list. Any of the values matches.

created[gte]?string

Creation date (ISO 8601). Greater than or equal to the given value.

Formatdate-time
created[lte]?string

Creation date (ISO 8601). Less than or equal to the given value.

Formatdate-time
created[gt]?string

Creation date (ISO 8601). Strictly greater than the given value.

Formatdate-time
created[lt]?string

Creation date (ISO 8601). Strictly less than the given value.

Formatdate-time

Headers

Factuarea-Version?string

Pin the API version (YYYY-MM-DD, Stripe-style date versioning) for this request; omit to use the key's pinned version, or the latest if none. Unsupported version → 400 unsupported_api_version; malformed → 400 parameter_invalid_format. The effective version is echoed in the Factuarea-Version response header. See the Versioning guide.

Formatdate
X-Active-Profile?string

Operate on behalf of a child company (gestoría master key): pass its public id (UUID v7) and the request runs against that child's data without changing the key's scope, tier or environment (omit to use the key's own company). Invalid UUID → 400 parameter_invalid_uuid; unknown or non-owned id → 404 profile_not_found. See the Acting on behalf guide.

Formatuuid

Response Body

application/json

application/json

application/json

application/json

application/json

application/json