List users
const url = 'https://optlo.com/api/v1/users?limit=50&externalIdKind=string';const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request GET \ --url 'https://optlo.com/api/v1/users?limit=50&externalIdKind=string' \ --header 'Authorization: Bearer <token>'Requires users:read.
Authorizations
Section titled “Authorizations”Parameters
Section titled “Parameters”Query Parameters
Section titled “Query Parameters”Maximum number of resources to return on one page.
Opaque cursor from the preceding page. Bound to workspace, resource and filters; survives key rotation.
Case-insensitive exact match; returns all matching users.
Exact external identity, preserving string/number distinction.
Type of the externalId filter. Numeric and string external IDs are distinct.
Response
Section titled “Response”Success
Show child attributes
Resources on this page.
Show child attributes
Unique identifier for the user.
User’s display name.
User’s email address.
User identifier in your system. String and numeric IDs are distinct.
URL of the user’s avatar image.
Custom attributes attached to the user, such as plan or company. Values can be strings, numbers, booleans, or null.
Show child attributes
Time the user was created.
Time of the user’s most recent visit. Null if no visit has been recorded.
Pass this cursor to retrieve the next page. Null when no further page is available. When polling events in ascending order, retain the cursor even on empty pages.
Example
{ "data": [ { "id": "user_kR7mP3xB9nQ2vL5z", "name": "Sam Rivera", "email": "sam@example.com", "externalId": "customer_1042", "avatarUrl": null, "attrs": { "plan": "pro", "company": "Acme" }, "createdAt": "2026-10-13T09:00:00.000Z", "lastVisitedAt": "2026-10-13T09:05:00.000Z" } ], "nextCursor": null}