Members

Get a member

Retrieve a person member with their role and mailbox access. Selected mailbox IDs are limited to the calling credential's effective mailbox reach and resource constraints and may be incomplete.

get/members/{id}

Request

  • Base URL: https://shipmail.to/api/v1
  • URL: https://shipmail.to/api/v1/members/{id}
  • 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

Member object.

object'member' required
idstring required

Plain member ID. Member IDs do not use a required prefix.

emailstring email required
namestring required
role'owner' | 'admin' | 'member' required
created_atstring date-time required

Example response

{
  "object": "member",
  "id": "mem_alice",
  "email": "alice@acme.com",
  "name": "Alice",
  "role": "admin",
  "mailbox_access": {
    "scope": "selected",
    "mailbox_ids": [
      "mbx_123"
    ]
  },
  "created_at": "2026-01-01T00:00:00Z"
}

Changes

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