Look up one buying signal: hiring, funding, tech stack, news, headcount or a job change. Charges credits only on a hit

POSTRequest

curl -X POST "https://prestigious-goldfish-661.convex.site/v1/signals" \
    -H "Authorization: Bearer $REACHIZ_API_KEY" \
    -H "Content-Type: application/json" \
    -d '{"kind":"hiring"}'

Responses

200400401403409429503

Response 200

Success

application/json

Example responseGenerated from schema

{
  "signal": "hiring",
  "found": true,
  "credits": -9007199254740991,
  "data": {}
}

Response 400

The request is not valid. error.fields lists each problem.

application/json

Example responseGenerated from schema

{
  "error": {
    "code": "invalid_request",
    "message": "message",
    "requestId": "requestId",
    "recovery": "recovery",
    "fields": [
      {
        "path": "path",
        "message": "message"
      }
    ]
  }
}

Response 401

The API key is missing or not valid.

application/json

Example responseGenerated from schema

{
  "error": {
    "code": "invalid_request",
    "message": "message",
    "requestId": "requestId",
    "recovery": "recovery",
    "fields": [
      {
        "path": "path",
        "message": "message"
      }
    ]
  }
}

Response 403

The key lacks the scope this route needs.

application/json

Example responseGenerated from schema

{
  "error": {
    "code": "invalid_request",
    "message": "message",
    "requestId": "requestId",
    "recovery": "recovery",
    "fields": [
      {
        "path": "path",
        "message": "message"
      }
    ]
  }
}

Response 409

The Idempotency-Key belongs to a different request, or the state does not allow this action.

application/json

Example responseGenerated from schema

{
  "error": {
    "code": "invalid_request",
    "message": "message",
    "requestId": "requestId",
    "recovery": "recovery",
    "fields": [
      {
        "path": "path",
        "message": "message"
      }
    ]
  }
}

Response 429

Too many requests.

application/json

Example responseGenerated from schema

{
  "error": {
    "code": "invalid_request",
    "message": "message",
    "requestId": "requestId",
    "recovery": "recovery",
    "fields": [
      {
        "path": "path",
        "message": "message"
      }
    ]
  }
}

Response 503

The service is busy. Retry with backoff.

application/json

Example responseGenerated from schema

{
  "error": {
    "code": "invalid_request",
    "message": "message",
    "requestId": "requestId",
    "recovery": "recovery",
    "fields": [
      {
        "path": "path",
        "message": "message"
      }
    ]
  }
}

Request body

Required

Yes

Content type

• application/json

• kindstringrequired
  Allowed values: hiring, funding, techStack, news, headcount, jobChange

  Which signal: hiring (open job postings at a company, 2 credits); funding (a company’s funding rounds, 2 credits); techStack (technologies a company’s website uses, 2 credits); news (recent news about a company, 2 credits); headcount (headcount by department and its monthly history, 6 credits); jobChange (whether a person changed employer or role, 3 credits)

• domainstringoptional

  Company website domain, like acme.com. Every signal but jobChange needs it

• fullNamestringoptional

  jobChange: the person’s full name

• companyNamestringoptional

  jobChange: the company you last knew them at

• jobTitlestringoptional

  jobChange: the title you last knew, optional

Returns

Schema shown for 200 · application/json

• signalstring
  Allowed values: hiring, funding, techStack, news, headcount, jobChange
• foundboolean
• creditsnumber

  Credits charged: the signal’s price on a hit, 0 on a miss

• dataone of 2 variants
  Show 2 variants

  • object