API Reference

Get User Profile Details

This API is used to get the user profile details when the user clicks on the My Profile page from the Profile menu.

We need to pass the authorization token in API in the header.

An authorization token will be generated when the user logs into the system.

Here are the descriptions of response attributes, which return in the form of JSON.

Attribute

Description

email

This returns the user's email ID.

firstName

This returns the user's first name.

lastName

This returns the user's last name.

countryCode

This returns the user's country code.

phoneNumber

This returns the user's phone number.

address1

This returns the user's address.

address2

This returns the user's address.

cityOrProvidence

This returns the user's city.

zipcode

This returns the user's postal/zip code.

state

This returns the user's US state.

country

This returns the user's country name.

zapierEnabled

Used to identify whether Zapier is enabled or not.

admin

Returns 'true' if the user is an admin. If not it returns "false."

userLabel

Returns the label if the role of the user is either super admin or admin status.

userProfilePhoto

Returns the user profile photo URL.

Here are the possible error messages, which will return if any conditions fail or the required data is missing for processing

Error code

Error description

200

Ok

401

User is not authorized to view the resource.

404

The resource you were trying to reach is not found.

Language
Credentials
Header
Click Try It! to start a request and see the response here!