--- title: "Get scenario bookings" method: GET path: "/api/v2/scenario_bookings" tags: ["Scenario Bookings"] --- # Get scenario bookings `GET /api/v2/scenario_bookings` ## Request - Base URL: `https://developer.productive.io` (the document declares no server; this is the origin it was published from) - URL: `https://developer.productive.io/api/v2/scenario_bookings` - Auth: none declared List scenario bookings with optional filters. Returns paginated scenario booking records the caller has access to. ## Query parameters - `filter` union: Filter schema for `scenario_booking` list endpoints — pass a single condition or a logical group. - object: A logical filter group — combine multiple conditions with the `$op` operator. - `$op` 'or' | 'and', required: Logical operator combining conditions in this group. `or` matches records satisfying any condition; `and` requires all conditions to match. - FilterScenarioBooking: Filter parameters for narrowing scenario booking list results. - `after` union: Filter to bookings ending on or after this date. - object: Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`. - `eq` After (unresolved $ref) - After (unresolved $ref) - `before` union: Filter to bookings starting on or before this date. - object: Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`. - `eq` Before (unresolved $ref) - Before (unresolved $ref) - `created_at` union: Filter by creation date. - object: Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`. - `eq` CreatedAt (unresolved $ref) - `not_eq` CreatedAt (unresolved $ref) - `gt` CreatedAt (unresolved $ref) - `lt` CreatedAt (unresolved $ref) - `gt_eq` CreatedAt (unresolved $ref) - `lt_eq` CreatedAt (unresolved $ref) - CreatedAt (unresolved $ref) - `ended_on` union: Filter by end date. - object: Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`. - `eq` EndedOn (unresolved $ref) - `not_eq` EndedOn (unresolved $ref) - `gt` EndedOn (unresolved $ref) - `lt` EndedOn (unresolved $ref) - `gt_eq` EndedOn (unresolved $ref) - `lt_eq` EndedOn (unresolved $ref) - EndedOn (unresolved $ref) - `id` union: Filter by ID. - object: Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`. - `eq` Id (unresolved $ref) - `not_eq` Id (unresolved $ref) - `contains` Id (unresolved $ref) - `not_contain` Id (unresolved $ref) - Id (unresolved $ref) - `last_activity_at` union: Filter by last activity date. - object: Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`. - `eq` LastActivityAt (unresolved $ref) - `not_eq` LastActivityAt (unresolved $ref) - `gt` LastActivityAt (unresolved $ref) - `lt` LastActivityAt (unresolved $ref) - `gt_eq` LastActivityAt (unresolved $ref) - `lt_eq` LastActivityAt (unresolved $ref) - LastActivityAt (unresolved $ref) - `note` union: Filter by note. - object: Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`. - `contains` Note (unresolved $ref) - Note (unresolved $ref) - `person_id` union: Filter by assigned person. - object: Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`. - `eq` PersonId (unresolved $ref) - `not_eq` PersonId (unresolved $ref) - `contains` PersonId (unresolved $ref) - `not_contain` PersonId (unresolved $ref) - PersonId (unresolved $ref) - `scenario_item_id` union: Filter by scenario item. - object: Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`. - `eq` ScenarioItemId (unresolved $ref) - `not_eq` ScenarioItemId (unresolved $ref) - `contains` ScenarioItemId (unresolved $ref) - `not_contain` ScenarioItemId (unresolved $ref) - ScenarioItemId (unresolved $ref) - `started_on` union: Filter by start date. - object: Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`. - `eq` StartedOn (unresolved $ref) - `not_eq` StartedOn (unresolved $ref) - `gt` StartedOn (unresolved $ref) - `lt` StartedOn (unresolved $ref) - `gt_eq` StartedOn (unresolved $ref) - `lt_eq` StartedOn (unresolved $ref) - StartedOn (unresolved $ref) - `updated_at` union: Filter by last update date. - object: Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`. - `eq` UpdatedAt (unresolved $ref) - `not_eq` UpdatedAt (unresolved $ref) - `gt` UpdatedAt (unresolved $ref) - `lt` UpdatedAt (unresolved $ref) - `gt_eq` UpdatedAt (unresolved $ref) - `lt_eq` UpdatedAt (unresolved $ref) - UpdatedAt (unresolved $ref) - `sort` string[] ## Response `200` Collection scenario booking - object: Paginated list of scenario booking records in JSON:API format. - `data` object[]: Array of scenario booking resource objects. - `attributes` object: Scenario booking attributes. - `booking_method_id` BookingMethodId (unresolved $ref) - `created_at` CreatedAt (unresolved $ref) - `custom_fields` CustomFields (unresolved $ref) - `ended_on` EndedOn (unresolved $ref) - `hours` Hours (unresolved $ref) - `last_activity_at` LastActivityAt (unresolved $ref) - `note` Note (unresolved $ref) - `percentage` Percentage (unresolved $ref) - `started_on` StartedOn (unresolved $ref) - `time` Time (unresolved $ref) - `total_time` TotalTime (unresolved $ref) - `total_working_days` TotalWorkingDays (unresolved $ref) - `updated_at` UpdatedAt (unresolved $ref) - `relationships` object: Scenario booking relationships. - `creator` union: A JSON:API single relationship — links to one related resource or `null`. - SingleLinkageNullable - `data` Resource, required: A JSON:API resource identifier object containing the resource type and ID. - `id` string, required: The unique identifier of the resource. - `type` string, required: The resource type name (e.g. `tasks`, `people`, `deals`). - NotIncluded: Placeholder for a relationship that was not sideloaded in this response. - `meta` object, required: Metadata indicating the sideload status of this relationship. - `included` false, required: Whether the related resource was included in the sideloaded data. Always `false` for this variant. - `organization` union: A JSON:API single relationship — links to one related resource or `null`. - SingleLinkageNullable - `data` Resource, required: A JSON:API resource identifier object containing the resource type and ID. - `id` string, required: The unique identifier of the resource. - `type` string, required: The resource type name (e.g. `tasks`, `people`, `deals`). - NotIncluded: Placeholder for a relationship that was not sideloaded in this response. - `meta` object, required: Metadata indicating the sideload status of this relationship. - `included` false, required: Whether the related resource was included in the sideloaded data. Always `false` for this variant. - `scenario_item` union: A JSON:API single relationship — links to one related resource or `null`. - SingleLinkageNullable - `data` Resource, required: A JSON:API resource identifier object containing the resource type and ID. - `id` string, required: The unique identifier of the resource. - `type` string, required: The resource type name (e.g. `tasks`, `people`, `deals`). - NotIncluded: Placeholder for a relationship that was not sideloaded in this response. - `meta` object, required: Metadata indicating the sideload status of this relationship. - `included` false, required: Whether the related resource was included in the sideloaded data. Always `false` for this variant. - `updater` union: A JSON:API single relationship — links to one related resource or `null`. - SingleLinkageNullable - `data` Resource, required: A JSON:API resource identifier object containing the resource type and ID. - `id` string, required: The unique identifier of the resource. - `type` string, required: The resource type name (e.g. `tasks`, `people`, `deals`). - NotIncluded: Placeholder for a relationship that was not sideloaded in this response. - `meta` object, required: Metadata indicating the sideload status of this relationship. - `included` false, required: Whether the related resource was included in the sideloaded data. Always `false` for this variant. - `included` unknown[]: Sideloaded related resources. - unknown - `meta` Meta: Pagination and response metadata returned with every collection endpoint. - `current_page` integer: The current page number in this paginated response (1-based). - `max_page_size` integer: Maximum number of records allowed per page for this endpoint. - `organization_features` object: Feature flags and capabilities enabled for the current organization, used for UI rendering. - `page_size` integer: Number of records returned per page in this response. - `settings` object: Organization or user settings relevant to this resource's display. - `total_count` integer: Total number of records matching the current query across all pages. - `total_pages` integer: Total number of pages available for the current query and page size. ## Other responses - `400`: Bad Request - `401`: Unauthorized - `403`: Forbidden - `408`: Request Timeout - `423`: Locked - `429`: Too Many Requests - `500`: Internal Server Error ## Changes - **2026-11-02** `fa3060fd0144`: 7 info - added the non-success response with the status `400` - added the non-success response with the status `401` - added the non-success response with the status `403` - added the non-success response with the status `408` - …3 more [Operation history](https://skmtc.dev/productive/apis/api-documentation/changes/api/v2/scenario_bookings/get.md) --- [API](https://skmtc.dev/productive/apis/api-documentation.md) - [All operations](https://skmtc.dev/productive/apis/api-documentation/llms.txt) - [OpenAPI document](https://skmtc.dev/productive/apis/api-documentation/revisions/e7bdfdf6cba3?raw)