GET
/
v2
/
user
curl --request GET \
  --url https://api.sonderplan.com/v2/user \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "id": 4,
      "first_name": "Jane",
      "last_name": "Smith",
      "primary_email": "[email protected]",
      "username": "jsmith",
      "group_id": 9223,
      "timezone": "Australia/Sydney",
      "locale": "en_US",
      "date_format": "d/m/Y",
      "time_format": "1",
      "notification": true,
      "expires": 123,
      "schedule_view_mode": 123
    }
  ],
  "meta": {
    "pagination": {
      "total": 1,
      "count": 1,
      "per_page": 1,
      "current_page": 1
    }
  }
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

​
id
string

One or more (comma seperated) IDs of users to retrieve

​
fields
string

Comma seperated list of fields you wish to return

​
page
integer

Specify the page of results you wish to return

​
limit
integer

The number of results returned per page. Default if not specified is 10

​
order_asc
string

Specify the field (with type of string or integer) you wish to order (ascending) the response with

​
order_desc
string

Specify the field (with type of string or integer) you wish to order (descending) the response with

​
filter_operator
enum<string>
default:OR

Specify if multiple filters should be combined with OR or AND logic

Available options:
OR,
AND

Response

200
application/json

Successful Operation

The response is of type object.