Skip to content

API Reference / Memberships

Resolve a registered user by email

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.

POST/accounts.v1.Accounts/GetUserByEmail

Request body

application/jsonRequired

Request to find a user by email address, so a workspace owner can invite them with CreateMembership.

email?string

The email address to look up, matched exactly. Addresses are stored lowercase, so send it lowercase.

Response body

application/json

Success

user?User

The matching user's account details.

Show attributes
avatarUrl?string

URL of the user's avatar image, taken from their linked Discord account. Empty when there is none.

createdAt?string

When the account was created.

Format"date-time"

email?string

The user's email address, stored lowercase and unique across users.

id?string

Opaque 16-byte identifier of the user, assigned when the account is created. Base64-encoded in JSON.

Format"byte" base64

isAdministrator?boolean

True when the user is a platform administrator with access across every workspace.

name?string

The user's display name, 1 to 256 characters.

status?string

The account's status. A suspended user can no longer sign in.

Value in"USER_STATUS_ACTIVE""USER_STATUS_SUSPENDED"

updatedAt?string

When the account was last changed.

Format"date-time"

curl -X POST "https://api.goldmine.to/accounts.v1.Accounts/GetUserByEmail" \
  -H "Authorization: Bearer $CSTRADER_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "email": "jordan@acme.example"
  }'
{
  "user": {
    "id": "EjRWeBI0VniQEjRWeBI0Vg==",
    "name": "Jordan Hale",
    "email": "jordan@acme.example",
    "status": "active",
    "createdAt": "2026-01-15T10:00:00Z",
    "updatedAt": "2026-03-02T14:22:30Z"
  }
}