New to Corsair? See API access, authentication, and error handling.
Customers
list
customers.list
List the account customers, with field selection, sorting and paging
Risk: read
A customer and a subscriber have the same documented properties, so both are the same shape here.
Output
items full type
items full type
metadata full type
metadata full type
Locations
customers
locations.customers
List the customers seen at one location, with their contact details and social profiles
Risk: read
Output
items full type
items full type
metadata full type
metadata full type
list
locations.list
List the account locations, with field selection, sorting and paging
Risk: read
Returns
items and metadata.total_count. next_offset is absent on the last page.
Output
items full type
items full type
metadata full type
metadata full type
macTransactions
locations.macTransactions
List the device MAC transactions at one location, with the device answers collected
Risk: read
Output
items full type
items full type
metadata full type
metadata full type
options
locations.options
List the account locations as id and name pairs for a picker; no paging
Risk: read
{ items } with no metadata and no paging, for filling a picker.
Output
items full type
items full type
paidTransactions
locations.paidTransactions
List the paid transactions at one location, with amounts and currencies
Risk: read
Output
items full type
items full type
metadata full type
metadata full type
socialTransactions
locations.socialTransactions
List social-login transactions at one location
Risk: read
Output
items full type
items full type
metadata full type
metadata full type
subscribers
locations.subscribers
List the subscribers seen at one location, with their contact details and social profiles
Risk: read
Output
items full type
items full type
metadata full type
metadata full type
vouchers
locations.vouchers
List the vouchers issued at one location, with their validity and traffic limits
Risk: read
Output
items full type
items full type
metadata full type
metadata full type
voucherTransactions
locations.voucherTransactions
List the voucher transactions at one location, with the voucher used and the amount
Risk: read
Output
items full type
items full type
metadata full type
metadata full type
Me
get
me.get
Read the resource owner behind the key: a user ID and an operator name
Risk: read
{ userId, operator }.
Output
Ping
check
ping.check
Confirm the API answers: returns pong. Needs a key, because Corsair resolves one before every call
Risk: read
{ ping: "pong" }. The endpoint needs no key, but Corsair resolves one before every call, so a connected account is still required.
Output
Subscribers
list
subscribers.list
List the account subscribers, with field selection, sorting and paging
Risk: read
Output
items full type
items full type
metadata full type
metadata full type
Transactions
mac
transactions.mac
List device MAC transactions across the account, with the device answers collected
Risk: read
The Swagger documents every field of a MAC transaction as
TODO, so nothing is required and the values are passed through as sent.
Output
items full type
items full type
metadata full type
metadata full type
paid
transactions.paid
List paid transactions across the account, with amounts and currencies
Risk: read
Output
items full type
items full type
metadata full type
metadata full type
social
transactions.social
List social-login transactions across the account, with the network used
Risk: read
Output
items full type
items full type
metadata full type
metadata full type
voucher
transactions.voucher
List voucher transactions across the account, with the voucher used and the amount
Risk: read
Output
items full type
items full type
metadata full type
metadata full type
Vouchers
list
vouchers.list
List the account vouchers with their traffic limits, validity and price
Risk: read
limit_tl, limit_dl and limit_ul are bytes, and are -1 when the voucher has no location context.
Output
items full type
items full type
metadata full type
metadata full type