GET api/companies/{id}

Get company details which id = {id}

Request Information

URI Parameters

Name	Description	Type	Additional information
id	The ID of the company.	integer	Required

Body Parameters

None.

Response Information

Resource Description

CompanyDTO

Name	Type	Additional information
Id	integer	None.
Name	string	Required Max length: 150
CompanyLogoUri	string	Data type: Url
Term	integer	None.
CreditLimit	decimal number	Data type: Currency
StripeCustomerId	string	None.
AccountingEmail	string	None.
Email	string	None.
MainCompanyAddress	AddressDTO	None.
Address	AddressDTO	None.
BillingAddress	AddressDTO	None.
Shipping	ShippingDTO	None.
isEnterprise	boolean	None.
isQualified	boolean	None.
WasOnboarded	boolean	None.
WasInvited	boolean	None.
InvitedByCompanyId	integer	None.
ContactFirstName	string	None.
ContactLastName	string	None.
AllAddresses	Collection of AddressDTO	None.
UserPerformance	UserPerformance	None.
CompanyAddedAt	date	None.
CurrencyCode	CurrencyCodes	None.

Response Formats

application/json, text/json

Sample:

{
  "id": 1,
  "name": "sample string 1",
  "companyLogoUri": "sample string 2",
  "term": 1,
  "creditLimit": 1.0,
  "stripeCustomerId": "sample string 3",
  "accountingEmail": "sample string 4",
  "email": "sample string 5",
  "mainCompanyAddress": {
    "id": 1,
    "country": "sample string 1",
    "stateOrProvinceName": "sample string 2",
    "city": "sample string 3",
    "addressLine1": "sample string 4",
    "addressLine2": "sample string 5",
    "zipCode": "sample string 6",
    "postalCode": "sample string 7",
    "isBilling": true,
    "isShipping": true,
    "isMainAddress": true
  },
  "address": {
    "id": 1,
    "country": "sample string 1",
    "stateOrProvinceName": "sample string 2",
    "city": "sample string 3",
    "addressLine1": "sample string 4",
    "addressLine2": "sample string 5",
    "zipCode": "sample string 6",
    "postalCode": "sample string 7",
    "isBilling": true,
    "isShipping": true,
    "isMainAddress": true
  },
  "billingAddress": {
    "id": 1,
    "country": "sample string 1",
    "stateOrProvinceName": "sample string 2",
    "city": "sample string 3",
    "addressLine1": "sample string 4",
    "addressLine2": "sample string 5",
    "zipCode": "sample string 6",
    "postalCode": "sample string 7",
    "isBilling": true,
    "isShipping": true,
    "isMainAddress": true
  },
  "shipping": {
    "id": 1,
    "attention_FreeText": "sample string 1",
    "phoneNumber": "sample string 2",
    "emailAddress": "sample string 3",
    "address": {
      "id": 1,
      "country": "sample string 1",
      "stateOrProvinceName": "sample string 2",
      "city": "sample string 3",
      "addressLine1": "sample string 4",
      "addressLine2": "sample string 5",
      "zipCode": "sample string 6",
      "postalCode": "sample string 7",
      "isBilling": true,
      "isShipping": true,
      "isMainAddress": true
    }
  },
  "isEnterprise": true,
  "isQualified": true,
  "wasOnboarded": true,
  "wasInvited": true,
  "invitedByCompanyId": 1,
  "contactFirstName": "sample string 8",
  "contactLastName": "sample string 9",
  "allAddresses": [
    {
      "id": 1,
      "country": "sample string 1",
      "stateOrProvinceName": "sample string 2",
      "city": "sample string 3",
      "addressLine1": "sample string 4",
      "addressLine2": "sample string 5",
      "zipCode": "sample string 6",
      "postalCode": "sample string 7",
      "isBilling": true,
      "isShipping": true,
      "isMainAddress": true
    },
    {
      "id": 1,
      "country": "sample string 1",
      "stateOrProvinceName": "sample string 2",
      "city": "sample string 3",
      "addressLine1": "sample string 4",
      "addressLine2": "sample string 5",
      "zipCode": "sample string 6",
      "postalCode": "sample string 7",
      "isBilling": true,
      "isShipping": true,
      "isMainAddress": true
    }
  ],
  "userPerformance": {
    "userName": "sample string 1",
    "userLocation": {
      "id": 1,
      "country": "sample string 1",
      "stateOrProvinceName": "sample string 2",
      "city": "sample string 3",
      "addressLine1": "sample string 4",
      "addressLine2": "sample string 5",
      "zipCode": "sample string 6",
      "postalCode": "sample string 7",
      "isBilling": true,
      "isShipping": true,
      "isMainAddress": true
    },
    "partConformance": 1.1,
    "orderConformance": 2.1,
    "onTimeConformance": 1.1,
    "completedParts": 1,
    "completedOrders": 1,
    "avrLeadTime": 1
  },
  "companyAddedAt": "2026-01-12T15:39:46.4005898+00:00",
  "currencyCode": 8
}