Users
Retrieves a paged list of users.
Example request:
GET /v1/users?profileid=12000000&page=1&pagesize=25&search=FirstName:"Alice"
Searchable fields:
- UserID (number)
- Status (string)
- LoginName (string)
- DisabledOnDate (date)
- FirstName (string)
- LastName (string)
- CorrespondenceEmailAddress (string)
- PhoneNumber (string)
- EnableSAMLDirectLogin (boolean)
- BillingAccess (boolean)
- Groups.GroupID (number)
- Groups.GroupName (string)
- Groups.IsAdmin (boolean)
Supported operators:
- Strings: ":" (exact). Values must be in quotes, e.g. FirstName:"Alice" or LoginName:"asmith". Negate with leading '-', e.g. -FirstName:"Alice".
- Numbers/Dates: =, >, >=, <, <= (e.g. UserID>100, DisabledOnDate>=2025-01-01)
- Booleans: ":" with "true"/"false" in quotes (e.g. BillingAccess:"true"), negate with '-'
- Null checks: field:null or -field:null (is null / is not null)
- Combine with AND / OR (case-insensitive)
Validation errors:
- 400 InvalidPage: Page must be a positive integer.
- 400 InvalidPageSize: Pagesize must be between 1 and 100.
- 400 ProfileRequired: ProfileID is required when the integration has access to multiple profiles.
- 401 Unauthorized: Access to the profile is not allowed.
get/v1/users
Request
- Base URL: https://api.channeladvisor.com
- URL: https://api.channeladvisor.com/v1/users
- Auth: OAuth 2 (authorization code, authorization URL https://api.channeladvisor.com/oauth2/authorize, token URL https://api.channeladvisor.com/oauth2/token; implicit, authorization URL https://api.channeladvisor.com/oauth2/authorize, scopes: orders, inventory) and HTTP bearer
Query parameters
profileidinteger
pageinteger
1-based page number. Must be a positive integer.
pagesizeinteger
searchstring
Optional advanced search query.
Response
Paged list of users
Changes
No recorded changes to this operation across all 1 revision of this API.