Skip to main content
GET
/
preview
/
v2
/
users
List users
curl --request GET \
  --url https://api.sfcompute.com/preview/v2/users \
  --header 'Authorization: Bearer <token>'
{
  "object": "list",
  "data": [
    {
      "object": "user",
      "id": "<string>",
      "resource_path": "<string>",
      "created_at": 1738972800,
      "email": "<string>",
      "first_name": "<string>",
      "last_name": "<string>"
    }
  ],
  "has_more": true,
  "cursor": "usrc_gqXR7s0Kj5mHvE2wNpLc4Q"
}

Authorizations

​
Authorization
string
header
required

Create an API token using sf tokens create or at https://sfcompute.com/account/api-keys.

Query Parameters

​
id
string[]

Filter by user ID or resource path (repeatable).

A resource path like 'sfc:user:my-user' or an ID. Resource paths are human-readable but not stable - they change when resources are renamed or moved. IDs are stable and permanent.

Pattern: ([a-zA-Z0-9][a-zA-Z0-9._-]{0,254})|(sfc:user:[a-zA-Z0-9._-]+)
​
email
string

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

​
limit
integer<u-int32>
default:50
Required range: 1 <= x <= 200
​
starting_after
string

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

Pattern: ^usrc_[A-Za-z0-9_-]+$
Example:

"usrc_gqXR7s0Kj5mHvE2wNpLc4Q"

​
ending_before
string

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

Pattern: ^usrc_[A-Za-z0-9_-]+$
Example:

"usrc_gqXR7s0Kj5mHvE2wNpLc4Q"

Response

A paginated list of users.

​
object
string
default:list
required
read-only
Allowed value: "list"
​
data
object[]
required
​
has_more
boolean
required
​
cursor
null | string
Pattern: ^usrc_[A-Za-z0-9_-]+$
Example:

"usrc_gqXR7s0Kj5mHvE2wNpLc4Q"