API docs by Redocly

Acall Public API (v1)

Download OpenAPI specification:Download

ユーザー API

ユーザー 一覧取得

Authorizations:
Bearer
query Parameters
limit
integer

取得件数を指定します

offset
integer

オフセットを指定します

freeword
string

名前、Emailアドレス、検索キー、部署名からあいまい検索します

Responses

Response samples

Content type
application/json
[
  • {
    }
]

ユーザー 詳細取得

Authorizations:
Bearer
path Parameters
user_id
required
string

Responses

Response samples

Content type
application/json
{
  • "user_id": "00000000-0000-0000-0000-0000000000000",
  • "family_name": "山田",
  • "given_name": "太郎",
  • "family_name_phonetic": "やまだ",
  • "given_name_phonetic": "たろう",
  • "email": "yamada@example.com",
  • "tel": "000-0000-0000",
  • "role_names": [
    ],
  • "groups": [
    ]
}

設備 API

設備 一覧取得

Authorizations:
Bearer
query Parameters
limit
integer

取得件数を指定します

offset
integer

オフセットを指定します

freeword
string

設備名と場所からあいまい検索します

Responses

Response samples

Content type
application/json
[
  • {
    }
]

設備 詳細取得

Authorizations:
Bearer
path Parameters
facility_id
required
string

Responses

Response samples

Content type
application/json
{
  • "facility_id": "00000000-0000-0000-0000-0000000000000",
  • "facility_name": "メイン会議室",
  • "location": "神戸本社",
  • "type": "room",
  • "usage": [
    ],
  • "description": "神戸本社で一番広い会議室"
}

イベント API

イベント 一覧取得

Authorizations:
Bearer
query Parameters
limit
integer

取得件数を指定します

offset
integer

オフセットを指定します

freeword
string

イベントのタイトル、説明、アジェンダからあいまい検索します

starting_at
string <date-time>

検索期間の開始日時を指定します

ending_at
string <date-time>

検索期間の終了日時を指定します

Responses

Response samples

Content type
application/json
[
  • {
    }
]

イベント 詳細取得

Authorizations:
Bearer
path Parameters
event_id
required
string

Responses

Response samples

Content type
application/json
{
  • "event_id": "00000000-0000-0000-0000-0000000000000",
  • "title": "打ち合わせ",
  • "guests": [
    ],
  • "starting_at": "2020-03-06T16:10:00+09:00",
  • "ending_at": "2020-03-06T16:40:00+09:00",
  • "attend_users": [
    ],
  • "facilities": [
    ],
  • "note": "打ち合わせのメモ",
  • "agendas": [
    ],
  • "mail_template_id": "00000000-0000-0000-0000-0000000000000",
  • "access_policy": "tenant"
}

ゲート API

ゲートアクセスログ 一覧取得

Authorizations:
Bearer
query Parameters
limit
integer

取得件数を指定します

offset
integer

オフセットを指定します

freeword
string

ゲート名、解錠者名からあいまい検索します

starting_at
string <date-time>

検索期間の開始日時を指定します

ending_at
string <date-time>

検索期間の終了日時を指定します

Responses

Response samples

Content type
application/json
[
  • {
    }
]

スポット API

スポット 一覧取得

Authorizations:
Bearer
query Parameters
limit
integer

取得件数を指定します

offset
integer

オフセットを指定します

root_spot_id
string

spot_idより下の階層のスポット一覧を検索します

Responses

Response samples

Content type
application/json
[
  • {
    }
]

スポット予約 API

スポット予約 一覧取得

Authorizations:
Bearer
query Parameters
limit
integer

取得件数を指定します

offset
integer

オフセットを指定します

root_spot_id
string

spot_idより下の階層のスポット一覧を検索します

starting_at
string <date-time>

検索期間の開始日時を指定します

ending_at
string <date-time>

検索期間の終了日時を指定します

Responses

Response samples

Content type
application/json
[
  • {
    }
]

スポット予約 新規作成

Authorizations:
Bearer
Request Body schema: application/json
spot_id
string
starting_at
string <date-time>
ending_at
string <date-time>
send_mail
boolean
invited_user_ids
Array of strings
title
string
description
string

Responses

Request samples

Content type
application/json
{
  • "spot_id": "00000000-0000-0000-0000-0000000000000",
  • "starting_at": "2021-08-06T16:00:00+09:00",
  • "ending_at": "2021-08-06T17:00:00+09:00",
  • "send_mail": true,
  • "invited_user_ids": [
    ],
  • "title": "〇〇の打ち合わせ",
  • "description": "〇〇について話します"
}

Response samples

Content type
application/json
{
  • "spot_reservation_id": "00000000-0000-0000-0000-0000000000000",
  • "spot_id": "00000000-0000-0000-0000-0000000000000",
  • "starting_at": "2021-08-01T16:10:00+09:00",
  • "ending_at": "2021-08-01T17:10:00+09:00",
  • "invited_users": [
    ],
  • "title": "〇〇の打ち合わせ",
  • "description": "〇〇について話します"
}

スポット予約 削除

Authorizations:
Bearer
path Parameters
spot_reservation_id
required
string
Request Body schema: application/json
send_mail
boolean

Responses

Request samples

Content type
application/json
{
  • "send_mail": true
}

スポット予約 詳細取得

Authorizations:
Bearer
path Parameters
spot_reservation_id
required
string

Responses

Response samples

Content type
application/json
[
  • {
    }
]

スポット予約 更新

Authorizations:
Bearer
path Parameters
spot_reservation_id
required
string
Request Body schema: application/json
starting_at
string <date-time>
ending_at
string <date-time>
send_mail
boolean
invited_user_ids
Array of strings
title
string
description
string

Responses

Request samples

Content type
application/json
{
  • "starting_at": "2021-08-06T16:00:00+09:00",
  • "ending_at": "2021-08-06T17:00:00+09:00",
  • "send_mail": true,
  • "invited_user_ids": [
    ],
  • "title": "予約1",
  • "description": "〇〇について話します"
}

Response samples

Content type
application/json
[
  • {
    }
]