List users in your addressbook (paginated)
Request
GET https://api.digital-nautic.com/v3/users
Query parameters
| Parameter name | Value | Description | Additional |
|---|---|---|---|
| id | integer | filter results by user id |
|
| name | string | filter results by user name (filters on both firstName and lastName) |
|
| organizationType | string | filter results by user organization type (accepted values are INDIVIDUAL, SOCIETY or ASSOCIATION) |
|
| string | filter results by user email |
||
| deactivated | boolean | set to "true" to only return deactivated users |
|
| page | integer | which page to display |
|
| perPage | integer | number of results, integer between 1 and 100 |
Response
The following HTTP status codes may be returned, optionally with a response resource.
| Status code | Description | Resource |
|---|---|---|
| 200 | OK the filtered user list |
User[] |
| 400 | Bad Request bad input parameter |
|
| 401 | Unauthorized authorization information is missing or invalid. |