v1

latestOpenAPI 3.0.02026-07-263403911.5 MB
Users

View user

Find a single user by ID.

get/v1/Users/{id}

Path parameters

idinteger required

ID of the user to view.

Response

OK

okboolean
user_idinteger

Primary identifier for this user.

first_namestring
last_namestring
login_namestring

a.k.a. Username.

emailstring

Used for system and account maintenance notification.

created_byinteger

Foreign identifier indicating the user who created this.

created_datestring date-time

Date and time this user was created.

agent_idinteger

If this user is associated with an agent, this is the ID of the agent object.

customer_hierarchy_idinteger

If this user is associated with a customer, this is the ID of the customer hierarchy object.

activeboolean

Indicates whether the user can log in.