---
title: "Get organization access"
method: GET
path: "/organization/access"
tags: ["Status"]
---

# Get organization access

`GET /organization/access`

## Request

- Base URL: `https://shipmail.to/api/v1`
- URL: `https://shipmail.to/api/v1/organization/access`
- Auth: one of:
  - HTTP bearer
  - OAuth 2 (authorization code, authorization URL `https://shipmail.to/api/auth/oauth2/authorize`, token URL `https://shipmail.to/api/auth/oauth2/token`)

Return whether the authenticated credential's organization can create mailboxes now, its plan, trial state and mailbox capacity. An agent polls this after the owner pays: access appears once Shipmail has recorded the payment. It never returns payment methods, invoices or billing provider identifiers.

## Headers

- `X-Shipmail-Organization` string

## Response `200`

Organization access returned.

- OrganizationAccess
  - `object` 'organization_access', required
  - `organization` object, required
    - `id` string, required
    - `name` string, required
  - `plan` 'free' | 'solo' | 'pro' | 'team' | 'scale', required
  - `has_access` boolean, required: Mailboxes can be created now. The same rule mailbox creation applies, including trials and managed accounts.
  - `trial` object, required
    - `active` boolean, required
    - `ends_at` string, date-time, nullable, required
    - `eligible` boolean, required: The organization has no subscription yet and its owner has never had a trial. A trial is still confirmed at checkout.
  - `mailboxes` object, required
    - `limit` integer, required: Mailboxes the organization can hold now. During a trial this is at most 3.
    - `used` integer, required
  - `newsletters_allowed` boolean, required: Newsletter sending is available. It is not during a trial.

## Other responses

- `401`: Authentication failed.
- `404`: Resource not found.
- `429`: Rate limit exceeded.

---

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