Groups

Retrieves a paged list of user groups.

Example request:

             GET /v1/groups?profileid=12000000&page=1&pagesize=25&search=GroupName:"Admin"

Searchable fields:

  • GroupID (number)
  • GroupName (string)
  • ModuleID (number)
  • ModuleName (string)
  • AccountID (number)
  • AccountName (string)
  • ParentGroupID (number)
  • IsAdmin (boolean)

Supported operators:

  • Strings: ":" (exact). Values must be in quotes, e.g. GroupName:"Admin". Negate with leading '-'
  • Numbers/Dates: =, >, >=, <, <= (e.g. GroupID>100)
  • Booleans: ":" with "true"/"false" in quotes (e.g. IsAdmin:"true"), negate with '-'
  • Null checks: field:null or -field:null (is null / is not null)
  • Combine with AND / OR (case-insensitive)

NOTE: Only the first 10 Modules may be returned per group in the bulk list endpoint.

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/groups

Request

  • Base URL: https://api.channeladvisor.com
  • URL: https://api.channeladvisor.com/v1/groups
  • 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 user groups

Changes

No recorded changes to this operation across all 1 revision of this API.