User Type - GET

User Type - GET API Endpoint
StoRegister - Login

List of User Types API

The list of user types configured for the account. User types categorize users based on different criteria, such as "General," "Business," "Student," "Military," and "Charitable."

GET
/v1/common/user-type
Request Content Type
application/json
Response Content Type
application/json

Request Header

  • Authorization: X-API-Key string required

    X-API-Key is a string of letters and numbers used to authenticate and control access to the API. It can be generated in the StoRegister management application.

Response Payload:

  • succeeded boolean

    Indicates whether the request to retrieve user type information was successful.

  • status string

    Describes the status of the request to retrieve user type information.

  • data object

    Array containing user type information.

  • pagination object

    Details about pagination, including current page number, total number of pages, and overall count of items.

  • errors array

    Holds any error information if applicable.

User Type Option Details

Details about the user type option.

array data
  • id unique-identifier
    Unique identifier for the user type.
  • name string
    Name of the user type (e.g., "General," "Business," "Student").
  • taxUserTypeInfoId integer
    Master ID for the user type.

Request Header

Authorization: X-API-Key --api-key--

API Response

{
    "data":[
        {
            "id":"0fd594e9-4635-4db6-9ea9-e04e80bf0b25",
            "name":"General",
            "taxUserTypeInfoId":1
        },
        {
            "id":"1d50940e-b166-432e-9470-9c9d751d9b8b",
            "name":"Business",
            "taxUserTypeInfoId":2
        },
        {
            "id":"962c7441-1d8a-48d2-a6cd-ca166e966bf0",
            "name":"Student",
            "taxUserTypeInfoId":3
        },
        {
            "id":"0a86b925-78a1-4075-ac4b-91251b4076f7",
            "name":"Military",
            "taxUserTypeInfoId":4
        },
        {
            "id":"109d671f-9437-4587-befb-56d0c39ec7b7",
            "name":"Charitable",
            "taxUserTypeInfoId":5
        }
    ],
    "pagination":{
        "pageNumber":1,
        "pageCount":5,
        "totalCount":5
    },
    "succeeded":true,
    "status":"SUCCESS",
    "errors":null
}

Error Codes

  • NO_RECORDS_FOUND

    NO_RECORDS_FOUND means there is no relevant information found.

  • FAILED

    FAILED refers to an unsuccessful API call.

  • SOMETHING_WENT_WRONG

    SOMETHING_WENT_WRONG refers to technical glitch. Please contact administrator.
API Reference documentation