View Company details

get/companies/{id}

Request

Base URL
https://www.harborcompliance.com/api/v1
Auth
OAuth 2
Authorization code/api/v1/oauth/authorize
Token URL/api/v1/oauth/access_token
TypeScript
https://skmtc.dev/harborcompliance/apis/harbor-compliance-api/docs/companies/:id/get.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

idstring uuid required

Resource UUID

Query parameters

includestring[]

Comma-separated list of related resources to include for companies.

Response

Success

Example response

{
  "data": {
    "domicile": {
      "id": "123e4567-e89b-12d3-a456-426614174000"
    },
    "principal_address": {
      "administrative_area": {
        "id": "123e4567-e89b-12d3-a456-426614174000"
      },
      "country": {
        "id": "123e4567-e89b-12d3-a456-426614174000"
      }
    },
    "mailing_address": {
      "administrative_area": {
        "id": "123e4567-e89b-12d3-a456-426614174000"
      },
      "country": {
        "id": "123e4567-e89b-12d3-a456-426614174000"
      }
    }
  }
}

Changes

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