openapi: 3.2.0 info: title: Everbridge Scheduling API version: '1.0' description: 'Operations tagged Scheduling across 2 of this provider''s published API definitions: everbridge-digital-apps-openapi.json, everbridge-eb-suite-openapi.json. Each path carries the servers of the definition it was published in.' servers: - url: https://api.everbridge.net/digitalapps/v2 - url: https://api.everbridge.net/rest - url: https://api.everbridge.eu/rest tags: - name: Scheduling description: Scheduling operations paths: /scheduling/staff-substitutions: post: tags: - Scheduling summary: Create Staff Substitutions description: Create staff substitutions. operationId: ebs-daa-create-staff-substitutions parameters: - name: Client-Id in: header description: Custom app client id required: true schema: type: string example: 3efb35a2-fdee-44bb-b476-2a45cada8b00 - name: Authorization in: header description: Access token required: true schema: type: string example: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiJ1c2VyLXRlc3QiLCJyb2xlIjoiYWRtaW4iLCJpYXQiOjE3MDAwMDAwMDAsImV4cCI6MjAwMDAwMDAwMH0.MEUCIQDRrT_U-WXmq9sdlqZQw4y1GiI4Pp2tJSrKzWSi8vBslgIgQzRSce6h7RkF70ZcQnFX6Zry8FSX8U5CggV2-3OyuVE requestBody: content: application/json: schema: $ref: '#/components/schemas/StaffSubstitutionV2BulkRequest' required: true responses: '200': description: List of added staff substitutions content: application/json: {} security: - API_Authorizer: [] x-amazon-apigateway-integration: httpMethod: post uri: https://mobilemember.everbridge.net/api/v2/scheduling/staff-substitutions responses: default: statusCode: '200' type: http_proxy passthroughBehavior: when_no_match get: tags: - Scheduling summary: Get Staff Substitutions description: Get all staff substitutions operationId: ebs-daa-get-staff-substitutions parameters: - name: Client-Id in: header description: Custom app client id required: true schema: type: string example: 3efb35a2-fdee-44bb-b476-2a45cada8b00 - name: Authorization in: header description: Access token required: true schema: type: string example: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiJ1c2VyLXRlc3QiLCJyb2xlIjoiYWRtaW4iLCJpYXQiOjE3MDAwMDAwMDAsImV4cCI6MjAwMDAwMDAwMH0.MEUCIQDRrT_U-WXmq9sdlqZQw4y1GiI4Pp2tJSrKzWSi8vBslgIgQzRSce6h7RkF70ZcQnFX6Zry8FSX8U5CggV2-3OyuVE responses: '200': description: List of all staff substitutions content: application/json: schema: type: string security: - API_Authorizer: [] x-amazon-apigateway-integration: httpMethod: get uri: https://mobilemember.everbridge.net/api/v2/scheduling/staff-substitutions responses: default: statusCode: '200' type: http_proxy passthroughBehavior: when_no_match put: tags: - Scheduling summary: Update Staff Substitutions description: Update staff substitutions. operationId: ebs-daa-update-staff-substitutions parameters: - name: Client-Id in: header description: Custom app client id required: true schema: type: string example: 3efb35a2-fdee-44bb-b476-2a45cada8b00 - name: Authorization in: header description: Access token required: true schema: type: string example: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiJ1c2VyLXRlc3QiLCJyb2xlIjoiYWRtaW4iLCJpYXQiOjE3MDAwMDAwMDAsImV4cCI6MjAwMDAwMDAwMH0.MEUCIQDRrT_U-WXmq9sdlqZQw4y1GiI4Pp2tJSrKzWSi8vBslgIgQzRSce6h7RkF70ZcQnFX6Zry8FSX8U5CggV2-3OyuVE requestBody: content: application/json: schema: $ref: '#/components/schemas/StaffSubstitutionV2BulkUpdateRequest' required: true responses: '200': description: List of updated staff substitutions content: application/json: {} security: - API_Authorizer: [] x-amazon-apigateway-integration: httpMethod: put uri: https://mobilemember.everbridge.net/api/v2/scheduling/staff-substitutions responses: default: statusCode: '200' type: http_proxy passthroughBehavior: when_no_match delete: tags: - Scheduling summary: Delete Staff Substitutions description: Delete staff substitutions. operationId: ebs-daa-delete-staff-substitutions parameters: - name: Client-Id in: header description: Custom app client id required: true schema: type: string example: 3efb35a2-fdee-44bb-b476-2a45cada8b00 - name: Authorization in: header description: Access token required: true schema: type: string example: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiJ1c2VyLXRlc3QiLCJyb2xlIjoiYWRtaW4iLCJpYXQiOjE3MDAwMDAwMDAsImV4cCI6MjAwMDAwMDAwMH0.MEUCIQDRrT_U-WXmq9sdlqZQw4y1GiI4Pp2tJSrKzWSi8vBslgIgQzRSce6h7RkF70ZcQnFX6Zry8FSX8U5CggV2-3OyuVE responses: '200': description: List of deleted staff substitutions content: application/json: {} security: - API_Authorizer: [] x-amazon-apigateway-integration: httpMethod: delete uri: https://mobilemember.everbridge.net/api/v2/scheduling/staff-substitutions responses: default: statusCode: '200' type: http_proxy passthroughBehavior: when_no_match servers: - url: https://api.everbridge.net/digitalapps/v2 /scheduling/events: get: tags: - Scheduling summary: List Events description: List scheduling events. operationId: ebs-daa-list-scheduling-events parameters: - name: Client-Id in: header description: Custom app client id required: true schema: type: string example: 3efb35a2-fdee-44bb-b476-2a45cada8b00 - name: Authorization in: header description: Access token required: true schema: type: string example: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiJ1c2VyLXRlc3QiLCJyb2xlIjoiYWRtaW4iLCJpYXQiOjE3MDAwMDAwMDAsImV4cCI6MjAwMDAwMDAwMH0.MEUCIQDRrT_U-WXmq9sdlqZQw4y1GiI4Pp2tJSrKzWSi8vBslgIgQzRSce6h7RkF70ZcQnFX6Zry8FSX8U5CggV2-3OyuVE responses: '200': description: OK content: application/json: schema: type: string security: - API_Authorizer: [] x-amazon-apigateway-integration: httpMethod: get uri: https://mobilemember.everbridge.net/api/v2/scheduling/events responses: default: statusCode: '200' type: http_proxy passthroughBehavior: when_no_match servers: - url: https://api.everbridge.net/digitalapps/v2 /scheduling/calendars: get: tags: - Scheduling summary: Get Calendars description: Get scheduling calendars. operationId: ebs-daa-get-scheduling-calendars parameters: - name: Client-Id in: header description: Custom app client id required: true schema: type: string example: 3efb35a2-fdee-44bb-b476-2a45cada8b00 - name: Authorization in: header description: Access token required: true schema: type: string example: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiJ1c2VyLXRlc3QiLCJyb2xlIjoiYWRtaW4iLCJpYXQiOjE3MDAwMDAwMDAsImV4cCI6MjAwMDAwMDAwMH0.MEUCIQDRrT_U-WXmq9sdlqZQw4y1GiI4Pp2tJSrKzWSi8vBslgIgQzRSce6h7RkF70ZcQnFX6Zry8FSX8U5CggV2-3OyuVE responses: '200': description: Get List of Calendars content: application/json: {} security: - API_Authorizer: [] x-amazon-apigateway-integration: httpMethod: get uri: https://mobilemember.everbridge.net/api/v2/scheduling/calendars responses: default: statusCode: '200' type: http_proxy passthroughBehavior: when_no_match servers: - url: https://api.everbridge.net/digitalapps/v2 /scheduling/{organizationId}/audits: get: description: Scheduling Audit is a read-only resource, meaning audits cannot be modified or deleted. Hence, there is only one API to get the audits. However, the result can be filtered in various ways as per the need. operationId: EBS List Scheduling Audits parameters: - description: The id of the Organization that owns this resource in: path name: organizationId required: true schema: $ref: '#/components/schemas/organizationId' - description: Fields to be included in the response. in: query name: fields required: false schema: type: string - description:
filter may be used to specify filter criteria for the request.
filters are specified in the format of filter[fieldName], where fieldName is any field supported by this resource.
multiple filter criteria will result in AND conditions, with the exception of multiple filters on the same field, in which case the criteria will be treated as an OR condition
Ex. filter[calendarId]=1234567890, filter[action]=CREATE, filter[auditResource.type]=calendar, etc.
explode: true in: query name: filter required: false schema: allOf: - properties: calendarId: description: Unique ID of the calendar type: integer required: - calendarId title: Filter by calendar ID type: object - properties: shiftScheduleId: description: Unique ID of the shift schedule type: integer required: - shiftScheduleId title: Filter by shiftSchedule ID type: object - properties: staffScheduleId: description: Unique ID of the shift schedule type: integer required: - staffScheduleId title: Filter by staffSchedule ID type: object style: deepObject - description: One or more calendarIds that this request should filter by. in: query name: calendarId required: false schema: items: type: integer type: array - description: One or more shiftScheduleIds that this request should filter by. in: query name: shiftScheduleId required: false schema: items: type: integer type: array - description: One or more staffScheduleIds that this request should filter by. in: query name: staffScheduleId required: false schema: items: type: integer type: array - description: One or more staffSubstitutionIds (unavailability/replacement) that this request should filter by. in: query name: staffSubstitutionId required: false schema: items: type: integer type: array - description: One or more shiftScheduleSubstitutionIds (override) that this request should filter by. in: query name: shiftScheduleSubstitutionId required: false schema: items: type: integer type: array - description: Audit CRUD action type that this request should filter by. in: query name: action required: false schema: enum: - CREATE - UPDATE - DELETE type: string - description:Comma delimited list of fields to sort by.
+/- can precede the field name to indicate direction (ascending/descending).
+ is the default direction.
Ex. sort=action,-createdDate sorts by the action ascending and createdDate descending.
Audit records are by default sorted by the createdDate descending.
in: query name: sort required: false schema: type: string - description: The number of records per page to be included in the response in: query name: pageSize required: false schema: format: int32 type: integer - description: The page to be returned. in: query name: pageNo required: false schema: format: int32 type: integer responses: '200': content: application/json: examples: Successful Operation: summary: Successful Operation value: currentPageNo: 1 data: - accountId: 1536846672691202 action: UPDATE auditResource: id: '2343267047833601' minStaff: 0 name: Pre Test 4 onCallReminder: enabled: false recurrence: datesApplicable: from: '2024-10-15' to: '2024-10-20' everyNRecurrence: 2 type: periodic sequencingOverrideAllowed: true staffAssignments: - days: - 1 - 2 - 3 - 4 type: mixed staffEachDay: false type: staffSchedule calendarId: 2343267047833601 createdDate: '2024-10-15T15:38:18Z' createdId: 2200330536222721 createdName: Nandish API Access details: assignments: after: - days: - 1 - 2 - 3 - 4 before: - days: - 1 - 2 - 3 - 4 - 5 - 6 - 7 ids: - id: 2480365088276853 type: contact id: 2560042637197315 includes: - id: 2343267047833601 name: PRE Test111 numDays: 7 sequenced: false timeZoneString: Pacific/Niue type: shiftSchedule weekStartsWith: SUNDAY - id: 2343267047833601 name: PRE Test111 onCallReminder: enabled: false type: calendar - firstName: nandy id: 2480365088276853 lastName: nandy type: contact organizationId: 1536984111644674 shiftScheduleId: 2343267047833601 staffScheduleId: 2343267047833601 type: audit - accountId: 1536846672691202 action: UPDATE auditResource: id: '2343267047833601' minStaff: 0 name: Pre Test 4 onCallReminder: enabled: false recurrence: datesApplicable: from: '2024-10-15' to: '2024-10-20' everyNRecurrence: 2 type: periodic sequencingOverrideAllowed: true staffAssignments: - days: - 1 - 2 - 3 - 4 - 5 - 6 - 7 ids: - id: 2480365088276853 type: contact type: mixed staffEachDay: false type: staffSchedule calendarId: 2343267047833601 createdDate: '2024-10-15T15:38:02Z' createdId: 2200330536222721 createdName: Nandish API Access details: recurrence: after: everyNRecurrence: 2 type: periodic before: everyNRecurrence: 1 type: periodic id: 2560042637197314 includes: - id: 2343267047833601 name: PRE Test111 numDays: 7 sequenced: false timeZoneString: Pacific/Niue type: shiftSchedule weekStartsWith: SUNDAY - id: 2343267047833601 name: PRE Test111 onCallReminder: enabled: false type: calendar - firstName: nandy id: 2480365088276853 lastName: nandy type: contact organizationId: 1536984111644674 shiftScheduleId: 2343267047833601 staffScheduleId: 2343267047833601 type: audit pageSize: 20 totalCount: 238 totalPageCount: 12 schema: $ref: '#/components/schemas/schedulingAudits' description: Successful Operation security: - BasicAuth: [] - API_Authorizer: [] - api_key: [] summary: List Scheduling Audits tags: - Scheduling x-amazon-apigateway-integration: httpMethod: GET passthroughBehavior: when_no_match requestParameters: integration.request.path.organizationId: method.request.path.organizationId responses: default: statusCode: '200' type: http_proxy uri: https://ebs-restapi-prod-us.evbg.io/rest/scheduling/{organizationId}/audits servers: - url: https://api.everbridge.net/rest - url: https://api.everbridge.eu/rest /scheduling/{organizationId}/calendarEvents: get: description: List of events and their corresponding assignments operationId: EBS List Calendar Events parameters: - description: The id of the Organization that owns this resource in: path name: organizationId required: true schema: $ref: '#/components/schemas/organizationId' - description:fields to be included in the response.
fields[resourceName] may be used to specify fields returned for included documents. When doing so, it is not necessary to also request to include the resource as the include is implied by the fields request
in: query name: fields required: false schema: type: string - description:Specifying the includes parameter will result in a compound document response, adding resources to included which have been referenced by resources returned in data.
include may be specified as a comma delimited list of resource names.
in: query name: include required: false schema: enum: - calendar - shiftSchedule - staffSchedule - shiftSubstitution - staffSubstitution - contact - group type: string - description: Start date/time to fetch events from. in: query name: start required: false schema: type: string - description: End date/time of the interval to fetch events from. in: query name: end required: false schema: type: string - description: Instant to fetch events for. in: query name: instant required: false schema: type: string - description: Number of days to fetch events for. in: query name: days required: false schema: type: integer - description: IDs for calendars that this request should filter by. in: query name: calendarId required: false schema: type: string - description: IDs for shifts that this request should filter by. in: query name: shiftScheduleId required: false schema: type: string responses: '200': content: application/json: examples: Successful Operation: summary: Successful Operation value: data: - assignments: [] calendarId: 2343267047833601 end: '2024-10-16T00:00:00-11:00' id: 08533060000001-670e4b30-670f9cb0 organizationId: 1536984111644674 shiftScheduleId: 2343267047833601 start: '2024-10-15T00:00:00-11:00' type: calendarEvent - assignments: [] calendarId: 2481052283043883 end: '2024-10-17T00:00:00+05:30' id: 08e1b060000001-670eb4a8-67100628 organizationId: 1536984111644674 shiftScheduleId: 2499947454791681 start: '2024-10-16T00:00:00+05:30' type: calendarEvent - assignments: [] calendarId: 2481052283043883 end: '2024-10-16T09:00:00-04:00' id: 08d08100000032-670ed7d0-670fb8d0 organizationId: 1536984111644674 shiftScheduleId: 2481052283043890 start: '2024-10-15T17:00:00-04:00' type: calendarEvent - assignments: - contactId: 2480365088276853 staffLayerId: 2514825221505027 - contactId: 2480365088276853 staffLayerId: 2514825221505029 - contactId: 2480365088276853 staffLayerId: 2514825221505030 - contactId: 2480365088276853 staffLayerId: 2514825221505031 - contactId: 2480365088276853 staffLayerId: 2514825221505032 - contactId: 2480365088276853 staffLayerId: 2514859581243393 - contactId: 2480365088276853 staffLayerId: 2514859581243394 - contactId: 2480365088276853 staffLayerId: 2514859581243395 calendarId: 2481052283043883 end: '2024-10-17T00:00:00-04:00' id: 08de2060000003-670f3a40-67108bc0 organizationId: 1536984111644674 shiftScheduleId: 2496030444617731 start: '2024-10-16T00:00:00-04:00' type: calendarEvent - assignments: [] calendarId: 2481052283043883 end: '2024-10-17T00:00:00-04:00' id: 08de2060000005-670f3a40-67108bc0 organizationId: 1536984111644674 shiftScheduleId: 2496030444617733 start: '2024-10-16T00:00:00-04:00' type: calendarEvent schema: $ref: '#/components/schemas/FlatCalendarEvent' description: Successful Operation security: - BasicAuth: [] - API_Authorizer: [] - api_key: [] summary: List Calendar Events tags: - Scheduling x-amazon-apigateway-integration: httpMethod: GET passthroughBehavior: when_no_match requestParameters: integration.request.path.organizationId: method.request.path.organizationId responses: default: statusCode: '200' type: http_proxy uri: https://ebs-restapi-prod-us.evbg.io/rest/scheduling/{organizationId}/calendarEvents servers: - url: https://api.everbridge.net/rest - url: https://api.everbridge.eu/rest /scheduling/{organizationId}/calendars: get: deprecated: false description: Return a list of all calendars for an organization operationId: EBS List Calendars parameters: - description: The ID of the organization that owns this resource example: 1536984111644674 in: path name: organizationId required: true schema: $ref: '#/components/schemas/organizationId' - description: An array containing country codes for the countries/regions to which this calendar is related. No validation is done. Invalid codes will be ignored example: AU in: query name: holidayCalendarCodes required: false schema: items: type: string type: array - description: Page number to be displayed. Maximum page number with page size 20 is 1 example: 1 in: query name: pageNumber required: false schema: type: integer - description: Number od records displayed per page. The maximum page size is 100 example: 20 in: query name: pageSize required: false schema: type: integer responses: '200': content: application/json: examples: Response Model: summary: Response Model value: currentPageNo: 1 data: - accountId: 1536846672691202 active: true createdDate: '2023-02-22T17:42:46Z' createdId: 585800790048776 createdName: Ajay Goel emailNotificationEnabled: false externalId: 8d0810000002b id: 2481052283043883 lastModifiedDate: '2023-02-22T17:44:10Z' lastModifiedId: 585800790048776 lastModifiedName: Ajay Goel name: Calendar for Engineering Team notifyScheduled: false onCallReminder: enabled: false organizationId: 1536984111644674 resourceBundleId: 1536984111644675 status: A type: calendar visibility: contact pageSize: 20 totalCount: 1 totalPageCount: 1 schema: $ref: '#/components/schemas/listCalendars' description: Model security: - BasicAuth: [] - API_Authorizer: [] - api_key: [] summary: List Calendars tags: - Scheduling x-amazon-apigateway-integration: httpMethod: GET passthroughBehavior: when_no_match requestParameters: integration.request.path.organizationId: method.request.path.organizationId responses: default: statusCode: '200' type: http_proxy uri: https://ebs-restapi-prod-us.evbg.io/rest/scheduling/{organizationId}/calendars post: deprecated: false description: Create Calendar in an Organization operationId: EBS Create Calendar parameters: - description: The id of the Organization that owns this resource example: 1536984111644674 in: path name: organizationId required: true schema: $ref: '#/components/schemas/organizationId' requestBody: content: application/json: examples: Calendar with Custom External Id: summary: Calendar with Custom External Id value: data: externalId: alph4Num3ricOrStringCharacters0nly name: Calendar for Eng Calendar with Email Notification: summary: Calendar with Email Notification value: data: emailNotificationEnabled: true emailNotificationList: - example@gmail.com externalId: alph4Num3ricOrStringCharacters0nly name: Calendar for Eng Calendar with Notification Scheduled: summary: Calendar with Notification Scheduled value: data: emailNotificationEnabled: true emailNotificationList: - example@gmail.com externalId: alph4Num3ricOrStringCharacters0nly name: Calendar for Eng notifyScheduled: true Minimal Calendar: summary: Minimal Calendar value: data: name: Calendar for Eng schema: $ref: '#/components/schemas/calendarObj' required: true responses: '200': content: application/json: example: Success: summary: Created Calendar value: data: accountId: 1536846672691202 active: false createdDate: '2024-06-04T06:27:37Z' createdId: 2200330536222721 createdName: Nandish API Access emailNotificationEnabled: false externalId: '8529060000001' id: 2342579853066241 lastModifiedDate: '2024-06-04T06:27:37Z' lastModifiedId: 2200330536222721 lastModifiedName: Nandish API Access name: PRE Calendar Postman 1717482455 notifyScheduled: false onCallReminder: enabled: false organizationId: 1536984111644674 resourceBundleId: 1536984111644675 status: A type: calendar visibility: contact schema: $ref: '#/components/schemas/calendar' description: OK security: - BasicAuth: [] - API_Authorizer: [] - api_key: [] summary: Create Calendar tags: - Scheduling x-amazon-apigateway-integration: httpMethod: POST passthroughBehavior: when_no_match requestParameters: integration.request.path.organizationId: method.request.path.organizationId responses: default: statusCode: '200' type: http_proxy uri: https://ebs-restapi-prod-us.evbg.io/rest/scheduling/{organizationId}/calendars servers: - url: https://api.everbridge.net/rest - url: https://api.everbridge.eu/rest /scheduling/{organizationId}/calendars/{ids}: delete: deprecated: false description: Delete Calendars within an Organization operationId: EBS Delete Calendars parameters: - description: The id of the Organization that owns this resource example: 1536984111644674 in: path name: organizationId required: true schema: $ref: '#/components/schemas/organizationId' - description: The id or ids (comma delimmited) of the resources to delete in: path name: ids required: true schema: type: string responses: '200': content: application/json: example: Success: summary: Delete Calendar value: data: accountId: 1536846672691202 active: false createdDate: '2024-06-04T09:02:52Z' createdId: 2200330536222721 createdName: Nandish API Access emailNotificationEnabled: false externalId: '8531860000001' id: 2343163968618497 lastModifiedDate: '2024-06-04T09:03:43Z' lastModifiedId: 2200330536222721 lastModifiedName: Nandish API Access name: PRE Calendar Postman 1717491771 notifyScheduled: false onCallReminder: enabled: false organizationId: 1536984111644674 resourceBundleId: 1536984111644675 status: D type: calendar visibility: contact schema: $ref: '#/components/schemas/calendar' description: OK security: - BasicAuth: [] - API_Authorizer: [] - api_key: [] summary: Delete Calendars tags: - Scheduling x-amazon-apigateway-integration: httpMethod: DELETE passthroughBehavior: when_no_match requestParameters: integration.request.path.ids: method.request.path.ids integration.request.path.organizationId: method.request.path.organizationId responses: default: statusCode: '200' type: http_proxy uri: https://ebs-restapi-prod-us.evbg.io/rest/scheduling/{organizationId}/calendars/{ids} get: deprecated: false description: Get Calendar or Calendars within an Organization operationId: EBS Get Calendars parameters: - description: The id of the Organization that owns this resource in: path name: organizationId required: true schema: $ref: '#/components/schemas/organizationId' - description: The id or ids (comma delimited) of the resources to find in: path name: ids required: true schema: type: string responses: '200': content: application/json: example: Success: summary: Get Calendar value: data: accountId: 1536846672691202 active: false createdDate: '2024-06-04T09:02:52Z' createdId: 2200330536222721 createdName: Nandish API Access emailNotificationEnabled: false externalId: '8531860000001' id: 2343163968618497 lastModifiedDate: '2024-06-04T09:03:43Z' lastModifiedId: 2200330536222721 lastModifiedName: Nandish API Access name: PRE Calendar Postman 1717491771 notifyScheduled: false onCallReminder: enabled: false organizationId: 1536984111644674 resourceBundleId: 1536984111644675 status: D type: calendar visibility: contact schema: $ref: '#/components/schemas/calendar' description: OK security: - BasicAuth: [] - API_Authorizer: [] - api_key: [] summary: Get Calendars tags: - Scheduling x-amazon-apigateway-integration: httpMethod: GET passthroughBehavior: when_no_match requestParameters: integration.request.path.ids: method.request.path.ids integration.request.path.organizationId: method.request.path.organizationId responses: default: statusCode: '200' type: http_proxy uri: https://ebs-restapi-prod-us.evbg.io/rest/scheduling/{organizationId}/calendars/{ids} put: deprecated: false description: Update Calendar or Calendars within an Organization operationId: EBS Update calendars parameters: - description: The id of the Organization that owns this resource in: path name: organizationId required: true schema: $ref: '#/components/schemas/organizationId' - description: The id or ids (comma delimited) of the resources to delete in: path name: ids required: true schema: type: string requestBody: content: application/json: examples: Change Calendar Name: summary: Change Calendar Name value: data: name: Updated Calendar for Eng Make Calendar Active: summary: Make Calendar Active value: data: active: true Make Calendar Inactive: summary: Make Calendar Inactive value: data: active: false Publish Calendar: summary: Publish Calendar value: data: visibility: org Unpublish Calendar: summary: Unpublish Calendar value: data: visibility: contact Update Calendar Email Notif List: summary: Update Calendar Email Notif List value: data: emailNotificationList: - example1@gmail.com - example2@gmail.com schema: $ref: '#/components/schemas/calendarObj' required: true responses: '200': content: application/json: example: Success: summary: Update Calendar value: data: accountId: 1536846672691202 active: false createdDate: '2024-06-04T09:02:52Z' createdId: 2200330536222721 createdName: Nandish API Access emailNotificationEnabled: false externalId: '8531860000001' id: 2343163968618497 lastModifiedDate: '2024-06-04T09:03:43Z' lastModifiedId: 2200330536222721 lastModifiedName: Nandish API Access name: PRE Calendar Postman 1717491771 notifyScheduled: false onCallReminder: enabled: false organizationId: 1536984111644674 resourceBundleId: 1536984111644675 status: D type: calendar visibility: contact schema: $ref: '#/components/schemas/calendar' description: OK security: - BasicAuth: [] - API_Authorizer: [] - api_key: [] summary: Update calendars tags: - Scheduling x-amazon-apigateway-integration: httpMethod: PUT passthroughBehavior: when_no_match requestParameters: integration.request.path.ids: method.request.path.ids integration.request.path.organizationId: method.request.path.organizationId responses: default: statusCode: '200' type: http_proxy uri: https://ebs-restapi-prod-us.evbg.io/rest/scheduling/{organizationId}/calendars/{ids} servers: - url: https://api.everbridge.net/rest - url: https://api.everbridge.eu/rest /scheduling/{organizationId}/oncallreminder/staff: get: description: Get the on-call staff for Scheduling reminder operationId: EBS Scheduling Oncall Reminder Staff parameters: - description: The id of the Organization that owns this resource in: path name: organizationId required: true schema: $ref: '#/components/schemas/organizationId' - description: The ID of the calendar associated with the onCall reminder in: query name: calendarId required: false schema: type: integer - description: The ID of the shiftSchedule associated with the onCall reminder in: query name: shiftScheduleId required: false schema: type: integer - description: The ID of the staffSchedule associated with the onCall reminder in: query name: staffScheduleId required: false schema: type: integer - description: The start datetime of the onCall reminder in: query name: eventStart required: false schema: type: string - description: The end datetime of the onCall reminder in: query name: eventEnd required: false schema: type: string - description: The time interval associated with the onCall reminder in: query name: reminderTimeIntervalValue required: false schema: type: integer - description: The time unit associated with the onCall reminder in: query name: reminderTimeIntervalUnit required: false schema: type: integer requestBody: content: application/json: examples: {} schema: {} required: true responses: '200': content: application/json: examples: {} schema: {} description: Successful Operation security: - BasicAuth: [] - API_Authorizer: [] - api_key: [] summary: Scheduling Oncall Reminder Staff tags: - Scheduling x-amazon-apigateway-integration: httpMethod: GET passthroughBehavior: when_no_match requestParameters: integration.request.path.organizationId: method.request.path.organizationId responses: default: statusCode: '200' type: http_proxy uri: https://ebs-restapi-prod-us.evbg.io/rest/scheduling/{organizationId}/oncallreminder/staff servers: - url: https://api.everbridge.net/rest - url: https://api.everbridge.eu/rest /scheduling/{organizationId}/oncallstaff: post: description: Get the on-call staff for non-flexible or flexible Scheduling operationId: EBS Scheduling Oncall Staff parameters: - description: The id of the Organization that owns this resource in: path name: organizationId required: true schema: $ref: '#/components/schemas/organizationId' requestBody: content: application/json: examples: {} schema: {} required: true responses: '200': content: application/json: examples: {} schema: {} description: Successful Operation security: - BasicAuth: [] - API_Authorizer: [] - api_key: [] summary: Scheduling Oncall Staff tags: - Scheduling x-amazon-apigateway-integration: httpMethod: POST passthroughBehavior: when_no_match requestParameters: integration.request.path.organizationId: method.request.path.organizationId responses: default: statusCode: '200' type: http_proxy uri: https://ebs-restapi-prod-us.evbg.io/rest/scheduling/{organizationId}/oncallstaff servers: - url: https://api.everbridge.net/rest - url: https://api.everbridge.eu/rest /scheduling/{organizationId}/shiftSchedules: get: deprecated: false description: Return a list of shiftSchedules within an organization operationId: EBS List Shift Schedules parameters: - description: The ID of the organization containing the shift schedules in: path name: organizationId required: true schema: $ref: '#/components/schemas/organizationId' - allowEmptyValue: false description:Fields (Any ShiftSchedule field) to be included in the response.
Fields[resourceName] may be used to specify fields returned for included documents. When doing so, it is not necessary to also request to include the resource as the include is implied by the fields request
in: query name: fields required: false schema: example: - name - colorIndicator - name,numDays,colorIndicator type: string - allowEmptyValue: false description:Filter (Any non transient ShiftSchedule field) may be used to specify filter criteria for the request.
filters are specified in the format of filter[fieldName], where fieldName is any field supported by this resource.
multiple filter criteria will result in AND conditions, with the exception of multiple filters on the same field, in which case the criteria will be treated as an OR condition
in: query name: filter required: false schema: example: - name - numDays,colorIndicator type: string - allowEmptyValue: false description:Specifying the includes parameter will result in a compound document response, adding resources to included which have been referenced by resources returned in data.
include may be specified as a comma delimited list of resource names.
in: query name: include required: false schema: enum: - calendar - group - staffSchedule - shiftSubstitution - calendar,group - staffSchedule,shiftSubstitution - group,staffSchedule - calendar,staffSchedule - calendar,group,staffSchedule - calendar,staffSchedule,shiftSubstitution - group,staffSchedule,shiftSubstitution type: string - allowEmptyValue: false description: The page to be returned. in: query name: pageNo required: false schema: default: 1 type: integer - allowEmptyValue: false description: The number of records per page to be included in the response in: query name: pageSize required: false schema: default: 10 type: integer - allowEmptyValue: false description:Comma delimited list of fields (Any non transient ShiftSchedule field) to sort by.
+/- can precede the field name to indicate direction (ascending/descending).
+ is the default direction
Ex. sort=status,-createdDate sorts by status ascending and createdDate descending
in: query name: sort required: false schema: example: - status - status,-createdDate type: string responses: '200': content: application/json: examples: Response Model: summary: Response Model value: currentPageNo: 1 data: - accountId: 1536846672691202 calendarId: 2481052283043883 colorIndicator: '#9EBAD3' createdDate: '2023-02-22T17:43:39Z' createdId: 585800790048776 createdName: Ajay Goel datesApplicable: from: '2023-02-22' groupId: null id: 2481052283043889 lastModifiedDate: '2023-02-22T17:43:39Z' lastModifiedId: 585800790048776 lastModifiedName: Ajay Goel name: Day Shift numDays: 7 organizationId: 1536984111644674 override: false resourceBundleId: 1536984111644675 schedule: - days: - 1 - 2 - 3 - 4 - 5 - 6 - 7 shift: end: '17:00' start: 09:00 type: day sequenced: false shiftTimeZoneString: America/New_York staffTypeRequired: [] status: A timeZoneString: America/New_York type: shiftSchedule weekStartsWith: SUNDAY - accountId: 1536846672691202 calendarId: 2481052283043883 colorIndicator: '#9EBAD3' createdDate: '2023-02-22T17:44:49Z' createdId: 585800790048776 createdName: Ajay Goel datesApplicable: from: '2023-02-22' groupId: null id: 2481052283043890 lastModifiedDate: '2023-02-22T17:44:49Z' lastModifiedId: 585800790048776 lastModifiedName: Ajay Goel name: Evening Shift numDays: 7 organizationId: 1536984111644674 override: false resourceBundleId: 1536984111644675 schedule: - days: - 1 - 2 - 3 - 4 - 5 - 6 - 7 shift: end: 09:00 start: '17:00' type: day sequenced: false shiftTimeZoneString: America/New_York staffTypeRequired: [] status: A timeZoneString: America/New_York type: shiftSchedule weekStartsWith: SUNDAY pageSize: 20 totalCount: 2 totalPageCount: 1 Response Model With Filters: summary: Response Model With Filters value: currentPageNo: 1 data: - calendarId: 2481052283043883 colorIndicator: '#9EBAD3' groupId: null id: 2481052283043890 name: Evening Shift numDays: 7 type: shiftSchedule - calendarId: 2481052283043883 colorIndicator: '#9EBAD3' groupId: null id: 2481052283043889 name: Day Shift numDays: 7 type: shiftSchedule included: - accountId: 1536846672691202 active: true createdDate: '2023-02-22T17:42:46Z' createdId: 585800790048776 createdName: Ajay Goel emailNotificationEnabled: false externalId: 8d0810000002b id: 2481052283043883 lastModifiedDate: '2023-02-22T17:44:10Z' lastModifiedId: 585800790048776 lastModifiedName: Ajay Goel name: Calendar for Engineering Team notifyScheduled: false onCallReminder: enabled: false organizationId: 1536984111644674 resourceBundleId: 1536984111644675 status: A type: calendar visibility: contact - accountId: 1536846672691202 calendarId: 2481052283043883 createdDate: '2023-02-22T17:44:05Z' createdId: 585800790048776 createdName: Ajay Goel id: 2481052283043888 lastModifiedDate: '2023-02-22T17:44:05Z' lastModifiedId: 585800790048776 lastModifiedName: Ajay Goel minStaff: 0 name: Manager onCallReminder: enabled: false organizationId: 1536984111644674 recurrence: datesApplicable: from: '2023-02-22' everyNRecurrence: 1 type: periodic resourceBundleId: 1536984111644675 seq: 0 sequencingOverrideAllowed: true shiftScheduleId: 2481052283043889 staffAssignments: - days: - 1 - 2 - 3 - 4 - 5 - 6 - 7 ids: - id: 609852606906395 type: contact type: mixed staffEachDay: false status: A type: staffSchedule - accountId: 1536846672691202 calendarId: 2481052283043883 createdDate: '2023-02-22T17:45:24Z' createdId: 585800790048776 createdName: Ajay Goel id: 2481052283043889 lastModifiedDate: '2023-02-22T17:45:24Z' lastModifiedId: 585800790048776 lastModifiedName: Ajay Goel minStaff: 0 name: 'Offshore Manager ' onCallReminder: enabled: false organizationId: 1536984111644674 recurrence: datesApplicable: from: '2023-02-22' everyNRecurrence: 1 type: periodic resourceBundleId: 1536984111644675 seq: 0 sequencingOverrideAllowed: true shiftScheduleId: 2481052283043890 staffAssignments: - days: - 1 - 2 - 3 - 4 - 5 - 6 - 7 ids: - id: 2451915224909156 type: contact type: mixed staffEachDay: false status: A type: staffSchedule pageSize: 10 totalCount: 2 totalPageCount: 1 schema: $ref: '#/components/schemas/shiftSchedules' description: Model security: - BasicAuth: [] - API_Authorizer: [] - api_key: [] summary: List Shift Schedules tags: - Scheduling x-amazon-apigateway-integration: httpMethod: GET passthroughBehavior: when_no_match requestParameters: integration.request.path.organizationId: method.request.path.organizationId responses: default: statusCode: '200' type: http_proxy uri: https://ebs-restapi-prod-us.evbg.io/rest/scheduling/{organizationId}/shiftSchedules post: operationId: EBS Create Shift Schedules parameters: - description: The id of the Organization that owns this resource in: path name: organizationId required: true schema: $ref: '#/components/schemas/organizationId' requestBody: content: application/json: examples: All days Shift: summary: All days Shift value: data: calendarId: 2481052283043883 colorIndicator: '#9EBAD3' datesApplicable: from: '2023-02-22' to: null name: All days Shift numDays: 7 schedule: - days: - 1 - 2 - 3 - 4 - 5 - 6 - 7 shift: end: '17:00' start: 09:00 type: day staffTypeRequired: [] timeZoneString: America/New_York Weekdays After Hour Shift: summary: Weekdays After Hour Shift value: data: calendarId: 2481052283043883 colorIndicator: '#FF3333' datesApplicable: from: '2017-08-23' name: Weekdays After Hour numDays: 7 schedule: - days: - 1 - 7 shift: end: 00:00 start: 00:00 type: day - days: - 2 shift: end: 09:00 start: 00:00 type: day - days: - 6 shift: end: 00:00 start: '18:00' type: day sequenced: true timeZoneString: America/New_York weekStartsWith: SUNDAY Weekdays Shift: summary: Weekdays Shift value: data: calendarId: 2481052283043883 colorIndicator: '#FF3333' datesApplicable: from: '2017-08-23' name: Weekdays Shift numDays: 7 schedule: - days: - 1 - 7 shift: end: 00:00 start: 00:00 type: day - days: - 2 shift: end: 09:00 start: 00:00 type: day - days: - 6 shift: end: 00:00 start: '18:00' type: day sequenced: true timeZoneString: America/New_York weekStartsWith: SUNDAY Weekend Shift: summary: Weekend Shift value: data: calendarId: 2481052283043883 colorIndicator: '#FF3333' datesApplicable: from: '2017-08-23' name: Weekend Shift numDays: 7 schedule: - days: - 1 - 7 shift: end: '18:00' start: 09:00 type: day - days: - 2 shift: end: 00:00 start: 00:00 type: day - days: - 6 shift: end: 00:00 start: 00:00 type: day sequenced: true timeZoneString: America/New_York weekStartsWith: SUNDAY schema: $ref: '#/components/schemas/shiftSchedulesRequest' required: true responses: '200': content: application/json: example: Success: summary: Create Shift Scheduler value: data: accountId: 453003085614350 calendarId: 7991254805643266 colorIndicator: '#CC99FF' createdDate: '2017-08-29T18:39:36Z' createdId: 8118798154465522 createdName: Ajay Goel datesApplicable: from: '2017-08-23' id: 7978060666109953 lastModifiedDate: '2017-08-29T18:39:36Z' lastModifiedId: 8118798154465522 lastModifiedName: Ajay Goel name: Weekdays After Hours numDays: 7 organizationId: 453003085616967 resourceBundleId: 453003085618621 schedule: - days: - 2 - 3 - 4 - 5 - 6 shift: end: 09:00 start: '18:00' type: day sequenced: true status: A timeZoneString: America/New_York type: shiftSchedule weekStartsWith: SUNDAY schema: $ref: '#/components/schemas/shiftSchedulesCreateResponse' description: OK '400': content: application/json: example: Success: summary: Bad request value: errors: - code: SHIFT_SCHEDULE_CALENDAR_ID_REQUIRED detail: A valid calendarId is required id: 3abc3100-061a-40d9-846b-794bebbc3323 meta: resource: shiftSchedule source: pointer: /data/calendarId status: '400' title: ShiftSchedule calendarId is required. schema: {} description: OK '401': content: application/json: example: Success: summary: Invalid input value: message: Org is invalid. status: 401 schema: {} description: OK security: - BasicAuth: [] - API_Authorizer: [] - api_key: [] summary: Create Shift Schedules tags: - Scheduling x-amazon-apigateway-integration: httpMethod: POST passthroughBehavior: when_no_match requestParameters: integration.request.path.organizationId: method.request.path.organizationId responses: default: statusCode: '200' type: http_proxy uri: https://ebs-restapi-prod-us.evbg.io/rest/scheduling/{organizationId}/shiftSchedules servers: - url: https://api.everbridge.net/rest - url: https://api.everbridge.eu/rest /scheduling/{organizationId}/shiftSchedules/{ids}: delete: deprecated: false description: Delete shiftSchedule or shiftSchedules within an organization operationId: EBS Delete Shift Schedules parameters: - description: The ID of the organization containing the shift schedules in: path name: organizationId required: true schema: $ref: '#/components/schemas/organizationId' - description: The id or ids (comma delimited) of the resources to find in: path name: ids required: true schema: {} responses: '200': content: application/json: examples: Response Model: summary: Response Model value: data: - accountId: 1536846672691202 calendarId: 2481052283043883 colorIndicator: '#9EBAD3' createdDate: '2024-09-18T07:05:44Z' createdId: 2200330536222721 createdName: Nandish API Access datesApplicable: from: '2023-02-22' id: 2503108550721537 lastModifiedDate: '2024-09-18T07:35:16Z' lastModifiedId: 2200330536222721 lastModifiedName: Nandish API Access name: All days Shift numDays: 7 organizationId: 1536984111644674 resourceBundleId: 1536984111644675 schedule: - days: - 1 - 2 - 3 - 4 - 5 - 6 - 7 shift: end: '17:00' start: 09:00 type: day staffTypeRequired: [] status: D timeZoneString: America/New_York type: shiftSchedule - accountId: 1536846672691202 calendarId: 2481052283043883 colorIndicator: '#FF3333' createdDate: '2024-09-13T11:05:38Z' createdId: 2200330536222721 createdName: Nandish API Access datesApplicable: from: '2017-08-23' id: 2496030444617730 lastModifiedDate: '2024-09-18T07:35:16Z' lastModifiedId: 2200330536222721 lastModifiedName: Nandish API Access name: Day Shift Test11 numDays: 7 organizationId: 1536984111644674 resourceBundleId: 1536984111644675 schedule: - days: - 1 - 7 shift: end: 00:00 start: 00:00 type: day - days: - 2 shift: end: 09:00 start: 00:00 type: day - days: - 6 shift: end: 00:00 start: '18:00' type: day sequenced: true staffTypeRequired: [] status: D timeZoneString: America/New_York type: shiftSchedule weekStartsWith: SUNDAY schema: {} description: Model '400': content: application/json: examples: Response Model: summary: Bad Request value: errors: - code: DELETE_DELETED_SHIFT_SCHEDULE_NOT_SUPPORTED detail: Cannot delete a deleted shiftSchedule id: e2ac67da-c858-4e9f-bd1c-7aa642d06fab meta: id: 2503108550721537 resource: shiftSchedule status: D source: pointer: /data/status status: '400' title: ShiftSchedule cannot be deleted schema: {} description: Model '500': content: application/json: examples: Response Model: summary: Server Error value: errors: - code: INTERNAL_SERVER_ERROR id: 1b067d8b-e3ca-4e66-9d55-bd9ec84be9f3 status: '500' title: Oops, an unexpected error occurred schema: {} description: Model security: - BasicAuth: [] - API_Authorizer: [] - api_key: [] summary: Delete Shift Schedules tags: - Scheduling x-amazon-apigateway-integration: httpMethod: DELETE passthroughBehavior: when_no_match requestParameters: integration.request.path.ids: method.request.path.ids integration.request.path.organizationId: method.request.path.organizationId responses: default: statusCode: '200' type: http_proxy uri: https://ebs-restapi-prod-us.evbg.io/rest/scheduling/{organizationId}/shiftSchedules/{ids} get: deprecated: false description: Get shiftSchedule or shiftSchedules within an organization operationId: EBS Get Shift Schedules parameters: - description: The ID of the organization containing the shift schedules in: path name: organizationId required: true schema: $ref: '#/components/schemas/organizationId' - description: The id or ids (comma delimmited) of the resources to find in: path name: ids required: true schema: {} - allowEmptyValue: false description:Fields (Any ShiftSchedule field) to be included in the response.
Fields[resourceName] may be used to specify fields returned for included documents. When doing so, it is not necessary to also request to include the resource as the include is implied by the fields request
in: query name: fields required: false schema: example: - name - colorIndicator - name,numDays,colorIndicator type: string - allowEmptyValue: false description:Specifying the includes parameter will result in a compound document response, adding resources to included which have been referenced by resources returned in data.
include may be specified as a comma delimited list of resource names.
in: query name: include required: false schema: enum: - calendar - group - staffSchedule - shiftSubstitution - calendar,group - staffSchedule,shiftSubstitution - group,staffSchedule - calendar,staffSchedule - calendar,group,staffSchedule - calendar,staffSchedule,shiftSubstitution - group,staffSchedule,shiftSubstitution type: string responses: '200': content: application/json: examples: Response Model: summary: Response Model value: currentPageNo: 1 data: - accountId: 1536846672691202 calendarId: 2481052283043883 colorIndicator: '#9EBAD3' createdDate: '2023-02-22T17:43:39Z' createdId: 585800790048776 createdName: Ajay Goel datesApplicable: from: '2023-02-22' groupId: null id: 2481052283043889 lastModifiedDate: '2023-02-22T17:43:39Z' lastModifiedId: 585800790048776 lastModifiedName: Ajay Goel name: Day Shift numDays: 7 organizationId: 1536984111644674 override: false resourceBundleId: 1536984111644675 schedule: - days: - 1 - 2 - 3 - 4 - 5 - 6 - 7 shift: end: '17:00' start: 09:00 type: day sequenced: false shiftTimeZoneString: America/New_York staffTypeRequired: [] status: A timeZoneString: America/New_York type: shiftSchedule weekStartsWith: SUNDAY - accountId: 1536846672691202 calendarId: 2481052283043883 colorIndicator: '#9EBAD3' createdDate: '2023-02-22T17:44:49Z' createdId: 585800790048776 createdName: Ajay Goel datesApplicable: from: '2023-02-22' groupId: null id: 2481052283043890 lastModifiedDate: '2023-02-22T17:44:49Z' lastModifiedId: 585800790048776 lastModifiedName: Ajay Goel name: Evening Shift numDays: 7 organizationId: 1536984111644674 override: false resourceBundleId: 1536984111644675 schedule: - days: - 1 - 2 - 3 - 4 - 5 - 6 - 7 shift: end: 09:00 start: '17:00' type: day sequenced: false shiftTimeZoneString: America/New_York staffTypeRequired: [] status: A timeZoneString: America/New_York type: shiftSchedule weekStartsWith: SUNDAY pageSize: 20 totalCount: 2 totalPageCount: 1 schema: $ref: '#/components/schemas/shiftSchedulesGetResponse' description: Model '400': content: application/json: examples: Response Model: summary: Bad Request value: errors: - code: DELETE_DELETED_SHIFT_SCHEDULE_NOT_SUPPORTED detail: Cannot delete a deleted shiftSchedule id: e2ac67da-c858-4e9f-bd1c-7aa642d06fab meta: id: 2503108550721537 resource: shiftSchedule status: D source: pointer: /data/status status: '400' title: ShiftSchedule cannot be deleted schema: {} description: Model '500': content: application/json: examples: Response Model: summary: Server Error value: errors: - code: INTERNAL_SERVER_ERROR id: 1b067d8b-e3ca-4e66-9d55-bd9ec84be9f3 status: '500' title: Oops, an unexpected error occurred schema: {} description: Model security: - BasicAuth: [] - API_Authorizer: [] - api_key: [] summary: Get Shift Schedules tags: - Scheduling x-amazon-apigateway-integration: httpMethod: GET passthroughBehavior: when_no_match requestParameters: integration.request.path.ids: method.request.path.ids integration.request.path.organizationId: method.request.path.organizationId responses: default: statusCode: '200' type: http_proxy uri: https://ebs-restapi-prod-us.evbg.io/rest/scheduling/{organizationId}/shiftSchedules/{ids} put: operationId: EBS Update Shift Schedules parameters: - description: The id of the Organization that owns this resource in: path name: organizationId required: true schema: $ref: '#/components/schemas/organizationId' - description: The id or ids (comma delimmited) of the resources to find in: path name: ids required: true schema: {} requestBody: content: application/json: examples: Update a Shift Schedule: summary: Update a Shift Schedule value: data: accountId: 1536846672691202 calendarId: 2481052283043883 colorIndicator: '#FF3333' createdDate: '2024-09-13T11:07:39Z' createdId: 2200330536222721 createdName: Nandish API Access datesApplicable: from: '2017-08-23' id: 2496030444617732 lastModifiedDate: '2024-09-18T09:22:13Z' lastModifiedId: 2200330536222721 lastModifiedName: Nandish API Access name: Weekend1 numDays: 7 organizationId: 1536984111644674 resourceBundleId: 1536984111644675 schedule: - days: - 1 - 7 shift: end: 09:00 start: '18:00' type: day - days: - 2 - 6 shift: end: 00:00 start: 00:00 type: day sequenced: true shiftTimeZoneString: America/New_York staffTypeRequired: [] status: A timeZoneString: America/New_York type: shiftSchedule weekStartsWith: SUNDAY Update multiple Shift Schedules: summary: Weekend Shift value: data: calendarId: 2481052283043883 colorIndicator: '#FF3333' datesApplicable: from: '2017-08-23' name: Weekends numDays: 7 schedule: - days: - 1 - 7 shift: end: 09:00 start: '18:00' type: day - days: - 2 shift: end: 00:00 start: 00:00 type: day - days: - 6 shift: end: 00:00 start: 00:00 type: day sequenced: true timeZoneString: America/New_York weekStartsWith: SUNDAY schema: $ref: '#/components/schemas/shiftSchedulesRequest' required: true responses: '200': content: '*/*': schema: type: string description: Successful Operation security: - BasicAuth: [] - API_Authorizer: [] - api_key: [] summary: Update Shift Schedules tags: - Scheduling x-amazon-apigateway-integration: httpMethod: PUT passthroughBehavior: when_no_match requestParameters: integration.request.path.ids: method.request.path.ids integration.request.path.organizationId: method.request.path.organizationId responses: default: statusCode: '200' type: http_proxy uri: https://ebs-restapi-prod-us.evbg.io/rest/scheduling/{organizationId}/shiftSchedules/{ids} servers: - url: https://api.everbridge.net/rest - url: https://api.everbridge.eu/rest /scheduling/{organizationId}/shiftSubstitutions: get: description: Retrieve Shift Substitution(s) for an organization (Override) operationId: EBS List Shift Substitutions parameters: - description: The id of the Organization that owns this resource in: path name: organizationId required: true schema: $ref: '#/components/schemas/organizationId' - description:fields to be included in the response.
fields[resourceName] may be used to specify fields returned for included documents. When doing so, it is not necessary to also request to include the resource as the include is implied by the fields request.
in: query name: fields required: false schema: items: enum: - calendar - shiftSchedule - eventSummary - assignment - contact - calendarEvent - event - group type: string type: array - description:Specifying the includes parameter will result in a compound document response, adding resources to included which have been referenced by resources returned in data.
include may be specified as a comma delimited list of resource names.
in: query name: include required: false schema: enum: - calendar - shiftSchedule - contact type: string - description:filter may be used to specify filter criteria for the request.
filters are specified in the format of filter[fieldName], where fieldName is any field supported by this resource.
multiple filter criteria will result in AND conditions, with the exception of multiple filters on the same field, in which case the criteria will be treated as an OR condition
explode: true in: query name: filter required: false schema: allOf: - properties: calendarId: description: Unique ID of the calendar type: integer required: - calendarId title: Filter by calendar ID type: object - properties: shiftScheduleId: description: Unique ID of the shift schedule type: integer required: - shiftScheduleId title: Filter by shiftSchedule ID type: object style: deepObject - description:Comma delimited list of fields to sort by.
+/- can precede the field name to indicate direction (ascending/descending).
+ is the default direction
Ex. sort=status,-createdDate sorts by status ascending and createdDate descending
in: query name: sort required: false schema: type: string - description: The number of records per page to be included in the response in: query name: pageSize required: false schema: type: integer - description: The page to be returned. in: query name: pageNo required: false schema: type: integer responses: '200': content: application/json: examples: Response Model: summary: Response Model value: currentPageNo: 1 data: - accountId: 1536846672691202 calendarId: 2516955525283841 createdDate: '2024-09-25T06:47:17Z' createdId: 2200330536222721 createdName: Nandish API Access id: 2514859581243393 lastModifiedDate: '2024-09-25T06:47:17Z' lastModifiedId: 2200330536222721 lastModifiedName: Nandish API Access organizationId: 1536984111644674 recurrence: datesApplicable: - '2024-09-23' type: occurrence resourceBundleId: 1536984111644675 shiftScheduleId: 2514859581243396 staffAssignment: contactIds: - 2414322986778856 type: contact status: A type: shiftSubstitution pageSize: 20 totalCount: 1 totalPageCount: 1 schema: {} description: Model '400': content: application/json: examples: Bad Request: summary: Bad Request value: errors: - code: SHIFT_SUBSTITUTION_RECURRENCE_DATES_APPLICABLE_OVERLAP detail: Multiple substitutions not allowed id: 433e76e2-7169-40ed-8c9f-03ef03c39b9f meta: resource: shiftSubstitution source: pointer: /data/recurrence/datesApplicable status: '400' title: Invalid shift substitution date schema: {} description: Model security: - BasicAuth: [] - API_Authorizer: [] - api_key: [] summary: List Shift Substitutions tags: - Scheduling x-amazon-apigateway-integration: httpMethod: GET passthroughBehavior: when_no_match requestParameters: integration.request.path.organizationId: method.request.path.organizationId responses: default: statusCode: '200' type: http_proxy uri: https://ebs-restapi-prod-us.evbg.io/rest/scheduling/{organizationId}/shiftSubstitutions post: description: Create Shift Substitution(s) for an organization (Override). operationId: EBS Create Shift Substitutions parameters: - description: The id of the Organization that owns this resource in: path name: organizationId required: true schema: $ref: '#/components/schemas/organizationId' requestBody: content: application/json: examples: 'Multiple Dates Shift Substitutions ': summary: Shift substitutions for multiple dates value: data: - recurrence: datesApplicable: - '2024-10-06' type: occurrence shiftScheduleId: 2527332166270977 staffAssignment: contactIds: - 2414322986778856 type: contact - recurrence: datesApplicable: - '2024-10-10' type: occurrence shiftScheduleId: 2527332166270977 staffAssignment: contactIds: - 2414322986778856 type: contact Shift Substitutions [Contact]: summary: Create a new shift substitutions with a contact value: data: recurrence: datesApplicable: - '2024-09-23' type: occurrence shiftScheduleId: 2514859581243396 staffAssignment: contactIds: - 2414322986778856 type: contact Shift Substitutions [Group]: summary: Contact shift substitutions with a group value: data: recurrence: datesApplicable: - '2024-09-27' type: occurrence shiftScheduleId: 2514859581243396 staffAssignment: ids: - id: '2469369971998969' type: group type: mixed Shift Substitutions [Multiple Contact]: summary: Create a new shift substitutions with multiple contacts value: data: recurrence: datesApplicable: - '2024-10-06' type: occurrence shiftScheduleId: 2527332166270977 staffAssignment: contactIds: - 2414322986778856 - 609852606906395 type: contact schema: $ref: '#/components/schemas/shiftSubstitutionsRequest' required: true responses: '200': content: application/json: examples: Response Model: summary: Response Model value: data: accountId: 1536846672691202 calendarId: 2516955525283841 createdDate: '2024-09-25T08:00:46Z' createdId: 2200330536222721 createdName: Nandish API Access id: 2514825221505030 lastModifiedDate: '2024-09-25T08:00:46Z' lastModifiedId: 2200330536222721 lastModifiedName: Nandish API Access organizationId: 1536984111644674 recurrence: datesApplicable: - '2024-09-27' type: occurrence resourceBundleId: 1536984111644675 shiftScheduleId: 2514859581243396 staffAssignment: contactIds: - 2414322986778856 type: contact status: A type: shiftSubstitution schema: {} description: Model '400': content: application/json: examples: Multiple Shift Substitutions Not Allowed: summary: Multiple shift substitutions not allowed value: errors: - code: SHIFT_SUBSTITUTION_RECURRENCE_DATES_APPLICABLE_SIZE detail: One and only one occurrence is supported id: bfa6e1c0-ccfc-4f71-9d31-11f02eea5231 meta: occurrences: datesApplicable: - '2024-10-01' - '2024-10-02' type: occurrence resource: shiftSubstitution source: pointer: /data/recurrence/datesApplicable status: '400' title: Occurrences error schema: {} description: Model security: - BasicAuth: [] - API_Authorizer: [] - api_key: [] summary: Create Shift Substitutions (Override) tags: - Scheduling x-amazon-apigateway-integration: httpMethod: POST passthroughBehavior: when_no_match requestParameters: integration.request.path.organizationId: method.request.path.organizationId responses: default: statusCode: '200' type: http_proxy uri: https://ebs-restapi-prod-us.evbg.io/rest/scheduling/{organizationId}/shiftSubstitutions servers: - url: https://api.everbridge.net/rest - url: https://api.everbridge.eu/rest /scheduling/{organizationId}/shiftSubstitutions/{ids}: delete: operationId: EBS Delete Shift Substitutions parameters: - description: 'The id of the Organization that owns this resource ' in: path name: organizationId required: true schema: $ref: '#/components/schemas/organizationId' - description: The id or ids of the resources to delete explode: false in: path name: ids required: true schema: items: type: string type: array style: simple responses: '200': content: application/json: examples: Response Model: summary: Response Model value: data: accountId: 1536846672691202 calendarId: 2516955525283841 createdDate: '2024-09-25T10:53:18Z' createdId: 2200330536222721 createdName: Nandish API Access id: 2514825221505031 lastModifiedDate: '2024-09-25T10:53:28Z' lastModifiedId: 2200330536222721 lastModifiedName: Nandish API Access organizationId: 1536984111644674 recurrence: datesApplicable: - '2024-09-27' type: occurrence resourceBundleId: 1536984111644675 shiftScheduleId: 2514859581243396 staffAssignment: contactIds: - 2414322986778856 type: contact status: D type: shiftSubstitution schema: {} description: Model '404': content: application/json: examples: Resource Not Found: summary: Resource not found value: errors: - code: NOT_FOUND detail: Resource not found id: 6182e569-eaa3-4ba0-a1cf-6e471cbe1c76 meta: id: 2514825221505032 resource: shiftSubstitution status: '404' title: Not Found schema: {} description: Model security: - BasicAuth: [] - API_Authorizer: [] - api_key: [] summary: Delete Shift Substitutions tags: - Scheduling x-amazon-apigateway-integration: httpMethod: DELETE passthroughBehavior: when_no_match requestParameters: integration.request.path.ids: method.request.path.ids integration.request.path.organizationId: method.request.path.organizationId responses: default: statusCode: '200' type: http_proxy uri: https://ebs-restapi-prod-us.evbg.io/rest/scheduling/{organizationId}/shiftSubstitutions/{ids} get: operationId: EBS Get Shift Substitutions parameters: - description: The id of the Organization that owns this resource in: path name: organizationId required: true schema: $ref: '#/components/schemas/organizationId' - description: The id or ids of the resources to find explode: false in: path name: ids required: true schema: items: type: string type: array style: simple - description:fields to be included in the response.
fields[resourceName] may be used to specify fields returned for included documents. When doing so, it is not necessary to also request to include the resource as the include is implied by the fields request
in: query name: fields required: false schema: items: enum: - calendar - shiftSchedule - eventSummary - assignment - contact - calendarEvent - event - group type: string type: array - description:Specifying the includes parameter will result in a compound document response, adding resources to included which have been referenced by resources returned in data.
include may be specified as a comma delimited list of resource names.
in: query name: include required: false schema: enum: - calendar - shiftSchedule - contact type: string responses: '200': content: application/json: examples: Response Model: summary: Response Model value: currentPageNo: 1 data: - accountId: 1536846672691202 calendarId: 2516955525283841 createdDate: '2024-09-25T06:47:17Z' createdId: 2200330536222721 createdName: Nandish API Access id: 2514859581243393 lastModifiedDate: '2024-09-25T06:47:17Z' lastModifiedId: 2200330536222721 lastModifiedName: Nandish API Access organizationId: 1536984111644674 recurrence: datesApplicable: - '2024-09-23' type: occurrence resourceBundleId: 1536984111644675 shiftScheduleId: 2514859581243396 staffAssignment: contactIds: - 2414322986778856 type: contact status: A type: shiftSubstitution pageSize: 20 totalCount: 1 totalPageCount: 1 schema: {} description: Model '404': content: application/json: examples: Bad Request: summary: Bad Request value: Invalid shift substitution date: - code: NOT_FOUND detail: Resource not found id: 18a4e506-1f0f-4fc4-a7df-4f5ed659ebbf meta: id: 25148595812433960 resource: shiftSubstitution status: '404' title: Not Found NO_SHIFT_FOR_OVERRIDE: - code: NO_SHIFT_FOR_OVERRIDE detail: A shift does not occur during the override period id: 6b6c4ba6-b2bc-461e-9c96-b019efbbb78f meta: period: from: '2024-09-22' to: '2024-09-22' resource: shiftSubstitution source: pointer: /data/recurrence status: '400' title: Invalid Field Value - code: SHIFT_SUBSTITUTION_RECURRENCE_DATES_APPLICABLE_OVERLAP detail: Multiple substitutions not allowed id: dd7a5ee9-6b01-4805-8050-bb8539ed5f1a meta: resource: shiftSubstitution source: pointer: /data/recurrence/datesApplicable status: '400' title: Invalid shift substitution date schema: {} description: Model security: - BasicAuth: [] - API_Authorizer: [] - api_key: [] summary: Get Shift Substitutions tags: - Scheduling x-amazon-apigateway-integration: httpMethod: GET passthroughBehavior: when_no_match requestParameters: integration.request.path.ids: method.request.path.ids integration.request.path.organizationId: method.request.path.organizationId responses: default: statusCode: '200' type: http_proxy uri: https://ebs-restapi-prod-us.evbg.io/rest/scheduling/{organizationId}/shiftSubstitutions/{ids} put: operationId: EBS Update Shift Substitutions parameters: - description: The id of the Organization that owns this resource in: path name: organizationId required: true schema: $ref: '#/components/schemas/organizationId' - description: The id of the resources to update in: path name: ids required: true schema: type: string requestBody: content: application/json: examples: Update Shift [Assign a shift multiple contacts]: summary: Assign a shift multiple contacts value: data: recurrence: datesApplicable: - '2024-10-01' type: occurrence shiftScheduleId: 2527332166270977 staffAssignment: ids: - id: '2414322986778856' type: contact - id: '609852606906395' type: contact type: mixed type: shiftSubstitution Update Shift [Assign a shift multiple groups]: summary: Assign a shift multiple groups value: data: recurrence: datesApplicable: - '2024-10-01' type: occurrence shiftScheduleId: 2527332166270977 staffAssignment: ids: - id: 2314748464988162 type: group - id: 2480365088276539 type: group type: mixed type: shiftSubstitution Update Shift [Replace a contact with group]: summary: Replace a contact with group value: data: recurrence: datesApplicable: - '2024-10-06' type: occurrence shiftScheduleId: 2527332166270977 staffAssignment: ids: - id: '2469369971998969' type: group type: mixed type: shiftSubstitution Update Shift [Replace a group with contact]: summary: Replace a group with contact value: data: recurrence: datesApplicable: - '2024-10-06' type: occurrence shiftScheduleId: 2527332166270977 staffAssignment: ids: - id: '2414322986778856' type: contact type: mixed type: shiftSubstitution schema: $ref: '#/components/schemas/shiftSubstitutionsRequest' required: true responses: '200': content: application/json: examples: Response Model: summary: Response Model value: data: accountId: 1536846672691202 calendarId: 2516955525283841 createdDate: '2024-09-25T09:42:05Z' createdId: 2200330536222721 createdName: Nandish API Access id: 2514859581243395 lastModifiedDate: '2024-09-25T09:44:38Z' lastModifiedId: 2200330536222721 lastModifiedName: Nandish API Access organizationId: 1536984111644674 recurrence: datesApplicable: - '2024-09-25' type: occurrence resourceBundleId: 1536984111644675 shiftScheduleId: 2514859581243396 staffAssignment: contactIds: - 609852606906395 type: contact status: A type: shiftSubstitution schema: {} description: Model '400': content: application/json: examples: Bad Request: summary: Bad Request value: errors: - code: SHIFT_SUBSTITUTION_SHIFT_SCHEDULE_ID_NOT_FOUND detail: Referenced shiftSchedule not found. id: 120029e1-f944-4523-9a75-340a6ba5ab32 meta: referencedResource: shiftSchedule resource: shiftSubstitution shiftScheduleId: 25148595812433960 source: pointer: /data/shiftScheduleId status: '400' title: ShiftSubstitution shiftScheduleId not found. schema: {} description: Model security: - BasicAuth: [] - API_Authorizer: [] - api_key: [] summary: Update Shift Substitutions tags: - Scheduling x-amazon-apigateway-integration: httpMethod: PUT passthroughBehavior: when_no_match requestParameters: integration.request.path.ids: method.request.path.ids integration.request.path.organizationId: method.request.path.organizationId responses: default: statusCode: '200' type: http_proxy uri: https://ebs-restapi-prod-us.evbg.io/rest/scheduling/{organizationId}/shiftSubstitutions/{ids} servers: - url: https://api.everbridge.net/rest - url: https://api.everbridge.eu/rest /scheduling/{organizationId}/staffSchedules: get: operationId: EBS List Staff Schedules parameters: - description: The id of the Organization that owns this resource in: path name: organizationId required: true schema: $ref: '#/components/schemas/organizationId' - description:fields to be included in the response.
fields[resourceName] may be used to specify fields returned for included documents. When doing so, it is not necessary to also request to include the resource as the include is implied by the fields request
in: query name: fields required: false schema: type: string - description:Specifying the includes parameter will result in a compound document response, adding resources to included which have been referenced by resources returned in data.
include may be specified as a comma delimited list of resource names.
in: query name: include required: false schema: enum: - calendar - shiftSchedule - contact - group type: string - description:filter may be used to specify filter criteria for the request.
filters are specified in the format of filter[fieldName], where fieldName is any field supported by this resource.
multiple filter criteria will result in AND conditions, with the exception of multiple filters on the same field, in which case the criteria will be treated as an OR condition
explode: true in: query name: filter required: false schema: allOf: - properties: calendarId: description: Unique ID of the calendar type: integer required: - calendarId title: Filter by calendarId type: object - properties: shiftScheduleId: description: Unique ID of the shift schedule type: integer required: - shiftScheduleId title: Filter by shiftScheduleId type: object - properties: organizationId: description: Organization Id type: integer required: - organizationId title: Filter by organizationId type: object - properties: recurrence.datesApplicable.from: description: Filter staff schedules by start date type: string required: - recurrence.datesApplicable.from title: Filter by recurrence.datesApplicable.from type: object - properties: recurrence.datesApplicable.to: description: Filter staff schedules by end date type: string required: - recurrence.datesApplicable.to title: Filter by recurrence.datesApplicable.to type: object style: deepObject - description:Comma delimited list of fields to sort by.
+/- can precede the field name to indicate direction (ascending/descending).
+ is the default direction
Ex. sort=status,-createdDate sorts by status ascending and createdDate descending
in: query name: sort required: false schema: type: string - description: The number of records per page to be included in the response in: query name: pageSize required: false schema: type: integer - description: The page to be returned. in: query name: pageNo required: false schema: type: integer responses: '200': content: application/json: examples: Response Model: summary: Response Model value: currentPageNo: 1 data: - accountId: 1536846672691202 calendarId: 2342511133589505 createdDate: '2024-06-04T06:34:47Z' createdId: 2200330536222721 createdName: Nandish API Access escalationOption: none id: 2342511133589505 lastModifiedDate: '2024-06-04T06:34:47Z' lastModifiedId: 2200330536222721 lastModifiedName: Nandish API Access minStaff: 1 name: PRE Test onCallReminder: enabled: false organizationId: 1536984111644674 recurrence: datesApplicable: from: '2024-06-04' to: '2024-06-05' everyNRecurrence: 1 type: periodic resourceBundleId: 1536984111644675 seq: 0 sequencingOverrideAllowed: true shiftScheduleId: 2342511133589505 staffAssignments: - days: - 1 - 2 - 3 - 4 - 5 - 6 - 7 ids: - id: 2480365088276853 type: contact type: mixed staffEachDay: false status: A type: staffSchedule - accountId: 1536846672691202 calendarId: 2343267047833601 createdDate: '2024-06-04T10:26:33Z' createdId: 2200330536222721 createdName: Nandish API Access escalationOption: none id: 2343267047833601 lastModifiedDate: '2024-06-04T10:34:37Z' lastModifiedId: 2200330536222721 lastModifiedName: Nandish API Access minStaff: 0 name: PRE Test111 onCallReminder: enabled: false organizationId: 1536984111644674 recurrence: datesApplicable: from: '2024-06-03' everyNRecurrence: 1 type: periodic seq: 0 sequencingOverrideAllowed: true shiftScheduleId: 2343267047833601 staffAssignments: - days: - 1 - 2 - 3 - 4 - 5 - 6 - 7 ids: - id: 2480365088276853 type: contact type: mixed staffEachDay: false status: A type: staffSchedule - accountId: 1536846672691202 calendarId: 2481052283043883 createdDate: '2023-02-22T17:45:24Z' createdId: 585800790048776 createdName: Ajay Goel id: 2481052283043889 lastModifiedDate: '2023-02-22T17:45:24Z' lastModifiedId: 585800790048776 lastModifiedName: Ajay Goel minStaff: 0 name: 'Offshore Manager ' onCallReminder: enabled: false organizationId: 1536984111644674 recurrence: datesApplicable: from: '2023-02-22' everyNRecurrence: 1 type: periodic resourceBundleId: 1536984111644675 seq: 0 sequencingOverrideAllowed: true shiftScheduleId: 2481052283043890 staffAssignments: - days: - 1 - 2 - 3 - 4 - 5 - 6 - 7 ids: [] type: mixed staffEachDay: false status: A type: staffSchedule pageSize: 20 totalCount: 3 totalPageCount: 1 schema: $ref: '#/components/schemas/listStaffSchedules' description: Model security: - BasicAuth: [] - API_Authorizer: [] - api_key: [] summary: List Staff Schedules tags: - Scheduling x-amazon-apigateway-integration: httpMethod: GET passthroughBehavior: when_no_match requestParameters: integration.request.path.organizationId: method.request.path.organizationId responses: default: statusCode: '200' type: http_proxy uri: https://ebs-restapi-prod-us.evbg.io/rest/scheduling/{organizationId}/staffSchedules post: operationId: EBS Create Staff Schedule parameters: - description: The id of the Organization that owns this resource in: path name: organizationId required: true schema: $ref: '#/components/schemas/organizationId' requestBody: content: application/json: examples: Create Staff Schedule [Different Staff on Different Days]: summary: Create Staff Schedule [Different Staff on Different Days] value: data: escalationOption: none minStaff: 1 name: Pre Test onCallReminder: enabled: false recurrence: datesApplicable: from: '2024-10-13' to: '2024-09-30' everyNRecurrence: '2' type: periodic shiftScheduleId: 1166823965852239 staffAssignments: - days: - '1' ids: - id: 281616710713090 type: contact - id: 281616710713091 type: contact type: mixed - days: - '2' ids: - id: '9004729648556214' type: contact type: mixed - days: - '3' ids: - id: 281616710713091 type: contact type: mixed - days: - '4' ids: - id: 281616710713090 type: contact - id: 281616710713091 type: contact type: mixed - days: - '5' ids: - id: '9004729648556213' type: contact type: mixed - days: - '6' ids: - id: 281616710713090 type: contact - id: 281616710713091 type: contact type: mixed - days: - '7' ids: - id: 281616710713090 type: contact - id: 281616710713091 type: contact type: mixed staffEachDay: true staffRotation: null Create Staff Schedule [No End Date]: summary: No End Date value: data: name: Pre Test recurrence: datesApplicable: from: '2024-09-24' type: periodic shiftScheduleId: 2517402201882625 staffAssignments: - days: - 1 - 2 - 3 - 4 - 5 - 6 - 7 ids: - id: '2414322986778856' type: contact type: mixed 'Create Staff Schedule [Non Repeating]: All days of the week': summary: 'Create Staff Schedule [Non Repeating]: All days of the week' value: data: name: Pre Test recurrence: datesApplicable: from: '2024-09-24' to: '2024-09-30' type: repeat shiftScheduleId: 2517402201882625 staffAssignments: - ids: - id: '2451915224907929' type: group type: mixed Create Staff Schedule [Repeating Every N Weeks]: summary: Create Staff Schedule [Repeating Every N Weeks] value: data: name: Pre Test recurrence: datesApplicable: from: '2024-09-24' to: '2024-09-30' everyNRecurrence: 3 type: periodic shiftScheduleId: 2517402201882625 staffAssignments: - days: - 1 - 2 - 3 - 4 - 5 - 6 - 7 ids: - id: '2414322986778856' type: contact type: mixed Create Staff Schedule [With Contacts & Groups]: summary: Create Staff Schedule [With Contacts & Groups] value: data: name: Pre Test recurrence: datesApplicable: from: '2024-09-24' to: '2024-09-30' type: periodic shiftScheduleId: 2517402201882625 staffAssignments: - days: - 1 - 2 - 3 - 4 - 5 - 6 - 7 ids: - id: '2414322986778856' type: contact - id: '2451915224907929' type: group type: mixed Create Staff Schedule [With Contacts]: summary: With Contacts value: data: name: Pre Test recurrence: datesApplicable: from: '2024-09-24' to: '2024-09-30' type: periodic shiftScheduleId: 2517402201882625 staffAssignments: - days: - 1 - 2 - 3 - 4 - 5 - 6 - 7 ids: - id: '2414322986778856' type: contact type: mixed Create Staff Schedule [With Groups]: summary: With Groups value: data: name: Pre Test recurrence: datesApplicable: from: '2024-09-24' to: '2024-09-30' type: periodic shiftScheduleId: 2517402201882625 staffAssignments: - days: - 1 - 2 - 3 - 4 - 5 - 6 - 7 ids: - id: '2451915224907929' type: group type: mixed Create Staff Schedule [With Minimum Staff requirement]: summary: Create Staff Schedule [With Minimum Staff requirement] value: data: minStaff: 1 name: Pre Test recurrence: datesApplicable: from: '2024-09-24' to: '2024-09-30' type: periodic shiftScheduleId: 2517402201882625 staffAssignments: - days: - 1 - 2 - 3 - 4 - 5 - 6 - 7 ids: - id: '2414322986778856' type: contact type: mixed schema: $ref: '#/components/schemas/createStaffSchedule' required: true responses: '200': content: application/json: examples: Response Model: summary: Response Model value: data: accountId: 1536846672691202 calendarId: 2481052283043883 createdDate: '2024-09-24T07:21:55Z' createdId: 2200330536222721 createdName: Nandish API Access id: 2514825221505026 lastModifiedDate: '2024-09-24T07:21:55Z' lastModifiedId: 2200330536222721 lastModifiedName: Nandish API Access minStaff: 0 name: From API4 onCallReminder: enabled: false organizationId: 1536984111644674 recurrence: datesApplicable: from: '2023-02-23' everyNRecurrence: 1 type: periodic resourceBundleId: 1536984111644675 seq: 0 sequencingOverrideAllowed: true shiftScheduleId: 2496030444617731 staffAssignments: - days: - 1 ids: - id: 2480365088276853 type: contact type: mixed staffEachDay: false status: A type: staffSchedule schema: $ref: '#/components/schemas/staffSchedule' description: Model security: - BasicAuth: [] - API_Authorizer: [] - api_key: [] summary: Create Staff Schedule tags: - Scheduling x-amazon-apigateway-integration: httpMethod: POST passthroughBehavior: when_no_match requestParameters: integration.request.path.organizationId: method.request.path.organizationId responses: default: statusCode: '200' type: http_proxy uri: https://ebs-restapi-prod-us.evbg.io/rest/scheduling/{organizationId}/staffSchedules servers: - url: https://api.everbridge.net/rest - url: https://api.everbridge.eu/rest /scheduling/{organizationId}/staffSchedules/{ids}: delete: operationId: EBS Delete Staff Schedules parameters: - description: The id of the Organization that owns this resource in: path name: organizationId required: true schema: $ref: '#/components/schemas/organizationId' - description: The id or ids (comma delimited) of the resources to delete in: path name: ids required: true schema: type: string responses: '200': content: application/json: examples: Multiple Staff Schedule: summary: Multiple Staff Schedule value: currentPageNo: 1 data: - accountId: 1536846672691202 calendarId: 2342511133589505 createdDate: '2024-06-04T06:34:47Z' createdId: 2200330536222721 createdName: Nandish API Access escalationOption: none id: 2342511133589505 lastModifiedDate: '2024-06-04T06:34:47Z' lastModifiedId: 2200330536222721 lastModifiedName: Nandish API Access minStaff: 1 name: PRE Test onCallReminder: enabled: false organizationId: 1536984111644674 recurrence: datesApplicable: from: '2024-06-04' to: '2024-06-05' everyNRecurrence: 1 type: periodic resourceBundleId: 1536984111644675 seq: 0 sequencingOverrideAllowed: true shiftScheduleId: 2342511133589505 staffAssignments: - days: - 1 - 2 - 3 - 4 - 5 - 6 - 7 ids: - id: 2480365088276853 type: contact type: mixed staffEachDay: false status: A type: staffSchedule - accountId: 1536846672691202 calendarId: 2343267047833601 createdDate: '2024-06-04T10:26:33Z' createdId: 2200330536222721 createdName: Nandish API Access escalationOption: none id: 2343267047833601 lastModifiedDate: '2024-06-04T10:34:37Z' lastModifiedId: 2200330536222721 lastModifiedName: Nandish API Access minStaff: 0 name: PRE Test111 onCallReminder: enabled: false organizationId: 1536984111644674 recurrence: datesApplicable: from: '2024-06-03' everyNRecurrence: 1 type: periodic seq: 0 sequencingOverrideAllowed: true shiftScheduleId: 2343267047833601 staffAssignments: - days: - 1 - 2 - 3 - 4 - 5 - 6 - 7 ids: - id: 2480365088276853 type: contact type: mixed staffEachDay: false status: A type: staffSchedule pageSize: 20 totalCount: 2 totalPageCount: 1 Success Operation: summary: Success Operation value: data: accountId: 1536846672691202 calendarId: 2481052283043883 createdDate: '2024-09-24T07:19:41Z' createdId: 2200330536222721 createdName: Nandish API Access id: 2514825221505025 lastModifiedDate: '2024-09-24T07:19:41Z' lastModifiedId: 2200330536222721 lastModifiedName: Nandish API Access minStaff: 0 name: From API4 onCallReminder: enabled: false organizationId: 1536984111644674 recurrence: datesApplicable: from: '2023-02-23' everyNRecurrence: 1 type: periodic resourceBundleId: 1536984111644675 seq: 0 sequencingOverrideAllowed: true shiftScheduleId: 2496030444617731 staffAssignments: - days: - 1 ids: - id: 2480365088276853 type: contact type: mixed staffEachDay: false status: A type: staffSchedule schema: oneOf: - $ref: '#/components/schemas/listStaffSchedules' - $ref: '#/components/schemas/staffSchedule' description: Successful Operation security: - BasicAuth: [] - API_Authorizer: [] - api_key: [] summary: Delete Staff Schedules tags: - Scheduling x-amazon-apigateway-integration: httpMethod: DELETE passthroughBehavior: when_no_match requestParameters: integration.request.path.ids: method.request.path.ids integration.request.path.organizationId: method.request.path.organizationId responses: default: statusCode: '200' type: http_proxy uri: https://ebs-restapi-prod-us.evbg.io/rest/scheduling/{organizationId}/staffSchedules/{ids} get: description: Get one or more Staff Schedules operationId: EBS Get Staff Schedules parameters: - description: The id of the Organization that owns this resource in: path name: organizationId required: true schema: $ref: '#/components/schemas/organizationId' - description: The id or ids (comma delimited) of the resources to find in: path name: ids required: true schema: type: string - description:fields to be included in the response.
fields[resourceName] may be used to specify fields returned for included documents. When doing so, it is not necessary to also request to include the resource as the include is implied by the fields request
in: query name: fields required: false schema: type: string - description:Specifying the includes parameter will result in a compound document response, adding resources to included which have been referenced by resources returned in data.
include may be specified as a comma delimited list of resource names.
in: query name: include required: false schema: enum: - calendar - shiftSchedule - contact - group type: string responses: '200': content: application/json: examples: Multiple Staff Schedule: summary: Multiple Staff Schedule value: currentPageNo: 1 data: - accountId: 1536846672691202 calendarId: 2342511133589505 createdDate: '2024-06-04T06:34:47Z' createdId: 2200330536222721 createdName: Nandish API Access escalationOption: none id: 2342511133589505 lastModifiedDate: '2024-06-04T06:34:47Z' lastModifiedId: 2200330536222721 lastModifiedName: Nandish API Access minStaff: 1 name: PRE Test onCallReminder: enabled: false organizationId: 1536984111644674 recurrence: datesApplicable: from: '2024-06-04' to: '2024-06-05' everyNRecurrence: 1 type: periodic resourceBundleId: 1536984111644675 seq: 0 sequencingOverrideAllowed: true shiftScheduleId: 2342511133589505 staffAssignments: - days: - 1 - 2 - 3 - 4 - 5 - 6 - 7 ids: - id: 2480365088276853 type: contact type: mixed staffEachDay: false status: A type: staffSchedule - accountId: 1536846672691202 calendarId: 2343267047833601 createdDate: '2024-06-04T10:26:33Z' createdId: 2200330536222721 createdName: Nandish API Access escalationOption: none id: 2343267047833601 lastModifiedDate: '2024-06-04T10:34:37Z' lastModifiedId: 2200330536222721 lastModifiedName: Nandish API Access minStaff: 0 name: PRE Test111 onCallReminder: enabled: false organizationId: 1536984111644674 recurrence: datesApplicable: from: '2024-06-03' everyNRecurrence: 1 type: periodic seq: 0 sequencingOverrideAllowed: true shiftScheduleId: 2343267047833601 staffAssignments: - days: - 1 - 2 - 3 - 4 - 5 - 6 - 7 ids: - id: 2480365088276853 type: contact type: mixed staffEachDay: false status: A type: staffSchedule pageSize: 20 totalCount: 2 totalPageCount: 1 Single Staff Schedule: summary: Single Staff Schedule value: data: accountId: 1536846672691202 calendarId: 2481052283043883 createdDate: '2024-09-24T07:19:41Z' createdId: 2200330536222721 createdName: Nandish API Access id: 2514825221505025 lastModifiedDate: '2024-09-24T07:19:41Z' lastModifiedId: 2200330536222721 lastModifiedName: Nandish API Access minStaff: 0 name: From API4 onCallReminder: enabled: false organizationId: 1536984111644674 recurrence: datesApplicable: from: '2023-02-23' everyNRecurrence: 1 type: periodic resourceBundleId: 1536984111644675 seq: 0 sequencingOverrideAllowed: true shiftScheduleId: 2496030444617731 staffAssignments: - days: - 1 ids: - id: 2480365088276853 type: contact type: mixed staffEachDay: false status: A type: staffSchedule schema: oneOf: - $ref: '#/components/schemas/listStaffSchedules' - $ref: '#/components/schemas/staffSchedule' description: Successful Operation security: - BasicAuth: [] - API_Authorizer: [] - api_key: [] summary: Get Staff Schedules tags: - Scheduling x-amazon-apigateway-integration: httpMethod: GET passthroughBehavior: when_no_match requestParameters: integration.request.path.ids: method.request.path.ids integration.request.path.organizationId: method.request.path.organizationId responses: default: statusCode: '200' type: http_proxy uri: https://ebs-restapi-prod-us.evbg.io/rest/scheduling/{organizationId}/staffSchedules/{ids} put: description: Update one or more Staff Schedules operationId: EBS Update Staff Schedules parameters: - description: The id of the Organization that owns this resource in: path name: organizationId required: true schema: $ref: '#/components/schemas/organizationId' - description: The id or ids (comma delimmited) of the resources to update in: path name: ids required: true schema: type: string requestBody: content: application/json: examples: Add additional Contacts/Groups: summary: Add additional Contacts/Groups value: data: staffAssignments: - days: - 1 - 2 - 3 - 4 ids: - id: 281616710713090 type: contact - id: 281616710713092 type: contact - id: 281616710652429 type: group type: mixed Change Minimum Staff requirement For Staff Schedule: summary: Change Minimum Staff requirement For Staff Schedule value: data: minStaff: 3 Change Staff Schedule days: summary: Change Staff Schedule days value: data: staffAssignments: - days: - 1 - 2 - 3 - 4 type: mixed Update Repeat schedule for specific weeks: summary: Update Repeat schedule for specific weeks value: data: recurrence: everyNRecurrence: 2 type: periodic Update Staff Schedule Name: summary: Update Name value: data: name: Pre Test 4 Update Staff Schedule Start & End Date: summary: Update Start & End Date value: data: recurrence: datesApplicable: from: '2024-10-15' to: '2024-10-20' type: periodic schema: $ref: '#/components/schemas/updateStaffSchedule' required: true responses: '200': content: application/json: examples: Multiple Staff Schedule: summary: Multiple Staff Schedule value: currentPageNo: 1 data: - accountId: 1536846672691202 calendarId: 2342511133589505 createdDate: '2024-06-04T06:34:47Z' createdId: 2200330536222721 createdName: Nandish API Access escalationOption: none id: 2342511133589505 lastModifiedDate: '2024-06-04T06:34:47Z' lastModifiedId: 2200330536222721 lastModifiedName: Nandish API Access minStaff: 1 name: PRE Test onCallReminder: enabled: false organizationId: 1536984111644674 recurrence: datesApplicable: from: '2024-06-04' to: '2024-06-05' everyNRecurrence: 1 type: periodic resourceBundleId: 1536984111644675 seq: 0 sequencingOverrideAllowed: true shiftScheduleId: 2342511133589505 staffAssignments: - days: - 1 - 2 - 3 - 4 - 5 - 6 - 7 ids: - id: 2480365088276853 type: contact type: mixed staffEachDay: false status: A type: staffSchedule - accountId: 1536846672691202 calendarId: 2343267047833601 createdDate: '2024-06-04T10:26:33Z' createdId: 2200330536222721 createdName: Nandish API Access escalationOption: none id: 2343267047833601 lastModifiedDate: '2024-06-04T10:34:37Z' lastModifiedId: 2200330536222721 lastModifiedName: Nandish API Access minStaff: 0 name: PRE Test111 onCallReminder: enabled: false organizationId: 1536984111644674 recurrence: datesApplicable: from: '2024-06-03' everyNRecurrence: 1 type: periodic seq: 0 sequencingOverrideAllowed: true shiftScheduleId: 2343267047833601 staffAssignments: - days: - 1 - 2 - 3 - 4 - 5 - 6 - 7 ids: - id: 2480365088276853 type: contact type: mixed staffEachDay: false status: A type: staffSchedule pageSize: 20 totalCount: 2 totalPageCount: 1 Success Operation: summary: Success Operation value: data: accountId: 1536846672691202 calendarId: 2481052283043883 createdDate: '2024-09-24T07:19:41Z' createdId: 2200330536222721 createdName: Nandish API Access id: 2514825221505025 lastModifiedDate: '2024-09-24T07:19:41Z' lastModifiedId: 2200330536222721 lastModifiedName: Nandish API Access minStaff: 0 name: From API4 onCallReminder: enabled: false organizationId: 1536984111644674 recurrence: datesApplicable: from: '2023-02-23' everyNRecurrence: 1 type: periodic resourceBundleId: 1536984111644675 seq: 0 sequencingOverrideAllowed: true shiftScheduleId: 2496030444617731 staffAssignments: - days: - 1 ids: - id: 2480365088276853 type: contact type: mixed staffEachDay: false status: A type: staffSchedule schema: oneOf: - $ref: '#/components/schemas/listStaffSchedules' - $ref: '#/components/schemas/staffSchedule' description: Successful Operation security: - BasicAuth: [] - API_Authorizer: [] - api_key: [] summary: Update Staff Schedules tags: - Scheduling x-amazon-apigateway-integration: httpMethod: PUT passthroughBehavior: when_no_match requestParameters: integration.request.path.ids: method.request.path.ids integration.request.path.organizationId: method.request.path.organizationId responses: default: statusCode: '200' type: http_proxy uri: https://ebs-restapi-prod-us.evbg.io/rest/scheduling/{organizationId}/staffSchedules/{ids} servers: - url: https://api.everbridge.net/rest - url: https://api.everbridge.eu/rest /scheduling/{organizationId}/substitutions: get: description: List scheduling substitutions (Unavailable/Replacement) operationId: EBS List Scheduling Substitutions parameters: - description: The id of the Organization that owns this resource in: path name: organizationId required: true schema: $ref: '#/components/schemas/organizationId' - description:fields to be included in the response.
fields[resourceName] may be used to specify fields returned for included documents. When doing so, it is not necessary to also request to include the resource as the include is implied by the fields request
in: query name: fields required: false schema: type: string - description:Specifying the includes parameter will result in a compound document response, adding resources to included which have been referenced by resources returned in data.
include may be specified as a comma delimited list of resource names.
in: query name: include required: false schema: enum: - calendar - contact type: string - description:filter may be used to specify filter criteria for the request.
filters are specified in the format of filter[fieldName], where fieldName is any field supported by this resource.
multiple filter criteria will result in AND conditions, with the exception of multiple filters on the same field, in which case the criteria will be treated as an OR condition
in: query name: filter required: false schema: type: string - description:Comma delimited list of fields to sort by.
+/- can precede the field name to indicate direction (ascending/descending).
+ is the default direction
Ex. sort=status,-createdDate sorts by status ascending and createdDate descending
in: query name: sort required: false schema: type: string - description: The number of records per page to be included in the response in: query name: pageSize required: false schema: type: integer - description: The page to be returned. in: query name: pageNo required: false schema: type: integer responses: '200': content: '*/*': schema: type: string description: Successful Operation security: - BasicAuth: [] - API_Authorizer: [] - api_key: [] summary: List Scheduling Substitutions tags: - Scheduling x-amazon-apigateway-integration: httpMethod: GET passthroughBehavior: when_no_match requestParameters: integration.request.path.organizationId: method.request.path.organizationId responses: default: statusCode: '200' type: http_proxy uri: https://ebs-restapi-prod-us.evbg.io/rest/scheduling/{organizationId}/substitutions post: description: Create scheduling substitutions (Unavailable/Replacement) operationId: EBS Create Scheduling Substitutions parameters: - description: The id of the Organization that owns this resource in: path name: organizationId required: true schema: $ref: '#/components/schemas/organizationId' requestBody: content: application/json: examples: Make Contact Unavailable: summary: Make Contact Unavailable value: data: contactId: 2414322986778856 recurrence: datesApplicable: from: '2024-10-11' to: '2024-10-13' event: end: '2024-10-13T00:00:00' start: '2024-10-11T00:00:00' type: ical timeZoneString: America/Chicago Make Contact Unavailable & Substitute with another contact: summary: Make Contact Unavailable & Substitute with another contact value: data: contactId: 2413360914104548 recurrence: datesApplicable: from: '2024-10-24' to: '2024-10-25' event: end: '2024-10-25T00:00:00' start: '2024-10-24T00:00:00' type: ical staffAssignment: contactIds: - 2403465309454563 type: contact timeZoneString: America/Chicago schema: $ref: '#/components/schemas/CreateSubstitution' required: true responses: '200': content: application/json: examples: Successful Operation: summary: Successful Operation value: data: accountId: 1536846672691202 contactId: 2394256899571762 createdDate: '2024-10-16T13:44:03Z' createdId: 2200330536222721 createdName: Nandish API Access id: 2562860135743492 lastModifiedDate: '2024-10-16T13:44:03Z' lastModifiedId: 2200330536222721 lastModifiedName: Nandish API Access organizationId: 1536984111644674 recurrence: datesApplicable: from: '2024-10-24' to: '2024-10-25' event: end: '2024-10-25T00:00:00' start: '2024-10-24T00:00:00' type: ical resourceBundleId: 1536984111644675 staffAssignment: contactIds: - 2403465309454563 type: contact status: A timeZoneString: America/Chicago type: staffSubstitution schema: $ref: '#/components/schemas/substitution' description: Successful Operation security: - BasicAuth: [] - API_Authorizer: [] - api_key: [] summary: Create Scheduling Substitutions tags: - Scheduling x-amazon-apigateway-integration: httpMethod: POST passthroughBehavior: when_no_match requestParameters: integration.request.path.organizationId: method.request.path.organizationId responses: default: statusCode: '200' type: http_proxy uri: https://ebs-restapi-prod-us.evbg.io/rest/scheduling/{organizationId}/substitutions servers: - url: https://api.everbridge.net/rest - url: https://api.everbridge.eu/rest /scheduling/{organizationId}/substitutions/{ids}: delete: description: Delete scheduling substitutions (Unavailable/Replacement) operationId: EBS Delete Scheduling Substitutions parameters: - description: The id of the Organization that owns this resource in: path name: organizationId required: true schema: $ref: '#/components/schemas/organizationId' - description: The id or ids (comma delimmited) of the resources to delete in: path name: ids required: true schema: type: string responses: '200': content: '*/*': schema: type: string description: Successful Operation security: - BasicAuth: [] - API_Authorizer: [] - api_key: [] summary: Delete Scheduling Substitutions tags: - Scheduling x-amazon-apigateway-integration: httpMethod: DELETE passthroughBehavior: when_no_match requestParameters: integration.request.path.ids: method.request.path.ids integration.request.path.organizationId: method.request.path.organizationId responses: default: statusCode: '200' type: http_proxy uri: https://ebs-restapi-prod-us.evbg.io/rest/scheduling/{organizationId}/substitutions/{ids} get: description: Get a single substitution(s) (Unavailable/Replacement) operationId: EBS Get Scheduling Substitutions parameters: - description: The id of the Organization that owns this resource in: path name: organizationId required: true schema: $ref: '#/components/schemas/organizationId' - description: The id or ids (comma delimmited) of the resources to find in: path name: ids required: true schema: type: string - description:fields to be included in the response.
fields[resourceName] may be used to specify fields returned for included documents. When doing so, it is not necessary to also request to include the resource as the include is implied by the fields request
in: query name: fields required: false schema: type: string - description:Specifying the includes parameter will result in a compound document response, adding resources to included which have been referenced by resources returned in data.
include may be specified as a comma delimited list of resource names.
in: query name: include required: false schema: enum: - calendar - contact type: string responses: '200': content: '*/*': schema: type: string description: Successful Operation security: - BasicAuth: [] - API_Authorizer: [] - api_key: [] summary: Get Scheduling Substitutions tags: - Scheduling x-amazon-apigateway-integration: httpMethod: GET passthroughBehavior: when_no_match requestParameters: integration.request.path.ids: method.request.path.ids integration.request.path.organizationId: method.request.path.organizationId responses: default: statusCode: '200' type: http_proxy uri: https://ebs-restapi-prod-us.evbg.io/rest/scheduling/{organizationId}/substitutions/{ids} put: description: Update scheduling substitutions (Unavailable/Replacement) operationId: EBS Update Scheduling Substitutions parameters: - description: The id of the Organization that owns this resource in: path name: organizationId required: true schema: $ref: '#/components/schemas/organizationId' - description: The id or ids (comma delimmited) of the resources to update in: path name: ids required: true schema: type: string requestBody: content: application/json: examples: Change Substitute Contact: summary: Change Substitute Contact value: data: staffAssignment: contactIds: - 2403465309454563 type: contact Update Start Date/Time End Date/Time: summary: Update Start Date/Time End Date/Time value: data: recurrence: datesApplicable: from: '2024-10-12' to: '2024-10-14' event: end: '2024-10-13T00:00:00' start: '2024-10-11T00:00:00' type: ical Update Unavailable Contact: summary: Make Contact Unavailable value: data: contactId: 2395906167014109 schema: $ref: '#/components/schemas/UpdateSubstitution' required: true responses: '200': content: '*/*': schema: type: string description: Successful Operation security: - BasicAuth: [] - API_Authorizer: [] - api_key: [] summary: Update Scheduling Substitutions tags: - Scheduling x-amazon-apigateway-integration: httpMethod: PUT passthroughBehavior: when_no_match requestParameters: integration.request.path.ids: method.request.path.ids integration.request.path.organizationId: method.request.path.organizationId responses: default: statusCode: '200' type: http_proxy uri: https://ebs-restapi-prod-us.evbg.io/rest/scheduling/{organizationId}/substitutions/{ids} servers: - url: https://api.everbridge.net/rest - url: https://api.everbridge.eu/rest components: schemas: StaffingAssignment: type: object properties: type: type: string description: Staffing Assignment type contactIds: type: array description: Substitution Contact IDs items: type: integer description: Substitution Contact IDs format: int64 description: Staffing Assignment StaffSubstitutionV2BulkUpdateRequest: type: object properties: data: type: object additionalProperties: $ref: '#/components/schemas/StaffSubstitution' description: Data Recurrence: type: object properties: type: type: string description: Staffing Assignment type datesApplicable: $ref: '#/components/schemas/DatesApplicable' event: $ref: '#/components/schemas/Event' rrule: type: string description: Recurrence Rule description: Recurrence definition for substitution DatesApplicable: type: object properties: from: type: string description: Applicable dates start to: type: string description: Applicable dates end description: Applicable Date Range StaffSubstitution: required: - type type: object properties: type: type: string description: Staff Substitution type contactId: type: integer description: Contact ID format: int64 calendarId: type: integer description: Calendar ID format: int64 recurrence: $ref: '#/components/schemas/Recurrence' staffAssignment: $ref: '#/components/schemas/StaffingAssignment' timeZoneString: type: string description: Timezone description: Data Event: type: object properties: end: type: string description: Event end start: type: string description: Event start description: Event Time Range StaffSubstitutionV2BulkRequest: type: object properties: data: type: array description: Data items: $ref: '#/components/schemas/StaffSubstitution' shiftSchedulesRequest: properties: data: properties: calendarId: type: number colorIndicator: type: string datesApplicable: properties: from: type: string to: {} required: - from - to type: object groupId: type: number name: type: string numDays: type: number override: type: boolean schedule: items: properties: days: items: type: number type: array shift: properties: end: type: string start: type: string required: - start - end type: object type: type: string required: - days - type - shift type: object type: array sequenced: type: boolean staffTypeRequired: items: {} type: array timeZoneString: type: string weekStartsWith: type: string required: - name - calendarId - timeZoneString - datesApplicable type: object required: - data type: object CreateSubstitution: properties: data: properties: contactId: type: number recurrence: properties: datesApplicable: properties: from: type: string to: type: string required: - from - to type: object event: properties: end: type: string start: type: string required: - end - start type: object type: type: string required: - type - datesApplicable - event type: object staffAssignment: properties: contactIds: items: type: number type: array type: type: string required: - type - contactIds type: object timeZoneString: type: string required: - contactId - recurrence - timeZoneString type: object required: - data type: object shiftSchedules: properties: currentPageNo: type: integer data: items: properties: accountId: type: integer calendarId: type: integer colorIndicator: type: string createdDate: type: string createdId: type: integer createdName: type: string datesApplicable: properties: from: type: string type: object groupId: type: string id: type: integer lastModifiedDate: type: string lastModifiedId: type: integer lastModifiedName: type: string name: type: string numDays: type: integer organizationId: type: integer override: type: boolean resourceBundleId: type: integer schedule: items: properties: days: items: type: integer type: array shift: properties: end: type: string start: type: string type: object type: type: string type: object type: array sequenced: type: boolean shiftTimeZoneString: type: string staffTypeRequired: items: items: {} type: array status: type: string timeZoneString: type: string type: type: string weekStartsWith: type: string type: object type: array pageSize: type: integer totalCount: type: integer totalPageCount: type: integer type: object FlatAssignmentReplacement: properties: replacedContactId: format: int64 type: integer replacementPeriod: $ref: '#/components/schemas/ZonedDateTimeRange' staffSubstitutionId: format: int64 type: integer type: object FlatAssignmentUnavailability: properties: period: $ref: '#/components/schemas/ZonedDateTimeRange' replacedById: format: int64 type: integer staffSubstitutionId: format: int64 type: integer type: object ZonedDateTimeRange: properties: from: format: date-time type: string to: format: date-time type: string type: object UpdateSubstitution: properties: data: properties: contactId: type: number recurrence: properties: datesApplicable: properties: from: type: string to: type: string type: object event: properties: end: type: string start: type: string type: object type: type: string type: object staffAssignment: properties: contactIds: items: type: number type: array type: type: string type: object timeZoneString: type: string type: object required: - data type: object substitution: properties: data: properties: accountId: type: number contactId: type: number createdDate: type: string createdId: type: number createdName: type: string id: type: number lastModifiedDate: type: string lastModifiedId: type: number lastModifiedName: type: string organizationId: type: number recurrence: properties: datesApplicable: properties: from: type: string to: type: string type: object event: properties: end: type: string start: type: string type: object type: type: string type: object resourceBundleId: type: number staffAssignment: properties: contactIds: items: type: number type: array type: type: string type: object status: type: string timeZoneString: type: string type: type: string type: object type: object calendar: properties: data: properties: accountId: type: integer active: type: boolean createdDate: type: string createdId: type: integer createdName: type: string emailNotificationEnabled: type: boolean externalId: type: string id: type: integer lastModifiedDate: type: string lastModifiedId: type: integer lastModifiedName: type: string name: type: string notifyScheduled: type: boolean onCallReminder: properties: enabled: type: boolean type: object organizationId: type: integer resourceBundleId: type: integer status: type: string type: type: string visibility: type: string type: object type: object createStaffSchedule: properties: data: properties: calendarId: type: number minStaff: type: number name: type: string recurrence: properties: datesApplicable: properties: from: type: string to: type: string required: - from type: object everyNRecurrence: type: number type: type: string required: - type - datesApplicable type: object seq: type: number shiftScheduleId: type: number staffAssignments: items: properties: days: items: type: number type: array ids: items: properties: id: type: number type: type: string required: - id - type type: object type: array type: type: string required: - type - days - ids type: object type: array staffEachDay: type: boolean status: type: string type: type: string required: - name - recurrence - shiftScheduleId - staffAssignments type: object required: - data type: object listCalendars: properties: currentPageNo: type: integer data: items: properties: accountId: type: integer active: type: boolean createdDate: type: string createdId: type: integer createdName: type: string emailNotificationEnabled: type: boolean externalId: type: string id: type: integer lastModifiedDate: type: string lastModifiedId: type: integer lastModifiedName: type: string name: type: string notifyScheduled: type: boolean onCallReminder: properties: enabled: type: boolean type: object organizationId: type: integer resourceBundleId: type: integer status: type: string type: type: string visibility: type: string type: object type: array pageSize: type: integer totalCount: type: integer totalPageCount: type: integer type: object listStaffSchedules: properties: currentPageNo: type: number data: items: properties: accountId: type: number calendarId: type: number createdDate: type: string createdId: type: number createdName: type: string escalationOption: type: string id: type: number lastModifiedDate: type: string lastModifiedId: type: number lastModifiedName: type: string minStaff: type: number name: type: string onCallReminder: properties: enabled: type: boolean type: object organizationId: type: number recurrence: properties: datesApplicable: properties: from: type: string to: type: string type: object everyNRecurrence: type: number type: type: string type: object resourceBundleId: type: number seq: type: number sequencingOverrideAllowed: type: boolean shiftScheduleId: type: number staffAssignments: items: properties: days: items: type: number type: array ids: items: properties: id: type: number type: type: string type: object type: array type: type: string type: object type: array staffEachDay: type: boolean status: type: string type: type: string type: object type: array pageSize: type: number totalCount: type: number totalPageCount: type: number type: object FlatCalendarEvent: properties: assignments: items: $ref: '#/components/schemas/FlatAssignment' type: array uniqueItems: true calendarId: format: int64 type: integer end: format: date-time type: string id: type: string organizationId: format: int64 type: integer shiftScheduleId: format: int64 type: integer start: format: date-time type: string type: object shiftSubstitutionsRequest: properties: data: properties: recurrence: properties: datesApplicable: items: type: string type: array type: type: string required: - type - datesApplicable type: object shiftScheduleId: type: number staffAssignment: properties: contactIds: items: type: number type: array type: type: string required: - type - contactIds type: object required: - recurrence - shiftScheduleId - staffAssignment type: object required: - data type: object staffSchedule: properties: data: properties: accountId: type: number calendarId: type: number createdDate: type: string createdId: type: number createdName: type: string id: type: number lastModifiedDate: type: string lastModifiedId: type: number lastModifiedName: type: string minStaff: type: number name: type: string onCallReminder: properties: enabled: type: boolean required: - enabled type: object organizationId: type: number recurrence: properties: datesApplicable: properties: from: type: string required: - from type: object everyNRecurrence: type: number type: type: string required: - type - datesApplicable - everyNRecurrence type: object resourceBundleId: type: number seq: type: number sequencingOverrideAllowed: type: boolean shiftScheduleId: type: number staffAssignments: items: properties: days: items: type: number type: array ids: items: properties: id: type: number type: type: string required: - id - type type: object type: array type: type: string required: - type - days - ids type: object type: array staffEachDay: type: boolean status: type: string type: type: string required: - id - type - accountId - calendarId - createdDate - createdId - createdName - lastModifiedDate - lastModifiedId - lastModifiedName - minStaff - name - onCallReminder - organizationId - recurrence - resourceBundleId - seq - sequencingOverrideAllowed - shiftScheduleId - staffAssignments - staffEachDay - status type: object required: - data type: object FlatAssignment: properties: contactId: format: int64 type: integer groupId: format: int64 type: integer replacements: items: $ref: '#/components/schemas/FlatAssignmentReplacement' type: array uniqueItems: true sequence: format: int32 type: integer shiftSubstitutionId: format: int64 type: integer staffLayerId: format: int64 type: integer unavailabilities: items: $ref: '#/components/schemas/FlatAssignmentUnavailability' type: array uniqueItems: true type: object updateStaffSchedule: properties: data: properties: calendarId: type: number minStaff: type: number name: type: string recurrence: properties: datesApplicable: properties: from: type: string to: type: string type: object everyNRecurrence: type: number type: type: string type: object seq: type: number shiftScheduleId: type: number staffAssignments: items: properties: days: items: type: number type: array ids: items: properties: id: type: number type: type: string type: object type: array type: type: string type: object type: array staffEachDay: type: boolean status: type: string type: type: string type: object required: - data type: object organizationId: default: '1536984111644674' description: Everbridge Organization id. Available on manager portal (Settings --> Organization --> Base Information) example: '1536984111644674' maxLength: 16 type: integer schedulingAudits: properties: currentPageNo: type: number data: items: properties: accountId: type: number action: type: string auditResource: properties: id: type: string minStaff: type: number name: type: string onCallReminder: properties: enabled: type: boolean type: object recurrence: properties: datesApplicable: properties: from: type: string to: type: string type: object everyNRecurrence: type: number type: type: string type: object sequencingOverrideAllowed: type: boolean staffAssignments: items: properties: days: items: type: number type: array ids: items: properties: id: type: number type: type: string type: object type: array type: type: string type: object type: array staffEachDay: type: boolean type: type: string type: object calendarId: type: number createdDate: type: string createdId: type: number createdName: type: string details: properties: assignments: properties: after: items: properties: days: items: type: number type: array type: object type: array before: items: properties: days: items: type: number type: array ids: items: properties: id: type: number type: type: string type: object type: array type: object type: array type: object name: properties: after: type: string before: type: string type: object recurrence: properties: after: properties: datesApplicable: properties: from: type: string to: type: string type: object everyNRecurrence: type: number type: type: string type: object before: properties: datesApplicable: properties: from: type: string type: object everyNRecurrence: type: number type: type: string type: object type: object type: object id: type: number includes: items: properties: firstName: type: string id: type: number lastName: type: string name: type: string numDays: type: number onCallReminder: properties: enabled: type: boolean type: object sequenced: type: boolean timeZoneString: type: string type: type: string weekStartsWith: type: string type: object type: array organizationId: type: number resourceBundleId: type: number shiftScheduleId: type: number staffScheduleId: type: number type: type: string type: object type: array pageSize: type: number totalCount: type: number totalPageCount: type: number type: object shiftSchedulesGetResponse: properties: currentPageNo: type: number data: items: properties: accountId: type: number calendarId: type: number colorIndicator: type: string createdDate: type: string createdId: type: number createdName: type: string datesApplicable: properties: from: type: string required: - from type: object id: type: number lastModifiedDate: type: string lastModifiedId: type: number lastModifiedName: type: string name: type: string organizationId: type: number resourceBundleId: type: number shiftTimeZoneString: type: string staffTypeRequired: items: {} type: array status: type: string timeZoneString: type: string type: type: string required: - id - type - accountId - calendarId - colorIndicator - createdDate - createdId - createdName - datesApplicable - lastModifiedDate - lastModifiedId - lastModifiedName - name - organizationId - resourceBundleId - shiftTimeZoneString - staffTypeRequired - status - timeZoneString type: object type: array pageSize: type: number totalCount: type: number totalPageCount: type: number required: - currentPageNo - totalPageCount - totalCount - pageSize - data type: object calendarObj: properties: data: properties: active: type: boolean emailNotificationEnabled: type: boolean emailNotificationList: items: type: string type: array externalId: type: string name: type: string notifyScheduled: type: boolean visibility: type: string type: object required: - data type: object shiftSchedulesCreateResponse: properties: data: properties: accountId: type: number calendarId: type: number colorIndicator: type: string createdDate: type: string createdId: type: number createdName: type: string datesApplicable: properties: from: type: string required: - from type: object id: type: number lastModifiedDate: type: string lastModifiedId: type: number lastModifiedName: type: string name: type: string numDays: type: number organizationId: type: number resourceBundleId: type: number schedule: items: properties: days: items: type: number type: array shift: properties: end: type: string start: type: string required: - end - start type: object type: type: string required: - type - days - shift type: object type: array sequenced: type: boolean status: type: string timeZoneString: type: string type: type: string weekStartsWith: type: string required: - id - type - accountId - calendarId - colorIndicator - createdDate - createdId - createdName - datesApplicable - lastModifiedDate - lastModifiedId - lastModifiedName - name - numDays - organizationId - resourceBundleId - schedule - sequenced - status - timeZoneString - weekStartsWith type: object required: - data type: object securitySchemes: API_Authorizer: type: apiKey name: Authorization in: header x-amazon-apigateway-authtype: custom x-amazon-apigateway-authorizer: authorizerUri: arn:aws:apigateway:us-east-1:lambda:path/2015-03-31/functions/arn:aws:lambda:us-east-1:214792946631:function:API_Authorizer_us-east-1_prod:live/invocations authorizerCredentials: arn:aws:iam::214792946631:role/ebs-mobile-member-api-prod-us-us-east-1-0-us-east-1-gw authorizerResultTtlInSeconds: 300 identitySource: method.request.header.Authorization,method.request.header.PathCacheKey,method.request.header.MethodCacheKey type: request BasicAuth: description: Basic Authentication Token scheme: basic type: http api_key: description: API Key - For System Use in: header name: x-api-key type: apiKey x-refined-from: - everbridge-digital-apps-openapi.json - everbridge-eb-suite-openapi.json x-readme: explorer-enabled: true proxy-enabled: true