GET
Get Company Profile

Overview

This endpoint returns detailed information about the authenticated company, including contact details, configuration, and basic statistics.

Authentication

Requires a valid OAuth 2.0 access token with the company:read scope.

Request

string
required
Bearer token for authentication

Example Request

Response

boolean
Always false for successful requests
string
Success message
object
Company profile data

Success Response

Error Responses

Rate Limiting

This endpoint is subject to rate limiting. See the Rate Limits documentation for details. Rate Limit: 1,000 requests per hour

Usage Notes

  • The company profile contains sensitive information and should be cached appropriately
  • Use the Get Company Statistics endpoint for aggregate counts and metrics