---
title: "Create a company shell"
method: POST
path: "/api/v0/company_shells"
tags: ["Company shells"]
---

# Create a company shell

`POST /api/v0/company_shells`

## Request

- Base URL: `https://www.getonbrd.com`
- URL: `https://www.getonbrd.com/api/v0/company_shells`
- Auth: HTTP bearer
- TypeScript: <https://skmtc.dev/getonbrd/apis/get-on-board-api/docs/api/v0/company_shells/post.ts> (a function with typed inputs; its response is checked against the schema)

## Headers

- `Authorization` string, required

## Request body

- object
  - `company_shell` object, required
    - `name` string, required
    - `description` string, required
    - `web` string, required
    - `remote_logo_url` string, required

## Response `201`

Creates a partner-owned public shell profile that can later be referenced as `company_shell_id` on job create/update requests. A logo is required: send either a multipart `logo` file or a `remote_logo_url`; requests without one fail with 422 `logo can't be blank`. `remote_logo_url` must be a publicly reachable https URL — private or internal hosts are rejected with `could not download logo`. Partner-only: requires an authorized partner account; standard company API keys receive 403.

- object
  - `data` object, required
    - `id` string, required
    - `type` string, required
    - `attributes` object, required
      - `name` string, required
      - `description` string, required
      - `web` string, required
      - `logo` string, required

## Other responses

- `403`: Creates a partner-owned public shell profile that can later be referenced as `company_shell_id` on job create/update requests. A logo is required: send either a multipart `logo` file or a `remote_logo_url`; requests without one fail with 422 `logo can't be blank`. `remote_logo_url` must be a publicly reachable https URL — private or internal hosts are rejected with `could not download logo`. Partner-only: requires an authorized partner account; standard company API keys receive 403.
- `422`: Creates a partner-owned public shell profile that can later be referenced as `company_shell_id` on job create/update requests. A logo is required: send either a multipart `logo` file or a `remote_logo_url`; requests without one fail with 422 `logo can't be blank`. `remote_logo_url` must be a publicly reachable https URL — private or internal hosts are rejected with `could not download logo`. Partner-only: requires an authorized partner account; standard company API keys receive 403.

---

[API](https://skmtc.dev/getonbrd/apis/get-on-board-api.md) - [All operations](https://skmtc.dev/getonbrd/apis/get-on-board-api/llms.txt) - [OpenAPI document](https://skmtc.dev/getonbrd/apis/get-on-board-api/revisions/f8405113049f?raw)