API reference
All operations
COMPANY

Fetches all addresses for a specific company.

GET/api/v2/companies/{companyId}/addresses

Authentication

Choose one supported method for this request.

OAuth 2.0 client credentials

Parameters

companyIdpathinteger · int32required

The ID of the company to retrieve addresses for.

Responses

Company addresses retrieved successfully.

Standard response envelopeisSuccessmessageerrorsdata

Read the result from data. When isSuccess is false, errors lists what went wrong. Handling errors

dataCompanyAssignedAddressDto[]

An array. Each item is a CompanyAssignedAddressDto:

  • addressIdinteger · int32
  • companyIdinteger · int32
  • descriptionstring
  • address1string
  • address2string
  • address3string
  • citystring
  • statestring
  • zipstring
  • countystring
  • countrystring
  • longitudenumber · double
  • latitudenumber · double
  • mailingboolean
  • mappingboolean
  • linkedboolean