/user/search
The action returns a list of matching active PPW users.
Request
| Field | Description | Type | Required |
|---|---|---|---|
user_email | User’s email address | string | No |
user_name | User name | string | No |
user_company | User company name | string | No |
offset | Search offset | number | No |
Example:
{
"user_name": "vfw"
}
curl -H 'Content-Type: application/json' \
-H 'Authorization: Bearer ACCESS_TOKEN' \
-d '{"user_name": "vfw"}' \
https://ppw.web/svc/user/search
Response
| Field | Description | Type |
|---|---|---|
users | List of users | array |
next | Indicates there are more matching users. | object |
Each item in the users array is an object with the following fields:
| Field | Description | Type |
|---|---|---|
user_id | Unique identifier for a PPW user | number |
user_name | PPW user name | string |
user_email | PPW user email | string |
user_first_name | PPW user’s first name | string |
user_last_name | PPW user’s last name | string |
user_company | PPW user’s company name | string |
user_display_name | PPW user’s display name | string |
The next field is set only when there are more matching users. The
value of next field is an object with the following fields:
| Field | Description | Type |
|---|---|---|
user_email | User’s email address provided as the search parameter | string |
user_name | User’s name provided as the search parameter | string |
user_company | User’s company name provided as the search parameter | string |
offset | Search offset | number |
To get the next chunk of matching users, provide the offset in
next.offset as the offset in the request.
Example successful response:
{
"users": [{
"user_id": 131713,
"user_name": "vfw-sub-7",
"user_email": "mark.roebling@preservation.land",
"user_first_name": "Mary",
"user_last_name": "Roebling",
"user_company": "PPW",
"user_display_name": "Roebling, Mary"
},
{
"user_id": 131712,
"user_name": "vfw-sub-6",
"user_email": "wilma.mankiller@preservation.land",
"user_first_name": "Wilma",
"user_last_name": "Mankiller",
"user_company": "PPW",
"user_display_name": "Mankiller, Wilma"
},
{
"user_id": 131711,
"user_name": "vfw-sub-5",
"user_email": "amelia.boynton@preservation.land",
"user_first_name": "Amelia",
"user_last_name": "Boynton",
"user_company": "PPW",
"user_display_name": "Boynton, Amelia"
},
{
"user_id": 131710,
"user_name": "vfw-sub-4",
"user_email": "eunice.kennedy@preservation.land",
"user_first_name": "Eunice",
"user_last_name": "Kennedy",
"user_company": "PPW",
"user_display_name": "Kennedy, Eunice"
},
{
"user_id": 131709,
"user_name": "vfw-sub-3",
"user_email": "elizabeth.peratrovich@preservation.land",
"user_first_name": "Elizabeth",
"user_last_name": "Peratrovich",
"user_company": "PPW",
"user_display_name": "Peratrovich, Elizabeth"
}
],
"next": {
"user_email": null,
"user_name": "vfw",
"user_company": null,
"offset": 100
}
}
Errors
| Error Type | Description | Status Code |
|---|---|---|
access_denied | Access token is invalid or expired | 401 |
scope_invalid | Client app does not have the required OAuth scope | 403 |