MOmodjo
Users

List users

Changed on

Returns a paginated list of users. Supports filtering by email and by license assignment.

get/users

Request

  • Base URL
    https://api.modjo.ai/v2
  • URL
    https://api.modjo.ai/v2/users
  • Auth
    HTTP bearer

Query parameters

pageinteger

Page number (1-based)

Example:1
sizeinteger

Number of items per page

Example:25
emailstring email

Filter by exact email address

has_license'true' | 'false'

Filter on license assignment: "true" returns licensed users only, "false" unlicensed users only

Example:true

Response

Paginated list of users

Example response

{
  "data": [
    {
      "id": 1,
      "email": "john@example.com",
      "phoneNumber": "+33612345678",
      "jobTitle": "Account Executive",
      "jobDepartment": "Sales",
      "role": "user",
      "timezone": "Europe/Paris",
      "createdOn": "2024-06-15T14:30:00.000Z",
      "modifiedOn": "2024-06-15T15:00:00.000Z",
      "hasLicense": true
    }
  ],
  "pagination": {
    "page": 1,
    "size": 25,
    "total": 100
  }
}

Changes

  • cd38cb80cde1Revision changes
    • info

      added the new optional query request parameter has_license

    • info

      added the required property // to the response with the status