Skip to main content
GET
/
v2
/
teams
/
{teamId}
/
endpoints
Get team export endpoints
curl --request GET \
  --url https://rest.forestreet.com/v2/teams/{teamId}/endpoints \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "filters": {
    "name": "<string>",
    "description": "<string>",
    "url": "<string>",
    "version": 2
  },
  "sortBy": [
    {
      "field": "name",
      "order": "asc"
    }
  ]
}
'
{
  "metadata": {
    "teamId": 1,
    "pagination": {
      "totalItems": 123,
      "totalPages": 13,
      "currentPage": 1,
      "pageSize": 10,
      "unfilteredTotalItems": 196,
      "unfilteredTotalPages": 20
    },
    "filters": {
      "name": "<string>",
      "description": "<string>",
      "url": "<string>",
      "version": 2
    },
    "sortBy": [
      {
        "field": "name",
        "order": "asc"
      }
    ]
  },
  "data": [
    {
      "name": "<string>",
      "description": "<string>",
      "url": "<string>",
      "headers": {},
      "version": 2
    }
  ]
}

Documentation Index

Fetch the complete documentation index at: https://docs.forestreet.com/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
x-api-key
string
header
required

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

Path Parameters

​
teamId
number | null
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 endpoints, used for filtering and sorting endpoints.

​
filters
object
​
sortBy
object[]

Sorting criteria for the endpoints.

Response

Get team endpoints response

​
metadata
object
required
​
data
object[]
required

Array of endpoints associated with the team.