Skip to main content
GET
/
v2
/
collections
/
{collectionId}
/
dossier
/
{agentId}
Get a dossier
curl --request GET \
  --url https://rest.forestreet.com/v2/collections/{collectionId}/dossier/{agentId} \
  --header 'x-api-key: <api-key>'
{
  "metadata": {},
  "data": {}
}

Authorizations

x-api-key
string
header
required

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

Path Parameters

collectionId
number | null
required

ID of the collection containing the dossier agent to be managed.

agentId
string
required

Unique identifier for the dossier agent to be managed.

Response

Dossier retrieved successfully

metadata
object
required

Agent metadata information

data
object
required

Dossier content and results