Skip to main content

Search Groups

GET 
/:namespace/Groups

Status: Trusted Tester

List the groups that can be assigned to users, or look one up by displayName. Groups in Vendasta are predefined: they cannot be created, renamed or deleted, so this list is the same for every namespace. For what each group grants see Groups and their assignment to users.

To enumerate the groups, send this request without a filter and without paging parameters. The complete list is returned in a single response. The filters below are for looking up one group, not for listing a subset reliably.

Only two filter expressions are supported: displayName eq "Platform Admin" and type eq "platformFeature". type eq "business" and type eq "businessFeature" are rejected with 501; anything that is not a single comparison, such as two expressions joined with and, is rejected with 400. Other unsupported filters are rejected, but not with a single consistent code — treat any non-200 here as "unsupported filter".

A displayName search is an exact match against the display names in the group reference, and a value that does not match one is an error rather than an empty list. Do not use it to test whether a group exists.

Business groups are per business location, so an unfiltered list shows them against the placeholder account group AG-1234567. Substitute the real business location id when assigning one.

Group membership is not returned here: members is always absent. Read a user to see the groups they belong to.

Request​

Responses​

OK