マスターデータAPI

都道府県、業界、求人媒体、職種などは、検索条件に名前ではなくIDまたはコードを指定します。マスターデータAPIで、表示名と識別子の対応を取得してください。

すべてのマスターAPIにX-API-Keyヘッダーが必要です。取得は検索クレジットを消費しません。

エンドポイント

エンドポイント	取得するもの	検索で使う主な項目
`GET /master/prefectures`	都道府県	`filter.company.prefectureId.in`
`GET /master/industries`	業界の大分類・小分類	`filter.company.industry.in/subIn`
`GET /master/media`	求人媒体	`filter.job.mediaId.in`, `filter.company.paidMediaId.in`
`GET /master/job-categories`	職種の大分類・小分類	`filter.job.category.in/subIn`
`GET /master/markets`	市場区分	`filter.company.marketCode.in`
`GET /master/employment-types`	雇用形態	`filter.job.employmentTypeId.in`

取得例

printf 'header = "X-API-Key: %s"\n' "$SALESBRAIN_API_KEY" |
  curl -sS --config - "$SALESBRAIN_API_BASE_URL/master/industries"

業界と職種は、大分類の中にsubCategoriesとして小分類が返ります。

[
  {
    "id": 1,
    "name": "大分類名",
    "subCategories": [
      { "id": 101, "name": "小分類名" }
    ]
  }
]

検索へ指定する

取得したIDを検索リクエストへ指定します。

{
  "filter": {
    "company": {
      "industry": {"in": [1], "subIn": [101]}
    }
  },
  "limit": 25
}

市場区分はidではなくcodeを検索条件へ指定します。雇用形態は filter.job.employmentTypeId.in にIDを指定します。業界・職種の大分類は in、小分類は subIn です。上のIDは構造を示す例のため、実際にはマスターで取得したIDへ置き換えてください。

キャッシュ

マスターは頻繁に変わらないため、レスポンスのCache-Control: max-age=86400に従い、24時間キャッシュできます。リクエストのたびに取得する必要はありません。

マスターデータAPI

エンドポイント

取得例

検索へ指定する

キャッシュ

次に読む