Get a company by id

Prev Next
Get
/GetCompany

Allows you to retrieve a company and their details by their Id.

Security
API Key
Header parameter nameapi_key
Query parameters
id
integer (int32) Required

The ID of the company to retrieve

Responses
200

OK Response

Expand All
object
Status
integer (int32)

Indicates the status of the API request.

0 = Success
10 = Error
20 = Not found
30 = Invalid integration key

Example10
Error
string | null

Error details. This will only have a value if an error was encountered. The status property will also be set to Error (10).

Company
Array of object (Company)

See Company results.

object
Id
integer (int32)

The company's unique identifier.

Name
string

The Name of the company

ExternalId
string | null

The External Id of the company

Description
string | null

The Description of the company

OrganizationId
integer (int32)

The Id of the Organization associated with this company

OwningUserId
integer (int32) | null

The Id of the owning User (if any) associated with this company

AssignableToUsers
boolean

Indicates whether the Company is Assignable to Users

Theme
string | null

The name of the Theme to be used for the company

Address1
string | null

The first Address line for a Company

Address2
string | null

The second Address line for a Company

City
string | null

The City for a Company

State
string | null

The State for a Company (recommended use standard 2-character abbreviation, limit 50 characters)

Zip
string | null

The Zip code for a Company

Country
string | null

The Country for a Company (recommended use standard 2-character abbreviation, limit 80 characters)

Email
string | null

The Email address for a Company

Phone
string | null

The Phone number for a Company

Phone2
string | null

The alternate Phone number for a Company

Fax
string | null

The Fax number for a Company

WebSiteUrl
string | null

The Web Site Url for a Company

CustomDropdown1
string | null

The first Custom Dropdown list for a Company

CustomDropdown2
string | null

The second Custom Dropdown list for a Company