List Company

List all (or one) companies.

Endpoint URL

https://{{base_url}}/api/v2/company

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/company" \
  --header 'Authorization: Bearer $BEARER_TOKEN'
curl --request GET \
  --url "https://{{base_url}}/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"
}
Language
Click Try It! to start a request and see the response here!