User

Represents a user. You can retrieve standard fields on User with the Tooling API, but custom fields can’t be retrieved.

User fields are exposed in SOAP API version 45.0 and later. You can use Tooling API to query for User fields in guest user mode in API version 44.0 and earlier. In API version 45.0 and later, use SOAP API to get this data in guest user mode. User is still exposed in Tooling API to User Profiles with the ViewSetup permission.

Note

Version 

Introduced in API version 25.0.

Supported SOAP API Calls 

describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), update()

Supported REST API Methods 

GET, HEAD, PATCH, Query

Fields 

FirstName 

• Type: string

• Required: No

• Properties: Filter, Group, Nillable, Sort, Update

• Description: The user’s first name.

LastName 

• Type: string

• Required: No

• Properties: Filter, Group, Sort, Update

• Description: The user’s last name.

MiddleName 

• Type: string
• Required: No
• Properties: Filter, Group, Nillable, Sort, Update

Name 

• Type: string

• Required: No

• Properties: Filter, Group, Sort

• Introduced: API version 33.0

• Description: Concatenation of FirstName and LastName. Limited to 121 characters.

Suffix 

• Type: string
• Required: No
• Properties: Filter, Group, Nillable, Sort, Update

Username 

• Type: string

• Required: No

• Properties: Filter, Group, idLookup, Sort, Update

• Description: The name of the user in your organization.

WorkspaceId 

• Type: reference

• Required: No

• Properties: Filter, Group, Nillable, Sort, Update

• Introduced: API version 25.0

• Description: The ID of the last open Developer Console workspace.

• Relationship name: WorkspaceId

• Relationship type: relationship

• Refers to: IDEWorkspace