neatcar

Endpoint

Get Account Details

The Get Account Details endpoint allows to retrieve detailed information about a specific user account using its unique identifier (userUUID). This endpoint is used to fetch account data such as profile information and metadata when the client already knows the user’s UUID.

GET

/user?userUUID=4d06009b-fbdb-44bb-9329-b50334bf9538

User Model data

The following list provides a selection of key values included in the model; however, it is non-exhaustive. Developers can expect to find additional fields and data within the model, offering comprehensive information about each user. This abbreviated list serves as a starting point for understanding the structure of the model and the types of information available for each user.

uuid
Unique identifier for the user
associatedBrandName
The name of the brand associated with the user
externalReferenceId
The unique identifier for the client for the user
communicationEmail
The email used for communication with the user (transactional emails, etc.)
firstName
The first name of the user
lastName
The last name of the user

Response example

Below is an example of the API endpoint response, showcasing the structure and format of the data returned by the specified endpoint. This example serves as a practical illustration, demonstrating how developers can expect the information to be organized and presented when interacting with the API. It provides insight into the content and layout of the response, facilitating effective integration and utilization of the endpoint within your applications.

Possible errors

The following list provides a selection of possible errors that can occur when getting account details. However, it is non-exhaustive. Developers can expect to find additional errors and data within the model, offering comprehensive information about each error.

HTTP 400

Bad Request due to missing parameters

When the API token is valid and present, this error is returned when the request contains missing parameters to be processed.

Error body response example: 

  







  

    

      HTTP 400
      
Bad Request due to invalid userUUID

    

    
    
  

  
The userUUID passed as a query parameter is invalid or does not exist.

  Error body response example:
  

    

  







  

    

      HTTP 401
      
Unauthorized

    

    
    
  

  
The API token is invalid or missing.

  Error body response example:
  

    

  







  

    

      HTTP 500
      
Internal Server Error

    

    
    
  

  
An unexpected error occurred while processing the request. This can happen when the query parameters are malformed. Please try again later or contact support if the problem persists.

  Error body response example: