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>"
    }
  ]
}

POST

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. The collection ID to which the new dossier belongs.

Body

application/json

filters

object

Optional filters to apply to the dossiers.

Show child attributes

filters.agentIds

string<uuid>[]

Filter agents by the agent's unique identifier.

filters.agentTypes

enum<string>[]

Filter agents by their type, e.g., 'supplierDossier'.

Type of agent, e.g., 'supplierDossier'

Available options:

supplierDossier,

marketInsight

filters.query

string

Filter agents by substring match on the original query.

filters.createdBy

string<uuid>[]

Filter agents by the unique identifier of the user who created them.

sort

object[]

Optional sorting criteria for the dossiers.

Show child attributes

sort.field

enum<string>

required

Fields to sort agents by.

Available options:

createdAt,

lastModified

sort.order

enum<string>

required

Sort order according to the specified field.

Available options:

asc,

desc

Response

Dossiers retrieved successfully

metadata

object

required

Show child attributes

metadata.pagination

object

required

Schema for pagination metadata, including total items, total pages, current page, and page size.

Show child attributes

metadata.pagination.totalItems

number

required

Total number of items across all pages.

metadata.pagination.totalPages

number

required

Total number of pages.

metadata.pagination.currentPage

number

required

Current page number.

metadata.pagination.pageSize

number

required

Number of items per page.

metadata.filters

object

required

Show child attributes

metadata.filters.agentIds

string<uuid>[]

Filter agents by the agent's unique identifier.

metadata.filters.agentTypes

enum<string>[]

Filter agents by their type, e.g., 'supplierDossier'.

Type of agent, e.g., 'supplierDossier'

Available options:

supplierDossier,

marketInsight

metadata.filters.query

string

Filter agents by substring match on the original query.

metadata.filters.createdBy

string<uuid>[]

Filter agents by the unique identifier of the user who created them.

metadata.sort

object[]

required

Sorting criteria for the agents.

Show child attributes

metadata.sort.field

enum<string>

required

Fields to sort agents by.

Available options:

createdAt,

lastModified

metadata.sort.order

enum<string>

required

Sort order according to the specified field.

Available options:

asc,

desc

data

object[]

required

List of agents associated with the collection.

Show child attributes

data.agentId

string

required

Unique identifier for the agent

data.query

string

required

Original query used to create the agent

data.agentType

enum<string>

required

Type of agent, e.g., 'supplierDossier'

Available options:

supplierDossier,

marketInsight

data.createdBy

string<uuid>

required

User ID of the creator of this agent

data.lastModifiedAt

string | null

required

Timestamp when the agent was last modified

data.lastTaskId

string<uuid>

required

ID of the last task associated with this agent

data.lastTaskStatus

object

required

Status of the last task associated with this agent

Show child attributes

data.lastTaskStatus.taskId

string<uuid>

required

Unique identifier for the task

data.lastTaskStatus.createdAt

string | null

required

Timestamp when the task was created

data.lastTaskStatus.status

enum<string>

required

Current status of the task, indicating its progress

Available options:

CREATED,

INITIALIZING,

ACQUIRING_TARGET,

GATHERING_RESOURCES,

GATHERING_INSIGHTS,

FINDING_COMPETITORS,

FINALIZING,

COMPLETED,

FAILED

data.lastTaskStatus.lastReportedAt

string | null

required

Timestamp of the last status update for the task

data.lastTaskStatus.lastReportedBy

string | null

required

Hostname of the worker that last reported the status

data.lastTaskStatus.agentId

string

Unique identifier for the agent associated with this task

data.lastTaskStatus.success

boolean | null

Indicates whether the task was successful; if null, the task is still in progress

data.createdAt

string | null

Timestamp when the agent was created

Get a dossier Update a dossier

⌘I

Quick Start

Guides

API Reference

UI Components

Get dossiers in collection

Authorizations

Path Parameters

Body

Response