---
title: "Retrieve user information by email address"
slug: "retrieve-user-information-by-email-address"
updated: 2024-10-25T18:04:27Z
published: 2026-02-10T22:32:35Z
---

> ## Documentation Index
> Fetch the complete documentation index at: https://docs.skillable.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Retrieve user information by email address

Get/GetUserByEmail

Allows you to get information about a user with the given primary email address.

SecurityAPI Key: api_keyHeader parameter nameapi_key

Query parametersemailstringRequired

The primary email address of the user to retrieve.

Responses200

OK Response

<select class='api-response-data' aria-label='Media type'><option value='efb476b6-3ea6-4f04-8eef-48821138408f'>application/json</option>
</select>Expand Allobject  Statusinteger  (int32)    

Indicates the status of the API request. 0 = Success 10 = Error 20 = Not found 30 = Invalid integration key

Example0
Errorstring   | null  

Error details. This will only have a value if an error was encountered. The status property will also be set to Error (10).

Userobject (User)  Idinteger  (int32)    

The user's unique identifier

Example57383
ExternalIdstring   | null  

The user's external ID, usually a unique identifier from the calling system

ExampleC9876ZFGEFER9876
Titlestring   | null  

The user's title

FirstNamestring    

The user's first name

ExampleJohn
MiddleNamestring   | null  

The user's middle name

LastNamestring    

The user's last name

ExampleSmith
UserNamestring    

The user's username (used during sign-in)

Examplejohn.smith
OrganizationIdinteger  (int32)    

The unique identifier of the organization the user belongs to

Example4873
CompanyIdinteger  (int32)   | null  

The Id of the user's company (set only if the user belongs to a company)

ManagerIdinteger  (int32)   | null  

The user Id of the user's manager (set only if the user belongs to a manager)

Disabledboolean    

Indicates whether the user account has been disabled

Examplefalse
Emailstring    

The user's e-mail address

Examplejoe.smith@yourorg.com
Phonestring   | null  

The user's phone number

Phone2string   | null  

The user's secondary phone number

Address1string   | null  

First line of the user's address

Address2string   | null  

Second line of the user's address

Citystring   | null  

The user's city

Statestring   | null  

The user's state

Countrystring   | null Deprecated 

The user's country.

CountryCodestring   | null  

The 2-character code for the user's country

Zipstring   | null  

The user's zip/postal code

ProfileImageUrlstring   | null  

URL to the user's profile image

TimeZoneIdstring   | null  

The User's timezone

Roles Array of integer   

Identifiers of roles the user belongs to

Example[
  0,
  2
]integer  (int32)    
ManagedOrganizations Array of integer   

Identifiers of organizations the user has management rights to

Example[]integer  (int32)    
CustomFields Array of object   

Custom Fields that have values for the user

Example[
  {
    "Name": "Core Id",
    "TextValue": "AXY12345",
    "CustomFieldId": 5080
  },
  {
    "Name": "Blood Type",
    "TextValue": "A+",
    "CustomFieldId": 5081
  }
]object  string
