List members

Responses

• 200 The account roster
  • members array of MemberView required

    Everyone on the account, including invitations not yet accepted.

    • userId string required

      The user id of this member.

    • email string | null required

      Their email address. Null when not yet known.

    • name string | null required

      Their display name. Null when not set.

    • role string required

      Their role on this account. A role is a named group of permissions, resolved when they authenticate; the API itself only ever screens the resulting permissions.

    • status string required

      Whether they have accepted their invitation and are active.

    • invitedAt string | null required

      When they were invited, as an ISO 8601 instant. Null when they were not invited.

    • joinedAt string | null required

      When they accepted, as an ISO 8601 instant. Null while an invitation is outstanding.

    • lastActiveAt string | null required

      When they were last seen making a request, as an ISO 8601 instant. Null when never.

    • lastLoginAt string | null required

      When they last signed in, as an ISO 8601 instant. Null when never.

• 401 No or invalid credential
  • code string required

    Stable machine-readable error code. Branch on this, never on the numeric status.

    bad_requestunauthorizedsignature_requiredpayment_requiredforbiddennot_foundconflictgonepayload_too_largeunprocessable_entitytoo_many_requestsinternal_errornot_implementedbilling_unavailablenot_contactablemailbox_link_unavailablemailbox_requiredmail_engine_unavailablewebhook_publisher_unavailabledatabase_unavailableclient_error
  • message string required

    Human-readable explanation of the refusal.

  • status integer required

    The HTTP status code, repeated in the body.

  • remedy object

    A self-serve path forward, when one exists (a 402 points at the credit top-up).

    • kind string required

      What kind of remedy this is, so a client can route it: whether the caller can clear the condition through the API, or a person must act in the web app.

      topupconnect_mailbox
    • url string required

      Where to go to clear the condition: an API path, or a web app page when only a person can.

• 403 Missing member:read
  • code string required

    Stable machine-readable error code. Branch on this, never on the numeric status.

    bad_requestunauthorizedsignature_requiredpayment_requiredforbiddennot_foundconflictgonepayload_too_largeunprocessable_entitytoo_many_requestsinternal_errornot_implementedbilling_unavailablenot_contactablemailbox_link_unavailablemailbox_requiredmail_engine_unavailablewebhook_publisher_unavailabledatabase_unavailableclient_error
  • message string required

    Human-readable explanation of the refusal.

  • status integer required

    The HTTP status code, repeated in the body.

  • remedy object

    A self-serve path forward, when one exists (a 402 points at the credit top-up).

    • kind string required

      What kind of remedy this is, so a client can route it: whether the caller can clear the condition through the API, or a person must act in the web app.

      topupconnect_mailbox
    • url string required

      Where to go to clear the condition: an API path, or a web app page when only a person can.