GET Api/v1/Company

Returns information about the authenticated company.

Request Information

URI Parameters

None.

Body Parameters

None.

Response Information

Resource Description

CompanyViewModel

Name	Type	Additional information
Id	integer	None.
PublicId	string	None.
Name	string	None.
Address	AddressViewModel	None.
UsDotCompanyName	string	None.
UsDotNumber	string	None.
NscCompanyName	string	None.
NscNumber	string	None.
Organization	OrganizationViewModel	None.
Organizations	Collection of OrganizationViewModel	None.
OilfieldPermitNumber	string	None.
OilfieldPermitEffective	date	None.
OilfieldPermitExpiry	date	None.

Response Formats

application/json, text/json

Sample:

{
  "id": 1,
  "publicId": "sample string 2",
  "name": "sample string 3",
  "address": {
    "id": 1,
    "addressLine1": "sample string 2",
    "addressLine2": "sample string 3",
    "addressLine3": "sample string 4",
    "city": "sample string 5",
    "stateProvince": "sample string 6",
    "country": "sample string 7",
    "postalCode": "sample string 8"
  },
  "usDotCompanyName": "sample string 4",
  "usDotNumber": "sample string 5",
  "nscCompanyName": "sample string 6",
  "nscNumber": "sample string 7",
  "organization": {
    "id": 1,
    "name": "sample string 2",
    "address": {
      "id": 1,
      "addressLine1": "sample string 2",
      "addressLine2": "sample string 3",
      "addressLine3": "sample string 4",
      "city": "sample string 5",
      "stateProvince": "sample string 6",
      "country": "sample string 7",
      "postalCode": "sample string 8"
    },
    "usDotCompanyName": "sample string 3",
    "usDotNumber": "sample string 4",
    "nscCompanyName": "sample string 5",
    "nscNumber": "sample string 6"
  },
  "organizations": [
    {
      "id": 1,
      "name": "sample string 2",
      "address": {
        "id": 1,
        "addressLine1": "sample string 2",
        "addressLine2": "sample string 3",
        "addressLine3": "sample string 4",
        "city": "sample string 5",
        "stateProvince": "sample string 6",
        "country": "sample string 7",
        "postalCode": "sample string 8"
      },
      "usDotCompanyName": "sample string 3",
      "usDotNumber": "sample string 4",
      "nscCompanyName": "sample string 5",
      "nscNumber": "sample string 6"
    },
    {
      "id": 1,
      "name": "sample string 2",
      "address": {
        "id": 1,
        "addressLine1": "sample string 2",
        "addressLine2": "sample string 3",
        "addressLine3": "sample string 4",
        "city": "sample string 5",
        "stateProvince": "sample string 6",
        "country": "sample string 7",
        "postalCode": "sample string 8"
      },
      "usDotCompanyName": "sample string 3",
      "usDotNumber": "sample string 4",
      "nscCompanyName": "sample string 5",
      "nscNumber": "sample string 6"
    }
  ],
  "oilfieldPermitNumber": "sample string 8",
  "oilfieldPermitEffective": "2025-04-21T04:57:14.7783104-06:00",
  "oilfieldPermitExpiry": "2025-04-21T04:57:14.7783104-06:00"
}