Tenant Profile - GET

Tenant Profile - GET API Endpoint
StoRegister - Tenant

Tenant Profile API

This endpoint retrieves the profile information of the logged-in user, encompassing primary details, address information, and profile image.

GET
/v1/tenant/profile
Request Content Type
application/json
Response Content Type
application/json

Response Payload:

  • succeeded boolean

    Indicates whether the request to retrieve logged-in user (i.e., Tenant) information was successful.

  • status string

    Describes the status of the request to retrieve logged-in user (i.e., Tenant) information for the login user.

  • data object

    Contains logged-in user (i.e., Tenant) Profile Information (refer to Tenant Profile Details section).

  • errors array

    Holds any error information if applicable.

Tenant Profile Details

Primary and communication address information of the logged-in user (i.e., Tenant Information)

object data.contactBook

  • id unique-identifier

    Unique identifier for the logged-in user (i.e., Tenant).

  • firstName string

    First name of the logged-in user.

  • lastName string

    Last name of the logged-in user.

  • email string

    Email address of the logged-in user.

  • phoneNumber string

    Phone number of the logged-in user.

  • address string

    Address of the logged-in user.

  • city string

    City of the logged-in user.

  • postalCode string

    Postal code of the logged-in user.

  • region string

    Information about the state, province, or county (if applicable) of the logged-in user, including the unique identifier (Id) and name.

  • country object

    Country information of the logged-in user, including the unique identifier (Id), name, ISO codes, and dialing code.

  • profileImageInfoPath object

    Remote file Path to the profile image of the logged-in user.

Request Header

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

API Response

{
    "data": {
        "contactBook": {
            "id": "e9e3de25-9b64-43b2-8510-5d954d091053",
            "firstName": "Giada",
            "lastName": "Rossi",
            "email": "[email protected]",
            "phoneNumber": "+33 3552623014",
            "address": "13 Rue des Chalets",
            "city": "Toulouse",
            "postalCode": "31000",
            "region": {
                "id": 0,
                "name": ""
            },
            "country": {
                "id": 82,
                "name": "France"
            },
            "profileImageInfoPath": "https://..."
        }
    },
    "succeeded": true,
    "status": "SUCCESS",
    "errors": null
}

Error Codes

  • INVALID_PARAM_CONTACT_BOOK_ID

    INVALID_PARAM_CONTACT_BOOK_ID refers to invalid contact id or invaild user id to retrieve contact details.

  • UNABLE_TO_RETREIVE_CONTACT_DETAILS

    UNABLE_TO_RETREIVE_CONTACT_DETAILS refers to unable to retrieve contact details.

  • 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