List Business Unit

List all (or one) business units.

Endpoint URL

https://dashboard-api.revnue.com/api/v2/business-unit

Authentication and rate limits

Item	Details
Authentication method	OAuth 2.0 Bearer token
Rate limit	Rate Limit

Requests Example

curl --request GET \
  --url 'https://dashboard-api.revnue.com/api/v2/business-unit/?company=1' \
  --header 'Authorization: Bearer $BEARER_TOKEN'

curl --request GET \
  --url 'https://dashboard-api.revnue.com/api/v2/business-unit/$id/?company=1' \
  --header 'Authorization: Bearer $BEARER_TOKEN'

Query Parameters

company (integer) --
[REQUIRED]
The ID of the specific company your API is calling. For accounts with only one company, the default value is 1.
To lookup a specific company ID, see the List Company API.
id (integer) --
Optional if you want to list a specific business unit ID. The id parameter is passed as part of the request url /business-unit/$id/.

Response Syntax

{
  "id": integer,
  "name": "string",
  "contact_name": "string",
  "contact_email": "string",
  "contact_phone_number": "string",
  "description": "string"
}

Response Fields

id (integer) --
The ID of the business unit.
name (string) --
The name of the business unit.
contact_name (string) --
The contact name of the business unit.
contact_email (string) --
The contact email of the business unit.
contact_phone_number (string) --
The contact phone number of the business unit.
description (string) --
The description of the business unit.