Status

Get organization access

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.

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)

Headers

X-Shipmail-Organizationstring

OAuth access tokens only. The organization ID this request acts on. Required when the OAuth connection was approved for several organizations (400 validation_error without it); optional with one. An organization the connection was not approved for returns 403 authorization_error. Ignored for API keys, which belong to one organization.

Response

Organization access returned.

object'organization_access' required
plan'free' | 'solo' | 'pro' | 'team' | 'scale' required
has_accessboolean required

Mailboxes can be created now. The same rule mailbox creation applies, including trials and managed accounts.

newsletters_allowedboolean required

Newsletter sending is available. It is not during a trial.

Changes

No recorded changes to this operation across all 1 revision of this API.