Skip to main content
GET
Get Agency Company Details

Authorizations

Authorization
string
header
required

Agency API Key

Path Parameters

company_id
string
required

The ID of the company

Query Parameters

tab
enum<string>
default:agents

Data type to retrieve

Available options:
agents,
modules,
phone,
transactions
date
string<date-time>

ISO-8601 datetime for single month (default: current month)

start_date
string<date-time>

ISO-8601 datetime for date range start

end_date
string<date-time>

ISO-8601 datetime for date range end

page
integer
default:1

Page number for pagination

Response

Company details retrieved successfully

name
string

Logo URL

email
string
active
boolean
settings
object
billing
object