企業検索API

POST /corporates/searchで、企業属性と求人条件を組み合わせて企業を検索します。利用前にAPIキーと認証を設定してください。

リクエスト例

東京都、従業員50人以上、Webサイトありの企業を従業員数の多い順に取得します。

curl -s "$SALESBRAIN_API_BASE_URL/corporates/search" \
  -H "X-API-Key: $SALESBRAIN_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "filters": {
      "prefectureId": {"any": [13]},
      "employeeCount": {"min": 50},
      "hasCorporateWebsite": true
    },
    "sort": { "field": "employeeCount", "order": "desc" },
    "limit": 25,
    "offset": 0,
    "includeTotalResults": true
  }'

都道府県や業界のIDは、マスターデータから取得します。

よく使う検索条件

filters 内の異なるフィールドはANDで評価されます。文字列は anyContains / allContains / noneContains、IDは any / none を使います。異なるフィールド同士をORで結ぶ場合は filterGroups を使います。

ページング

• limit: 1回に返す件数。1〜1000、初期値25
• offset: 先頭から読み飛ばす件数。初期値0
• includeTotalResults: 総件数が必要な場合はtrue

最初はlimitを5〜25件にして、検索条件が正しいことを確認してください。

並び替え

sort.fieldに項目名、sort.orderにascまたはdescを指定します。省略時は企業名の昇順です。

"sort": { "field": "employeeDiff6m", "order": "desc" }

拠点数の多い順に並べる場合は、sort.fieldへworkLocationCountを指定します。

"sort": { "field": "workLocationCount", "order": "desc" }

拠点数の意味

workLocationCountは、求人票に書かれた勤務地の住所から推定しています。同じ企業・同じ住所の求人は、何件あっても1拠点です。

たとえば、東京店で10件、大阪店で5件の求人が出ていても、住所が2つならworkLocationCountは2です。

住所が十分に分からない求人や、フルリモート・客先常駐・単発求人などは数えません。そのため、実際の拠点数より少ない場合があります。求人から拠点を見つけられない場合は0を返します。

次の例では、検知できた拠点数が10以上100以下の企業を、拠点数の多い順に取得します。

{
  "filters": {
    "workLocationCount": {"min": 10, "max": 100}
  },
  "sort": {"field": "workLocationCount", "order": "desc"}
}

レスポンス

resultsに企業一覧、totalResultsに総件数が返ります。includeTotalResultsをfalseにした場合、totalResultsはnullです。

結果には法人番号、企業名、所在地、業界、従業員数、拠点数、資本金、連絡先、事業概要などが含まれます。拠点数はworkLocationCountで返ります。値を保有していない項目はnullになる場合があります。

エラー

未定義のフィールドは無視されず400になります。エラーのerrorsにフィールド名と理由が含まれる場合は、その内容を修正してください。

Webアプリと同じ条件を使う

Webアプリの企業検索で条件を設定し、画面上部の「API」を押すと、そのフィルターを使ったcURLを確認できます。

次に読む

• マスターデータ
• 求人検索API