Skip to content

Users (Collection)

Endpoint

Method URL
GET /users

GET /users

Parameter Type Description
page int Result page. Defaults to 1.
pagesize int Max per page. Range [10, 100]. Defaults to 10.
sort string Any user field. Defaults to username.
q string Search string filter.

Returns: The user collection.

Example:

curl -u "username:api_key" -H "Accept: application/json" \
  "https://app.duo.pt/users?page=1&pagesize=10"

Response:

{
  "success": true,
  "data": {
    "pageCount": 1,
    "users": [
      {
        "id": 1,
        "username": "user@example.com",
        "smtp_server": 1,
        "sms_server": 1,
        "parent": 522,
        "limit_contacts": 1000,
        "limit_monthly_emails": 1000,
        "limit_monthly_sms": 1000
      }
    ],
    "success": true,
    "page": 1
  }
}