목적

이 API는 특정 예약 폼에 등록된 예약 내역을 등록일 기준 최신순으로 조회합니다.

limit과 page를 사용하여 예약 내역을 페이지 단위로 조회할 수 있습니다.

URL

<https://api.sidetalk.ai/v1/reservations>

HTTP 메서드

GET

헤더

헤더 값 설명
Authorization Bearer <api_key> 사이드톡 대시보드의 설정 메뉴에서 발급한 API KEY를 사용합니다.

파라미터(Query String)

파라미터 타입 필수 설명
reservationsId String 예 조회할 예약 폼의 고유 ID입니다.
limit Number 아니요 한 페이지에서 조회할 예약 개수입니다. 기본값은 50입니다.
page Number 아니요 조회할 페이지 번호입니다. 기본값은 1입니다.

요청 예시

최신 예약 10개 조회

curl -X GET \
  "<https://api.sidetalk.ai/v1/reservations?reservationsId=${RESERVATIONS_ID}&limit=10&page=1>" \
  -H "Authorization: Bearer ${API_KEY}"

두 번째 페이지 조회

curl -X GET \
  "<https://api.sidetalk.ai/v1/reservations?reservationsId=${RESERVATIONS_ID}&limit=10&page=2>" \
  -H "Authorization: Bearer ${API_KEY}"

기본값으로 조회

limit과 page를 생략하면 첫 번째 페이지의 예약 내역을 20개 조회합니다.

curl -X GET \
  "<https://api.sidetalk.ai/v1/reservations?reservationsId=${RESERVATIONS_ID}>" \
  -H "Authorization: Bearer ${API_KEY}"