Get one User

Authorizations

Authorization

string

header

required

Generate a JWT access token through a Custom Global Integration and provide it with each request in the Authorization header prefixed with "Bearer" and then a single space.

Path Parameters

type

enum<string>

required

Specify the user type to which your operations will be restricted.

Available options:

any,

organization,

client

integer<int32>

required

The id of the referenced User.

Required range: x >= 1

Query Parameters

fields

enum<string>[]

Specify additional fields of the OrganizationUser or ClientUser objects to be included in the response. See the selecting fields page for more information.

Available options:

basic,

all,

created_at,

updated_at,

last_login_at,

login_via_badge,

is_deleted,

roles,

default_warehouse

fields:roles

enum<string>[]

Specify additional fields of the OrganizationRole or ClientRole object to be included in the response. See the selecting fields page for more information.

Available options:

all

fields:warehouse

enum<string>[]

Specify additional fields of the Warehouse object to be included in the response.

Available options:

all

fields:merchant

enum<string>[]

Specify additional fields of the Merchant object to be included in the response. See the selecting fields page for more information.

Available options:

basic,

all,

code,

name,

status,

created_at,

updated_at,

brands,

default_brand

Response

resource

OrganizationUser · object

A user with organization-wide access.

OrganizationUser
ClientUser

Show child attributes

resource.type

enum<string>

required

This property describes the type of object in the response body.

Available options:

OrganizationUser

resource.id

integer<int32>

required

The internal id property used as a path parameter in a resource lookup.

Example:

3

resource.name

string

The full name of the user.

Maximum string length: 65

Example:

"Bernard Greensmith"

resource.email

string<email>

The user's email address.

Maximum string length: 128

Example:

"[email protected]"

resource.username

string

User name for login.

Maximum string length: 40

Example:

"b.greensmith"

resource.is_active

boolean

Only active users may log in.

Example:

true

resource.roles

UserRoleRef · object[]

A list of user roles allowed for this user.
Optional Field

Show child attributes

resource.roles.type

enum<string>

required

Available options:

OrganizationUserRole,

ClientUserRole

resource.roles.id

integer<int32>

required

The internal id property used as a path parameter in a resource lookup.

Example:

3

This flag must be true to allow login with badge capability.
Optional Field

Example:

true

resource.default_warehouse

WarehouseRef · object

The last Warehouse that was active for the user.
Optional Field

Show child attributes

resource.default_warehouse.type

enum<string>

required

This property describes the type of object in the response body.

Available options:

Warehouse

resource.default_warehouse.id

integer<int32>

required

The internal id property used as a path parameter in a resource lookup.

included

object

Lists of referenced objects included by specifying optional fields. See the selecting fields page for more information.

Show child attributes

included.ClientUserRole

ClientUserRole · object[]

Show child attributes

included.ClientUserRole.type

enum<string>

This is a read-only property that describes the type of object in the response body.

Available options:

ClientUserRole

included.ClientUserRole.id

integer

The internal id property used as a path parameter in a resource lookup.

Example:

3

included.ClientUserRole.name

string

The name of the User Role.

Maximum string length: 50

Example:

"Administrators"

included.ClientUserRole.permissions

string[]

A list of permissions for a single role.

Example:

[
  "warehouse",
  "warehouse/staff",
  "warehouse/staff/time_entry_log",
  "warehouse/staff/time_management",
  "warehouse/staff/time_management/excluded",
  "warehouse/staff/time_management/status_dashboard"
]

included.Merchant

Merchant · object[]

Show child attributes

included.Merchant.type

enum<string>

Available options:

Merchant

included.Merchant.id

integer<int32>

The internal id property used as a path parameter in a resource lookup.

Example:

4

included.Merchant.code

string

Merchant code may only contain letters (a-z), numbers (0-9) or underscore(_), the first character must be a letter.

Required string length: 1 - 32

Example:

"acme_inc"

included.Merchant.name

string

Any string which uniquely identifies a Merchant.

Required string length: 1 - 64

Example:

"ACME Inc."

included.Merchant.status

enum<string> | null

default:active

Lifecycle status of the Merchant:

active: Merchant is operational and available for use
suspended: Temporarily on hold, can be easily reactivated
inactive: Long-term offline status, reactivation is possible but may require additional steps
archived: Soft delete status, manual recovery required

Available options:

active,

inactive,

suspended,

archived

Example:

"active"

included.Merchant.created_at

string<date-time> | null

The date and time the object was created in RFC 3339 section 5.6 notation.
Optional Field

Example:

"2017-07-21T17:32:28Z"

included.Merchant.updated_at

string<date-time> | null

The date and time the object was last updated in RFC 3339 section 5.6 notation.
Optional Field

Example:

"2017-07-21T17:39:43Z"

included.Merchant.brands

BrandRef · object[]

A merchant must have one or more brands which may share the same pool of inventory. Brands can be used for customizing presentation and behaviors and often correspond to distinct lines of business or market presences.
Optional Field

Show child attributes

included.Merchant.brands.type

enum<string>

required

Available options:

Brand

included.Merchant.brands.id

integer<int32>

required

The numeric id of a particular resource being updated.

Example:

4

included.Merchant.default_brand

BrandRef · object

This is the primary brand used when defining only the merchant for operations such as creating a new product.
Optional Field

Show child attributes

included.Merchant.default_brand.type

enum<string>

required

Available options:

Brand

included.Merchant.default_brand.id

integer<int32>

required

The numeric id of a particular resource being updated.

Example:

4

included.OrganizationUserRole

OrganizationUserRole · object[]

Show child attributes

included.OrganizationUserRole.type

enum<string>

This is a read-only property that describes the type of object in the response body.

Available options:

OrganizationUserRole

included.OrganizationUserRole.id

integer

The internal id property used as a path parameter in a resource lookup.

Example:

3

included.OrganizationUserRole.name

string

The name of the User Role.

Maximum string length: 50

Example:

"Administrators"

included.OrganizationUserRole.permissions

string[]

A list of permissions for a single role.

Example:

[
  "warehouse",
  "warehouse/staff",
  "warehouse/staff/time_entry_log",
  "warehouse/staff/time_management",
  "warehouse/staff/time_management/excluded",
  "warehouse/staff/time_management/status_dashboard"
]

included.Warehouse

Warehouse · object[]

Show child attributes

included.Warehouse.type

enum<string>

required

This is a read-only property that describes the type of object in the response body.

Available options:

Warehouse

included.Warehouse.id

integer<int32>

required

The internal id property used as a path parameter in a resource lookup.

Example:

3

included.Warehouse.name

string

The display name for the Warehouse.

Maximum string length: 255

Example:

"East Coast 1"

included.Warehouse.is_active

boolean

This flag determines if the Warehouse is active and viable for fulfillment.

Example:

true

Get Started

Common Features

Inventory API v1

Receiving API v1

Shipping API v1

System API v1

Authorizations

Path Parameters

Query Parameters

Response