Skip to main content
GET
Get Business Data

Authorizations

Authorization
string
header
required

API key for accessing CivOps endpoints.

Passed in the Authorization: Bearer <key> header.

REQUIRED FOR ALL CIVOPS ENDPOINTS (except /health).

Query Parameters

action
enum<string>
required

Action type for retrieving data.

Available options:
list,
info,
balance,
employees,
store,
transfers,
rating,
pending
businessId
string

Business ID (for info, balance, employees, transfers).

businessName
string

Business name.

limit
integer
default:10

Record limit.

page
integer
default:1

Page number.

Response

Successful response with business data.

The response is of type object.