Use this collection to retrieve a list of Users

Arguments

filter
optional

This list can be filtered by the following properties: coming soon

Returns

Returns a list with a data property that contains an array of connections. Each entry in the array is a separate object. If no data is returned, the resulting array will be empty. Otherwise, this call returns an error in the event of a failure.

GET /users
GET users HTTP/1.1
Authorization: Bearer YOUR_ACCESS_TOKEN
HTTP/1.1 200 OK
Content-Type: application/json

{
  "type": "list",
  "size": 431,
  "data": [
    {
      "type": "user",
      "id": "9ac25c19",
      "email": "[email protected]",
      "mobile": "",
      "createdTime": "2021-05-25T06:29:44Z",
      "links": {
        "self": "https://au-api.basiq.io/users/9ac25c19"
      }
    },
    {
      "type": "user",
      "id": "63e0025d5",
      "firstName": "Dinesh",
      "lastName": "Chugtai",
      "email": "[email protected]",
      "mobile": "+61555444776",
      "createdTime": "2021-01-19T01:42:30Z",
      "links": {
        "self": "https://au-api.basiq.io/users/63e0025d5"
      }
    }
  ],
  "links": {
    "self": "https://au-api.basiq.io/users"
  }
}