Skip to main content

list

Lists users defined within the environment.

Parameters​

search (optional) - Search users by key, email, first name, or last name
role (optional) - Match users with a specific role
page (optional) - The page number of the results to fetch, starting at page 1
perPage (optional) - The number of results per page (maximum of 100)

Implementation​

await permit.api.users.list({
  search: "@permit.io",
  role: "admin",
  page: 1,
  perPage: 20,
});

Contents