Skip to main content
POST
/
v2
/
collections
/
{collectionId}
/
dossiers
Get dossiers in collection
curl --request POST \
  --url https://rest.forestreet.com/v2/collections/{collectionId}/dossiers \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "filters": {
    "agentIds": [
      "3c90c3cc-0d44-4b50-8888-8dd25736052a"
    ],
    "agentTypes": [
      "supplierDossier"
    ],
    "query": "<string>",
    "createdBy": [
      "3c90c3cc-0d44-4b50-8888-8dd25736052a"
    ]
  },
  "sort": [
    {
      "field": "createdAt",
      "order": "asc"
    }
  ]
}
'
{
  "metadata": {
    "pagination": {
      "totalItems": 123,
      "totalPages": 123,
      "currentPage": 123,
      "pageSize": 123
    },
    "filters": {
      "agentIds": [
        "3c90c3cc-0d44-4b50-8888-8dd25736052a"
      ],
      "agentTypes": [
        "supplierDossier"
      ],
      "query": "<string>",
      "createdBy": [
        "3c90c3cc-0d44-4b50-8888-8dd25736052a"
      ]
    },
    "sort": [
      {
        "field": "createdAt",
        "order": "asc"
      }
    ]
  },
  "data": [
    {
      "agentId": "<string>",
      "query": "<string>",
      "agentType": "supplierDossier",
      "createdBy": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "lastModifiedAt": "<string>",
      "lastTaskId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "lastTaskStatus": {
        "taskId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "createdAt": "<string>",
        "status": "CREATED",
        "lastReportedAt": "<string>",
        "lastReportedBy": "<string>",
        "agentId": "<string>",
        "success": true
      },
      "createdAt": "<string>"
    }
  ]
}

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

The collection ID to which the new dossier belongs.

Body

application/json
​
filters
object

Optional filters to apply to the dossiers.

​
sort
object[]

Optional sorting criteria for the dossiers.

Response

Dossiers retrieved successfully

​
metadata
object
required
​
data
object[]
required

List of agents associated with the collection.