Memberships

Invite someone to a workspace by email

POST
/accounts.v1.Accounts/InviteMemberByEmail

Invites an email address to the caller's current workspace as a member. An address that already has an account gets an invited membership to accept. An address without one is sent a sign-up link that admits it without using a pilot invitation, and the invitation becomes a membership once the account exists.

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://api.goldmine.to/accounts.v1.Accounts/InviteMemberByEmail" \  -H "Content-Type: application/json" \  -d '{    "email": "teammate@example.com",    "policies": [      "trading"    ]  }'
{
  "emailInvitation": {
    "id": "ICEiIyQlJicoKSorLC0uLw==",
    "email": "teammate@example.com",
    "policies": [
      "trading"
    ]
  }
}

{
  "code": "failed_precondition",
  "message": "The request cannot be carried out in the current system state."
}

{
  "code": "unauthenticated",
  "message": "The request lacks a valid API key in the Authorization header."
}
{
  "code": "permission_denied",
  "message": "The API key is not allowed to perform this action on this workspace."
}
{
  "code": "already_exists",
  "message": "The resource already exists."
}
{
  "code": "internal",
  "message": "An internal server error occurred."
}

GetUserByEmail

Looks up a registered user by their exact email address, so a workspace owner can resolve an invitee's email to a user ID before calling CreateMembership. Matches only an existing, exact email - never a partial or fuzzy match.

ListMemberships

Lists memberships in the caller's own active workspace, optionally narrowed to a single user. There is no workspace_id request field; the result always means the caller's own workspace. Results are paginated; pass the returned cursor to fetch the next page.