users.list

GET

/v1/users

import { Client, Orvano } from '@orvano/js/server'

const orvano = new Orvano(
  new Client({ endpoint: 'https://orvano.example.com', apiKey: process.env.ORVANO_API_KEY }),
)

const userPage = await orvano.users.list()
console.log(userPage)

import 'dart:io';

import 'package:orvano_dart/orvano_dart.dart';

Future<void> main() async {
  final orvano = Orvano(
    Client(
      endpoint: 'https://orvano.example.com',
      apiKey: Platform.environment['ORVANO_API_KEY'],
    ),
  );
  final userPage = await orvano.users.list();
  print(userPage.toJson());
}

using Orvano;

using var orvano = new OrvanoClient(new OrvanoClientOptions(new Uri("https://orvano.example.com"))
{
    ApiKey = Environment.GetEnvironmentVariable("ORVANO_API_KEY"),
});
var userPage = await orvano.Users.ListAsync();
Console.WriteLine(userPage);

Lists the project’s users, newest first.

Server SDKs: JavaScript on a server, Dart, and .NET call it with an API key. API key scope: users.read. A failure answers with a problem details body; its code has a page under Errors.

Authorizations

apiKey

Parameters

Query Parameters

email

string

Only users whose email starts with this, ignoring case.

status

string

Only users with this status: active or blocked.

createdAfter

string format: date-time

Only users created after this time.

createdBefore

string format: date-time

Only users created before this time.

emailVerified

boolean

Only verified users (true) or unverified users (false).

cursor

string

The nextCursor of the previous page.

limit

integer format: int32

Users per page, 1 to 100. Defaults to 25.

Responses

200

The request has succeeded.

application/json

One page of a project’s users, newest first.

object

items

required

The users on this page.

Array<object>

A user of a project.

object

required

The user ID.

string

email

required

Any of:

string
null

string

emailVerified

required

Whether the email has been verified. Also the access token’s email_verified claim.

boolean

emailVerifiedAt

required

Any of:

string
null

string format: date-time

name

required

Any of:

string
null

string

status

required

Whether the user may sign in.

string

Allowed values: active blocked

metadata

required

Your own data about the user: a JSON object of at most 16 KB.

object

createdAt

required

When the user signed up.

string format: date-time

lastSignInAt

required

Any of:

string
null

string format: date-time

nextCursor

required

Any of:

string
null

string

Example

{
  "items": [
    {
      "id": "01924f5e-8d2b-7c4d-8e21-3d5e6f7a8b9c",
      "email": "ada@example.com",
      "emailVerified": false,
      "name": "Ada Lovelace",
      "status": "active"
    }
  ]
}

default

An unexpected error response.

application/problem+json

An RFC 9457 problem details body. Every operation declares it as its default response, sent as application/problem+json.

object

type

required

Identifies the error: https://orvano.dev/errors/<code>.

string

title

required

The standard HTTP reason phrase for the status.

string

status

required

The HTTP status code.

integer format: int32

detail

A short, safe sentence about this occurrence, when the server has one.

string

code

required

Orvano’s stable error code, from the ErrorCode catalog. SDKs treat it as a plain string.

string

requestId

required

The request ID to quote when reporting a problem; also sent as X-Request-Id.

string

Example

{
  "type": "https://orvano.dev/errors/not_found",
  "title": "Not Found",
  "status": 404,
  "code": "not_found",
  "requestId": "4bf92f3577b34da6a3ce929d0e0e4736"
}