Test And Accept
API ReferenceProjectusers

List project users

Get all users and optional invitations for a project

GET
/projects/{projectId}/users
AuthorizationBearer <token>

Clerk authentication token

In: header

Path Parameters

projectIdstring
Match^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000)$
Formatuuid

Query Parameters

includeInvitations?string

Response Body

curl -X GET "http://localhost:3001/projects/497f6eca-6276-4993-bfeb-53cbbbba6f08/users?includeInvitations=string"
{
  "users": [
    {
      "userId": "string",
      "email": "string",
      "firstName": "string",
      "lastName": "string",
      "imageUrl": "string",
      "accessLevel": "owner",
      "grantedAt": "string",
      "grantedBy": "string",
      "expiresAt": "string"
    }
  ],
  "invitations": [
    {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "email": "string",
      "accessLevel": "owner",
      "status": "pending",
      "invitedBy": "string",
      "invitedAt": "string",
      "expiresAt": "string",
      "acceptedAt": "string",
      "acceptedBy": "string"
    }
  ],
  "totalUsers": 0,
  "totalInvitations": 0
}
{
  "code": "BAD_REQUEST",
  "message": "Invalid input data",
  "issues": []
}
{
  "code": "UNAUTHORIZED",
  "message": "Authorization not provided",
  "issues": []
}
{
  "code": "FORBIDDEN",
  "message": "Insufficient access",
  "issues": []
}
{
  "code": "NOT_FOUND",
  "message": "Not found",
  "issues": []
}
{
  "code": "INTERNAL_SERVER_ERROR",
  "message": "Internal server error",
  "issues": []
}