User

Find all users.

GET

http://localhost:3000/api/user

Find all users.

curl -X GET 'http://localhost:3000/api/user' \
  -H 'Authorization: Bearer YOUR_TOKEN'

const response = await fetch('http://localhost:3000/api/user', {
  method: 'GET',
  headers: {
    'Authorization': 'Bearer YOUR_TOKEN',
  },
});

const data = await response.text();

import requests

response = requests.get(
    'http://localhost:3000/api/user',
    headers={
        'Authorization': 'Bearer YOUR_TOKEN',
    },
)
print(response.text)

200

{
  "deletedAt": "2018-11-21T06:20:32.232Z",
  "createdAt": "2018-11-21T06:20:32.232Z",
  "updatedAt": "2018-11-21T06:20:32.232Z",
  "id": "string",
  "isActive": true,
  "isArchived": false,
  "archivedAt": "2018-11-21T06:20:32.232Z",
  "tenantId": "string",
  "thirdPartyId": "string",
  "firstName": "string",
  "lastName": "string",
  "email": "string",
  "phoneNumber": "string",
  "username": "string",
  "timeZone": "string",
  "timeFormat": 12,
  "hash": "string",
  "refreshToken": "string",
  "imageUrl": "string",
  "preferredLanguage": "en",
  "preferredComponentLayout": "CARDS_GRID",
  "uiPreferences": {},
  "code": "string",
  "codeExpireAt": "2024-01-15T09:30:00Z",
  "emailVerifiedAt": "2024-01-15T09:30:00Z",
  "lastLoginAt": "2024-01-15T09:30:00Z",
  "emailToken": "string",
  "roleId": "string",
  "imageId": "string",
  "defaultTeamId": "string",
  "lastTeamId": "string",
  "defaultOrganizationId": "string",
  "lastOrganizationId": "string"
}

Parameters

selectObjectquery

relationsObjectquery

whereObjectrequiredquery

orderObjectquery

withDeletedbooleanquery

takenumber[0, 100]query

skipnumber>= 0query

Response

200OKUser

Found users

Response fields application/json

deletedAtstring<date-time>

Example

2018-11-21T06:20:32.232Z

createdAtstring<date-time>

The creation timestamp of the entity.

Example

2018-11-21T06:20:32.232Z

updatedAtstring<date-time>

The last update timestamp of the entity.

Example

2018-11-21T06:20:32.232Z

idstring

isActivebooleantrue

isArchivedbooleanfalse

archivedAtstring<date-time>

Example

2018-11-21T06:20:32.232Z

tenantIdstring

thirdPartyIdstring

firstNamestring

lastNamestring

emailstring

phoneNumberstring

usernamestring

timeZonestring

timeFormatstring1224

hashstring

refreshTokenstring

imageUrlstring

preferredLanguagestringenbgherufreszhdeptitnlplar

preferredComponentLayoutstringCARDS_GRIDTABLE

uiPreferencesobject

codestring

codeExpireAtstring<date-time>

emailVerifiedAtstring<date-time>

lastLoginAtstring<date-time>

emailTokenstring

roleIdstring

imageIdstring

defaultTeamIdstring

lastTeamIdstring

defaultOrganizationIdstring

lastOrganizationIdstring

401Unauthorized

Unauthorized

403Forbidden

Forbidden

404Not Found

Record not found

Authorization

bearerhttp (bearer) in header

Enter JWT token

bearerhttp (bearer) in header

Enter JWT token

Stack Overflow Website Demo