Office Users

Retrieve collection of users with access to the office. Takes in consideration the companies which the user has access and its highest privilege application role.

GET users?fields=settings

Request properties

Property Type Description Optional
fields Array Optional fields to retrieve. Yes

Collection properties

Property Type Description
users Array List of users with access to the office that the user is allowed to see.
_links Array A list of useful preconfigured uri's a client app can use to navigate this resource collection.
_metadata Complex object Optional object with additional information concerning the current returned result.

For details on collections see collection details.

Example response:

{
  "users":[
    {
      "userName": "user01",
      "id": "a9d85b5e-be81-499e-b730-9ee4bf8afca1",
      "roles": [
        "Accountant"
      ],
      "name": "user01",
      "email": "user01@basecone.com",
      "settings" :{
          "canEditBankAccount": false,
          "canViewAllDocumentsArchive": false
        }
    },
    {
      "userName": "user02",
      "id": "45080dfe-316c-4eb0-8c84-676942d792f1",
      "roles": [
        "SuperUser",
        "Accountant"
      ],
      "name": "user02",
      "email": "user02@basecone.com",
      "settings" :{
          "canEditBankAccount": false,
          "canViewAllDocumentsArchive": false
        }
    },
    {
      "userName": "user03",
      "id": "2a237d72-ebef-46ab-91eb-0be2c9517a27",
      "roles": [
        "SMEAccountant"
      ],
      "name": "user03",
      "email": "user03@basecone.com",
      "settings" :{
          "canEditBankAccount": false,
          "canViewAllDocumentsArchive": false
        }
    },
    {
      "userName": "user04",
      "id": "c47e268f-a1fb-4310-a8c8-558628b6bf9d",
      "roles": [
        "ClientUser"
      ],
      "name": "user04",
      "email": "user04@basecone.com",
      "settings" :{
          "canEditBankAccount": false,
          "canViewAllDocumentsArchive": false
        }
    }
  ],
  "metadata": {
    "total": 4,
    "count": 4
  },
  "_links": [
    {
      "rel": "self",
      "href": "http://api.basecone.com/users?limit=20&offset=0"
    }
  ]
}