List Users | Gradii API Documentation

{
  "success": true,
  "data": {
    "users": [
      {
        "id": "user-uuid",
        "firstName": "John",
        "lastName": "Doe",
        "email": "john@example.com",
        "role": "hr",
        "jobTitle": "HR Manager",
        "department": "Human Resources",
        "phoneNumber": "+1234567890",
        "isActive": true,
        "emailVerified": "2024-01-15T10:00:00.000Z",
        "otpLoginEnabled": true,
        "socialLoginEnabled": true,
        "createdAt": "2024-01-01T00:00:00.000Z",
        "updatedAt": "2024-01-15T10:00:00.000Z",
        "lastLoginAt": "2024-01-28T09:00:00.000Z"
      }
    ],
    "pagination": {
      "currentPage": 1,
      "totalPages": 5,
      "totalCount": 95,
      "limit": 20,
      "hasNextPage": true,
      "hasPreviousPage": false,
      "nextPage": 2
    },
    "filters": {
      "search": "john",
      "role": "hr",
      "isActive": true,
      "sortBy": "firstName",
      "sortOrder": "asc"
    },
    "company": {
      "id": "company-uuid",
      "name": "Acme Corp",
      "email": "admin@acme.com"
    }
  },
  "message": "Retrieved 20 users",
  "timestamp": "2024-01-28T10:00:00Z",
  "version": "2.0"
}

Get paginated list of users for your company with filtering, searching, and sorting

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Query parameters

pageintegerOptional

Page number (default: 1, min: 1)

limitintegerOptional

Users per page (default: 20, min: 1, max: 100)

searchstringOptional

Search in firstName, lastName, email, jobTitle, or department (min 2 chars)

rolestringOptional

Filter by role: owner|hr|interviewer|recruiter

departmentstringOptional

Filter by department

isActivebooleanOptional

Filter by active status (true|false)

sortBystringOptional

sortOrderstringOptional

Sort order: asc|desc (default: desc)

Response

Users retrieved successfully

successbooleanOptional

dataobjectOptional

messagestringOptional

timestampstringOptional

versionstringOptional

$	curl https://gradii.ai/api/v2/users \
>	-H "Authorization: Bearer <token>"