v1

latestOpenAPI 3.0.32026-08-061810496.7 KB

Users of organization

List users

get/api/1/org/users

Query parameters

filters[roles]string[]

Filters users by their role.

[
  "admin"
]

sortstring nullable

Sorts the result by the attribute. Defaults to name alphabetically.

Example:!created_at

Sorts the result by the attribute. Defaults to name alphabetically.

Response

Example response

{
  "users": [
    {
      "ID": 28147,
      "@type": "User",
      "Title": null,
      "Name": "Jaqueline Schoen",
      "FirstName": "Jaqueline",
      "LastName": "Schoen",
      "Avatar": "https://alex-macbook.tail9fea4c.ts.net/images/avatar_male.png",
      "Email": "garrison49@example.org",
      "Scope": "external",
      "HasContact": false,
      "business": {
        "Name": "Goldner-Aufderhar",
        "Modules": 1,
        "LogoLight": null,
        "LogoDark": null,
        "Logo": null,
        "@type": "Business",
        "PasswordPolicy": {
          "min": 8,
          "mixedCase": true,
          "symbols": false,
          "uncompromised": false,
          "strength": 0
        }
      },
      "Role": "admin",
      "MFA": false,
      "created_at": "2026-06-29T18:54:47.000000Z",
      "Locale": "fr_CA",
      "Locked": false
    },
    {
      "ID": 28148,
      "@type": "User",
      "Title": null,
      "Name": "Beau Oberbrunner",
      "FirstName": "Beau",
      "LastName": "Oberbrunner",
      "Avatar": "https://alex-macbook.tail9fea4c.ts.net/images/avatar_male.png",
      "Email": "maximillian39@example.org",
      "Scope": "external",
      "HasContact": false,
      "business": {
        "Name": "Quitzon Inc",
        "Modules": 1,
        "LogoLight": null,
        "LogoDark": null,
        "Logo": null,
        "@type": "Business",
        "PasswordPolicy": {
          "min": 8,
          "mixedCase": true,
          "symbols": false,
          "uncompromised": false,
          "strength": 0
        }
      },
      "Role": "admin",
      "MFA": false,
      "created_at": "2026-06-29T18:54:47.000000Z",
      "Locale": "en_US",
      "Locked": false
    }
  ],
  "quota": {
    "price_per_user": 7,
    "total_user_used": 2,
    "total_user_available": 3
  }
}