Documentation

Get Project Users

GET /project/{project_id}/users

Returns a list of project users.

Path Parameters

Parameter Type Required Description
project_id string Yes Project ID

Query Parameters

Parameter Type Description
limit integer Limits the number of results returned
offset integer Offset for pagination
include_site_role boolean Include site role in response
search string Search for users by display name
sort_atr string Sort attribute (e.g., "name")
sort_ord string Sort order ("asc" or "desc")

Response

Success Response (200 OK)

data is an array of project membership entries with display_name, from, role, and user_id. include_site_role=true adds site_role. numitems counts matching users before pagination. shared.num_admins counts administrators among the returned entries.

Error Responses

  • 400 Bad Request: Invalid request
  • 422 Unprocessable Entity: Request fields fail schema validation
  • 401 Unauthorized: Authentication failed
  • 403 Forbidden: User does not have permission to view project users
  • 404 Not Found: Project with the specified ID does not exist

See the Projects API overview for related endpoints.