Skip to content

List Users

POST https://api.prosperworks.com/developer_api/v1/users/search

Parameters

You can include the following parameters in a search request.

Field Type Details Default
Required Parameters
--
Optional Parameters
page_number number The page number (starting with 1) that you would like to view. 1
page_size number The number of entries included in a page of results 20

Example

List of Users

1
2
3
4
5
6
7
8
9
curl --location --request POST "https://api.prosperworks.com/developer_api/v1/users/search" \
  --header "X-PW-AccessToken: YOUR_TOKEN_HERE" \
  --header "X-PW-Application: developer_api" \
  --header "X-PW-UserEmail: YOUR_EMAIL_HERE" \
  --header "Content-Type: application/json" \
  --data '{
  "page_number":1,
  "page_size": 200
}'
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
[
  {
    "id": 137658,
    "name": "John Doe",
    "email": "johndoe@copper.com"
  },
  {
    "id": 159258,
    "name": "Jane Smith",
    "email": "janesmith@copper.com"
  }
]