Retrieve User List

Request

Query Params

with

enum<string>

optional

object(s) included in the dataset, see eager loading for more info.

Possible options are:

resource

Allowed values:

resourcetime_trackingsettingsboard_views

Example:

resource

limit

integer

optional

Number of maximum records given. More info pagination

Default:

100

offset

integer

optional

Number of records to be skipped. More info pagination

Default:

0

filter

string

optional

Filter the dataset. More info filter

sort

string

optional

Sorting the dataset. More info sorting

show

string

optional

Show only specific properties from the response. More info show & hide

hide

string

optional

Hide properties from the response. More info show & hide

archived

boolean

optional

per default archived objects are not returned, use this parameter to include archived objects.

combine with filter parameter to return only archived results ?archived&filter=archived_at:not:eq:null

Header Params

x-api-key

string

required

Default:

x-api-env

string

required

Default:

Request samples

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

curl --location --request GET 'https://api.vplan.com/v1/user?limit=100&offset=0&filter=&sort=&show=&hide=&archived=' \
--header 'x-api-key;' \
--header 'x-api-env;'

Responses

🟢200Ok

application/json

Body

count

integer <uint64>

optional

Total amount of items

>= 0

Default:

1

limit

integer <uint64>

optional

Max amount of items fetched

>= 0<= 1000

Default:

100

offset

integer <uint64>

optional

Offset so items may be paginated

>= 0

Default:

0

data

array[object (User) {29}]

required

Items

id

string <uuid>

read-onlyrequired

Unique identifier

idp_id

string | null

read-onlyoptional

username

string <email>

optional

status

enum<string>

optional

Allowed values:

invitedactivearchived

invite_id

string | null

optional

resource_id

string <uuid> | null

optional

firstname

string

optional

lastname

string

optional

infix

string | null

optional

fullname

string

read-onlyoptional

gender

enum<string>

optional

Allowed values:

MFU

Default:

U

email

string <email>

optional

mobile

string | null

optional

avatar

string <uri> | null

optional

avatar_checksum

string | null

read-onlyoptional

avatar_signature

string | null

read-onlyoptional

about

string | null

optional

date_of_birth

string <date> | null

optional

role

enum<string>

required

Allowed values:

adminmanagerorganisermemberguest

card_visibility

enum<string>

optional

Allowed values:

alllinked

Default:

all

language

enum<string>

optional

Allowed values:

nldeesfritplpten

Default:

nl

timezone

string

deprecated

notify_own_changes

boolean

optional

mfa_enabled

boolean

optional

nps_counter

integer

read-onlyoptional

external_ref

string | null

read-onlyoptional

Third-party reference of the object, for informational purposes only

Example:

fb1033a2ed70

created_at

string <date-time>

read-onlyrequired

Date and time of creation

Example:

2024-04-11T10:22:15Z

updated_at

string <date-time>

read-onlyrequired

Date and time of last update

Example:

2024-04-11T10:22:15Z

archived_at

string <date-time> | null

read-onlyoptional

Date and time that the object is archived

Example:

2021-07-06T11:24:35Z

Example

{
  "count": 1,
  "limit": 100,
  "offset": 0,
  "data": [
    {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "idp_id": "string",
      "username": "user@example.com",
      "status": "invited",
      "invite_id": "string",
      "resource_id": "4d5215ed-38bb-48ed-879a-fdb9ca58522f",
      "firstname": "string",
      "lastname": "string",
      "infix": "string",
      "fullname": "string",
      "gender": "U",
      "email": "user@example.com",
      "mobile": "string",
      "avatar": "http://example.com",
      "avatar_checksum": "string",
      "avatar_signature": "string",
      "about": "string",
      "date_of_birth": "2019-08-24",
      "role": "admin",
      "card_visibility": "all",
      "language": "nl",
      "timezone": "string",
      "notify_own_changes": true,
      "mfa_enabled": true,
      "nps_counter": 0,
      "external_ref": "fb1033a2ed70",
      "created_at": "2024-04-11T10:22:15Z",
      "updated_at": "2024-04-11T10:22:15Z",
      "archived_at": "2021-07-06T11:24:35Z"
    }
  ]
}

🟠401Not Logged In