---
title: "Create or list workspace invites"
method: POST
path: "/workspace/invites"
tags: ["workspace"]
---

# Create or list workspace invites

`POST /workspace/invites`

Create a workspace invitation (action: "create") or list existing ones (action: "list"). Sends an email if provided. Codes expire in 14 days..

## Request body

- object
  - `action` 'create' | 'list', required — "create" to make a new invite, "list" to get existing
  - `email` string — Invitee email (sends invite email)
  - `name` string — Invitee name
  - `maxUses` integer — Max times code can be used

## Response `200`

Invite created or listed

- union
  - object
    - `success` true, required
    - `invite` object, required
      - `id` string, required
      - `email` string, nullable, required
      - `name` string, nullable, required
      - `code` string, required
      - `status` string
      - `maxUses` integer, required
      - `useCount` integer, required
      - `expiresAt` string, nullable, required
      - `createdAt` string, required
    - `creditsUsed` integer, required — Credits consumed by this call. 0 for free endpoints, cached results, duplicates, and for every query that does not touch LinkedIn.
    - `retryAfter` integer, required — Seconds to wait before another call of the same type. 0 means no wait is needed.
    - `_meta` object — Credit balance carried on every response so a caller never has to ask for it separately. Absent when the caller has no connected account.
      - `credits` object, required
        - `current` number, required — Credits spent this period.
        - `limit` number, nullable, required — Period allowance, or null when unlimited.
        - `remaining` number, nullable, required — Allowance left, or null when unlimited.
        - `percentage` number, required — Share of the allowance spent, 0 to 100.
        - `isUnlimited` boolean, required
        - `accountPlan` string, required — The credential's plan.
  - object
    - `success` true, required
    - `invites` object[], required
      - `id` string, required
      - `email` string, nullable, required
      - `name` string, nullable, required
      - `code` string, required
      - `status` string
      - `maxUses` integer, required
      - `useCount` integer, required
      - `expiresAt` string, nullable, required
      - `createdAt` string, required
    - `workspace` object, required
      - `tier` string, required
      - `proSeatsIncluded` integer, required
      - `proSeatsUsed` integer, required
    - `creditsUsed` integer, required — Credits consumed by this call. 0 for free endpoints, cached results, duplicates, and for every query that does not touch LinkedIn.
    - `retryAfter` integer, required — Seconds to wait before another call of the same type. 0 means no wait is needed.
    - `_meta` object — Credit balance carried on every response so a caller never has to ask for it separately. Absent when the caller has no connected account.
      - `credits` object, required
        - `current` number, required — Credits spent this period.
        - `limit` number, nullable, required — Period allowance, or null when unlimited.
        - `remaining` number, nullable, required — Allowance left, or null when unlimited.
        - `percentage` number, required — Share of the allowance spent, 0 to 100.
        - `isUnlimited` boolean, required
        - `accountPlan` string, required — The credential's plan.

## Other responses

- `400` — The server cannot or will not process the request due to something that is perceived to be a client error.
- `401` — Although HTTP specifies "unauthorized", this response means "unauthenticated". Authenticate to continue. NOTE: 401 is also returned with code "linkedin_not_connected" when the caller IS authenticated but has no connected LinkedIn account — connect LinkedIn (not re-authenticate) to continue.
- `403` — The client does not have access rights to the content.
- `404` — The server cannot find the requested resource.
- `409` — The request conflicts with the current state of the server.
- `410` — The requested content has been permanently deleted from the server.
- `422` — The request was well-formed but was unable to be followed due to semantic errors.
- `429` — Rate limit exceeded. Read error.retryAfter for the wait time in seconds.
- `500` — The server encountered a situation it does not know how to handle.
- `502` — LinkedIn returned a server error or the proxy connection failed. Retry after a few seconds.
- `503` — Proxy capacity temporarily exceeded. Retry after a few seconds.

---

[API](https://skmtc.net/berea/apis/bereach-api.md) · [All operations](https://skmtc.net/berea/apis/bereach-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/berea/bereach-api/revisions/9217eedacbb8/schema)