---
title: "Get a Company Onboarding"
method: GET
path: "/2024-11/company_onboardings/{external_id}"
tags: ["Companies"]
---

# Get a Company Onboarding

`GET /2024-11/company_onboardings/{external_id}`

Retrieve a Company Onboarding.

Required authorization scope: `enterprise.company:read`

## Response `200`

Company onboarding found

- CompanyOnboardingSingle — Company Onboarding Detail
  - `company_onboarding` CompanyOnboarding
    - `app_access` AppAccess, required
      - `url` string, uri — App Access redirect URL with one time token
      - `expires_at` string, datetime — Expiry time for URI
    - `completed_at` string, date-time, nullable, required — When the onboarding was completed
    - `created_at` string, date-time, required — When the Company Onboarding was created
    - `easyship_company_id` string, nullable, required — Easyship Company ID of the onboarded Company. Only present after the Company Onboarding is completed.
    - `external_id` string, required — External identifier of the Company to onboard.
  - `meta` Meta
    - `request_id` string — An unique ID represent the request.

## Other responses

- `404` — Company onboarding not found

---

[API](https://skmtc.net/easyship/apis/easyship-public-api.md) · [All operations](https://skmtc.net/easyship/apis/easyship-public-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/easyship/easyship-public-api/revisions/71d737a5fcbf/schema)