Users

Search workspace members.

POST

https://api.stackinternal.com

/v1/users/search

Paginated. Supports a text filter (q, matched against name and email), exact role, status, and userIds filters, and sorting by name (first + last), email, or role.

Search workspace members. › Request Body

Request to search workspace members with optional filters, sorting, and pagination.

UserSearchRequest

page

integer | null · int32

The one-based page number. Values below one are treated as one.

pageSize

integer | null · int32

The number of results per page, from 1 through 100.

q

string | null

Optional text filter, matched against name and email.

role

string | null

Optional exact role filter.

status

string | null

Optional active-state filter. Accepted values are active or deactivated.

userIds

array | null

Optional user IDs to include.

sort

UserSortField · enum

Fields the user list can be sorted by. "Name" sorts on first + last name.

Enum values:

name

role

direction

SortDirection · enum

Sort order: ascending or descending.

Enum values:

asc

desc

Search workspace members. › Responses

200

A single page of results plus the total count across all pages (for the given filters).

UserListItemResponsePagedResult

array | null

page

integer · int32

pageSize

integer · int32

totalCount

integer · int64

POST/v1/users/search

curl https://api.stackinternal.com/v1/users/search \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer <token>' \
  --data '{
  "page": 0,
  "pageSize": 0,
  "q": "q",
  "role": "role",
  "status": "status",
  "userIds": [
    "00000000-0000-0000-0000-000000000000"
  ],
  "sort": "name",
  "direction": "asc"
}'

Example Request Body

{
  "page": 0,
  "pageSize": 0,
  "q": "q",
  "role": "role",
  "status": "status",
  "userIds": [
    "00000000-0000-0000-0000-000000000000"
  ],
  "sort": "name",
  "direction": "asc"
}

json

Example Responses

{
  "items": [
    {
      "userId": "00000000-0000-0000-0000-000000000000",
      "email": "email",
      "firstName": "firstName",
      "lastName": "lastName",
      "role": "role",
      "isActive": true
    }
  ],
  "page": 0,
  "pageSize": 0,
  "totalCount": 0
}

text

Update a workspace member's role.

PUT

https://api.stackinternal.com

/v1/users/{userId}/role

Update a workspace member's role. › path Parameters

userId

string · uuid · required

Update a workspace member's role. › Request Body

Request to set a workspace member's role.

ChangeUserRoleRequest

role

string | null

Update a workspace member's role. › Responses

200

No data returned

Deactivate a workspace member.

POST

https://api.stackinternal.com

/v1/users/{userId}/deactivate

Deactivate a workspace member. › path Parameters

userId

string · uuid · required

Deactivate a workspace member. › Responses

200

No data returned

Activate a workspace member.

POST

https://api.stackinternal.com

/v1/users/{userId}/activate

Activate a workspace member. › path Parameters

userId

string · uuid · required

Activate a workspace member. › Responses

200

No data returned

OAuth Applications Validation Requests