Object overview

The Company Object

The company object represents the business entity associated with your API key. Each API key is scoped to exactly one company, so GET /companies returns a single company record rather than a list.


Returned by

EndpointShape
GET /companiesCompany

Field Reference

FieldTypeDescription
company_idintegerUnique company identifier.
namestringCompany name.
emailstringCompany contact email.
phonestring | nullCompany phone number.
timezonestring | nullIANA timezone identifier (e.g. "America/New_York").
start_datedate-time | nullWhen the company started using Friday.
default_pay_periodstring | nullDefault pay period type (e.g. "biweekly", "weekly").
addressAddress | nullCompany mailing address.
plan_namestring | nullCurrent subscription plan name (e.g. "Time Tracking + Payroll").

Example

{
  "company_id": 42,
  "name": "Acme Corp",
  "email": "[email protected]",
  "phone": "+1-555-123-4567",
  "timezone": "America/New_York",
  "start_date": "2024-01-15T00:00:00.000Z",
  "default_pay_period": "biweekly",
  "address": {
    "address_line_1": "100 Main Street",
    "address_line_2": "Suite 300",
    "city": "New York",
    "state": "NY",
    "zip": "10001",
    "country": "US"
  },
  "plan_name": "Time Tracking + Payroll"
}

Related