---
title: "Invite External"
method: POST
path: "/v1/externals"
tags: ["externals"]
---

# Invite External

`POST /v1/externals`

## Request

- Base URL: `https://api.shapemaker.io` (the document declares no server; this is the origin it was published from)
- URL: `https://api.shapemaker.io/v1/externals`
- Auth: OAuth 2
  - Password
  - Token URL: `/v1/auth`

Invite an external collaborator by email. Creates their account and sends
an invite email with a password setup link. Site grants are applied
afterwards via the sites endpoints.

## Request body

- InviteExternalInput
  - `email` string, required
  - `company` string, required
  - `expiresAtUtc` string, date-time, nullable

## Response `200`

Successful Response

- OrganizationMemberView: One person in the organization, employee or external collaborator. The fields only an external has (granted_site_count, invited_by_email, invited_at_utc) are None for employees, who reach every site in the organization and are not invited by anyone.
  - `id` integer, required
  - `uuid` string, uuid4, required
  - `email` string, required
  - `displayName` string, nullable
  - `isExternal` boolean, required
  - `company` string, nullable
  - `status` 'invited' | 'active' | 'disabled' | 'expired', required
  - `expiresAtUtc` string, date-time, nullable
  - `lastActiveAtUtc` string, date-time, nullable
  - `grantedSiteCount` integer, nullable
  - `invitedByEmail` string, nullable
  - `invitedAtUtc` string, date-time, nullable

## Other responses

- `422`: Validation Error

---

[API](https://skmtc.dev/shapemaker/apis/shapemaker-api.md) - [All operations](https://skmtc.dev/shapemaker/apis/shapemaker-api/llms.txt) - [OpenAPI document](https://skmtc.dev/shapemaker/apis/shapemaker-api/revisions/b8461cf1236c?raw)