v1

latestOpenAPI 3.1.02026-07-2665179189.7 KB

Users

List users

⚠️ This endpoint is in public preview.

List users that are members of the caller's organization.

get/preview/v2/users

Query parameters

idResourcePathOrIdUserId[]

Filter by user ID or resource path (repeatable).

[
  "my-resource-name"
]

emailstring

Filter to the user with this email address. Matched case-insensitively against the member's non-deleted identities.

limitinteger

starting_afterstring

Example:usrc_gqXR7s0Kj5mHvE2wNpLc4Q

Set to the response's cursor to fetch the next page.

ending_beforestring

Example:usrc_gqXR7s0Kj5mHvE2wNpLc4Q

Set to the response's cursor to fetch the previous page.

Response

A paginated list of users.

object'list' required

has_moreboolean required

cursorstring

Example response

{
  "data": [
    {
      "id": "my-resource-name",
      "resource_path": "sfc:user:<name>",
      "created_at": 1738972800
    }
  ],
  "cursor": "usrc_gqXR7s0Kj5mHvE2wNpLc4Q"
}