Appearance
Search users by name or email
GET
/api/users/search
Searches user accounts by name or email address. Used by the membership assignment UI to find users to add to projects. Requires authentication.
Authorizations
cookieAuth
Type
API Key (cookie: _vulcan_session)
or
tokenAuth
Personal access token authentication. Send via Authorization header: Authorization: Token vulcan_xxx. Tokens are SHA-256 hashed server-side (never stored in plaintext). Scopes: read (GET), write (mutations), admin (everything). Create tokens via Settings → API Tokens in the web UI.
Type
HTTP (token)
Parameters
Query Parameters
q*
Search query string (minimum 2 characters).
Type
Requiredstring
Example
"container platform"Min Length
2membership_type*
Type of resource to search members for.
Type
Requiredstring
Valid values
"Project""Component"Example
"Project"membership_id*
ID of the project or component to search members for.
Type
Requiredinteger
Example
1scope
Search scope. Default searches non-members (for "add member" flow, admin only). "members" searches existing members (for PoC selection, any member).
Type
string
Valid values
"members"Example
"members"limit
Maximum number of results (1-25, default 10).
Type
integer
Example
10Minimum
1Maximum
25Responses
Matching users
application/json
JSON "users": [ { "id": 42, "name": "Jane Doe", "email": "jane.doe@example.org" } ]
{
}