Skip to main content

GET User of an Organization not in a Project

Overview


The following table contains important information about the GET method in regards to receiving the users of an organization that are not in a certain project.

GET User of an Organization not in a Project
MethodGET
URL or Endpoint​/api/projects/projectId/users/user-organization
HeadersAuthorization
ParametersprojectId, search, page, take, order, insertedDate
BodyNot Applicable

The description of the URL parameter is as follows:

projectId URL Parameter
URL Parameter NameprojectId
MandatoryYes
Typestring
DescriptionUnique Id of the project.

The description of the parameters is as follows:

Parameter NameMandatoryTypeDescription
searchNostringA word you want to filter.
pageYesinteger($int32)The page in which the user is located
takeYesinteger($int32)The number of users to take from the page
orderYesstringThe order in which you receive the users.
insertedDateNoDateThe date

Request Body

The request does not contain a request body.

{
"success": true,
"errors": [],
"messages": [],
"result": {
"currentPage": 1,
"totalPages": 5,
"pageSize": 2,
"totalCount": 9,
"items": [
{
"publicId": "string",
"globalId": "string",
"firstname": "string",
"lastname": "string",
"picture": null,
"email": "string",
"isActive": true,
"role": {
"id": 0,
"name": null,
"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 NameTypeDescription
successboolIf the response is successful it will return true. Otherwise will return false.
errorsarray[]Indicates if there was an error.
messagesarray[]Returns the response message from back-end.
resultarray[Object]Returns the response object.
publicIdstringThe id of the user
globalIdstringThe global id of the user.
firstNamestringThe first name of the user.
lastNamestringThe last name of the user.
pictureImageThe picture of the user.
emailstringThe email of the user.
isActiveboolIndicates whether the user is active.
roleObjectReturns the role as an object.
idinteger($int32)The id of the
namestringThe name of the role.
descriptionstringThe description of the role.
isActiveboolIndicates whether the role is active.
organizationIdinteger($int32)The id of the organization.
isConfirmedboolIndicates whether the user is confirmed.
defaultOrganizationIdinteger($int32)The default ID of the organization.
resultInfostringReturns extra information about the result.
statusCodeinteger($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