GET User's Data

Overview

---

The following table contains important information about the GET method in regards to receiving a user's data.

GET User's Data
Method	GET
URL or Endpoint	/api/accounts/users/data
Headers	Authorization
Parameters	projectId, organizationId
Body	Not applicable.

The description to the parameters is displayed below:

Field Name	Type	Description
projectId	string	The ID of the project.
organizationId	string	The ID of the organization.

Request Body

The request does not have a request body.

Response

{
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "user": {
      "publicId": "string",
      "firstname": "string",
      "lastname": "string",
      "projectName": null,
      "picture": "string",
      "email": "string",
      "isActive": false,
      "role": {
        "id": 2,
        "name": "string",
        "description": null,
        "isActive": false,
        "organizationId": null
      },
      "isConfirmed": false,
      "defaultOrganizationId": 3
    },
    "defaultOrganization": {
      "publicId": "string",
      "isDefault": false,
      "name": "string",
      "addressLine1": "string",
      "addressLine2": "string",
      "state": "string",
      "country": "string",
      "city": "string",
      "vatNumber": "string"
    },
    "defaultProject": {
      "publicProjectId": "string",
      "name": "string",
      "publicOrganizationId": "string",
      "orderNumber": 2,
      "isDefault": false,
      "biskoId": null,
      "prebidConfigId": null
    }
  },
  "resultInfo": null,
  "statusCode": 200
}

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.
user	Object	The user object.
publicId	string	The public ID of the user.
firstname	string	The first name of the user.
lastname	string	The last name of the user.
projectName	string	The name of the project
picture	string	The URL of the profile picure.
email	string	The email of the user.
isActive	bool	Indicates whether the user is active.
role	Object	The role object.
id	integer($int32)	The ID of the role.
name	string	The name of the role.
description	string	The description of the role.
isActive	bool	Indicates whether the role is active.
organizationId	string	The ID of the organization.
isConfirmed	bool	Indicates whether the user is confirmed.
defaultOrganizationId	integer($int32)	The ID of the default organization.
defaultOrganization	Object	The default organization object.
publicId	string	The public ID of the organization.
isDefault	bool	Indicates whether the organization is the default organization.
name	string	The name of the organization.
addressLine1	string	The first address line.
addressLine2	string	The second address line.
state	string	The state.
country	string	The country.
city	string	The city.
vatNumber	string	The VAT number.
defaultProject	Object	The default project object.
publicProjectId	string	The public ID of the project.
name	string	The name of the project.
publicOrganizationId	string	The public ID of the organization.
orderNumber	integer($int32)	The order number.
isDefault	bool	Indicates whether the project is the default project.
biskoId	string	The bisko ID.
prebidConfigId	string	The ID of the prebid config.
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