Get users by projectId

GET 
/users/by/project/:projectId

Get users by projectId

Request

Path Parameters

projectId projectIdrequired

The unique identifier for the project

Query Parameters

page integer

Possible values: >= 1

Default value: 1

Specify the page number for pagination (default is 1).

limit integer

Default value: 10

Specify the number of projects per page (default is 10, 0 gets all results).

sortBy string

Possible values: [activePoints, totalPoints]

Field to order the results by (e.g., 'activePoints', 'totalPoints'). Default is 'totalPoints'.

sortOrder string

Possible values: [asc, desc]

Default value: desc

'asc' for ascending or 'desc' for descending order. Default is 'desc'.

Responses

200

Users retrieved successfully

application/json

Schema

Schema

• Array [

activePoints integer

The number of active points the user has

username string

The username of the user

avatar string

The avatar URL of the user

totalPoints integer

The total number of points the user has

userQuestCount integer

The number of quests the user has completed

cognitoUserId string

The ID of the user

• ]

Example (from schema)

[
  {
    "activePoints": 0,
    "username": "string",
    "avatar": "string",
    "totalPoints": 0,
    "userQuestCount": 0,
    "cognitoUserId": "string"
  }
]

403

Forbidden

application/json

Schema

Schema

error string

Example (from schema)

{
  "error": "string"
}

Example

{
  "error": "Forbidden access"
}

404

NotFound

application/json

Schema

Schema

error string

Example (from schema)

{
  "error": "string"
}

Example

{
  "error": "A mandatory item was not found"
}

500

Internal Server Error

application/json

Schema

Schema

error string

Example (from schema)

{
  "error": "string"
}

Example

{
  "error": "Internal Server Error"
}

Loading...