List users pinned to a homepage

Returns the list of users whose preferred homepage is the specified homepage. The result is paginated: use the limit and skip query parameters to page through results. When more results are available, the response includes an X-Next-Page header (and an X-Previous-Page header when a previous page exists) containing the URL of the corresponding page.

Path Params
integer
required

The ID of the homepage to update. To find a homepage's ID, log into Alation and go to Admin Settings > Customize Homepage and edit the desired homepage. The homepage's ID can be found at the end of the URL path.

Query Params
integer
≤ 100
Defaults to 20

The maximum number of users to return in a single page.

integer
Defaults to 0

The number of users to skip before returning results, used for pagination.

Responses

Language
Credentials
Header
URL
LoadingLoading…
Response
Choose an example:
application/json