Booking List

GET /booking/list

This API is to get bookings. This is an authendicated API so we need to pass bearer token in request header to access the data.

Headers

Accept string Required

application/json
Content-Type string Required

application/json

Query parameters

start_date string Required

The planned day to get report from
end_date string Required

The planned day to get report till
region number

Id of region to filter booking
business_unit number

Id of business unit to filter booking
shift string

Shift name to filter booking

Values are Day or Night.
candidate string

Id of candidate to filter booking
jobs string

Array of job ids to filter booking
status boolean

pass 0 for Unpublished and 1 for published
deleted boolean

pass 1 to get deleted bookings

Default value is 0.
delete_type boolean

pass 0 to deleted only shift or 1 to Deleted and moved to open shift
per_page number

Minimum value is 1 and maximum value is 100

Responses

200 application/json

OK
Hide response attributes Show response attributes object
- status string
- data object
  
  Hide data attributes Show data attributes object
  
  current_page integer
  
  data array[object]
  
  Hide data attributes Show data attributes object
  
  candidate_name string
  
  business_unit_name string
  
  business_unit_email string
  
  bookings_email string
  
  client string
  
  candidate_email string
  
  id number
  
  code string
  
  vacancy_id number
  
  candidate_id number
  
  status string
  
  notes string
  
  vacancy_note string
  
  is_publish boolean
  
  is_deleted boolean
  
  is_confirm boolean
  
  reason_to_delete string
  
  created_by string
  
  break string
  
  job_title string
  
  job_color string
  
  booked_by string
  
  deleted_by string
  
  is_moved_to_vacancies boolean
  
  start_time string
  
  end_time string
  
  on_date string
  
  deleted_at string
  
  created_at string
  
  total_hours string
  
  first_page_url string
  
  from integer
  
  last_page integer
  
  last_page_url string
  
  next_page_url string
  
  path string
  
  per_page integer
  
  prev_page_url string
  
  to integer
  
  total integer
- message string

GET /booking/list

curl \
 -X GET https://api-console.logezy.co/v1/booking/list?start_date=string&end_date=string \
 -H "Accept: Bearer your-access-token" \
 -H "Content-Type: application/json"

Response examples (200)

{
  "status": "success",
  "data": {
    "current_page": 1,
    "data": [
      {
        "candidate_name": "Abey K",
        "business_unit_name": "24 Care Unit 1",
        "business_unit_email": "raveek02+24careunit1@gmail.com",
        "bookings_email": null,
        "client": "24 Care",
        "candidate_email": "sruthi+9@logezy.co.uk",
        "id": 2185,
        "code": "BKIN2185",
        "vacancy_id": 3133,
        "candidate_id": 120,
        "status": "pending",
        "notes": null,
        "vacancy_note": null,
        "is_publish": 1,
        "is_deleted": 0,
        "is_confirm": 0,
        "reason_to_delete": null,
        "created_by": 4186,
        "break": 60,
        "job_title": "Nurse",
        "job_color": "#0EB995",
        "booked_by": "Khushali",
        "deleted_by": null,
        "is_moved_to_vacancies": 0,
        "start_time": "08:00 AM",
        "end_time": "08:00 PM",
        "on_date": "12-12-2022",
        "deleted_at": null,
        "created_at": "14-12-2022 07:18 AM",
        "total_hours": "11.00",
        "region_names": "London,Glasgow"
      }
    ],
    "first_page_url": "http://api-console.localhost:8000/v1/booking/list?page=1",
    "from": 1,
    "last_page": 1,
    "last_page_url": "http://api-console.localhost:8000/v1/booking/list?page=1",
    "next_page_url": null,
    "path": "http://api-console.localhost:8000/v1/booking/list",
    "per_page": "10",
    "prev_page_url": null,
    "to": 5,
    "total": 5
  },
  "message": "Bookings retrieved successfully."
}