List all (or one) companies.
Endpoint URL
https://dashboard-api.revnue.com/api/v2/company
Authentication and rate limits
Item | Details |
|---|---|
Authentication method | |
Rate limit |
Requests Example
curl --request GET \
--url 'https://dashboard-api.revnue.com/api/v2/company' \
--header 'Authorization: Bearer $BEARER_TOKEN'
curl --request GET \
--url 'https://dashboard-api.revnue.com/api/v2/company/$id' \
--header 'Authorization: Bearer $BEARER_TOKEN'
Query Parameters
- id (integer) --
Optional if you want to list a specific company ID. The id parameter is passed as part of the request url
/company/$id.
Response Syntax
{
"id": integer,
"name": "string",
"status": "active" | "archived"
}
Response Fields
- id (integer) --
The ID of the company.
- name (string) --
The name of the company.
- status (string) --
The status of the company.