Skip to content

Fetch User by ID

GET https://api.prosperworks.com/developer_api/v1/users/{{example_user_id}}

This endpoint returns details about a specific user within a company.

Response body

The response is a JSON object with the following structure:

Field Type Details
id number The User's unique identifier.
name string The User's full name.
email string The User's email address.
groups list A list of teams (previously known as "Groups") that the User belongs to. Each one has the following fields:
  • id: A unique identifier for the Team.
  • name: The name of the Team.

Example

1
2
3
4
5
curl --location --request GET "https://api.prosperworks.com/developer_api/v1/users/{{example_user_id}}" \
  --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"
1
2
3
4
5
6
7
8
9
{
  "id": 159258,
  "name": "Demo User",
  "email": "demouser@example.com",
  "groups": [{
    "id": 1,
    "name": "Sales"
  }]
}