POST
/
v2
/
teams
/
{teamId}
/
users
Get team users
curl --request POST \
  --url https://rest.forestreet.com/v2/teams/{teamId}/users \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '{
  "filters": {
    "id": "<string>",
    "firstName": "<string>",
    "lastName": "<string>",
    "fullName": "<string>",
    "email": "<string>"
  },
  "sortBy": [
    {
      "field": "firstName",
      "order": "asc"
    }
  ]
}'
{
  "metadata": {
    "pagination": {
      "totalItems": 123,
      "totalPages": 123,
      "currentPage": 123,
      "pageSize": 123
    }
  },
  "data": [
    {
      "id": "<string>",
      "firstName": "<string>",
      "lastName": "<string>",
      "fullName": "<string>",
      "email": "<string>"
    }
  ]
}

Authorizations

​
x-api-key
string
header
required

Pass a static API key for every request, provided by your customer support.

Path Parameters

​
teamId
integer
required

ID of the team whose collections are being retrieved.

Required range: x > 0

Query Parameters

​
pageSize
number
default:10

Number of items per page, default is 10, minimum is 1, maximum is 100.

Required range: 1 <= x <= 100
​
page
number
default:1

Current page number, default is 1.

Required range: x >= 1

Body

application/json

Request body schema for getting team users, used for filtering and sorting users.

Response

Get team users response

The response is of type object.