Get User Profile

This endpoint retrieves the current user’s profile using their email address.

POST /auth/get_profile

Get User Profile

cURL

curl --request POST \
  --url https://public.plai.io/auth/get_profile \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "email": "<string>"
}
'

200

{
  "success": true,
  "results": {
    "success": true,
    "user": {
      "userId": "<string>",
      "email": "<string>",
      "name": "<string>",
      "createdAt": {
        "_seconds": 123,
        "_nanoseconds": 123
      }
    },
    "error": "<string>"
  }
}

Request Body

email · string · required

Customers Email Address

Response

success · boolean

Indicates that the HTTP response was successful (status code 200 OK).

results · object

Show Results

success · boolean

Indicates whether the specific operation or API action was successful.

user · object

Show Users Object

userId · string

Unique User id (you need to pass this id in all requests)

email · string

User Email Address

name · string

User name

createdAt · object

Show Timestamp Object

_seconds · number

Seconds Timestamp

_nanoseconds · number

Nanoseconds Timestamp

error · string

Error message if something went wrong