The Open API specification for Synapse is now available for download!

Download Open API Spec

GET /userGroupHeaders

Get Users and Groups that match the given prefix.

Resource URL

https://repo-prod.prod.sagebase.org/repo/v1/userGroupHeaders

Parameters
prefix

optional

The name to search for.
typeFilter

optional

Restrict the results to a type of principal. Available options: TypeFilter.
offset

optional

The offset index determines where this page will start from. An index of 0 is the first item.

Default is 0

limit

optional

Limits the number of items that will be fetched for this page.

Default is 10

Resource Information
Authentication not required
Required OAuth Scopes view
HTTP Method GET
Request Object None
Response Object UserGroupHeaderResponsePage
(application/json)