Find leads by title, location, industry and company size (3 credits per lead added)

POSTRequest

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

Responses

202400401403409429503

Response 202

Success

application/json

Example responseGenerated from schema

{
  "id": 0,
  "listId": 0,
  "status": "running",
  "found": -9007199254740991,
  "target": -9007199254740991,
  "error": "error",
  "creditsUsed": 0,
  "createdAt": "createdAt"
}

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

• titlestringoptional

  Job title, for example Head of Marketing

• locationstringoptional

  Country, region or city

• industrystringoptional

  Industry, for example Software Development

• companySizestringoptional

  Employee range, for example 11-50 or 201-500

• keywordsstringoptional

  Extra words to match

• maxResultsnumberrequired

  Leads to add. Each added lead costs 3 credits.

• listIdnumberoptional

  Add to this list instead of a new one

• listNamestringoptional

  Name of the new list

Returns

Schema shown for 202 · application/json

• idnumber
• listIdone of 2 variants

  null once the list was deleted

  Show 2 variants

  • number
• statusstring
  Allowed values: running, queued, finished, canceled, failed
• foundnumber
• targetnumber
• errorstring
• creditsUsednumber
• createdAtstring