SureTax Config API

GET User

OVERVIEWREQUESTRESPONSETRY IT OUT

Overview

The GET User API endpoint facilitates the process to verify if exist a user and LFEs related with parent account.

OperationId: GET User

Authorization Method(s): OAuth

Verb: GET

End Point: /api/v1/User

Query Parameters

Query parameters in an API operation are key-value pairs that are included in the URL of an API request to filter or modify the data returned by the API. They come after the `?` in the URL and are often used to pass optional parameters like search terms, pagination information, sorting criteria, or filters to narrow down the data in the response.

Display String	Field Name	Field Type
Email*	email	string

*Mandatory parameter

LFEEntitiesResponse

OVERVIEWEXAMPLE

Overview

Represents the response containing a list of lfes related to parent account username.

LFEEntitiesResponse

Display Name	Field Name	Field Type
Data	data	array[LFEEntity]

Example Response

The following is an example response you can expect for this operation

{
  "data": [
    {
      "id": "A001670001"
    },
    {
      "id": "A001670002"
    },
    {
      "id": "A001670003"
    },
    {
      "id": "A001670004"
    }
  ]
}

Response Codes

Response codes in an API indicate the outcome of a request. They are three-digit numbers returned by the server to help the client understand if the request was successful, encountered an error, or needs further action. This operation has the following possible responses.

code	description
200	The API responds with this code to indicate that the email username was found it and belong to token parent account successfully.
400	Bad Request - The server could not process the request due to invalid input or missing required parameters.
404	The API responds with this code to indicate that the email username was not found it.
401	Unauthorized: The user's authentication is not valid.
500	Internal Server Error - An unexpected error occurred on the server while processing the request.

To execute a web service call for API Key Enabled APIs, Select an environment and enter the client number and validation api key corresponding to that environment.

Select Environment:End Point:

/api/v1/User

Add Request Headers: