openapi-directory/api/exhibitday.com.json

Building & bundling https://github.com/APIs-guru/openapi-directory for easy use from JS

{"openapi":"3.0.0","info":{"description":"This API can be used to programmatically pull data out of ExhibitDay or push data into ExhibitDay -- allowing for automation between ExhibitDay and your internal systems (or other third-party software). To use the API, you'll need working knowledge of consuming REST APIs.<br /><br />Docs: https://api.exhibitday.com/swagger/docs/v1","title":"Test the ExhibitDay API with Swagger","version":"v1","x-apisguru-categories":["project_management"],"x-logo":{"url":"https://api.exhibitday.com/exhibitday-logo-small.png"},"x-origin":[{"format":"swagger","url":"https://api.exhibitday.com/swagger/docs/v1","version":"2.0"}],"x-providerName":"exhibitday.com"},"paths":{"/api/docs/Swagger":{"get":{"operationId":"Swagger_Get","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object"}},"text/json":{"schema":{"type":"object"}},"application/xml":{"schema":{"type":"object"}},"text/xml":{"schema":{"type":"object"}}}}},"tags":["Swagger"]}},"/v1/events/":{"delete":{"description":"Delete an Event","operationId":"events__3_delete","parameters":[{"in":"header","name":"api_key","required":true,"schema":{"type":"string","format":"string"}},{"description":"The id of the event you would like to delete.","in":"header","name":"id","required":true,"schema":{"type":"number","format":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"string"}}}}},"tags":["events"]},"get":{"description":"Retrieve Events","operationId":"events__0_get","parameters":[{"description":"","in":"header","name":"api_key","required":true,"schema":{"type":"string","format":"string"}},{"description":"Only include events that have the given text in the event Name. For example: If you want to retrieve all the events that have the word “International” in the event Name field, pass in the value “International” for the filter_by_event_name_contains_text parameter. Note: this text search is not case-sensitive.","in":"header","name":"filter_by_event_name_contains_text","required":false,"schema":{"type":"string","format":"string"}},{"description":"Only include events that have their start date greater than or equal to the value passed in for this filter parameter. Use this date format: YYYY-MM-DD","in":"header","name":"filter_by_start_date_greater_than_or_equal_to","required":false,"schema":{"type":"string","format":"date"}},{"description":"Only include events that have their start date smaller than or equal to the value passed in for this filter parameter. Use this date format: YYYY-MM-DD","in":"header","name":"filter_by_start_date_smaller_than_or_equal_to","required":false,"schema":{"type":"string","format":"date"}},{"description":"Only include events that have their end date greater than or equal to the value passed in for this filter parameter. Use this date format: YYYY-MM-DD","in":"header","name":"filter_by_end_date_greater_than_or_equal_to","required":false,"schema":{"type":"string","format":"date"}},{"description":"Only include events that have their end date smaller than or equal to the value passed in for this filter parameter. Use this date format: YYYY-MM-DD","in":"header","name":"filter_by_end_date_smaller_than_or_equal_to","required":false,"schema":{"type":"string","format":"date"}},{"description":"Only include events that have their participation_type_id equal to the value passed in for this filter parameter. To get a list of available event Participation Type Ids in your workspace, refer to this endpoint: /v1/references/event_participation_types","in":"header","name":"filter_by_event_participation_type_id","required":false,"schema":{"type":"number","format":"string"}},{"description":"Only include events that have their format_id equal to the value passed in for this filter parameter. The following integer values are accepted (1 for In-Person, 2 for Virtual, 3 for Hybrid)","in":"header","name":"filter_by_event_format_id","required":false,"schema":{"type":"number","format":"string"}},{"description":"Only include events that have their star rating equal to the value passed in for this filter parameter. The following integer values are accepted: 0, 1, 2, 3","in":"header","name":"filter_by_event_star_rating","required":false,"schema":{"type":"number","format":"string"}},{"description":"Only include events that have this tag. For example, you can use this filter to get all the events that have the tag “International”. Note: You can only pass in one tag to filter based on.","in":"header","name":"filter_by_event_tag","required":false,"schema":{"type":"string","format":"string"}},{"description":"This is a special filter that lets you filter down your events based on a value of a Custom Text field or a Custom Dropdown field under the Event Information tab, Event Booth tab, or the Special Event tab. To use this filter, you’ll need the field name for the custom text field or custom dropdown field. You can obtain a list of field names for custom event fields in your workspace from the following endpoint: /v1/references/event_custom_fields. For example, if you have configured a custom dropdown field called “Region” under the Event information tab, and its field name is “custom_123456” and you would like to filter your events to include only ones that have “Northeast” selected for that custom dropdown field, pass in “filter_by_custom_event_field__custom_123456” as the parameter name and “Northeast” as its parameter value. Note: You can only filter down based on one custom event field (and it has to be either a custom text field or a custom dropdown field).","in":"query","name":"filter_by_custom_event_field__custom_NNNNNN","required":false,"schema":{"type":"string","format":"string"}},{"description":"Only include events that have their integration_metadata_field_1 property equal to the value you pass in for this parameter. Note: An event's integration_metadata_field_1 property is an integration-specific text field only accessible via the ExhibitDay API. This field is typically used to store metadata or information about a particular event (e.g., the \"external id\" of the event from another system you're integrating with).","in":"query","name":"filter_by_integration_metadata_field_1","required":false,"schema":{"type":"string","format":"string"}},{"description":"Only include events that have their integration_metadata_field_2 property equal to the value you pass in for this parameter. Note: An event's integration_metadata_field_2 property is an integration-specific text field only accessible via the ExhibitDay API. This field is typically used to store metadata or information about a particular event (e.g., the \"external id\" of the event from another system you're integrating with).","in":"query","name":"filter_by_integration_metadata_field_2","required":false,"schema":{"type":"string","format":"string"}},{"description":"Only include events that have their integration_metadata_field_3 property equal to the value you pass in for this parameter. Note: An event's integration_metadata_field_3 property is an integration-specific text field only accessible via the ExhibitDay API. This field is typically used to store metadata or information about a particular event (e.g., the \"external id\" of the event from another system you're integrating with).","in":"query","name":"filter_by_integration_metadata_field_3","required":false,"schema":{"type":"string","format":"string"}},{"description":"Only include events that have their integration_metadata_field_4 property equal to the value you pass in for this parameter. Note: An event's integration_metadata_field_4 property is an integration-specific text field only accessible via the ExhibitDay API. This field is typically used to store metadata or information about a particular event (e.g., the \"external id\" of the event from another system you're integrating with).","in":"query","name":"filter_by_integration_metadata_field_4","required":false,"schema":{"type":"string","format":"string"}},{"description":"Only include events that have their integration_metadata_field_5 property equal to the value you pass in for this parameter. Note: An event's integration_metadata_field_5 property is an integration-specific text field only accessible via the ExhibitDay API. This field is typically used to store metadata or information about a particular event (e.g., the \"external id\" of the event from another system you're integrating with).","in":"query","name":"filter_by_integration_metadata_field_5","required":false,"schema":{"type":"string","format":"string"}},{"description":"Include the tasks collection for each event in the result set. Note: hydrating the task collection for each event in the results will naturally yield a larger response size and response time. Set the value for this parameter to true only if you need to include the list of tasks for each event in the result set.","in":"header","name":"hydrate_tasks","required":false,"schema":{"type":"string","format":"string","default":"false"}},{"description":"Include the list of available task sections for each event in the result set. Note: hydrating the event task section collection for each event in the results will naturally yield a larger response size and response time. Set the value for this parameter to true only if you need to include the list of task sections for each event in the result set.","in":"header","name":"hydrate_task_sections_list","required":false,"schema":{"type":"string","format":"string","default":"false"}},{"description":"Include the event custom fields (i.e. custom fields that have been added to your workspace) for each event in the result set. Note: hydrating the event custom field collection for each event in the results will naturally yield a larger response size and response time. Set the value for this parameter to true only if you need to include the custom field values for each event in the result set.","in":"header","name":"hydrate_custom_fields","required":false,"schema":{"type":"string","format":"string","default":"false"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"string"}}}}},"tags":["events"]},"patch":{"description":"Update an Event","operationId":"events__2_patch","parameters":[{"in":"header","name":"api_key","required":true,"schema":{"type":"string","format":"string"}},{"description":"The id of the event you would like to update.","in":"header","name":"id","required":true,"schema":{"type":"number","format":"string"}},{"description":"The name of the event.","in":"header","name":"name","required":false,"schema":{"type":"string","format":"string"}},{"description":"Event Start Date (format: YYYY-MM-DD). Must be smaller or equal to Event End Date.","in":"header","name":"start_date","required":false,"schema":{"type":"string","format":"date"}},{"description":"Event End Date (format: YYYY-MM-DD). Must be greater or equal to Event Start Date.","in":"header","name":"end_date","required":false,"schema":{"type":"string","format":"date"}},{"description":"Integer representing the participation_type_id for the event (1: Committed, 2: Considering, 3: Not Going). Note: you can use the following endpoint to retrieve a list of available participation_type_id's: /v1/references/event_participation_types","in":"header","name":"participation_type_id","required":false,"schema":{"type":"number","format":"string"}},{"description":"Integer representing the FormatId for the event (1 for In-Person, 2 for Virtual, 3 for Hybrid)","in":"header","name":"format_id","required":false,"schema":{"type":"number","format":"string"}},{"description":"Star Rating for the event (0, 1, 2, or 3).","in":"header","name":"star_rating","required":false,"schema":{"type":"number","format":"string"}},{"description":"URL of the event website. Must be a well-formed URL.","in":"query","name":"website_url","required":false,"schema":{"type":"string","format":"string"}},{"description":"The name of the venue for the event.","in":"query","name":"venue_name","required":false,"schema":{"type":"string","format":"string"}},{"description":"The size of your booth for the event.","in":"header","name":"booth_size","required":false,"schema":{"type":"number","format":"string"}},{"description":"Your booth number for the event.","in":"header","name":"booth_number","required":false,"schema":{"type":"number","format":"string"}},{"description":"Event Notes (under the Event Information tab). Only accepts plain text. Any html tags in the value you pass in will be stripped. New line characters will get replaced with a <br/> tag.","in":"query","name":"event_notes","required":false,"schema":{"type":"number","format":"string"}},{"description":"Booth Notes (under the event Booth tab). Only accepts plain text. Any html tags in the value you pass in will be stripped. New line characters will get replaced with a <br/> tag.","in":"query","name":"booth_notes","required":false,"schema":{"type":"number","format":"string"}},{"description":"Budget Notes (under the event Budget tab). Only accepts plain text. Any html tags in the value you pass in will be stripped. New line characters will get replaced with a <br/> tag.","in":"query","name":"budget_notes","required":false,"schema":{"type":"number","format":"string"}},{"description":"ROI Notes (under the event ROI tab). Only accepts plain text. Any html tags in the value you pass in will be stripped. New line characters will get replaced with a <br/> tag.","in":"query","name":"roi_notes","required":false,"schema":{"type":"number","format":"string"}},{"description":"A number (greater or equal to 0.00) that represents the budget for reserving the booth for the event.","in":"header","name":"budget_booth_reservation","required":false,"schema":{"type":"number","format":"string"}},{"description":"A number (greater or equal to 0.00) that represents the budget for all the booth services for the event.","in":"header","name":"budget_booth_services","required":false,"schema":{"type":"number","format":"string"}},{"description":"A number (greater or equal to 0.00) that represents the budget for event registration / attendee tickets.","in":"header","name":"budget_attendee_registrations","required":false,"schema":{"type":"number","format":"string"}},{"description":"A number (greater or equal to 0.00) that represents the budget for travel and lodging for the event.","in":"header","name":"budget_travel","required":false,"schema":{"type":"number","format":"string"}},{"description":"A number (greater or equal to 0.00) that represents the budget for your giveaways (swag and raffle items) for the event.","in":"header","name":"budget_giveaways","required":false,"schema":{"type":"number","format":"string"}},{"description":"A number (greater or equal to 0.00) that represents the budget for all shipments for the event.","in":"header","name":"budget_shipments","required":false,"schema":{"type":"number","format":"string"}},{"description":"A number (greater or equal to 0.00) that represents the budget for all miscellaneous expenses for the event.","in":"header","name":"budget_misc_expenses","required":false,"schema":{"type":"number","format":"string"}},{"description":"A number (greater or equal to 0.00) that represents the budget for all sponsorships for the event.","in":"header","name":"budget_sponsorships","required":false,"schema":{"type":"number","format":"string"}},{"description":"An integer (greater or equal to 0) that represents the number of leads generated from this event.","in":"header","name":"roi_num_leads","required":false,"schema":{"type":"number","format":"string"}},{"description":"An integer (greater or equal to 0) that represents the number of booth walk-bys / impressions (i.e., estimated total number of people who saw your booth at this event).","in":"header","name":"roi_num_impressions_booth","required":false,"schema":{"type":"number","format":"string"}},{"description":"An integer (greater or equal to 0) that represents the number of sponsorship impressions (i.e., estimated total number of people reached through all your sponsorships for this event).","in":"header","name":"roi_num_impressions_sponsorships","required":false,"schema":{"type":"number","format":"string"}},{"description":"An integer (greater or equal to 0) that represents the number of social/traditional media impressions (i.e., estimated total number of people reached via social media or traditional media coverage).","in":"header","name":"roi_num_impressions_media","required":false,"schema":{"type":"number","format":"string"}},{"description":"An integer (greater or equal to 0) that represents the number of meetings with existing customers (i.e., total number of meetings your team had with your existing customers at this event).","in":"header","name":"roi_num_meetings_existing_customers","required":false,"schema":{"type":"number","format":"string"}},{"description":"An integer (greater or equal to 0) that represents the number of meetings with new/potential customers (i.e., total number of meetings your team had with new/potential customers at this event).","in":"header","name":"roi_num_meetings_new_customers","required":false,"schema":{"type":"number","format":"string"}},{"description":"A number (greater or equal to 0.00) that represents the actual sales amount (attributable to this event and already closed).","in":"header","name":"roi_amount_actual_sales","required":false,"schema":{"type":"number","format":"string"}},{"description":"A number (greater or equal to 0.00) that represents the additional opportunity / potential sales amount (attributable to this event, but, yet to be closed).","in":"header","name":"roi_amount_potential_sales","required":false,"schema":{"type":"number","format":"string"}},{"description":"This is an integration-specific text field only accessible via the ExhibitDay API. This field can be used to store whatever metadata or information you'd like about a particular event. For example, you can use it to store the \"external id\" of the event (from another system you're integrating with). Or, you can use it to store the last sync timestamp. Note: when you retrieve a list of events (using the /v1/events endpoint), you can filter down the results by the value of this field.","in":"query","name":"integration_metadata_field_1","required":false,"schema":{"type":"string","format":"string"}},{"description":"This is an integration-specific text field only accessible via the ExhibitDay API. This field can be used to store whatever metadata or information you'd like about a particular event. For example, you can use it to store the \"external id\" of the event (from another system you're integrating with). Or, you can use it to store the last sync timestamp. Note: when you retrieve a list of events (using the /v1/events endpoint), you can filter down the results by the value of this field.","in":"query","name":"integration_metadata_field_2","required":false,"schema":{"type":"string","format":"string"}},{"description":"This is an integration-specific text field only accessible via the ExhibitDay API. This field can be used to store whatever metadata or information you'd like about a particular event. For example, you can use it to store the \"external id\" of the event (from another system you're integrating with). Or, you can use it to store the last sync timestamp. Note: when you retrieve a list of events (using the /v1/events endpoint), you can filter down the results by the value of this field.","in":"query","name":"integration_metadata_field_3","required":false,"schema":{"type":"string","format":"string"}},{"description":"This is an integration-specific text field only accessible via the ExhibitDay API. This field can be used to store whatever metadata or information you'd like about a particular event. For example, you can use it to store the \"external id\" of the event (from another system you're integrating with). Or, you can use it to store the last sync timestamp. Note: when you retrieve a list of events (using the /v1/events endpoint), you can filter down the results by the value of this field.","in":"query","name":"integration_metadata_field_4","required":false,"schema":{"type":"string","format":"string"}},{"description":"This is an integration-specific text field only accessible via the ExhibitDay API. This field can be used to store whatever metadata or information you'd like about a particular event. For example, you can use it to store the \"external id\" of the event (from another system you're integrating with). Or, you can use it to store the last sync timestamp. Note: when you retrieve a list of events (using the /v1/events endpoint), you can filter down the results by the value of this field.","in":"query","name":"integration_metadata_field_5","required":false,"schema":{"type":"string","format":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"string"}}}}},"tags":["events"]},"post":{"description":"Add an Event","operationId":"events__1_post","parameters":[{"description":"","in":"header","name":"api_key","required":true,"schema":{"type":"string","format":"string"}},{"description":"The name of the event.","in":"header","name":"name","required":true,"schema":{"type":"string","format":"string"}},{"description":"Event Start Date (format: YYYY-MM-DD). Must be smaller or equal to Event End Date.","in":"header","name":"start_date","required":true,"schema":{"type":"string","format":"date"}},{"description":"Event End Date (format: YYYY-MM-DD). Must be greater or equal to Event Start Date.","in":"header","name":"end_date","required":true,"schema":{"type":"string","format":"date"}},{"description":"Integer representing the format_id for the event (1 for In-Person, 2 for Virtual, 3 for Hybrid)","in":"header","name":"format_id","required":false,"schema":{"type":"number","format":"string","default":"1"}},{"description":"Integer representing the event_participation_type_id for the event (1: Committed, 2: Considering, 3: Not Going). Note: you can use the following endpoint to retrieve a list of available participation_type_id's: /v1/references/event_participation_types","in":"header","name":"participation_type_id","required":false,"schema":{"type":"number","format":"string","default":"1"}},{"description":"This is an integration-specific text field only accessible via the ExhibitDay API. This field can be used to store whatever metadata or information you'd like about a particular event. For example, you can use it to store the \"external id\" of the event (from another system you're integrating with). Or, you can use it to store the last sync timestamp. Note: when you retrieve a list of events (using the /v1/events endpoint), you can filter down the results by the value of this field.","in":"query","name":"integration_metadata_field_1","required":false,"schema":{"type":"string","format":"string"}},{"description":"This is an integration-specific text field only accessible via the ExhibitDay API. This field can be used to store whatever metadata or information you'd like about a particular event. For example, you can use it to store the \"external id\" of the event (from another system you're integrating with). Or, you can use it to store the last sync timestamp. Note: when you retrieve a list of events (using the /v1/events endpoint), you can filter down the results by the value of this field.","in":"query","name":"integration_metadata_field_2","required":false,"schema":{"type":"string","format":"string"}},{"description":"This is an integration-specific text field only accessible via the ExhibitDay API. This field can be used to store whatever metadata or information you'd like about a particular event. For example, you can use it to store the \"external id\" of the event (from another system you're integrating with). Or, you can use it to store the last sync timestamp. Note: when you retrieve a list of events (using the /v1/events endpoint), you can filter down the results by the value of this field.","in":"query","name":"integration_metadata_field_3","required":false,"schema":{"type":"string","format":"string"}},{"description":"This is an integration-specific text field only accessible via the ExhibitDay API. This field can be used to store whatever metadata or information you'd like about a particular event. For example, you can use it to store the \"external id\" of the event (from another system you're integrating with). Or, you can use it to store the last sync timestamp. Note: when you retrieve a list of events (using the /v1/events endpoint), you can filter down the results by the value of this field.","in":"query","name":"integration_metadata_field_4","required":false,"schema":{"type":"string","format":"string"}},{"description":"This is an integration-specific text field only accessible via the ExhibitDay API. This field can be used to store whatever metadata or information you'd like about a particular event. For example, you can use it to store the \"external id\" of the event (from another system you're integrating with). Or, you can use it to store the last sync timestamp. Note: when you retrieve a list of events (using the /v1/events endpoint), you can filter down the results by the value of this field.","in":"query","name":"integration_metadata_field_5","required":false,"schema":{"type":"string","format":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"string"}}}}},"tags":["events"]}},"/v1/events/info":{"get":{"description":"Retrieve a Single Event by id","operationId":"events_info_0_get","parameters":[{"description":"","in":"header","name":"api_key","required":true,"schema":{"type":"string","format":"string"}},{"description":"Id of the specific event that you would like to retrieve.","in":"header","name":"id","required":true,"schema":{"type":"number","format":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"string"}}}}},"tags":["events"]}},"/v1/financials/event_costs":{"get":{"description":"Retrieve event costs","operationId":"financials_event_costs_0_get","parameters":[{"description":"","in":"header","name":"api_key","required":true,"schema":{"type":"string","format":"string"}},{"description":"Id of a specific event that you would like to retrieve costs for.","in":"header","name":"filter_by_event_id","required":false,"schema":{"type":"number","format":"string"}},{"description":"Only include costs for events that have their start date greater than or equal to the value passed in for this filter parameter. Use this date format: YYYY-MM-DD","in":"header","name":"filter_by_event_start_date_greater_than_or_equal_to","required":false,"schema":{"type":"string","format":"date"}},{"description":"Only include costs for events that have their start date smaller than or equal to the value passed in for this filter parameter. Use this date format: YYYY-MM-DD","in":"header","name":"filter_by_event_start_date_smaller_than_or_equal_to","required":false,"schema":{"type":"string","format":"date"}},{"description":"Only include costs for events that have their end date greater than or equal to the value passed in for this filter parameter. Use this date format: YYYY-MM-DD","in":"header","name":"filter_by_event_end_date_greater_than_or_equal_to","required":false,"schema":{"type":"string","format":"date"}},{"description":"Only include costs for events that have their end date smaller than or equal to the value passed in for this filter parameter. Use this date format: YYYY-MM-DD","in":"header","name":"filter_by_event_end_date_smaller_than_or_equal_to","required":false,"schema":{"type":"string","format":"date"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"string"}}}}},"tags":["financials"]}},"/v1/financials/misc_annual_expense_costs":{"get":{"description":"Retrieve Miscellaneous Annual Expense Costs","operationId":"financials_misc_annual_expense_costs_0_get","parameters":[{"description":"","in":"header","name":"api_key","required":true,"schema":{"type":"string","format":"string"}},{"description":"The specific budget year that you would like to retrieve miscellaneous annual expense costs for (e.g., 2023).","in":"header","name":"budget_year","required":false,"schema":{"type":"number","format":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"string"}}}}},"tags":["financials"]}},"/v1/references/event_cost_types":{"get":{"description":"Event Cost Types","operationId":"references_event_cost_types_0_get","parameters":[{"description":"","in":"header","name":"api_key","required":true,"schema":{"type":"string","format":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"string"}}}}},"tags":["references"]}},"/v1/references/event_custom_fields":{"get":{"description":"Event Custom Fields","operationId":"references_event_custom_fields_0_get","parameters":[{"description":"","in":"header","name":"api_key","required":true,"schema":{"type":"string","format":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"string"}}}}},"tags":["references"]}},"/v1/references/event_participation_types":{"get":{"description":"Event Participation Types","operationId":"references_event_participation_types_0_get","parameters":[{"description":"","in":"header","name":"api_key","required":true,"schema":{"type":"string","format":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"string"}}}}},"tags":["references"]}},"/v1/references/event_tags":{"get":{"description":"Event Tags","operationId":"references_event_tags_0_get","parameters":[{"description":"","in":"header","name":"api_key","required":true,"schema":{"type":"string","format":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"string"}}}}},"tags":["references"]}},"/v1/references/users_and_resources":{"get":{"description":"User and Resources","operationId":"references_users_and_resources_0_get","parameters":[{"description":"","in":"header","name":"api_key","required":true,"schema":{"type":"string","format":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"string"}}}}},"tags":["references"]}},"/v1/tasks/":{"delete":{"description":"Delete a Task","operationId":"tasks__3_delete","parameters":[{"in":"header","name":"api_key","required":true,"schema":{"type":"string","format":"string"}},{"description":"The id of the task you would like to delete.","in":"header","name":"id","required":true,"schema":{"type":"number","format":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"string"}}}}},"tags":["tasks"]},"get":{"description":"Retrieve Tasks","operationId":"tasks__0_get","parameters":[{"description":"","in":"header","name":"api_key","required":true,"schema":{"type":"string","format":"string"}},{"description":"Only include tasks from this given event.","in":"header","name":"filter_by_event_id","required":false,"schema":{"type":"number","format":"string"}},{"description":"Only include general tasks (tasks on the main task board that do not belong to a particular event). Note: this filter cannot be used in conjunction with the filter_by_event_id filter.","in":"header","name":"filter_by_general_tasks_only","required":false,"schema":{"type":"number","format":"string","default":"false"}},{"description":"If you pass in the value \"true\" for this parameter, the result will only include tasks that are NOT marked as Completed.","in":"header","name":"filter_by_incomplete_only","required":false,"schema":{"type":"string","format":"string","default":"false"}},{"description":"If you pass in the value \"true\" for this parameter, the result will only include tasks that are marked as Completed.","in":"header","name":"filter_by_completed_only","required":false,"schema":{"type":"string","format":"string","default":"false"}},{"description":"If you pass in the value \"true\" for this parameter, the result will only include tasks that do not have a due date set.","in":"header","name":"filter_by_no_due_date","required":false,"schema":{"type":"string","format":"string","default":"false"}},{"description":"Only include tasks that have a due date greater than or equal to the value passed in for this filter parameter. Use this date format: YYYY-MM-DD. Note: this filter cannot be used in conjunction with the filter_by_no_due_date filter.","in":"header","name":"filter_by_due_date_greater_than_or_equal_to","required":false,"schema":{"type":"string","format":"date"}},{"description":"Only include tasks that have a due date smaller than or equal to the value passed in for this filter parameter. Use this date format: YYYY-MM-DD. Note: this filter cannot be used in conjunction with the filter_by_no_due_date filter.","in":"header","name":"filter_by_due_date_smaller_than_or_equal_to","required":false,"schema":{"type":"string","format":"date"}},{"description":"Only include tasks that have an assignee. Unassigned tasks will get excluded.","in":"header","name":"filter_by_has_assignee","required":false,"schema":{"type":"string","format":"string","default":"false"}},{"description":"Only include tasks that are assigned to this user. You can get a list of UserId's in your workspace from the /v1/references/users_and_resources endpoint. Note: If you want to retrieve the tasks that are unassigned, include this parameter and pass in the word \"null\" as the value for it.","in":"header","name":"filter_by_assignee_user_id","required":false,"schema":{"type":"string","format":"string"}},{"description":"Only include tasks that have the given text in the task Name. For example: If you want to retrieve all the tasks that have the word “order” in the task Name field, pass in the value “order” for the filter_by_task_name_contains_text parameter. Note: this text search is not case-sensitive.","in":"header","name":"filter_by_task_name_contains_text","required":false,"schema":{"type":"string","format":"string"}},{"description":"Only include tasks that have their integration_metadata_field_1 property equal to the value you pass in for this parameter. Note: A task's IntegrationMetadataField1 property is an integration-specific text field only accessible via the ExhibitDay API. This field is typically used to store metadata or information about a particular task (e.g., the \"external id\" of the task from another system you're integrating with).","in":"query","name":"filter_by_integration_metadata_field_1","required":false,"schema":{"type":"string","format":"string"}},{"description":"Only include tasks that have their integration_metadata_field_2 property equal to the value you pass in for this parameter. Note: A task's IntegrationMetadataField2 property is an integration-specific text field only accessible via the ExhibitDay API. This field is typically used to store metadata or information about a particular task (e.g., the \"external id\" of the task from another system you're integrating with).","in":"query","name":"filter_by_integration_metadata_field_2","required":false,"schema":{"type":"string","format":"string"}},{"description":"Only include tasks that have their integration_metadata_field_3 property equal to the value you pass in for this parameter. Note: A task's IntegrationMetadataField3 property is an integration-specific text field only accessible via the ExhibitDay API. This field is typically used to store metadata or information about a particular task (e.g., the \"external id\" of the task from another system you're integrating with).","in":"query","name":"filter_by_integration_metadata_field_3","required":false,"schema":{"type":"string","format":"string"}},{"description":"Only include tasks that have their integration_metadata_field_4 property equal to the value you pass in for this parameter. Note: A task's IntegrationMetadataField4 property is an integration-specific text field only accessible via the ExhibitDay API. This field is typically used to store metadata or information about a particular task (e.g., the \"external id\" of the task from another system you're integrating with).","in":"query","name":"filter_by_integration_metadata_field_4","required":false,"schema":{"type":"string","format":"string"}},{"description":"Only include tasks that have their integration_metadata_field_5 property equal to the value you pass in for this parameter. Note: A task's IntegrationMetadataField5 property is an integration-specific text field only accessible via the ExhibitDay API. This field is typically used to store metadata or information about a particular task (e.g., the \"external id\" of the task from another system you're integrating with).","in":"query","name":"filter_by_integration_metadata_field_5","required":false,"schema":{"type":"string","format":"string"}},{"description":"Include the comments collection for each task in the result set. Note: hydrating the comments collection for each task in the results will naturally yield a larger response size and response time. Set the value for this parameter to true only if you need to include the list of comments for each task in the result set.","in":"header","name":"hydrate_task_comments","required":false,"schema":{"type":"string","format":"string","default":"false"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"string"}}}}},"tags":["tasks"]},"patch":{"description":"Update a Task","operationId":"tasks__2_patch","parameters":[{"in":"header","name":"api_key","required":true,"schema":{"type":"string","format":"string"}},{"description":"The Id of the task you would like to update.","in":"header","name":"id","required":true,"schema":{"type":"number","format":"string"}},{"description":"The name/short description of the task.","in":"header","name":"name","required":false,"schema":{"type":"string","format":"string"}},{"description":"The id of the event task section that the task should be placed under. If you don't want to place/categorize the task under a specific event task section, pass in the value \null\" for this parameter. Note: you can get a list of available Task Section Ids for a given event using the /v1/event/info endpoint.","in":"header","name":"task_section_id","required":false,"schema":{"type":"number","format":"string"}},{"description":"Boolean representing whether or not the task has been completed.","in":"header","name":"is_completed","required":false,"schema":{"type":"string","format":"string","default":"false"}},{"description":"Task due date (format: YYYY-MM-DD). If you don't want the task to have a due date, pass in the value \"null\" for this parameter.","in":"header","name":"due_date","required":false,"schema":{"type":"string","format":"date"}},{"description":"The User Id of the user you would like to assign the task to. If you want the task to be unassigned, pass in the value \"null\" for this parameter. To get a list of all the User Ids in your workspace, use the /v1/references/users_and_resources API endpoint; users who can have tasks assigned to them will have their can_have_tasks_assigned property set to true.","in":"header","name":"assignee_user_id","required":false,"schema":{"type":"string","format":"string"}},{"description":"The details/description of the task. Only accepts plain text. Any html tags in the value you pass in will be stripped. New line characters will get replaced with a <br/> tag.","in":"query","name":"details","required":false,"schema":{"type":"string","format":"string"}},{"description":"This is an integration-specific text field only accessible via the ExhibitDay API. This field can be used to store whatever metadata or information you'd like about a particular task. For example, you can use it to store the \"external id\" of the task (from another system you're integrating with). Or, you can use it to store the last sync timestamp. Note: when you retrieve a list of tasks (using the /v1/tasks endpoint), you can filter down the results by the value of this field.","in":"query","name":"integration_metadata_field_1","required":false,"schema":{"type":"string","format":"string"}},{"description":"This is an integration-specific text field only accessible via the ExhibitDay API. This field can be used to store whatever metadata or information you'd like about a particular task. For example, you can use it to store the \"external id\" of the task (from another system you're integrating with). Or, you can use it to store the last sync timestamp. Note: when you retrieve a list of tasks (using the /v1/tasks endpoint), you can filter down the results by the value of this field.","in":"query","name":"integration_metadata_field_2","required":false,"schema":{"type":"string","format":"string"}},{"description":"This is an integration-specific text field only accessible via the ExhibitDay API. This field can be used to store whatever metadata or information you'd like about a particular task. For example, you can use it to store the \"external id\" of the task (from another system you're integrating with). Or, you can use it to store the last sync timestamp. Note: when you retrieve a list of tasks (using the /v1/tasks endpoint), you can filter down the results by the value of this field.","in":"query","name":"integration_metadata_field_3","required":false,"schema":{"type":"string","format":"string"}},{"description":"This is an integration-specific text field only accessible via the ExhibitDay API. This field can be used to store whatever metadata or information you'd like about a particular task. For example, you can use it to store the \"external id\" of the task (from another system you're integrating with). Or, you can use it to store the last sync timestamp. Note: when you retrieve a list of tasks (using the /v1/tasks endpoint), you can filter down the results by the value of this field.","in":"query","name":"integration_metadata_field_4","required":false,"schema":{"type":"string","format":"string"}},{"description":"This is an integration-specific text field only accessible via the ExhibitDay API. This field can be used to store whatever metadata or information you'd like about a particular task. For example, you can use it to store the \"external id\" of the task (from another system you're integrating with). Or, you can use it to store the last sync timestamp. Note: when you retrieve a list of tasks (using the /v1/tasks endpoint), you can filter down the results by the value of this field.","in":"query","name":"integration_metadata_field_5","required":false,"schema":{"type":"string","format":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"string"}}}}},"tags":["tasks"]},"post":{"description":"Add a Task","operationId":"tasks__1_post","parameters":[{"description":"","in":"header","name":"api_key","required":true,"schema":{"type":"string","format":"string"}},{"description":"The name/short description of the task.","in":"header","name":"name","required":true,"schema":{"type":"string","format":"string"}},{"description":"The id of the event you would like to add the task under. If this value is not provided, the task will be added as a general (non-event-specific) task in your workspace (under the main Task Board).","in":"header","name":"event_id","required":false,"schema":{"type":"number","format":"string"}},{"description":"The id of the event task section that the task should be placed under. Leave this value blank if you don't want to place/categorize the task under a specific event task section. Note: you can get a list of available Task Section Ids for a given event using the /v1/event/info endpoint.","in":"header","name":"task_section_id","required":false,"schema":{"type":"number","format":"string"}},{"description":"Boolean representing whether or not the task has been completed.","in":"header","name":"is_completed","required":false,"schema":{"type":"string","format":"string","default":"false"}},{"description":"Task due date (format: YYYY-MM-DD).","in":"header","name":"due_date","required":false,"schema":{"type":"string","format":"date"}},{"description":"The id of the user you would like to assign the task to. If you want the task to be unassigned, leave the value for this parameter blank. To get a list of all the user ids in your workspace, use the /v1/references/users_and_resources API endpoint. Users that can have tasks assigned to them will have their can_have_tasks_assigned property set to true.","in":"header","name":"assignee_user_id","required":false,"schema":{"type":"string","format":"string"}},{"description":"The details/description of the task. Only accepts plain text. Any html tags in the value you pass in will be stripped. New line characters will get replaced with a <br/> tag.","in":"query","name":"details","required":false,"schema":{"type":"string","format":"string"}},{"description":"This is an integration-specific text field only accessible via the ExhibitDay API. This field can be used to store whatever metadata or information you'd like about a particular task. For example, you can use it to store the \"external id\" of the task (from another system you're integrating with). Or, you can use it to store the last sync timestamp. Note: when you retrieve a list of tasks (using the /v1/tasks endpoint), you can filter down the results by the value of this field.","in":"query","name":"integration_metadata_field_1","required":false,"schema":{"type":"string","format":"string"}},{"description":"This is an integration-specific text field only accessible via the ExhibitDay API. This field can be used to store whatever metadata or information you'd like about a particular task. For example, you can use it to store the \"external id\" of the task (from another system you're integrating with). Or, you can use it to store the last sync timestamp. Note: when you retrieve a list of tasks (using the /v1/tasks endpoint), you can filter down the results by the value of this field.","in":"query","name":"integration_metadata_field_2","required":false,"schema":{"type":"string","format":"string"}},{"description":"This is an integration-specific text field only accessible via the ExhibitDay API. This field can be used to store whatever metadata or information you'd like about a particular task. For example, you can use it to store the \"external id\" of the task (from another system you're integrating with). Or, you can use it to store the last sync timestamp. Note: when you retrieve a list of tasks (using the /v1/tasks endpoint), you can filter down the results by the value of this field.","in":"query","name":"integration_metadata_field_3","required":false,"schema":{"type":"string","format":"string"}},{"description":"This is an integration-specific text field only accessible via the ExhibitDay API. This field can be used to store whatever metadata or information you'd like about a particular task. For example, you can use it to store the \"external id\" of the task (from another system you're integrating with). Or, you can use it to store the last sync timestamp. Note: when you retrieve a list of tasks (using the /v1/tasks endpoint), you can filter down the results by the value of this field.","in":"query","name":"integration_metadata_field_4","required":false,"schema":{"type":"string","format":"string"}},{"description":"This is an integration-specific text field only accessible via the ExhibitDay API. This field can be used to store whatever metadata or information you'd like about a particular task. For example, you can use it to store the \"external id\" of the task (from another system you're integrating with). Or, you can use it to store the last sync timestamp. Note: when you retrieve a list of tasks (using the /v1/tasks endpoint), you can filter down the results by the value of this field.","in":"query","name":"integration_metadata_field_5","required":false,"schema":{"type":"string","format":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"string"}}}}},"tags":["tasks"]}},"/v1/tasks/comment":{"delete":{"description":"Delete a Task Comment","operationId":"tasks_comment_3_delete","parameters":[{"in":"header","name":"api_key","required":true,"schema":{"type":"string","format":"string"}},{"description":"The Id of the task comment you would like to delete.","in":"header","name":"id","required":true,"schema":{"type":"number","format":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"string"}}}}},"tags":["tasks"]},"get":{"description":"Retrieve a Single Task Comment by id","operationId":"tasks_comment_0_get","parameters":[{"description":"","in":"header","name":"api_key","required":true,"schema":{"type":"string","format":"string"}},{"description":"Id of the specific task comment that you would like to retrieve.","in":"header","name":"id","required":true,"schema":{"type":"number","format":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"string"}}}}},"tags":["tasks"]},"patch":{"description":"Update a Task Comment","operationId":"tasks_comment_2_patch","parameters":[{"in":"header","name":"api_key","required":true,"schema":{"type":"string","format":"string"}},{"description":"The Id of the task comment you would like to update.","in":"header","name":"id","required":true,"schema":{"type":"number","format":"string"}},{"description":"The text that you would like to replace the existing comment with. Only accepts plain text. Any html tags in the value you pass in will be stripped.","in":"query","name":"comment","required":true,"schema":{"type":"string","format":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"string"}}}}},"tags":["tasks"]},