Companies

Get company by ID

get/companies/{company_id}

Request

  • Base URL: https://api.streamtime.net/v2
  • URL: https://api.streamtime.net/v2/companies/{company_id}
  • Auth: HTTP bearer

Path parameters

company_idinteger required

Response

Company fetched.

idinteger

Company ID

namestring

Company name

branchIdinteger

Branch ID the company belongs to

companyLeadUserIdinteger nullable

Lead user ID for this company

branchNamestring

Branch name

rateCardIdinteger nullable

Rate card ID

taxNumberstring nullable

Tax/GST/VAT number

phone1string nullable

Primary phone number

phone2string nullable

Secondary phone number

websiteAddressstring nullable

Website URL

notesstring nullable

Notes about the company

Example response

{
  "name": "Acme Corporation",
  "branchName": "Head Office",
  "rateCardId": 7,
  "taxNumber": "NZ123-456-789",
  "phone1": "+64 9 123 4567",
  "phone2": "+64 21 987 654",
  "websiteAddress": "https://www.acme.co",
  "notes": "Preferred client"
}

Changes

No recorded changes to this operation across all 1 revision of this API.