email Contact Us
  1. Harvest API V2 Documentation
  2. Company API
  3. Company

Company

Admin permissions required.

The company object

Attribute Type Description
base_uri string The Harvest URL for the company.
full_domain string The Harvest domain for the company.
name string The name of the company.
is_active boolean Whether the company is active or archived.
week_start_day string The weekday used as the start of the week. Returns one of: Saturday, Sunday, or Monday.
wants_timestamp_timers boolean Whether time is tracked via duration or start and end times.
time_format string The format used to display time in Harvest. Returns either decimal or hours_minutes.
date_format string The format used to display date in Harvest. Returns one of: %m/%d/%Y, %d/%m/%Y, %Y-%m-%d, %d.%m.%Y,.%Y.%m.%d or %Y/%m/%d.
plan_type string The type of plan the company is on. Examples: trial, free, or simple-v4
clock string Used to represent whether the company is using a 12-hour or 24-hour clock. Returns either 12h or 24h.
currency_code_display string How to display the currency code when formatting currency. Returns one of: iso_code_none, iso_code_before, or iso_code_after.
currency_symbol_display string How to display the currency symbol when formatting currency. Returns one of: symbol_none, symbol_before, or symbol_after.
decimal_symbol string Symbol used when formatting decimals.
thousands_separator string Separator used when formatting numbers.
color_scheme string The color scheme being used in the Harvest web client.
weekly_capacity integer The weekly capacity in seconds.
expense_feature boolean Whether the expense module is enabled.
invoice_feature boolean Whether the invoice module is enabled.
estimate_feature boolean Whether the estimate module is enabled.
approval_feature boolean Whether the approval module is enabled.
team_feature boolean Whether the team module is enabled.

Retrieve a company

Retrieves the company for the currently authenticated user. Returns a company object and a 200 OK response code.

GET /v2/company

Example requests:

Postman Collection

We have a collection of API requests in Postman that makes it easy to try this out. Click here to learn more!


curl "https://api.harvestapp.com/v2/company" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  -H "Harvest-Account-Id: $ACCOUNT_ID" \
  -H "User-Agent: MyApp ([email protected])"

Example response:

{
  "base_uri":"https://{ACCOUNT_SUBDOMAIN}.harvestapp.com",
  "full_domain":"{ACCOUNT_SUBDOMAIN}.harvestapp.com",
  "name":"API Examples",
  "is_active":true,
  "week_start_day":"Monday",
  "wants_timestamp_timers":true,
  "time_format":"hours_minutes",
  "date_format":"%Y-%m-%d",
  "plan_type":"sponsored",
  "expense_feature":true,
  "invoice_feature":true,
  "estimate_feature":true,
  "approval_feature":true,
  "clock":"12h",
  "currency_code_display":"iso_code_none",
  "currency_symbol_display":"symbol_before",
  "decimal_symbol":".",
  "thousands_separator":",",
  "color_scheme":"orange",
  "weekly_capacity": 126000
}

Update a company

Updates the company setting the values of the parameters passed. Any parameters not provided will be left unchanged. Returns a company object and a 200 OK response code if the call succeeded.

PATCH /v2/company
Attribute Type Description
wants_timestamp_timers boolean Whether time is tracked via duration or start and end times.
weekly_capacity integer The weekly capacity in seconds.

Example requests:

Postman Collection

We have a collection of API requests in Postman that makes it easy to try this out. Click here to learn more!


curl "https://api.harvestapp.com/v2/company" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  -H "Harvest-Account-Id: $ACCOUNT_ID" \
  -H "User-Agent: MyApp ([email protected])"
  -X PATCH \
  -H "Content-Type: application/json" \
  -d '{"weekly_capacity":108000, "wants_timestamp_timers":false}'

Example response:

{
  "base_uri":"https://{ACCOUNT_SUBDOMAIN}.harvestapp.com",
  "full_domain":"{ACCOUNT_SUBDOMAIN}.harvestapp.com",
  "name":"API Examples",
  "is_active":true,
  "week_start_day":"Monday",
  "wants_timestamp_timers":false,
  "time_format":"hours_minutes",
  "date_format":"%Y-%m-%d",
  "plan_type":"sponsored",
  "expense_feature":true,
  "invoice_feature":true,
  "estimate_feature":true,
  "approval_feature":true,
  "clock":"12h",
  "currency_code_display":"iso_code_none",
  "currency_symbol_display":"symbol_before",
  "decimal_symbol":".",
  "thousands_separator":",",
  "color_scheme":"orange",
  "weekly_capacity": 108000
}

Still have questions? We’re happy to help!

Contact Us