List all (or one) usage status

Endpoint URL

https://{{base_url}}/api/v2/usage-status

Authentication and rate limits

ItemDetails
Authentication methodOAuth 2.0 Bearer token
Rate limitRate Limit

Requests Example

curl --request GET \
  --url 'https://{{base_url}}/api/v2/usage-status/?company=1' \
  --header 'Authorization: Bearer $BEARER_TOKEN'
curl --request GET \
  --url 'https://dashboard-api.revnue.com/api/v2/category/$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 usage status ID. The id parameter is passed as part of the request url /usage-status/$id/.

  • name (integer) --

    Optional if you want to list a usage status by name. The name parameter is passed as part of the request url /usage-status/?company=1&name={{usage-status_name}}.

Response Syntax

{
    "id": integer,
    "company_id": integer,
    "name": "string",
    "set_as_default": false, true
}

Response Fields

  • id (integer) --

    The ID of the usage status.

  • company id (integer) --

    The company ID.

  • name (string) --

    The name of the usage status.

  • set_as_default (boolean) --

    Whether the usage status value is set as default.
    Options: true | false