GET Users of Project for Pagination

Overview

---

The following table contains important information about the GET method in regards to receiving the users of a project with pagination.

GET Users of Project with Pagination
Method	GET
URL or Endpoint	​/api/projects/projectId/users
Headers	Authorization
Parameters	projectId, search, page, take, order, insertedDate
Body	Not Applicable

The description of the URL parameter is as follows:

projectId URL Parameter
URL Parameter Name	projectId
Mandatory	Yes
Type	string
Description	Unique Id of the project.

The description of the parameters is as follows:

Parameter Name	Mandatory	Type	Description
search	No	string	A word you want to filter.
page	Yes	integer($int32)	The page in which the user is located
take	Yes	integer($int32)	The number of users to take from the page
order	Yes	string	The order in which you receive the users.
insertedDate	No	Date	The date when the user was inserted.

Request Body

The request does not contain a request body.

Response

{
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "currentPage": 1,
    "totalPages": 3,
    "pageSize": 5,
    "totalCount": 12,
    "items": [
      {
        "id": 6,
        "globalId": "55b8b8b7-584a-4b9b-949a-244c6347bcc6",
        "firstname": "Sejfi",
        "lastname": "Hoxha",
        "picture": null,
        "email": "sejfi@gjirafa.com",
        "isActive": true,
        "role": {
          "id": 4,
          "name": "Owner",
          "description": null,
          "isActive": false,
          "organizationId": null
        },
        "isConfirmed": true
      }
    ]
  },
  "resultInfo": null,
  "statusCode": 200
}

Information about the fields that appear when you receive the response are displayed in the table below.

Field Name	Type	Description
success	bool	If the response is successful it will return true. Otherwise will return false.
errors	array[]	Indicates if there was an error.
messages	array[]	Returns the response message from back-end.
result	array[Object]	Returns the response object.
currentPage	integer($int32)	The page the users are located in.
totalPages	integer($int32)	The total number of pages that contain users.
pageSize	integer($int32)	The number of contents a page holds.
totalCount	integer($int32)	The total number of users.
items	array[Object]	Returns the items as an array of objects.
id	integer($int32)	The id of the user
globalId	string	The global id of the user.
firstName	string	The first name of the user.
lastName	string	The last name of the user.
picture	Image	The picture of the user.
email	string	The email of the user.
isActive	bool	Indicates whether the user is active..
role	Object	Returns the role as an object.
id	integer($int32)	The id of the
name	string	The name of the role.
description	string	The description of the role.
isActive	bool	Indicates whether the role is active.
organizationId	integer($int32)	The id of the organization.
isConfirmed	bool	Indicates whether the user is confirmed.
resultInfo	string	Returns extra information about the result.
statusCode	integer($int32)	Returns the HTTP Status Code.

If the action is successful, the service sends back an HTTP 200 or 201 response.

Errors

For information about the errors that are common to all actions, see Common Errors:

• HTTP Status Code 400: Bad Request

• HTTP Status Code 401: Unauthorized

• HTTP Status Code 403: Forbidden

• HTTP Status Code 404: Result Not Found

• HTTP Status Code 500: Internal Server Error

• HTTP Status Code 503: Backend Fetch Failed