Sign in

v1

latestOpenAPI 3.0.3Apache 2.02026-08-062991191002.1 KB
User

Retrieves a User resource.

Retrieves a User resource.

get/users/{id}

Path parameters

idstring required

Resource identifier

Response

User resource

idstring
integrationstring

The key of the integration source e.g. "quickbooks", or "xero"

srcIdstring

the unique identifier of the source 3rd party integration

emailstring nullable

User email address

lastNamestring nullable

User last name

firstNamestring nullable

User first name

modifiedstring date-time nullable

Date and time user information last modified

rolestring nullable

User role in the company

primaryPhonestring nullable

Piamry phone number

addressLine1string nullable

User location line1 address

citystring nullable

User location line2 address

countrystring nullable

User location country address

postalCodestring nullable

User location postalcode

companystring nullable

The company user works in

profileUrlstring nullable

A URL that can be used to view the user's information without logging in.

departmentstring nullable

The department user works in

createdstring date-time nullable

When the user objects created

namestring nullable

Name of the user

Example response

{
  "integration": "quickbooks"
}