GET
/
users
List users
curl --request GET \
  --url https://core.api.ravennahq.com/api/users \
  --header 'x-ravenna-api-token: <api-key>'
{
  "items": [
    {
      "id": "<string>",
      "firstName": "<string>",
      "lastName": "<string>",
      "email": "<string>",
      "image": "<string>",
      "slackTeamId": "<string>",
      "slackUserId": "<string>",
      "slackRealName": "<string>",
      "slackImageUrl": "<string>",
      "emailVerified": "<string>",
      "defaultWorkspaceId": "<string>",
      "isGuestCreated": true,
      "isBot": true,
      "createdAt": "<string>",
      "auth0Id": "<string>",
      "updatedAt": "<string>"
    }
  ],
  "totalCount": 123,
  "nextCursor": "<string>"
}

Authorizations

​
x-ravenna-api-token
string
header
required

Query Parameters

​
search
string | null
​
email
string | null
​
skip
number | null
Required range: x >= 1
​
offset
number | null
Required range: x >= 0
​
cursor
string | null
​
limit
number | null
default:100
Required range: 1 <= x <= 10000
​
set
string | null
​
sortBy
string | null
​
sortDirection
enum<string> | null
Available options:
asc,
desc
​
groupBy
string | null
​
groupDirection
enum<string> | null
Available options:
asc,
desc

Response

200
application/json

Successful response

The response is of type object.