Skip to content

Getting Started

Base URL

https://findmyclient.org/api

Search Endpoint

POST / GET /search

Submit a new search request.

POST Request

{
  "query": "singapore cafe"
}

GET Request

/api/search?query=singapore+cafe

Response

{
  "status": "processing",
  "job_id": "60a414d4-776b-4480-b6e1-ce541439cd51"
}
Field Type Description
status string Current processing state
job_id string Unique identifier for the search job

Result Endpoint

GET /result/<job_id>

Retrieve the current status and results of a search job.

Example

/api/result/60a414d4-776b-4480-b6e1-ce541439cd51

Processing Response

Returned while the job is still running.

{
  "status": "processing",
  "result": null
}

Completed Response

Returned once the search has completed successfully.

{
  "status": "completed",
  "result": {
    "query": "singapore cafe",
    "total_websites": 10,
    "total_emails_found": 3,
    "emails": [
      "contact@pscafe.com"
    ]
  }
}