Sirportly

Toggle Menu

List all users

This method allows you to retrieve a full list of all users configured in your account.

URL

/api/v2/users/all

Supported Parameters

  • page - the page number you wish to view (defaults to 1)

Example JSON

{
  "pagination": {
    "page": 1,
    "offset": 0,
    "per_page": 30,
    "pages": 1,
    "total_records": 6
  },
  "records": [
    {
      "id": 1,
      "username": "adam",
      "first_name": "Adam",
      "last_name": "Cooke",
      "email_address": "adam@atechmedia.com",
      "time_zone": "London",
      "created_at": "2012-03-19T10:35:37+00:00",
      "job_title": "Managing Director",
      "teams": [
        {
          "id": 2,
          "name": "Support"
        },
        {
          "id": 3,
          "name": "Sales"
        },
        {
          "id": 4,
          "name": "Management"
        },
        {
          "id": 5,
          "name": "Accounts"
        }
      ]
    },
    {
      "id": 12,
      "username": "steve",
      "first_name": "Adam",
      "last_name": "Cooke",
      "email_address": "test2@atechmedia.com",
      "time_zone": "UTC",
      "created_at": "2012-03-19T16:18:20+00:00",
      "teams": [

      ]
    },
    {
      "id": 4,
      "username": null,
      "first_name": "Evie",
      "last_name": "Howorth",
      "email_address": "evie@atechmedia.com",
      "time_zone": "UTC",
      "created_at": "2012-03-19T10:35:37+00:00",
      "teams": [
        {
          "id": 3,
          "name": "Sales"
        },
        {
          "id": 5,
          "name": "Accounts"
        }
      ]
    },
    {
      "id": 5,
      "username": null,
      "first_name": "Alex",
      "last_name": "Pearce",
      "email_address": "alex@atechmedia.com",
      "time_zone": "UTC",
      "created_at": "2012-03-19T10:35:38+00:00",
      "teams": [
        {
          "id": 2,
          "name": "Support"
        }
      ]
    },
    {
      "id": 2,
      "username": "charlie",
      "first_name": "Charlie",
      "last_name": "Smurthwaite",
      "email_address": "charlie@atechmedia.com",
      "time_zone": "UTC",
      "created_at": "2012-03-19T10:35:37+00:00",
      "teams": [
        {
          "id": 2,
          "name": "Support"
        },
        {
          "id": 3,
          "name": "Sales"
        },
        {
          "id": 4,
          "name": "Management"
        },
        {
          "id": 5,
          "name": "Accounts"
        }
      ]
    },
    {
      "id": 3,
      "username": "dan",
      "first_name": "Dan",
      "last_name": "Wentworth",
      "email_address": "dan@atechmedia.com",
      "time_zone": "Baghdad",
      "created_at": "2012-03-19T10:35:37+00:00",
      "teams": [
        {
          "id": 2,
          "name": "Support"
        }
      ]
    }
  ]
}