Sign in
Schedules

Lists schedules

Changed on
get/v1/{account_subdomain}/schedules

Request

  • Base URL: http://localhost:3000
  • URL: http://localhost:3000/v1/{account_subdomain}/schedules
  • Auth: HTTP basic

Query parameters

page[number]integer

Page number

page[size]integer

Page size

filter[{attribute}_{predicate}]string

Filter by attribute using Ransack predicates.<br><br>Available attributes:<br>creator_id, name, bop, state, published_at, created_at, updated_at<br><br>Common predicates:<br>eq, not_eq, matches, lt, lteq, gt, gteq, in, not_in, cont, start, end, null, not_null<br><br>Full list of predicates

includestring

Include related resources in the response (JSON:API includes).<br><br>Available relationships:<br>creator, shifts

Response

schedules found

Changes

  • v1bc1e939fe260Revision changes
    • info

      added the new optional query request parameter include

    • info

      added the optional property to the response with the status

  • v1f21d52e73f26Revision changes
    • info

      added the new optional query request parameter filter[{attribute}_{predicate}]