v1

latestOpenAPI 3.0.3Apache 2.02026-08-062991191002.1 KB

Organization

Retrieves a Organization resource.

get/organizations/{id}

Path parameters

idstring required

Resource identifier

Response

Organization resource

idstring

integrationstring

The key of the integration source e.g. "quickbooks", or "xero"

namestring

Company name

legalNamestring nullable

legal name

primaryPhonestring nullable

Primary phone number of the company

emailstring nullable

Primary email address associated to the company

addressLine1string nullable

Line1 address of the company

addressLine2string nullable

citystring nullable

countrystring nullable

Country of the company location

postalCodestring nullable

Postalcode of the company location

startDatestring nullable

createdstring nullable

modifiedstring nullable

OrganisationTypestring nullable

Type of the organization e.g: charity e.g: not_for_profit e.g: partnership

employeeCountinteger nullable

Number of employees in the company

websitestring nullable

Website address of the comapny

annualRevenuestring nullable

descriptionstring nullable

Further details about the company

industrystring nullable

The industry company belongs to e.g: banking

locationCountinteger nullable

Number of locations company has

industryCodestring nullable

NAICS/SIC industry code for the company

organisationTypestring nullable

Example response

{
  "id": "quickbooks-726",
  "integration": "quickbooks",
  "name": "Bobs Sandwiches",
  "legalName": "Bobs Sandwiches",
  "primaryPhone": "4165769834",
  "email": "bobs.sandwiches@gmail.com",
  "addressLine1": "23 berkly street",
  "addressLine2": "45 portland road",
  "city": "Toronto",
  "country": "Canada",
  "postalCode": "H7F5R3",
  "startDate": "2021-06-25T20:39:32+00:00",
  "created": "2021-06-25T20:39:32+00:00",
  "modified": "2021-09-16T20:39:32+00:00",
  "OrganisationType": "charity",
  "employeeCount": 75,
  "website": "bobssandwiches.com",
  "annualRevenue": "45000000000",
  "description": "Best burgers in the world",
  "industry": "hospitality",
  "locationCount": 4,
  "industryCode": "441221"
}