Skip to content
BoxBilling

List events

GET
/v1/events/

List events with optional filters.

Parameters

Section titled “ Parameters ”

Query Parameters

Section titled “Query Parameters ”
skip
Skip
integer
0
limit
Limit
integer
default: 100 >= 1 <= 1000
order_by
Any of:
string
external_customer_id
Any of:
string
code
Any of:
string
from_timestamp
Any of:
string format: date-time
to_timestamp
Any of:
string format: date-time

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Successful Response

Response List Events V1 Events Get
Array<object>
EventResponse
object
id
required
Id
string format: uuid
transaction_id
required
Transaction Id
string
external_customer_id
required
External Customer Id
string
code
required
Code
string
timestamp
required
Timestamp
string format: date-time
properties
required
Properties
object
key
additional properties
any
created_at
required
Created At
string format: date-time

401

Section titled “401 ”

Unauthorized – invalid or missing API key

422

Section titled “422 ”

Validation Error

HTTPValidationError
object
detail
Detail
Array<object>
ValidationError
object
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string
input
Input
ctx
Context
object