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",
"createdAt": "<string>",
"lastModifiedAt": "<string>",
"lastTaskId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"lastTaskStatus": {
"taskId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"agentId": "<string>",
"createdAt": "<string>",
"success": true,
"status": "CREATED",
"lastReportedAt": "<string>",
"lastReportedBy": "<string>"
}
}
]
}
Retrieve dossiers associated with a specific collection with optional filtering and pagination
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",
"createdAt": "<string>",
"lastModifiedAt": "<string>",
"lastTaskId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"lastTaskStatus": {
"taskId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"agentId": "<string>",
"createdAt": "<string>",
"success": true,
"status": "CREATED",
"lastReportedAt": "<string>",
"lastReportedBy": "<string>"
}
}
]
}
Pass a static API key for every request, provided by your customer support.
The collection ID to which the new dossier belongs.
Dossiers retrieved successfully
The response is of type object
.