> ## Documentation Index > Fetch the complete documentation index at: https://docs.honeycomb.io/llms.txt > Use this file to discover all available pages before exploring further. # List all Recipients > Retrieve all recipients for a team. ## OpenAPI ````yaml /api/openapi-public.yaml get /1/recipients openapi: 3.1.0 info: title: Honeycomb API version: 1.0.0 license: name: Apache 2.0 url: https://www.apache.org/licenses/LICENSE-2.0.html contact: email: support@honeycomb.io description: > The API allows programmatic management of many resources within Honeycomb. Please report any discrepancies with actual API behavior in Pollinators Slack or to Honeycomb Support. servers: - url: https://api.honeycomb.io - url: https://api.eu1.honeycomb.io security: [] tags: - name: Auth description: > API Keys have various scopes permissions and belong to a specific Team or Environment. Any valid Honeycomb ingest or configuration API Key will work with this endpoint. Learn more about [API keys](https://docs.honeycomb.io/get-started/best-practices/api-keys). These endpoints can be used to validate authentication for a key, to determine what authorizations have been granted to a key, and to determine the Team and Environment that a key belongs to. - name: Boards description: > Boards are a place to pin and save useful queries/graphs, SLO panels, text panels, and views you want to retain for later reuse and reference. Boards can contain multiple panel types: - **Query panels**: Display saved queries/graphs - **SLO panels**: Monitor Service Level Objectives - **Text panels**: Add markdown-formatted text and documentation - **Views**: Filtered perspectives of board data (limited to 50 views per board) Boards also support preset filters (limited to 5 per board) to apply consistent filtering across the board. This API allows you to list, create, update, and delete boards, as well as manage board views. ## Authorization The API key must have the **Manage Public Boards** permission. Learn more about [API keys here](https://docs.honeycomb.io/configure/environments/manage-api-keys/). - name: Burn Alerts description: > This feature is available as part of the [Honeycomb Pro and Enterprise plans](https://www.honeycomb.io/pricing/). Burn Alerts notify you when issues impact your SLO budget. Learn more about [Burn Alerts here](https://docs.honeycomb.io/notify/alert/slos/monitor/). This API allows you to list, create, update, and delete burn alerts. ## Authorization The API key must have the **Manage SLOs** permission. Learn more about [API keys here](https://docs.honeycomb.io/configure/environments/manage-api-keys/). - name: Calculated Fields description: > Calculated Fields (also called Derived Columns) allow you to run queries based on the value of an expression that is calculated from the fields in an event. This API allows you to list, create, update, and delete Calculated Fields in a dataset or across a whole environment, paralleling the behavior of the Schema tab within a Dataset's or Environment's Settings UI. ## Authorization The API key must have the **Manage Queries and Columns** permission. Learn more about [API keys here](https://docs.honeycomb.io/configure/environments/manage-api-keys/). - name: Columns description: > Columns are fields in the events you send to Honeycomb. This API allows you to list, create, update, and delete columns in a dataset. ## Authorization The API key must have the **Manage Queries and Columns** permission. Learn more about [API keys here](https://docs.honeycomb.io/configure/environments/manage-api-keys/). - name: Datasets description: > A Dataset represents a collection of related events that come from the same source, or are related to the same source. This API allows you to list, create, and update datasets. ## Authorization The API key must have the **Create Datasets** permission. Learn more about [API keys here](https://docs.honeycomb.io/configure/environments/manage-api-keys/). - name: Dataset Definitions description: > Dataset definitions describe the fields with special meaning in the Dataset. Refer to the [Dataset Definitions](https://docs.honeycomb.io/configure/datasets/definitions/) documentation for more information. **Honeycomb automatically creates these Dataset definition fields when the Dataset is created.** Manual creation of Dataset definitions is **not** needed. ## Authorization The API key must have the **Create Datasets** permission. Learn more about [API keys here](https://docs.honeycomb.io/configure/environments/manage-api-keys/). - name: Events description: > The Events API endpoints are the lowest-level way to send Events to Honeycomb. **This should be your last resort!** If unsure where to start when instrumenting an application, read about how to [Send Data to Honeycomb](https://docs.honeycomb.io/send-data/). If you are building a tracing or metrics library, we recommend using [OpenTelemetry](https://docs.honeycomb.io/send-data/opentelemetry/). ## Authorization It is recommended that an Ingest API key is used for sending events. A Configuration API key will work, and must have the **Send Events** permission. Learn more about [API keys here](https://docs.honeycomb.io/configure/environments/manage-api-keys/). - name: Environments description: > This API allows you to list, create, and update, and delete Environments. ## Authorization This API requires a Management Key passed via the HTTP Authorization header. Join the key ID and secret with a colon, like this: `Authorization: Bearer :`. - name: Key Management description: > This API allows you to list, create, update, and delete API Keys for a Team. Learn more about [API keys here](https://docs.honeycomb.io/configure/environments/manage-api-keys/). ## Authorization This API requires a Management Key passed via the HTTP Authorization header. Join the key ID and secret with a colon, like this: `Authorization: Bearer :`. - name: Kinesis Events description: > The Kinesis Events API endpoints allow Honeycomb to process streaming events from Amazon Kinesis. Refer to the [Honeycomb AWS integrations](https://docs.honeycomb.io/integrations/aws/how-aws-integrations-work/) documentation for more information. ## Authorization It is recommended that an Ingest API key is used for sending events. A Configuration API key will work, and must have the **Send Events** permission. Learn more about [API keys here](https://docs.honeycomb.io/configure/environments/manage-api-keys/). - name: Markers description: > Markers indicate points in time on graphs where interesting things happen, such as deploys or outages. This API allows you to list, create, update, and delete Markers. ## Authorization The API key must have the **Manage Markers** permission. Learn more about [API keys here](https://docs.honeycomb.io/configure/environments/manage-api-keys/). - name: Marker Settings description: > Marker Settings apply to groups of similar Markers. For example, "deploys" markers appear with the same color on a graph. This API allows you to list, create, update, and delete Marker Settings. ## Authorization The API key must have the **Manage Markers** permission. Learn more about [API keys here](https://docs.honeycomb.io/configure/environments/manage-api-keys/). - name: Queries description: > Queries in Honeycomb are specifications for queries, and are used to identify queries in other parts of the API - in particular: boards, triggers, and query annotations. This API allows you to create and get query objects. ## Authorization The API key must have the **Manage Queries and Columns** permission. Learn more about [API keys here](https://docs.honeycomb.io/configure/environments/manage-api-keys/). - name: Query Annotations description: > Query Annotations in Honeycomb allow you to associate names and descriptions to queries to add additional information in collaboration features. This API allows you to list, create, update, and delete Query Annotations. ## Authorization The API key must have the **Manage Queries and Columns** permission. Learn more about [API keys here](https://docs.honeycomb.io/configure/environments/manage-api-keys/). - name: Query Data description: > This feature is available as part of the [Honeycomb Enterprise plan](https://www.honeycomb.io/pricing/). Query Results are the aggregated data from a Query, similar to what is displayed in graphs or heatmaps within the Honeycomb UI. Receiving results from a Query is a three-step process: Create the Query (or Query Spec), which validates that the query parameters are valid. Creating a query does not actually run the query to get results. Run the query asynchronously by creating a Query Result referencing the Query’s ID. This returns a Query Result ID. Poll the query result endpoint (with the Query Result ID) until the data is ready. Note that many Query Results can be created from a single Query. This is particularly useful when using a relative time_range parameter in the Query. For example, a Query with `time_range: 7200` and no explicit `start_time` or `end_time` can be re-run over and over, with each resulting Query Result containing the most recent 2 hours of data. This is conceptually similar to clicking Run Query in the Honeycomb UI without changing any query parameters. **IMPORTANT API RESTRICTIONS:** To ensure the stability of Honeycomb systems, we have enabled the following API restrictions. These restrictions may change over time. * Query Results can only be created for events with timestamps within the past 7 days. * When creating a Query Result, the time ranges from the Query are truncated according to the following rules. For queries with a time range of: * less than or equal to 6 hours, results are truncated to the nearest 1 minute. For example, a start/end time of 2021-04-22T05:28:12Z will be truncated to 2021-04-22T05:28:00Z. * greater than 6 hours and less than or equal to 2 days, results are truncated to the nearest 5 minutes. For example, a start/end time of 2021-04-22T05:28:12Z will be truncated to 2021-04-22T05:25:00Z. * greater than 2 days and less than or equal to 7 days, results are truncated to the nearest 30 minutes. For example, a start/end time of 2021-04-22T05:28:12Z will be truncated to 2021-04-22T05:00:00Z. * Creating a Query Result is rate limited to 10 requests per minute. Status code 429 will be returned when rate limited. * Query Results cannot take longer than 10 seconds to run. * Creating a Query Result that contains Relational Fields is rate limited to 1 request per minute. Status code 429 will be returned when rate limited. * Query Results with Relational Fields may be more likely to take longer to run. * Regardless of whether the `compare_time_offset_seconds` field is populated on a query, query run responses will not include comparison results. ## Authorization The API key must have the **Manage Queries and Columns** and **Run Queries** permission. Learn more about [API keys here](https://docs.honeycomb.io/configure/environments/manage-api-keys/). - name: Recipients description: > Honeycomb Recipients allow you to define and manage the Recipients that will get notified by a Trigger or Burn Alert. The types of Recipients supported are: PagerDuty, Email, Webhook, Microsoft Teams, and Slack. ## Authorization The API key must have the **Manage Recipients** permission. Recipients are team-wide and NOT environment-specific. API Keys with the **Manage Recipients** permission can modify recipients used by ALL environments for a given team. Learn more about [API keys here](https://docs.honeycomb.io/configure/environments/manage-api-keys/). - name: Reporting description: > The Reporting API provides access to historical performance data. ## Authorization The API key must have the **Manage SLOs** permission. Learn more about [API keys here](https://docs.honeycomb.io/configure/environments/manage-api-keys/). - name: Service Maps description: > The Service Maps API endpoints allow you to visualize the relationships between your services in Honeycomb. This API allows you to create and retrieve service Dependency Requests, which are used to generate maps of dependencies between services. ## Authorization The API key must have the **Read Service Maps** permission. Learn more about [API keys here](https://docs.honeycomb.io/configure/environments/manage-api-keys/). - name: SLOs description: > This feature is available as part of the [Honeycomb Pro and Enterprise plans](https://www.honeycomb.io/pricing). Honeycomb SLOs allow you to define and monitor Service Level Objectives (SLOs) for your organization. This API allows you to list, create, update, and delete SLO objects. You can also access historical reporting for your SLOs to analyze long-term performance trends. For more information, see [Get SLO History](https://api-docs.honeycomb.io/api/reporting/getslohistory) ## Authorization The API key must have the **Manage SLOs** permission. Learn more about [API keys here](https://docs.honeycomb.io/configure/environments/manage-api-keys/). - name: Triggers description: > Triggers let you receive notifications when your data in Honeycomb crosses the thresholds that you configure. The graph on which to alert is as flexible as a Honeycomb query, which helps reduce false positives due to known errors. Triggers support both standard event-based datasets and metrics datasets. Metrics triggers have additional capabilities such as granularity control. Learn more in the [Triggers documentation](https://docs.honeycomb.io/notify/alert/triggers/). This API allows you to list, create, update, and delete Triggers. ## Authorization The API key must have the **Manage Triggers** permission. Learn more about [API keys here](https://docs.honeycomb.io/configure/environments/manage-api-keys/). externalDocs: url: https://docs.honeycomb.io paths: /1/recipients: get: tags: - Recipients summary: List all Recipients description: | Retrieve all recipients for a team. operationId: listRecipients responses: '200': description: Success headers: Ratelimit: $ref: '#/components/headers/RateLimit' RateLimitPolicy: $ref: '#/components/headers/RateLimitPolicy' content: application/json: schema: type: array items: $ref: '#/components/schemas/Recipient' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/Error' example: error: unknown API key - check your credentials security: - configuration_key: [] components: headers: RateLimit: description: | The (draft07) recommended header from the IETF on rate limiting. The value of the header is formatted "limit=X, remaining=Y, reset=Z". Where: - X is the maximum number of requests allowed in the window - Y is the number of requests remaining in the window - Z is the number of seconds until the limit resets schema: type: string example: limit=100, remaining=50, reset=60 RateLimitPolicy: description: | The (draft07) recommended header from the IETF on rate limiting. The value of the header is formatted "X;w=Y". Where: - X is the maximum number of requests allowed in a window - Y is the size of the window in seconds schema: type: string example: 100;w=60 schemas: Recipient: type: object required: - type properties: type: type: string discriminator: propertyName: type mapping: pagerduty: $ref: '#/components/schemas/PagerDutyRecipient' email: $ref: '#/components/schemas/EmailRecipient' slack: $ref: '#/components/schemas/SlackRecipient' webhook: $ref: '#/components/schemas/WebhookRecipient' msteams: $ref: '#/components/schemas/MSTeamsRecipient' msteams_workflow: $ref: '#/components/schemas/MSTeamsWorkflowRecipient' oneOf: - $ref: '#/components/schemas/PagerDutyRecipient' - $ref: '#/components/schemas/EmailRecipient' - $ref: '#/components/schemas/SlackRecipient' - $ref: '#/components/schemas/WebhookRecipient' - $ref: '#/components/schemas/MSTeamsRecipient' - $ref: '#/components/schemas/MSTeamsWorkflowRecipient' Error: x-tags: - Errors type: object description: A legacy error, containing only a textual description. properties: error: type: string readOnly: true PagerDutyRecipient: allOf: - $ref: '#/components/schemas/RecipientProperties' - type: object properties: type: type: string enum: - pagerduty - type: object properties: details: type: object required: - pagerduty_integration_name - pagerduty_integration_key description: Specific schema for the Pagerduty Recipient Type properties: pagerduty_integration_name: type: string description: A name for this Integration. example: Example PagerDuty Service pagerduty_integration_key: type: string description: Pagerduty Integration Key. example: 7zOwh1edS8xHGcwfb2bA4sqY8E6PJzSK minLength: 32 maxLength: 32 EmailRecipient: allOf: - $ref: '#/components/schemas/RecipientProperties' - type: object properties: type: type: string enum: - email - type: object properties: details: type: object required: - email_address description: Specific schema for the Email Recipient Type properties: email_address: type: string description: Email address to notify. example: notify-me@example-email.com SlackRecipient: allOf: - $ref: '#/components/schemas/RecipientProperties' - type: object properties: type: type: string enum: - slack - type: object properties: details: type: object required: - slack_channel description: Specific schema for the Slack Recipient Type. properties: slack_channel: type: string description: Slack channel to notify. example: '#alerts-channel' WebhookRecipient: allOf: - $ref: '#/components/schemas/RecipientProperties' - type: object properties: type: type: string enum: - webhook - type: object properties: details: type: object required: - webhook_name - webhook_url description: Specific schema for the Webhook Recipient Type properties: webhook_headers: type: array maxItems: 5 description: Custom headers for this webhook items: $ref: '#/components/schemas/WebhookHeader' example: - header: Authorization value: Bearer xyz123 webhook_name: type: string maxLength: 255 description: A name for this Integration. example: Example webhook webhook_url: type: string description: Webhook URL. maxLength: 2048 example: https://webhook.example.com webhook_secret: type: string description: Webhook secret. maxLength: 255 example: secret webhook_payloads: type: object description: Specify a custom webhook payload. properties: template_variables: type: array maxItems: 10 description: Custom variable definitions for this webhook items: $ref: '#/components/schemas/TemplateVariableDefinition' example: - name: severity default_value: CRITICAL payload_templates: type: object properties: trigger: $ref: '#/components/schemas/PayloadTemplate' budget_rate: $ref: '#/components/schemas/PayloadTemplate' exhaustion_time: $ref: '#/components/schemas/PayloadTemplate' MSTeamsRecipient: allOf: - $ref: '#/components/schemas/RecipientProperties' - type: object properties: type: type: string enum: - msteams - type: object deprecated: true properties: details: type: object required: - webhook_name - webhook_url description: >- Specific schema for the MS Teams Recipient Type. Now deprecated, please use the `msteams_workflow` type instead. properties: webhook_name: type: string description: A name for this recipient. example: My Teams Channel webhook_url: type: string description: Incoming webhook URL of an Teams instance. example: https://yourco.webhook.office.com/webhook/xxxx MSTeamsWorkflowRecipient: allOf: - $ref: '#/components/schemas/RecipientProperties' - type: object properties: type: type: string enum: - msteams_workflow - type: object properties: details: type: object required: - webhook_name - webhook_url description: Specific schema for the MS Teams Workflow Recipient Type. properties: webhook_name: type: string maxLength: 255 description: A name for this recipient. example: My Teams Channel webhook_url: type: string maxLength: 2048 description: Incoming webhook URL of an Teams instance. example: >- https://test-123.westus.logic.azure.com:443/workflows/54321/triggers/manual/paths/invoke RecipientProperties: type: object properties: id: type: string readOnly: true example: yUheCUmgZ8p created_at: type: string format: date-time description: ISO8601 formatted time the Recipient was created. example: '2022-07-26T22:38:04Z' readOnly: true updated_at: type: string format: date-time description: ISO8601 formatted time the Recipient was updated. example: '2022-07-26T22:38:04Z' readOnly: true type: $ref: '#/components/schemas/RecipientType' WebhookHeader: type: object required: - header properties: header: type: string maxLength: 64 value: type: string maxLength: 750 TemplateVariableDefinition: type: object required: - name properties: name: type: string pattern: ^[a-z](?:[a-zA-Z0-9]+$)?$ maxLength: 64 example: severity default_value: type: string maxLength: 256 example: CRITICAL PayloadTemplate: type: object properties: body: type: string example: '{ \"alert\": \"{{.Alert.Description}}\" }' RecipientType: type: string description: One of the supported Recipient Types enum: - pagerduty - email - slack - webhook - msteams - msteams_workflow securitySchemes: configuration_key: type: apiKey name: X-Honeycomb-Team in: header description: > A Honeycomb Configuration Key is required to use this API. A Configuration Key can be found in the API Keys section of the environment configuration, which can be found under Environment Settings -> API Keys -> Configuration tab. Check out our documentation to [find your API Keys](https://docs.honeycomb.io/configure/environments/manage-api-keys/#find-api-keys). More information can be found in [Manage Environments](https://docs.honeycomb.io/configure/environments/manage-api-keys/). ````