一覧 - Nitte 人材紹介 API

調整の一覧を取得します。複数のプロパティを指定した場合は、AND条件で絞り込まれます。

Requestパラメータ

Authorization

Headerにパラメータ

Authorization

を追加し、その値にはBearerの後にTokenを連結します

例：

Authorization: Bearer ********************

Pathパラメータ

teamId

string

必須

Queryパラメータ

ids

array[string]

可選

日程調整のIDの配列。カンマ区切り

サンプル値:

["0a4792db,0c3a8283,3706a08c"]

name

string

可選

管理名

サンプル値:

一次面接

status

enum<string>

可選

調整のステータス(wip/confirmed/canceled)のいずれか

列挙型:

wipconfirmedcanceled

サンプル値:

wip

clientId

string

可選

企業担当者のID

サンプル値:

058d3f7e

candidateId

string

可選

求職者のID

サンプル値:

17bc2d30

hasError

boolean

可選

エラーの調整か(true/false)

サンプル値:

true

page

number

可選

ページ

デフォルト値:

サンプル値:

hitsPerPage

number

可選

ページあたりのレコード数

デフォルト値:

サンプル値:

サンプルコード

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Response

🟢200成功

application/json

Body

bookings

array[object (日程調整) {19}]

必須

調整一覧

string <uuid>

必須

name

string

必須

名前

lengthMin

number

必須

所要時間

client

object (企業担当者)

必須

企業担当者のID

candidate

object (求職者)

必須

求職者のID

proposablePeriods

array[object (時間帯) {2}]

可選

候補日時として選択できる時間帯。proposedPeriodsとの併用は不可。

proposableWeeklyAvailableTimes

必須

place

string | null

必須

場所

placeInfo

enum<string>

可選

場所の事前情報(online/offline)

列挙型:

offlineonline

information

string | null

必須

連絡事項

deadline

string <date-time>

可選

期日。ISO8601

array[string]

必須

cc通知対象ユーザーのメールアドレス

status

enum<string>

必須

調整ステータス

列挙型:

startedproposedselectedconfirmedcanceled

proposedPeriods

array[object (時間帯) {2}] | null

必須

候補日時

selectedPeriod

必須

希望日時

approvedPeriod

必須

確定した日時

links

object

必須

URL

createdAt

string <date-time>

必須

作成日時

metadata

object

可選

メタデータ

page

number

必須

ページ

htisPerPage

number

必須

ページあたりのレコード数

numberHits

number

必須

全体のレコード数

例

{
  "bookings": [
    {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "name": "string",
      "lengthMin": 0,
      "client": {
        "id": "c1be87a5-d8ff-4338-a60a-ad8792b99ee6",
        "email": "nitte@exmaple.com",
        "publicName": "Nitte株式会社",
        "privateName": "client-12345",
        "tel": "08012341234",
        "lineUserId": "string",
        "blockedPeriods": [
          {
            "start": "2019-08-24T14:15:22Z",
            "end": "2019-08-24T14:15:22Z"
          }
        ],
        "preProposedPeriods": [
          {
            "start": "2019-08-24T14:15:22Z",
            "end": "2019-08-24T14:15:22Z"
          }
        ]
      },
      "candidate": {
        "id": "c1be87a5-d8ff-4338-a60a-ad8792b99ee6",
        "email": "nitte@exmaple.com",
        "publicName": "Nitte株式会社",
        "privateName": "client-12345",
        "tel": "08012341234",
        "lineUserId": "string",
        "blockedPeriods": [
          {
            "start": "2019-08-24T14:15:22Z",
            "end": "2019-08-24T14:15:22Z"
          }
        ],
        "preProposedPeriods": [
          {
            "start": "2019-08-24T14:15:22Z",
            "end": "2019-08-24T14:15:22Z"
          }
        ]
      },
      "proposablePeriods": [
        {
          "start": "2019-08-24T14:15:22Z",
          "end": "2019-08-24T14:15:22Z"
        }
      ],
      "proposableWeeklyAvailableTimes": {
        "mon": {
          "available": true,
          "times": [
            {
              "startTime": {
                "hour": 0,
                "min": 0
              },
              "endTime": {
                "hour": 0,
                "min": 0
              }
            }
          ]
        },
        "tue": {
          "available": true,
          "times": [
            {
              "startTime": {
                "hour": 0,
                "min": 0
              },
              "endTime": {
                "hour": 0,
                "min": 0
              }
            }
          ]
        },
        "wed": {
          "available": true,
          "times": [
            {
              "startTime": {
                "hour": 0,
                "min": 0
              },
              "endTime": {
                "hour": 0,
                "min": 0
              }
            }
          ]
        },
        "thu": {
          "available": true,
          "times": [
            {
              "startTime": {
                "hour": 0,
                "min": 0
              },
              "endTime": {
                "hour": 0,
                "min": 0
              }
            }
          ]
        },
        "fri": {
          "available": true,
          "times": [
            {
              "startTime": {
                "hour": 0,
                "min": 0
              },
              "endTime": {
                "hour": 0,
                "min": 0
              }
            }
          ]
        },
        "sat": {
          "available": true,
          "times": [
            {
              "startTime": {
                "hour": 0,
                "min": 0
              },
              "endTime": {
                "hour": 0,
                "min": 0
              }
            }
          ]
        },
        "sun": {
          "available": true,
          "times": [
            {
              "startTime": {
                "hour": 0,
                "min": 0
              },
              "endTime": {
                "hour": 0,
                "min": 0
              }
            }
          ]
        },
        "hol": {
          "available": true,
          "times": [
            {
              "startTime": {
                "hour": 0,
                "min": 0
              },
              "endTime": {
                "hour": 0,
                "min": 0
              }
            }
          ]
        }
      },
      "place": "string",
      "placeInfo": "offline",
      "information": "string",
      "deadline": "2019-08-24T14:15:22Z",
      "cc": [
        "string"
      ],
      "status": "started",
      "proposedPeriods": [
        {
          "start": "2019-08-24T14:15:22Z",
          "end": "2019-08-24T14:15:22Z"
        }
      ],
      "selectedPeriod": {
        "start": "2019-08-24T14:15:22Z",
        "end": "2019-08-24T14:15:22Z"
      },
      "approvedPeriod": {
        "start": "2019-08-24T14:15:22Z",
        "end": "2019-08-24T14:15:22Z"
      },
      "links": {
        "candidateBookingUrl": "string",
        "clientBookingUrl": "string",
        "detailUrl": "string"
      },
      "createdAt": "2019-08-24T14:15:22Z",
      "metadata": {}
    }
  ],
  "page": 0,
  "htisPerPage": 0,
  "numberHits": 0
}

🟠401Unauthorized

🟠404NotFound

🟠422Unprocessable Entity

🔴500InternalServerError