Skip to main content
GET
List companies

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

has_usage
boolean

Filter companies by metered usage. true returns only companies with at least one recorded usage event; false returns companies with none.

page
integer

Page number (default: 1)

Filter by company name (case-insensitive)

tier
enum<string>

Commercial tier for this company. Drives entitlements and billing posture.

  • free - Free
  • pay-as-you-go - Pay-as-you-go
  • business - Business
Available options:
business,
free,
pay-as-you-go

Response

List of companies with DRF pagination (count, next, previous, results)

count
integer
required
Example:

123

results
object[]
required
next
string<uri> | null
Example:

"http://api.example.org/accounts/?page=4"

previous
string<uri> | null
Example:

"http://api.example.org/accounts/?page=2"