Company

A company represents an account in the interview suite with a unique identifier represented by the subdomain (e.g. supercompany.interview-suite.com). A company contains projects, candidates, customers, templates and so on.

A company can only be updated and accessed as an object. A company listing is not available.

Attributes

Name	Type	Description
name	string
city	string
country	reference
address	string
state_province	string	optional
division	string	optional
phone	string	optional
postcode	string	optional
billing_settings	reference	read only
design_settings	reference	read only
account_settings	reference	read only
security_settings	reference	read only
features	list	read only

Object

/companies/{{companyId}}/

or

/company-by-identifier/{{identifier}}/

Methods

• GET
• PATCH

Example response

{
  "name":"viasto",
  "division":"",
  "address":"Mehringdahm 32",
  "postcode":"1234",
  "city":"Berlin",
  "state_province":"",
  "country":"https://interview-suite.com/api/v3/countries/1/",
  "phone":"",
  "account_settings":"https://interview-suite.com/api/v3/companies/1/settings/",
  "security_settings":"https://interview-suite.com/api/v3/companies/1/security/",
  "billing_settings":"https://interview-suite.com/api/v3/companies/1/billing/",
  "design_settings":"https://interview-suite.com/api/v3/companies/1/design/",
  "features": ["Share Candidates", "Veto Candidates", "Template"]
}