Skip to main content
POST
Add a member to a vault

Authorizations

Authorization
string
header
required

API key for authentication. Format: gcai_xxxxxxxxx

Create API keys in the GC AI app under Settings → API.

Path Parameters

id
string<uuid>
required

The vault ID

Body

application/json
user_id
integer

GC AI user ID of the person to add, as user_id from GET /vaults/{id}/members or id from GET /me. Send this or email.

Required range: x > 0
email
string<email>

Email address of the person to add. It has to belong to someone who is already a member of your organization. Send this or user_id.

Maximum string length: 320
Example:

"dana@example.com"

role
enum<string>
default:editor

Role to grant. Defaults to editor.

Available options:
owner,
editor,
viewer

Response

The vault member

user_id
integer
required

GC AI user ID of the member. This is the same identifier GET /me reports for the calling user, so a caller can pick their own row out of the list.

email
string | null
required

Member email address, or null when the account has none on file.

name
string | null
required

Member display name, preferring the name they chose for themselves. Null when the account has no name on file.

role
enum<string> | null
required

The member's role in this vault: owner (manage members and settings), editor (add documents and edit extracted data), or viewer (read and annotate). Null on the rare stored value GC AI cannot read as a role. Such a grant carries no permissions at all, so remove it and add the person again.

Available options:
owner,
editor,
viewer,
null
added_at
string | null
required

ISO 8601 timestamp when the member was added, or null for grants written before GC AI recorded that.

Last modified on September 25, 2026