Get Entities - The Search Company API

Getting Started

Website

Onboarding

Cron

Your Current Setup

Explore

Settings - Toggle

Settings - Business

Settings - Team

Settings - Billing

Settings - Domain

Webhooks

Health

Manual Trigger

curl "https://searchcompany-main.up.railway.app/api/cron/entities?business_id=nike&type=business"

{
  "entities": [
    {
      "business_id": "nike",
      "product_id": null,
      "source_url": "https://nike.com",
      "deployment_url": "https://nike-com.searchcompany.dev"
    },
    {
      "business_id": "nike",
      "product_id": "air-max-90",
      "source_url": "https://nike.com/air-max-90",
      "deployment_url": "https://nike-com-air-max-90.searchcompany.dev"
    }
  ]
}

GET

api

cron

entities

curl "https://searchcompany-main.up.railway.app/api/cron/entities?business_id=nike&type=business"

{
  "entities": [
    {
      "business_id": "nike",
      "product_id": null,
      "source_url": "https://nike.com",
      "deployment_url": "https://nike-com.searchcompany.dev"
    },
    {
      "business_id": "nike",
      "product_id": "air-max-90",
      "source_url": "https://nike.com/air-max-90",
      "deployment_url": "https://nike-com-air-max-90.searchcompany.dev"
    }
  ]
}

Internal endpoint for the Cron service to get entities (businesses and products) for batch processing.

Query Parameters

string

Filter by specific business slug. If omitted, returns all businesses.

string

Filter by entity type: - "business" - Only businesses (no product_id) - "product" - Only products (has product_id) - Omit for all entities

Response

array

Array of entity objects with business_id, product_id (null for businesses), source_url, deployment_url

curl "https://searchcompany-main.up.railway.app/api/cron/entities?business_id=nike&type=business"

{
  "entities": [
    {
      "business_id": "nike",
      "product_id": null,
      "source_url": "https://nike.com",
      "deployment_url": "https://nike-com.searchcompany.dev"
    },
    {
      "business_id": "nike",
      "product_id": "air-max-90",
      "source_url": "https://nike.com/air-max-90",
      "deployment_url": "https://nike-com-air-max-90.searchcompany.dev"
    }
  ]
}

Example Queries

Use Case	URL
All entities	`/api/cron/entities`
Single business	`/api/cron/entities?business_id=nike`
All businesses (no products)	`/api/cron/entities?type=business`
All products only	`/api/cron/entities?type=product`
Products for one business	`/api/cron/entities?business_id=nike&type=product`

​Query Parameters

​Response

​Example Queries

Query Parameters

Response

Example Queries