Search companies

Search for impact data

POST /v2/impact/search

Search companies

cURL

curl --request POST \
  --url https://rest.forestreet.com/v2/impact/search \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "keyword": "<string>",
  "location": "<string>",
  "page": 50.5,
  "perPage": 55,
  "filters": {
    "certifications": [
      "<string>"
    ],
    "naicsCodes": [
      {
        "value": "<string>",
        "label": "<string>"
      }
    ],
    "companyKeyword": "<string>"
  },
  "sort": {}
}
'

200

{
  "data": [
    {
      "location": {
        "state": {
          "type": "<string>",
          "name": "<string>",
          "code": "<string>",
          "country": "<string>"
        },
        "country": {
          "type": "<string>",
          "name": "<string>",
          "code": "<string>"
        }
      },
      "nameOfFirm": "<string>",
      "description": "<string>",
      "keywords": [
        "<string>"
      ],
      "certifications": [
        "<string>"
      ],
      "unverifiedCertifications": [
        "<string>"
      ],
      "city": "<string>",
      "domain": "<string>",
      "url": "<string>",
      "naicsCodes": [
        123
      ],
      "naicsDescriptions": [
        "<string>"
      ],
      "revenue": {
        "actual": {
          "value": 123,
          "currency": "<string>"
        },
        "id": 123,
        "label": "<string>"
      },
      "size": {
        "id": 123,
        "label": "<string>",
        "actual": 123
      },
      "score": 123,
      "revenueDelta": 123,
      "sizeDelta": 123
    }
  ],
  "meta": {
    "totalItems": 123,
    "currentPage": 123,
    "totalPages": 123,
    "itemsPerPage": 123
  }
}

Authorizations

apiKeyAuthbearerAuthsessionIdQuery

x-api-key · string · header · required

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

Body

application/json

searchType · enum<string> · required

Type of search to perform: keyword-based or domain-based.

Available options: keywordSearch, domainSearch

keyword · string · required

Keyword or domain name to search for.

Minimum string length: 1

location · string

Optional location filter to refine search results.

page · number

Page number for paginated search results (1–100).

Required range: 1 <= x <= 100

perPage · number

Number of items per page (10–100).

Required range: 10 <= x <= 100

filters · object

Optional filters applied to the search.

Show child attributes

sort · object

Optional sorting parameters.

Show child attributes

Response

200

application/json

Search impact data response

data · object[] · required

List of companies returned by the search.

Show child attributes

meta · object · required

Pagination metadata for the search results.

Show child attributes