Get users List

GET 
/seb-api/v1/users

Retrieve a list of users.

Request

Query Parameters

limit int32

Number of users to return.

includeDeleted boolean

Include deleted users.

user.name string

Filter by user name.

user.email string

Filter by user email.

user.first_seen_gte date-time

Filter by first seen time or after.

user.last_seen_lte date-time

Filter by last seen time or before.

cursor string

An optional opaque string that defines from where to start listing

sort string

Possible values: [user.name, user.email, user.first_seen, user.last_seen]

The field to sort by.

order Order

Possible values: [asc, desc]

The sort order.

Responses

200

A list of users with pagination info

application/json

Schema

Schema

data object[]
Array [
deletedTime date-timerequired
Deleted Time
deviceIds string[]
Device IDs
email stringrequired
Email
externalId stringrequired
External identifier
firstSeen date-timerequired
First seen time
id stringrequired
Unique identifier
lastSeen date-timerequired
Last seen time
name stringrequired
Name
profilePictureURL stringrequired
Profile Picture URL
provider stringrequired
Possible values: [saml, local, oidc]
Provider
userGroups object[]
User Groups
Array [
createdAt date-time
Created at
id stringrequired
Unique identifier
lastUpdated date-time
Last updated
name stringrequired
Name
provider string
Possible values: [sso, local]
Provider
]
]
pageInfo object

cursor stringnullable

When paginating forwards, the cursor to continue.

hasNextPage booleanrequired

When paginating forwards, are there more items?

Example (from schema)

{
  "data": [
    {
      "deletedTime": "2024-07-29T15:51:28.071Z",
      "deviceIds": [
        "string"
      ],
      "email": "string",
      "externalId": "string",
      "firstSeen": "2024-07-29T15:51:28.071Z",
      "id": "string",
      "lastSeen": "2024-07-29T15:51:28.071Z",
      "name": "string",
      "profilePictureURL": "string",
      "provider": "saml",
      "userGroups": [
        {
          "createdAt": "2024-07-29T15:51:28.071Z",
          "id": "string",
          "lastUpdated": "2024-07-29T15:51:28.071Z",
          "name": "string",
          "provider": "sso"
        }
      ]
    }
  ],
  "pageInfo": {
    "cursor": "string",
    "hasNextPage": true
  }
}

400

Bad request

500

Internal server error

Loading...