E-State
  1. Auth
E-State
  • Prepare Api
  • E-state
    • Client
      • Attention Requests
        • index
        • store
        • show
      • Auth
        • profile
          GET
        • logout
          POST
        • register
          POST
        • login
          POST
      • Units
        • index
        • show
        • units client
      • Sales
        • index
        • show
    • System
      • Projects
        • index
        • show
      • Units
        • index
        • show units by project
        • show
      • Sales
        • SaleRefund
          • index
          • show
        • index
        • show
      • Attention Requests
        • index
        • show
      • Clients
        • index
        • show
      • Discounts
        • index
        • show
      • Lands
        • owners
        • index
        • show
        • show land owner
      • marketings
        • campaign-types
        • show campaign type
        • campaign-goals
        • show campaign goals
        • index
        • show
      • Purchase Orders
        • index
        • show
        • raise-budgets
        • show raise-budgets
      • Purchase Requests
        • index
        • show
      • Rental Requests
        • rental-requests
        • show rental-requests
  1. Auth

profile

Developing
GET
http://estate.test/api/v1{{url}}/profile
Request Request Example
Shell
JavaScript
Java
Swift
curl --location -g --request GET 'http://estate.test/api/v1/profile' \
--header 'x-api-key: f482480c-11fe-4426-9f6e-e7d26c8c3eed' \
--header 'x-secret-key: FkSF0PDbMOgLmLlJeMDSDzBFIl5dloAC'
Response Response Example
{
    "status": "true",
    "message": "Operation completed successfully",
    "data": {
        "id": 1,
        "name": "Tony Armstrong",
        "phone": "212.859.3192 x3642",
        "email": "Amber_Bins64@gmail.com",
        "nationality_id": 3,
        "area_id": 1,
        "city_id": 4,
        "block_id": 9,
        "sale_support_user_id": 4,
        "other_phone": "1-856-771-6905 x51849",
        "national_id": 0,
        "national_id_end_date": "2026-01-26T17:45:41.982Z",
        "postal_code": 13584,
        "date_of_birth": "2024-10-07T06:42:56.741Z",
        "gender": "female",
        "address": "Indiana West Benedicthaven Jefferson County 521 Kings Highway Suite 583",
        "avatar": "https://avatars.githubusercontent.com/u/65240267",
        "income": "dolor",
        "education_level": "enim eiusmod Lorem consectetur",
        "platform": "nisi",
        "avatar_url": "https://avatars.githubusercontent.com/u/35421906",
        "saleSupportUser": {
            "id": 3,
            "name": "Mr. Adrian Heidenreich",
            "email": "Abagail.Roberts79@gmail.com",
            "phone": 781.33,
            "job_title": "\\\"95m67}/2",
            "id_number": 3
        },
        "area": {
            "id": 8,
            "name": "Ms. Judith Halvorson",
            "type": "magna sed velit"
        },
        "city": {
            "id": 9,
            "country_id": 8,
            "parent_id": 7,
            "name": "Audrey Rolfson-Ledner",
            "type": "commodo ut Duis"
        },
        "block": {
            "id": 9,
            "name": "Alvin Mayer-Effertz",
            "type": "in occaecat sed"
        },
        "nationality": "veniam proident eu adipisicing",
        "sales": [
            {
                "id": 1,
                "reason_for_pay_id": 7,
                "project_id": 2,
                "building_id": 6,
                "unit_id": 3,
                "tax_reference_number": 1,
                "sale_type": "velit dolor consequat",
                "target_type": "eu adipisicing",
                "status": "quis labore minim"
            }
        ],
        "rentalRequests": [
            {
                "id": 4,
                "unit_name": "Yvonne Herman",
                "bathrooms_count": 1
            }
        ],
        "bookings": [
            {
                "id": 6,
                "unit_id": 7,
                "building_id": 2,
                "client_id": 9,
                "booking_open_at": "2025-02-19T22:33:01.528Z",
                "booking_expired_at": "2024-05-03T11:25:16.506Z",
                "booking_open_at_text": "aliquip mollit id aute amet",
                "booking_expired_at_text": "2025-04-18T06:51:10.256Z"
            },
            {
                "id": 1,
                "unit_id": 4,
                "building_id": 4,
                "client_id": 4,
                "booking_open_at": "2024-09-07T21:49:25.486Z",
                "booking_expired_at": "2024-12-25T22:20:31.983Z",
                "booking_open_at_text": "nisi cupidatat proident et",
                "booking_expired_at_text": "2025-04-18T16:57:50.285Z"
            }
        ]
    }
}

Request

Authorization
Provide your bearer token in the
Authorization
header when making requests to protected resources.
Example:
Authorization: Bearer ********************
Header Params
x-api-key
string 
optional
Example:
{{x-api-key}}
x-secret-key
string 
optional
Example:
{{x-secret-key}}

Responses

🟢200Success
application/json
Body
status
string 
required
status
message
string 
required
data
object (Client) 
required
id
number 
required
ID
name
string 
required
name
phone
string 
required
email
string 
optional
nationality_id
number 
optional
area_id
number 
optional
city_id
number 
optional
block_id
number 
optional
sale_support_user_id
number 
optional
other_phone
string 
optional
national_id
number 
optional
national_id_end_date
string 
optional
postal_code
number 
optional
date_of_birth
string 
optional
gender
string 
optional
address
string 
optional
avatar
string 
optional
income
string 
optional
education_level
string 
optional
platform
string 
optional
avatar_url
string 
optional
saleSupportUser
object (User Simple) 
optional
area
object (Area Simple) 
optional
city
object (City Simple) 
optional
block
object (Block Simple) 
optional
nationality
string 
optional
sales
array[object (Sale Simple) {9}] 
optional
rentalRequests
array[object (RentalRequest Simple) {3}] 
optional
bookings
array[object (Booking Simple) {8}] 
optional
Modified at 2025-04-16 00:04:54
Previous
show
Next
logout
Built with