Skip to content

API Reference / Memberships

Invite a user to a workspace

Creates a membership inviting a user to a workspace with the given initial operational policies. The invitation always creates a member-role membership. Ownership cannot be granted through an invite. The invited user must accept before the membership becomes active.

POST/accounts.v1.Accounts/CreateMembership

Request body

application/jsonRequired

Request to invite a user to the caller's workspace. The owner or an administrator can invite a member. Only the owner can invite an administrator. The invitation stays invited until the user accepts.

policies?array<string>

Policies the member will hold once they accept: any of "trading", "steam", "proxies", "analytics" and "csfloat". Empty invites a read-only member.

role?string

The role offered: MEMBERSHIP_ROLE_MEMBER (the default when unspecified) or MEMBERSHIP_ROLE_ADMINISTRATOR, which only the owner can offer. An administrator's policies must be empty, because the role holds every operational permission.

Value in"MEMBERSHIP_ROLE_OWNER""MEMBERSHIP_ROLE_MEMBER""MEMBERSHIP_ROLE_ADMINISTRATOR"

userId?string

Opaque 16-byte identifier of the user to invite, base64-encoded in JSON. GetUserByEmail resolves an email address to this identifier.

Format"byte" base64

Response body

application/json

Success

membership?Membership

The new membership, with the offered role and invited status.

Show attributes
createdAt?string

When the membership was created, which for a member is when they were invited.

Format"date-time"

expiresAt?string

When a pending invitation stops being acceptable. Unset once accepted and for an owner.

Format"date-time"

id?string

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

Format"byte" base64

invitedBy?string

Opaque 16-byte identifier of the user who sent the invitation. Unset for the workspace owner and for invitations sent before the inviter was recorded.

Format"byte" base64

lastActiveAt?string

When the member last used the workspace while signed in, to the minute. Unset for a member who has not used it since activity was recorded.

Format"date-time"

policies?array<string>

Names of the policies a member holds: any of "trading", "steam", "proxies", "analytics" and "csfloat". Empty means a read-only member. Not used for an owner or an administrator, who hold every operational permission by role.

role?string

Owner for the one person who holds the workspace (its creator until ownership is transferred), administrator for someone who runs it with the owner but cannot delete it, hand it over or change roles, or member for everyone else.

Value in"MEMBERSHIP_ROLE_OWNER""MEMBERSHIP_ROLE_MEMBER""MEMBERSHIP_ROLE_ADMINISTRATOR"

status?string

Invited until the invited user accepts, then accepted.

Value in"MEMBERSHIP_STATUS_INVITED""MEMBERSHIP_STATUS_ACCEPTED"

updatedAt?string

When the membership was last changed, such as accepted or given new policies.

Format"date-time"

userId?string

Opaque 16-byte identifier of the member user, base64-encoded in JSON.

Format"byte" base64

workspaceId?string

Opaque 16-byte identifier of the workspace, base64-encoded in JSON.

Format"byte" base64

curl -X POST "https://api.goldmine.to/accounts.v1.Accounts/CreateMembership" \
  -H "Authorization: Bearer $CSTRADER_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "userId": "q83vq83vEjRWeBI0VniQqg==",
    "policies": [
      "trading",
      "analytics"
    ]
  }'
{
  "membership": {
    "id": "ICEiIyQlJicoKSorLC0uLw==",
    "userId": "q83vq83vEjRWeBI0VniQqg==",
    "workspaceId": "AAECAwQFBgcICQoLDA0ODw==",
    "role": "MEMBERSHIP_ROLE_MEMBER",
    "status": "MEMBERSHIP_STATUS_INVITED",
    "createdAt": "2026-06-29T12:00:00Z",
    "updatedAt": "2026-06-29T12:00:00Z",
    "policies": [
      "trading",
      "analytics"
    ]
  }
}