# Single Sign-On (SSO)
Source: https://docs.push.ai/admin/single-sign-on

Configure SSO authentication for your Push.ai organization

# Single Sign-On Integration

Push.ai supports using Identity Providers (IdP) such as Okta to control authentication through single sign-on (SSO). We also support provisioning and deprovisioning Push.ai users along with managing their role assignments through SCIM (directory sync).

## Setting up SSO

Push.ai supports the SAML protocol for single sign-on authentication. To initiate setup, contact our support team at [support@push.ai](mailto:support@push.ai). We'll provide specific instructions and a test environment for setting up Push.ai with your preferred IdP.

### Post-Integration Changes

After completing the SSO integration:

* Users will no longer be able to log in with their previous Push.ai authentication method (username & password or Google)
* Attempting to use previous authentication methods will redirect users to the SSO login page
* Users will need to input their email, which will use the domain to redirect to your IdP for sign-in
* Users can log in directly from your IdP by clicking on the Push.ai application integration

<Warning>
  **Email Requirements**

  The primary email of each user assigned to Push.ai in your IdP must match their Push.ai user's email. Otherwise, they won't be able to log in to their Push.ai account.
</Warning>

## SCIM Configuration

### Overview

SCIM (System for Cross-domain Identity Management) enables you to:

* Create and delete Push.ai users directly within your IdP
* Update user information (including email)
* Manage Push.ai role assignments

### Required Attributes

In addition to standard attributes (`id`, `emails`, `first_name`, `last_name`), Push.ai requires the following custom attribute:

`roles` → `<name_of_push_ai_role>`
Examples: `Admin`, `Data`, or `NormalUser`

<Note>
  **Important Notes about Roles** - Role assignments must be non-empty -
  SCIM-enabled organizations do not have default roles - All role assignments
  must be explicitly managed through your IdP - Role names are case-insensitive
</Note>

### Initial Synchronization

During initial SCIM setup:

1. We match IdP users with existing Push.ai users by primary email
2. Matched users will be linked to their IdP identity
3. Future updates (including email changes) will sync automatically
4. New IdP users without matching Push.ai accounts will have accounts provisioned automatically

### User Management

* User assignments in your IdP automatically sync to Push.ai in real-time
* Creating, editing, and deleting users must be done through your IdP
* Direct user management in Push.ai is restricted for SSO-enabled organizations

### Role Management

* Creating and editing roles must still be done within Push.ai by Admins
* Role assignments to users must be managed in your IdP using the `roles` attribute
* Available roles include: Admin, Data, and Normal User

<Note>
  For detailed setup instructions specific to your IdP or additional support,
  please contact our support team at [support@push.ai](mailto:support@push.ai)
</Note>


# Users and Roles
Source: https://docs.push.ai/admin/users-and-roles

Manage users and roles within your Push.ai organization

## Adding Users

Users can be added to your organization through an invitation flow or automatically according to their email domain. All users' email addresses are verified during user creation.

### Automatic Assignment

Any user who signs up with an email domain that matches the organization's domain will be automatically added to their organization. Common domains such as gmail, hotmail, etc. are excluded from this policy.

### Invitation

Any user who is invited via an invite flow will be added to the organization regardless of their email domain. This allows you to include team members or external collaborators who may not share your organization's email domain.

## Roles and Permissions

Push.ai offers different user roles with varying levels of permissions to help manage team members' access levels and responsibilities. Here's an overview of each role:

### Admin Role

The admin role is the highest level of authority within Push.ai, possessing comprehensive access and control over all settings and functions.

* Can manage integrations, members, organization, and billing in the settings page
* Modify team settings, including billing and member roles
* Access to all Data Role and Normal User permissions

### Data Role

* Can create and edit metrics and metadata
* Access to all Normal User permissions

### Normal User

* Can view metrics and subscribe to them
* Can manage individual user preferences


# Create a run
Source: https://docs.push.ai/api-reference/endpoint/create-run

POST /agents/{agent_id}/runs
Invoke a published agent asynchronously. Returns a run ID that you can poll for status and results.

Pass `?dry_run=true` to preview the compiled prompt without executing.



# Get run status
Source: https://docs.push.ai/api-reference/endpoint/get-run-status

GET /agents/{agent_id}/runs/{run_id}
Poll for the status and result of an agent run. Returns the output when the run succeeds, or an error message if it fails.



# List agents
Source: https://docs.push.ai/api-reference/endpoint/list-agents

GET /agents
Returns all published agents for your organization, with their accepted parameters.



# API Reference
Source: https://docs.push.ai/api-reference/introduction

Programmatic access to Push AI agents

The Push AI API lets you list your published agents, invoke them with parameters, and poll for results — all from your own code, scripts, or backend services.

## Base URL

```
https://api.push.ai/api/v1
```

## Authentication

All endpoints require an API key passed in the `x-api-key` header.

```bash theme={null}
curl https://api.push.ai/api/v1/agents \
  -H "x-api-key: YOUR_API_KEY"
```

API keys are scoped to your organization. Every key you create can access all published agents in your org.

### Creating an API key

<Note>API key management is only available to **Admin** users. If you don't see the API Key option in Settings, contact your organization's admin.</Note>

1. Open **Settings → API Key** from the left sidebar in the Push AI dashboard
2. Click **Create Key**
3. Copy the key immediately — it is only shown once

<Frame>
  <img alt="API Key settings page" />
</Frame>

### Regenerating or revoking a key

From the same **Settings → API Key** page, you can:

* **Regenerate** — creates a new key and invalidates the old one
* **Revoke** — permanently disables the key

Revoked or regenerated keys return `401` immediately. Make sure to update any scripts or integrations using the old key.

## Errors

All errors return a consistent JSON envelope:

```json theme={null}
{
  "error": {
    "code": "agent_not_found",
    "message": "Agent 123 not found or not published.",
    "request_id": "req_abc123"
  }
}
```

| Field        | Description                                                                                                          |
| ------------ | -------------------------------------------------------------------------------------------------------------------- |
| `code`       | Machine-readable error code for programmatic handling.                                                               |
| `message`    | Human-readable description.                                                                                          |
| `request_id` | Unique ID for this request. Include it when contacting support. Also returned in the `X-Request-Id` response header. |

### Common error codes

| Code                      | Status | Meaning                                                                  |
| ------------------------- | ------ | ------------------------------------------------------------------------ |
| `missing_api_key`         | 401    | No `x-api-key` header provided.                                          |
| `invalid_api_key`         | 401    | Key is invalid or has been revoked.                                      |
| `agent_not_found`         | 404    | Agent doesn't exist, isn't published, or belongs to another org.         |
| `run_not_found`           | 404    | Run ID not found or belongs to another org.                              |
| `unknown_parameter`       | 400    | Parameter name doesn't match any defined on the agent.                   |
| `invalid_parameter_value` | 400    | The value provided for a parameter doesn't match any known option.       |
| `internal_error`          | 500    | Unexpected server error. Retry or contact support with the `request_id`. |

## Rate limits

Rate limiting is enforced per API key. Current limits are generous for normal usage. If you hit a limit, you'll receive a `429` response — back off and retry.


# Use Cases
Source: https://docs.push.ai/business-graph/business-graph

Populate your Business Graph™ to improve the relevancy of Push.ai's AI systems.

By defining Business Objects, you've already established a strong foundation of data context. The Business Graph™ is used to map additional context to the data, enhancing the relevancy of AI systems. Over time, we'll expand functionality to include and integrate additional sources of business context. Below is a list of the capabilities available today.

## Data Context

### Metric Relationships

Define relationships between metrics to include additional context and leverage additional analaysis capabilities. Metric relationships are defined through input and output metrics, in what is commonly known as a metric tree.

### Metric-Dimension Relationships

<Note>
  **Example:** If a user is Subscribed to a metric such as Revenue,
  Metric-Dimension relationships allow our systems to pull in related context,
  like the Dimensions we can use to slice Revenue (e.g., Revenue by Product,
  Revenue by Country, etc.)
</Note>

Metric-Dimension relationships are generated as a result of defining Business Objects like metrics and dimensions. They serve a crucial role in the Business Graph™, allowing our systems to pull in context from related Business Objects.

## Business Context

### Metadata for Business Objects

Attach metdata to Business Objects, such as metrics, dimensions, and artifacts. For metrics and dimensions defined in Push.ai, you can use descriptions, labels and owners to attach metadata and organize resources. Artifacts can include rich metadata such as document types, authors, and creation dates. Semantic layer integrations offer additional metadata capabilities that can be integrated with Push.ai.

### Goals

<Note>
  **Note:** If you'd like to input a large list of goals or would like to define
  goals at the dimension level, you can [reach out to
  us](mailto:support@push.ai) and someone from our team can help you get set up.
</Note>

Define goals to keep teams accountable and identify where teams are on or off track. Goals can be defined on metrics at a monthly time grain in the UI.

### Organizational Context

Organizational context is an open text field that can be configured in [Organization Settings](https://app.push.ai/settings). This allows you to add additional context around your organization that can be used to enhance the relevancy of Push.ai's AI systems.


# How It Works?
Source: https://docs.push.ai/business-graph/how-it-works

Map data with business context using a graph-based model of your business.

<img alt="Business Graph" />

The Business Graph™ is a graph-based representation of your business that integrates
data with business context. You can think of the Business Graph™ as a model of your
business which encompasses:

* the data and measurement system used to measure success
* the people in the business and their individual roles in driving success
* the projects and goals that the business is working to achieve

## Data Context

The Business Graph™ allows you to model your data beyond tables and columns. Through centrally defined metrics and dimensions, you can explicitly define a measurement system for sucess.

For example, by defining metric-relationships and dimension-relationships, you gain visibility into how different parts of the business relate to each other.

## Business Context

The Business Graph™ increases the knowledge of your organization by capturing and organizing information outside your measurement system. Conversations, documents and other sources of unstructured data can be mapped back to the individual Business Objects in your Business Graph™. This is valuable in two major ways:

* improves the ability for organizations to share information and collaborate around the correct actions
* improves the relevancy of AI systems using context not available in the data directly

For example, a marketing team might be discussing a spike in performance and determine that the increase was due to a cultural holiday within a specific region. This information, whether it be in a Slack message, weekly business review, or logged in Push.ai can be mapped back to the Business Object for that region and referenced by others exploring that same region and in AI systems.


# Artifacts
Source: https://docs.push.ai/business-objects/artifacts

Artifacts are one of the core primitives of knowledge in Push.ai. They represent various types of content and provide valuable context that enhances strcutured data analysis.

## Features

* Process and analyze content from multiple sources including documents, chats, meeting minutes and more
* Automatically categorize and tag content for better organization
* Make content searchable and accessible across your organization

## Artifact Categories

Artifacts are organized into abstract categories that help classify different types of content:

| Category         | Description                                                                |
| ---------------- | -------------------------------------------------------------------------- |
| **DOCUMENT**     | Any text-based document, such as PDFs, Word documents, or text files       |
| **MESSAGE**      | Any chat or discussion format, including Slack channels and Teams channels |
| **PRESENTATION** | Any slide or presentation format, such as PowerPoint or Google Slides      |
| **MEETING**      | Any meeting recording or transcript                                        |

## Integration

Artifacts can be integrated from various sources:

* **File Upload** - Direct file uploads to the system
* **API Integration** - Integration with third-party APIs
* **Warehouse Integration** - Integration with data warehouses

Each integration method supports different types of artifacts and provides different capabilities for processing and analysis.


# Dimension Values
Source: https://docs.push.ai/business-objects/dimension-values

If Dimensions are like groups, Dimension Values are the individual parts that make up each group. For example, Marketing Channel is a Dimension, while Paid Search, Direct Traffic and Email are Dimension Values.

## How Dimension Values work in Push.ai?

In Push.ai, Dimension Values are first-class citizens that get automatically generated, rather than being defined by the admin or user. Using <Tooltip>omni-search</Tooltip>, you can quickly find any Dimension Value and explore all of its related metrics. This is especially valuable for data teams because it allows business users to access data and metrics specific to their area of the business without relying on a data team to build out custom views.


# Dimensions
Source: https://docs.push.ai/business-objects/dimensions

Dimensions are categories or attributes used to organize and analyze data within a business. Dimensions help break down data into specific segments, such as time, location, or product type, allowing a business to understand and compare different aspects of their operations.

## Features

* Define dimensions centrally and use them across multiple metrics.
* Enabled AI for dimensions that are the primary drivers of your metrics.
* Define hierarchies across dimensions to add additional context to your data. *(coming soon)*.

## ✨ AI Enabled Dimensions

This feature enables Dimensions for use in AI systems. We recommend enabling this for any Dimensions considered to be the primary drivers of metric changes. These are often lower cardinality dimensions, such as Marketing Channel, Country or Product.

<Warning>
  Selecting this feature across too many dimensions or high cardinality
  dimensions can result in noise in AI features and create unnecessary compute
  on your datasource.
</Warning>


# Metrics
Source: https://docs.push.ai/business-objects/metrics

Metrics are the basis for measuring your business. They are times-series aggregations of data that can be defined inside of Push.ai or integrated using semantic layers such as [the dbt Semantic Layer](https://getdbt.com), [Looker](https://cloud.google.com/looker/) and [Cube](https://cube.dev).

## Features

* Define metrics in one place and use them across a variety of use-cases without the need to maintain defintions.
* Track historical results, see automated projections and compare them to business goals.
* Use pre-built calculations to quickly explore how metrics change over time.

## Defining Metrics

Our metric builder allows teams to easily input metric definitions and dynamically generate the yml used to store them in dbt. We also include some best practice metadata so that Push.ai and other systems can better organize and deliver value using metrics. Below is the complete list of properties that are needed to make metrics.

### Definition Types

* **Metric Builder** - The easiest way to define a metric. Select a table and the fields used to configure a metric.
* **Custom SQL** - A flexible solution with the ability to join tables, edit and paste in SQL from other sources.
* **Derived Metric** - Use existing metrics to define metrics with parent-child relationships, like average order value.

### Definition Configuration

| Field                 | Description                                                 | Example           | Required?                    |
| :-------------------- | :---------------------------------------------------------- | :---------------- | :--------------------------- |
| **Table**             | The table used to calculate this metric                     | dim\_customers    | yes (no for derived metrics) |
| **Calculation Type**  | The method of calculation that is applied to the expression | count\_distinct   | yes                          |
| **Calculation Field** | The expression to aggregate/calculate over                  | user\_id          | yes                          |
| **Date Field**        | The time-based component of the metric                      | signup\_date      | yes                          |
| **Dimensions**        | A list of dimensions to group or filter the metric by       | \[plan, country]  | no                           |
| **Filters**           | A list of filters to apply before calculating the metric    | status = 'active' | no                           |

### Properties

Metric properties define how a metric is calculated in Push.

| Field                      | Description                                                                               |
| :------------------------- | :---------------------------------------------------------------------------------------- |
| **Goal Direction**         | Defines whether the business goal is to increase or decrease the metric.                  |
| **Aggregation Properties** | Configures whether this metric can be aggregated across the date dimension.               |
| **Metric Format**          | Configures whether a metric will display as a number, percent or currency when displayed. |

### Derived Metrics

Derived metrics use existing metric definitions to calculate a new metric with a *parent-child* relationship. For example, *Profit* is a derived metric that can be calculating using the parent metrics of *Revenue* and *Cost* (`profit = revenue - costs`). Using derived metrics makes maintaining metric definitions easier by defining the supporting metrics in one definition and then having the derived metrics inherit any metric changes.

With derived metrics, dimensions are inherited. The dimensions available for derived metrics are the ones shared by all related metrics

## Calculations

Calculations help us explore how metrics change over time. You are likely already familiar with them if you've used traditional Business Intellignece tools.

In Push.ai, calculations are used to compare metrics across time periods. Each calculation in Push.ai is associated with two time periods, a **current period** and a **previous period**. Individual calculations will be relevant depending on the use-case (e.g., you want to track something on a daily v. monthly cadence) or the nature of the business (e.g., you run an ecommerce business and order volume has a strong day-of-week seasonality).

<AccordionGroup>
  <Accordion title="Previous Period">
    <table>
      <thead>
        <tr>
          <th>Calculation</th>
          <th>Current Period</th>
          <th>Previous Period</th>
        </tr>
      </thead>

      <tbody>
        <tr>
          <td>Previous Day</td>
          <td>Apr 23</td>
          <td>Apr 22</td>
        </tr>

        <tr>
          <td>Previous Week</td>
          <td>Apr 17-23</td>
          <td>Apr 10-16</td>
        </tr>

        <tr>
          <td>Previous Month</td>
          <td>Apr 1-30</td>
          <td>Mar 1-31</td>
        </tr>

        <tr>
          <td>Previous Quarter</td>
          <td>Q1 2023</td>
          <td>Q2 2023</td>
        </tr>

        <tr>
          <td>Previous Year</td>
          <td>2021</td>
          <td>2022</td>
        </tr>
      </tbody>
    </table>
  </Accordion>

  <Accordion title="Period to Date">
    <table>
      <thead>
        <tr>
          <th>Calculation</th>
          <th>Current Period</th>
          <th>Previous Period</th>
        </tr>
      </thead>

      <tbody>
        <tr>
          <td>Week to date</td>
          <td>Apr 16: Sun - Thurs</td>
          <td>Apr 9: Sun - Thurs</td>
        </tr>

        <tr>
          <td>Month to date</td>
          <td>Apr 1-23</td>
          <td>Mar 1-23</td>
        </tr>

        <tr>
          <td>Quarter to date</td>
          <td>Q2 Days 1-23</td>
          <td>Q1 Days 1-23</td>
        </tr>

        <tr>
          <td>Year to date</td>
          <td>Y 2023 Days 1-156</td>
          <td>Y 2022 Days 1-156</td>
        </tr>

        <tr>
          <td>Week on Week</td>
          <td>Prior Full Week</td>
          <td>Current Week to Date</td>
        </tr>

        <tr>
          <td>Month on Month</td>
          <td>Prior Full Month</td>
          <td>Current Week to Date</td>
        </tr>
      </tbody>
    </table>
  </Accordion>

  <Accordion title="Trailing Period">
    <table>
      <thead>
        <tr>
          <th>Calculation</th>
          <th>Current Period</th>
          <th>Previous Period</th>
        </tr>
      </thead>

      <tbody>
        <tr>
          <td>Trailing 7 Day</td>
          <td>Apr 15 - 22</td>
          <td>Apr 7 - 14</td>
        </tr>

        <tr>
          <td>Trailing 30 Day</td>
          <td>Mar 24 - Apr 23</td>
          <td>Feb 21 - Mar 23</td>
        </tr>
      </tbody>
    </table>
  </Accordion>

  <Accordion title="Same Day Previous Period">
    <table>
      <thead>
        <tr>
          <th>Calculation</th>
          <th>Current Period</th>
          <th>Previous Period</th>
        </tr>
      </thead>

      <tbody>
        <tr>
          <td>Same Day Previous Week</td>
          <td>W15: Mon</td>
          <td>W14: Mon</td>
        </tr>

        <tr>
          <td>Same Day Previous Month</td>
          <td>January 15</td>
          <td>February 15</td>
        </tr>

        <tr>
          <td>Same Day Previous Quarter</td>
          <td>Q2 W1 Monday</td>
          <td>Q1 W2 Monday</td>
        </tr>

        <tr>
          <td>Same Day Previous Year</td>
          <td>Y2023 W15 Monday</td>
          <td>Y2022 W15 Monday</td>
        </tr>
      </tbody>
    </table>
  </Accordion>

  <Accordion title="Year over Year">
    <table>
      <thead>
        <tr>
          <th>Calculation</th>
          <th>Current Period</th>
          <th>Previous Period</th>
        </tr>
      </thead>

      <tbody>
        <tr>
          <td>Week to Date, Prev. Year</td>
          <td>W2 2023: Sun - Thurs</td>
          <td>W2 2024: Sun - Thurs</td>
        </tr>

        <tr>
          <td>Month to Date, Prev. Year</td>
          <td>Apr 1-16 2023</td>
          <td>Apr 1-16 2024</td>
        </tr>

        <tr>
          <td>Quarter to Date, Prev. Year</td>
          <td>Q2 Days 1-23, 2023</td>
          <td>Q2 Days 1-23, 2024</td>
        </tr>

        <tr>
          <td>Prev. Week, Prev. Year</td>
          <td>Y 2023 W2</td>
          <td>Y 2022 W2</td>
        </tr>

        <tr>
          <td>Prev. Month, Prev. Year</td>
          <td>Apr 2023</td>
          <td>Apr 2024</td>
        </tr>

        <tr>
          <td>Prev. Quarter, Prev. Year</td>
          <td>Q1 2023</td>
          <td>Q1 2024</td>
        </tr>
      </tbody>
    </table>
  </Accordion>

  <Accordion title="Progress to Goal">
    <table>
      <thead>
        <tr>
          <th>Calculation</th>
          <th>Current Period</th>
          <th>Previous Period</th>
        </tr>
      </thead>

      <tbody>
        <tr>
          <td>End of Week Progress</td>
          <td>Apr 16-23</td>
          <td>Goal EOW W15</td>
        </tr>

        <tr>
          <td>End of Month Progress</td>
          <td>Apr 1-23</td>
          <td>Goal EOM Apr</td>
        </tr>

        <tr>
          <td>End of Quarter Progress</td>
          <td>Apr 1-23</td>
          <td>Goal EOQ Q2</td>
        </tr>

        <tr>
          <td>End of Year Progress</td>
          <td>Jan 1 - Apr 23</td>
          <td>Goal EOY 2023</td>
        </tr>
      </tbody>
    </table>
  </Accordion>

  <Accordion title="Pacing to Goal">
    <table>
      <thead>
        <tr>
          <th>Calculation</th>
          <th>Current Period</th>
          <th>Previous Period</th>
        </tr>
      </thead>

      <tbody>
        <tr>
          <td>End of Week Pacing</td>
          <td>Projection EOW W15</td>
          <td>Goal EOW W14</td>
        </tr>

        <tr>
          <td>End of Month Pacing</td>
          <td>Projection EOM Apr</td>
          <td>Goal EOM Apr</td>
        </tr>

        <tr>
          <td>End of Quarter Pacing</td>
          <td>Projection Q2</td>
          <td>Goal Q2</td>
        </tr>

        <tr>
          <td>End of Year Pacing</td>
          <td>Projection 2023</td>
          <td>Goal 2023</td>
        </tr>
      </tbody>
    </table>
  </Accordion>
</AccordionGroup>


# Product Updates
Source: https://docs.push.ai/changelog/product-updates

New updates and improvements.

<Update label="2026-03-09" description="v0.14.2">
  ### New Feature: AI-Assisted Model Editing

  * The AI agent can now suggest changes to your semantic models — adding metrics, measures, and dimensions with inline patch suggestions
  * Live activity timeline shows each step the agent takes when building or updating a model
  * Modified rows are highlighted so you can quickly review what changed before accepting suggestions
  * Smarter validation catches issues like duplicate measure names and invalid metric configurations before they're saved

  ### New Feature: Learning Center

  * Interactive learning modules covering key concepts: data modeling, knowledge graphs, integrations, context windows, agent skills, and more
  * Each module walks through a topic in digestible sections with clear explanations
  * Mobile-friendly layout with responsive navigation

  ### Charts & Visualizations

  * New waterfall chart type with dynamic formatting and percentage support
  * Time series analysis charts now lock their chart type to prevent accidental changes
  * Fixed-schema chart types hide irrelevant configuration controls for a cleaner editing experience

  ### Context & Integrations

  * New Context overview page showing a unified summary of all connected sources — data warehouses, integrations, knowledge, and web sources
  * Redesigned context sidebar with per-card scrolling and clearer organization
  * Agent responses now link back to the specific integration sources they used, so you can see where each answer came from
  * Data table previews load faster with pre-fetched source details

  ### Semantic Layer & Models

  * Top-level metric filters let you scope any metric to a specific subset of data directly from the metric configuration modal
  * Percentile aggregation support for measures
  * Derived metrics now support per-reference filters on formula tokens for more precise calculations
  * Cascading validation: deleting or modifying a model element now correctly flags all dependent metrics and dimensions
  * Models can be created without measures for dimension-only use cases

  ### AI Agent Improvements

  * Agent now tracks and displays web page sources used during analysis
  * Improved search with pagination and per-type result counts for more complete answers
  * Better handling of complex metric references and object mentions in conversation

  ### Onboarding

  * Onboarding now includes a real query step so you can test your data connection immediately after setup
  * Data source auto-detection streamlines the warehouse connection flow

  ### Settings & UX

  * Column type icons are now consistently aligned across all data tables
  * Full internationalization pass across the product with improved translations
  * Fixed a settings panel flash when closing modals

  ### Performance & Reliability

  * Faster permission checks with cached authorization policies
  * Fixed streaming timeouts that could interrupt long-running agent sessions
  * Fixed issues with model creation forms silently dropping invalid configurations
  * Resolved errors when editing conversion metrics and derived metric references
  * Fixed query planner errors when referencing removed semantic objects
</Update>

<Update label="2026-02-16" description="v0.14.1">
  ### New Onboarding Experience

  * Interactive product demo that walks through Push AI's capabilities in under 5 minutes — no setup required
  * Progressive demo starting with a basic data answer, then layering on web research and integrations to show the full power of multi-source AI
  * Streamlined flow to connect your data warehouse (Snowflake, BigQuery, Redshift, ClickHouse, Databricks) with connection testing and field grouping
  * After connecting tools like Slack, Notion, and GitHub via OAuth, onboarding shows what was discovered (channels, repos, pages) in a scrollable carousel
  * Clear 5-step progress indicator (Demo, Connect, Explore, Model, Integrate) keeps you oriented throughout setup

  ### Redesigned Home Dashboard

  * Completely redesigned landing experience with a query input overlay and live metric ticker bar with inline sparkline charts
  * Click any metric in the ticker to see a full-width trend chart powered by real data from your warehouse
  * See your active agents and recent activity at a glance from the home page

  ### Metric Formatting

  * Configure how each metric displays its values — choose number, currency, or percentage with decimal precision, compact notation (1.2K, 3.4M), and custom currency symbols
  * Formatting settings now apply consistently across charts (axes, tooltips, value labels), data tables, and CSV/JSON exports
  * Set format and goal direction directly from the metric settings modal
  * Update format and goal direction for multiple metrics at once

  ### Unified Data Display

  * Every data result now has a single toggle to switch between table view, chart view, and the underlying SQL
  * Smooth cross-fade animations when switching between table, chart, and code views
  * Toggle text wrapping in data table cells for better readability of long values
  * Tables with many columns now handle gracefully, preventing issues with wide datasets

  ### Charts in Notifications

  * When an agent sends a scheduled report, charts are now rendered as images and included inline in Slack, Teams, and Email
  * Data table results sent to Slack now include a downloadable CSV file attached to the message

  ### AI Agent Improvements

  * Live-updating todo list in the context sidebar as the agent works through complex analyses — see what's pending, in progress, and completed
  * Agents can now execute longer analysis runs for deeper, more thorough results
  * Upgraded report writing for more coherent and complete output
  * Data queries no longer cap at 100 rows — the agent retrieves all the data it needs for accurate analysis
  * Improved chart generation with more reliable field detection for visualizations

  ### Semantic Layer & Validation

  * New issues page showing all invalid objects with error details and one-click resolution paths
  * When a dimension, entity, or time field becomes invalid, all metrics that reference it are now automatically flagged
  * Models with dimensions but no metrics are now fully supported
  * Faster validation on large semantic layers

  ### Data Model & Connections

  * Redesigned business graph with a hub-and-spoke layout and dedicated panels for Sources, Metrics, Relationships, and Knowledge
  * Consolidated warehouse connection forms into a single consistent experience across all providers

  ### Task Progress

  * Integration discovery and metadata sync now report detailed progress (which schemas, tables, and columns are being processed) instead of just showing "pending"

  ### Performance & Reliability

  * Fixed several issues that could freeze the query page or prevent navigation
  * Fixed rendering issues with wide data tables containing many columns
  * Fixed chart rendering issues in scheduled Slack and Email reports
</Update>

<Update label="2026-02-09" description="v0.14.0">
  ### Charts & Visualizations

  * New chart types: treemap, heatmap, pie, and donut charts with percentage labels and smart aggregation
  * Interactive charts: click to select data points, legend filtering, and reference lines/bands for annotations
  * Smart date axes with continuous temporal scale and automatic quarter label formatting
  * Small multiples: break a chart into a grid of subcharts by any dimension for easy comparison
  * Download charts as images directly from the chat interface
  * Simplified, cleaner tooltip design for source citations

  ### Data Tables

  * Completely rebuilt data tables with column sorting, drag-to-reorder columns, and column resizing
  * Tables with hundreds of rows now render instantly
  * Global search across all columns with instant highlighting and filtered row counts
  * Row grouping and aggregation: group rows by any dimension with collapsible sections and automatic numeric aggregation
  * One-click copy to clipboard, or export as CSV / JSON — respects any active search filters or row selection
  * Conditional formatting: toggle heatmap-style color coding for numeric columns to spot patterns at a glance
  * Sticky headers and optional row numbering

  ### Query & Chat Experience

  * New context sidebar showing all data sources and integrations referenced in your conversation
  * Click any data source in the context sidebar to open a resizable live data preview alongside your chat
  * Scroll-to-bottom button to quickly jump to the latest message in long conversations
  * Metrics built from other metrics (derived/composite) are now fully supported in queries
  * View the generated SQL behind any metric or query result

  ### Integrations

  * Connect third-party tools directly from settings with a streamlined OAuth experience
  * Name your connections, view details, and delete with inline confirmation
  * Push AI now automatically discovers your Slack channels, GitHub repos, Linear projects, Notion pages, and Asana workspaces so the AI can reference them in context
  * Improved search and navigation in the integrations settings panel

  ### Semantic Layer & Models

  * Create and edit semantic models using a rich YAML editor with inline validation and error messages with line numbers
  * View and manage derived/composite metrics that reference other metrics
  * More reliable syncing between your data warehouse schema and your semantic model definitions

  ### AI Agent

  * 11 new built-in analysis skills including trend analysis, cohort comparison, anomaly detection, and more
  * Human-in-the-loop tool approval — the agent asks for your approval before executing sensitive actions
  * Hybrid query mode: the agent can now fall back to direct SQL when the semantic layer doesn't cover a question
  * Agent actions collapsed by default with clear one-line summaries; expand for full detail

  ### Settings & UX

  * Redesigned modal-based settings with faster loading and cleaner navigation
  * Two-panel dashboard layout with improved schema browsing on the data page
  * Better UX for finding and managing saved queries
  * Cleaner agent history grouped by query instead of individual runs
  * Streamlined product experience with fewer options for a more focused workflow

  ### Performance

  * Faster data transfer with an optimized data pipeline
  * Query results, entity recognition, and join resolution now cached with automatic invalidation on model changes
  * Fixed inflated query view counts — now tracks unique viewers per query
  * Faster page loads through reduced bundle size
</Update>

<Update label="2026-01-31" description="v0.13.0">
  ### New Feature: Multi-Model Queries

  * Query data across multiple semantic models in a single request
  * Smart disambiguation when objects exist in multiple models
  * Automatic discovery of join paths between models

  ### Complex Metrics

  * Create derived metrics based on other metrics
  * Use metrics in filter conditions
  * Support for queries without aggregation

  ### Model Validation

  * See exactly why a model or object is invalid
  * Automatic scheduled validation of models

  ### YAML Model Creation

  * Create semantic models using YAML syntax with a built-in code editor
  * Real-time validation with helpful error messages
  * Automatic label generation from definitions

  ### New Feature: Tool Approval

  * Review and approve tool executions before they run
  * Clear visual feedback on approval status
  * Dedicated approval flow for SQL execution

  ### New Feature: AI Skills

  * New skills system for higher-level agent orchestration
  * 11 new analysis skills available out of the box
  * Create custom skills for your team

  ### Hybrid Query Mode

  * Automatically fall back to SQL when the semantic layer can't answer a question
  * Combine semantic layer precision with SQL flexibility

  ### Time Field Improvements

  * Models can specify default time fields
  * Better handling of time grain throughout queries

  ### Performance

  * Faster query compilation and execution
</Update>

<Update label="2025-12-31" description="v0.12.0">
  ### New Feature: Subagents

  * Main agent can now coordinate specialized subagents for complex analysis
  * Parallel subagent execution with result aggregation
  * View results from subagent runs in the main conversation
  * Control how many subagents run simultaneously

  ### New Feature: Agent Scheduling

  * Set up agents to run on a recurring schedule
  * Configure scheduling behavior with flexible policies
  * Track whether a run was triggered manually or by schedule

  ### Agent Configuration

  * Configure reasoning effort for more thorough or faster analysis
  * Control the level of detail in agent responses
  * Choose which AI model powers each agent

  ### Data Table Improvements

  * Better axis configuration for data visualizations
  * Richer metadata for table columns
  * Improved dimension value handling

  ### Knowledge Documents

  * Documents now influence query mode selection
  * Documents included in AI context based on query mode
</Update>

<Update label="2025-11-28" description="v0.11.0">
  ### New Feature: SQL Explore Mode

  * New query mode for direct SQL exploration of your data
  * Choose between Explore, Analyze, and Deep Research modes
  * Select specific data sources for exploration
  * Configure which schemas, tables, and columns are available

  ### Data Source Objects

  * Reference schemas, tables, and columns in queries using @mentions
  * Data source objects now appear in the business graph
  * Detailed tooltips for database objects on hover

  ### AI-Powered Metadata

  * AI-suggested descriptions and synonyms for objects
  * Edit metadata directly in tables
  * Refresh schema with automatic column reconciliation

  ### Knowledge Documents

  * Link knowledge documents to metrics, dimensions, and other objects
  * Documents can influence which query mode is used
  * Full lifecycle management: publish, unpublish, and delete

  ### Agent History

  * View parameter values used in agent runs
  * See who created each agent run

  ### Search Improvements

  * Improved search including descriptions and synonyms
  * Option to search by name only for precise matching
  * Show complete object paths in selector

  ### Integrations

  * Updated authentication for improved compatibility with third-party providers
</Update>

<Update label="2025-10-31" description="v0.10.0">
  ### New Feature: Knowledge Documents

  * Full-featured document editor with versioning and autosave
  * Save drafts and publish when ready
  * View and restore previous versions of documents
  * Compare changes between document versions

  ### Navigation Reorganization

  * "Knowledge" is now "Context" for clearer navigation
  * New dedicated Integrations tab under Context

  ### New Feature: Business Graph 2.0

  * Completely rewritten visualization with an interactive canvas
  * Automatic graph layout with smart positioning
  * Web pages and knowledge documents now appear in the graph
  * Rich tooltips on graph nodes showing object details
  * Navigate the graph by expanding and collapsing nodes

  ### Agent Improvements

  * Agents can now have parameterized dimension values
  * New card UI with metric charts showing goal progress
  * View agent run history with status and timing
  * Dedicated tabs for monitoring agent status

  ### New Data Source: ClickHouse

  * Connect to ClickHouse databases
  * Full schema discovery for ClickHouse with proper case-sensitivity handling

  ### Integration Objects

  * Select which Slack channels and users to include
  * New UI for selecting integration objects

  ### New Feature: Report Builder

  * Add data queries directly to reports
  * Use relative time periods instead of fixed dates
  * Include agent analysis in reports
</Update>

<Update label="2025-09-30" description="v0.9.0">
  ### New Feature: Agent Configuration

  * New rich text editor for configuring agent prompts
  * Reference integrations, metrics, and other objects directly in agent prompts using @mentions
  * Configure goal metrics for agents to track

  ### Object Mentions

  * Rich tooltips showing object details on hover
  * Integrations can now be mentioned like other objects in prompts

  ### New Feature: Metric Formulas

  * New UI for creating and editing metric formulas
  * Automatic measure extraction from data queries
  * Visual indicators when objects aren't valid for use in formulas

  ### Field Mapping

  * Redesigned field mapping step in model creation
  * Progressive field mapping during model setup

  ### Query Experience

  * Share queries at specific timestamps
  * Check for model references in queries
</Update>

<Update label="2025-08-29" description="v0.8.0">
  ### New Chart Types

  * Waterfall charts for visualizing incremental changes over time
  * Area and scatter chart options
  * Improved axis formatting with smarter date and time labels

  ### New Feature: Query Sharing

  * Share queries with team members via a new sharing modal
  * Generate public links to share query results externally
  * View and edit permissions now enforced on shared queries

  ### Model Management

  * Improved model editing experience with better field management
  * Bulk operations for business objects
  * Merge duplicate or related business objects
  * Track and display active and inactive fields

  ### Metrics & Measures

  * Improved interfaces for managing measures including SQL preview
  * Better metric type selection and configuration
  * Support for distinct count and other aggregate functions
  * Improved time field handling in models
</Update>

<Update label="2025-07-31" description="v0.7.2">
  ### Query Experience Overhaul

  * Redesigned query creation flow with a cleaner, more intuitive interface
  * New query grid layout for browsing and managing saved queries
  * More responsive query cancellation

  ### Data Exploration

  * Explore dimension values directly within the query interface
  * Real-time "Analyzing..." feedback while the AI processes your question

  ### Integrations

  * Integrations now seamlessly connect to the AI assistant
  * Better visibility into agent task execution status

  ### Permissions

  * New permission scoping for better access control
  * Fixed interaction issues with permission-gated elements

  ### Internationalization

  * Added support for Spanish and French locales
</Update>

<Update label="2025-07-28" description="v0.7.1">
  ### New Feature: Slack as a Source of Context in Reviews

  * The agent uses what your team is already discussing in the channel to improve relevancy and respond to feedback.
  * This gives the agent context around what's important and a method of providing feedback
  * Use this to facilitate an asynchronous weekly business review style workflows

  ### Agent Updates

  * Latency improvements through faster tool initialization with integrations
  * Thread management in Slack across both channels and app DMs
</Update>

<Update label="2025-07-14" description="v0.7.0">
  ### Agent Updates

  * Latency improvements through LLM model caching
  * Enhanced charting configuration
  * Enhanced search capabilities for faster and more relevant results

  ### New Feature: Record-level Data Queries

  * Support for record-level queries to drill into data further
  * Define Attributes for longer context or high cardinality fields (Beta)
</Update>

<Update label="2025-06-01" description="v0.6.2">
  ### New Feature: Tools

  * Tools allow you to leverage context from and take action in your third-party applications
  * Tool integrations include Gmail, Hubspot, Google Calendar, Linear, Notion and 250+ additional integrations.
  * Over time, we'll work to more deeply integrate and connect the objects and resources from these integrations into the Business Graph (e.g., connect a message, meeting transcript, or document to a single, canonical customer record)
</Update>

<Update label="2025-05-15" description="v0.6.1">
  ### Agent Updates

  * Query Agent: Improved Slack search performance and latency
  * Query Agent can now answer questions using Push.ai documentation
  * Added support for web tools, enabling real-time web and documentation search

  ### New Feature: Use the Query Agent in Slack and Microsoft Teams

  * Query the Agent directly in Slack channels, App DMs, and Microsoft Teams
  * Agent responses in Reviews now include deeper background analysis, chart generation, and custom destination formats
</Update>

<Update label="2025-04-28" description="v0.6.0">
  ### New Feature: The Push.ai Query Agent

  * Ask questions in natural language using trusted semantic-layer queries
  * Agentic Business Graph exploration (i.e., it can do data analysis for you)
  * Brings explicity tagged and relevant untagged Business Objects into context
  * Support for citations, sources, charts, tables
</Update>

<Update label="2025-03-25" description="v0.5.23">
  ### General Updates

  * Added support for dimensions with derived metrics
</Update>

<Update label="2025-02-27" description="v0.5.22">
  ### New Feature: Knowledge

  * Support for generic knowledge processors of chat systems, meeting recording transcripts, and documents
  * Source specific and LLM-driven chunking
  * Added ability to integrate knowledge via data warehouses
  * Added ability to upload knowledge from files
</Update>

<Update label="2024-12-20" description="v0.5.21">
  ### General Updates

  * Enhanced performance and latency of the dbt semantic layer integration
</Update>

<Update label="2024-12-12" description="v0.5.20">
  ### General Updates

  * Introduced additional calculations for trailing periods and introduced calculations for future periods including "Next Period" and "Leading Periods"
  * Introduced Spanish translation support

  ### Bug Fixes

  * Fixed issue where calculation order was lost in Reviews
  * Fixed issue with displaying duplicate Dimensions in the Dimension table on metric pages
</Update>

<Update label="2024-12-06" description="v0.5.2">
  ### New Feature: Outliers (experimental)

  * Introduced ability for users to receive outliers for any metrics they've
    subscribed to
  * Introduced sensitivity configuration for outlier detection
</Update>

<Update label="2024-11-26" description="v0.5.1">
  ### Performance Improvements

  * Improved caching and performance of object selectors and omni-search
  * Introduced unlimited scroll for dimension-values, improving app performance with high cardinality dimension values

  ### UI Upgrades

  * Expanded use of iconography for metrics, dimension and dimension-values

  ### Bug Fixes

  * Fixed issues with Review creation and saving
  * Fixed ability to group-by dimensions and filter to dimension values
</Update>


# Caching
Source: https://docs.push.ai/data-sources/caching

Understand how caching and datasource queries work in Push.ai.

Push.ai uses a caching strategy to optimize application performance, while reducing the load on your data sources.

## How it works?

Push.ai queries datasources through two methods:

1. **Calculations**: metric and dimension queries using one of our [calculations](/business-objects/metrics#calculations).
2. **Time-series**: metric and dimension queries using a daily time grain.

## When is caching used?

Caching is used when querying both calculations and timeseries data. Push.ai implements a caching strategy for each unique metric-dimension combination. For each combination, we maintain a daily cache, meaning that we will query that specific combination from the data source at most once per day.

## When are datasource queries triggered?

Push.ai queries datasources using two methods:

1. **In-app Exploration**: Datasource queries are triggered when you interact with a metrics and dimension in the Push.ai UI.
2. **Scheduled Updates**: Datasource queries are triggered on a schedule defined in both Reviews and Subscriptions. With Subscriptions, datasource queries are triggered for each Business Object a user is subscribed to, in addition to any related Business Objects. Related objects include any related metrics and are limited to [AI-enabled dimensions](/business-objects/dimensions#ai-enabled-dimensions) only.

<Info>
  If multiple users are subscribed to the same Business Object, the datasource
  query will be triggered once for each object, rather than once for each user.
</Info>

## When is datasource compute not used?

Datasource compute is not used in any of Push.ai's advanced analytics or AI applications. This includes time-series modeling, such as outlier detection and forecasting. In addition, Push.ai's AI systems combine the existing calculations with large language models, and do not use additional datasource compute.


# Cube Cloud
Source: https://docs.push.ai/data-sources/semantic-layers/cube-cloud

Leverage you cubes, measures and dimensions in Push.ai by connecting with Cube Cloud.

<Note>
  Learn about Push.ai

  <iframe title="YouTube video player" />
</Note>

## How it works?

* Import measures and dimensions to create metrics from your source of truth.
* Explore and visualize data from the Cube Cloud and apply AI using automated analysis.
* Organize metrics and dimensions by department, apply labels and manage access controls.

## Prerequisites

* To connect Push.ai with Cube, you'll need a project set up in Cube Cloud.

<Info>
  Don't have Cube Cloud yet? Learn how to get started using [their
  documentation](https://cube.dev/docs/product/getting-started/cloud).
</Info>

## Setup Guide

### Step 1 - Copy the REST API Endpoint

Copy the REST API endpoint which can be found on the Overview page or by navigating to **Integrations** > **API Credentials** > **REST API**

### Step 2 - Copy an API Token

Copy the authorization token which can be found in the header of the REST API request.

### Step 3 - Configure the connection in Push.ai

| Parameter | Description                                                                       |
| :-------- | :-------------------------------------------------------------------------------- |
| API URL   | the REST API endpoint which can be found on the Overview page or in Integrations. |
| API Key   | the authorization token can be found in the header of a valid REST API request.   |

## Usage Notes

After connecting with Cube, measures and dimensions need to be converted into metrics. This can be done in two ways:

1. Measures and dimensions will automatically be available in the Review builder and can be converted to metrics in the Data section of the Review builder. Any metrics configured here will be created and available throughout the application.
2. Metrics can be imported through the Metric import flow on the metrics page.


# dbt Semantic Layer
Source: https://docs.push.ai/data-sources/semantic-layers/dbt

Leverage your existing metrics and dimensions in Push.ai by connencting with the dbt Semantic Layer.

<Note>
  Learn about Push.ai

  <iframe title="YouTube video player" />
</Note>

## How it works?

* Automatically sync semantic models, metrics and dimensions from your source of truth.
* Explore and visualize data from the dbt Semantic Layer and apply AI using automated analysis.
* Organize metrics and dimensions by department, apply labels and manage access controls.

## Prerequisites

* To connect to the dbt Semantic Layer, you must first set up and have access to the feature in dbt Cloud.

<Info>
  Don't have the dbt Semantic Layer yet? Learn how to get started using [dbt's
  documentation](https://docs.getdbt.com/docs/use-dbt-semantic-layer/setup-sl).
</Info>

## Setup Guide

### **Step 1** - Generate a service token

Generate a service token for use in Push.ai

### Step 2 - Configure Connection in Push.ai

| Parameter      | Description                                                                                                                                                                                                  | Example                                                                                 |
| :------------- | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | :-------------------------------------------------------------------------------------- |
| Access URL     | The [access URL](https://docs.getdbt.com/docs/cloud/about-cloud/regions-ip-addresses) for your account's dbt Cloud region. You must always add the `semantic-layer` prefix before the access URL.            | For dbt Cloud deployment hosted in North America, use `semantic-layer.cloud.getdbt.com` |
| Environment Id | The unique identifier for the dbt production environment. In dbt Cloud, navigate to **Orchestration** → **Environments**, select your desired environment, and copy the environment ID from the URL.         | If your URL ends with `.../environments/222222`, your `environmentId` is `222222`       |
| Service Token  | dbt Cloud [service token](https://docs.getdbt.com/docs/dbt-cloud-apis/service-tokens) with “Semantic Layer Only” and "Metadata Only" permissions. Create a new service token on the *Account Settings* page. | `token=SERVICE_TOKEN`                                                                   |

## Usage Notes

<Warning>
  Changing a metric or dimension `name` in MetricFlow will be recognized as a
  new resource in Push.ai, and the existing resource will be automatically
  deleted.
</Warning>

* To propograte any changes in your MetricFlow configuration, you can update the connection in Push.ai's settings under Integrations.
* After connecting with the dbt Semantic Layer, all supported metrics will become available in Push.ai. Our system may not support all metric types. Please [reach out](mailto:support@push.ai) if you encounter any issues and we can help you get setup.


# Looker
Source: https://docs.push.ai/data-sources/semantic-layers/looker

Import metrics directly from your LookML models.

# LookML

Push.ai allows teams to import metric definitions directly from their existing sources. To setup the Looker integration, an administrator of the Looker account will need to collect:

* Looker Instance URL
* Client ID
* Client Secret

The client ID and client secret can be generated using the Looker API3 Key generation in the users page in Looker. To generate the credentials, navigate to Admin -> Users -> API3 Keys and select Edit Keys. The following screenshots show the locations of each step:

### Usage Notes

After connecting with Looker, measures and dimensions need to be converted into metrics. This can be done in two ways:

1. Measures and dimensions will automatically be available in the Review builder and can be converted to metrics in the Data section of the Review builder. Any metrics configured here will be created and available throughout the application.
2. Metrics can be imported through the Metric import flow on the metrics page.


# BigQuery
Source: https://docs.push.ai/data-sources/warehouses/bigquery

Connect with BigQuery and define your metrics and dimensions in Push.ai.

## Prerequisites

To connect BigQuery to Push.ai, you need the following:

* The ability to create service accounts in Google Cloud console.

## Setup Guide

### Step 1 - Create a service account in the Google Cloud console

If you're not already familiar with Google Cloud IAM you can follow this [link to create service account.](https://console.cloud.google.com/iam-admin/serviceaccounts/create?pli=1)

### Step 2 - Grant permissions

Select and grant the `BigQuery Data Viewer` and `BigQuery User` roles

### Step 3 - Create a key and download the file

Download the JSON key file and save it to your computer.

### Step 4 - Whitelist IP Addresses (if necessary)

Push.ai connects to your warehouse from the following IP addresses. Be sure to allow traffic from these IPs in your firewall, and include them in any database grants.

| Region/Deployment | IP Addresses                                                                                            |
| ----------------- | ------------------------------------------------------------------------------------------------------- |
| All               | `44.226.145.213`, `54.187.200.255`, `34.213.214.55`, `35.164.95.156`, `44.230.95.183`, `44.229.200.200` |

### Step 5 - Configure the connection in Push.ai

1. Copy the `project_id` from URL
2. Upload the JSON key file
3. Test and create the datasource connection.

## Enhanced Security Controls

To implement dataset level permissioning, please see [GCP's most up-to-date documentation](https://cloud.google.com/bigquery/docs/control-access-to-resources-iam#grant_access_to_a_dataset).


# Postgres
Source: https://docs.push.ai/data-sources/warehouses/postgres

Connect with Postgres and define your metrics and dimensions in Push.ai.

## Prerequisites

To connect Postgres to Push.ai, you need the following:

* A Postgres account with the appropriate permissions to create a user.

## Setup Guide

### Step 1 - Create the warehouse connection

1. Log in to your Postgres database.

2. Create a user with read permissions to the schema and tables that you want to connect from.

3. If data will be written back to the warehouse from Push.ai, add a schema and permissions to allow the Push.ai user to write to a specific schema.

### Step 2 - Whitelist IP Addresses (if necessary)

Push.ai connects to your warehouse from the following IP addresses. Be sure to allow traffic from these IPs in your firewall, and include them in any database grants.

| Region/Deployment | IP Addresses                                                                                            |
| ----------------- | ------------------------------------------------------------------------------------------------------- |
| All               | `44.226.145.213`, `54.187.200.255`, `34.213.214.55`, `35.164.95.156`, `44.230.95.183`, `44.229.200.200` |

### Step 3 - Configure the connection in Push.ai

1. Add the Host, Port, Database, Username, Password

2. (Optional) Configure the schema name to write to. By default, data will be written to `PUSH_AI`.

3. Click **Test Postgres** to confirm the connection settings.

4. Click **Connect Postgres** to complete the connection.


# Redshift
Source: https://docs.push.ai/data-sources/warehouses/redshift

Connect with Amazon Redshift and define your metrics and dimensions in Push.ai.

## Prerequisites

To connect Redshift to Push.ai, you need the following:

* A Redshift account with the appropriate permissions to create a user.

## Setup Guide

### Step 1 - Create the warehouse connection

1. Log in to your Redshift data warehouse at [http://console.aws.amazon.com/redshiftv2/home](http://console.aws.amazon.com/redshiftv2/home)

2. Create a user with read permissions to the schema and tables that you want to connect from.

3. If data will be written back to the warehouse from Push.ai, add a schema and permissions to allow the Push.ai user to write to a specific schema.

### Step 2 - Whitelist IP Addresses (if necessary)

Push.ai connects to your warehouse from the following IP addresses. Be sure to allow traffic from these IPs in your firewall, and include them in any database grants.

| Region/Deployment | IP Addresses                                                                                            |
| ----------------- | ------------------------------------------------------------------------------------------------------- |
| All               | `44.226.145.213`, `54.187.200.255`, `34.213.214.55`, `35.164.95.156`, `44.230.95.183`, `44.229.200.200` |

### Step 3 - Configure the connection in Push.ai

1. Add the Host, Port, Database, Username, Password

2. (Optional) Configure the schema name to write to. By default, data will be written to `PUSH_AI`.

3. Test and create the datasource connection.


# Snowflake
Source: https://docs.push.ai/data-sources/warehouses/snowflake

Connect with Snowflake and define your metrics and dimensions in Push.ai.

## Prerequisites

To connect Snowflake to Push.ai, you need the following:

* A Snowflake account with the appropriate permissions to create a user.

## Setup Guide

### Step 1 - Create the warehouse connection

1. Log in to your Snowflake data warehouse.

2. Copy the following script to a new worksheet and select the **All Queries** checkbox:

```
-- Edit the following variables
set push_username='PUSH_AI_USER';
set push_password='<a secure password>';
set push_first_name='Push.ai';
set push_last_name='User';
set push_default_warehouse='<warehouse>';
set push_database='<database>';
set push_default_namespace='<database.schema>';
set push_default_role='PUSH_AI_ROLE';
set push_comment='Used for Push.ai integrations';

-- Set role for grants
USE ROLE ACCOUNTADMIN;

-- Create a role for PUSH_AI
CREATE ROLE IF NOT EXISTS identifier($push_default_role)
COMMENT = $push_comment;

-- Create PUSH_AI's user
CREATE USER IF NOT EXISTS identifier($push_username)
PASSWORD=$push_password
FIRST_NAME=$push_first_name
LAST_NAME=$push_last_name
DEFAULT_WAREHOUSE=$push_default_warehouse
DEFAULT_NAMESPACE=$push_default_namespace
DEFAULT_ROLE=$push_default_role
COMMENT=$push_comment;


-- Grant permissions to the role
GRANT ROLE identifier($push_default_role) TO ROLE SYSADMIN;
GRANT USAGE ON WAREHOUSE identifier($push_default_warehouse) TO ROLE identifier($push_default_role);
GRANT ROLE identifier($push_default_role) TO USER identifier($push_username);

GRANT USAGE ON DATABASE identifier($push_database) TO ROLE identifier($push_default_role);
GRANT USAGE ON ALL SCHEMAS IN DATABASE identifier($push_database) TO ROLE identifier($push_default_role);
GRANT SELECT ON ALL TABLES IN DATABASE identifier($push_database) TO ROLE identifier($push_default_role);
GRANT SELECT ON FUTURE TABLES IN DATABASE identifier($push_database) TO ROLE identifier($push_default_role);
GRANT SELECT ON ALL VIEWS IN DATABASE identifier($push_database) TO ROLE identifier($push_default_role);
GRANT SELECT ON FUTURE VIEWS IN DATABASE identifier($push_database) TO ROLE identifier($push_default_role);

-- Grant write access for Push.ai specific schema (required for additional write-related features)
GRANT CREATE SCHEMA ON DATABASE identifier($push_database) TO ROLE identifier($push_default_role);
```

3. Replace the password, warehouse and database variables with appropriate values.

4. Run the script.

### Step 2 - Whitelist IP Addresses (if necessary)

Push.ai connects to your warehouse from the following IP addresses. Be sure to allow traffic from these IPs in your firewall, and include them in any database grants.

| Region/Deployment | IP Addresses                                                                                            |
| ----------------- | ------------------------------------------------------------------------------------------------------- |
| All               | `44.226.145.213`, `54.187.200.255`, `34.213.214.55`, `35.164.95.156`, `44.230.95.183`, `44.229.200.200` |

### Step 3 - Configure the connection in Push.ai

1. Enter your Snowflake `Account Identifier`. You can find this identifier at the beginning of your Snowflake URL, for example, `https://ACCOUNT_IDENTIFIER.snowflakecomputing.com`.

<Info>
  Account identifier format may differ based on Snowflake account age.

  For example, older Snowflake accounts often have identifiers that look like `<account_locator>.<region>.<cloudprovider>`, whereas newer Snowflake accounts have identifiers that look like `<orgname>-<account_name>`.

  For more details, visit [Snowflake's account identifier docs](https://docs.snowflake.com/en/user-guide/admin-account-identifier.html).
</Info>

2. For `Role`, `Database`, `Warehouse`, `Username`, and `Password` enter the values used when running the script.

3. Test and create the datasource connection.


# Email
Source: https://docs.push.ai/destinations/email

Receive Subscriptions and Reviews where you already collaborate in email.

Email does not require setup and has no special configurations at this time.


# Microsoft Teams
Source: https://docs.push.ai/destinations/microsoft-teams

Receive Subscriptions and Reviews where you already work in Microsoft Teams.

## Setup

<Check>
  The Microsoft Teams integration is available on the [Enterprise
  Plan](https://www.push.ai/pricing).
</Check>

Please [contact us](mailto:support@push.ai) to get started with Push.ai and Microsoft Teams.


# Slack
Source: https://docs.push.ai/destinations/slack

Receive Subscriptions and Reports where you already work in Slack.

## Setup

<Note>You may need to contact your Slack administrator for approval.</Note>

1. Navigate to [**Settings**](https://app.push.ai/settings) > [**Integrations**](https://app.push.ai/settings).
2. Click **"Connect"** under the Slack integration
   and complete the flow.
3. Individual users should map their Slack user to their Push.ai user in [**User Settings**](https://app.push.ai/settings/user).

## User Guide

### Using the Query Agent in Slack Channels

The Query Agent will repond to direct mentions (`@push.ai`) in any public or private channels. Agent conversations are mapped to individual Slack threads. For example, to maintain a conversation history, tag the app in the same thread.

### Using the Query Agent in App DM's

The Query Agent will respond to any messages directly with the app. Similar to channel conversations, agent conversations in app DM's are mapped to individual Slack threads. Reply in the thread to maintain the same conversation.

<Note>If you connected your Slack instance after July, 14th 2025, you may have to re-authenticate with an expanded scope to be able to trigger the agent in channels.</Note>

### Selecting Channels

Reviews can be delivered via shared channels, private channels and direct app messages, while Subscriptions are configured at the user-level and delivered only via direct app messages.

<Note>
  To send to a private channel, you must first invite the Push.ai Slack application by typing `@push.ai`.
</Note>

### Custom Emojis

We recommend adding our custom emoji pack to your Slack workspace to leverage our complete design for Slack:

1. Download Push.ai's custom emoji pack [here](https://app.push.ai/push-ai_emoji_pack.zip)
2. Upload the emoji's to your Slack workspace.

<Warning>
  Be mindful of emoji names when uploading emojis. Emoji names should match the
  naming convention in the files.
</Warning>

### Security

All organization-scoped integrations are on by default in Slack chanels. User-scoped integrations are only available in App DM's with a Slack user mapped to that Push.ai user.


# Admins & Data Teams
Source: https://docs.push.ai/getting-started/admin

Learn how to setup Push.ai for your organization.

<Info>
  **Prerequisite** You should have admin access to one of our supported data
  sources. If you'd like help with navigating setup, you can [reach out to
  us](mailto:support@push.ai) or [book
  time](https://calendly.com/d/g3s-mwy-jpb/push-ai-intro) with someone from our
  team.
</Info>

<Steps>
  <Step title="Connect a data source and chat workspace">
    Connect with one of our supported data sources, using either a semantic
    layer or data warehouse integration.
  </Step>

  <Step title="Define Business Objects">
    Define metrics, dimensions, and metadata within Push.ai or integrate them
    directly using a semantic layer.
  </Step>

  <Step title="Use Reviews and Subscriptions to receive updates">
    Use Subscriptions to receive a personalized feed of updates, including AI
    Summaries. Use Reviews to send updates to shared company channels.
  </Step>

  <Step title="Invite your team">
    Invite Business Users to set up their own Subscriptions and access data
    inside Push.ai.
  </Step>
</Steps>

## Troubleshooting

Here's how to solve some common problems when setting up Push.ai.

<AccordionGroup>
  <Accordion title="I can't connect to my data source">
    Be sure you have assigned the proper roles and permissions to Push.ai. If
    applicable, make sure you have white listed the following IP addresses:
    `44.226.145.213`, `54.187.200.255`, `34.213.214.55`,
    `35.164.95.156`, `44.230.95.183`, `44.229.200.200`.
  </Accordion>

  <Accordion title="I'm unable to connect with my Slack workspace">
    You may need to request apporval from your Slack administrator.
  </Accordion>

  <Accordion title="I'm getting an unknown error">
    Please [reach out to us](mailto:support@push.ai) and we'll be happy to help
    you get setup.
  </Accordion>
</AccordionGroup>

Need additional help? Feel free to [contact us.](mailto:support@push.ai)


# Business Users
Source: https://docs.push.ai/getting-started/business

Learn how to get started with Push.ai as a new user.

<Info>
  **Prerequisite** To get started with Push.ai, you'll need to connect with your
  company's internal data systems. This responsibility usually lies with a data
  team. If you'd like help with navigating setup, you can [reach out to
  us](mailto:support@push.ai) or [book
  time](https://calendly.com/d/g3s-mwy-jpb/push-ai-intro) with someone from our
  team.
</Info>

<Steps>
  <Step title="Create an account using your company email">
    Connect with one of our supported data sources, using either a semantic
    layer or data warehouse integration.
  </Step>

  <Step title="Enter your user details and connect your Slack user if applicable">
    Give context about you and your role. If your organization uses Slack,
    connect your Slack user to receive personalized updates in your DM.
  </Step>

  <Step title="Subscribe to Business Objects">
    Subscribe to the parts of the business you care about. Receive a personalize
    feed of updates where you already work.
  </Step>
</Steps>

## Troubleshooting

Here's how to solve some common problems when working with Push.ai:

<AccordionGroup>
  <Accordion title="I haven't received my Subscription">
    First, check your Subscription settings in
    [**Settings**](https://app.push.ai/settings). Otherwise, you can contact
    your administrator.
  </Accordion>

  <Accordion title="I can't find the metrics I'm looking for">
    Verify with your data team or administrator that they've defined the metrics
    you're looking for.
  </Accordion>

  <Accordion title="I'm getting an unknown error">
    Please [reach out to us](mailto:support@push.ai) and we'll be happy to help
    you get setup.
  </Accordion>
</AccordionGroup>

Need additional help? Feel free to [contact us](mailto:support@push.ai) or reach out to your admin.


# Ably
Source: https://docs.push.ai/integrations/ably



Ably is a real-time messaging platform helping developers build live features, including chat and data synchronization, with global scalability and robust reliability for modern applications

<Accordion title="Query Batch Presence">
  This tool enables querying the presence states of multiple channels in a single api request. the api retrieves the member presence details of the specified channels in parallel.
</Accordion>

<Accordion title="Get Channel History">
  This tool retrieves the message history for a specified ably channel. it uses the get /channels/\{channelid}/messages endpoint to return a paginated list of messages in chronological order, subject to parameters such as 'channelid', 'limit', 'direction', 'start', and 'end'. the tool is useful for auditing, recovering missed messages, analyzing channel activity, and debugging message flows. authentication is required via basic or token authentication.
</Accordion>

<Accordion title="Get Ably Service Time">
  This tool retrieves the current server time from ably's service in milliseconds since the epoch. it is particularly useful for time synchronization and generating valid tokenrequest timestamps to prevent replay attacks. the endpoint supports multiple content types, handles http errors, network issues, and is a fundamental tool for ensuring accurate timing in ably applications.
</Accordion>

<Accordion title="Query Batch Presence History">
  This tool enables querying presence history for multiple channels in a single api request. it uses the get endpoint at [https://rest.ably.io/presence](https://rest.ably.io/presence) to retrieve the member presence history details of the specified channels in parallel.
</Accordion>

<Accordion title="Delete Channel Subscription">
  This tool allows you to unsubscribe devices or clients from push notifications for specific channels. the operation is asynchronous, so immediate requests after deletion may briefly still return the subscription.
</Accordion>

<Accordion title="Get Channel Details">
  This tool retrieves metadata and details for a specific channel in ably. it returns a channeldetails object containing information about the channel's status, occupancy, and other metadata. the endpoint provides visibility into channel activity, including metrics such as connections, presence, publishers, and subscribers, and requires appropriate permissions.
</Accordion>

<Accordion title="Get Channel Presence History">
  This tool retrieves the history of presence messages for a specified channel in ably. it allows you to query presence events on a channel within a given time period.
</Accordion>

<Accordion title="Get Application Stats">
  This tool retrieves your application's usage statistics from ably. the stats endpoint returns a paginated list of your application's usage statistics by minute, hour, day, or month. it supports optional parameters such as start, end, direction, limit, and unit to filter and format the returned data. the stats include metrics for: - message counts and data transferred - connection counts - channel usage - api request counts - push notification metrics - token request counts
</Accordion>

<Accordion title="List Push Channel Subscriptions">
  This tool retrieves a list of all push notification channel subscriptions. it allows you to view all active push notification subscriptions for channels in your ably application. allows filtering by channel, deviceid, and clientid, supports pagination with limit parameter, and returns detailed push notification subscription information including channel, deviceid, and clientid.
</Accordion>

<Accordion title="Publish Message to Channel">
  This tool will allow users to publish a message to a specified ably channel using a post request. it covers the essentials like channel name, message data, optional event name/type, and additional metadata for push notifications. it is an independent and fundamental operation within ably's real-time messaging platform.
</Accordion>

<Accordion title="Create Ably Channel">
  Creates a new channel or retrieves an existing channel in ably. this tool allows you to programmatically create and initialize channels for real-time messaging. since ably creates channels implicitly when first used, this action publishes an empty initialization message to create/activate the channel.
</Accordion>


# Acculynx
Source: https://docs.push.ai/integrations/acculynx



Using the AccuLynx API, data can be seamlessly exchanged between AccuLynx and other applications for greater efficiency and productivity.

<Accordion title="Job appointment summary">
  Retrieves a list of appointments from the calendar associated with a specific job in acculynx. this endpoint is used to fetch scheduled events, such as site visits, inspections, or project milestones, for a particular roofing or construction job. it provides valuable information for project management and scheduling purposes. the endpoint should be used when you need to view or manage the timeline of events for a specific job. it will not provide general calendar information or appointments unrelated to the specified job id. the response likely includes details such as appointment dates, times, descriptions, and associated team members, though the exact structure is not specified in the given schema.
</Accordion>

<Accordion title="List of calendars for the location">
  Retrieves a list of calendars associated with the authenticated user or organization in acculynx. this endpoint provides access to the calendar data, which is crucial for scheduling and organizing tasks in the roofing and construction project management context. it should be used when you need to obtain an overview of all available calendars or to gather calendar ids for use in other api operations. the endpoint returns basic information about each calendar, likely including identifiers, names, and possibly associated metadata. it does not modify any calendar data and is intended for read-only operations. keep in mind that the response may be paginated for large datasets, and additional parameters might be available for filtering or sorting the results, although they are not specified in the current schema.
</Accordion>

<Accordion title="Update company representative">
  This endpoint allows you to add a company representative to a specific job within the acculynx system. it is used when you need to associate a representative with a particular project or task. the endpoint requires the job's unique identifier and the representative's id to establish the connection. this operation is useful for assigning personnel to projects, tracking responsibilities, and maintaining accurate job records. it's important to note that this endpoint only adds the association and doesn't create new representative or job entries.
</Accordion>

<Accordion title="Create a lead">
  This endpoint creates a new lead in the acculynx system, specifically for residential roofing projects. it should be used when a new potential customer expresses interest in roofing services or when importing lead data from external sources. the endpoint captures essential contact information to initiate the lead management process. while it creates the lead, it does not assign priorities or sales representatives; these actions would need to be performed separately. the endpoint is designed for simplicity and quick lead entry, focusing on the most crucial identifying information.
</Accordion>

<Accordion title="List of contact types related to the company">
  Retrieves a list of all available contact types in the acculynx system. this endpoint is used to fetch the predefined categories or classifications for contacts, such as residential, repair, property management, and other job categories. it's essential for organizing and filtering contact information within the acculynx platform. the endpoint should be used when setting up new contacts, updating existing ones, or when needing to populate dropdown menus or filter options in the user interface. it does not create, modify, or delete contact types; it only provides the current list of available options. the response will likely include unique identifiers and names for each contact type, allowing for easy integration with other parts of the acculynx api or external systems.
</Accordion>

<Accordion title="Add job appointment">
  This endpoint allows users to schedule the initial appointment for a specific job in the acculynx system. it is used to set up the first meeting or site visit for a construction or roofing project. the endpoint requires the job id, start date and time, and end date and time for the appointment. this is crucial for initiating the project workflow and ensuring that all parties involved are aware of the scheduled time for the first interaction. the appointment details are set in the context of the company's timezone unless otherwise specified. use this endpoint when a new job has been created and the first appointment needs to be scheduled with the client or at the job site.
</Accordion>

<Accordion title="Create a job">
  Creates a new job in the acculynx system with the provided details. this endpoint allows you to initialize a job with essential information such as the associated contact, location, job category, work type, priority, and trade types. it's particularly useful for setting up new projects or tasks within the acculynx platform for the roofing and construction industries. the endpoint requires at minimum a contact id and location address, with several optional fields to further customize the job entry. use this when you need to programmatically create new jobs in acculynx, such as when integrating with other systems or automating job creation processes.
</Accordion>

<Accordion title="Create a contact">
  Creates a new contact in the acculynx system with detailed information for use in roofing and construction project management. this endpoint allows for the addition of comprehensive contact details including personal information, company affiliation, communication preferences, and address information. it's particularly useful for adding new customers, leads, vendors, or any other type of contact relevant to construction projects. the endpoint provides flexibility in the amount of information that can be added, with only the contact type being required. use this when you need to add a new contact to your acculynx database or update your system with new lead information. note that while many fields are optional, providing as much information as possible will enhance the usefulness of the contact record for future project management and communication purposes.
</Accordion>


# Active campaign
Source: https://docs.push.ai/integrations/active_campaign



ActiveCampaign provides APIs for marketing automation, customer
relationship management (CRM), and email marketing.

<Accordion title="Add contact note">
  Add a note to a contact in activecampaign. the note will be associated with a contact as a subscriber type. the tool will first find the contact id using the provided email address and then create the note.
</Accordion>

<Accordion title="Create contact">
  Creates a new contact in activecampaign with the specified details. this action allows you to create a new contact with basic information like email, name, phone, organization details, and tags. the email address is the only required field, while all other fields are optional.
</Accordion>

<Accordion title="List all contacts">
  List all contacts in activecampaign. this action allows you to: 1. list all contacts with pagination 2. search contacts by name, organization, phone, or email 3. filter contacts by email pattern 4. sort contacts by various fields 5. filter contacts by creation and update dates 6. filter contacts by list, tag, or segment
</Accordion>

<Accordion title="Manage contact tag">
  Manage tags for a contact in activecampaign. this action allows adding or removing tags from a contact. the action can be performed using either the contact's id or email address.
</Accordion>

<Accordion title="Manage list subscription">
  Subscribe or unsubscribe a contact from a list in activecampaign. the tool requires either a contact's email address or contact id, and can perform either a subscribe or unsubscribe action on a specified list.
</Accordion>

<Accordion title="Create contact task">
  Create a task associated with a contact in activecampaign. this action allows you to create a new task that will be associated with a specific contact in your activecampaign account. the task can include details such as due date, title, description, and can be assigned to a specific user.
</Accordion>

<Accordion title="Find contact">
  Find a specific contact in activecampaign using either their email address, id, or phone number. this action provides a more efficient way to find a specific contact instead of listing all contacts.
</Accordion>


# Affinity
Source: https://docs.push.ai/integrations/affinity



Affinity helps private capital investors to find, manage, and close more deals

<Accordion title="Get metadata on a single list">
  Returns metadata on a single list.
</Accordion>

<Accordion title="Get a company s list entries">
  Summarize company data across all lists, including list-specific fields and metadata like creation date and author. access requires "export data from lists" permission.
</Accordion>

<Accordion title="Get a person s lists">
  Returns metadata for all the lists on which the given person appears.
</Accordion>

<Accordion title="Get metadata on a single list s fields">
  Returns metadata on the fields available on a single list. use the returned field ids to request field data from the get `/v2/lists/\{listid\}/list-entries` endpoint.
</Accordion>

<Accordion title="Get a person s list entries">
  Summary: browse rows for a person in all lists, showing field data and entry metadata like creation time and author. requires "export data from lists" permission.
</Accordion>

<Accordion title="Get a single company">
  Retrieve basic company info and specific field data by using `fieldids` or `fieldtypes` parameters. multiple fields can be queried. no field data if parameters aren't specified. requires "export all organizations directory" permission.
</Accordion>

<Accordion title="Get metadata on a single saved view">
  Returns metadata on a single saved view.
</Accordion>

<Accordion title="Get a single opportunity">
  Get basic details about an opportunity without field data via provided endpoints. field data requires using specific list entry apis and the "export data from lists" permission.
</Accordion>

<Accordion title="Get all companies">
  Affinity api allows paginated access to company info and custom fields. use `fieldids` or `fieldtypes` to specify data in a request. retrieve field ids/types via get `/v2/companies/fields`. export permission needed.
</Accordion>

<Accordion title="Get all list entries on a list">
  Access and export essential data and metadata for companies, persons, or opportunities from a list, specifying data via `fieldids` or `fieldtypes`. "export data from lists" permission is necessary.
</Accordion>

<Accordion title="Get metadata on company fields">
  Returns metadata on non-list-specific company fields. use the returned field ids to request field data from the get `/v2/companies` and get `/v2/companies/\{id\}` endpoints.
</Accordion>

<Accordion title="Get a single person">
  Use get `/v2/persons/fields` with `fieldids` or `fieldtypes` for detailed data; basic info by default. request multiple fields at once. "export all people" permission needed.
</Accordion>

<Accordion title="Get all list entries on a saved view">
  Use the endpoint to access rows in a saved view with specific filters and selected fields from a web app. it doesn't maintain sort order, supports only sheet-type views, and requires export permissions.
</Accordion>

<Accordion title="Get metadata on person fields">
  Returns metadata on non-list-specific person fields. use the returned field ids to request field data from the get `/v2/persons` and get `/v2/persons/\{id\}` endpoints.
</Accordion>

<Accordion title="Get all opportunities">
  Pagination through opportunities in affinity yields basic info but excludes field data. for field data, use specified get endpoints. "export data from lists" permission needed.
</Accordion>

<Accordion title="Get current user">
  Returns metadata about the current user.
</Accordion>

<Accordion title="Get all persons">
  The affinity api offers paginated access to person data using `fieldids` or `fieldtypes`. bulk extraction needs special permissions and supports multiple parameters.
</Accordion>

<Accordion title="Get a company s lists">
  Returns metadata for all the lists on which the given company appears.
</Accordion>

<Accordion title="Get metadata on all lists">
  Returns metadata on lists.
</Accordion>

<Accordion title="Get metadata on saved views">
  Returns metadata on the saved views on a list.
</Accordion>


# Agencyzoom
Source: https://docs.push.ai/integrations/agencyzoom



AgencyZoom is for the P\&C insurance agent that's looking to increase sales, boost retention and analyze agency & producer performance.

<Accordion title="Initiate dashboard data request">
  The v4sso sso login endpoint facilitates single sign-on (sso) authentication for agencyzoom while simultaneously requesting dashboard data. this dual-purpose endpoint streamlines the login process and initial data retrieval, enhancing user experience and reducing api calls. it should be used when a user needs to authenticate and immediately access their dashboard information. the endpoint expects login credentials and optionally a v4sso callback code, returning authentication tokens and relevant dashboard data upon successful login. note that this endpoint combines authentication and data retrieval, which may not be suitable for scenarios where only authentication or only dashboard data is needed.
</Accordion>

<Accordion title="Batch create contacts">
  The batchcreatecontacts endpoint enables creation of multiple contacts (up to 5) in a single api call within agencyzoom. it's ideal for efficiently importing new contacts or updating records from external sources. the endpoint requires 'firstname' and 'lastname' for each contact, with optional fields for additional details. note the 5-contact limit per request for larger datasets.
</Accordion>

<Accordion title="Batch create leads">
  The batchcreateleads endpoint allows for the efficient creation of multiple leads in a single api call. this endpoint is designed to streamline the process of adding new leads to the agencyzoom system, supporting up to 5 lead creations per request. it's particularly useful for bulk imports or when integrating lead generation systems with agencyzoom. the endpoint accepts an array of lead objects, each containing essential information such as the lead's name, contact details, assigned agent, and pipeline information. additional optional fields allow for comprehensive lead profiling, including custom fields for agency-specific data. when using this endpoint, ensure that all required fields are provided for each lead and that the total number of leads does not exceed the maximum limit of 5 per request. this batch creation method significantly reduces api calls and improves efficiency when handling multiple new leads simultaneously.
</Accordion>

<Accordion title="Add note to lead">
  Adds a new note to a specific lead in the agencyzoom platform. this endpoint is used to record important information, interactions, or updates related to a lead. it's particularly useful for maintaining a comprehensive history of client communications and internal observations. the note is associated with the lead identified by the provided leadid. this endpoint should be used whenever there's new information to add to a lead's record, such as after a phone call, email exchange, or any significant event in the sales process. it does not modify any other lead information besides adding the new note. the endpoint is essential for keeping all team members informed about the latest developments with each lead, facilitating better collaboration and follow-up strategies.
</Accordion>

<Accordion title="Create opportunity driver request">
  Creates a new driver record associated with a specific opportunity in the agencyzoom platform. this endpoint is used to add detailed driver information to an existing opportunity, which is crucial for insurance agencies managing client data and policy quotes. it captures comprehensive driver details including personal information, relationship status, and licensing information. the endpoint also offers the option to automatically create a contact in the system based on the driver information provided. use this endpoint when you need to add a new driver to an opportunity or update driver information for insurance quoting or policy management purposes. note that while many fields are optional, providing complete and accurate information will result in more comprehensive records and potentially more accurate insurance quotes.
</Accordion>

<Accordion title="Batch delete tasks by id">
  Allows batch deletion of multiple tasks in the agencyzoom platform. this endpoint is designed for efficiently removing multiple tasks simultaneously, reducing the need for individual deletion requests. it should be used when you need to delete several tasks at once, such as when cleaning up completed or outdated tasks. the endpoint accepts an array of task ids and attempts to delete all specified tasks. note that this operation is irreversible, so care should be taken to ensure that all listed task ids are intended for deletion. the endpoint does not provide confirmation of individual task deletions, so it's advisable to verify the results separately if needed.
</Accordion>

<Accordion title="Add opportunity data to lead">
  Adds a new opportunity to an existing lead in agencyzoom. this endpoint allows you to associate detailed opportunity information with a specific lead, including the insurance carrier, product line, premium amount, and number of items. it's particularly useful for tracking potential sales and managing the sales pipeline within the agency. the endpoint also supports custom fields, enabling the capture of agency-specific data alongside standard opportunity information. use this when you need to create a new sales opportunity for an existing lead or want to update your sales pipeline with fresh potential business. this endpoint is crucial for maintaining an up-to-date and comprehensive view of your agency's sales activities and potential revenue streams.
</Accordion>

<Accordion title="Delete customer by id">
  Deletes a specific customer record from the agencyzoom platform. this endpoint should be used when an agency needs to permanently remove a customer's information from their database, such as when a customer relationship has ended or due to data privacy requests. it's important to note that this action is irreversible and will remove all associated data for the specified customer. use this endpoint with caution, as it may have implications on historical reporting and data integrity. always ensure proper authorization and confirmation before executing a customer deletion.
</Accordion>

<Accordion title="Delete customer file">
  Deletes a specific file associated with a customer in the agencyzoom platform. this endpoint is used when you need to remove a file from a customer's record, such as outdated documents or incorrectly uploaded files. it's important to note that this operation is irreversible, so it should be used with caution. the endpoint requires both the customer id and the specific file id to ensure precise file deletion within the customer's records.
</Accordion>

<Accordion title="Delete lead quote by id">
  Deletes a specific quote associated with a particular lead in the agencyzoom system. this endpoint should be used when you need to permanently remove a quote from a lead's record, such as when a quote is no longer valid or relevant. it's important to note that this operation is irreversible, so it should be used with caution. the endpoint requires both the lead id and quote id to ensure precise targeting of the quote to be deleted. after successful deletion, the quote will no longer be accessible or associated with the specified lead.
</Accordion>

<Accordion title="Delete task by id">
  Deletes a specific task from the agencyzoom system using its unique identifier. this endpoint should be used when a task is no longer relevant, completed outside the system, or entered in error. it permanently removes the task from the user's task list and associated workflows. use with caution as this action cannot be undone. the endpoint is particularly useful for maintaining a clean and organized task list, ensuring that only active and relevant tasks are visible to users. it does not return the deleted task information, so make sure to retrieve any necessary data before deletion.
</Accordion>

<Accordion title="Delete customer policy">
  Deletes a specific policy associated with a customer in the agencyzoom system. this endpoint should be used when an agency needs to remove a policy from a customer's account, such as when a policy has been cancelled or is no longer active. it's important to note that this action is irreversible, so it should be used with caution. this endpoint does not return the deleted policy details; it typically returns a success status if the deletion is completed or an error if the policy or customer cannot be found or if there are any issues with the deletion process.
</Accordion>

<Accordion title="Delete opportunity by id">
  Deletes a specific opportunity from the agencyzoom system using its unique identifier. this endpoint should be used when an agency needs to remove an opportunity that is no longer relevant, has been closed, or was created in error. it permanently removes the opportunity data, so it should be used with caution. the deletion is irreversible, and once an opportunity is deleted, it cannot be recovered through the api. this endpoint is useful for maintaining data accuracy and cleaning up the agency's opportunity pipeline.
</Accordion>

<Accordion title="Get certificate signing requests">
  Retrieves a list of customer service representatives (csrs) associated with the agency in agencyzoom. this endpoint allows agencies to access information about their csr team, which can be useful for performance tracking, workload distribution, and team management. the retrieved data likely includes details such as csr names, contact information, and possibly performance metrics. use this endpoint when you need an overview of your customer service team or when integrating csr data with other systems for reporting or workflow automation purposes. note that the specific fields returned and any filtering options are not detailed in the provided schema, so additional documentation may be needed for a complete understanding of the response structure and query capabilities.
</Accordion>

<Accordion title="Change lead status via leadid">
  This endpoint updates the status of a lead in agencyzoom, allowing for comprehensive lead management and workflow transitions. it can be used to mark leads as active, won, lost, or x-dated, with additional options for specifying workflow stages, recycling parameters, and lead sources. the endpoint is particularly useful for automating lead lifecycle management, handling lead recycling processes, and maintaining accurate status information within the agencyzoom system. it should be used whenever there's a need to change a lead's status or move it through different stages of your sales pipeline. note that while only the 'status' field is required, providing additional parameters can offer more context and control over the lead's journey through your workflow.
</Accordion>

<Accordion title="Retrieve customer ams policies">
  Retrieves the ams (agency management system) policies associated with a specific customer in the agencyzoom platform. this endpoint allows users to fetch policy information that has been synchronized from an integrated agency management system for a given customer. it should be used when you need to access up-to-date policy details for a particular customer, such as during customer reviews, policy updates, or when generating reports. the endpoint provides a comprehensive view of the customer's policies as stored in the ams, but it does not allow for policy modifications or creations through this call.
</Accordion>

<Accordion title="Delete opportunity driver by id">
  This endpoint deletes an opportunity associated with a specific driver in the agencyzoom platform. it is used to remove a lead, potential sale, or business engagement from a driver's record when it's no longer relevant or needed. the deletion is permanent and should be used with caution. this tool is particularly useful for maintaining an up-to-date and accurate sales pipeline by removing opportunities that have been closed, lost, or are no longer pursuable. it helps in keeping the agency's opportunity tracking system clean and efficient.
</Accordion>

<Accordion title="Get authentication parameters via sso api">
  The get auth params endpoint retrieves the necessary authentication parameters for single sign-on (sso) integration with agencyzoom. this endpoint should be used when initiating an sso authentication flow or when refreshing sso authentication details. it provides the required parameters to properly configure and execute the sso process with agencyzoom's authentication system. the endpoint doesn't require any input parameters, simplifying the process of obtaining up-to-date sso configuration. however, users should be aware that the returned parameters may change over time, so it's recommended to call this endpoint before each sso attempt rather than caching the results for extended periods.
</Accordion>

<Accordion title="Add quote data to lead">
  Adds a new quote to a specific lead in the agencyzoom platform. this endpoint allows users to associate detailed quote information with a lead, including carrier details, product information, premium amount, and custom fields. it's particularly useful for tracking and managing different insurance quotes offered to a potential client. the endpoint should be used when a new quote is generated for a lead or when updating quote information. it provides a comprehensive way to capture both standard quote data and agency-specific information through custom fields, enhancing the lead management process. note that this endpoint only adds quote data and does not process or bind the insurance policy itself.
</Accordion>

<Accordion title="Retrieve drivers by opportunity id">
  Retrieves the drivers associated with a specific opportunity in agencyzoom. this endpoint allows users to fetch detailed information about the factors influencing a particular sales opportunity, which can include customer data, policy information, or other relevant details that impact the opportunity's success. it should be used when analyzing the key elements affecting a specific sales lead or potential business. the tool provides insights into what's driving the opportunity, helping agents make informed decisions and strategize effectively. note that this endpoint only returns driver information for a single opportunity at a time and does not provide an overview of multiple opportunities or agency-wide analytics.
</Accordion>

<Accordion title="Delete vehicle opportunity by id">
  This endpoint deletes a specific vehicle associated with an opportunity in the agencyzoom system. it is used to remove a vehicle from the database when it is no longer relevant to an insurance opportunity or lead. the operation is permanent and should be used with caution as it may affect related data or workflows within the agency management process. this endpoint is particularly useful for maintaining accurate and up-to-date information about potential insurance deals, especially when vehicle details change or are no longer part of the opportunity. it does not provide any information about the deleted vehicle or the status of the deletion process, so additional verification may be necessary after calling this endpoint.
</Accordion>

<Accordion title="Retrieve loss reasons endpoint">
  Retrieves a comprehensive list of loss reasons from the agencyzoom system. this endpoint is designed to provide insurance agencies with standardized reasons for policy losses or claim denials. it should be used when agencies need to categorize or analyze the causes of lost business or rejected claims. the tool returns all available loss reasons without any filtering options, making it useful for populating dropdown menus or conducting overall loss analysis. however, it does not provide detailed statistics or frequency of each loss reason; it only offers the predefined list of reasons.
</Accordion>

<Accordion title="Create opportunity vehicle">
  Creates a new vehicle record associated with a specific opportunity in agencyzoom. this endpoint is used to add detailed vehicle information to an existing opportunity, which is crucial for insurance agencies managing auto policies or quotes. it allows for the input of essential vehicle data such as make, model, year, vin, and ownership status, enabling agents to accurately assess and process insurance-related opportunities. the endpoint should be used when new vehicle information needs to be added to an opportunity, typically during the quoting process or when updating client information. it's important to note that this endpoint only creates the vehicle record and does not modify other aspects of the opportunity. ensure that the opportunityid is valid and that you have the necessary vehicle details before making the api call.
</Accordion>

<Accordion title="Assign groups endpoint">
  Retrieves information about assigned groups within the agencyzoom platform. this endpoint allows users to fetch details about organizational structures, teams, or categories that have been set up and assigned within their agency. it can be used to get an overview of how tasks, leads, or responsibilities are distributed across different groups in the agency. the endpoint does not accept any parameters, suggesting it may return a comprehensive list of all assigned groups by default. use this endpoint when you need to understand the current group structure or assignment distribution in your agencyzoom account. note that this endpoint may not provide detailed information about individual group members or specific assignments; it's primarily for getting a high-level view of the assigned group structure.
</Accordion>

<Accordion title="Retrieve locations list">
  Retrieves a list of all locations or branches associated with the agency in agencyzoom. this endpoint provides comprehensive information about each office, which may include details such as address, contact information, operating hours, and assigned territories. it is particularly useful for agencies with multiple branches to manage their office network, support territory management, and maintain up-to-date location data. the endpoint should be used when an overview of all agency locations is needed, such as for reporting, administrative purposes, or integrating location data with other systems. note that this endpoint returns all locations without filtering, so it may not be suitable for retrieving specific location details in high-volume scenarios.
</Accordion>

<Accordion title="Retrieve pipeline and stage information">
  Retrieves a comprehensive list of pipelines and their associated stages within the agencyzoom system. this endpoint provides crucial information for understanding and managing workflow processes in an insurance agency. it should be used when you need an overview of all available pipelines and their constituent stages, which is essential for task organization, progress tracking, and workflow optimization. the endpoint returns data about the structure of your agency's workflows, including pipeline names, stage sequences, and potentially other relevant metadata. it does not modify any existing pipelines or stages, nor does it provide detailed information about specific tasks or leads within these pipelines.
</Accordion>

<Accordion title="Get lead source categories">
  Retrieves a list of lead source categories from the agencyzoom system. this endpoint allows users to fetch the predefined categories used for classifying lead sources within the agency. it's useful for understanding how leads are organized and for maintaining consistency when adding new leads or analyzing lead data. the categories returned can be used in other api calls or within the agencyzoom platform to properly categorize and manage leads. this endpoint does not accept any parameters, suggesting it returns all available categories without filtering options.
</Accordion>

<Accordion title="Retrieve product lines listing">
  Retrieves a list of product lines available in the agencyzoom platform. this endpoint allows users to fetch information about various insurance products or services that can be managed through agencyzoom. it should be used when an agency needs to view or update their product offerings, or when integrating agencyzoom with other systems that require product line information. the endpoint provides a comprehensive overview of all product lines but does not include detailed information about individual policies or customers associated with each product line. it's particularly useful for agencies looking to streamline their product management or analyze their current product portfolio.
</Accordion>

<Accordion title="Retrieve vehicles for opportunity">
  Retrieves a list of vehicles associated with a specific opportunity in the agencyzoom platform. this endpoint is useful for accessing detailed information about vehicles linked to a particular insurance opportunity, such as a quote, policy, or claim. it should be used when you need to review or process vehicle-specific data within the context of an agency's opportunity management workflow. the endpoint provides a comprehensive view of all vehicles tied to the given opportunity, which can be crucial for accurate policy pricing, risk assessment, or claim processing. note that this endpoint only returns vehicle information and does not modify any existing data.
</Accordion>

<Accordion title="Create business lead">
  Creates or updates a business lead in the agencyzoom platform. this endpoint is used to input detailed information about a potential business client, including both personal contact details and company-specific data. it's particularly useful for b2b sales and marketing teams who need to manage and track business leads through various stages of the sales pipeline. the endpoint requires essential information like the lead's name, email, and assignment details, while also allowing for extensive additional data to be recorded, such as business classification, revenue, and custom fields. use this when you need to add a new business lead to the system or update an existing one with new information. note that this endpoint is specifically designed for business leads and includes fields that may not be relevant for individual consumer leads.
</Accordion>

<Accordion title="List carriers via api">
  Retrieves a list of insurance carriers available in the agencyzoom system. this endpoint allows users to fetch information about various insurance providers integrated with agencyzoom. it should be used when you need to obtain an up-to-date list of carriers for tasks such as populating dropdown menus, verifying carrier availability, or syncing carrier data with other systems. the endpoint returns basic information about each carrier, which may include their name, id, and possibly other relevant details. keep in mind that this endpoint does not provide detailed information about specific policies or coverage options offered by the carriers.
</Accordion>

<Accordion title="Fetch lead recycle events">
  Retrieves the recycle events associated with a specific lead in the agencyzoom platform. this endpoint allows users to fetch the history of recycling activities for a given lead, which can include events such as lead reassignment, reactivation, or any other recycling-related actions. it is particularly useful for tracking the lifecycle of a lead and understanding how it has been managed over time. the endpoint should be used when analyzing lead management processes, auditing lead handling, or gathering data for performance metrics related to lead recycling efficiency.
</Accordion>

<Accordion title="Retrieve employee data">
  Retrieves a list of employees within the agency from the agencyzoom system. this endpoint allows users to access comprehensive employee information, which can be crucial for managing staff, tracking performance, and maintaining accurate records for e\&o compliance. it's designed to be used when an overview of all employees or specific employee details are needed. the endpoint returns data such as employee names, roles, contact information, and potentially performance metrics or task assignments. however, it does not modify any employee data and should not be used for updates or deletions. note that the response may be paginated for large agencies, and additional calls might be necessary to retrieve the complete employee list.
</Accordion>

<Accordion title="Access life professionals api">
  Retrieves a list of life insurance professionals managed within the agencyzoom platform. this endpoint allows users to access information about life insurance agents, brokers, or other professionals associated with their agency. it can be used to gather data for performance tracking, communication management, or workflow automation purposes. the endpoint does not provide detailed sales data or customer information, focusing solely on professional-related data. note that the specific fields returned for each professional are not defined in the given schema and may need to be confirmed with the api documentation.
</Accordion>

<Accordion title="Post lead files request">
  The leadfilesearch endpoint allows you to search and retrieve lead files within the agencyzoom platform. this post request to /v1/api/leads/files supports pagination, sorting, and filtering options to efficiently manage and access lead data. use this endpoint when you need to fetch lead files based on specific criteria such as location, customer referral, or file type. the endpoint is particularly useful for generating reports, analyzing lead data, or integrating lead information into other systems. note that while the endpoint provides flexible search capabilities, it may not include all lead details in the response, focusing primarily on file-related information.
</Accordion>

<Accordion title="Get lead sources">
  Retrieves a list of lead sources available in the agencyzoom platform. this endpoint allows users to fetch information about various channels or origins from which leads are acquired. it should be used when you need to analyze the distribution of leads across different sources, update marketing strategies, or integrate lead source data into reports. the endpoint returns all lead sources associated with the authenticated user's account or agency. it's particularly useful for understanding the effectiveness of different lead generation channels and optimizing lead management processes. note that this endpoint does not provide detailed information about individual leads, but rather focuses on the sources themselves.
</Accordion>

<Accordion title="Customer search request">
  This endpoint allows users to search for and retrieve department and group information within a specific agency in the agencyzoom platform. it is designed to support customer search requests in the context of department and group management. the endpoint should be used when there's a need to access or analyze the organizational structure of an agency, particularly for customer-related operations. it provides a way to streamline agency management by offering insights into how departments and groups are organized within an agency. note that this endpoint focuses solely on retrieving department and group data and does not modify or create new organizational structures. the response likely includes details about the departments, their associated groups, and potentially relevant customer information, although the exact response structure is not specified in the provided schema.
</Accordion>

<Accordion title="Retrieve notes for specific lead">
  Retrieves all notes associated with a specific lead in agencyzoom. this endpoint allows users to fetch the complete history of notes or comments related to a particular lead, which can include interaction logs, follow-up reminders, or any other relevant information recorded by the agency. it's particularly useful for getting a comprehensive view of all communications and updates regarding a lead. the endpoint should be used when there's a need to review the entire note history for a lead, such as during client meetings, performance reviews, or when preparing for follow-up actions. note that this endpoint only provides read access to the notes and doesn't allow for creating, updating, or deleting notes.
</Accordion>

<Accordion title="Delete file from lead">
  Deletes a specific file associated with a lead in the agencyzoom system. this endpoint is used to remove unnecessary or outdated files from a lead's record, helping maintain organized and relevant data. it's particularly useful for cleaning up lead information, ensuring compliance with data retention policies, or removing sensitive information when no longer needed. the operation is irreversible, so it should be used with caution. this endpoint doesn't return the deleted file content; it only removes the file from the system.
</Accordion>

<Accordion title="Retrieve quotes for lead">
  Retrieves all quotes associated with a specific lead in the agencyzoom platform. this endpoint allows users to fetch detailed information about the insurance quotes generated for a particular lead, enabling efficient tracking and management of potential policies. it should be used when an agent or system needs to review or compare multiple quotes for a single lead, such as during the sales process or when updating a lead's status. the endpoint provides a comprehensive view of quote history for the specified lead but does not modify any data or generate new quotes. note that the response may include both active and historical quotes, so users should pay attention to quote status and dates when processing the returned data.
</Accordion>

<Accordion title="Delete email thread">
  The deleteemailthread endpoint allows users to delete a specific email thread from the agencyzoom system. this post request requires the unique threadid of the email thread to be deleted. the endpoint supports pagination and sorting options, making it useful for managing large volumes of email threads efficiently. it's particularly helpful when cleaning up old or irrelevant email conversations to maintain a clutter-free communication environment. however, users should exercise caution as deleted threads cannot be recovered, and this action may affect related data or workflows within agencyzoom.
</Accordion>

<Accordion title="Lead create request">
  Creates or updates a lead in the agencyzoom crm system. this endpoint allows you to input comprehensive information about a lead, including personal details, contact information, assignment data, and custom fields. it's used to add new leads to the system or update existing lead information. the endpoint is particularly useful for integrating lead capture forms or importing leads from external sources. it ensures that leads are properly categorized, assigned, and placed into the correct stage of your sales pipeline. when using this endpoint, make sure to provide all required fields and any additional information that will help in lead management and follow-up processes.
</Accordion>

<Accordion title="Create task post endpoint">
  The createtask endpoint allows users to create a new task within the agencyzoom platform. this powerful tool is essential for managing agency workflows, tracking activities, and ensuring timely follow-ups with clients and leads. it provides flexibility in task creation, allowing users to specify various details such as the task type, assignee, due date, and associated contacts or leads. the endpoint is particularly useful for automating task creation as part of larger workflow processes or for integrating task management with other systems. when using this endpoint, it's important to provide at least the required fields (title and type) and to ensure that any ids used (such as assigneeid or customerid) correspond to valid entities within your agencyzoom account. while many fields are optional, providing more details can significantly enhance task tracking and management efficiency.
</Accordion>

<Accordion title="Add opportunity data request">
  The createopportunity endpoint allows users to add new lead opportunity data to the agencyzoom system. it is designed for creating comprehensive records of potential business opportunities, including details about the lead, associated insurance products, and property information. this endpoint should be used when a new lead or potential client is identified and needs to be entered into the system for tracking and follow-up. it's particularly useful for insurance agencies managing various types of policies and leads across different carriers. the endpoint requires minimal information to create an opportunity but allows for extensive customization through optional fields and custom data points. however, users should note that this endpoint is for creating new opportunities only and cannot be used to update existing records.
</Accordion>

<Accordion title="Retrieve end stages">
  Retrieves information about the end stages of workflows or processes within the agencyzoom platform. this endpoint allows users to fetch data related to the final steps in various agency management workflows, such as lead conversion, customer onboarding, or policy closure. it provides valuable insights into the completion status of different processes, helping agencies track and optimize their operational efficiency. the endpoint should be used when analyzing workflow performance, identifying bottlenecks, or generating reports on process completion rates. note that this endpoint may not provide real-time updates and the data retrieved might reflect the most recent system update rather than instantaneous status.
</Accordion>

<Accordion title="Mark task as completed">
  Updates the status of a specific task to 'completed' in the agencyzoom platform. this endpoint should be used when a user or automated system needs to mark a task as finished, helping to maintain accurate task tracking and workflow management. it's particularly useful for updating task progress in real-time, which can trigger subsequent workflow automations or update performance metrics. the endpoint doesn't return the updated task details, so a separate api call may be needed if confirmation or additional task information is required after completion.
</Accordion>

<Accordion title="Customer add note data request">
  Adds a new note to a specific customer's profile in agencyzoom. this endpoint allows users to append additional information, comments, or observations to a customer's record, enhancing the tracking and management of customer interactions. it should be used whenever there's a need to document important information related to a customer, such as meeting notes, follow-up reminders, or any relevant updates. the endpoint is designed for creating new notes only and does not support editing or retrieving existing notes. there are no apparent limitations on note length or content, providing flexibility in the type of information that can be recorded.
</Accordion>

<Accordion title="Fetch custom fields metadata">
  Retrieves all custom fields configured in the agencyzoom system. custom fields are user-defined data points that allow agencies to track additional information tailored to their specific needs. this endpoint should be used when you need to fetch a comprehensive list of all custom fields set up in the system, which can include fields for leads, customers, or sales activities. it provides a way to dynamically adapt to an agency's unique data structure without requiring changes to the core api. note that this endpoint returns only the custom field definitions and not their associated values for specific records.
</Accordion>

<Accordion title="Retrieve customer policies">
  Retrieves a list of insurance policies associated with a specific customer in the agencyzoom platform. this endpoint allows users to access detailed policy information for a given customer, enabling efficient management of customer relationships and policy tracking. it should be used when needing to review or analyze the insurance coverage of a particular customer. the endpoint returns policy details such as policy types, coverage amounts, and policy statuses, but does not provide premium payment information or claims history.
</Accordion>

<Accordion title="Retrieve product categories list">
  Retrieves a list of all product categories available in the agencyzoom system. this endpoint is used to obtain a comprehensive overview of how products or services are categorized within the platform. it's particularly useful for agency managers or system integrators who need to understand the product structure or want to use these categories for reporting, filtering, or organizing insurance products. the endpoint returns all categories without any filtering, making it ideal for populating dropdown menus or creating a product hierarchy in client applications. note that this endpoint does not provide detailed information about the products within each category; it only returns the category structure itself.
</Accordion>

<Accordion title="Delete email thread message">
  The deletemessage endpoint allows users to remove a specific message from an email thread within the agencyzoom platform. this tool is crucial for maintaining clean and organized communication records, supporting e\&o compliance, and managing agency communications effectively. it should be used when a user needs to permanently remove an incorrect, outdated, or sensitive message from an email thread. the endpoint supports pagination and sorting, which is particularly useful when dealing with large email threads or when precise message selection is required before deletion. it's important to note that this operation is irreversible, so users should exercise caution and ensure they have the correct messageid before proceeding with deletion. the tool does not provide message recovery options, so it's advisable to have a backup or confirmation process in place before using this endpoint for critical communications.
</Accordion>

<Accordion title="Retrieve tasks for lead by leadid">
  Retrieves a list of tasks associated with a specific lead in the agencyzoom platform. this endpoint allows users to fetch all tasks that have been assigned or linked to a particular lead, providing a comprehensive view of the activities and follow-ups planned for that potential customer. it is particularly useful for tracking the progress of lead nurturing, ensuring that all necessary steps are taken in the sales process, and maintaining an organized workflow. the endpoint should be used when you need to review or manage tasks for a specific lead, such as during lead follow-up, performance review, or when updating the lead's status. note that this endpoint only returns task information and does not provide detailed lead data or allow for task modification.
</Accordion>

<Accordion title="Get text thread producer">
  Retrieves text thread information for a specified producer in the agencyzoom system. this endpoint allows users to access communication logs, which can be crucial for tracking customer interactions, managing follow-ups, and ensuring compliance with agency policies. it can be used to monitor producer performance, analyze communication patterns, and gather insights for improving customer service. the endpoint may return multiple text threads or a specific thread, depending on the parameters provided. it's particularly useful for agencies looking to review producer-client communications or gather data for reporting purposes.
</Accordion>

<Accordion title="Delete lead opportunity">
  Deletes a specific opportunity associated with a lead in the agencyzoom platform. this endpoint should be used when an opportunity is no longer relevant, has been closed, or was created in error. it permanently removes the opportunity from the lead's record, helping to maintain an accurate and up-to-date sales pipeline. use this endpoint with caution, as deleted opportunities cannot be recovered. it's important to note that this action only removes the opportunity, not the lead itself.
</Accordion>

<Accordion title="List customer tasks">
  Retrieves a list of tasks associated with a specific customer in agencyzoom. this endpoint is used to fetch all tasks related to a given customer, enabling agents to view and manage customer-specific activities, follow-ups, and action items. it provides a comprehensive overview of ongoing and completed tasks for the customer, supporting effective task management and customer engagement. the endpoint should be used when an agent needs to review or track the progress of tasks associated with a particular customer, such as policy renewals, claim follow-ups, or general inquiries. note that this endpoint only returns task data and does not include detailed customer information or allow task modification.
</Accordion>

<Accordion title="Search business classification request">
  Retrieves a paginated list of business classifications based on specified search criteria. this endpoint allows you to search, filter, and sort business classifications within the agencyzoom platform. it's useful for retrieving structured information about various business types, industries, or categories that agencies work with. the search can be refined by location and text-based queries, making it valuable for tasks such as market analysis, client segmentation, or data enrichment in agency management workflows. the endpoint returns a subset of results based on pagination parameters, allowing for efficient handling of large datasets. use this when you need to explore or analyze the types of businesses in the agencyzoom system, or when integrating business classification data into your agency's processes.
</Accordion>

<Accordion title="Update user profile">
  This endpoint allows you to update the profile information of the currently authenticated user in the agencyzoom platform. it is used to modify essential user details such as first name, last name, email, and optionally, the phone number. this endpoint should be called whenever there's a need to update the user's contact information or correct any inaccuracies in their profile data. it's particularly useful for maintaining up-to-date records, which is crucial for effective agency management and communication. note that this endpoint only updates the profile information and does not affect other aspects of the user's account such as permissions or associated agency data. ensure that the provided email is unique within the system, as it may be used as a primary identifier for the user.
</Accordion>

<Accordion title="Edit opportunity vehicle by id">
  The editopportunityvehicle endpoint allows you to update the details of a vehicle associated with an existing opportunity in agencyzoom. this tool is primarily used for maintaining accurate and up-to-date vehicle information within the context of insurance opportunities or policy management. it enables you to modify various aspects of a vehicle's record, including its identification, basic details, and ownership status. use this endpoint when you need to correct, update, or add new information about a vehicle that is linked to an opportunity in the system. this could be necessary when a client's vehicle details change, when correcting data entry errors, or when adding more comprehensive information to an existing record. it's important to note that while only the 'make' field is required, providing as much accurate information as possible will ensure the most complete and useful vehicle record. the endpoint does not handle the creation or deletion of vehicle records, only their modification.
</Accordion>

<Accordion title="Retrieve customer information">
  Retrieves detailed information about a specific customer in the agencyzoom system. this endpoint allows you to fetch comprehensive customer data using a unique customer identifier. it should be used when you need to access or display individual customer details, such as contact information, account status, or custom fields associated with the customer. the endpoint is particularly useful for populating customer profile pages, preparing for customer interactions, or integrating customer data into other systems. keep in mind that this endpoint only provides information for a single customer at a time and does not support bulk retrieval or filtering of multiple customers.
</Accordion>

<Accordion title="Get opportunity vehicle by id">
  Retrieves a list of opportunities associated with a specific vehicle in the agencyzoom system. this endpoint is useful for agencies looking to track and manage sales opportunities or leads related to a particular vehicle or vehicle-related product. it can be used to fetch potential sales, renewals, or other business prospects tied to the specified vehicle. the endpoint should be called when an agent or system needs to review or analyze opportunities for a single vehicle, which can aid in targeted sales strategies or follow-ups. note that this endpoint focuses on opportunities for a single vehicle and may not provide comprehensive information about the vehicle itself or other related entities.
</Accordion>

<Accordion title="Update lead business details">
  Updates the data for an existing business lead in agencyzoom. this endpoint allows you to modify various aspects of a lead's profile, including personal information, contact details, pipeline status, and business-specific data. it's particularly useful for keeping lead information up-to-date as the sales process progresses or when new information becomes available. the endpoint requires several mandatory fields to ensure critical lead data is maintained, while offering flexibility with numerous optional fields for comprehensive lead management. note that this endpoint is specifically designed for business leads and includes fields tailored to business entities.
</Accordion>

<Accordion title="Retrieve opportunity by id">
  Retrieves detailed information about a specific opportunity within the agencyzoom platform. this endpoint allows users to fetch comprehensive data for a single opportunity by providing its unique identifier. it's particularly useful for accessing up-to-date information about leads, sales prospects, or potential business deals tracked in agencyzoom. the endpoint should be used when detailed information about a particular opportunity is needed, such as during sales reviews, client interactions, or when updating opportunity status. note that this endpoint only provides data for one opportunity at a time and does not support bulk retrieval or filtering of multiple opportunities.
</Accordion>

<Accordion title="Delete text thread request">
  The deletetextthread endpoint is used to remove a specific text thread from the agencyzoom communication workflow. this operation is irreversible and should be used with caution. the endpoint allows for the deletion of a single thread at a time, identified by its unique threadid. while primarily focused on thread deletion, the endpoint also supports pagination, sorting, and location-based filtering, which can be useful for managing large volumes of threads or when working with multi-location agencies. it's important to note that this endpoint does not provide information about the deleted thread or confirm its contents before deletion. users should ensure they have the correct threadid before proceeding with the deletion to avoid unintended data loss.
</Accordion>

<Accordion title="Link driver to opportunity">
  Links a specific driver (sales agent or team member) to an existing opportunity within agencyzoom. this endpoint is used to associate a driver with a potential sales or business opportunity, enabling better tracking and management of the sales process. it should be used when assigning or reassigning opportunities to specific team members. the linkage allows for personalized workflow management and enhanced performance tracking. this operation updates the existing opportunity record and may trigger related workflows or notifications within the agencyzoom system.
</Accordion>

<Accordion title="Search text thread messages details">
  Searches for messages within text threads in the agencyzoom platform. this endpoint allows users to retrieve and filter messages based on various criteria such as thread id, search term, lead status, and date. it supports pagination, sorting, and filtering to provide flexible and efficient access to message data. use this endpoint when you need to find specific messages, analyze communication history, or gather insights from text thread conversations. the search can be narrowed down to a specific thread or broadened to include multiple threads based on the provided parameters. note that this endpoint does not provide real-time message updates and is intended for historical data retrieval and analysis.
</Accordion>

<Accordion title="Retrieve lead by leadid">
  Retrieves detailed information about a specific lead in the agencyzoom platform using its unique identifier. this endpoint is essential for accessing comprehensive data about a single lead, including contact information, status, associated policies, and interaction history. use this endpoint when you need to fetch up-to-date information about a particular lead, such as during customer interactions, for updating records, or when analyzing individual lead performance. the endpoint provides a snapshot of the lead's current state in the system, which is crucial for effective lead management and informed decision-making in insurance agency operations.
</Accordion>

<Accordion title="Fetch lead opportunities by id">
  Retrieves all opportunities associated with a specific lead in agencyzoom. this endpoint allows users to fetch detailed information about potential sales or business prospects linked to a particular lead, enabling efficient tracking and management of the sales pipeline. it should be used when you need to review or analyze the opportunities generated from a specific lead, such as for performance tracking or follow-up prioritization. the endpoint provides a comprehensive view of a lead's potential value but does not modify any data. note that it only returns opportunities for the specified lead and does not provide aggregate data across multiple leads.
</Accordion>

<Accordion title="Update customer info using id">
  Updates an existing customer's information in the agencyzoom platform. this endpoint allows for comprehensive modifications to a customer's profile, including personal details, contact information, address, and business-specific data. it supports both individual and business customers, with specific fields for commercial entities. the endpoint is ideal for keeping customer information up-to-date, adding new details, or correcting existing data. it provides flexibility through custom fields and tagging capabilities, enabling personalized customer management. use this endpoint when you need to modify any aspect of a customer's profile or when new information becomes available. note that some fields are only applicable to business customers, and care should be taken to maintain data consistency, especially with date formats and business-specific numeric values.
</Accordion>

<Accordion title="Lead status change via api">
  Updates the status of a lead in the agencyzoom system and manages associated workflow information. this endpoint allows for changing a lead's status (e.g., from active to won), updating workflow stages, scheduling future actions, and managing lead recycling. it's particularly useful for tracking lead progress, managing sales pipelines, and automating lead nurturing processes. the endpoint provides granular control over lead management, including the ability to change lead sources, set loss reasons, and apply tags. it should be used whenever there's a significant change in a lead's status or when you need to move a lead through different stages of your sales process. note that this endpoint doesn't provide historical tracking of status changes; it only updates the current status and related information.
</Accordion>

<Accordion title="Retrieve driver opportunities by id">
  Retrieves detailed information about a specific driver associated with an opportunity in the agencyzoom platform. this endpoint is used to fetch driver data, which may include personal details, performance metrics, and opportunity-related information. it's particularly useful for agencies managing multiple drivers and tracking their involvement in various business opportunities. the endpoint should be called when detailed driver information is needed in the context of opportunity management or when updating driver records. note that this endpoint only provides data for a single driver and does not return a list of all drivers or opportunities.
</Accordion>

<Accordion title="Reopen task with comments">
  Reopens a previously closed task in the agencyzoom system. this endpoint allows users to reactivate a task that was marked as completed or closed, enabling further work or updates on the task. it should be used when a closed task needs to be revisited, such as when additional information becomes available or when the task's objectives were not fully met. the endpoint requires the unique identifier of the task and optionally accepts comments to provide context for reopening. note that this action may impact task analytics and workflow statuses within agencyzoom, so it should be used judiciously and in accordance with the organization's task management policies.
</Accordion>

<Accordion title="Add tag to policy">
  This endpoint allows users to add tags to a specific policy in agencyzoom. it's used to categorize and organize policies for easier management and retrieval. the endpoint accepts either a policy id from agencyzoom or an ams policy id, along with a list of tag names to be associated with the policy. this tool is particularly useful for bulk updates or when integrating tag management into external workflows. note that this endpoint only adds tags and does not remove existing ones; separate api calls may be needed for tag removal or replacement.
</Accordion>

<Accordion title="Unlink driver from opportunity">
  This endpoint unlinks a specific driver from an opportunity within the agencyzoom platform. it is used to update the details of a potential sale or business engagement by removing the association between a driver and an opportunity. this action is particularly useful when managing insurance-related opportunities and need to modify the involved parties. the endpoint should be used when a driver is no longer relevant to an opportunity, such as when a policy is being updated or when correcting data entry errors. it's important to note that this operation may have implications on the opportunity's status or associated policies, so it should be used carefully and in accordance with the business logic of the insurance agency.
</Accordion>

<Accordion title="Update lead data through leadid">
  Updates an existing lead's information in the agencyzoom platform. this endpoint allows you to modify various details of a lead, including personal information, contact details, assignment, and pipeline stage. it's particularly useful for keeping lead information up-to-date as they progress through your sales pipeline or when new information becomes available. the endpoint requires several key pieces of information to be provided, ensuring that critical lead data is always maintained. while it offers flexibility in updating many optional fields, it enforces the presence of essential information through required parameters. this endpoint should be used whenever there's a need to modify any aspect of a lead's data, whether it's a simple update to contact information or a significant change in the lead's status within your agency's workflow.
</Accordion>

<Accordion title="Unlink vehicle from opportunity">
  This endpoint unlinks a specific vehicle from an opportunity in the agencyzoom platform. it is used to remove the association between a vehicle and an opportunity, which may be necessary when updating opportunity details or managing vehicle-related data within the system. the operation is performed using the put http method, indicating an update to the existing relationship. this endpoint should be used when you need to dissociate a vehicle from an opportunity, such as when a vehicle is no longer relevant to a particular sales opportunity or when correcting incorrectly linked data. it's important to note that this operation only removes the link between the vehicle and the opportunity; it does not delete either the vehicle or the opportunity from the system.
</Accordion>

<Accordion title="Link vehicle to opportunity">
  Links a specific vehicle to an existing opportunity in the agencyzoom platform. this endpoint is used to associate vehicle information with a sales opportunity, which is crucial for insurance agencies dealing with auto policies or vehicle-related services. it allows for better organization and management of client data by connecting vehicle details directly to potential business opportunities. the endpoint should be used when a vehicle needs to be explicitly associated with an ongoing sales opportunity, such as when a client is considering insurance for a specific vehicle. this operation helps in streamlining the sales process and ensuring that all relevant information is connected within the agencyzoom system.
</Accordion>

<Accordion title="Update task details with lead and customer ids">
  Updates an existing task in the agencyzoom platform with new lead data and task details. this endpoint allows for comprehensive modifications to a task, including its title, due date, assignment, associated lead or customer, and status. it's particularly useful for keeping task information current as leads progress through the sales pipeline or when task requirements change. the endpoint supports various task types, making it versatile for different agency workflows such as follow-ups, email communications, phone calls, and meetings. use this endpoint when you need to modify any aspect of an existing task, including reassigning it, rescheduling, or marking it as completed. note that while many parameters are optional, at least one parameter should be provided to make meaningful updates to the task.
</Accordion>

<Accordion title="Mark email thread unread">
  This endpoint allows users to mark an email thread as unread or read within the agencyzoom platform. it is primarily used for managing communication threads and controlling their visibility in the user's inbox or unread list. the endpoint should be called when a user wants to change the read status of a specific email thread, either to flag it for future attention (marking as unread) or to indicate it has been reviewed (marking as read). this function is particularly useful for prioritizing communications, managing workflow, and ensuring important threads don't get overlooked. it's important to note that this endpoint only updates the read status and does not modify the content of the thread or move it between folders.
</Accordion>

<Accordion title="Search email thread details">
  The email thread detail search endpoint allows users to search and retrieve information about email threads within agencyzoom. it supports pagination, sorting, and filtering options for efficient data retrieval. use this endpoint to find specific email threads, analyze communication patterns, or gather information about client interactions. it's ideal for customer service reviews and auditing communication history.
</Accordion>

<Accordion title="Post sso login request">
  Authenticates a user using their email and password, and retrieves initial dashboard data. this endpoint should be used for single sign-on (sso) functionality, allowing users to access the agencyzoom platform and immediately receive relevant dashboard information. it combines the login process with data retrieval, streamlining the user's entry into the system. note that this endpoint requires both username (email) and password to be provided in the request body as json. the specific structure of the dashboard data returned is not detailed in the given schema and may vary based on the user's role and permissions.
</Accordion>

<Accordion title="Add opportunity data request">
  The updateopportunity endpoint modifies existing opportunity data in agencyzoom. it updates lead information, policy details, and property data for a specific opportunity. this endpoint is crucial for maintaining accurate and current opportunity information throughout the sales process. it supports partial updates and adapts to agency-specific configurations, ensuring critical data points are included based on individual agency needs.
</Accordion>

<Accordion title="User login request">
  Authenticates a user in the agencyzoom platform using their email address and password. this endpoint should be used to obtain the necessary authentication token for accessing other agencyzoom api features. it is the initial step in any workflow that requires authenticated access to agencyzoom's services. the endpoint returns a jwt token upon successful authentication, which must be included in subsequent api calls. note that this endpoint does not create new user accounts; it only authenticates existing users. for security reasons, implement appropriate measures to protect sensitive login credentials during transmission.
</Accordion>

<Accordion title="Customer search request model">
  The customersearch endpoint enables advanced filtering and retrieval of customer data in agencyzoom. it supports various search criteria, sorting, and pagination, ideal for generating targeted customer lists or analysis. users can filter by personal info, agency-specific data, and customer status, making it valuable for customer segmentation and reporting.
</Accordion>

<Accordion title="Edit opportunity driver request">
  The editopportunitydriver endpoint updates information for a specific driver in agencyzoom. it modifies details like personal info, relationships, and licensing data. use this put request when changes in a driver's status or information need to be reflected in the system. the endpoint requires driverid in the url and firstname and lastname in the request body. other fields are optional.
</Accordion>

<Accordion title="Rename lead file">
  This endpoint allows you to rename a lead file associated with a specific customer referral in agencyzoom. it's used when you need to update the name of an existing file for better organization or to reflect changes in the lead's information. the operation requires the customer referral id, the specific file id, and the new file name. this tool is particularly useful for maintaining accurate and up-to-date records in your lead management system. keep in mind that renaming a file does not alter its contents or associations within the system.
</Accordion>

<Accordion title="Mark thread unread via id">
  This endpoint allows users to mark a specific text thread as unread in the agencyzoom platform. it is used to manage the read/unread status of communication threads, which can include email conversations or chat messages. the endpoint is particularly useful for users who want to flag important messages for later attention or maintain an organized view of their communications. it should be used when a user needs to change the status of a thread they've previously read or accidentally marked as read. this operation only affects the thread's read status and does not modify the content of the messages within the thread.
</Accordion>

<Accordion title="List email threads">
  The emailthreadsearch endpoint allows users to search, filter, and retrieve email threads within the agencyzoom platform. this powerful tool enables agencies to efficiently manage their email communications by providing a flexible way to locate specific threads based on various criteria. use this endpoint when you need to find relevant email conversations, track communication history with clients or team members, or analyze email trends within your agency. the endpoint supports pagination, sorting, and multiple filtering options, making it suitable for handling large volumes of email threads. it can be used to build advanced search interfaces, generate reports on communication patterns, or integrate email thread management into other agency workflows. note that this endpoint focuses on retrieving thread metadata and does not return the full content of emails. for sensitive operations or accessing full email content, additional authentication or separate api calls may be required.
</Accordion>

<Accordion title="Update lead opportunity info">
  Updates the opportunity data for a specific lead in agencyzoom. this endpoint allows users to modify existing opportunity information, including the associated carrier, product line, premium amount, number of items, and custom fields. it's primarily used when there are changes to an opportunity's details or when new information becomes available during the sales process. the endpoint is essential for keeping opportunity data current and accurate, which is crucial for effective lead management and sales tracking in insurance agencies. note that this endpoint updates an existing opportunity; it cannot be used to create a new opportunity or modify lead information directly.
</Accordion>

<Accordion title="Retrieve task by id">
  Retrieves detailed information about a specific task within the agencyzoom platform. this endpoint allows users to fetch comprehensive data related to a single task, including its status, assigned agent, due date, and other relevant details. it should be used when you need to access or review the complete information of a particular task, such as during task management, progress tracking, or reporting activities. the endpoint is particularly useful for integrating task data into external systems or creating custom dashboards. note that this endpoint only provides information for a single task; for bulk task retrieval or listing multiple tasks, a different endpoint should be used.
</Accordion>

<Accordion title="Logout user endpoint">
  Logs out the currently authenticated user from the agencyzoom platform. this endpoint should be called when a user wants to end their active session and securely sign out of the application. it invalidates the user's current authentication token, ensuring that it can no longer be used for api requests. this is an important security measure to implement when building integrations with agencyzoom, especially in multi-user environments or applications where session management is crucial.
</Accordion>

<Accordion title="Update lead quote data">
  This endpoint allows you to update quote data for a specific lead in agencyzoom. it is used to modify existing quote information, including essential details such as the quote id, carrier, product line, number of items, and premium amount. the endpoint also supports the addition of custom fields, enabling flexible data management for agency-specific requirements. use this endpoint when you need to revise or update quote information for a lead, such as when policy details change or when refining a quote based on new information. note that this endpoint requires the lead id as part of the url path, ensuring that the quote is associated with the correct lead in the system.
</Accordion>

<Accordion title="Lead pipeline count search request">
  The leadpipelinesearch endpoint allows you to search and retrieve lead pipeline counts based on various criteria in agencyzoom. it supports filtering by attributes such as status, assigned user, creation date, and customer information, with pagination and sorting options. use this tool for analyzing your sales pipeline, tracking lead progress, and generating reports. it's ideal for complex searches across your lead database, but primarily returns counts or summary data rather than detailed lead information.
</Accordion>

<Accordion title="Search thread notification request">
  The searchtextthreads endpoint allows users to search, filter, and retrieve text threads (notifications) within the agencyzoom platform. this powerful tool supports pagination, custom sorting, and various filtering options to help users efficiently manage and analyze their communication threads. use this endpoint when you need to find specific threads, generate reports, or analyze communication patterns across different agents, locations, or time periods. the endpoint is particularly useful for large agencies dealing with high volumes of client communications, enabling them to quickly locate relevant conversations and track engagement metrics. note that while this endpoint provides comprehensive search capabilities, it does not modify or create new threads; it is strictly for retrieving existing data.
</Accordion>

<Accordion title="Process lead sold request">
  This endpoint allows you to mark a lead as sold in the agencyzoom system by updating its status and recording details of the sold products. it's used when a sale has been completed for a lead, enabling you to track successful conversions and maintain accurate sales records. the endpoint supports marking multiple products as sold in a single request, making it efficient for recording complex sales transactions. use this when you need to update the status of a lead and log the specifics of the products sold, including policy details, premiums, and related information. the endpoint is particularly useful for agencies tracking their sales performance and maintaining detailed records of their insurance policy sales.
</Accordion>

<Accordion title="Update policy by id">
  The updatepolicy endpoint allows you to modify an existing insurance policy in the agencyzoom system. this put request to /v1/api/policies/\{policyid} updates various details of a policy, including its category, carrier, dates, premium, and associated ids. it's used when policy information needs to be changed or corrected after initial creation. the endpoint requires several mandatory fields to ensure accurate policy updates, while also allowing optional fields for more comprehensive policy management. it's important to note that monetary values are represented in cents, requiring conversion from dollar amounts before submission.
</Accordion>

<Accordion title="Service ticket list">
  The listservicetickets endpoint allows users to search and retrieve a list of service tickets in the agencyzoom crm platform. it provides extensive filtering and sorting capabilities to narrow down results based on various criteria such as status, priority, date ranges, and associated entities like workflows and carriers. this endpoint is particularly useful for generating reports, analyzing customer service performance, and managing ongoing customer interactions. the results are paginated for efficient data retrieval, and the endpoint supports customizable sorting to help users organize the data according to their needs. it's important to note that this endpoint does not create or modify service tickets; it's designed solely for retrieval and analysis purposes.
</Accordion>

<Accordion title="Search and list tasks">
  This endpoint allows you to search and list tasks within the agencyzoom platform. it provides extensive filtering options to retrieve specific sets of tasks based on various criteria such as date range, task type, status, assignee, and lead source. the endpoint supports pagination and sorting, making it suitable for displaying task lists in user interfaces or for bulk data retrieval. use this endpoint when you need to fetch tasks for display, reporting, or synchronization purposes. it's particularly useful for generating task overviews, managing workloads, or analyzing task distribution across team members and lead sources. the endpoint does not create, update, or delete tasks; it's purely for retrieval and searching. also, note that while it offers many filter options, it does not provide task details beyond the search criteria. for full task details, you may need to use a separate endpoint after obtaining the task ids from this search.
</Accordion>

<Accordion title="Search life health leads">
  This endpoint allows users to search and filter life and health insurance leads within the agencyzoom platform. it provides a comprehensive set of parameters for refining search results based on various criteria such as lead status, date ranges, customer information, and agent associations. the endpoint supports pagination, sorting, and detailed filtering options, making it suitable for retrieving specific subsets of lead data for analysis, follow-up, or reporting purposes. use this endpoint when you need to access or analyze life and health insurance lead data with granular control over the returned results.
</Accordion>

<Accordion title="Post lead search request">
  The listleads endpoint allows users to search and retrieve a list of leads from the agencyzoom platform based on various filtering criteria. this powerful tool enables users to find specific leads by applying multiple filters such as date ranges, customer information, lead status, and workflow stages. the endpoint supports pagination, sorting, and detailed filtering options, making it ideal for generating targeted lead lists, analyzing lead performance, and managing sales pipelines efficiently. use this endpoint when you need to retrieve a comprehensive view of leads or when searching for leads that match specific criteria within your agencyzoom account.
</Accordion>


# Ahrefs
Source: https://docs.push.ai/integrations/ahrefs



Ahrefs is an SEO and marketing platform offering site audits, keyword research, content analysis, and competitive insights to improve search rankings and drive organic traffic

<Accordion title="Get site audit projects">
  Retrieves a list of site audit projects associated with the authenticated ahrefs account. this endpoint allows users to access and manage their site audit projects, which are essential for identifying technical and on-page seo issues across websites. it should be used when you need an overview of all site audit projects or want to check the status of ongoing audits. the endpoint likely returns project details such as project names, urls being audited, last audit dates, and overall health scores. keep in mind that while this endpoint provides a list of projects, it does not include the detailed audit results for each project; separate api calls would be needed to fetch specific project data.
</Accordion>

<Accordion title="Fetch all backlinks">
  Retrieves a comprehensive list of backlinks for a specified website or url using ahrefs' site explorer tool. this endpoint provides detailed information about the backlink profile of the target, including the source urls, link attributes, and potentially other seo metrics like domain rating (dr) or url rating (ur) of the linking pages. it's particularly useful for analyzing a website's link-building efforts, identifying potential link-building opportunities, and assessing the overall health of a site's backlink profile. the endpoint can handle large-scale backlink data, making it suitable for in-depth seo analysis and competitive research. however, users should be aware that for websites with a substantial number of backlinks, multiple api calls or pagination may be necessary to retrieve the complete dataset.
</Accordion>

<Accordion title="Get site explorer country metrics">
  Retrieves country-specific site explorer metrics for a given website from ahrefs. this endpoint provides valuable insights into a website's performance across different countries, including data on organic traffic, keyword rankings, and backlink profiles. it's particularly useful for analyzing international seo performance, identifying strong markets, and uncovering opportunities for global expansion. the tool returns a list of countries with their respective seo metrics, helping users understand how their website performs in various geographical regions. note that the specific metrics returned may vary based on the ahrefs plan and data availability for the target website.
</Accordion>

<Accordion title="Backlinks stats retrieval">
  Retrieves comprehensive backlink statistics for a specified website or url using ahrefs' site explorer tool. this endpoint provides crucial data for seo analysis, including the total number of backlinks, referring domains, and potentially the domain rating (dr). it's essential for understanding a site's link profile, assessing its seo performance, and conducting competitive analysis. the tool is particularly useful when users need detailed insights into a website's backlink structure or when comparing the backlink profiles of multiple domains. note that the data returned is based on ahrefs' extensive web crawl and may not include very recent backlinks.
</Accordion>

<Accordion title="Get site explorer linked anchors external">
  The site-explorer-linked-anchors-external endpoint retrieves data about external anchor texts linking to a specified target website. this tool is essential for analyzing the backlink profile of a domain, understanding the context in which other sites are linking to it, and identifying potential seo opportunities or issues. it provides insights into the most common anchor texts used in external links, which can help in assessing the website's perceived topical relevance and authority. use this endpoint when you need to analyze the external link profile of a website, conduct competitor research, or identify potential link-building opportunities. note that this tool focuses solely on external links and does not provide information about internal linking structures or other on-page seo factors.
</Accordion>

<Accordion title="Get url rating history">
  Retrieves the historical url rating data for a specified url over time. this endpoint provides insights into how a url's seo strength has changed, allowing users to track the impact of their seo efforts or analyze competitors' url performance. the url rating is a key ahrefs metric that reflects the strength of a url based on its backlink profile and other seo factors. use this endpoint to visualize url rating trends, identify significant changes in a url's seo performance, and correlate these changes with specific events or strategies. the data returned is particularly useful for long-term seo analysis and competitive research.
</Accordion>

<Accordion title="Domain rating for site explorer">
  Retrieves the domain rating (dr) for a specified domain. domain rating is an ahrefs metric that measures the strength and authority of a website's backlink profile on a logarithmic scale from 0 to 100. this endpoint should be used when you need to quickly assess the overall seo strength of a domain based on its backlink profile. it's particularly useful for competitive analysis, link building research, and evaluating potential partnership opportunities. the tool provides a single, easy-to-understand metric but does not offer detailed information about the backlinks themselves or other seo factors. for more comprehensive backlink analysis, consider using other ahrefs endpoints that provide more detailed backlink data.
</Accordion>

<Accordion title="Retrieve crawler ip ranges">
  Retrieves the list of ip address ranges used by ahrefs' web crawler (ahrefsbot). this endpoint provides essential information for website administrators to identify and potentially whitelist ahrefs' crawler traffic. use this endpoint when you need to configure your server's firewall rules, analyze server logs, or verify the authenticity of crawler requests claiming to be from ahrefs. the returned data includes the current set of ip ranges, which may change over time, so it's recommended to check this endpoint periodically for updates. note that while this information helps in identifying ahrefs' crawler, it should not be used as the sole method of authentication for the crawler.
</Accordion>

<Accordion title="Retrieve best by internal links">
  Retrieves data on the best-performing internal links within a specified website using ahrefs' site explorer feature. this endpoint analyzes the internal link structure of the target site and returns a list of the most effective internal links based on various seo metrics. it's particularly useful for identifying high-value linking opportunities within your own website, which can help improve your site's overall seo performance and user navigation. the tool provides insights that can be used to optimize your internal linking strategy, potentially boosting the ranking potential of important pages on your site. note that this endpoint focuses solely on internal links and does not provide information about external backlinks or other seo metrics.
</Accordion>

<Accordion title="Domain rating history">
  Retrieves the historical domain rating (dr) data for a specified domain over time. this endpoint is part of ahrefs' site explorer tool and provides insights into how a domain's authority has changed. it's useful for tracking the impact of seo efforts, analyzing competitors, or understanding long-term trends in domain strength. the tool returns a time series of domain rating values, allowing users to visualize changes in a domain's perceived authority according to ahrefs' metrics. it should be used when analyzing the historical performance of a domain in terms of its overall seo strength and backlink profile quality. note that this endpoint focuses solely on domain rating and does not provide other metrics like backlink counts or organic traffic data.
</Accordion>

<Accordion title="Explore keywords overview">
  Retrieves a comprehensive overview of keyword data from ahrefs' keywords explorer tool. this endpoint provides essential insights for seo professionals and content strategists, offering a summary of key metrics such as search volume, keyword difficulty, and potential traffic. it's ideal for users looking to get a quick snapshot of keyword performance and opportunities without diving into specific keyword details. the overview likely includes aggregate data and trends, helping users to make informed decisions about their keyword strategy. while it offers a broad perspective, it may not provide in-depth analysis of individual keywords. use this endpoint when you need a high-level view of your keyword landscape or to identify general trends in your niche.
</Accordion>

<Accordion title="Explore keyword volume by country">
  Retrieves the search volume data for specified keywords across different countries using ahrefs' keywords explorer tool. this endpoint allows users to obtain accurate search volume information, helping in keyword research and content strategy planning for specific geographic regions. it's particularly useful for seo professionals and content marketers looking to optimize their targeting for different markets. the endpoint provides monthly search volume data, which can be used to gauge the popularity and potential traffic of keywords in various countries. note that the data is based on ahrefs' extensive database and may not always exactly match real-time google search volumes.
</Accordion>

<Accordion title="Retrieve anchor data">
  Retrieves anchor text data for a specified website or url using ahrefs' site explorer tool. this endpoint provides valuable insights into the anchor text distribution of backlinks pointing to the target url or domain. it helps seo professionals analyze the quality and diversity of anchor texts, which can influence search engine rankings. use this endpoint when you need to understand how other websites are linking to a specific page or domain, and to identify potential opportunities for link building or anchor text optimization. the tool does not provide information about the linking pages themselves, focusing solely on the anchor text data.
</Accordion>

<Accordion title="Retrieve organic keywords">
  Retrieves organic keywords data for a specified website using ahrefs' site explorer tool. this endpoint provides valuable insights into a website's seo performance by returning a list of keywords for which the site ranks in organic search results. it's particularly useful for analyzing a website's organic search visibility, identifying ranking opportunities, and comparing keyword performance against competitors. the data returned includes key metrics such as keyword position, search volume, and estimated traffic, allowing users to make informed decisions about their seo strategy. note that the results are based on ahrefs' database and may not reflect real-time search engine results.
</Accordion>

<Accordion title="Retrieve public crawler ips">
  Retrieves a list of ip addresses currently used by ahrefsbot, ahrefs' web crawler. this endpoint provides essential information for webmasters and seo professionals who want to verify the authenticity of requests coming from ahrefs or manage their server's access rules. the returned list includes all active ip addresses utilized by ahrefsbot for crawling websites. this tool should be used when you need to confirm if a particular ip belongs to ahrefs or when updating your website's firewall rules to allow ahrefs' crawler. it's important to note that this list may change over time, so it's recommended to check it periodically for the most up-to-date information.
</Accordion>

<Accordion title="Linked anchors explorer">
  Retrieves information about internal linked anchors for a specified website using the ahrefs api. this endpoint provides data on anchor text used in internal links and the number of outgoing links associated with each anchor. it's particularly useful for analyzing a website's internal linking structure, identifying commonly used anchor texts, and optimizing internal link distribution. the endpoint is part of ahrefs' site explorer tool and helps in understanding the website's hierarchy and content relationships. each request and result incurs a cost of 1 row, which should be considered when making multiple or large-scale queries.
</Accordion>

<Accordion title="Retrieve organic competitors">
  The getorganiccompetitors endpoint in the ahrefs api provides a comprehensive analysis of websites competing for organic search rankings with a specified target domain. it identifies and ranks competitors based on their keyword overlap and organic search performance relative to the target site. this tool is essential for understanding the competitive landscape in seo, discovering potential content gaps, and informing strategic decisions for improving organic search visibility. use this endpoint when you need to identify key competitors in organic search, analyze their strengths, and uncover opportunities for outranking them. the tool focuses solely on organic search competitors and does not provide information on paid search or other marketing channels.
</Accordion>

<Accordion title="Explore linked domains of a site">
  Retrieves a list of external domains that the specified target website or url links to, using ahrefs' site explorer functionality. this endpoint is crucial for analyzing a website's external linking structure, which can provide insights into its content strategy, partnerships, and overall seo approach. it's particularly useful for competitive analysis, link building strategies, and identifying potential opportunities or risks in a website's outbound link profile. the endpoint returns detailed information about each linked domain, including the number of links pointing to it from the target site.
</Accordion>

<Accordion title="Retrieve outlinks stats">
  Retrieves comprehensive statistics about outgoing links (outlinks) from a specified website using ahrefs' site explorer tool. this endpoint provides valuable insights into a website's external linking practices, which is crucial for seo analysis and understanding a site's overall link profile. use this tool to gather data on the number of outlinks, the diversity of linked domains, and the distribution of follow vs. nofollow links. it's particularly useful for competitive analysis, identifying potential link-building opportunities, and assessing a site's overall linking strategy. note that this endpoint focuses solely on outgoing links and does not provide information about backlinks or internal links.
</Accordion>

<Accordion title="List best by external links">
  The 'get best by external links' endpoint retrieves a list of pages from a specified website, ranked by the number of external links pointing to them. this tool is essential for identifying the most authoritative and popular pages on a domain from an external linking perspective. it helps in understanding which content attracts the most backlinks, aiding in content strategy and link building efforts. the endpoint is particularly useful for seo professionals and digital marketers looking to analyze a website's most valuable pages in terms of external link equity. however, it's important to note that this tool focuses solely on external links and doesn't provide information on internal linking or other seo metrics.
</Accordion>

<Accordion title="Fetch broken backlinks data">
  Retrieves a list of broken backlinks for a specified website using ahrefs' site explorer tool. this endpoint helps identify and analyze backlinks that are no longer functional, potentially affecting the website's seo performance. it should be used when conducting a backlink audit, cleaning up a website's link profile, or identifying opportunities for link reclamation. the tool provides detailed information about each broken backlink, including the referring page, anchor text, and the specific broken url. it's important to note that this endpoint may have limitations on the number of results returned and may require additional api calls for pagination if there are many broken backlinks.
</Accordion>

<Accordion title="Retrieve paid pages data">
  Retrieves information about paid pages (ppc advertising) for a specified website using ahrefs' site explorer tool. this endpoint provides valuable insights into a website's paid search strategy, including the keywords they're targeting, ad copies, and potentially performance metrics. it's particularly useful for competitive analysis in digital marketing, allowing users to understand their competitors' paid search efforts. the tool should be used when analyzing a website's ppc strategy or researching potential keywords for paid campaigns. it does not provide information about organic search performance or other seo metrics.
</Accordion>

<Accordion title="Explore matching terms for keywords">
  The keywords explorer matching terms endpoint retrieves a list of keyword phrases that match or contain the specified keyword from ahrefs' vast database. this tool is part of ahrefs' keyword explorer functionality and is designed to assist in comprehensive keyword research for seo purposes. it returns matching terms along with their relevant metrics such as search volume, keyword difficulty, and potential traffic. this endpoint is particularly useful when expanding a seed keyword list, finding long-tail variations, or discovering closely related search terms. the tool takes into account the specified country for localized results, allowing for targeted keyword strategies in different markets. it's important to note that while this tool provides valuable keyword suggestions, it should be used in conjunction with other ahrefs features for a complete seo strategy.
</Accordion>

<Accordion title="Retrieve site explorer referring domains history">
  Retrieves the historical data of referring domains for a specified website or url over time. this endpoint is part of ahrefs' site explorer tool and provides valuable insights into the growth or decline of a website's backlink profile. it should be used when analyzing the long-term seo performance of a website, identifying trends in link building efforts, or comparing the backlink acquisition rates of different domains. the data returned includes the number of referring domains at various points in time, allowing users to track changes and potentially correlate them with specific events or marketing efforts. this endpoint is particularly useful for seo professionals, digital marketers, and website owners who need to monitor their site's authority growth over time or analyze competitors' link building strategies.
</Accordion>

<Accordion title="Retrieve subscription limits and usage">
  Retrieves detailed information about the current subscription limits and usage for an ahrefs account. this endpoint provides essential data to monitor api consumption, track remaining credits or rows, and manage subscription usage effectively. it should be used regularly to ensure compliance with plan limits and to plan for potential upgrades or additional purchases. the tool does not modify any account settings or usage data; it only provides a snapshot of the current status. while specific response fields are not detailed in the schema, users can expect information about total limits, current usage, and possibly remaining allowances for various ahrefs features and api endpoints.
</Accordion>

<Accordion title="Retrieve site explorer metrics history">
  Retrieves historical seo metrics data for a specified website over a given time period. this endpoint is part of the ahrefs site explorer tool and provides valuable insights into a website's performance trends. it should be used when analyzing long-term seo progress, identifying patterns in backlink growth, or tracking changes in organic traffic and keyword rankings. the tool is particularly useful for competitive analysis, allowing users to compare their website's historical performance against competitors. it's important to note that the data granularity may vary depending on the date range selected, with more recent dates potentially offering more detailed data.
</Accordion>

<Accordion title="Search suggestions explorer">
  Retrieves search suggestions for a given keyword or phrase using ahrefs' keywords explorer tool. this endpoint provides autocomplete-style suggestions that can help uncover related keywords, long-tail variations, and potential content ideas based on real search data. it's particularly useful for expanding keyword lists, finding low-competition keywords, and understanding user search intent. the suggestions returned may include both informational and transactional keywords, offering insights into various stages of the user journey. this tool should be used when conducting keyword research, planning content strategies, or optimizing for search engine visibility. it does not provide detailed metrics like search volume or keyword difficulty; for such data, additional api calls may be necessary.
</Accordion>

<Accordion title="Pages by traffic overview">
  Retrieves a list of pages from a specified website, ordered by their estimated organic search traffic. this endpoint is part of the ahrefs site explorer tool and provides valuable insights into which pages on a website are performing well in terms of attracting organic search visitors. it's useful for identifying top-performing content, understanding traffic distribution across a site, and prioritizing optimization efforts. the endpoint returns data such as page urls, estimated traffic, and other relevant metrics. it's important to note that the traffic data is an estimation based on ahrefs' algorithms and may not exactly match actual analytics data. this tool is particularly useful for seo professionals, content strategists, and website owners looking to analyze and improve their site's organic search performance.
</Accordion>

<Accordion title="Fetch competitors overview">
  Retrieves a comprehensive overview of competitor data in relation to keyword rankings and organic search performance. this endpoint is part of ahrefs' rank tracker feature and provides a comparative analysis of your website against multiple competitors. it offers insights into keyword positions, traffic share, and serp features across all tracked keywords. use this endpoint when you need a high-level view of your seo performance relative to your competitors. the data returned helps identify ranking opportunities, track your market share in organic search, and understand how you stack up against your competition in terms of visibility and traffic. note that this endpoint may have limitations on the number of competitors it compares against and the historical data range available.
</Accordion>

<Accordion title="Retrieve site explorer pages history">
  The get site explorer pages history endpoint retrieves historical data about specific pages or domains from ahrefs' site explorer. it tracks changes in seo performance over time, including backlinks, organic traffic, and visibility. use this endpoint for assessing historical performance, comparing metrics, and identifying trends. ideal for seo audits and competitor analysis. data availability may vary based on ahrefs' crawl history.
</Accordion>

<Accordion title="Retrieve top pages from site explorer">
  Retrieves data about the top-performing pages of a specified website using ahrefs' site explorer tool. this endpoint provides valuable insights into a site's most successful content based on various seo metrics. it's particularly useful for content analysis, competitive research, and identifying opportunities for optimization. the data returned includes details such as page urls, organic traffic estimates, ranking keywords, and other relevant seo metrics for each top page. use this endpoint when you need to analyze the best-performing content of a website or compare top pages across different domains. note that the results are based on ahrefs' data and estimates, which may not always reflect real-time traffic or exact google rankings.
</Accordion>

<Accordion title="Retrieve volume history">
  Retrieves the historical search volume data for a specified keyword using ahrefs' keywords explorer tool. this endpoint provides valuable insights into how the popularity of a keyword has changed over time, allowing users to analyze trends, seasonality, and long-term shifts in search behavior. the data returned can be crucial for planning seo strategies, content calendars, and understanding market dynamics. it's particularly useful when you need to assess the historical performance of keywords, identify seasonal patterns, or evaluate the potential of trending topics. the tool does not provide future predictions or real-time data, focusing instead on historical trends based on ahrefs' comprehensive database of search information.
</Accordion>

<Accordion title="Perform batch url analysis using multiple parameters">
  Performs a batch analysis on multiple urls or domains using ahrefs' powerful seo metrics. this endpoint allows users to retrieve key seo data for up to 100 targets simultaneously, streamlining the process of analyzing multiple websites or pages. it's particularly useful for comparing competitors, analyzing site sections, or processing large sets of urls efficiently. the endpoint offers customization options for selecting specific metrics, filtering by country, and choosing the calculation mode for volume-based metrics. while it provides comprehensive data, users should be aware of the 100-target limit per request and ensure they have sufficient api quota for large-scale analyses.
</Accordion>

<Accordion title="Retrieve related terms">
  The keywords explorer related terms endpoint retrieves a list of related terms for a given keyword using ahrefs' extensive keyword database. this tool is essential for expanding keyword research, finding new content ideas, and identifying potential long-tail keywords for seo strategies. it provides valuable insights into semantically related terms that users are searching for, helping to broaden and refine content targeting. the endpoint is particularly useful when brainstorming content ideas or looking to expand the scope of an existing seo campaign. however, it should be noted that this tool focuses on keyword relationships and does not provide metrics like search volume or keyword difficulty directly in its response.
</Accordion>

<Accordion title="Retrieve site explorer keywords history">
  Retrieves historical keyword performance data for a specified website or domain using ahrefs' site explorer. this endpoint provides insights into how keywords have performed over time, including changes in rankings, search volume, and potential traffic. it's particularly useful for analyzing seo trends, understanding the impact of optimization efforts, and identifying seasonal patterns in keyword performance. the tool should be used when you need a comprehensive view of a website's keyword history to inform seo strategies and content planning. it does not provide real-time data and may have limitations on the historical range available.
</Accordion>

<Accordion title="Fetch site explorer referring domains">
  Retrieves a list of domains that have backlinks pointing to a specified target website. this endpoint is essential for conducting comprehensive backlink analysis, allowing users to identify and evaluate the sources of incoming links to their website. it provides valuable data for assessing the strength and quality of a site's backlink profile, which is crucial for seo strategies and competitor analysis. the endpoint returns detailed information about each referring domain, likely including metrics such as domain rating (dr), number of backlinks, and first seen date. it should be used when analyzing a website's backlink structure, identifying potential link-building opportunities, or auditing the quality of incoming links. note that while this endpoint provides aggregate data about referring domains, it does not offer specifics about individual backlinks or anchor texts.
</Accordion>

<Accordion title="Retrieve site explorer metrics">
  The getsiteexplorermetrics endpoint retrieves comprehensive seo metrics for a specified website using ahrefs' site explorer tool. it provides crucial data such as backlink profile, referring pages, organic keyword rankings, and various other seo-related metrics that are essential for understanding a website's performance and authority in search engine results. this endpoint is particularly useful for seo professionals, digital marketers, and website owners who need to analyze their own sites or competitor websites. the tool offers flexibility in terms of analysis scope and specific metrics retrieval, allowing users to tailor the data to their specific needs. however, users should be aware that the depth and recency of data may vary depending on ahrefs' crawling frequency and the size of the target website.
</Accordion>

<Accordion title="Fetch rank tracker overview">
  The getranktrackeroverview endpoint retrieves a comprehensive summary of keyword rankings and seo performance data from ahrefs' rank tracker tool. it provides a high-level overview of a website's ranking positions, serp features, and performance against competitors across multiple search engines and countries. this endpoint is ideal for quickly assessing the overall seo health and progress of a website without delving into specific keyword details. it should be used when you need a snapshot of your seo performance or to track changes in your overall ranking landscape over time. note that while this overview gives a broad picture, it may not include in-depth data for individual keywords or specific serp features.
</Accordion>

<Accordion title="Get serp overview">
  Retrieves a comprehensive overview of search engine results pages (serp) data for specified keywords or queries. this endpoint provides valuable insights into search performance, including historical data, search intent analysis, and detailed metrics for each keyword. it's particularly useful for seo professionals and digital marketers looking to optimize their content strategy and improve their website's search engine visibility. the serp overview can help identify trends, analyze competition, and inform content creation efforts based on real search data. note that while this endpoint offers a wealth of information, it may not provide real-time data and should be used for strategic planning rather than immediate tactical decisions.
</Accordion>

<Accordion title="Fetch total search volume history">
  Retrieves the historical total search volume data for specified keywords using ahrefs' site explorer tool. this endpoint allows users to track and analyze the search popularity trends of specific terms over time, which is crucial for seo strategy and content planning. it provides aggregated search volume data, helping users understand seasonal trends, overall interest changes, and compare different keywords' performance. the tool is particularly useful for identifying trending topics, planning content calendars, and making data-driven decisions in digital marketing campaigns. however, it's important to note that the data represents past trends and should be used in conjunction with other metrics for comprehensive seo analysis.
</Accordion>


# Airtable
Source: https://docs.push.ai/integrations/airtable



Airtable is a low‒code platform to build next‒gen apps. Move beyond
rigid tools, operationalize your critical data, and reimagine
workflows with AI

<Accordion title="Create Comment">
  Creates a comment in airtable.
</Accordion>

<Accordion title="Create Multiple Records">
  Creates multiple records in airtable.
</Accordion>

<Accordion title="Create Field">
  Create a field in airtable.
</Accordion>

<Accordion title="Delete Comment">
  Deletes a comment in airtable.
</Accordion>

<Accordion title="Create Record">
  Creates a new record in airtable.
</Accordion>

<Accordion title="Get Record">
  Retrieves a specific record from airtable.
</Accordion>

<Accordion title="Get Base Schema">
  Gets the schema of a base in airtable.
</Accordion>

<Accordion title="Delete Record">
  Deletes a specific record in airtable.
</Accordion>

<Accordion title="List Bases">
  Lists all bases in airtable.
</Accordion>

<Accordion title="List Comments">
  Lists comments in airtable.
</Accordion>

<Accordion title="Get User Information">
  Retrieves user information from airtable.
</Accordion>

<Accordion title="Delete Multiple Records">
  Deletes multiple records in airtable.
</Accordion>

<Accordion title="List Records">
  Retrieves records from airtable.
</Accordion>

<Accordion title="Create Table">
  Creates a new table in airtable.
</Accordion>

<Accordion title="Create Base">
  Creates a new base in airtable.
</Accordion>

<Accordion title="Update Multiple Records">
  Updates multiple records in airtable.
</Accordion>

<Accordion title="Update Record">
  Updates a specific record in airtable.
</Accordion>


# Alchemy
Source: https://docs.push.ai/integrations/alchemy



Alchemy is a blockchain development platform that provides powerful APIs and developer tools for building and scaling Ethereum applications

<Accordion title="Get Token Metadata">
  This tool retrieves metadata for a given token contract address, including the token's name, symbol, decimals, and logo url if available. it is essential for applications that need to display token information, handle token transfers, or manage token listings.
</Accordion>

<Accordion title="Get NFT Contract Metadata">
  This tool retrieves metadata for a given nft smart contract. essential for obtaining basic nft collection details such as contract name, symbol, total supply, token type (erc721 vs erc1155), contract deployer address, deployed block number, opensea metadata, and contract verification status.
</Accordion>

<Accordion title="Get Token Balances">
  This tool retrieves erc20 token balances for a specified ethereum address. it can either return balances for all tokens an address has ever interacted with or for a specific set of token contract addresses. it is useful for checking token balances for wallets, monitoring erc20 token holdings, portfolio tracking, and defi applications.
</Accordion>

<Accordion title="Get NFTs for Contract">
  This tool retrieves all nfts for a given contract address. it is designed to return a complete list of nfts from a specific nft collection by accepting parameters such as contractaddress (required), withmetadata (optional), pagesize (optional), and pagekey (optional). the tool is useful for analyzing collections, building nft marketplaces, and creating collection analytics.
</Accordion>

<Accordion title="Get NFT Sales">
  This tool will retrieve nft sales data across various marketplaces. it allows users to query historical nft sales data with filtering options such as fromblock, toblock, order, marketplace, and limit in order to track nft sales activity, analyze historical data, monitor specific collections, and get real-time updates on nft transactions.
</Accordion>

<Accordion title="Get Transaction Count">
  This tool retrieves the number of transactions sent from a specific address (also known as the nonce). it uses the eth gettransactioncount endpoint to return the transaction count for an address at a specified block tag (latest, pending, earliest, or a hex block number), which is essential for determining the nonce for subsequent transactions.
</Accordion>

<Accordion title="Get NFT Owners">
  This tool retrieves the owner(s) for a specific nft token, supporting both erc721 and erc1155 tokens on ethereum and several layer 2 chains such as polygon, arbitrum, optimism, and base. it requires the contract address and tokenid, and returns a list of owner addresses along with an optional pagination key for further results.
</Accordion>


# Amplitude
Source: https://docs.push.ai/integrations/amplitude



Amplitude Inc. is an American publicly trading company that develops digital analytics software.

<Accordion title="Create Amplitude Event Category">
  Create a new event category in amplitude. this action allows you to: - create a new event category to organize event types - validate category name before creation key features: - creates event categories for organizing events - returns success/failure status
</Accordion>

<Accordion title="Update Amplitude Event Type">
  Update an existing event type in amplitude. this action allows you to: - change event type properties - update event name, category, metadata, and settings - modify display name for ingested events key features: - updates event type configuration - supports partial updates (only specified fields are changed)
</Accordion>

<Accordion title="Create Amplitude Event Type">
  Create a new event type in amplitude. this action allows you to: - define a new event type with various properties - associate the event with a category - add metadata like description, tags, and owner key features: - creates trackable events in your amplitude project - supports full event type configuration
</Accordion>

<Accordion title="Get Amplitude Event Categories">
  Get event categories from amplitude. this action allows you to: - get all event categories in your project - get a specific category by name
</Accordion>

<Accordion title="Get Amplitude Event Type">
  Get a specific event type from amplitude by name. this action allows you to: - retrieve detailed information about a single event type - get all properties and metadata for the event key features: - retrieves comprehensive event type details - returns metadata like category, description, and settings - supports lookup by exact event name
</Accordion>

<Accordion title="Update Amplitude Event Category">
  Update an existing event category in amplitude. this action allows you to: - update the name of an existing event category - validate the new category name key features: - updates category names - returns success/failure status
</Accordion>

<Accordion title="Get Amplitude Event Types">
  Get all event types from amplitude. this action allows you to: - retrieve all event types in your project - optionally include deleted events
</Accordion>

<Accordion title="Update User Properties in Amplitude">
  Update user properties using amplitude's identify api. this action allows you to: - set or update the user id for a device id - update user properties without sending an event - perform operations on user properties (set, append, etc.) - update user attributes like device info and location
</Accordion>

<Accordion title="List Amplitude Cohorts">
  List all discoverable cohorts for an amplitude project. this action allows you to: - get a list of all cohorts in your amplitude project - optionally include sync information for each cohort key features: - returns cohort details including id, name, size, and definition - optionally includes sync metadata for integration with other tools - supports eu data residency
</Accordion>

<Accordion title="Restore Amplitude Event Type">
  Restore a deleted event type in amplitude. this action allows you to: - restore a previously deleted event type - make the event available again in the ui and api key features: - undoes the deletion of an event type - returns success/failure status
</Accordion>

<Accordion title="Delete Amplitude Event Category">
  Delete an event category from amplitude. this action allows you to: - delete an existing event category - remove category organization from events key features: - permanently removes event categories - returns success/failure status
</Accordion>

<Accordion title="Delete Amplitude Event Type">
  Delete an event type from amplitude. this action allows you to: - remove an event type from your project - mark live events as deleted - remove planned events from the tracking plan key features: - different behavior based on event status (live, planned, etc.) - returns success/failure status
</Accordion>

<Accordion title="Check Amplitude Cohort Status">
  Check the status of a cohort export request. this action allows you to: - poll the status of an in-progress cohort download request - determine if a cohort is ready for download
</Accordion>

<Accordion title="Request Amplitude Cohort">
  Get a single cohort by id and initiate download. this action allows you to: - request a specific cohort from amplitude - optionally include user properties in the response - start the asynchronous download process key features: - supports filtering by specific user properties - returns a request id used for polling status and downloading - supports eu data residency
</Accordion>

<Accordion title="Update Amplitude Cohort Membership">
  Incrementally update cohort membership by adding or removing ids. this action allows you to: - add new ids to an existing cohort - remove ids from an existing cohort - perform multiple operations in a single request
</Accordion>

<Accordion title="Send Events to Amplitude">
  Send events to amplitude using the http v2 api. this action allows you to send events to amplitude for tracking user behavior and analytics. it supports all amplitude event fields, handles proper validation, and includes comprehensive error handling.
</Accordion>


# Apaleo
Source: https://docs.push.ai/integrations/apaleo



Apaleo is a cloud-based property management platform handling reservations, billing, and daily operations for hospitality businesses

<Accordion title="Get a units list">
  Get the list of units.

  you must have at least one of these scopes: 'units.read, setup.read, setup.manage'.
</Accordion>

<Accordion title="Get a unit">
  Get a unit by id.

  you must have at least one of these scopes: 'units.read, setup.read, setup.manage'.
</Accordion>

<Accordion title="Create a unit">
  Use this call to create a new unit.

  you must have at least one of these scopes: 'units.create, setup.manage'.
</Accordion>

<Accordion title="Create a unit attribute">
  Use this call to create a new unit attribute.

  you must have at least one of these scopes: 'unitattributes.create, setup.manage'.
</Accordion>

<Accordion title="Creates a property">
  Use this call to create a new property.

  you must have at least one of these scopes: 'properties.create, setup.manage'.
</Accordion>

<Accordion title="Check if a property exists">
  Check if a property exists by id.

  you need to be authorized (no particular scope required)
</Accordion>

<Accordion title="Get unit attribute by id">
  Get unit attribute by id

  you must have at least one of these scopes: 'unitattributes.read, setup.read, setup.manage'.
</Accordion>

<Accordion title="Check if a unit attribute exists">
  Check if a unit attribute exists

  you must have at least one of these scopes: 'unitattributes.read, setup.read, setup.manage'.
</Accordion>

<Accordion title="Archive a property">
  Use this endpoint to archive an existing live property this operation set the isarchived flag to true

  you must have at least one of these scopes: 'properties.manage, setup.manage'.
</Accordion>

<Accordion title="Get a unit group">
  Get a unit group by id.

  you must have at least one of these scopes: 'unitgroups.read, setup.read, setup.manage'.
</Accordion>

<Accordion title="Check if a unit exists">
  Check if a unit exists by id.

  you must have at least one of these scopes: 'units.read, setup.read, setup.manage'.
</Accordion>

<Accordion title="Get unit attribute list">
  Get unit attribute list

  you must have at least one of these scopes: 'unitattributes.read, setup.read, setup.manage'.
</Accordion>

<Accordion title="Create a unit group">
  Use this call to create a new unit group.

  you must have at least one of these scopes: 'unitgroups.create, setup.manage'.
</Accordion>

<Accordion title="Move property to live">
  Use this endpoint to move an existing test property to live this operation changes the property status to 'live'

  you must have at least one of these scopes: 'properties.manage, setup.manage'.
</Accordion>

<Accordion title="Replace a unit group">
  Use this call to modify a unit group.

  you must have at least one of these scopes: 'unitgroups.manage, setup.manage'.
</Accordion>

<Accordion title="Check if a unit group exists">
  Check if a unit group exists by id.

  you must have at least one of these scopes: 'unitgroups.read, setup.read, setup.manage'.
</Accordion>

<Accordion title="Clones a property">
  Use this call to clone a specific property. this operation creates a new property with inventory and rate plans from the specified property.

  you must have at least one of these scopes: 'properties.create, setup.manage'.
</Accordion>

<Accordion title="Reset a test property and delete all transactional data">
  This endpoint deletes transactional data for a property in 'test' status. requires 'properties.manage' or 'setup.manage' scopes.
</Accordion>

<Accordion title="Returns a list of supported countries">
  Returns a list of iso country codes that could be used to create properties.

  you need to be authorized (no particular scope required)
</Accordion>

<Accordion title="Create multiple units">
  Use this call to create multiple units, following a naming rule.

  you must have at least one of these scopes: 'units.create, setup.manage'.
</Accordion>

<Accordion title="Returns number of units">
  Returns number of units matching the filter criteria

  you must have at least one of these scopes: 'units.read, setup.read, setup.manage'.
</Accordion>

<Accordion title="Deletes unit attribute">
  Deletes unit attribute

  you must have at least one of these scopes: 'unitattributes.delete, setup.manage'.
</Accordion>

<Accordion title="Delete a unit">
  Use this call to delete a unit.

  you must have at least one of these scopes: 'units.delete, setup.manage'.
</Accordion>

<Accordion title="Delete a unit group">
  Use this call to delete a unit group.

  you must have at least one of these scopes: 'unitgroups.delete, setup.manage'.
</Accordion>

<Accordion title="Get all unit groups or all unit groups for a property">
  Get the list of unit groups.

  you must have at least one of these scopes: 'unitgroups.read, setup.read, setup.manage'.
</Accordion>

<Accordion title="Return total count of properties">
  Return total count of properties

  you need to be authorized (no particular scope required)
</Accordion>

<Accordion title="Returns number of unit groups">
  Returns number of unit groups matching the filter criteria

  you must have at least one of these scopes: 'unitgroups.read, setup.read, setup.manage'.
</Accordion>

<Accordion title="Get a properties list">
  Get the list of properties.

  you need to be authorized (no particular scope required)
</Accordion>

<Accordion title="Get a property">
  Get a property by id.

  you need to be authorized (no particular scope required)
</Accordion>


# Apollo
Source: https://docs.push.ai/integrations/apollo



Apollo is a CRM tool that allows you to manage your contacts, leads, and opportunities.

<Accordion title="Create Apollo Task">
  Creates new tasks in apollo.io for users and teams. requires a master api key. note: not available for free plan users. apollo does not deduplicate tasks.
</Accordion>

<Accordion title="List Apollo Account Stages">
  Retrieves the ids and details for available account stages in your apollo account. requires a master api key.
</Accordion>

<Accordion title="Create Apollo Deal">
  Creates a new deal in apollo.io. requires a master api key. tracks account activity including monetary values, owners, and stages.
</Accordion>

<Accordion title="List Apollo Contact Stages">
  Retrieves the ids and details for available contact stages in your apollo account. requires a master api key.
</Accordion>

<Accordion title="Apollo People Search">
  Search for people in apollo's database. consumes credits and not available for free plans. limited to 50,000 records (100 per page, up to 500 pages). note: does not return new email/phone data - use people enrichment endpoints for that.
</Accordion>

<Accordion title="List Apollo Deals">
  Retrieves all deals that have been created for your team's apollo account. requires a master api key.
</Accordion>

<Accordion title="Search Apollo Contacts">
  Search for contacts in your apollo account. not available for free plan users. limited to 50,000 records (100 per page, up to 500 pages).
</Accordion>

<Accordion title="Search Apollo Accounts">
  Search for accounts in your apollo account. not available for free plan users. limited to 50,000 records (100 per page, up to 500 pages). note: this searches only accounts added to your database, not all companies in apollo.
</Accordion>

<Accordion title="List Apollo Users">
  Retrieves the ids for all users (teammates) in your apollo account. requires a master api key.
</Accordion>

<Accordion title="Update Apollo Contact">
  Updates an existing contact in apollo.io. requires a master api key.
</Accordion>

<Accordion title="Update Apollo Account">
  Updates an existing account in apollo.io. requires a master api key.
</Accordion>

<Accordion title="Create Apollo Contact">
  Creates a new contact in apollo.io. requires a master api key. note: apollo does not deduplicate contacts - a new contact will be created even if similar details exist.
</Accordion>

<Accordion title="Update Apollo Deal">
  Updates an existing deal in apollo.io. requires a master api key.
</Accordion>

<Accordion title="Apollo Organization Enrichment">
  Enriches data for one company in apollo.io. requires a master api key. enriched data includes industry information, revenue, employee counts, funding details, and more.
</Accordion>

<Accordion title="Apollo Organization Search">
  Search for companies in apollo's database. consumes credits and not available for free plans. limited to 50,000 records (100 per page, up to 500 pages).
</Accordion>

<Accordion title="Apollo People Enrichment">
  Enriches data for one person in apollo.io. requires a master api key.
</Accordion>

<Accordion title="Create Apollo Account">
  Creates a new account in apollo.io. requires a master api key. note: apollo does not deduplicate accounts - a new account will be created even if similar details exist.
</Accordion>


# Asana
Source: https://docs.push.ai/integrations/asana



Tool to help teams organize, track, and manage their work.

<Accordion title="Create tag in workspace">
  Creates a new tag within a specified asana workspace. this endpoint allows you to add a custom label (tag) that can be attached to tasks for better organization and categorization. use this when you need to introduce a new way of grouping or filtering tasks across projects within a workspace. the created tag can have a name, color, description, and designated followers. it's particularly useful for implementing consistent task categorization schemes or setting up new organizational systems within your asana workspace. note that tags are workspace-specific and cannot be shared across different workspaces. this endpoint doesn't attach the tag to any tasks; it only creates the tag for future use.
</Accordion>

<Accordion title="Create task comment">
  This tool creates a comment (story) on an existing asana task. the comment is authored by the currently authenticated user and is timestamped when the server receives the request. it requires a task id and a non-empty comment text.
</Accordion>

<Accordion title="Create subtask">
  Creates a new subtask under a specified parent task in asana. this tool allows users to create subtasks with required parameters (task gid and name) and optional parameters (notes, assignee, due on, due at, completed, followers). it returns the complete subtask object containing details like gid, name, type, created at, completion status, assignee, due dates, notes, and parent task information.
</Accordion>

<Accordion title="Add task to section">
  This tool will add an existing task to a specific section in an asana project. it handles the placement of tasks within project sections, distinguishing it from creating or updating tasks, and ensures tasks are organized properly within the project structure.
</Accordion>

<Accordion title="Retrieve user task list by id">
  Retrieves a specific user task list from asana by its unique identifier (gid). this endpoint allows developers to fetch detailed information about a user's task list, including associated tasks and metadata. it's particularly useful for integrations that need to display or process a user's tasks in external applications or workflows. the endpoint returns the current state of the task list, which may include task details, assignee information, and custom field data. use this when you need to access up-to-date information about a user's tasks or when syncing task data with other systems. note that this endpoint only retrieves data and does not modify the task list.
</Accordion>

<Accordion title="Retrieve list of tasks">
  The retrievetasks endpoint allows you to fetch a list of tasks from a specified asana workspace. this get request to /tasks is essential for retrieving task information, enabling applications to sync task data, generate reports, or display task lists. the endpoint supports filtering completed tasks and implements pagination for handling large result sets efficiently. it's particularly useful for building integrations that need to keep task information up-to-date across different systems or for creating custom dashboards and reports based on asana task data. note that while this endpoint provides task retrieval functionality, it does not support creating, updating, or deleting tasks, which would require separate api calls.
</Accordion>

<Accordion title="Get user list">
  Retrieves a list of users in the asana platform. this endpoint allows you to fetch information about users, such as their names, email addresses, and other profile details. it's particularly useful for getting an overview of team members, managing user accounts, or synchronizing user data with external systems. the endpoint supports pagination to handle large sets of users efficiently. you can filter users by workspace or team, making it easier to manage users within specific organizational units. note that the response will only include users that the authenticated user has permission to see, based on their access level and workspace memberships.
</Accordion>

<Accordion title="List projects">
  Retrieves a list of projects from the user's asana account. this endpoint allows users to fetch information about all available projects, providing an overview of ongoing work and team collaborations. it's particularly useful for project managers and team leads who need to monitor multiple projects or for integrations that require syncing project data with other systems. the endpoint returns basic project details, which may include project names, ids, and status. it should be used when you need a comprehensive view of all projects in the asana workspace. note that this endpoint might not provide detailed task information within each project; for that, you would need to use a separate endpoint specific to tasks.
</Accordion>

<Accordion title="Update task by task gid">
  The updatetask endpoint allows you to modify an existing task in asana by updating its properties. this powerful tool enables you to change various aspects of a task, including its name, description, due dates, assignee, custom fields, and more. it's particularly useful when you need to adjust task details as project requirements evolve or when updating task progress. the endpoint requires the task's unique identifier (gid) and accepts a json object containing the fields to be updated. while it offers extensive customization, it's important to note that some fields are read-only or have specific constraints, and certain updates may have cascading effects on related objects like projects or subtasks.
</Accordion>

<Accordion title="Retrieves list of workspaces">
  Retrieves a list of workspaces accessible to the authenticated user in asana. this endpoint provides essential information about the workspaces, which are the top-level organizational units in asana where teams collaborate on projects and tasks. use this endpoint to get an overview of all workspaces the user has access to, including both personal and organizational workspaces. the response will likely include details such as workspace ids, names, and whether they are personal or organizational. this endpoint is particularly useful for applications that need to enumerate available workspaces or when implementing workspace selection functionality.
</Accordion>

<Accordion title="Retrieve task by gid">
  Retrieves detailed information about a specific task in asana using its unique identifier. this endpoint allows you to fetch comprehensive data about a single task, including its title, description, assignee, due date, project associations, and other relevant metadata. it's particularly useful when you need to access or display the current state and details of a specific task within your application or workflow. the endpoint should be used when you have a task's gid and require its full information. note that this endpoint only provides read access to task data and cannot be used to modify the task. for real-time task updates, consider implementing webhook notifications in addition to using this endpoint.
</Accordion>

<Accordion title="Create task in asana with specific details">
  Creates a new task in asana with the specified properties. this endpoint allows you to create a detailed task by setting various attributes such as name, description, assignee, due date, project associations, and custom fields. it's particularly useful for programmatically creating tasks based on external triggers or as part of automated workflows. the endpoint supports creating standalone tasks, tasks within projects, and subtasks. when creating a task, you can set its initial state, including completion status and dependencies. note that some fields are create-only, meaning they can be set during creation but must be modified through separate endpoints afterward. the response will include the full details of the created task, including system-generated fields like creation timestamp and task gid.
</Accordion>

<Accordion title="Retrieve tasks for project">
  Retrieves a list of tasks associated with a specific project in asana. this endpoint allows you to fetch all tasks that belong to a given project, providing a comprehensive view of the project's workload. use this when you need to get an overview of all tasks within a project, such as for progress tracking, workload assessment, or reporting purposes. the endpoint returns basic task information; however, it may not include full details of each task, so individual task queries might be necessary for in-depth information. keep in mind that for large projects, the response may be paginated, requiring multiple requests to retrieve all tasks.
</Accordion>

<Accordion title="Create new project resource">
  Creates a new project in asana with the specified attributes. this endpoint allows you to set up a project with various details such as name, description, due date, team association, and custom fields. it's used when you need to programmatically create a new project within your asana workspace or team. the endpoint returns the full details of the created project, including its unique identifier (gid) which can be used for further operations or references.
</Accordion>

<Accordion title="Retrieve project by gid">
  Retrieves detailed information about a specific asana project using its unique identifier. this endpoint allows users to fetch comprehensive data about a project, including its name, description, status, due dates, team members, and associated tasks. it's particularly useful when you need up-to-date information about a project's current state or when integrating asana project data into external systems. the endpoint returns a single project object, providing a snapshot of the project at the time of the request. note that this endpoint does not return the full list of tasks within the project; for that, you would need to use a separate endpoint specifically for retrieving project tasks.
</Accordion>


# Attio
Source: https://docs.push.ai/integrations/attio



Attio is a fully customizable workspace for your team's relationships and workflows.

<Accordion title="Post comment to workspace">
  Creates a new comment in the attio platform. this endpoint allows you to add comments to records, list entries, or reply to existing comment threads. it supports plaintext comments with the ability to mention workspace members. use this when you need to add notes, feedback, or engage in discussions within the attio workspace. the endpoint is versatile, handling both top-level comments and threaded replies, but requires careful specification of the comment's context (record, list entry, or thread). note that rich text formatting is not supported, and comments can be backdated within certain limits for data migration purposes.
</Accordion>

<Accordion title="Create new object endpoint">
  Creates a new custom object type in the attio platform. this endpoint allows you to define the basic properties of a new object, including its api slug for future api calls and its singular and plural names for display purposes. use this when you need to establish a new category of data in your attio workspace, such as projects, products, or any other entity type specific to your business. the created object type can then be used to manage relationships and data within attio. note that this endpoint only defines the object type; you'll need separate api calls to add actual data entries for this object type.
</Accordion>

<Accordion title="Create new lists with access control">
  Creates a new list in attio with specified properties and access permissions. this endpoint allows you to define a list's name, api slug, parent object type, and set detailed access controls for workspace members. use this when you need to create a new list for organizing records (e.g., contacts, companies) with custom visibility settings. the list's access can be set globally for all workspace members or individually for specific members, providing flexible control over data visibility and manipulation rights within your attio workspace.
</Accordion>

<Accordion title="Add select option attribute">
  Creates a new option for a specific attribute of a target entity in attio. this endpoint allows you to add selectable values to attributes, enhancing the customization and flexibility of your data model. use this when you need to expand the list of possible values for a particular attribute of a person, company, or entry. the new option will be available for selection when updating or filtering entities based on this attribute. note that this endpoint only creates the option; it does not automatically assign it to any existing entities. ensure that the attribute is set to "selectable" before attempting to create options for it.
</Accordion>

<Accordion title="Create task with related records">
  Creates a new task in the attio platform with specified details such as content, deadline, completion status, linked records, and assignees. this endpoint should be used when you need to programmatically add tasks to your attio workspace, allowing for integration with other systems or automated task creation based on certain triggers. it's particularly useful for bulk task creation or when tasks need to be created as part of a larger workflow. the endpoint provides flexibility in linking tasks to existing records and assigning them to workspace members, enhancing the contextual relevance of tasks within your attio ecosystem. however, it's important to note that rich text formatting and @references within task content are not supported via the api, limiting the formatting options for task descriptions.
</Accordion>

<Accordion title="Delete comment by id">
  Deletes a specific comment from the attio system using its unique identifier. this endpoint should be used when you need to permanently remove a comment from your attio workspace, such as when the comment is no longer relevant or contains incorrect information. the deletion is irreversible, so use this endpoint with caution. it's particularly useful for maintaining data cleanliness and complying with data retention policies. note that this endpoint only deletes the comment itself and does not affect any related records or relationships in the attio system.
</Accordion>

<Accordion title="Post status attributes update">
  Creates or updates a status for a specific attribute of a target in the attio platform. this endpoint allows you to define new statuses or modify existing ones, enabling better organization and tracking of items within your workflow. use this when you need to add a new stage to your process or adjust the properties of an existing status. the endpoint is particularly useful for customizing workflow stages, setting celebration triggers for important milestones, and defining target durations for each status to improve process efficiency. note that this endpoint operates on a specific attribute of a target, so you must have the correct target, identifier, and attribute information to use it effectively.
</Accordion>

<Accordion title="Create note with parent info">
  Creates a new note in the attio platform, associating it with a specific parent object and record. this endpoint is used to add detailed information, such as meeting summaries, call notes, or any other relevant data, to existing records in the system. the note is created with a title, content in plaintext format, and is linked to a parent object and record for organizational purposes. while it allows for backdating notes for historical records, it's important to note that the content is limited to plaintext format only, without support for rich text formatting or special features like @mentions or links. use this endpoint when you need to programmatically add structured notes to your attio records, enhancing the depth of information in your relationship management processes.
</Accordion>

<Accordion title="Create webhook subscriptions">
  Creates a new webhook subscription in attio to receive notifications about specific events. this endpoint allows you to set up automated notifications for various actions within the attio platform, such as comment creation, list updates, or task deletions. use this when you want to integrate attio with external systems or automate workflows based on attio events. the webhook can be configured with multiple event subscriptions and optional filters to precisely control which events trigger notifications. note that the webhook will only receive events that occur after its creation, and there may be a slight delay between an event occurring and the webhook being triggered.
</Accordion>

<Accordion title="Update object records via values">
  Updates records for a specific object in attio by modifying one or more attributes. this endpoint allows for bulk updates of multiple attributes across one or more records within the specified object. it's particularly useful for synchronizing data from external sources or updating multiple fields of a record simultaneously. the endpoint accepts a flexible structure that can handle various attribute types, including single-select and multi-select options. when using this endpoint, ensure that you have the correct object identifier and use the appropriate api slug or attribute id for each attribute you want to update. note that this endpoint performs an upsert operation, meaning it will create new records if they don't exist or update existing ones based on the provided data.
</Accordion>

<Accordion title="Create object records via post">
  Creates a new record for a specific object in attio. this endpoint allows you to add a new entry to an object (e.g., person, company, user) with custom attribute values. it's used when you need to create a new record with specific attribute data in your attio workspace. the endpoint supports various attribute types, including single-select and multi-select options. ensure you provide valid attribute identifiers and corresponding values according to attio's attribute type specifications. this endpoint is essential for programmatically adding new data to your attio objects.
</Accordion>

<Accordion title="Create list entry with parent record">
  Creates a new entry in a specified list within the attio platform, linking it to a parent record. this endpoint allows you to add a record to a list while simultaneously assigning attribute values to the new list entry. it's particularly useful for creating structured relationships between records and lists, enabling complex data organization within attio. the endpoint should be used when you need to associate an existing record with a list and provide additional context through custom attributes. it's important to note that this operation requires an existing parent record and knowledge of the list's attribute structure.
</Accordion>

<Accordion title="Update list entry via put">
  Adds a new entry to a specified list in attio. this endpoint allows you to create a list entry by associating an existing record (the parent record) with a set of attribute values specific to the list. it's particularly useful for categorizing or organizing existing records within custom lists, enabling better relationship management and data organization. the endpoint requires you to provide the parent record's id, the object it belongs to, and the values for the list entry's attributes. use this when you need to add a record to a list with additional, list-specific information. note that this endpoint doesn't create new records in attio; it only creates list entries for existing records.
</Accordion>

<Accordion title="Create attribute">
  This endpoint creates a new attribute for a specific target (object or entry) in the attio platform. it allows you to define custom fields with various data types, configurations, and behaviors. use this endpoint when you need to extend the data model of your attio workspace by adding new fields to objects or entries. the created attribute can store different types of data (e.g., text, numbers, dates) and can be configured with specific behaviors like uniqueness, multi-select capabilities, and default values. this is particularly useful for tailoring attio to your specific business needs, such as adding custom fields for industry-specific data or internal processes. note that some configurations, like default values, are not supported for all object types, and certain attribute types (e.g., 'status') have limitations on where they can be used.
</Accordion>

<Accordion title="Delete entry from list">
  Deletes a specific entry from a designated list in the attio system. this endpoint is used to permanently remove an individual item or task from a collection, helping to manage and organize data within attio. it should be used when you need to eliminate outdated, irrelevant, or erroneous entries from a list. the operation is irreversible, so caution should be exercised when invoking this endpoint. this tool is particularly useful for maintaining the accuracy and relevance of list contents in attio, supporting efficient relationship management and team collaboration.
</Accordion>

<Accordion title="Delete record from object">
  Permanently removes a specific record from a designated object type in the attio system. this endpoint should be used when you need to delete an individual entry from your dataset, such as removing an outdated contact or an irrelevant company profile. the operation is irreversible, so it should be used with caution. once a record is deleted, it cannot be recovered through the api. this endpoint is particularly useful for data cleanup, removing duplicate entries, or complying with data retention policies. it does not provide any confirmation or return the deleted data; it simply removes the specified record if it exists.
</Accordion>

<Accordion title="Delete note by id">
  Deletes a specific note from the attio system using its unique identifier. this endpoint should be used when you need to permanently remove a note from the relationship management platform. it's particularly useful for cleaning up outdated or irrelevant information, maintaining data accuracy, or complying with data retention policies. be cautious when using this endpoint, as the deletion is likely irreversible. the operation does not return the deleted note's content, so ensure you have a backup if needed before deletion. this endpoint is essential for managing the lifecycle of notes within attio's relationship management framework.
</Accordion>

<Accordion title="Delete webhook by id">
  Deletes a specific webhook from the attio platform using its unique identifier. this endpoint should be used when you need to remove a webhook that is no longer required or has become obsolete. it permanently removes the webhook configuration, stopping any further notifications or data transfers associated with it. use this endpoint with caution, as the deletion process is irreversible. once a webhook is deleted, you will need to create a new one if you want to reinstate similar functionality. this operation is useful for managing and cleaning up your webhook configurations in attio, ensuring that only active and necessary webhooks remain in your system.
</Accordion>

<Accordion title="Delete task by id">
  Deletes a specific task from the attio platform using its unique identifier. this endpoint should be used when a task needs to be permanently removed from the system, such as when it's no longer relevant or was created in error. the deletion is irreversible, so use with caution. this operation is useful for maintaining a clean and up-to-date task list in workflows and relationship management processes. the endpoint doesn't return the deleted task's data, so ensure you have any necessary information before deletion.
</Accordion>

<Accordion title="Fetch object by id">
  Retrieves information about a specific object type from the attio relationship management platform. this endpoint allows you to fetch details and structure of various data entities within your attio instance, such as contacts, companies, or custom object types. use this endpoint when you need to understand the properties and structure of a particular object type in your attio setup. it's especially useful for discovering available fields, relationships, or metadata associated with different object types. note that this endpoint retrieves the object type definition, not the actual data records of that type.
</Accordion>

<Accordion title="Retrieve list details">
  Retrieves detailed information about a specific list in the attio relationship management platform. this endpoint allows users to fetch the properties, metadata, and potentially the contents of a single list identified by its unique identifier. it's useful for accessing up-to-date information about a list, including its name, description, creation date, last modified date, and possibly summary statistics about its contents. this endpoint should be used when detailed information about a specific list is needed, rather than for bulk operations or creating/updating lists. it does not modify any data and is safe for frequent calls, subject to any rate limiting that may be in place.
</Accordion>

<Accordion title="Retrieve workspace members">
  Retrieves a list of all members associated with a specified workspace in attio. this endpoint is crucial for user management and collaboration features, allowing you to view and manage the individuals who have access to a particular workspace. use this when you need to audit workspace access, manage team members, or gather information about the users in a specific workspace. the endpoint returns member details such as user ids, names, roles, and possibly other relevant information like email addresses or join dates. it's important to note that this endpoint only provides a list of members and their basic details; it does not offer functionality to modify member access or roles directly. for large workspaces, the results are likely paginated, requiring multiple api calls to retrieve the full list of members.
</Accordion>

<Accordion title="Update task details by id">
  The update task endpoint allows you to modify an existing task in the attio system. it provides the ability to update various properties of a task, including its deadline, completion status, linked records, and assignees. this endpoint is particularly useful for managing task progress, reassigning responsibilities, or adjusting task details as project requirements evolve. the flexibility in referencing linked records and assignees makes it versatile for different use cases. however, it's important to note that creating record links within task content text is not possible via the api at present.
</Accordion>

<Accordion title="Retrieve comment by id">
  Retrieves a specific comment from the attio system using its unique identifier. this endpoint allows users to fetch detailed information about a single comment, including its content, author, creation date, and any associated metadata. it should be used when you need to access or display the full details of a particular comment, such as when viewing comment history or responding to a specific comment. the endpoint will not return information about other comments or modify the comment in any way. note that the availability of comment data may depend on the user's permissions within the attio system.
</Accordion>

<Accordion title="Retrieve webhook details">
  Retrieves a list of all configured webhooks for the authenticated user or organization in the attio platform. this endpoint allows users to view and manage their existing webhook integrations, which are used for real-time event notifications from attio to external applications. it's particularly useful for reviewing current automation setups, troubleshooting integration issues, or planning new automated workflows. the response typically includes details such as webhook urls, associated events, and unique identifiers for each webhook. this endpoint should be used when setting up or managing integrations between attio and other systems, or when auditing existing automation processes. note that while this endpoint provides information about configured webhooks, it does not trigger or test them directly.
</Accordion>

<Accordion title="Fetch entry details from list">
  Retrieves a specific entry from a designated list in the attio platform using the entry's unique identifier. this endpoint allows you to fetch detailed information about a single entry, including all its associated data fields and metadata. it's particularly useful when you need to access or display the complete information of a specific contact, company, or any other entity type stored in an attio list. the endpoint should be used when you have both the list identifier and the entry's unique id, and you require the most up-to-date information for that entry. it does not provide bulk retrieval capabilities or list-wide operations; for those, you would need to use separate list-focused endpoints.
</Accordion>

<Accordion title="Retrieve target attributes">
  Retrieves the attributes associated with a specific target and identifier in the attio crm system. this endpoint is used to fetch metadata or properties of a particular record, such as a contact, company, or any other entity type supported by attio. it allows users to access detailed information about a specific entity, including custom fields and standard attributes. the endpoint is particularly useful when you need to gather all available data about a single record for display, analysis, or integration purposes. note that the response structure and available attributes may vary depending on the target type and your attio workspace configuration.
</Accordion>

<Accordion title="Retrieve attribute by target and identifier">
  Retrieves the value of a specific attribute for a given entity in the attio platform. this endpoint allows you to fetch individual attribute values, providing granular access to entity data. it should be used when you need to access a particular piece of information about an entity without retrieving its entire profile. the endpoint is particularly useful for real-time data retrieval and verification of specific attributes. note that this endpoint only returns the value of a single attribute; to retrieve multiple attributes or full entity profiles, you may need to use a different endpoint or make multiple calls.
</Accordion>

<Accordion title="Patch object properties">
  This endpoint allows you to update the metadata of an existing object in attio. it is used to modify how an object is referenced and accessed within the attio platform, including its api slug, singular name, and plural name. this operation is particularly useful when you need to refine your data model or improve the clarity of your object naming conventions. the update affects how the object is accessed via the api and how it's displayed in the attio user interface. be cautious when updating the api slug, as it will change how the object is referenced in api calls, potentially affecting existing integrations.
</Accordion>

<Accordion title="Retrieve note by id">
  Retrieves a specific note by its unique identifier from the attio platform. this endpoint allows users to fetch detailed information about a single note, including its content, associated contacts or entities, creation date, and any other metadata. it should be used when you need to access or display the full contents of a particular note. the endpoint is useful for viewing note details, preparing for updates, or integrating note information into other systems. it does not modify the note and cannot be used to search across multiple notes or retrieve notes by criteria other than their id.
</Accordion>

<Accordion title="Update webhook by id">
  The updatewebhook endpoint allows you to modify the configuration of an existing webhook in the attio system. this endpoint is used to update the target url where webhook events are sent, as well as to add, remove, or modify event subscriptions and their associated filters. it's particularly useful when you need to change the destination of webhook notifications or adjust which events trigger the webhook. the endpoint provides granular control over event filtering, enabling you to set up complex conditions for when notifications should be sent. note that this endpoint updates the entire webhook configuration, so you should include all desired subscriptions in the request, even if you're only changing some of them.
</Accordion>

<Accordion title="Patch list properties">
  The updatelist endpoint allows you to modify the properties of an existing list in the attio platform. this patch operation can be used to update the list's name, api slug, workspace-wide access level, and individual member access permissions. it's particularly useful when you need to rename a list, change its api accessibility, or adjust its visibility and permissions within your workspace. use this endpoint when you want to make changes to an existing list without creating a new one or replacing it entirely. it provides flexibility in managing list properties, allowing you to update one or more attributes in a single api call. note that while you can update the api slug, changing it may affect existing integrations or api calls that rely on the current slug. exercise caution when modifying this field. also, be aware that this endpoint only updates the specified fields; any fields not included in the request will retain their current values.
</Accordion>

<Accordion title="Patch target identifier attribute configuration">
  The updateattribute endpoint allows you to modify the properties of an existing attribute within a specific object in attio. this powerful tool enables fine-tuning of your data model by adjusting attribute characteristics such as its title, description, api slug, required/unique flags, default values, and type-specific configurations. it's particularly useful when you need to evolve your data structure, improve data quality, or adjust how information is captured and displayed in attio's ui. the endpoint supports a wide range of attribute types, including simple fields like text and numbers, as well as more complex types like record references and currencies. when using this endpoint, be cautious as changes may affect existing data and integrations. it's recommended to thoroughly test any attribute modifications in a non-production environment before applying them to your live workspace.
</Accordion>

<Accordion title="Get task by id">
  Retrieves detailed information about a specific task within the attio relationship management platform. this endpoint allows users to fetch comprehensive data about a single task, including its current status, associated contacts, due dates, and other relevant metadata. it should be used when detailed information about a particular task is needed, such as for displaying task details in a user interface or for further processing in a workflow. the endpoint does not modify the task; it only provides read-only access to the task's current state. note that this endpoint is part of the v2 api, which may have different features or response formats compared to earlier versions.
</Accordion>

<Accordion title="Get notes endpoint">
  Retrieves a list of notes from the attio platform. this endpoint allows users to access and view notes associated with their account or organization. it's particularly useful for getting an overview of all notes, which can include information related to contacts, meetings, or any other relevant data in the relationship management context. the endpoint should be used when you need to fetch multiple notes at once, perhaps for displaying in a list view or for syncing with another system. note that this endpoint likely returns a paginated list of notes, and additional parameters for pagination might be available but are not specified in the current schema. the response will likely include basic information for each note such as its id, title, creation date, and possibly a snippet of the content, but the full note content may require a separate api call.
</Accordion>

<Accordion title="Retrieve attribute options">
  Retrieves the available options for a specific attribute of a target entity in attio. this endpoint is used to fetch the predefined set of selectable values for a given attribute, which can be used for populating dropdown menus, validating input, or understanding the possible values for an entity's attribute. it's particularly useful when working with custom fields or attributes that have a finite set of allowed values. the endpoint doesn't modify any data and is safe for frequent calls, making it ideal for dynamically updating user interfaces or validating data before submission. note that the response will only include active options; any archived or deleted options will not be returned.
</Accordion>

<Accordion title="Get attribute values for entry in list">
  Retrieves the values of a specific attribute for a particular entry within a list in attio. this endpoint is used to access detailed information about an entry's attributes, allowing for granular data retrieval. it's particularly useful when you need to fetch specific attribute data without retrieving the entire entry information. the endpoint requires the list identifier, entry id, and attribute identifier to pinpoint the exact data you're seeking. it's important to note that this endpoint only retrieves data and doesn't modify any information in your attio account.
</Accordion>

<Accordion title="Query filtered list entries with sorting">
  The querylistentries endpoint enables searching, filtering, sorting, and paginating entries within a specific attio list. it's ideal for retrieving customized data subsets, supporting complex queries and efficient handling of large datasets. use it for tailored data retrieval, report generation, or external system integrations. while powerful, it focuses on data retrieval and organization, not data aggregation or computation.
</Accordion>

<Accordion title="Retrieve list of objects">
  Retrieves a collection of objects from the attio platform. this endpoint allows users to fetch data objects without modifying them, providing a comprehensive view of the available objects in the system. it should be used when you need to list or browse through the objects in your attio workspace, such as contacts, companies, or custom object types. the endpoint returns all accessible objects by default, which may include a large amount of data. consider using appropriate query parameters (if supported) to filter or limit the results for more efficient data retrieval. note that while the schema doesn't specify parameters, common restful practices suggest that pagination, filtering, or sorting options might be available through query parameters.
</Accordion>

<Accordion title="Retrieve object record by id">
  Retrieves a specific record from a designated object in the attio platform. this endpoint allows you to fetch detailed information about a single record by providing the object type and the record's unique identifier. it's useful for accessing up-to-date information about a particular entity in your attio instance, such as a specific contact, company, or any custom object you've defined. the endpoint returns comprehensive data about the requested record, including all fields and their current values. use this when you need to retrieve the most recent data for a known record within a specific object type in your attio database.
</Accordion>

<Accordion title="Fetch attribute statuses">
  Retrieves the current statuses of a specific attribute for a given entity in the attio platform. this endpoint is used to check the state or condition of a particular attribute, which is crucial for tracking changes, managing workflows, or understanding the current state of an entity's data point. it should be used when you need to get up-to-date status information for a specific attribute of a contact, company, or other supported entity types in attio. the endpoint does not modify any data and is intended for read-only operations. it's particularly useful for monitoring the progress of workflows, verifying the current state of attributes, or gathering information for reporting purposes.
</Accordion>

<Accordion title="Get v2 lists">
  Retrieves a collection of lists from the attio platform. this endpoint allows users to fetch information about all available lists within their attio workspace. it's particularly useful for getting an overview of the organizational structure and data categorization within the platform. the endpoint should be used when you need to retrieve a comprehensive list of all available lists, their names, and potentially other metadata associated with each list. it does not provide the actual contents of the lists, but rather serves as a directory of available lists. this endpoint is ideal for scenarios such as populating dropdown menus for list selection, auditing the organizational structure, or as a first step in more complex workflows involving list management.
</Accordion>

<Accordion title="Retrieve thread details">
  Retrieves detailed information about a specific thread in the attio platform using its unique identifier. this endpoint allows users to fetch comprehensive data about a particular discussion or topic thread, including its content, participants, and other relevant metadata. it should be used when detailed information about a specific thread is needed, such as when displaying thread contents, updating thread information, or analyzing thread activity. the endpoint will not modify the thread data and is read-only. note that the response may include sensitive information, so proper authorization should be ensured before exposing thread details to end-users.
</Accordion>

<Accordion title="Retrieve self information">
  Retrieves the profile information for the currently authenticated user. this endpoint allows you to fetch details about the user who is making the api request, such as their name, email, account settings, and other relevant profile data. it should be used when you need to access or display the current user's information within your application. the endpoint does not require any additional parameters as it relies on the authentication context to identify the user. note that this endpoint will only return data for the authenticated user and cannot be used to retrieve information about other users.
</Accordion>

<Accordion title="Patch attribute option">
  Updates a specific select option within an attribute for a target entity in attio. this endpoint allows you to modify the title of an existing select option and change its archived status. use this when you need to rename a select option or manage its visibility within your attio workspace. the endpoint is particularly useful for maintaining up-to-date and relevant options for your attributes, ensuring that your data remains organized and reflective of your current business needs. note that archiving an option doesn't delete it, but rather makes it inactive while preserving historical data associated with it.
</Accordion>

<Accordion title="Retrieve webhook by id">
  Retrieves detailed information about a specific webhook in the attio system. this endpoint allows you to fetch the current configuration, status, and other relevant details of a webhook identified by its unique id. use this when you need to review or verify the settings of an existing webhook, such as its target url, the events it's subscribed to, or its activation status. this tool is particularly useful for troubleshooting webhook-related issues or auditing your webhook configurations. it provides a snapshot of the webhook's current state but does not modify any settings.
</Accordion>

<Accordion title="Update entry values in list">
  This endpoint updates specific attributes of an existing entry within a designated list in attio. it uses a patch operation to modify only the specified attributes, leaving others unchanged. provide the list id, entry id, and a json payload with updated attribute values in the 'data' object's 'entry values'. supports various attribute types, but doesn't allow adding new properties. refer to attio's docs for correct value formats.
</Accordion>

<Accordion title="Get record entry by id">
  Retrieves all entries (field values) for a specific record within a given object in attio. this endpoint allows you to fetch detailed information about an individual record, such as all the fields and their values for a particular contact or company. it's useful when you need comprehensive data about a single record without retrieving the entire object collection. the endpoint returns all available fields for the record, providing a complete view of the data stored for that specific entry. use this when you need to display or process all information related to a particular record in your application.
</Accordion>

<Accordion title="Fetch tasks">
  Retrieves a list of tasks from the attio platform. this endpoint allows users to fetch task information related to their relationship management activities. it's particularly useful for getting an overview of ongoing tasks, tracking progress, or syncing task data with other systems. the endpoint returns task details which may include task titles, descriptions, due dates, assignees, and associated contacts or deals. use this endpoint when you need to retrieve task information for display, reporting, or further processing in your application. note that this endpoint likely returns all tasks by default, and filtering or pagination might be handled through query parameters not specified in this schema.
</Accordion>

<Accordion title="List threads v2">
  Retrieves a list of threads from the attio platform. this endpoint allows users to fetch all available threads, which likely represent conversations or discussions related to various records, lists, notes, or tasks within the attio crm system. it's useful for getting an overview of ongoing communications or for syncing thread data with external systems. the endpoint returns a collection of thread objects, though the exact structure of these objects is not specified in the schema. this tool should be used when you need to access or review multiple threads at once, but it may not provide detailed content of individual messages within the threads. note that the lack of query parameters might mean that all threads are returned, potentially requiring client-side filtering for specific use cases.
</Accordion>

<Accordion title="Retrieve workspace member details">
  Retrieves detailed information about a specific member within an attio workspace. this endpoint allows you to fetch comprehensive data about an individual user's profile, permissions, and role within the workspace context. use this when you need to access or verify a particular member's details, such as during user management tasks, permission audits, or when displaying member information in your application. the endpoint provides a snapshot of the member's current status and configuration within the workspace but does not include historical data or changes to their profile over time. it's particularly useful for administrators and team leads who need to manage workspace memberships and understand individual user setups.
</Accordion>

<Accordion title="Patch status attributes">
  This endpoint allows you to update the attributes of a specific status within an attribute of a target in attio. it's used to modify status properties such as the title, celebration settings, target time in status, and archival state. this patch operation is particularly useful when you need to refine your workflow stages, adjust time-based goals, or manage the visibility of statuses in your attio workspace. the endpoint requires you to specify the target, identifier, attribute, and status in the path, and provide the updated attributes in the request body. it's important to note that this operation only updates the specified fields and does not affect other attributes of the status that are not included in the request.
</Accordion>

<Accordion title="Get attribute value records">
  Retrieves the values of a specific attribute for a particular record within an object in the attio platform. this endpoint is useful for accessing detailed information about a single attribute of a record, allowing you to fetch current values without retrieving the entire record. it should be used when you need to check or verify the specific attribute values of a known record. this endpoint is particularly helpful for targeted data retrieval, reducing unnecessary data transfer when only specific attribute information is needed. note that this endpoint only provides read access to the attribute values and cannot be used to modify the data.
</Accordion>

<Accordion title="Query object records with filter and sort">
  The queryrecords endpoint allows you to search and retrieve records from a specific object in attio using advanced filtering, sorting, and pagination options. this powerful querying tool is ideal for extracting precise subsets of data from your attio workspace, enabling efficient data retrieval and analysis. use this endpoint when you need to fetch records based on specific criteria, sort results in a particular order, or implement paginated data fetching. the endpoint supports complex filtering logic and multi-level sorting, making it suitable for a wide range of data querying needs. however, note that the maximum number of results per query is limited to 500 by default, so for larger datasets, you'll need to implement pagination using the limit and offset parameters.
</Accordion>

<Accordion title="Update list entry attributes">
  Updates an existing entry in a specified list within the attio platform. this endpoint allows you to modify the values of attributes for a particular entry. it's useful for keeping your relationship data up-to-date when information changes. the endpoint supports updating both single-select and multi-select attributes, as well as other attribute types defined in attio's attribute type documentation. use this endpoint when you need to update specific information for an entry without replacing the entire entry. note that you can only update attributes that are already associated with the entry; to add new attributes, you may need to use a different endpoint.
</Accordion>

<Accordion title="Update record data via object id">
  Updates a specific record within an object in the attio platform. this endpoint allows you to modify the values of one or more attributes for a given record. it's particularly useful for updating contact information, changing status fields, or modifying any custom attributes associated with the record. the endpoint supports both single-select and multi-select attributes, allowing for flexible updates to various data types. when using this endpoint, ensure you have the correct object identifier and record id, and format the update data according to attio's attribute type specifications.
</Accordion>


# Bamboohr
Source: https://docs.push.ai/integrations/bamboohr



BambooHR is an American technology company that provides human resources software as a service.

<Accordion title="Add time tracking record">
  This endpoint allows you to add a new time tracking record for an employee in the bamboohr system. it's used to log hours worked, including regular and overtime hours, along with associated details such as pay rates, job codes, and organizational information. the endpoint is essential for accurate time tracking, payroll processing, and reporting within bamboohr. use this when you need to manually input or programmatically add time entries for employees, ensuring that all required fields are provided and optional fields are included as needed for your specific payroll and reporting requirements.
</Accordion>

<Accordion title="Create employee unpaid paystub">
  Posts unpaid pay stubs for a specific employee in the bamboohr system. this endpoint allows you to add or update information about pay periods for which an employee has not been paid. it's useful for tracking delayed payments, managing payroll discrepancies, or recording periods of unpaid leave. the function requires the employee's id and an array of unpaid period dates. use this when you need to update an employee's payroll record with periods that haven't been compensated yet. note that this endpoint doesn't process payments; it only records the unpaid periods for tracking and future processing.
</Accordion>

<Accordion title="Add benefit group employee record">
  This endpoint allows you to associate an employee with a specific benefit group in bamboohr for a defined period. it's used when you need to enroll an employee in a new benefits package or update their existing benefits enrollment. the association can be set for a specific time frame or left open-ended for ongoing enrollment. this tool is particularly useful for hr administrators managing employee benefits, especially during onboarding, annual enrollment periods, or when an employee's benefit status changes. note that this endpoint only creates the association; it doesn't provide details about the benefits themselves or handle the actual enrollment process in specific benefit plans.
</Accordion>

<Accordion title="Post applicant comment">
  This endpoint allows you to post a comment on a specific application in bamboohr's applicant tracking system. it's used to add notes, feedback, or any relevant information to an applicant's file during the recruitment process. the endpoint requires the company domain and application id to identify where the comment should be added, along with the comment text itself. it's particularly useful for collaboration among hiring team members, documenting interview feedback, or noting important details about an applicant. this function should be used whenever there's a need to update an application with new information in a comment format. note that this endpoint only handles adding comments and does not provide functionality for reading or modifying existing comments.
</Accordion>

<Accordion title="Submit candidate application">
  This endpoint creates a new job application in the bamboohr applicant tracking system. it allows for the submission of a candidate's personal information, professional details, and supporting documents for a specific job opening. the endpoint accepts multipart/form-data, enabling the upload of resume and cover letter files along with text-based information. it should be used when a new candidate applies for a job or when bulk-uploading applications from external sources. the endpoint requires at minimum the candidate's first name, last name, and the job id, but allows for a comprehensive application with optional fields covering everything from contact details to educational background.
</Accordion>

<Accordion title="Post training category via domain">
  Creates a new training category in the bamboohr system. this endpoint allows hr administrators to organize and structure their training programs by adding custom categories. use this when you need to introduce a new classification for training content, courses, or programs. the newly created category can then be used to group related training materials, making it easier for employees and managers to navigate and access specific types of training. this endpoint is essential for maintaining an organized and efficient training management system within bamboohr.
</Accordion>

<Accordion title="Post employee training record">
  This endpoint allows you to create a new training record for a specific employee in the bamboohr system. it's used to document completed training sessions, including details such as the completion date, cost, instructor, duration, credits earned, and any additional notes. this tool is essential for maintaining accurate employee development records, tracking professional growth, and ensuring compliance with training requirements. it should be used whenever an employee completes a training session, workshop, or course that needs to be officially recorded in their hr file. the endpoint requires the company domain and employee id as part of the url, ensuring that the training record is associated with the correct employee in the appropriate company account.
</Accordion>

<Accordion title="Retrieve employee performance options">
  Retrieves the list of employees with whom a specific employee's goals can be shared within bamboohr. this endpoint is used to determine the visibility options for an employee's performance goals, allowing hr managers or system administrators to view and potentially modify goal sharing settings. it's particularly useful when setting up or reviewing goal visibility across the organization, ensuring appropriate access to performance information. the endpoint does not modify any data; it only provides information about current share options. it should be used when there's a need to understand or audit the goal visibility for a particular employee.
</Accordion>

<Accordion title="Add webhook with monitoring fields">
  The addwebhook endpoint allows you to create a new webhook in bamboohr, enabling real-time notifications for specific employee data changes. this tool is used to set up automated data synchronization between bamboohr and external systems, triggered by changes to monitored fields. it provides granular control over which data is sent, how often, and in what format. use this when you need to integrate bamboohr with other systems or automate workflows based on hr data changes. note that webhooks are subject to rate limiting and security constraints, so careful configuration is essential to ensure reliable and secure data transmission.
</Accordion>

<Accordion title="Approve timesheets with timestamp">
  The approvetimesheets endpoint enables managers or authorized personnel to approve multiple employee timesheets in a single api call within the bamboohr time tracking system. this function streamlines the timesheet approval process, which is a critical step in payroll processing and ensuring accurate compensation for employees. it should be used at the end of a pay period or when managers need to approve a batch of completed timesheets. the endpoint requires the last modification timestamp and an array of timesheet ids to be approved, allowing for efficient batch processing. however, it does not provide the ability to partially approve or reject individual time entries within a timesheet; the approval applies to the entire timesheet for each id provided.
</Accordion>

<Accordion title="Adjust employee time off balance">
  This endpoint allows you to adjust the time off balance for a specific employee in bamboohr. it's used to make corrections, add or subtract time off, or reconcile discrepancies in an employee's time off records. the adjustment is applied to a particular time off type (e.g., vacation, sick leave) on a specified date. this tool is particularly useful for hr administrators who need to manually modify time off balances due to policy changes, corrections, or special circumstances. it provides a way to maintain accurate time off records without altering the underlying accrual rules or past time off requests. note that this adjustment will be reflected in the employee's time off history and may affect future balance calculations.
</Accordion>

<Accordion title="Post training object for a company domain">
  Creates a new training type in the bamboohr system with specified attributes and settings. this endpoint allows hr administrators to define and customize various aspects of a training program, including its name, description, renewal requirements, categorization, and completion settings. it's particularly useful for setting up new employee training programs, compliance courses, or skill development modules within an organization. the endpoint provides flexibility in configuring how the training is presented, tracked, and managed within the bamboohr platform.
</Accordion>

<Accordion title="Update employee table row">
  This endpoint allows you to update a specific row in an employee's table within bamboohr. it is used to modify various aspects of an employee's record, such as their job information, location, or organizational structure. the endpoint is particularly useful for keeping employee data up-to-date when changes occur, such as promotions, transfers, or organizational restructuring. it's important to note that this endpoint updates a single row in a specific table, so multiple calls may be necessary for comprehensive employee record updates across different tables.
</Accordion>

<Accordion title="Fetch goal alignment options">
  Retrieves the available goal alignment options for a specific employee or the authenticated api user in bamboohr. this endpoint is used to fetch possible alignment choices for employee goals, which helps in ensuring that individual objectives are in line with broader organizational goals. the response includes the currently aligned option for the employee's goal, if one exists. this tool is particularly useful when setting up or adjusting employee performance goals, allowing for proper alignment with company objectives. it should be used when there's a need to view or update the alignment of an employee's goals within the performance management system. the endpoint does not modify any data; it only provides information about available alignment options.
</Accordion>

<Accordion title="Clock out and approve timesheets">
  This endpoint allows you to clock out employees and approve their timesheets simultaneously in the bamboohr time tracking system. it's designed for efficiently processing end-of-day or end-of-shift time entries for one or multiple employees. the endpoint accepts an array of clock out information, enabling bulk processing of timesheet approvals. it should be used when managers or hr personnel need to finalize time entries and approve timesheets in a single operation, streamlining the time tracking workflow. this endpoint is particularly useful for companies with shift-based work or those requiring daily timesheet approvals. note that this action is final and may require appropriate permissions to execute.
</Accordion>

<Accordion title="Create employee benefit entry">
  Creates or updates an employee benefit in the bamboohr system. this endpoint allows you to manage various aspects of an employee's benefit enrollment, including coverage details, financial contributions, and enrollment status. it's primarily used when setting up new benefits for an employee, making changes to existing benefits, or updating enrollment statuses. the endpoint is versatile, handling different types of benefits with various contribution structures for both employees and the company. it's important to note that while many fields are optional, they may be required depending on the specific benefit type and company policies. this endpoint should not be used for bulk updates or to retrieve benefit information; separate endpoints likely exist for those purposes.
</Accordion>

<Accordion title="Check employee goal creation permission">
  This endpoint checks whether a specific employee has the permission to create goals within the bamboohr performance management system. it is useful for determining user capabilities before attempting to create or modify goals, ensuring proper access control within the application. the endpoint should be used when setting up or managing goal-setting processes, or when building interfaces that dynamically adjust based on user permissions. it does not provide information about existing goals or other performance metrics, focusing solely on the create permission for goals.
</Accordion>

<Accordion title="Create job opening post">
  Creates a new job opening in the bamboohr applicant tracking system. this endpoint allows you to set up a comprehensive job listing with detailed information about the position, requirements, and application process. use this when you need to post a new job opportunity, whether it's ready to be published or still in draft form. the endpoint captures essential job details and allows customization of the application form through various question fields. it's particularly useful for hr managers and recruiters who need to efficiently manage the hiring process. note that while you can create a job opening, this endpoint does not automatically publish or advertise the position; additional steps may be required to make the job visible to potential applicants.
</Accordion>

<Accordion title="Create company benefit">
  This endpoint creates a new company benefit in bamboohr. it allows hr administrators to set up various types of employee benefits, including health insurance, retirement plans, and reimbursement programs. the endpoint captures essential details such as benefit type, start and end dates, deduction information, and compliance with aca requirements. use this endpoint when adding a new benefit offering or updating an existing benefit with new terms. it's particularly useful during open enrollment periods or when changing benefit providers. note that this endpoint does not enroll employees in the benefit; it only sets up the benefit at the company level.
</Accordion>

<Accordion title="Post application status update">
  Updates the status of a specific application in the bamboohr applicant tracking system. this endpoint allows you to change the current status of an application, which is useful for tracking the progress of candidates through your hiring process. use this when you need to move an application to a new stage, such as from 'new' to 'under review' or 'interviewed' to 'offer extended'. the status is represented by an integer id, which corresponds to predefined status options in your bamboohr setup. it's important to note that this endpoint only updates the status and doesn't provide additional information about the application or candidate. ensure you have the correct status id before making the call, as incorrect ids may lead to unexpected status changes.
</Accordion>

<Accordion title="Delete employee direct deposit accounts">
  Deletes a specific direct deposit account associated with an employee in the bamboohr system. this endpoint should be used when an employee's direct deposit account needs to be removed, such as when an employee closes a bank account or requests removal of a direct deposit option. the deletion is permanent and cannot be undone, so it should be used with caution. this endpoint only removes the specified direct deposit account and does not affect other accounts or employee information.
</Accordion>

<Accordion title="Delete employee withholding by id">
  Deletes a specific employee withholding record from the bamboohr system. this endpoint is used to remove tax deduction or other financial withholding information for an employee. it should be used when you need to permanently remove outdated, incorrect, or no longer applicable withholding data. this operation cannot be undone, so it should be used with caution. the endpoint requires the company's bamboohr subdomain and the unique identifier of the withholding record to be deleted. it does not return any content upon successful deletion, typically responding with a 204 no content status.
</Accordion>

<Accordion title="Update time off request status">
  This endpoint updates the status of a specific time-off request in bamboohr. it allows hr managers or authorized personnel to approve, deny, or cancel an employee's time-off request. the endpoint is used when a decision has been made regarding a pending time-off request or when there's a need to change the status of an existing request. it's particularly useful for maintaining accurate records of employee leave and ensuring proper workflow in the time-off management process. the endpoint also provides the option to attach a note to the status change, allowing for clear communication and documentation of the decision-making process.
</Accordion>

<Accordion title="Add or update list field values">
  Adds new values or updates existing values for a specific list field in the bamboohr system. this endpoint allows you to modify the available options for custom dropdown fields, multi-select fields, or other list-type fields in your bamboohr instance. it's particularly useful when you need to maintain consistent list options across your hr system, such as updating department names, job titles, or any other predefined lists used in employee records or forms. the endpoint requires the company domain and the specific list field id to be included in the url path, ensuring changes are applied to the correct field in the right company instance.
</Accordion>

<Accordion title="Update employee time off history">
  Adds a new time off history item to an employee's record in bamboohr. this endpoint is used to retroactively add time off requests to an employee's history, which is useful for maintaining accurate records of past time off, especially when backfilling data or correcting historical entries. it allows hr administrators to ensure that an employee's time off history is complete and up-to-date, which is crucial for accurate leave balance calculations and reporting. the endpoint requires the company domain and employee id to be specified in the url path, ensuring that the time off history item is added to the correct employee's record.
</Accordion>

<Accordion title="Delete employee unpaid pay stub">
  This endpoint deletes a specific unpaid pay stub for an employee in the bamboohr system. it is used to remove outdated, erroneous, or unnecessary unpaid pay stub records from the company's hr database. the operation is irreversible, so it should be used with caution. this endpoint is particularly useful for correcting payroll mistakes, managing test data, or cleaning up records during employee offboarding processes. it does not affect paid pay stubs or other employee financial records beyond the specified unpaid pay stub.
</Accordion>

<Accordion title="Create employee dependent record">
  This endpoint allows you to create a new dependent for an existing employee in the bamboohr system. it is used to add family members or other individuals who are dependent on the employee, which is crucial for benefits administration, tax purposes, and other hr-related tasks. the endpoint requires detailed information about the dependent, including personal details, contact information, and status indicators. it should be used when onboarding new employees with dependents, updating family information, or managing benefits enrollment periods. note that some fields contain sensitive personal information, so ensure proper data security measures are in place when using this endpoint.
</Accordion>

<Accordion title="Clock in employee with time and location">
  This endpoint records a clock-in event for a specific employee in the bamboohr time tracking system. it allows for precise tracking of work hours, including the start time, associated project and task, and optionally, the location of the clock-in. this tool should be used when an employee begins their work day or returns from a break. it's particularly useful for organizations that need detailed time tracking, especially those with remote or field workers. the endpoint doesn't handle clock-out events or provide any information about ongoing or completed work periods.
</Accordion>

<Accordion title="Modify employee withholding details">
  This endpoint updates an employee's withholding information for tax purposes in the bamboohr system. it allows modification of federal, state, and local tax withholding amounts, including any additional withholdings, as well as specifying the applicable tax state and local jurisdiction. this tool should be used when there are changes to an employee's tax situation, such as filing status changes, additional jobs, or relocation. it's crucial for maintaining accurate payroll calculations and tax compliance. the endpoint doesn't calculate tax amounts; it only updates the stored values based on the provided information. users should ensure they have the correct withholding information before making updates, as incorrect data may lead to under or over-withholding of taxes.
</Accordion>

<Accordion title="Post employee clock out datetime">
  This endpoint records the clock-out time for a specific employee in the bamboohr time tracking system. it should be used when an employee ends their work shift or workday. the endpoint requires the company domain, employee id, and the exact clock-out time. it supports specifying a timezone, which is particularly useful for companies with employees working across different geographical locations. this function is crucial for accurate time tracking, payroll processing, and compliance with labor regulations. note that this endpoint only records the clock-out event; it does not provide information about the total hours worked or any other time tracking data.
</Accordion>

<Accordion title="Clock out employee with location">
  The clockoutemployee endpoint allows you to record an employee's clock-out time and location in the bamboohr time tracking system. this endpoint should be used when an employee finishes their work session and needs to log their end time and current location. it captures precise geolocation data along with a readable address to ensure accurate time and location tracking for payroll, compliance, and workforce management purposes. this tool is particularly useful for remote or field workers who need to clock out from various locations.
</Accordion>

<Accordion title="Request employee time off">
  This endpoint allows you to add or update a time off request for a specific employee in bamboohr. it's used to submit new time off requests or modify existing ones, providing detailed information about the request such as start and end dates, type of time off, and any associated notes. this tool is essential for managing employee leave and maintaining accurate records of time off within the bamboohr system. it should be used whenever an employee needs to request time off or when hr needs to update an existing time off request. the endpoint doesn't handle approval workflows directly; it's primarily for creating and updating request data.
</Accordion>

<Accordion title="Create employee direct deposit account">
  Updates the direct deposit account information for a specific employee in the bamboohr system. this endpoint allows you to modify existing direct deposit accounts or add new ones for an employee. it's particularly useful when an employee changes their bank account, adjusts their deposit allocations, or wants to split their paycheck across multiple accounts. the endpoint requires the company domain and employee id in the url path, and accepts an array of account objects in the request body, each detailing the specifics of a direct deposit account. this tool should be used with caution as it directly affects an employee's payment method, and any errors could result in payroll issues.
</Accordion>

<Accordion title="Add employee goal">
  This endpoint allows you to add a new goal for a specific employee in the bamboohr performance management system. it's used to create structured, trackable objectives that can be aligned with company strategies and shared among team members. the endpoint is particularly useful for setting up performance targets, professional development plans, or project-specific goals. it supports both simple goals and more complex objectives with multiple milestones, enabling detailed progress tracking and collaborative goal-setting within the organization.
</Accordion>

<Accordion title="Add comment to employee goal">
  This endpoint allows you to post a comment on a specific employee's goal within the bamboohr performance management system. it's used to provide feedback, updates, or additional information related to an employee's progress on a particular goal. the endpoint is particularly useful for managers, hr professionals, or team members who need to collaborate and communicate about goal achievement. when using this endpoint, ensure you have the necessary permissions to comment on the specified employee's goals. the comment will be immediately visible to users with access to the employee's performance records in bamboohr.
</Accordion>

<Accordion title="Close employee goal">
  The closeemployeegoal endpoint allows you to mark a specific performance goal as completed or closed for an individual employee in bamboohr. this action is typically used when an employee has achieved their goal or when the goal period has ended. the endpoint provides the option to include a final comment, which can be useful for summarizing the outcome or providing context for the goal closure. it's important to note that this action is irreversible, so it should be used carefully and only when you're certain that the goal should be finalized. this endpoint is particularly useful for maintaining up-to-date performance records and facilitating performance review processes within the bamboohr system.
</Accordion>

<Accordion title="Employee clock in via taskid">
  Clocks in an employee in the bamboohr time tracking system, marking the start of their work period. this endpoint should be used when an employee begins their work shift or returns from a break. it allows for optional association with specific projects and tasks, as well as the addition of a note for context. the function is particularly useful for remote workers or companies with flexible working hours. it does not provide clock-out functionality or retrieve existing time entries - separate endpoints would be required for those actions.
</Accordion>

<Accordion title="Delete employee table row">
  This endpoint deletes a specific row from an employee's table in bamboohr. it allows for the removal of individual entries from structured data sets associated with an employee, such as job history, education records, or certifications. the endpoint should be used when there's a need to remove incorrect or outdated information from an employee's record. it's important to note that this operation is irreversible, so it should be used with caution. this endpoint does not return the deleted data or provide a confirmation of deletion in its response, so additional verification may be necessary after calling this endpoint.
</Accordion>

<Accordion title="Create time tracking project">
  Creates a new time tracking project in bamboohr. this endpoint allows you to set up a project with customizable settings such as billability, employee access, and associated tasks. use this when you need to establish a new project for tracking employee time, whether for client work or internal initiatives. the endpoint is particularly useful for project managers or hr administrators setting up new projects or initiatives that require time tracking. note that while you can create a project without tasks, adding tasks provides more granular time tracking capabilities.
</Accordion>

<Accordion title="Delete time tracking entry">
  The deletetimetrackingentry endpoint allows for the deletion of a specific time tracking entry from the bamboohr system. this operation is used when you need to remove an individual time tracking record, such as an incorrectly entered time-off request or work hours log. the endpoint requires the company domain and the unique identifier of the time tracking entry to be deleted. it's important to note that this operation is irreversible, so it should be used with caution. this endpoint is particularly useful for correcting errors in time tracking data or removing outdated entries, but it should not be used for bulk deletions or regular data management tasks.
</Accordion>

<Accordion title="Delete employee pay stub by id">
  Deletes a specific employee pay stub from the bamboohr system. this endpoint should be used when there's a need to remove an incorrect or outdated pay stub from an employee's record. it permanently removes the pay stub data, so it should be used with caution and only when necessary, such as in cases of payroll errors or data cleanup. the operation cannot be undone, so it's crucial to verify the correct pay stub id before deletion. this endpoint is particularly useful for maintaining accurate payroll records and ensuring compliance with financial regulations.
</Accordion>

<Accordion title="Delete company benefit by id">
  Deletes a specific company benefit from the bamboohr system. this endpoint should be used when you need to remove a benefit that is no longer offered or relevant to the company. it permanently removes the benefit from the system, so it should be used with caution. once deleted, the benefit cannot be recovered, and any employees associated with this benefit may need to be updated. this operation may have implications for reporting and historical data, so it's recommended to archive or document the benefit details before deletion if needed for record-keeping purposes.
</Accordion>

<Accordion title="Post employee clock out">
  This endpoint clocks out an employee in the bamboohr time tracking system, marking the end of their working hours. it should be used when an employee finishes their work shift or needs to record the end of their working time. the endpoint is part of the time tracking api, which integrates with bamboohr timesheets for comprehensive time management. it's important to note that this endpoint only records the clock-out time and doesn't provide additional information about the employee's shift or total hours worked. ensure that the employee is currently clocked in before using this endpoint, as attempting to clock out an employee who isn't clocked in may result in an error.
</Accordion>

<Accordion title="Delete file by id">
  Deletes a specific file from the bamboohr system for a given company. this endpoint is used when you need to permanently remove a file from an employee's records or the company's document storage in bamboohr. it should be used with caution as the deletion is irreversible. the endpoint requires the company's subdomain and the specific file id to identify and delete the correct file. it's particularly useful for maintaining data hygiene, removing outdated or incorrect documents, or complying with data retention policies. note that this operation may be subject to user permissions within the bamboohr system, and successful deletion might depend on the file's association with other records or processes.
</Accordion>

<Accordion title="Delete clock entry ids">
  Deletes multiple clock entries from the bamboohr time tracking system. this endpoint allows administrators to remove specific time tracking records, which is useful for correcting errors, managing outdated entries, or cleaning up the time tracking data. it should be used when you need to permanently remove one or more clock entries from an employee's time tracking history. note that this operation is irreversible, so caution should be exercised when using this endpoint. the endpoint does not provide any confirmation or details about the deleted entries, so it's recommended to verify the deletion through a separate get request if necessary.
</Accordion>

<Accordion title="Delete employee file by id">
  Deletes a specific file associated with an employee in the bamboohr system. this endpoint should be used when you need to permanently remove a document or file from an employee's record. it's particularly useful for maintaining data accuracy, complying with document retention policies, or removing outdated or incorrect files. the operation is irreversible, so caution should be exercised when using this endpoint. it does not provide any confirmation or retrieve the file content before deletion, so it's advisable to verify the correct fileid before making the call.
</Accordion>

<Accordion title="Delete employee goal comment">
  Deletes a specific comment on an employee's performance goal in the bamboohr system. this endpoint should be used when you need to remove feedback, notes, or other comments that are no longer relevant or appropriate for a particular goal. it's particularly useful for maintaining clean and up-to-date goal tracking by removing outdated or incorrect information. the deletion is permanent, so use this endpoint with caution. it does not return any content upon successful deletion, only a success status code.
</Accordion>

<Accordion title="Store time tracking clock entries">
  The "store time tracking clock entries" endpoint allows you to create or update multiple time tracking entries for employees in bamboohr. this endpoint is used to record working hours, including start and end times, dates, and optional project, task, and note information. it's particularly useful for batch processing of time entries, such as at the end of a pay period or when synchronizing data from another system. use this endpoint when you need to add new time entries or modify existing ones in bulk. it supports creating new entries and updating existing ones by specifying the entry id. the endpoint is designed for efficiency, allowing multiple entries to be processed in a single api call. note that this endpoint does not handle time entry approval workflows or payroll calculations directly. it's primarily for data entry and updates. ensure that the employee ids, project ids, and task ids used in the request correspond to valid entities in your bamboohr system to avoid errors.
</Accordion>

<Accordion title="Post employee paystub details">
  Creates a new employee pay stub in the bamboohr system. this endpoint allows for the detailed recording of an employee's pay information for a specific pay period, including gross and net pay, taxes, deductions, and direct deposit allocations. it should be used when processing payroll to maintain accurate financial records for each employee. the endpoint captures both current pay period data and year-to-date totals, providing a comprehensive view of an employee's earnings and deductions. it's particularly useful for integrating external payroll systems with bamboohr, ensuring that hr records are synchronized with actual payroll data. note that this endpoint does not process actual payments; it only records the pay stub information in the bamboohr system.
</Accordion>

<Accordion title="Delete hour entries by ids">
  Deletes multiple time tracking hour entries from the bamboohr system. this endpoint allows for bulk removal of hour entries, which is useful for correcting errors, removing duplicate entries, or cleaning up historical time tracking data. it should be used when you need to permanently remove specific hour entries from an employee's time tracking record. be cautious when using this endpoint, as deleted entries cannot be recovered. this tool does not provide a way to retrieve or view the entries before deletion, so it's recommended to verify the entries to be deleted using other endpoints before calling this one.
</Accordion>

<Accordion title="Delete clock entries via ids">
  Deletes multiple clock entries from the bamboohr time tracking system. this endpoint allows administrators or authorized users to remove specific time clock entries identified by their unique ids. it should be used when there's a need to correct errors, remove duplicate entries, or manage outdated records in bulk. the endpoint processes the deletion of all specified entries in a single request, improving efficiency for large-scale time tracking data management. however, it's important to note that this action is irreversible, and deleted clock entries cannot be recovered through the api.
</Accordion>

<Accordion title="Delete employee training record">
  Deletes a specific employee training record from the bamboohr system. this endpoint is used to permanently remove a training record associated with an employee, such as completed courses, certifications, or professional development activities. it should be used when a training record needs to be removed due to errors, duplications, or when it's no longer relevant. caution should be exercised when using this endpoint, as the deletion is irreversible and may affect reporting or compliance tracking. ensure proper authorization and verification before deleting any records.
</Accordion>

<Accordion title="Delete webhook by id">
  The deletewebhook endpoint is used to remove a specific webhook from the bamboohr system. this operation permanently deletes the webhook configuration, stopping any further notifications for the events it was set up to monitor. use this endpoint when you need to discontinue a particular integration or clean up unused webhooks to maintain an organized webhook structure. it's important to note that this action cannot be undone, so it should be used with caution. the endpoint requires the company's domain and the unique identifier of the webhook to ensure precise targeting of the webhook to be deleted.
</Accordion>

<Accordion title="Delete training category">
  Deletes a specific training category from the bamboohr system for a given company. this endpoint should be used when you need to remove an obsolete or incorrect training category from the company's hr records. it permanently removes the category and all associated data, so it should be used with caution. the operation cannot be undone, and any training records linked to this category may be affected. ensure you have the necessary permissions and have verified the category id before deletion.
</Accordion>

<Accordion title="Delete employee goal">
  This endpoint deletes a specific goal associated with an employee in the bamboohr performance management system. it should be used when a goal is no longer relevant, has been completed, or needs to be removed from an employee's record. the operation is permanent and cannot be undone, so it should be used with caution. this endpoint is particularly useful for maintaining up-to-date and relevant goal records, especially during performance review cycles or when organizational objectives change. it does not return any data upon successful deletion, and it's important to note that it will not affect any historical performance data or completed goal achievements that may be associated with the deleted goal.
</Accordion>

<Accordion title="Delete training type by id">
  Deletes a specific training type from the bamboohr system. this endpoint is used to permanently remove a training category that is no longer needed or was created in error. it should be used with caution as the deletion is irreversible and may affect related training records. the endpoint requires the company's bamboohr subdomain and the unique identifier of the training type to be deleted. it's important to note that this action might have cascading effects on employees' training records or reports that reference the deleted training type.
</Accordion>

<Accordion title="Store hour entries">
  This endpoint allows you to store or update multiple time tracking hour entries for employees in bamboohr. it's designed for bulk creation or modification of timesheet entries, enabling efficient management of employee work hours, project time allocation, and task tracking. use this endpoint when you need to submit time entries for one or more employees, associate work hours with specific projects or tasks, or update existing time entries. the endpoint is particularly useful for integrating external time tracking systems with bamboohr or for automating the process of time entry submission. note that while you can create multiple entries in a single request, each entry must contain the required fields (employeeid, date, and hours) to be valid. optional fields allow for more detailed time tracking and management capabilities.
</Accordion>

<Accordion title="Create new employee">
  Creates a new employee record in the bamboohr system. this endpoint allows you to add a new employee to your company's hr database by providing essential information such as first name and last name. it's typically used when onboarding new hires or adding existing employees to the bamboohr system for the first time. the endpoint supports additional properties beyond the required fields, allowing for flexible and comprehensive employee data entry. however, it's important to note that this endpoint only initiates the employee record and may not include all possible employee information fields available in bamboohr.
</Accordion>

<Accordion title="Post employee clock in data">
  This endpoint allows an employee to clock in and record their work start time in the bamboohr time tracking system. it captures essential information such as the start time, timezone, and optionally, the project and task being worked on, as well as the precise geolocation of the clock-in event. this tool should be used when an employee begins their work shift or returns from a break. it's particularly useful for businesses tracking remote work, field services, or requiring detailed time logs for project-based billing. the endpoint does not handle clock-out events directly; a separate call would be needed for that purpose.
</Accordion>

<Accordion title="Get changed employees by company domain">
  Retrieves a list of employees whose records have been changed in the bamboohr system for a specific company. this endpoint is useful for syncing employee data with external systems or for auditing purposes. it allows you to efficiently track updates to employee information without querying all employee records. the endpoint returns only the identifiers of changed employees, not the actual changes, so you may need to make additional api calls to fetch the updated details. use this endpoint regularly to keep your systems in sync with bamboohr data. note that the specific time range for changes and the format of the response are not provided in the given schema and may require additional parameters or documentation.
</Accordion>

<Accordion title="Calculate employee time off">
  Retrieves the time off calculator information for a specific employee in bamboohr. this endpoint is used to access details about an employee's time off balances, accruals, and other related metrics. it's particularly useful for hr managers or employees themselves to check current leave balances or plan future time off requests. the calculator may include information such as available vacation days, sick leave, or other types of time off specific to the company's policies. this endpoint should be used when there's a need to programmatically access up-to-date time off information for an individual employee, which can be helpful for integrating with other systems or generating reports. note that the exact details returned may vary based on the company's bamboohr configuration and time off policies.
</Accordion>

<Accordion title="Retrieve employee unpaid pay stubs by id">
  Retrieves the unpaid pay stubs for a specific employee within a company's bamboohr account. this endpoint is used to access detailed information about an employee's earnings that have not yet been paid out, which is crucial for payroll processing and financial record-keeping. it should be used when there's a need to review or verify an employee's pending compensation before the actual payment is made. the endpoint provides up-to-date information on unpaid wages, bonuses, or other forms of compensation, but does not include historical data for already paid stubs. it's particularly useful for payroll administrators, finance teams, or integrated payroll systems that need to ensure accurate and timely payment processing.
</Accordion>

<Accordion title="Retrieve meta tables for companydomain">
  Retrieves metadata information about the tables available in the bamboohr system for a specific company. this endpoint is essential for developers and integrators who need to understand the structure of the bamboohr data model. it provides details about the available tables, which can be used to plan data retrieval, reporting, and integration strategies. the metadata likely includes table names, field names, and potentially data types or other structural information. this tool should be used when initializing a new integration or when updates to the bamboohr system might have changed the data structure. it's particularly useful for dynamic integrations that need to adapt to changes in the bamboohr schema. note that this endpoint doesn't return the actual data within the tables, only their structural information.
</Accordion>

<Accordion title="Retrieve benefit group plan costs">
  Retrieves the costs associated with benefit group plans for a specific company in bamboohr. this endpoint provides detailed financial information about employee benefit plans, including premiums, contributions, and other related expenses. it is particularly useful for hr managers and finance teams who need to analyze and manage benefit costs across different employee groups. the endpoint should be used when you need to review or report on the current cost structure of your company's benefit plans. it does not modify any data and is intended for read-only operations. note that the response may not include historical cost data or future projections, focusing instead on current cost information.
</Accordion>

<Accordion title="Retrieve benefit plans by company domain">
  Retrieves a list of benefit plans available for the specified company in bamboohr. this endpoint allows you to fetch comprehensive information about the various employee benefit plans offered by the organization, such as health insurance, retirement plans, and other perks. it should be used when you need to review or analyze the benefit offerings for a specific company within bamboohr. the endpoint provides a snapshot of current benefit plans and does not include historical data or employee enrollment information. keep in mind that the level of detail in the response may vary depending on the company's configuration and data availability in bamboohr.
</Accordion>

<Accordion title="Retrieve benefit group plans">
  Retrieves a list of benefit group plans for a specified company in bamboohr. this endpoint is used to fetch information about the various benefit plans associated with different groups within the organization. it's particularly useful for hr administrators and benefits managers who need to review or manage the benefit offerings across the company. the endpoint returns details about each benefit group plan, which may include plan names, coverage types, eligibility criteria, and other relevant information. use this endpoint when you need a comprehensive overview of the benefit structure within the company or when preparing for benefits enrollment periods. note that the specific details returned may vary based on the company's configuration and the user's access permissions within bamboohr.
</Accordion>

<Accordion title="Monitor webhook fields">
  Retrieves a list of fields currently being monitored for webhook notifications in bamboohr. this endpoint is used to check which specific data points (such as employee information, time-off requests, or other hr-related activities) are set up for real-time notifications through webhooks. it's particularly useful for developers integrating their applications with bamboohr to understand what changes they can track. the endpoint doesn't modify any data; it only provides information about the current webhook monitoring configuration. note that this endpoint doesn't set up new monitored fields; it only reports on existing ones.
</Accordion>

<Accordion title="Get employee project assignments">
  Retrieves a list of projects assigned to a specific employee within a company's bamboohr account. this endpoint is part of the time tracking api and allows you to fetch project assignments for individual employees, which is essential for managing and tracking employee time across different projects. use this endpoint when you need to view or analyze an employee's project allocations, plan resource distribution, or generate reports on employee project involvement. the endpoint returns only current project assignments and does not provide historical data or future planned assignments. it's particularly useful for managers and hr professionals who need to oversee employee workloads and project distributions.
</Accordion>

<Accordion title="Post employee table row update">
  Updates a specific row in a custom table for an individual employee in bamboohr. this endpoint allows you to modify various aspects of an employee's record, such as their job information, location, or organizational details. it's particularly useful for keeping employee data current when there are changes in their role, department, or other key information. the endpoint should be used when there's a need to update specific fields in a custom table that's associated with an employee, rather than modifying their core profile. it's important to note that this endpoint updates existing data and doesn't create new entries. ensure that the table and employee id exist before making the call, as the endpoint doesn't provide validation for non-existent records.
</Accordion>

<Accordion title="Adjust time tracking hours">
  This endpoint allows you to adjust existing time tracking records in bamboohr. it is used to update the number of hours worked for a specific time entry, identified by its unique time tracking id. this tool is particularly useful for correcting errors in time logs, adjusting hours after the fact, or updating time records based on new information. the endpoint requires both the time tracking id and the new total hours worked, ensuring accurate and targeted updates to employee time records. it's important to note that this endpoint updates the total hours worked, not the difference from the original value.
</Accordion>

<Accordion title="Retrieve employee table by id">
  Retrieves specific table data for a given employee from a company's bamboohr instance. this endpoint allows you to access structured information about an employee, such as job details, employment status, or custom fields, depending on the specified table. it's particularly useful for integrations that need to pull specific categories of employee data for reporting, analysis, or synchronization with other systems. the endpoint requires the company's bamboohr domain, the employee's unique identifier, and the name of the table to be queried. note that the availability and content of tables may vary based on the company's bamboohr configuration.
</Accordion>

<Accordion title="Get webhooks for company domain">
  Retrieves a list of all webhooks configured for a specific company in bamboohr. this endpoint allows you to view the current webhook subscriptions, providing information about the events being monitored and the target urls where notifications are sent. use this endpoint when you need to audit existing webhooks, verify webhook configurations, or prepare for updating or deleting webhooks. it's particularly useful for maintaining and troubleshooting integrations that rely on real-time data from bamboohr. note that this endpoint only lists webhooks; it does not provide details about individual webhook events or allow for webhook creation or modification.
</Accordion>

<Accordion title="Retrieve benefit plan coverage data">
  Retrieves detailed information about benefit plan coverages for employees within a specific bamboohr company environment. this endpoint provides comprehensive data on various benefits and coverages offered by the company, such as health insurance, retirement plans, and other employee benefits. it should be used when you need to access or review the current benefit plans and coverage details for employees. the endpoint is particularly useful for hr administrators, benefits coordinators, or integration systems that need to synchronize benefit information with other platforms. note that this endpoint only provides read access to the benefit plan coverage data and cannot be used to modify or update this information.
</Accordion>

<Accordion title="Fetch employees changed for table">
  Retrieves information about changes made to a specific table in the bamboohr system for a given company. this endpoint is useful for tracking updates and modifications to employee data or other hr-related information stored in bamboohr. it allows you to monitor changes in a particular table, helping maintain data integrity and auditing purposes. use this endpoint when you need to review recent changes, sync data with external systems, or generate reports on data modifications within a specific bamboohr table. the endpoint requires specifying both the company domain and the target table name to fetch the relevant change data.
</Accordion>

<Accordion title="Get employee goal aggregate">
  Retrieves aggregated performance data for a specific employee's goal within the bamboohr system. this endpoint allows users to fetch consolidated information about a particular goal, providing insights into the employee's progress and performance related to that objective. it should be used when detailed aggregate data about a specific goal is needed, such as for performance reviews, goal tracking, or progress reporting. the endpoint focuses solely on individual goal data and does not provide company-wide or team-level aggregates. note that the specific aggregated metrics returned may vary based on the goal type and settings within your bamboohr environment.
</Accordion>

<Accordion title="Retrieve time tracking record by id">
  Retrieves a specific time tracking record from bamboohr based on the provided company domain and record id. this endpoint allows you to fetch detailed information about a single time entry, including the employee, date, hours worked, and any associated metadata. it's particularly useful for auditing time entries, generating reports, or displaying detailed time tracking information in custom interfaces. the endpoint should be used when you need to access or verify the details of a specific time tracking record. note that this endpoint only retrieves data and does not modify any existing records.
</Accordion>

<Accordion title="Retrieve goals for employee performance">
  Retrieves the performance goals for a specific employee within a company's bamboohr account. this endpoint allows you to fetch the current set of goals associated with an individual employee, which may include both active and completed goals. it's particularly useful for managers or hr professionals who need to review an employee's objectives, track progress, or prepare for performance discussions. the endpoint should be used when you need to access detailed goal information for a single employee, such as during performance reviews, goal-setting sessions, or when generating reports on employee performance. note that this endpoint only provides goal data and does not include other performance metrics or feedback. the response will likely include details such as goal descriptions, target dates, current status, and any associated notes or updates.
</Accordion>

<Accordion title="Retrieve time off types">
  Retrieves a list of available time off types for a specific company in bamboohr. this endpoint is used to fetch metadata about the various categories of time off that employees can request, such as vacation, sick leave, or personal days. it's particularly useful when setting up or managing time off policies, or when integrating time off requests with other systems. the endpoint provides essential information for creating time off requests or reporting on time off usage across the organization. note that this endpoint only returns the types of time off available and does not provide information about individual employee time off balances or requests.
</Accordion>

<Accordion title="Get time off requests">
  Retrieves a list of time off requests for a specific company in the bamboohr system. this endpoint allows hr administrators and authorized personnel to fetch and review all pending, approved, and denied time off requests across the organization. it's particularly useful for managing employee leave, tracking time off balances, and ensuring proper staffing levels. the endpoint should be used when you need a comprehensive view of all time off requests or when integrating bamboohr's time off management with other systems. note that this endpoint likely returns all time off requests without filtering, so additional processing may be required for specific date ranges or employee subsets.
</Accordion>

<Accordion title="Retrieve employee plan by id">
  Retrieves detailed information about a specific employee plan within a company's bamboohr system. this endpoint allows hr professionals and authorized personnel to access individual plan details, which may include benefits information, compensation arrangements, or other work-related agreements. it's particularly useful when reviewing or updating an employee's plan, during performance evaluations, or when making changes to employee benefits. the endpoint requires the company's unique domain identifier and the specific plan id to fetch the correct information. while it provides access to plan details, it does not allow modifications to the plan through this get request. for any changes or updates to the plan, a separate endpoint (likely a put or patch request) would be necessary.
</Accordion>

<Accordion title="Fetch time off policies">
  Retrieves metadata about time off policies for a specific company in the bamboohr system. this endpoint provides access to information about various types of time off policies configured for the company, such as vacation, sick leave, or personal time. it's useful for obtaining an overview of all available time off policies, their settings, and any associated rules or accrual information. the endpoint should be used when there's a need to review or audit the company's time off policy structure, or when integrating time off management with other systems. note that this endpoint only provides policy information and does not include individual employee time off balances or requests.
</Accordion>

<Accordion title="Update employee table row info">
  This endpoint updates a specific row in an employee's table within bamboohr. it modifies various aspects of employee information, such as job details or organizational assignment. use it to keep employee records current when changes occur in employment status, job role, or structure. specify company domain, employee id, table name, and row id. partial updates are supported.
</Accordion>

<Accordion title="Retrieve employee training record">
  Retrieves the training record for a specific employee within a bamboohr company account. this endpoint allows you to access detailed information about an employee's training history, including completed courses, certifications, and other relevant training data. it should be used when you need to review or report on an individual employee's training progress or compliance status. the endpoint does not provide aggregate training data for multiple employees or allow modifications to the training record. keep in mind that the response structure and specific fields returned may vary based on the company's bamboohr configuration and the employee's training history.
</Accordion>

<Accordion title="Fetch applications by company domain path">
  Retrieves a list of applications submitted through the bamboohr applicant tracking system (ats). this endpoint allows hr personnel and recruiters to access and review all job applications in a centralized manner. it's particularly useful for managing the hiring process, tracking candidate progress, and generating reports on recruitment activities. the endpoint returns detailed information about each application, which may include applicant details, applied position, application date, and current status. use this endpoint when you need to fetch application data for review, analysis, or integration with other hr systems. note that the response may be paginated for large datasets, and additional parameters for filtering or sorting may be available but are not specified in the given schema.
</Accordion>

<Accordion title="Retrieve employee goal filters">
  Retrieves the available filters for an employee's performance goals in bamboohr. this endpoint is used to fetch a list of filter options that can be applied when querying or managing an employee's goals within the performance management system. it provides the necessary parameters to narrow down goal-related data, such as by goal type, status, or time frame. this tool is particularly useful when preparing to search or analyze an employee's goals, as it allows you to understand the available filtering options before making more specific goal-related api calls.
</Accordion>

<Accordion title="Retrieve employee project assignments">
  Retrieves a list of time tracking projects assigned to a specific employee within a bamboohr company environment. this endpoint is used to fetch project data that an employee can log time against, supporting efficient time tracking and project management. it's particularly useful for integrations that need to display or process an employee's available projects for time entry. the endpoint should be called when initializing time entry interfaces or updating project lists for a given employee. note that this endpoint only provides project information and does not include actual time entries or project details beyond what's necessary for time tracking purposes.
</Accordion>

<Accordion title="Retrieve employee goal comments">
  Retrieves comments associated with a specific goal for a particular employee within a company's bamboohr environment. this endpoint is useful for tracking feedback, progress updates, and discussions related to employee performance goals. it provides valuable insights into the ongoing communication and evaluation process surrounding individual employee objectives. the tool should be used when detailed information about goal-related comments is needed, such as during performance reviews, goal assessments, or when monitoring employee progress. it does not modify any data and is intended for read-only access to existing comments. note that this endpoint only returns comments for a single goal at a time and does not provide information about the goal itself or other aspects of employee performance.
</Accordion>

<Accordion title="List employee goals filters">
  Retrieves the available filters for an employee's performance goals in bamboohr. this endpoint is used to fetch a list of filters that can be applied when querying or managing an employee's goals. these filters may include criteria such as goal status, goal type, time frame, or other relevant categorizations specific to the company's performance management system. the retrieved filters can be used to refine subsequent api calls related to employee goals, allowing for more targeted and efficient data retrieval or updates. this endpoint is particularly useful when building interfaces or reports that require dynamic filtering options for employee goals.
</Accordion>

<Accordion title="Retrieve user meta information">
  Retrieves metadata about users within a specific company's bamboohr instance. this endpoint is useful for obtaining information about all users in the system, which can be valuable for user management, reporting, and integration purposes. it provides a comprehensive list of users and their associated metadata, allowing for efficient bulk retrieval of user information. this endpoint should be used when you need to gather data about multiple users simultaneously or when you require an up-to-date list of all users in the bamboohr system for a given company.
</Accordion>

<Accordion title="Retrieve employee time off policies">
  Retrieves the time off policies applicable to a specific employee within a bamboohr company. this endpoint allows you to fetch detailed information about the leave policies, including vacation days, sick leave, and other types of absences that are assigned to the employee. it's particularly useful for hr systems integration, leave management applications, or when you need to display an employee's available time off options. the endpoint returns policy details such as accrual rates, maximum balances, and any specific rules applied to the employee. use this when you need to understand an employee's time off entitlements or to synchronize leave policy data with external systems. note that this endpoint only provides policy information and does not include the employee's current leave balances or usage history.
</Accordion>

<Accordion title="Get employee time off policies">
  Retrieves the time-off policies applicable to a specific employee within a bamboohr company account. this endpoint allows you to fetch detailed information about the time-off rules, accrual rates, and other policy specifics for an individual employee. it's particularly useful for hr managers or systems that need to understand or display an employee's current time-off entitlements and rules. the endpoint should be used when you need to review or verify an employee's time-off policies, such as during leave requests or policy audits. it does not modify any data and is read-only. note that the response will only include policies relevant to the specified employee and may not provide a comprehensive list of all company-wide policies.
</Accordion>

<Accordion title="Reopen employee goal">
  Reopens a previously closed or completed goal for a specific employee in the bamboohr performance management system. this endpoint allows hr managers or authorized personnel to reactivate a goal that was marked as finished, enabling further updates or modifications to the goal. it's particularly useful when goals need to be revisited due to changing circumstances, ongoing projects, or as part of a continuous performance review process. the endpoint requires the company's domain, the employee's id, and the specific goal id to be reopened. use this endpoint when you need to make a closed goal active again for tracking and evaluation purposes.
</Accordion>

<Accordion title="Generate custom report for company">
  Creates a custom report in bamboohr with specified parameters. this endpoint allows users to generate tailored reports by defining a title, applying filters, and selecting specific data fields to include. it's particularly useful for extracting and analyzing employee data based on custom criteria. the report can include various employee attributes and can be filtered based on when the data was last changed. this tool should be used when detailed, customized employee data reports are needed, especially for data analysis, hr planning, or integration with other systems. note that the report generation might be asynchronous, and the actual report data may need to be retrieved separately.
</Accordion>

<Accordion title="Fetch hiring leads for applicant tracking">
  Retrieves a list of hiring leads from the bamboohr applicant tracking system (ats) for a specified company. this endpoint allows users to access information about individuals responsible for various aspects of the hiring process, such as recruiters, hiring managers, or interviewers. it should be used when you need to gather data on the personnel involved in recruitment activities within your organization. the endpoint provides an overview of hiring leads but may not include detailed information about ongoing recruitment processes or candidate data. note that the specific fields returned in the response are not detailed in the given schema and may vary based on the company's configuration and permissions.
</Accordion>

<Accordion title="Aggregate employee goals by id">
  Retrieves aggregated goal information for a specific employee within a company's bamboohr system. this endpoint provides a comprehensive overview of an employee's goals, including a list of all goals, goal type counts, and goal comment counts. it's particularly useful for managers or hr professionals who need a quick summary of an employee's performance objectives and progress. the tool should be used when a high-level view of an employee's goal-related activities is required, such as during performance reviews or goal-setting sessions. it does not provide detailed information about individual goals or allow for goal modifications.
</Accordion>

<Accordion title="Post clock entries for time tracking">
  The create clock entries endpoint allows you to add or update time tracking entries for employees in the bamboohr system. this endpoint is used to record work hours, including start and end times, for one or multiple employees in a single request. it's particularly useful for bulk time entry creation or for updating existing entries. the endpoint accepts a json payload containing an array of entry objects, each representing a single clock entry with details such as employee id, date, start and end times, and optional information like project and task associations. use this endpoint when you need to log employee work hours, update existing time entries, or associate work time with specific projects and tasks. it's important to note that this endpoint does not handle time-off requests or other types of absence management, which are typically handled by separate endpoints in the bamboohr api.
</Accordion>

<Accordion title="Upload employee photo by id">
  Updates the photo for a specific employee in the bamboohr system. this endpoint allows you to upload a new profile picture for an employee, enhancing their digital presence within the hr platform. it should be used when there's a need to refresh an employee's photo, such as after a company-wide headshot update or when onboarding a new employee. the endpoint accepts image data (not specified in the schema, but likely in the request body) and associates it with the given employee id. note that this endpoint only updates the photo and does not affect other employee profile information. ensure the image meets any size or format requirements specified by bamboohr to avoid upload issues.
</Accordion>

<Accordion title="Fetch training types by domain">
  Retrieves a list of training types configured in the company's bamboohr system. this endpoint allows developers to access and integrate training type information into their applications, supporting features such as employee development tracking, training program management, or reporting on learning initiatives. it's particularly useful when building custom dashboards, generating training-related reports, or synchronizing training data with other systems. the endpoint provides a comprehensive view of the training categories or classifications used within the organization but does not return detailed information about specific training sessions or employee participation.
</Accordion>

<Accordion title="Get webhook by id">
  Retrieves detailed information about a specific webhook registered in the bamboohr system. this endpoint allows you to fetch the configuration and settings of an existing webhook using its unique identifier. use this endpoint when you need to review or verify the details of a particular webhook, such as its target url, subscribed events, or current status. it's particularly useful for troubleshooting webhook-related issues or auditing your webhook configurations. the endpoint does not modify any webhook settings; it's a read-only operation.
</Accordion>

<Accordion title="Fetch application by id">
  Retrieves detailed information about a specific job application from bamboohr's applicant tracking system. this endpoint allows you to access comprehensive data related to a single application, including applicant details, application status, and any custom fields associated with the application process. it's particularly useful when you need to review or process individual applications, such as during candidate evaluation or interview scheduling. the endpoint provides a snapshot of the application at the time of the request, reflecting the most current information available in the system. note that this endpoint is read-only and does not allow modification of application data.
</Accordion>

<Accordion title="Fetch applicant tracking statuses">
  Retrieves a list of all applicant tracking statuses for a specific bamboohr company. this endpoint is useful for getting an overview of the different stages in your company's recruitment process. it can be used to populate dropdown menus in applicant tracking systems, generate reports on application statuses, or synchronize status information with other hr tools. the endpoint returns all available statuses, so there's no need for pagination or filtering parameters. note that this endpoint only provides status information and does not include details about individual applicants or job postings.
</Accordion>

<Accordion title="Fetch applicant tracking jobs">
  Retrieves a list of job postings from the company's applicant tracking system (ats) in bamboohr. this endpoint provides access to all active job listings for the specified company, including details such as job titles, descriptions, and current status. it's particularly useful for hr managers, recruiters, or integration systems that need to display or process the company's current job openings. the endpoint returns comprehensive job data, allowing for easy synchronization with external job boards or internal systems. note that this endpoint likely returns all active jobs without pagination, so it may not be suitable for companies with an extremely large number of open positions.
</Accordion>

<Accordion title="Post daily time tracking entries">
  The addorupdatedailytimeentries endpoint allows you to create new or update existing daily time entries for employees in the bamboohr time tracking system. it accepts an array of time entry objects, enabling bulk operations in a single request. this tool is ideal for efficiently managing multiple time entries, such as importing time data or updating entries after payroll review. it handles both adding new entries and updating existing ones based on the 'dailyentryid' parameter.
</Accordion>

<Accordion title="Get employee clock entries">
  Retrieves a specific clock entry for an employee from the bamboohr time tracking system. this endpoint allows you to fetch detailed information about a single clock-in or clock-out record, including timestamps and any associated metadata. use this when you need to review or verify a particular time entry for an employee, such as for payroll processing, attendance verification, or dispute resolution. the endpoint provides access to historical time tracking data, but it does not allow modification of existing entries or creation of new ones. note that the accessibility of clock entries may be subject to company-specific permissions and retention policies.
</Accordion>

<Accordion title="Update employee table row by id">
  Updates a specific row in a table associated with an employee's record in bamboohr. this endpoint allows for modifying various attributes of an employee's data, such as job information, location, or other custom fields, depending on the table being updated. it's particularly useful for recording changes in an employee's status, position, or other job-related information over time. the endpoint should be used when there's a need to update existing information in an employee's record, rather than adding new entries. it's important to note that this endpoint updates an existing row and does not create new ones. the specific fields available for update may vary depending on the table being modified and your bamboohr configuration.
</Accordion>

<Accordion title="Update company file details">
  Updates an existing company file in bamboohr, allowing modifications to the file's metadata such as name, category, and employee sharing permissions. this endpoint is used when you need to change details of a file already uploaded to the bamboohr system, without replacing the file content itself. it's particularly useful for reorganizing files, updating file names for better clarity, or adjusting file visibility to employees. the endpoint doesn't support uploading new file content; it's strictly for updating file metadata. ensure you have the correct file id and company domain before making the request, as these are crucial for targeting the right file in the correct bamboohr instance.
</Accordion>

<Accordion title="Update employee dependent details">
  The updateemployeedependent endpoint allows you to modify the information of an existing employee dependent in the bamboohr system. this tool is used to update personal details, contact information, and other relevant data for an employee's dependent, such as a spouse, child, or other family member. it's particularly useful for maintaining accurate records for benefits administration, emergency contacts, and compliance purposes. the endpoint accepts a comprehensive set of fields, allowing for detailed updates to the dependent's profile. however, it's important to note that while many fields are provided, not all may be required for every update operation. use this endpoint when there are changes to a dependent's information or when correcting existing data in the system.
</Accordion>

<Accordion title="Retrieve webhook log by id">
  Retrieves the log entries for a specific webhook in a company's bamboohr instance. this endpoint is used to access the history of events triggered by the webhook, providing valuable information for monitoring and troubleshooting integrations. it's particularly useful for developers who need to verify that webhooks are functioning correctly or investigate any issues with event delivery. the log typically includes details such as timestamps, event types, and delivery statuses for each webhook trigger. this tool should be used when detailed information about a webhook's activity is required, but it does not provide real-time notifications or allow modification of the webhook itself.
</Accordion>

<Accordion title="Update employee information via id">
  Updates an employee's basic information in the bamboohr system. this endpoint allows you to modify an employee's first name and/or last name. it should be used when there's a need to correct or change an employee's name in the hr records, such as in cases of marriage, divorce, or legal name changes. the endpoint accepts partial updates, meaning you can update either the first name, last name, or both. any additional properties sent in the request will also be accepted due to the 'additionalproperties: true' setting, but their behavior is not specified in this schema. it's important to note that this endpoint only updates name information and should not be used for modifying other employee data such as contact details or job information.
</Accordion>

<Accordion title="Update employee goal">
  Updates an existing employee goal in the bamboohr system. this endpoint allows you to modify various aspects of an employee's goal, including its title, description, progress, alignment, sharing, and key dates. it's particularly useful for keeping goal information current as progress is made or when goal details need to be adjusted. the endpoint requires the company domain, employee id, and goal id to be specified in the url path. note that any non-required fields not provided in the request will overwrite existing data with null values, so include all relevant fields even if they haven't changed. use this endpoint when you need to update goal information, track progress, or modify goal sharing and alignment within your organization.
</Accordion>

<Accordion title="Aggregate employee goals">
  Retrieves aggregated performance goal data for a specific employee within a company's bamboohr system. this endpoint provides a comprehensive summary of an employee's goals, potentially including metrics such as goal completion rates, progress status, and overall performance against set objectives. it's particularly useful for managers and hr professionals who need a quick overview of an employee's goal-related performance without diving into individual goal details. the aggregated data can be valuable for performance reviews, goal-setting sessions, or generating reports on employee progress. note that this endpoint focuses on summarized data and may not provide granular details about each individual goal.
</Accordion>

<Accordion title="Retrieve applicant location data">
  Retrieves a list of locations associated with the applicant tracking system for a specific bamboohr company account. this endpoint is useful for obtaining information about the various locations or offices where job openings may be available or where applicants might be considered for placement. it can be used to populate location dropdown menus in job application forms or to filter job postings by location. the endpoint provides a comprehensive view of all locations configured in the company's applicant tracking system, which is particularly valuable for organizations with multiple office locations or those offering remote work options. note that this endpoint only returns location data and does not provide any information about specific job openings or applicants associated with these locations.
</Accordion>

<Accordion title="Update employee training record">
  The updateemployeetrainingrecord endpoint allows you to update an existing training record for a specific employee in the bamboohr system. this tool is used to modify details of a completed training, such as the completion date, cost, instructor information, duration, credits earned, and any additional notes. it's particularly useful for keeping employee training records up-to-date and accurate, which is crucial for maintaining compliance and tracking professional development. the endpoint requires the company domain and the unique identifier of the training record to be updated, ensuring that the correct record is modified for the right employee within the organization.
</Accordion>

<Accordion title="Update employee goal comment">
  Updates a specific comment on an employee's goal in bamboohr's performance management system. this endpoint allows you to modify existing feedback or progress updates associated with a particular goal for an employee. it's useful for correcting information, providing additional context, or updating the status of a goal. the endpoint requires the company domain, employee id, goal id, and comment id to precisely target the comment to be updated. the new comment content should be provided in the request body as a json string. this endpoint should be used when there's a need to revise or expand on previously provided goal-related feedback. it does not create new comments or modify the goal itself, only the specified comment.
</Accordion>

<Accordion title="Get employee project tasks">
  Retrieves a list of tasks assigned to a specific employee for a particular project within a company's bamboohr account. this endpoint is useful for managers or hr personnel who need to review an employee's project-specific workload or track progress on assigned tasks. it provides a detailed view of an individual's responsibilities within a given project context. the endpoint should be used when there's a need to assess employee engagement in projects, monitor task assignments, or gather data for performance reviews related to project contributions. it will not provide information about tasks from other projects or for other employees, focusing solely on the intersection of the specified employee and project.
</Accordion>

<Accordion title="Access training category">
  Retrieves all training categories for a specific company in bamboohr. this endpoint allows hr managers and administrators to access a comprehensive list of training categories set up within their organization's bamboohr instance. it's useful for getting an overview of the training structure, planning new training programs, or integrating training data with other systems. the endpoint returns all categories without filtering, making it ideal for populating dropdown menus or generating reports on the company's training taxonomy. note that this endpoint only provides category information and does not include details about specific training sessions or employee participation.
</Accordion>

<Accordion title="Check employee clockin status">
  Retrieves the current clock-in status for a specific employee within a company's bamboohr environment. this endpoint allows you to quickly determine whether an employee is currently clocked in or out, which is useful for real-time attendance tracking and management. it should be used when you need to check an employee's immediate work status, such as for timesheet verification or monitoring ongoing projects. the endpoint provides a simple boolean response, indicating only the current state, and does not offer historical data or clock-in/out times. this tool is particularly valuable for managers and hr professionals who need to monitor employee attendance or track time-sensitive tasks.
</Accordion>

<Accordion title="Update employee specific file">
  Updates an existing file associated with a specific employee in the bamboohr system. this endpoint allows you to modify file properties such as the name, category, and sharing status. use this when you need to rename a file, move it to a different category, or change its visibility to the employee. it's particularly useful for maintaining up-to-date and properly organized employee records. note that this endpoint doesn't allow you to change the actual content of the file; it only updates the file's metadata. to replace the file content, you would need to delete the existing file and upload a new one.
</Accordion>

<Accordion title="Update employee goal progress">
  Updates the progress of a specific employee's goal in bamboohr. this endpoint allows you to modify the completion status of a goal assigned to an employee, helping track performance and achievement. it's particularly useful for regular goal check-ins or when significant milestones are reached. the endpoint also considers goal sharing, as the description mentions that employee ids of those with whom the goal is shared are tracked. use this when you need to reflect the latest status of an employee's progress towards their set objectives. note that this endpoint only updates the progress and doesn't modify other aspects of the goal or provide additional goal details.
</Accordion>

<Accordion title="Share employee goal with others">
  Updates the list of employees with whom a specific performance goal is shared in bamboohr. this endpoint allows you to modify the visibility of an employee's goal by specifying which other employees should have access to it. it's useful for managing goal transparency and collaboration within the organization. the endpoint automatically includes all goal owners in the sharing list, so they don't need to be explicitly specified. use this when you need to change who can view or interact with a particular employee's performance goal.
</Accordion>

<Accordion title="Update training category">
  This endpoint allows you to update the name of an existing training category in bamboohr. it is used when you need to modify the label or classification of a group of training programs or courses within your organization. the endpoint requires the company domain and the specific training category id to identify which category to update. you should use this when reorganizing your training structure or correcting category names. note that this endpoint only updates the name of the category and does not affect the training items associated with it. ensure you have the necessary permissions to modify training categories before using this endpoint.
</Accordion>

<Accordion title="View company domain files">
  The viewfile endpoint allows you to retrieve and view employee files stored in the bamboohr system. this get request is used to access specific documents or files associated with employees within your company's bamboohr instance. it's particularly useful for retrieving important employee documents such as contracts, performance reviews, or any other files stored in the system. the endpoint requires the company's subdomain for identification and likely accepts additional query parameters (not specified in the schema) to identify the specific file to be viewed. use this endpoint when you need to access or display employee files directly through the api, enabling integration with document management systems or internal company portals.
</Accordion>

<Accordion title="Get whos out for company">
  Retrieves a list of employees who are currently out of office or on leave within your organization. this endpoint is part of bamboohr's time off management feature and provides real-time information about employee absences. use this endpoint to get an overview of current staff availability, which can be helpful for resource planning, scheduling, or maintaining an up-to-date company-wide calendar. the endpoint returns data for all types of absences, including vacation, sick leave, and other approved time-off categories. note that this endpoint only provides current "who's out" information and does not offer historical or future absence data.
</Accordion>

<Accordion title="Fetch report by company domain and id">
  Retrieves a specific report from the bamboohr system for a given company. this endpoint allows users to fetch pre-configured reports containing various hr-related data such as employee information, company statistics, or custom reports created within the bamboohr platform. it is particularly useful for extracting structured data for analysis, reporting, or integration with other systems. the endpoint should be used when specific report data is needed, rather than raw data queries. note that the availability and content of reports depend on the company's bamboohr configuration and permissions.
</Accordion>

<Accordion title="Update company benefit details">
  Updates an existing company benefit in the bamboohr system. this endpoint allows you to modify the details of a specific benefit offering, such as its name, type, dates, and various attributes. it's used when changes need to be made to an existing benefit, such as extending the coverage period, updating the benefit description, or adjusting reimbursement details. the endpoint requires the company domain and the benefit id to identify the specific benefit to be updated. at minimum, the update must include the benefit name, start date, and type, even if these values remain unchanged. this endpoint should not be used to create new benefits or to delete existing ones.
</Accordion>

<Accordion title="Upload file to company domain">
  This endpoint allows you to upload files to the bamboohr system for a specific company. it is used to add documents, such as employee records, contracts, or other hr-related files, to the company's bamboohr account. the endpoint should be used when you need to programmatically add new files to the system or update existing documents. it's important to note that this endpoint only handles the file upload process and does not provide functionality for retrieving or managing existing files. be aware that there may be limitations on file types and sizes that can be uploaded, although these are not specified in the given schema.
</Accordion>

<Accordion title="Update employee goal with milestones">
  This endpoint updates an existing employee goal with milestones in the bamboohr performance management system. it allows for comprehensive modification of goal details, including title, description, alignment, shared employees, due date, and associated milestones. the endpoint is particularly useful for adjusting goals as circumstances change or for adding more detailed tracking through milestones. it's important to note that any non-required field not provided in the request will overwrite existing data with a null value, potentially resulting in unintended data loss. this endpoint should be used carefully to ensure all necessary information is included in each update to maintain the integrity of the goal data.
</Accordion>

<Accordion title="Upload employee file">
  This endpoint allows you to upload a file to an employee's record in bamboohr. it's used when you need to attach documents such as contracts, certificates, or any other relevant files to a specific employee's profile. the endpoint accepts a file upload, likely through a multipart form data request, and associates it with the specified employee. this function is particularly useful for maintaining comprehensive employee records, ensuring all relevant documents are centralized and easily accessible within the bamboohr system. note that the file size and type limitations are not specified in the schema and may be subject to bamboohr's general file upload constraints.
</Accordion>

<Accordion title="Update training type by id">
  Updates an existing training type in the bamboohr system. this endpoint allows you to modify various attributes of a training type, including its name, description, frequency, category, and other properties. it's used when you need to change the details of an existing training program or adjust its settings. the endpoint requires the company domain and the specific training type id in the url path. it's important to note that while some fields are optional, the 'name' and 'required' fields must always be provided in the update request. this tool is particularly useful for hr managers and administrators who need to keep training information up-to-date or make changes to training requirements and settings.
</Accordion>

<Accordion title="Retrieve timesheets using company domain">
  Retrieves specific timesheet data from the bamboohr time tracking system. this endpoint allows you to fetch detailed information for one or multiple timesheets by providing their unique ids. it's particularly useful when you need to access time tracking records for specific employees or time periods. the endpoint should be used when you have the timesheet ids and require the associated time tracking data. it does not provide a way to search or filter timesheets; you must know the exact ids of the timesheets you want to retrieve. the response will include all available information for the requested timesheets, which can be used for reporting, payroll processing, or auditing purposes.
</Accordion>

<Accordion title="View employee files by id">
  This endpoint allows you to view a specific file associated with an employee in the bamboohr system. it retrieves the file's content and metadata, enabling you to access important employee documents such as contracts, performance reviews, or any other files stored in the employee's profile. use this endpoint when you need to fetch and display the contents of an employee's file, such as during employee reviews, audits, or when updating employee records. the endpoint is read-only and does not modify any data. note that while the endpoint doesn't explicitly specify which file to view, it's likely that an additional identifier for the specific file is required, either as part of the path or through a separate api call. also, be aware that access to employee files may be restricted based on user permissions within bamboohr.
</Accordion>

<Accordion title="Retrieve employee dependents by company domain">
  Retrieves a list of dependents for all employees in the company. this endpoint provides comprehensive information about employee dependents, which may include family members, beneficiaries, or other individuals associated with employees for hr purposes such as benefits administration or emergency contacts. it's particularly useful for generating reports, updating benefits information, or performing company-wide dependent audits. the endpoint returns data for all employees, so it should be used cautiously and in compliance with data privacy regulations. note that this endpoint does not support filtering or pagination, so it may return a large amount of data for companies with many employees and dependents.
</Accordion>

<Accordion title="Retrieve employee timesheet data">
  Retrieves a specific timesheet for a given employee within a bamboohr company environment. this endpoint allows you to fetch detailed time tracking information for a particular timesheet, identified by its unique id, associated with a specific employee. it's useful for reviewing an employee's work hours, verifying time entries, or gathering data for payroll processing. the endpoint should be used when you need to access or analyze individual timesheet data, rather than summary or aggregate time tracking information. note that this endpoint retrieves data for a single timesheet only; for bulk timesheet data or time tracking summaries, you may need to use different endpoints or make multiple calls.
</Accordion>

<Accordion title="Get employee daily entries">
  Retrieves a specific daily time tracking entry for an employee in bamboohr. this endpoint allows you to fetch detailed information about a single day's time tracking record, including clock-in and clock-out times, total hours worked, and any associated metadata. it's particularly useful when you need to review or verify an employee's time entry for a specific date. the endpoint requires the company domain, employee id, and the unique identifier of the daily entry to ensure accurate and secure data retrieval. use this endpoint when you need to access or display detailed time tracking information for auditing, payroll processing, or employee time management purposes.
</Accordion>

<Accordion title="Fetch employee photo by size">
  Retrieves an employee's photo from the bamboohr system in a specified size. this endpoint is used to fetch visual representations of employees, which can be useful for directories, profiles, or other hr-related applications that require employee images. the tool allows for flexibility in photo size, enabling developers to retrieve appropriately sized images for different use cases, such as thumbnails or full-size profile pictures. it should be used when an application needs to display or process an employee's photo. note that the availability and quality of photos depend on what has been uploaded to the bamboohr system for each employee.
</Accordion>

<Accordion title="Get benefit coverages by company domain">
  Retrieves the benefit coverages information for employees within a specific company in bamboohr. this endpoint allows hr administrators and authorized personnel to access detailed data about the various benefit plans and coverage options available to employees. it provides a comprehensive overview of the company's benefit offerings, which may include health insurance, dental plans, vision coverage, life insurance, and other employee benefits. use this endpoint when you need to review, audit, or report on the current benefit coverage landscape for the entire organization. the returned data can be useful for benefits administration, open enrollment planning, and ensuring compliance with company policies and regulations.
</Accordion>

<Accordion title="Update webhook for company domain">
  Updates an existing webhook configuration in bamboohr. this endpoint allows you to modify various aspects of a webhook, including the monitored fields, data to be sent, frequency of updates, and rate limiting. use this when you need to change the behavior of an existing webhook, such as adjusting which employee data changes trigger notifications or modifying the format and content of the webhook payload. the endpoint provides fine-grained control over webhook behavior, enabling real-time integration with other systems based on specific bamboohr events. note that updating a webhook requires careful consideration of the receiving system's capabilities and the potential impact on data flow between systems.
</Accordion>

<Accordion title="Retrieve file by id">
  Retrieves a specific employee file from the bamboohr system. this endpoint allows you to fetch individual documents or records associated with employees, such as contracts, performance reviews, or personal information forms. it should be used when you need to access or download a particular file for an employee. the endpoint requires the company's bamboohr subdomain and the unique file identifier to locate and retrieve the correct file. note that this endpoint only retrieves the file content; it does not provide metadata about the file or list multiple files. ensure you have the necessary permissions to access the requested file, as bamboohr's access controls may restrict file retrieval based on user roles.
</Accordion>

<Accordion title="Retrieve employee file by id">
  Retrieves a specific file associated with an employee from the bamboohr system. this endpoint allows you to access individual documents or files that have been uploaded to an employee's record, such as resumes, contracts, or performance reviews. it should be used when you need to fetch a particular file for viewing, downloading, or processing. the endpoint requires precise identification of the company, employee, and file, ensuring secure and accurate retrieval of sensitive hr documents. it's important to note that this endpoint only retrieves the file; it does not provide capabilities for uploading, modifying, or deleting files. access to files may be subject to user permissions within the bamboohr system.
</Accordion>

<Accordion title="Retrieve meta lists">
  Retrieves metadata about reference lists available in a company's bamboohr instance. this endpoint provides essential information about predefined lists used across various bamboohr operations, such as employee statuses, departments, or job titles. it's particularly useful for understanding the structure and available options within your bamboohr setup, which can be crucial for data integration, reporting, or building custom applications that interact with bamboohr data. the endpoint returns a comprehensive overview of all available lists, their purposes, and potentially their contents, allowing developers to efficiently work with standardized data sets within the bamboohr ecosystem. use this endpoint when you need to explore or validate the available options for fields that rely on predefined lists in your bamboohr instance.
</Accordion>

<Accordion title="Retrieve employee direct deposit account by id">
  Retrieves detailed information about a specific employee's direct deposit account within a bamboohr company instance. this endpoint is used to access sensitive financial information, such as bank account details and routing numbers, associated with an employee's payroll. it should be used when there's a need to view or verify an employee's direct deposit setup, such as during payroll processing or when an employee requests to confirm their banking information. the endpoint returns read-only data and does not allow modifications to the account information. it's important to note that this endpoint should only be accessed by authorized personnel with appropriate permissions due to the sensitive nature of the data involved.
</Accordion>

<Accordion title="Retrieve timesheet entries">
  Retrieves timesheet entries for a specific company in bamboohr. this endpoint is part of the time tracking feature and provides detailed information about employee time entries, including total hours worked, holiday and time off hours, clock in and out times, projects, tasks, and notes. it's primarily used for payroll processing, workforce management, and generating time-related reports. the endpoint should be used when you need to access comprehensive time tracking data for all employees or when preparing for payroll runs. it does not provide real-time clock-in/out status and may have limitations on the date range for which data can be retrieved in a single call.
</Accordion>

<Accordion title="Retrieve company benefits">
  Retrieves a comprehensive list of company-wide benefits offered by the organization as configured in bamboohr. this endpoint provides details about various benefit programs such as health insurance plans, retirement options, paid time off policies, and other perks available to employees. it's particularly useful for hr managers and system integrators who need to access or sync the company's benefit information across different platforms. the endpoint should be used when you need an overview of all benefits at the company level, rather than benefits assigned to specific employees. note that this endpoint does not provide individual employee enrollment information or personalized benefit details.
</Accordion>

<Accordion title="Retrieve all benefits deduction types">
  Retrieves a comprehensive list of all deduction types configured in the bamboohr system for a specific company. this endpoint is crucial for benefits administrators and payroll managers who need to review or audit the various deduction categories set up in their bamboohr instance. it provides a complete overview of all possible deductions that can be applied to employee paychecks, such as health insurance premiums, retirement contributions, or other benefits-related deductions. this tool should be used when a full inventory of deduction types is required, for example, during benefit enrollment periods, payroll reconciliation, or when updating company-wide benefit policies. note that this endpoint does not provide individual employee deduction information, but rather the types of deductions available in the system.
</Accordion>

<Accordion title="Retrieve company benefit by id">
  Retrieves detailed information about a specific company benefit offered by an organization using bamboohr. this endpoint allows hr administrators or integrated systems to fetch comprehensive data about a particular benefit, such as health insurance plans, retirement options, or other employee perks. it's useful for reviewing benefit details, verifying information, or displaying benefit specifics to employees. the endpoint requires the company's bamboohr subdomain and the unique identifier of the benefit, ensuring accurate and targeted data retrieval. note that this endpoint only provides information about the benefit itself and does not include employee enrollment data or personal information.
</Accordion>

<Accordion title="Fetch benefit groups">
  Retrieves a list of benefit groups for a specific company in bamboohr. this endpoint allows you to access information about the various benefit groups set up within your organization, which can be crucial for managing employee benefits and understanding the structure of your company's benefit offerings. it's particularly useful when you need to review or audit the benefit groups available to employees, or when integrating benefit information with other hr systems. the endpoint doesn't support creating, updating, or deleting benefit groups, nor does it allow for enrolling employees or changing benefit statuses. use this endpoint when you need a comprehensive overview of all benefit groups in your bamboohr instance.
</Accordion>

<Accordion title="Retrieve company benefit type">
  Retrieves a list of company benefit types available in the specified bamboohr company account. this endpoint allows hr administrators and integrated systems to fetch information about the various benefit categories or types that the company offers to its employees. it's useful for populating dropdown menus in benefits enrollment forms, generating reports on benefit offerings, or syncing benefit type data with other hr systems. the endpoint provides a comprehensive view of the benefit structure within the organization but does not include details about specific benefit plans or employee enrollments.
</Accordion>

<Accordion title="Retrieve employee dependent by id">
  Retrieves detailed information about a specific employee's dependent in bamboohr. this endpoint is used to fetch data such as the dependent's name, relationship to the employee, date of birth, and other relevant details stored in the system. it's particularly useful when you need to access or verify information about an employee's family members or other dependents for benefits administration, emergency contact updates, or other hr-related tasks. the endpoint requires both the company's unique domain and the specific dependent's id to locate and return the correct information.
</Accordion>

<Accordion title="Get employee by id">
  Retrieves detailed information for a specific employee within a company's bamboohr system. this endpoint allows you to fetch comprehensive employee data using the employee's unique identifier. it's particularly useful when you need to access or display individual employee records, update employee information, or verify employee details. the endpoint returns all available fields for the employee, which may include personal information, job details, compensation data, and custom fields configured for the company. use this endpoint when you need specific, up-to-date information about a single employee. note that the exact fields returned may vary based on the company's bamboohr configuration and the permissions of the authenticated user making the request.
</Accordion>

<Accordion title="Retrieve meta fields for domain">
  Retrieves metadata about available fields in the bamboohr api for a specific company. this endpoint provides essential information about the structure and attributes of employee data that can be accessed or manipulated through other api calls. it should be used when you need to understand the available fields, their data types, and any constraints or formatting requirements. this information is crucial for constructing accurate queries or updates to employee records. the endpoint does not return actual employee data; it only provides metadata about the fields themselves.
</Accordion>

<Accordion title="Fetch employee pay stub by id">
  Retrieves detailed pay stub information for a specific employee within a company's bamboohr system. this endpoint allows hr professionals or authorized personnel to access an individual employee's pay details, including earnings, deductions, and net pay for a particular pay period. it's particularly useful for payroll verification, addressing employee inquiries about their compensation, or generating reports. the endpoint should be used when specific, detailed pay information is needed for an individual employee. it does not provide aggregate payroll data or modify any information. note that access to this sensitive data is likely to be restricted to users with appropriate permissions within the bamboohr system.
</Accordion>

<Accordion title="Fetch employee withholding by id">
  Retrieves the withholding information for a specific employee within a company's bamboohr system. this endpoint allows hr professionals and authorized personnel to access tax withholding details, which are crucial for payroll processing and tax reporting. it provides up-to-date information on an employee's tax withholding status, including federal, state, and local tax elections. use this endpoint when you need to review or verify an employee's current withholding information, such as during payroll runs, annual reviews, or when an employee requests changes to their withholding. the endpoint returns only the most recent withholding data and does not provide historical information or the ability to modify withholding details.
</Accordion>

<Accordion title="Get payroll deductions by id">
  Retrieves detailed information about a specific payroll deduction by its id for a given company in bamboohr. this endpoint allows hr administrators and payroll managers to access comprehensive data about individual deductions, such as type, amount, frequency, and associated employee information. it's particularly useful when reviewing or auditing payroll deductions, preparing reports, or addressing employee inquiries about specific deductions. the endpoint provides up-to-date information but does not allow modifications to the deduction data.
</Accordion>

<Accordion title="Retrieve employee deduction details">
  Retrieves detailed information about a specific employee deduction within a bamboohr company account. this endpoint allows hr professionals and authorized personnel to access individual deduction records, which may include details such as the deduction type, amount, frequency, and associated employee. it's particularly useful for verifying deduction details, auditing payroll information, or gathering data for financial reporting. the endpoint should be used when specific deduction information is needed, rather than for bulk data retrieval. note that this endpoint provides read-only access to deduction data and cannot be used to modify existing deductions or create new ones.
</Accordion>

<Accordion title="List benefit group employees">
  Retrieves a list of employees associated with benefit groups within a specific bamboohr company instance. this endpoint is useful for hr administrators and systems integrators who need to access or audit employee benefit group assignments. it provides a comprehensive view of how employees are categorized for benefits purposes, which can be essential for managing enrollment periods, analyzing benefit distribution, or synchronizing data with other hr systems. the endpoint should be used when you need an up-to-date snapshot of benefit group memberships across the organization. note that this endpoint only provides read access and cannot be used to modify benefit group assignments. the returned data may include employee ids, names, and their associated benefit group information, but the exact structure of the response should be verified in the api documentation.
</Accordion>

<Accordion title="Fetch employee directory">
  Retrieves the employee directory for a specified bamboohr company. this endpoint provides a list of employees within the company, including basic information such as names, job titles, and departments. it's useful for getting an overview of the company's workforce or for integrating employee data into other systems. the endpoint should be used when you need a comprehensive list of employees, but it may not include detailed information about each employee. for more specific or detailed employee data, consider using custom reports or individual employee endpoints instead. keep in mind that the amount and type of information returned may depend on the user's permissions within the bamboohr system.
</Accordion>

<Accordion title="Retrieve employee benefit filters">
  Retrieves employee benefit information based on specified filters. this endpoint allows hr professionals and benefit administrators to query and access employee benefit data using various criteria such as employee id, company benefit plan id, or enrollment status effective date. it is particularly useful for tasks like auditing benefit enrollments, managing open enrollment periods, or generating reports on benefit plan participation. the endpoint requires at least one filter to be specified and can combine multiple filters for more precise queries. it should be used when specific employee benefit information is needed, rather than for bulk data retrieval. note that this endpoint only provides filter-based access to benefit data and does not support creating, updating, or deleting benefit information.
</Accordion>

<Accordion title="Aggregate employee goals">
  Retrieves aggregated information about an employee's goals within the bamboohr performance management system. this endpoint provides a summary of goal-related data for a specific employee, which may include metrics such as goal completion rates, progress status, or overall performance indicators. it's particularly useful for managers or hr professionals who need a quick overview of an employee's goal achievement without delving into individual goal details. the aggregated data can be valuable for performance reviews, progress tracking, or identifying areas where an employee may need additional support or recognition. note that this endpoint focuses on summarized data and may not provide exhaustive details about each individual goal.
</Accordion>

<Accordion title="Post company login">
  Authenticates a user with the bamboohr system, initiating a session for subsequent api calls. this endpoint should be used as the first step when integrating with the bamboohr api, allowing access to protected resources and user-specific data. it requires the application key, user credentials, and is specific to each company's domain. the login process is essential for maintaining security and tracking user actions within the bamboohr system. note that this endpoint does not provide any hr data directly; it only establishes authentication for further api usage.
</Accordion>


# Bannerbear
Source: https://docs.push.ai/integrations/bannerbear



Bannerbear offers an automated image and video generation API, allowing businesses to create graphics, social media visuals, and marketing collateral with customizable templates at scale

<Accordion title="Join PDFs">
  This tool allows users to merge multiple pdf files into a single pdf document by accepting an array of pdf urls, sending a post request to the bannerbear api, and returning the unique identifier, status, and url of the merged pdf.
</Accordion>

<Accordion title="Get Available Fonts">
  This tool retrieves a list of all available fonts in bannerbear. the fonts are categorized into serif, sans serif, novelty, international, and custom, and can be used to verify font availability prior to creating or modifying images.
</Accordion>

<Accordion title="Get Signed Bases">
  This tool retrieves a list of signed bases for a specific template. signed bases are used to generate on-demand images using encrypted url parameters. the endpoint returns a list of base urls that can be used with the signed url feature.
</Accordion>

<Accordion title="Get Account Info">
  This tool allows you to check your bannerbear account status, including quota levels and current usage. the endpoint returns information about your account status, paid plan, api usage, and quota.
</Accordion>

<Accordion title="List Templates">
  This action retrieves a list of all templates available in your bannerbear project. it returns an array of template objects including properties like uid, name, dimensions, creation and update timestamps, template type, preview url, and modifications. the tool is used for listing templates, retrieving template uids for subsequent actions such as image or video creation, and managing project templates.
</Accordion>

<Accordion title="List Images">
  Lists all images inside a bannerbear project. this endpoint allows you to retrieve a paginated list of all images that have been created in your project.
</Accordion>

<Accordion title="Get Template Set Details">
  This tool retrieves detailed information about a specific template set using its unique identifier (uid). template sets are sets of templates that you group together in the bannerbear dashboard. it provides comprehensive details about the template set including its name, available modifications, and the list of templates inside the set.
</Accordion>

<Accordion title="List Videos">
  This action retrieves a list of all videos created in your bannerbear account. it returns an array of video objects including properties like uid, status, timestamps, video and preview urls, as well as template and modification details. the tool is used for listing videos, monitoring video status, and managing project videos.
</Accordion>


# Baserow
Source: https://docs.push.ai/integrations/baserow



Baserow is an open-source database tool that lets teams build no-code data applications, collaborate on records, and integrate with other services for data management

<Accordion title="List Tables in Database">
  This tool lists all tables within a specified baserow database. it allows users to retrieve information about all tables in a database by using the get /api/database/\{database id}/tables/ endpoint. the expected output is an array of table objects containing details such as id, name, order, database id, type, and first row header.
</Accordion>

<Accordion title="List Databases">
  This tool retrieves a list of all databases in a specified workspace. as a fundamental operation, it allows users to discover which databases are available in their baserow workspace. this operation is independent and requires only authentication in order to fetch essential metadata for subsequent operations.
</Accordion>


# Bill
Source: https://docs.push.ai/integrations/bill



Integration with Bill.com API

<Accordion title="Create an employee">
  Create a new employee.
</Accordion>

<Accordion title="Archive a vendor">
  Archive an existing vendor. in the response, the `archived` field is set as `true`. you can restore an archived vendor with `post /v3/vendors/\{vendorid\}/restore`. there is no change when you archive an archived vendor.
</Accordion>

<Accordion title="Api login as user">
  The loginasuser endpoint allows partners to authenticate and log in as a specific user within a designated organization in the bill system. this powerful feature enables partners to access and interact with an organization's account on behalf of a particular user, facilitating seamless integration and support. it should be used when a partner needs to perform actions or access information as if they were the specified user within the organization. this endpoint requires careful use and proper authorization, as it effectively allows impersonation of a user. while it supports mfa for enhanced security, partners should ensure they have explicit permission from the organization and user before utilizing this functionality.
</Accordion>

<Accordion title="Check app health">
  Retrieve app details, such as version and deployment location.
</Accordion>

<Accordion title="Create an accounting class">
  Create a new accounting class.
</Accordion>

<Accordion title="Archive a user">
  Archive an existing user. in the response, the `archived` field is set as `true`." you can restore an archived user with `post /v3/users/\{userid\}/restore`. there is no change when you archive an archived user.
</Accordion>

<Accordion title="Archive an item">
  Archive an existing item. in the response, the `archived` field is set as `true`.
</Accordion>

<Accordion title="Create a chart of accounts">
  Create a new chart of accounts.
</Accordion>

<Accordion title="Create a bulk payment">
  This endpoint allows you to create and process multiple bill payments in a single api call. it streamlines the payment process for businesses by enabling batch processing of payments to one or multiple vendors. the endpoint supports various funding sources, including bank accounts, credit/debit cards, bill balance (wallet), and ap cards. it offers flexibility in payment scheduling, delivery methods, and transaction tracking. use this endpoint when you need to efficiently manage and execute multiple payments simultaneously, reducing the number of individual api calls and simplifying your payment workflows. note that certain parameters may be required based on the chosen funding source, and there are specific rules for vendor and bill identification that must be followed.
</Accordion>

<Accordion title="Create a customer">
  Create a new customer. see [customers](doc:ar-customers) in the guides section for more information, sample requests, and responses.
</Accordion>

<Accordion title="Delete a budget">
  Delete an existing budget.
</Accordion>

<Accordion title="Create custom field values">
  Create new custom field values.
</Accordion>

<Accordion title="Create an image upload url for a reimbursement">
  Create an image upload url that can be used to upload receipts for reimbursements.
</Accordion>

<Accordion title="Create a user">
  Create a new user. the currently signed-in user must have the `administrator` user role in the bill organization to perform this operation. see [organizations and users](doc:organizations-users) in the guides section for more information, sample requests, and responses.
</Accordion>

<Accordion title="Delete a card">
  Delete an existing card.
</Accordion>

<Accordion title="Create a reimbursement">
  Create a reimbursement
</Accordion>

<Accordion title="Delete a custom field">
  Delete a custom field.
</Accordion>

<Accordion title="Delete custom field values">
  Delete custom fields. values cannot be assigned to current or future transactions. the values will remain assigned to past transactions.
</Accordion>

<Accordion title="Delete a member from a budget">
  Delete a member from a budget
</Accordion>

<Accordion title="Delete customer connection">
  Delete an existing network connection with a customer. in addition, use this endpoint to cancel a pending customer connection invite. you can send a new connection invitation after an existing connection or invitation is canceled. **note**: if the invited customer does not respond to an invitation for 60 days, the invitation expires. see [bill network](doc:bill-network) in the guides section for more information, sample requests, and responses.
</Accordion>

<Accordion title="Delete a vendor bank account">
  Delete the existing vendor bank account for a vendor. to update vendor bank account information, you must first delete the existing vendor bank account (with `delete /v3/vendors/\{vendorid\}/bank-account`), and then create a new vendor bank account (with `post /v3/vendors/\{vendorid\}/bank-account`) with the updated information.
</Accordion>

<Accordion title="Delete a reimbursement">
  Delete a specified reimbursement.
</Accordion>

<Accordion title="Create a recurring bill">
  Create a recurring bill. see [recurring bills](doc:ap-recurring-bills) in the guides section for more information, sample requests, and responses.
</Accordion>

<Accordion title="Delete vendor connection">
  Delete an existing network connection with a vendor. in addition, use this endpoint to cancel a pending vendor connection invite. you can send a new connection invitation after an existing connection or invitation is canceled. **note**: if the invited vendor does not respond to an invitation for 60 days, the invitation expires. see [bill network](doc:bill-network) in the guides section for more information, sample requests, and responses.
</Accordion>

<Accordion title="Delete a user">
  Delete an existing user.
</Accordion>

<Accordion title="Get a single member for a budget">
  Get a single member for a budget
</Accordion>

<Accordion title="Get accounting class details">
  Get details about an existing accounting class.
</Accordion>

<Accordion title="Get api session details">
  Get details about your current api session. this includes information about the current organization id, user id, and mfa status of the organization.
</Accordion>

<Accordion title="Get attachment details">
  Get details about an attachment. from the response, use `downloadlink` in a get request to download the attachment. `curl '{downloadlink}&sessionid={session id}' --output {attachment name}`
</Accordion>

<Accordion title="Generate mfa challenge">
  Generates a multi-factor authentication (mfa) challenge for enhanced security in the bill api. this endpoint initiates the mfa process by creating a challenge that the user must respond to with their authentication token. it provides the option to use either the primary or a backup mfa device for generating the challenge. this tool should be used when implementing mfa flows in your application, particularly before sensitive operations like accessing billing information or making payments. the generated challenge is typically time-sensitive and should be responded to promptly for successful authentication.
</Accordion>

<Accordion title="Get audit trail details for a vendor">
  Get audit trail details about changes made to a vendor object. the audit trail lists records for each create and edit operation. see [getting audit trail details](doc:getting-audit-trail-details) in the guides section for more information, sample requests, and responses.
</Accordion>

<Accordion title="Create a vendor">
  Creates a new vendor in the bill.com system with comprehensive details for invoicing and payment processing. this endpoint allows you to set up a vendor's basic information, address, payment preferences, tax details, and auto-pay settings. it's particularly useful when onboarding new suppliers or updating existing vendor information en masse. the endpoint requires at minimum the vendor's name and address, but allows for extensive customization of payment terms, currencies, and automated payment rules. note that enabling auto-pay features requires additional authentication through mfa. use this endpoint when you need to add new vendors to your bill.com account or update existing vendors with new information.
</Accordion>

<Accordion title="Accept network invitation">
  Accept a network invitation that was sent to the organization by a vendor or customer. when the invitation is accepted, the organization is connected with the vendor or customer in the bill network. see [bill network](doc:bill-network) in the guides section for more information, sample requests, and responses.
</Accordion>

<Accordion title="Get bank account details">
  Get details about an existing bank account.
</Accordion>

<Accordion title="Api partner login">
  Authenticates a partner user and initiates a session with the bill api. this endpoint should be used at the beginning of any integration session to obtain necessary authentication tokens or session identifiers. it verifies the partner's credentials and grants access to other api endpoints. the login process is a prerequisite for accessing any protected resources or performing operations within the bill system. note that this endpoint does not provide any financial or account information directly; it only establishes an authenticated session.
</Accordion>

<Accordion title="Get chart of accounts details">
  Get details about an existing chart of accounts.
</Accordion>

<Accordion title="Get card funding purpose">
  Get a list of card funding purpose values based on the vendor and card brand. when you create a payment (`post /v3/payments` or `post /v3/payments/bulk`) with a `card account` funding account `type`, bill requires a vendor industry value for compliance. when bill cannot identify the vendor industry, the `cardfundingpurpose` field must be set in your payment request. use this endpoint to get the list of card funding purpose values you can set. if you get an empty 200 response, bill has information about the vendor industry and setting the `cardfundingpurpose` field is not required in your payment request.
</Accordion>

<Accordion title="Api logout">
  Sign out of your bill developer account. in response, the current `sessionid` expires and your api session is terminated. you will be required to sign in again with `/v3/login` before you can make another api call.
</Accordion>

<Accordion title="Add phone for mfa setup">
  Sets up multi-factor authentication (mfa) for a user account in the bill api. this endpoint allows users to configure their preferred method of receiving authentication tokens, enhancing account security. it should be used when a user wants to enable mfa or update their existing mfa settings. the setup process requires providing a phone number, selecting between voice calls or text messages for token delivery, and specifying if it's a primary or backup device. this endpoint is crucial for implementing a robust security layer but does not handle the actual authentication process or token validation.
</Accordion>

<Accordion title="Get check image data">
  Get images of an existing check sent to a vendor. from the response, use `downloadlink` in a get request to download the front and back images of the check. `curl '{downloadlink}&sessionid={session id}' --output {check name}`
</Accordion>

<Accordion title="Get card account details">
  Get details about an existing card account.
</Accordion>

<Accordion title="Add phone for risk verification">
  Add a phone number for the currently signed-in user. bill requires the signed-in user to have a linked phone number for initiating risk verification for the organization. you can check whether a phone number has been added for the user with `get /v3/risk-verifications/phone`. after you add a phone number with this endpoint, you can initiate risk verification for the organization with `post /v3/risk-verifications`.
</Accordion>

<Accordion title="Get card details">
  Get details about an existing card.
</Accordion>

<Accordion title="Get customer invitation status">
  Get the status of an existing invitation sent with `post /v3/network/invitation/customer/\{customerid\}`. when the customer accepts the invitation, your organization is connected with the customer. **note**: if the invited customer does not respond to an invitation for 60 days, the invitation expires. see [bill network](doc:bill-network) in the guides section for more information, sample requests, and responses.
</Accordion>

<Accordion title="Get customer details">
  Get details about an existing customer.
</Accordion>

<Accordion title="Get bill details">
  Get details about an existing bill.
</Accordion>

<Accordion title="Api login">
  Sign in to your bill developer account. in the response, your api session is created and a bill-generated `sessionid` is available. use the `sessionid` in all subsequent api calls to confirm that you are in a signed-in session. to create an mfa-trusted api session, set `remembermeid` and `device` in addition to the required fields. see [mfa setup](ref:setup) for information about the bill mfa process. you can sign out with `post /v3/logout`. if your api session is inactive for 35 minutes, the session expires and you are automatically signed out. see [api partner login](ref:partnerlogin) for information about the additional permissions you get with the api partner login. **note**: this section is about authentication for working with the bill v3 api. see [authentication with spend & expense api token](doc:authentication-with-api-token) for information about authentication for the spend & expense api endpoints.
</Accordion>

<Accordion title="Create a vendor bank account">
  Create a vendor bank account for an existing vendor. to update vendor bank account information, you must first delete the existing vendor bank account (with `delete /v3/vendors/\{vendorid\}/bank-account`), and then create a new vendor bank account (with `post /v3/vendors/\{vendorid\}/bank-account`) with the updated information. **note**: when you add vendor bank account information, bill requires 2 business days to complete a one-time verification of the bank account. payments sent to the vendor are processed after the one-time verification is complete. see [get list of vendor payment options](ref:listpaymentoptions) to get details about vendor payment options and payment process dates.
</Accordion>

<Accordion title="Get custom field details">
  Get details about a custom field.
</Accordion>

<Accordion title="Get department details">
  Get details about an existing department.
</Accordion>

<Accordion title="Get budget details">
  Get details about an existing budget.
</Accordion>

<Accordion title="Get employee details">
  Get details about an existing employee.
</Accordion>

<Accordion title="Create a vendor card">
  Create a new vendor card.
</Accordion>

<Accordion title="Get document upload status">
  Get status of a document upload. use this endpoint to identify when a document upload is complete. \* at the start of the document upload process (`in progress`), bill generates an `uploadid` for the document. the value begins with `0du`. \* when the document upload is complete (`uploaded`), bill generates a `documentid` for the document. the value begins with `00h`.
</Accordion>

<Accordion title="Archive a customer">
  Archive an existing customer. in the response, the `archived` field is set as `true`. you can restore an archived customer with `post /v3/customers/\{customerid\}/restore`. there is no change when you archive an archived customer.
</Accordion>

<Accordion title="Get custom field value">
  Get details about a custom fields values.
</Accordion>

<Accordion title="Get document details">
  Get details about a document associated with a bill. from the response, use `downloadlink` in a get request to download the document. `curl '{downloadlink}&sessionid={session id}' --output {document name}`
</Accordion>

<Accordion title="Approve or deny a reimbursement">
  Approve or deny a reimbursement.
</Accordion>

<Accordion title="Archive a bank account user">
  Archive an existing bank account user. in the response, the `archived` field is set as `true` and the bank account user `verificationstatus` is set as `unverified`.
</Accordion>

<Accordion title="Archive an accounting class">
  Archive an existing accounting class. in the response, the `archived` field is set as `true`.
</Accordion>

<Accordion title="Archive a department">
  Archive an existing department. in the response, the `archived` field is set as `true`.
</Accordion>

<Accordion title="Create an item">
  Create a new item.
</Accordion>

<Accordion title="Create custom field">
  Create a new custom field.
</Accordion>

<Accordion title="Archive a bank account">
  Archive an existing bank account. in the response, the `archived` field is set as `true`. archiving a bank account at bill has a set of requirements. \* **bank account status**: the bank account `status` must be set as `verified`. you can verify the bank account with `post /v3/funding-accounts/banks/\{bankaccountid\}/verify`. \* **bank account user status**: the bank account user `verificationstatus` must be set as `verified`. to begin the verification process, nominate a bank account user with `post /v3/funding-accounts/banks/users`.
</Accordion>

<Accordion title="Archive multiple departments">
  Archive multiple departments with one api request. in the response, the `archived` field is set as `true`.
</Accordion>

<Accordion title="Archive multiple employees">
  Archive multiple employees with one api request. in the response, the `archived` field for each object is set as `true`.
</Accordion>

<Accordion title="Archive a bill">
  Archive an existing bill. in the response, the `archived` field is set as `true`. you can restore an archived bill with `post /v3/bills/\{billid\}/restore`. there is no change when you archive an archived bill.
</Accordion>

<Accordion title="Archive a job">
  Archive an existing job. in the response, the `archived` field is set as `true`.
</Accordion>

<Accordion title="Create a bank account">
  Create a new bank account. the currently signed-in user must have the `administrator` user role in the bill organization to perform this operation. bill sends an email notification for informing you about changes to your funding accounts. **note**: when you create a bank account, bill sends a test ach payment to the bank account to confirm whether the account details are accurate. in the response, three fields are set to their default values. \* the bank account `status` is set as `pending`. you can verify the bank account with `post /v3/funding-accounts/banks/\{bankaccountid\}/verify`. \* the `payables` and `receivables` values are set as `false`. to update these values, update the bank account with `patch /v3/funding-accounts/banks/\{bankaccountid\}`. see [bank account setup (v3 api)](doc:bank-account-setup-v3-api) in the guides section for more information, sample requests, and responses.
</Accordion>

<Accordion title="Archive a recurring bill">
  Archive a recurring bill. in the response, the `archived` field is set as `true`. you can restore an archived recurring bill with `post /v3/recurringbills/\{recurringbillid\}/restore`. there is no change when you archive an archived recurring bill. when a recurring bill is modified, all future bills are automatically changed.
</Accordion>

<Accordion title="Create a department">
  Create a new department.
</Accordion>

<Accordion title="Create a job">
  Create a new job.
</Accordion>

<Accordion title="Archive a location">
  Archive an existing location. in the response, the `archived` field is set as `true`.
</Accordion>

<Accordion title="Create an invoice">
  Create a new invoice. see [invoices](doc:ar-invoices) in the guides section for more information, sample requests, and responses.
</Accordion>

<Accordion title="Create a location">
  Create a new location.
</Accordion>

<Accordion title="Create a bill">
  Create a new bill. see [bills](doc:ap-bills) in the guides section for more information, sample requests, and responses.
</Accordion>

<Accordion title="Archive mutliple chart of accounts">
  Archive multiple chart of accounts with one api request. in the response, the `archived` field for each object is set as `true`.
</Accordion>

<Accordion title="Archive an invoice">
  Archive an existing invoice. in the response, the `archived` field is set as `true`. you can restore an archived invoice with `post /v3/invoices/\{invoiceid\}/restore`. there is no change when you archive an archived invoice.
</Accordion>

<Accordion title="Archive an employee">
  Archive an existing employee. in the response, the `archived` field is set as `true`.
</Accordion>

<Accordion title="Archive multiple locations">
  Archive multiple locations with one api request. in the response, the `archived` field for each object is set as `true`.
</Accordion>

<Accordion title="Archive multiple jobs">
  Archive multiple jobs with one api request. in the response, the `archived` field for each object is set as `true`.
</Accordion>

<Accordion title="Create an organization">
  Create a new organization. this operation requires partner-level permissions. \* a `sessionid` header value generated with [api partner login](ref:partnerlogin) \* an `appkey` header value see [organizations for bill partners](doc:partner-organizations) in the guides section for more information, sample requests, and responses.
</Accordion>

<Accordion title="Archive a chart of accounts">
  Archive an existing chart of accounts. in the response, the `archived` field is set as `true`.
</Accordion>

<Accordion title="Archive multiple items">
  Archive multiple items with one api request. in the response, the `archived` field for each object is set as `true`.
</Accordion>

<Accordion title="Create a budget">
  Create a new budget for a company.
</Accordion>

<Accordion title="Cancel a payment">
  Cancel an existing payment. you can attempt to cancel a payment with `post /v3/payments/\{paymentid\}/cancel` based on a set of conditions. see \<a href="[https://help.bill.com/hc/en-us/articles/115005898063"\&gt;payment](https://help.bill.com/hc/en-us/articles/115005898063"\&gt;payment) cancelation and void cut-off timing\</a> in the bill help center to learn about the bill cancel payment process and timing. if the conditions are not met, you cannot cancel the payment. at that point, you can attempt to void the payment with `post /v3/payments/\{paymentid\}/void`.
</Accordion>

<Accordion title="Create a payment">
  Create a payment. see [get list of vendor payment options](ref:listpaymentoptions) to get details about vendor payment options and payment process dates. **note**: creating a payment requires an mfa-trusted api session. see [mfa setup](ref:setup) for information about the bill mfa process. see [payments](doc:ap-payments) in the guides section for more information, sample requests, and responses.
</Accordion>

<Accordion title="Archive multiple accounting classes">
  Archive multiple accounting classes with one api request. in the response, the `archived` field for each object is set as `true`.
</Accordion>

<Accordion title="Get current user details">
  Get details about the current user.
</Accordion>

<Accordion title="Get funding account permissions">
  Get the funding account permissions available for the current organization and current organization user.
</Accordion>

<Accordion title="Get list of bank account users">
  Get a list of bank account user objects. in the response, if the bank account user `verificationstatus` is set as `nominated`, user verification must be completed before the user can pay with the specified bank account. by default, you get 20 results on one page of results. set `max` in your request to get up to 100 results on one page.
</Accordion>

<Accordion title="Get list of vendor payment options">
  Get a list of vendor payment options available based on the funding account options available in the signed-in user's bill organization and on the payment methods accepted by a vendor. see [vendor payment options](doc:vendor-payment-options) in the guides section for more information, sample requests, and responses.
</Accordion>

<Accordion title="Get invoice details">
  Get details about an existing invoice.
</Accordion>

<Accordion title="Get item details">
  Get details about an existing item.
</Accordion>

<Accordion title="Get location details">
  Get details about an existing location.
</Accordion>

<Accordion title="Get transaction custom field details">
  Get details about existing transaction custom fields
</Accordion>

<Accordion title="Get list of organization industries">
  Get a list of available values for the `industry` field for an organization. use this information to set the `industry` field in your `post /v3/partner/organizations` or `patch /v3/organizations/\{organizationid\}` request.
</Accordion>

<Accordion title="Get risk verification details">
  Get risk verification details for an existing organization.
</Accordion>

<Accordion title="Get list of employees">
  Get a list of employee objects. by default, you get 20 results on one page of results. set `max` in your request to get up to 100 results on one page. see [search operations with lists](doc:search-op-with-lists) in the guides section for filtering, sorting, and pagination examples.
</Accordion>

<Accordion title="Get list of organizations">
  Get a list of organization objects. by default, you get 20 results on one page of results. set `max` in your request to get up to 100 results on one page. see [search operations with lists](doc:search-op-with-lists) in the guides section for filtering, sorting, and pagination examples. this operation requires partner-level permissions. \* a `sessionid` header value generated with [api partner login](ref:partnerlogin) \* an `appkey` header value
</Accordion>

<Accordion title="Get international payments configuration">
  Get international payments (not usd) configuration that is required for compliance with international payment rules of a vendor country and vendor bank account. this information is based on vendor country, bill currency, and vendor account type. use this endpoint for getting information before creating an international vendor. in the response, the required `paymentpurpose` and `regulatoryfields` information is retrieved for the vendor. **note**: if you are adding `paymentpurpose` and `regulatoryfields` information after creating an international vendor, use `get /v3/vendors/\{vendorid\}/configuration` to get the required configuration for your created vendor. see [creating an international vendor](doc:creating-an-international-vendor) for more information on how to set `paymentpurpose` and `regulatoryfields`.
</Accordion>

<Accordion title="Get list of bills">
  Get a list of bill objects. by default, you get 20 results on one page of results. set `max` in your request to get up to 100 results on one page. see [search operations with lists](doc:search-op-with-lists) in the guides section for filtering, sorting, and pagination examples.
</Accordion>

<Accordion title="Get list of documents">
  Get a list of documents associated with a bill. from the response, use `downloadlink` in a get request to download the document. `curl '{downloadlink}&sessionid={session id}' --output {document name}`
</Accordion>

<Accordion title="Get list of vendor attachments">
  Get a list of attachments associated with a vendor. from the response, use `downloadlink` in a get request to download the attachment. `curl '{downloadlink}&sessionid={session id}' --output {attachment name}`
</Accordion>

<Accordion title="Get job details">
  Get details about an existing job.
</Accordion>

<Accordion title="Get vendor details">
  Get details about an existing vendor.
</Accordion>

<Accordion title="Get vendor invitation status">
  Get the status of an existing invitation sent with `post /v3/network/invitation/vendor/\{vendorid\}`. when the vendor accepts the invitation, your organization is connected with the vendor. **note**: if the invited vendor does not respond to an invitation for 60 days, the invitation expires. see [bill network](doc:bill-network) in the guides section for more information, sample requests, and responses.
</Accordion>

<Accordion title="Get list of recurring bills">
  Get a list of recurring bill objects. by default, you get 20 results on one page of results. set `max` in your request to get up to 100 results on one page. see [search operations with lists](doc:search-op-with-lists) in the guides section for filtering, sorting, and pagination examples.
</Accordion>

<Accordion title="Get list of payments">
  Get a list of payment objects. by default, you get 20 results on one page of results. set `max` in your request to get up to 100 results on one page. see [search operations with lists](doc:search-op-with-lists) in the guides section for filtering, sorting, and pagination examples.
</Accordion>

<Accordion title="Initiate risk verification for an organization">
  Initiate risk verification for an organization. the currently signed-in user must have the `administrator` user role in the bill organization to perform this operation. **note**: you must add a phone number for the signed-in user (with `post /v3/risk-verifications/phone`) before you can initiate risk verification. bill partners must add a phone number for a created user with `post /v3/partner/risk-verifications/\{userid\}/phone`. as a bill partner, when you create an organization and then create a user for that organization, it is important that you initiate risk verification with `post /v3/risk-verifications`. bill performs a kyc/kyb (know you customer/know your business) check based on the provided organization information. bill sends an email notification for risk verficiation. when the check is complete, bill approves the organization for bill ap and ar operations.
</Accordion>

<Accordion title="Get transaction custom field value details">
  Get details about an existing transaction custom field and values
</Accordion>

<Accordion title="Get list of invoices">
  Get a list of invoice objects. by default, you get 20 results on one page of results. set `max` in your request to get up to 100 results on one page. see [search operations with lists](doc:search-op-with-lists) in the guides section for filtering, sorting, and pagination examples.
</Accordion>

<Accordion title="Get organization details">
  Get details about an existing organization. the currently signed-in user must have the `administrator` user role in the bill organization to perform this operation. see [organizations and users](doc:organizations-users) in the guides section for more information, sample requests, and responses.
</Accordion>

<Accordion title="Invite a customer in the bill network">
  Send an invitation to connect a customer created in your organization with a customer in the network. bill sends an invitation email to the customer email address. when the customer accepts the invitation, the customer in your organization is connected with the invited customer. if the invited customer does not respond, delete the invitation (with `delete /v3/network/invitation/customer/\{customerid\}`) before sending a new invitation. **note**: if the invited customer does not respond to an invitation for 60 days, the invitation expires. see [bill network](doc:bill-network) in the guides section for more information, sample requests, and responses.
</Accordion>

<Accordion title="Restore an archived customer">
  Restore an archived customer. in the response, the `archived` field is set as `false`. you can perform any valid bill operation on restored customers. there is no change when you restore a restored customer.
</Accordion>

<Accordion title="Get transaction details">
  Get details about an existing transaction.
</Accordion>

<Accordion title="Invite a vendor in the bill network">
  Send an invitation to connect a vendor created in your organization with a vendor in the network. bill sends an invitation email to the vendor email address. when the vendor accepts the invitation, the vendor in your organization is connected with the invited vendor. if the invited vendor does not respond, delete the invitation (with `delete /v3/network/invitation/vendor/\{vendorid\}`) before sending a new invitation. **note**: if the invited vendor does not respond to an invitation for 60 days, the invitation expires. see [bill network](doc:bill-network) in the guides section for more information, sample requests, and responses.
</Accordion>

<Accordion title="Restore an archived bill">
  Restore an archived bill. in the response, the `archived` field is set as `false`. you can perform any valid bill operation on restored bills. there is no change when you restore a restored bill.
</Accordion>

<Accordion title="Restore an archived chart of accounts">
  Restore an archived chart of accounts. in the response, the `archived` field is set as `false`.
</Accordion>

<Accordion title="Get list of invoice attachments">
  Get a list of attachments associated with an invoice. from the response, use `downloadlink` in a get request to download the attachment. `curl '{downloadlink}&sessionid={session id}' --output {attachment name}`
</Accordion>

<Accordion title="Restore an archived accounting class">
  Restore an archived accounting class. in the response, the `archived` field is set as `false`.
</Accordion>

<Accordion title="Replace a recurring bill">
  Update the number of line items in a recurring bill. you can also update other recurring bill details. you can use the put operation to add, remove, or replace the number of line items in a recurring bill. a set of rules apply with the put operation. \* when you add a new line item, a new line item `id` is generated in the bill. \* when you omit an existing line item `id`, the line item is removed from the bill. when a recurring bill is modified, all future bills are automatically changed.
</Accordion>

<Accordion title="Mfa step up for api session">
  Set your current api session as mfa trusted. ideally, when you sign in with `post /v3/login`, set `remembermeid` and `device` in your request to generate an mfa-trusted api session. in case you sign in without `remembermeid` and `device` in your request, you can use this `post /v3/mfa/step-up` endpoint to mark the current api session as mfa trusted.
</Accordion>

<Accordion title="Get organization price plan details">
  Get the bill price plan details for an existing organization. the currently signed-in user must have the `administrator` user role in the bill organization to perform this operation. a bill price plan for an organization provides a range of information, including monthly subscription fees and the terms and conditions for additional charges in the price plan.
</Accordion>

<Accordion title="Restore an archived employee">
  Restore an archived employee. in the response, the `archived` field is set as `false`.
</Accordion>

<Accordion title="Restore an archived item">
  Restore an archived item. in the response, the `archived` field is set as `false`.
</Accordion>

<Accordion title="Restore an archived invoice">
  Restore an archived invoice. in the response, the `archived` field is set as `false`. you can perform any valid bill operation on restored invoices. there is no change when you restore a restored invoice.
</Accordion>

<Accordion title="Restore an archived department">
  Restore an archived department. in the response, the `archived` field is set as `false`.
</Accordion>

<Accordion title="Restore an archived job">
  Restore an archived job. in the response, the `archived` field is set as `false`.
</Accordion>

<Accordion title="Nominate a bank account user">
  Nominate a bank account user. when you nominate a user, bill performs a set of operations. \* the bank account user `verificationstatus` is set as `nominated`. \* bill sends the user an email asking them to sign in to the bill web app and complete identity verification. after user identity verification is successful, the bank account user `verificationstatus` is set as `verified` and the user can pay with the specified bank account. **note**: the bank account `status` must be set as `verified` before you can nominate bank account users.
</Accordion>

<Accordion title="Get user details">
  Get details about a existing user.
</Accordion>

<Accordion title="Restore an archived recurring bill">
  Restore an archived recurring bill. in the response, the `archived` field is set as `false`. you can perform any valid bill operation on restored recurring bills. there is no change when you restore a restored recurring bill. when a recurring bill is modified, all future bills are automatically changed.
</Accordion>

<Accordion title="Get list of budgets">
  Get a list of budget objects for the current user's company.
</Accordion>

<Accordion title="Restore an archived location">
  Restore an archived location. in the response, the `archived` field is set as `false`.
</Accordion>

<Accordion title="Get pan jwt">
  Get a jwt token for retrieving a card's pan (full account number). the jwt token contains all the information required for retrieving details about a virtual card (16-digit pan, cvv, and expiration date). the jwt token lifespan is 5 minutes. you can convert the retrieved jwt token to get the related virtual card details with `post https://app-dev-sandbox.divvy.co/de/rest/pan`. `curl --location --request post 'https://app-dev-sandbox.divvy.co/de/rest/pan' --header 'content-type: application/json' --data-raw '{"token":"{jwt token}"}'` **note**: use `post https://api.divvy.co/de/rest/pan` in the production environment.
</Accordion>

<Accordion title="Get list of items">
  Get a list of item objects. by default, you get 20 results on one page of results. set `max` in your request to get up to 100 results on one page. see [search operations with lists](doc:search-op-with-lists) in the guides section for filtering, sorting, and pagination examples.
</Accordion>

<Accordion title="Get list of cards">
  Get a list of card objects.
</Accordion>

<Accordion title="Get payment details">
  Get details about an existing payment.
</Accordion>

<Accordion title="Get user role details">
  Get details about an existing user role.
</Accordion>

<Accordion title="Restore an archived user">
  Restore an archived user. in the response, the `archived` field is set as `false`. you can perform any valid bill operation on restored users. there is no change when you restore a restored user.
</Accordion>

<Accordion title="Restore multiple accounting classes">
  Restore multiple accounting classes with one api request. in the response, the `archived` field for each object is set as `false`.
</Accordion>

<Accordion title="Restore multiple chart of accounts">
  Restore multiple chart of accounts with one api request. in the response, the `archived` field for each object is set as `false`.
</Accordion>

<Accordion title="Record ar payment">
  Record an invoice payment received outside your bill system. apply the recorded payment amount to one or more invoices for a customer. any recorded unapplied amount is an overpayment and is available as a customer balance in your bill system. see [recording an ar payment](doc:recording-an-ar-payment) in the guides section for more information, sample requests, and responses.
</Accordion>

<Accordion title="Get vendor bank account details">
  Get details about an existing vendor bank account.
</Accordion>

<Accordion title="Get phone status for risk verification">
  Check whether a phone number has been added for the currently signed-in user. bill requires the signed-in user to have a linked phone number for initiating risk verification for the organization. in the response, if `hasphone` is `false`, you can add a phone number for the user with `post /v3/risk-verifications/phone`. after you add a phone number, you can initiate risk verification for the organization with `post /v3/risk-verifications`.
</Accordion>

<Accordion title="Search for an organization in the bill networks">
  Search for a customer, vendor, or verified national vendor. you can search in the bill network and verified national vendor network. when you search in the bill network, there are two `name` requirements for getting search results. \* your search term must have a minimum of three characters. \* your search term must be a complete word. you will not get search results when your search term is a partial word. when you search in the verified national vendor network, search results are based on both a complete and partial match on `name` and `ziporpostalcode`. you can further filter your search by the billing statement `accountnumber` with the vendor. for example, your verizon internet bill account number. see [bill network](doc:bill-network) in the guides section for more information, sample requests, and responses.
</Accordion>

<Accordion title="Retrieve customer attachments">
  Retrieves all attachments associated with a specific customer in the bill api. this endpoint allows businesses to fetch documents, invoices, or any other files that have been uploaded and linked to a particular customer account. it should be used when there's a need to access or review all attachment files for a given customer, such as during auditing, customer service inquiries, or account management tasks. the endpoint returns a collection of attachment metadata and potentially the attachment contents, depending on the api's implementation. it does not modify any data and is typically used for read-only operations. note that this endpoint focuses on customer-specific attachments and may not include system-wide or non-customer-related files.
</Accordion>

<Accordion title="Send an invoice">
  Send an invoice to a customer email address. you can send the invoice to multiple email addresses. see [invoices](doc:ar-invoices) in the guides section for more information, sample requests, and responses.
</Accordion>

<Accordion title="Restore multiple employees">
  Restore multiple employees with one api request. in the response, the `archived` field for each object is set as `false`.
</Accordion>

<Accordion title="Restore multiple departments">
  Restore multiple departments with one api request. in the response, the `archived` field is set as `false`.
</Accordion>

<Accordion title="Get list of card accounts">
  Get a list of card account objects.
</Accordion>

<Accordion title="Get recurring bill details">
  Get details about an existing recurring bill.
</Accordion>

<Accordion title="Restore multiple locations">
  Restore multiple locations with one api request. in the response, the `archived` field for each object is set as `false`.
</Accordion>

<Accordion title="Get vendor configuration">
  Get international payments (not usd) configuration after vendor creation. this configuration is required for compliance with international payment rules of a vendor country and vendor bank account. in the response, the required `paymentpurpose` and `regulatoryfields` information is retrieved for the vendor. **note**: if you are adding `paymentpurpose` and `regulatoryfields` information during international vendor creation, use `get /v3/vendors/configuration/international-payments` to get the required configuration before vendor creation. see [creating an international vendor](doc:creating-an-international-vendor) for more information on how to set `paymentpurpose` and `regulatoryfields`.
</Accordion>

<Accordion title="Restore multiple items">
  Restore multiple items with one api request. in the response, the `archived` field for each object is set as `false`.
</Accordion>

<Accordion title="Update an employee">
  Update details about an existing employee.
</Accordion>

<Accordion title="Update an accounting class">
  Update details about an existing accounting class.
</Accordion>

<Accordion title="Get reimbursement details">
  Get details about a specified reimbursement.
</Accordion>

<Accordion title="Update an invoice">
  Update details about an invoice line item. you can also update other invoice details. you can use the patch operation to modify line item details, such as `amount`, `quantity`, and `description`. the invoice line item `id` does not change with a patch operation.
</Accordion>

<Accordion title="Get list of card account users">
  Get a list of card account user objects. in the response, if the card account user `verificationstatus` is set as `nominated`, user verification must be completed before the user can pay with the specified card account. by default, you get 20 results on one page of results. set `max` in your request to get up to 100 results on one page.
</Accordion>

<Accordion title="Update an item">
  Update details about an existing item.
</Accordion>

<Accordion title="Update an organization">
  Update details about an existing organization. the currently signed-in user must have the `administrator` user role in the bill organization to perform this operation. see [organizations and users](doc:organizations-users) in the guides section for more information, sample requests, and responses.
</Accordion>

<Accordion title="Get list of ap cards">
  Get a list of ap card objects. with the ap card, you can earn rewards simply by paying your bills. the ap card is a payment method that enables you to send fast payments with no transaction fees or annual fees. you can use the ap card with any vendor who accepts virtual card payments. see [ap card frequently asked questions (faqs)](https://help.bill.com/direct/s/article/000003348) in the bill help to learn more about ap card.
</Accordion>

<Accordion title="Update a bank account">
  Update details about an existing bank account. this operation follows a set of rules. \* **bank account `status` requirement**: the bank account `status` must be set as `verified` before you can update any details about the bank account. you can verify the bank account with `post /v3/funding-accounts/banks/\{bankaccountid\}/verify`. \* **update field restrictions**: you cannot update the `routingnumber`, `accountnumber`, and account `type` values for a bank account. if you want to update any of these values, create a new bank account with `post /v3/funding-accounts/banks`.
</Accordion>

<Accordion title="Update a customer">
  Update details about an existing customer.
</Accordion>

<Accordion title="Replace a bill">
  Update the number of line items in a bill. you can also update other bill details. you can use the put operation to add, remove, or replace the number of line items in a bill. a set of rules apply with the put operation. \* when you add a new line item, a new line item `id` is generated in the bill. \* when you omit an existing line item `id`, the line item is removed from the bill.
</Accordion>

<Accordion title="Update a chart of accounts">
  Update details about an existing chart of accounts.
</Accordion>

<Accordion title="Restore multiple jobs">
  Restore multiple jobs with one api request. in the response, the `archived` field for each object is set as `false`.
</Accordion>

<Accordion title="Replace an invoice">
  Update the number of line items in an invoice. you can also update other invoice details. you can use the put operation to add, remove, or replace the number of line items in an invoice. a set of rules apply with the put operation. \* when you add a new line item, a new line item `id` is generated in the invoice. \* when you omit an existing line item `id`, the line item is removed from the invoice.
</Accordion>

<Accordion title="Update a bill">
  Update details about a bill line item. you can also update other bill details. you can use the patch operation to modify line item details, such as `amount` and `description`. the bill line item `id` does not change with a patch operation.
</Accordion>

<Accordion title="Get list of bank accounts">
  Get a list of bank account objects. by default, you get 20 results on one page of results. set `max` in your request to get up to 100 results on one page. see [search operations with lists](doc:search-op-with-lists) in the guides section for filtering, sorting, and pagination examples.
</Accordion>

<Accordion title="Update a budget">
  Update details about an existing budget.
</Accordion>

<Accordion title="Update a custom field and values on a transaction">
  Update a custom field and values on a transaction.
</Accordion>

<Accordion title="Get list of jobs">
  Get a list of job objects. by default, you get 20 results on one page of results. set `max` in your request to get up to 100 results on one page. see [search operations with lists](doc:search-op-with-lists) in the guides section for filtering, sorting, and pagination examples.
</Accordion>

<Accordion title="Get list of members for a budget">
  Get a list of members for a budget.
</Accordion>

<Accordion title="Get list of accounting classes">
  Get a list of accounting class objects. by default, you get 20 results on one page of results. set `max` in your request to get up to 100 results on one page. see [search operations with lists](doc:search-op-with-lists) in the guides section for filtering, sorting, and pagination examples.
</Accordion>

<Accordion title="Get list of locations">
  Get a list of location objects. by default, you get 20 results on one page of results. set `max` in your request to get up to 100 results on one page. see [search operations with lists](doc:search-op-with-lists) in the guides section for filtering, sorting, and pagination examples.
</Accordion>

<Accordion title="Get list of mfa phone numbers">
  Get a list of phone numbers that have been added for setting up mfa in the current organization.
</Accordion>

<Accordion title="Get list of user roles">
  Get a list of user role objects. by default, you get 20 results on one page of results. set `max` in your request to get up to 100 results on one page. see [search operations with lists](doc:search-op-with-lists) in the guides section for filtering, sorting, and pagination examples.
</Accordion>

<Accordion title="Get list of transactions">
  Get a list of transaction objects.
</Accordion>

<Accordion title="Get list of users">
  Get a list of user objects. by default, you get 20 results on one page of results. set `max` in your request to get up to 100 results on one page. see [search operations with lists](doc:search-op-with-lists) in the guides section for filtering, sorting, and pagination examples.
</Accordion>

<Accordion title="Get list of departments">
  Get a list of department objects. by default, you get 20 results on one page of results. set `max` in your request to get up to 100 results on one page. see [search operations with lists](doc:search-op-with-lists) in the guides section for filtering, sorting, and pagination examples.
</Accordion>

<Accordion title="Restore an archived vendor">
  Restore an archived vendor. in the response, the `archived` field is set as `false`. you can perform any valid bill operation on restored vendors. there is no change when you restore a restored vendor.
</Accordion>

<Accordion title="Get list of chart of accounts">
  Get a list of chart of accounts objects. by default, you get 20 results on one page of results. set `max` in your request to get up to 100 results on one page. see [search operations with lists](doc:search-op-with-lists) in the guides section for filtering, sorting, and pagination examples.
</Accordion>

<Accordion title="Get list of customers">
  Get a list of customer objects. by default, you get 20 results on one page of results. set `max` in your request to get up to 100 results on one page. see [search operations with lists](doc:search-op-with-lists) in the guides section for filtering, sorting, and pagination examples.
</Accordion>

<Accordion title="Get list of custom fields">
  Get list of custom fields.
</Accordion>

<Accordion title="Get list of values for custom field">
  Get list of values for custom field.
</Accordion>

<Accordion title="Get list of vendors">
  Get a list of vendor objects. by default, you get 20 results on one page of results. set `max` in your request to get up to 100 results on one page. see [search operations with lists](doc:search-op-with-lists) in the guides section for filtering, sorting, and pagination examples.
</Accordion>

<Accordion title="Get list of reimbursements">
  Get a list of reimbursement objects.
</Accordion>

<Accordion title="Validate phone for mfa setup">
  Validates the setup of multi-factor authentication (mfa) for a user's account in the bill api. this endpoint is used as the final step in the mfa setup process, confirming that the user has successfully received and can provide the validation token sent to their registered phone number. it should be called immediately after the user receives the mfa setup token via the specified method (voice call or sms). the endpoint ensures that the mfa setup is correctly configured and functional, adding an extra layer of security to the user's account. it's important to note that this endpoint does not actually enable mfa; it only validates the setup process.
</Accordion>

<Accordion title="Update budget member funds">
  Add a member to a budget or update an existing member of the budget
</Accordion>

<Accordion title="Update a job">
  Update details about an existing job.
</Accordion>

<Accordion title="Upload bill document">
  Upload a document for an existing bill. **note**: when you upload a document, it takes a few minutes for bill to complete the upload process. you can get the document upload status with `get /v3/documents/upload-status`. see [documents and attachments](doc:documents-attachments) in the guides section for more information, sample requests, and responses.
</Accordion>

<Accordion title="Update a department">
  Update details about an existing department.
</Accordion>

<Accordion title="Update transaction">
  Update a transaction
</Accordion>

<Accordion title="Update a vendor card">
  Update a new vendor card.
</Accordion>

<Accordion title="Void a payment">
  Void an existing payment. void a bill payment that has started processing and cannot be canceled (with `post /v3/payments/\{paymentid\}/cancel`). you can attempt to void payments made both with bill (online) and outside bill (offline). ### void a payment made with bill (online) in your /`post /v3/payments/\{paymentid\}/void` request: \* set `paymentid` as the bill-generated id of the payment. the value begins with `stp`. \* set `type` as the void payment request type \* set `reason` as the reason for voiding the payment see [can i cancel or void a payables payment?](https://help.bill.com/direct/s/article/115005898063) in the bill help center to learn about the bill void payment process and timing in the production environment.
</Accordion>

<Accordion title="Update a location">
  Update details about an existing location.
</Accordion>

<Accordion title="Verify a bank account">
  Verifies a bank account by initiating a small deposit transaction. this endpoint is used to confirm the validity and ownership of a bank account before it can be used for funding or receiving payments. it simulates a micro-deposit process commonly used in financial systems for account verification. the api requires specifying a deposit amount, which must be between $0.01 and $0.99. this verification step is crucial for ensuring the security and accuracy of financial transactions within the bill payment system. note that in the sandbox environment, using a deposit amount of \$0.50 will always result in a successful verification, allowing for easy testing and integration.
</Accordion>

<Accordion title="Update a vendor">
  Update details about an existing vendor. ### requirements for enabling vendor payments vendor address details are required for paying a vendor by check or for inviting the vendor to join the bill network. \* `line1` \* `city` \* `ziporpostalcode` \* `country` \* `payeename` **note**: you cannot add or update vendor bank account information with this endpoint. you can add and manage vendor bank account information with a dedicated set of endpoints. \* **create a vendor bank account**: `post /v3/vendors/\{vendorid\}/bank-account` \* **get vendor bank account details**: `get /v3/vendors/\{vendorid\}/bank-account` \* **delete a vendor bank account**: `delete /v3/vendors/\{vendorid\}/bank-account`
</Accordion>

<Accordion title="Update a reimbursement">
  Update a reimbursement
</Accordion>

<Accordion title="Update custom field details">
  Update settings for a custom field.
</Accordion>

<Accordion title="Update a list of budget members in a budget">
  Update a list of budget members in a budget.
</Accordion>

<Accordion title="Validate mfa challenge">
  Validates a multi-factor authentication (mfa) challenge in the bill api. this endpoint is used to complete the mfa process by verifying the token sent to the user's registered phone number. it should be called after initiating an mfa challenge with the 'post /v3/mfa/challenge' endpoint. the function provides options for remembering the device or machine for an extended period, enhancing user convenience for trusted devices while maintaining security. it's crucial for implementing secure, two-factor authentication flows in applications integrated with the bill api.
</Accordion>

<Accordion title="Update a user">
  Update details about an existing user.
</Accordion>

<Accordion title="Upload invoice attachment">
  Upload an attachment for an invoice. **note**: when you upload an attachment, it takes a few minutes for bill to complete the upload process. see [documents and attachments](doc:documents-attachments) in the guides section for more information, sample requests, and responses.
</Accordion>

<Accordion title="Upload customer attachment">
  Upload an attachment for an existing customer. **note**: when you upload an attachment, it takes a few minutes for bill to complete the upload process. see [documents and attachments](doc:documents-attachments) in the guides section for more information, sample requests, and responses.
</Accordion>

<Accordion title="Update a recurring bill">
  Update details about a recurring bill line item. you can also update other recurring bill details. you can use the patch operation to modify line item details, such as amount and description. the recurring bill line item `id` does not change with a patch operation. when a recurring bill is modified, all future bills are automatically changed.
</Accordion>

<Accordion title="Upload vendor attachment">
  Upload an attachment for an existing vendor. **note**: when you upload an attachment, it takes a few minutes for bill to complete the upload process. see [documents and attachments](doc:documents-attachments) in the guides section for more information, sample requests, and responses.
</Accordion>


# Bitbucket
Source: https://docs.push.ai/integrations/bitbucket



Bitbucket is a Git-based code hosting and collaboration platform supporting private and public repositories, enabling teams to manage and review code through pull requests and integrations

<Accordion title="Delete repository">
  This tool allows for the permanent deletion of a bitbucket repository. it requires admin access to the repository and the repository:delete scope. it uses the delete endpoint at [https://api.bitbucket.org/2.0/repositories/\\\{workspace\\}/\\\{repo](https://api.bitbucket.org/2.0/repositories/\\\{workspace\\}/\\\{repo) slug}. important notes include the irreversible nature of this action and the fact that the deletion does not affect any forks of the repository.
</Accordion>

<Accordion title="Delete issue">
  This tool deletes a specified issue from a bitbucket repository. it requires write access to the repository.
</Accordion>

<Accordion title="Update issue">
  Action to update an existing issue in a bitbucket repository. this tool allows updating an existing issue in a bitbucket repository. it uses the put /2.0/repositories/\{workspace}/\{repo slug}/issues/\{issue id} endpoint.
</Accordion>

<Accordion title="Create branch">
  This tool creates a new branch in a specified bitbucket repository. it uses the bitbucket api to create a branch from a specified commit hash.
</Accordion>

<Accordion title="List workspace members">
  This tool lists all members of a specified bitbucket workspace using the get /2.0/workspaces/\{workspace}/members api endpoint. it requires the workspace id and supports pagination. the tool is independent and is useful for checking workspace membership, auditing access, and integration with user management systems.
</Accordion>

<Accordion title="Get current user">
  This tool retrieves the profile information of the currently authenticated user in bitbucket. it can function independently with only authentication required and provides essential user details such as the user's uuid, display name, avatar url, and account creation timestamp.
</Accordion>

<Accordion title="Get file from repository">
  This tool retrieves the contents of a specific file from a bitbucket repository. it uses the bitbucket api endpoint: get [https://api.bitbucket.org/2.0/repositories/\\\{workspace\\}/\\\{repo](https://api.bitbucket.org/2.0/repositories/\\\{workspace\\}/\\\{repo) slug}/src/\{commit}/\{path}
</Accordion>

<Accordion title="Get snippet">
  This tool retrieves a single snippet from bitbucket. the snippet can be retrieved in multiple formats including application/json, multipart/related, or multipart/form-data.
</Accordion>

<Accordion title="List pull requests">
  Action to list pull requests in a bitbucket repository.
</Accordion>

<Accordion title="Create issue">
  This tool creates a new issue in a bitbucket repository. the authenticated user will be set as the issue's reporter.
</Accordion>

<Accordion title="Create issue comment">
  Action to create a new comment on an existing bitbucket issue. this tool creates a new comment on an existing issue in a bitbucket repository. the comment can include formatted text and will be associated with the authenticated user.
</Accordion>

<Accordion title="Create pull request">
  This tool creates a new pull request in a bitbucket repository. it uses the provided parameters (workspace, repo slug, title, source branch, destination branch, description, reviewers, close source branch) to create the pull request via the bitbucket api. it complements bitbucket list pull requests by providing the ability to create new pull requests, essential for code collaboration and review.
</Accordion>

<Accordion title="Create repository">
  This tool creates a new repository in the specified workspace. it is essential for repository management and serves as an important step in many git workflows.
</Accordion>

<Accordion title="List workspaces">
  This tool will list all workspaces that the authenticated user has access to. it is a fundamental operation needed before performing any workspace-specific operations, functioning solely with authentication. additionally, it provides essential information for further bitbucket operations.
</Accordion>

<Accordion title="List repositories in workspace">
  This tool retrieves a paginated list of all repositories owned by the specified workspace. it is based on the bitbucket api (get /2.0/repositories/\{workspace}) and is designed to be a fundamental operation for listing repositories. the tool requires only the workspace identifier and optionally accepts query parameters such as role, q, and sort to filter and sort the results.
</Accordion>


# Blackboard
Source: https://docs.push.ai/integrations/blackboard



Anthology Adopt powered by Pendo allows institutions to gain insights on Blackboard Learn usage and take action through in-app messages, digital walkthrough guides, and tooltips.

<Accordion title="Copy course with specific options">
  The coursecopytool allows you to create a copy of a blackboard course with fine-grained control over which elements are included in the copy. this endpoint is used when you need to duplicate a course, either creating a new course or overwriting an existing one, while selectively choosing which components to transfer. it's particularly useful for course administrators or instructors preparing for a new semester or creating variations of an existing course. the tool provides extensive customization options, allowing you to include or exclude specific course elements such as content areas, assessments, gradebook settings, and more. however, it does not handle enrollment of students or instructors in the new course - this must be done separately after the copy is complete.
</Accordion>

<Accordion title="Create adaptive release criteria by rule">
  This endpoint allows for the creation of new adaptive release criteria for a specific rule within a course's content in blackboard. it is used to define conditions under which course content will be made available to students, such as completion of prerequisites, achievement of certain grades, or specific dates. the endpoint should be used when instructors or course designers want to implement or modify conditional access to course materials. it's important to note that this endpoint only creates criteria for existing adaptive release rules and does not create the rules themselves.
</Accordion>

<Accordion title="Get oauth2 authorization code">
  Initiates the oauth 2.0 authorization code flow for the blackboard api. this endpoint is used to obtain an authorization code, which is a crucial step in the oauth 2.0 authentication process. the authorization code can later be exchanged for an access token, granting limited access to user resources on the blackboard platform. this endpoint should be called when an application needs to request permission from a user to access their blackboard data. it's important to note that this endpoint does not directly provide access to user data; it only initiates the authorization process. the response will typically include a redirect url containing the authorization code, which the client application must handle appropriately.
</Accordion>

<Accordion title="Delete user from course">
  Removes a specific user from a particular course in the blackboard learning management system. this endpoint should be used when an administrator or instructor needs to unenroll a student, remove a teaching assistant, or disassociate any user from a course. it's particularly useful for managing course rosters, handling student withdrawals, or updating staff assignments. the operation is irreversible, so it should be used with caution. this endpoint does not delete the user from the entire blackboard system; it only removes their association with the specified course. it's important to note that this action may affect the user's access to course materials and their course-related data.
</Accordion>

<Accordion title="List gradebook columns for course">
  Retrieves all gradebook columns for a specified course in the blackboard learning management system. this endpoint allows instructors or authorized users to access the structure and details of the gradebook for a particular course. it returns information about each column, such as column name, points possible, creation date, and last modified date. this tool is essential for understanding the current layout of a course's gradebook, preparing for grade entry, or auditing the grading structure. it should be used when a comprehensive view of the gradebook organization is needed. note that this endpoint only provides metadata about the columns and does not include actual student grades or submissions.
</Accordion>

<Accordion title="Get user gradebook for course">
  Retrieves the gradebook information for a specific user within a particular course in blackboard. this endpoint allows instructors or authorized personnel to access individual student grade data, including assignment scores, overall course grade, and any custom gradebook columns. it should be used when detailed grade information for a single student in a specific course is needed, such as for progress monitoring or grade reviews. the endpoint does not modify any data and is read-only. note that this tool only provides grade data and does not include other course or user information beyond what's directly related to the gradebook.
</Accordion>

<Accordion title="Copy course by courseid">
  This endpoint creates a copy of an existing course in the blackboard learning management system. it allows instructors or administrators to duplicate course content, settings, and structure into a new or existing course. use this endpoint when you need to replicate a course for a new semester, create a template from an existing course, or backup course content. the operation copies all copyable elements of the source course into the target course specified by the courseid. note that this process may take some time for large courses, and certain elements (such as student data or time-sensitive content) may not be copied. the endpoint does not provide real-time progress updates on the copying process.
</Accordion>

<Accordion title="Create course announcement">
  Creates a new announcement within a specified course in the blackboard learning management system. this endpoint allows instructors or course administrators to post important messages, updates, or notifications to all enrolled students. the announcement can be customized with a title, rich text body using bbml, and specific availability settings. use this endpoint when you need to communicate course-wide information, such as syllabus changes, assignment reminders, or important dates. the announcement can be created as a draft for later publication or immediately made visible based on the specified availability settings.
</Accordion>

<Accordion title="Retrieve course list">
  Retrieves a list of courses from the blackboard learn platform. this endpoint allows developers to fetch information about courses available in the learning management system. it can be used to integrate course data into external applications, create custom dashboards, or sync course information with other systems. the endpoint returns read-only data and does not modify any course information. while it provides a comprehensive list of courses, it may not include detailed information about course content, assignments, or student data, which might require additional api calls. use this endpoint when you need to obtain an overview of courses in the blackboard learn environment, such as for course catalogs or administrative purposes.
</Accordion>

<Accordion title="Create system announcement">
  Creates a new system-wide announcement in the blackboard learn environment. this endpoint allows administrators to compose and configure announcements that can be displayed to users across the platform. the announcement can be customized with rich text content, specific visibility durations, and display locations such as the login page or within courses. use this endpoint when you need to broadcast important information, updates, or alerts to all users or specific segments of your blackboard learn community. it's particularly useful for system-wide notifications, maintenance alerts, or important institutional announcements. note that creating excessive or irrelevant announcements may lead to information overload for users, so use this feature judiciously.
</Accordion>

<Accordion title="Create assignment in course contents">
  Creates a new assignment within a specified blackboard course. this endpoint allows instructors to set up detailed assignments with customizable settings for availability, grading, and plagiarism detection. it supports rich text instructions using bbml, adaptive release for controlled content visibility, and integration with originality reporting tools. use this endpoint when you need to programmatically create assignments with specific requirements or to batch create multiple assignments. the endpoint provides extensive customization options but requires careful consideration of parameters to ensure the assignment is set up correctly for student access and evaluation.
</Accordion>

<Accordion title="Update user meeting attendance status">
  Adds a user to a specific meeting within a blackboard course and sets their attendance status. this endpoint is essential for managing attendance and user participation in course meetings. it allows instructors or authorized users to update a student's attendance record for a particular meeting. the endpoint should be used when recording attendance for course meetings, updating a user's attendance status, or integrating external attendance tracking systems with blackboard. it provides a way to maintain accurate attendance records, which can be crucial for course management and student engagement tracking.
</Accordion>

<Accordion title="Create data source with external id">
  Creates a new data source in the blackboard learn system. this endpoint is used to establish a unique identifier for an external data source, which can then be referenced in other api calls or integrations. it's particularly useful when setting up integrations between blackboard and external systems, such as student information systems (sis) or other educational tools. the created data source can be used for various purposes, including batch operations, data synchronization, or as a reference point for imported content. this endpoint should be used when initially setting up a new integration or when a new external system needs to be recognized within blackboard. it's important to note that the externalid must be unique across all data sources in the blackboard instance, and once created, it cannot be changed.
</Accordion>

<Accordion title="Add course content attachment">
  Adds an attachment to a specific content item within a blackboard learn course. this endpoint allows developers to programmatically upload and associate files with course materials, enhancing the content available to students. it should be used when integrating external systems with blackboard learn to automate the process of adding supplementary materials, documents, or resources to course content. the endpoint requires specifying both the course and the content item to which the attachment will be added, ensuring precise placement of materials within the course structure. note that this operation likely has size limitations for attachments and may be subject to storage quotas set by the institution's blackboard learn administrator.
</Accordion>

<Accordion title="Create grading period in course gradebook">
  Creates a new grading period within a specific course's gradebook in the blackboard learn system. this endpoint allows instructors or administrators to define and organize temporal segments for grade collection and management. it's particularly useful for structuring the academic year into distinct grading intervals, such as semesters, quarters, or specific assessment periods. the created grading period can be used to associate gradable items (columns) with specific timeframes, facilitating organized grade tracking and reporting. this endpoint should be used when setting up a new course structure or adjusting existing grading timelines. it's important to note that while the endpoint offers flexibility in date handling, careful consideration should be given to the datemode parameter and its implications on start and end dates.
</Accordion>

<Accordion title="Update user criterion in adaptive rule">
  This endpoint updates a user-specific criterion within an adaptive release rule for a particular content item in a blackboard course. it allows for fine-tuning of content visibility based on individual user conditions. use this endpoint when you need to modify existing user-based criteria for adaptive release rules, such as changing performance thresholds or adjusting access conditions for a specific student. this tool is specifically for updating existing criteria and should not be used for creating new rules or criteria. note that this endpoint focuses solely on user-specific criteria and does not handle group-based or date-based release conditions.
</Accordion>

<Accordion title="List course announcements">
  Retrieves a list of announcements for a specific course in the blackboard learning management system. this endpoint allows users to access important messages, updates, or notifications related to a particular course. it should be used when there's a need to fetch all announcements or check for recent updates in a course. the tool returns announcement data but does not provide functionality for creating, updating, or deleting announcements. keep in mind that the returned list may be paginated if there are many announcements, and additional calls might be necessary to retrieve all data.
</Accordion>

<Accordion title="Create lti domain configuration">
  Creates or updates an lti (learning tools interoperability) domain configuration in blackboard learn. this endpoint allows administrators to set up and manage integrations with external learning tools, configuring various aspects such as user data sharing, security settings, and service permissions. it's used when setting up a new lti tool or modifying an existing integration to control how the tool interacts with blackboard and what data it can access. the configuration includes options for managing user privacy, tool authentication, and access to blackboard services like membership and grading.
</Accordion>

<Accordion title="Create course group">
  Creates a new group within a specified course in the blackboard learn system. this endpoint allows for detailed customization of group properties, including its name, description, availability, and enrollment settings. it's particularly useful for organizing students into smaller units for collaborative work, discussions, or specific course activities. the function supports creating both regular groups and group sets, with options for self-enrollment or instructor-managed membership. use this when setting up course structures that require student groupings, whether for project teams, study groups, or other collaborative activities within a course.
</Accordion>

<Accordion title="Create discussion forum in course">
  Creates a new discussion forum within a specified course in the blackboard learning management system. this endpoint allows instructors or course administrators to set up a discussion topic, define its availability, and optionally make it gradable. it's particularly useful for initiating course-related discussions, q\&a sessions, or collaborative learning activities. the endpoint requires a course id in the path and accepts json payload with discussion details. it should be used when setting up new discussion areas for a course, but not for posting individual messages within an existing discussion. note that while you can set the initial topic message, many properties of the discussion are auto-generated and read-only.
</Accordion>

<Accordion title="Update user in course group">
  This endpoint updates a user's information within a specific group in a blackboard course. it allows administrators or instructors to modify user details, roles, or permissions for a particular user in the context of a course group. use this endpoint when you need to change a user's status, role, or other attributes within a group, such as updating their group membership type or adjusting their group-specific permissions. this operation is specifically for modifying existing user data and should not be used for adding new users to a group or creating new groups. the endpoint requires the course id, group id, and user id to precisely target the user's information in the correct context.
</Accordion>

<Accordion title="Post group attempts for gradebook column">
  The creategroupattempt endpoint allows for the creation or update of a group attempt for a specific gradebook column in a blackboard learn course. this tool is essential for managing group submissions, tracking their progress, and facilitating the grading process. it supports various aspects of group work, including submission status tracking, grading, feedback, and metadata management. the endpoint is particularly useful for instructors and course administrators who need to manage group assignments and assessments within the blackboard learning environment. it provides flexibility in handling different stages of the submission process, from initial attempt to final grading, and supports both regular and ultra course formats. however, users should be aware that some status options are deprecated and may cause unexpected behavior if used.
</Accordion>

<Accordion title="Retrieve course details by id">
  Retrieves detailed information about a specific course in the blackboard learning management system. this endpoint allows users to fetch comprehensive data related to a course, such as its title, description, start and end dates, enrollment information, and other course-specific attributes. it is particularly useful for applications that need to display or process course information outside of the blackboard interface. this tool should be used when detailed course information is required for a known course id, but it will not provide a list of all courses or modify any course data.
</Accordion>

<Accordion title="Modify course content adaptive release group criteria">
  This endpoint updates the criteria for a specific group within an adaptive release rule for a particular content item in a blackboard course. it allows instructors or course administrators to modify how and when course content is made available to different groups of students based on various conditions. use this endpoint when you need to adjust the release criteria for course materials for a specific student group, such as changing date restrictions, grade requirements, or other access conditions. this operation is crucial for maintaining flexible and personalized learning paths within a course. note that this endpoint only updates existing criteria and cannot be used to create new adaptive release rules or groups.
</Accordion>

<Accordion title="Update content group association">
  This endpoint updates the association between a specific content item and a group within a blackboard learn course. it is used to modify existing content-group relationships, enabling instructors or administrators to manage group-specific content access or visibility. the endpoint requires the course id, content id, and group id to be specified in the url path, with the content id and group id repeated in the request body for confirmation. this operation is particularly useful for customizing content delivery to different student groups or managing group-based learning activities within a course. note that this endpoint only updates existing associations and cannot create new content or groups.
</Accordion>

<Accordion title="Create course content in course">
  Creates new content within a specified blackboard course. this endpoint allows for the addition of various types of content, including documents, external links, folders, and more, with detailed configuration options. it supports rich text formatting through bbml, hierarchical content structure, and granular control over content availability and accessibility. use this endpoint when adding new materials, resources, or structural elements to a course. it's particularly useful for bulk content creation or programmatic course setup. note that while it offers extensive customization, some advanced features may depend on the blackboard learn version in use.
</Accordion>

<Accordion title="Create course group in course">
  Creates a new group within a specified course in the blackboard learning management system. this endpoint allows instructors or administrators to set up and configure groups for collaborative work, discussions, or other course-related activities. the function provides extensive customization options for group availability, enrollment methods, and signup processes. it's particularly useful for organizing students into smaller teams for projects, facilitating peer-to-peer learning, or managing course sections. note that while many parameters are optional, careful configuration is recommended to ensure the group serves its intended purpose within the course structure.
</Accordion>

<Accordion title="Update group details by course and group id">
  Updates the properties of a specific group within a blackboard learn course. this endpoint allows modification of group details such as name, description, availability, and enrollment settings. it's particularly useful for adjusting group configurations after initial creation, managing student access, and controlling enrollment options. the endpoint supports partial updates, allowing you to modify only the specified fields without affecting others. use this when you need to change group settings, update availability, or adjust enrollment limits and signup options for an existing group in a course.
</Accordion>

<Accordion title="Post discussion message reply">
  Creates a reply to a specific message within a blackboard course discussion. this endpoint allows users to contribute to ongoing discussions by posting responses to existing messages. it supports both course-wide and group-specific discussions, with options to control the visibility and state of the reply. the content of the reply must be formatted in bbml (blackboard markup language) for rich text support. use this endpoint when a user wants to respond to a particular message in a discussion thread, either immediately publishing the reply or saving it as a draft for later review.
</Accordion>

<Accordion title="Create institutional hierarchy node">
  Creates a new node in the institutional hierarchy of blackboard. this endpoint allows for the addition of organizational elements such as departments, courses, or other structural units within an educational institution's blackboard system. it is used to build and maintain the hierarchical structure that organizes content and permissions. the endpoint requires a json payload with node details and supports optional parameters for flexibility in node creation and positioning within the hierarchy.
</Accordion>

<Accordion title="Update course user details">
  Updates a user's enrollment details in a specific blackboard learn course. this endpoint allows for modifying various aspects of a user's course membership, including their role, availability status, and association with cross-listed courses. it's particularly useful for managing instructor assignments, adjusting student access, and organizing cross-listed course enrollments. the endpoint should be used when changes to a user's course enrollment are required, such as changing their role, updating their availability, or moving them between cross-listed courses. it does not provide functionality for initial course enrollment or complete removal of a user from a course.
</Accordion>

<Accordion title="Add new gradebook column for course">
  Creates a new grade column in a course's gradebook within the blackboard learn platform. this endpoint allows instructors or administrators to set up various types of grade columns, including manual entry, calculated grades, and those based on student attempts. it supports features such as anonymous grading, external tool integration, and custom formulas for grade calculation. the endpoint is particularly useful when setting up a new assignment or assessment that requires a corresponding grade column in the course gradebook. it should be used to establish the grading structure for a course, but not for entering actual grades (which would be done through a separate endpoint). note that some features may have version-specific availability, and certain settings (like includeincalculations) may behave differently between classic and ultra courses.
</Accordion>

<Accordion title="Retrieve course details">
  Retrieves detailed information about a specific course in the blackboard learn platform using its unique identifier. this endpoint allows users to fetch comprehensive course data, which may include the course name, code, description, enrollment information, instructor details, and other relevant metadata. it's particularly useful for applications that need to display or process course information, such as student portals, administrative tools, or integration with other educational systems. the endpoint should be used when specific course details are required, but it will not provide information about student performance or course content. note that the exact scope of information returned may depend on the user's permissions within the blackboard system.
</Accordion>

<Accordion title="Update course information">
  Updates an existing course in the blackboard learn system. this endpoint allows modification of various course attributes including basic information, availability settings, enrollment options, and localization preferences. it's used to adjust course details after initial creation, enabling instructors or administrators to manage course lifecycle and accessibility. the endpoint requires the course id and accepts a range of optional parameters for fine-tuning course properties. it's particularly useful for making bulk changes to course settings or adapting courses to changing educational needs. note that some settings, like allowing guests, are only modifiable for specific course types (classic vs ultra).
</Accordion>

<Accordion title="Create new lti placement">
  Creates a new lti (learning tools interoperability) placement in the blackboard learn system. this endpoint allows integration of external tools and services into the learning management system, enhancing the capabilities and user experience. it supports various types of placements, including content handlers, system tools, and course navigation elements. use this endpoint when you need to add a new external tool or service to blackboard learn, specifying its type, location, and configuration settings. the created placement can be used for various purposes such as content delivery, student engagement, or administrative tasks, depending on the specified type.
</Accordion>

<Accordion title="Update course primary node association">
  This endpoint updates the association between a specific course and a node in the blackboard institutional hierarchy. it allows you to set or change whether the specified node is the primary association for the given course. use this endpoint when you need to modify the primary status of a course-node relationship, such as when restructuring your institution's course organization or correcting misallocations. the endpoint is particularly useful for managing courses that span multiple nodes or departments. note that this operation only affects the 'primary' status of the association and does not create or delete associations between courses and nodes.
</Accordion>

<Accordion title="Create calendar items">
  This endpoint creates a new calendar item in the blackboard platform. it allows users to add various types of events, such as course-related activities, personal appointments, or institution-wide events, to specific calendars within the system. the endpoint supports creating one-time events as well as recurring items with customizable recurrence patterns. it also facilitates the integration of learning tools interoperability (lti) links, enabling the association of external learning tools with calendar items. this endpoint should be used when adding new events or activities to blackboard calendars, but it cannot be used to modify existing calendar items or to create items for the read-only gradebookcolumn type.
</Accordion>

<Accordion title="Post pronouns details">
  Creates a new pronoun entry in the blackboard learning management system. this endpoint is used to add new pronouns to the system's user identity management, supporting inclusive and diverse user representation. it should be used when administrators or authorized users need to introduce new pronoun options for users to select from. the endpoint incorporates an approval workflow, allowing for review of new pronoun entries before they become available for general use. note that this endpoint only creates the pronoun entry; it does not assign pronouns to specific users or modify existing user profiles.
</Accordion>

<Accordion title="Add catalog category by type">
  Creates a new category in the blackboard catalog system. this endpoint allows administrators to define and organize content categories within the learning management system. use this tool to add a new category with specific properties such as title, description, availability, and access restrictions. it's particularly useful for structuring course offerings, organizing resources, or creating custom catalogs within blackboard. the created category can be set to appear on the front page and can be restricted to specific institutional roles, providing flexible control over content organization and access.
</Accordion>

<Accordion title="Add adaptive release rule to course content">
  Creates a new adaptive release rule for a specific content item within a blackboard course. this endpoint allows instructors or course administrators to set up conditions for releasing course content to students based on various criteria. the rule is identified by a title and associated with a particular content item in a course. use this when you need to control the visibility or accessibility of course materials based on specific conditions. note that while this endpoint creates the rule, setting up the specific conditions for release would likely require additional api calls or configuration.
</Accordion>

<Accordion title="Post course assessment question">
  This endpoint creates a new question within an existing blackboard assessment. it supports various question types and allows for customization of content, feedback, and scoring. use it to build or modify assessments by adding new questions. note that while many parameters are optional, the 'text' field is required. the question type determines its structure and behavior, but specific configurations may require additional documentation.
</Accordion>

<Accordion title="Create rubric association in course">
  Creates a new association between a rubric and a specific course content item in the blackboard learning management system. this endpoint allows instructors or course designers to link a rubric to elements such as assignments, discussions, or other gradable items within a course. it's used to establish grading criteria, set visibility options for students, and connect the rubric to the appropriate gradebook column or question. the association can be configured for grading purposes or as an informational guide, with flexible options for when and how students can view the rubric and its evaluation. this tool is essential for implementing consistent assessment strategies across course content and providing clear expectations to students.
</Accordion>

<Accordion title="Create rubric evaluation for course">
  Creates or updates a rubric evaluation for a specific course, rubric, and rubric association in the blackboard learn platform. this endpoint allows instructors or authorized users to submit detailed evaluations of student work using predefined rubrics. it supports various types of rubrics (numeric, numeric range, percentage, percentage range) and allows for granular scoring and feedback at the cell level. the evaluation can be associated with individual, group, or question attempts, providing flexibility for different assessment scenarios. use this endpoint when you need to programmatically submit or modify rubric-based evaluations, such as grading assignments or providing structured feedback on assessments.
</Accordion>

<Accordion title="Create course meeting">
  Creates a new meeting for a specific course within the blackboard learning management system. this endpoint allows you to schedule and define the details of a course meeting, including its title, description, start and end times, and an optional external link. use this when you need to add a new meeting or event to a course's calendar or schedule. the created meeting will be associated with the specified course and visible to course participants. this tool is specifically for creating new meetings and cannot be used to update existing ones or retrieve meeting information.
</Accordion>

<Accordion title="Get course announcement by id">
  Retrieves a specific announcement from a particular course in the blackboard learn system. this endpoint allows users to fetch detailed information about a single announcement, including its content, creation date, and any attachments. it is particularly useful for displaying announcement details in external applications or for retrieving updated information about a previously known announcement. the endpoint requires both the course id and the announcement id to ensure precise retrieval of the intended announcement. it should be used when specific announcement details are needed, rather than for listing all announcements in a course.
</Accordion>

<Accordion title="Create course rubric with details">
  Creates a new rubric for a specific course in blackboard learn. this endpoint allows instructors or course designers to define a structured evaluation tool with customizable criteria, performance levels, and scoring methods. the rubric can be used for various assessment types, including assignments, discussions, and projects. it supports different rubric types (numeric, percentage, range-based) to accommodate diverse grading needs. the created rubric can include detailed descriptions for each performance level and criterion, ensuring clear expectations and consistent grading across evaluators. this tool is essential for setting up comprehensive and transparent assessment frameworks within blackboard courses.
</Accordion>

<Accordion title="Create group set">
  Creates a new group set within a specified course in the blackboard learn platform. this endpoint allows instructors or administrators to set up a structured group of students for collaborative work, discussions, or other course activities. the group set can be configured with various settings controlling its visibility, enrollment method, and description. use this when you need to organize students into groups for project work, facilitate peer reviews, or create focused discussion spaces within a course. it's particularly useful for larger classes where multiple small groups are needed for effective collaboration and management.
</Accordion>

<Accordion title="Create term with availability and description">
  Creates a new term in the blackboard learn system with the specified attributes. this endpoint allows administrators to define academic periods or sessions, setting up the structure for courses and student enrollments. it provides options for customizing term availability and duration, which is crucial for managing access to educational content over time. the created term can be associated with a specific data source, enabling integration with external systems. use this endpoint when setting up a new academic year, semester, or any other defined study period in your institution's blackboard environment.
</Accordion>

<Accordion title="Update user observer">
  Updates the observer relationship between a user and an observer in the blackboard learn platform. this endpoint is used to modify existing observer connections, such as changing the level of access or updating the relationship status between a student and a parent/guardian. it should be used when there's a need to adjust the monitoring permissions or details of an established observer relationship. the endpoint doesn't create new observer relationships; it only modifies existing ones. note that this operation may have implications on privacy settings and data access within the blackboard environment.
</Accordion>

<Accordion title="Create a new course">
  Creates a new course in the blackboard learn system with specified attributes and settings. this endpoint allows for the detailed configuration of a course, including its basic information, availability, enrollment options, and localization settings. it supports both classic and ultra course views and provides flexibility in defining course duration, access control, and integration with external systems. use this endpoint when setting up a new course or organization within blackboard, ensuring all required parameters are provided and optional parameters are used as needed to fully customize the course setup.
</Accordion>

<Accordion title="Update course category details">
  This endpoint updates an existing course within a specific category in the blackboard catalog. it allows administrators or authorized users to modify course details such as title, description, or other attributes associated with the course. the endpoint should be used when changes need to be made to a course that is already placed within a category in the catalog structure. it's important to note that this endpoint only updates existing courses and cannot be used to create new courses or move courses between categories. proper authorization is likely required to perform this operation, as it involves modifying the course catalog.
</Accordion>

<Accordion title="Post course message with bbml support">
  Creates a new message within a specific blackboard course. this endpoint allows users to compose and send messages to course participants, supporting rich text formatting through bbml, file attachments, and flexible recipient management. it's ideal for course announcements, discussions, or direct communication between instructors and students. the endpoint should be used when there's a need to initiate or continue a conversation within the context of a particular course. it provides comprehensive options for message creation, including subject, body content with rich formatting, recipient lists (to, cc, bcc), and file attachments. however, it does not support scheduling messages for future delivery or sending to recipients outside the course context.
</Accordion>

<Accordion title="Add child node in hierarchy">
  Creates a new child node within the institutional hierarchy of blackboard learn. this endpoint allows administrators to expand and organize the structure of their educational institution by adding new nodes as children of existing ones. it is particularly useful for creating department, faculty, or program-level nodes within a larger institutional framework. the endpoint requires at least a title for the new node and can optionally include an external id, description, and specific parent id. use this when you need to add a new organizational unit or level to your institution's hierarchy in blackboard.
</Accordion>

<Accordion title="Update child course in parent">
  This endpoint updates the relationship between a parent course and its child course in the blackboard learning management system. it is used to modify existing course hierarchies, allowing administrators to restructure course organizations or adjust course relationships. the endpoint should be used when there's a need to change the parent-child association between two courses, such as moving a sub-course to a different parent course or updating the hierarchical structure of courses. it's important to note that this endpoint only modifies existing relationships and does not create new courses or new child-parent associations if they don't already exist in some form.
</Accordion>

<Accordion title="Delete course by courseid">
  Deletes a specific course from the blackboard learn platform. this endpoint should be used when an administrator or authorized user needs to permanently remove a course from the system, including all associated content, enrollments, and data. it is particularly useful for cleaning up old or unused courses, or when restructuring the course catalog. caution should be exercised when using this endpoint, as the deletion is irreversible and will result in the loss of all course-related information. this operation may have significant implications for student records and institutional data, so it should only be used after careful consideration and in compliance with institutional policies.
</Accordion>

<Accordion title="Post grade notation to course gradebook">
  Creates a new grade notation in the gradebook for a specific course in blackboard. this endpoint allows instructors or administrators to add custom performance codes and their corresponding descriptions to the grading system. it's particularly useful for implementing non-standard grading schemes or providing additional context to traditional letter or number grades. the created grade notation can then be used when assigning grades to students, offering more nuanced feedback on their performance. this tool should be used when setting up or modifying the grading structure for a course, especially in cases where standard grading notations are insufficient to capture the full range of student performance or special grading circumstances.
</Accordion>

<Accordion title="Upload file to attempt in gradebook">
  This endpoint allows for the upload and attachment of files to a specific attempt within a course's gradebook in the blackboard learning management system. it is used to associate submitted work, supporting documents, or any relevant files with a student's attempt on an assignment, quiz, or other assessable items. the endpoint should be called after the initial file upload process, using the generated uploadid to link the file to the specific attempt. it's particularly useful for instructors or system integrators who need to programmatically attach files to student submissions, or for building custom submission interfaces that interact with blackboard's backend. this endpoint does not handle the actual file transfer; it assumes the file has already been uploaded to blackboard's system and is now being associated with a specific attempt.
</Accordion>

<Accordion title="Create course gradebook schema">
  Creates a new gradebook schema for a specific course in blackboard learn. this endpoint allows instructors or administrators to define custom grading structures tailored to their course needs. it supports various grading scales including percentage, score-based, tabular (letter grades), text-based, and complete/incomplete systems. the created schema can then be applied to assignments and other gradable items within the course. this tool is essential for setting up the grading framework at the beginning of a course or when implementing a new grading strategy. it should be used carefully as it forms the foundation for grade calculations and student grade representations throughout the course.
</Accordion>

<Accordion title="Submit gradebook attempt">
  Creates a new attempt for a specific gradebook column in a blackboard course. this endpoint allows instructors or authorized users to add a new attempt record for a student's assignment or assessment. it can be used to manually enter grades, provide feedback, or update the status of an attempt. the endpoint is particularly useful for managing individual student submissions, entering grades for offline assignments, or updating attempt statuses in bulk. note that some fields, such as the attemptreceipt, are read-only and will be generated by the system rather than accepted as input.
</Accordion>

<Accordion title="Create child content in course">
  Creates a new content item within a specified course and parent content in the blackboard learn platform. this endpoint allows for the creation of various types of content, such as documents, external links, folders, and assignments. it provides extensive control over content properties, including title, body, description, availability, and positioning within the course structure. the endpoint supports rich text formatting through bbml and offers features like review status and adaptive release settings. it should be used when adding new materials, resources, or organizational elements to a course. note that the content type is determined by the contenthandler, and some properties may have different effects depending on the course experience (classic vs. ultra).
</Accordion>

<Accordion title="Create group in course">
  Creates a new group within a specified course group set in the blackboard learn platform. this endpoint allows instructors or administrators to set up groups with customizable settings for student collaboration and activities. it provides options for controlling group availability, enrollment methods, and detailed descriptions using bbml formatting. use this endpoint when you need to create structured student groups within a course, whether for project work, discussions, or other collaborative activities. the created group can be configured for instructor-managed enrollment or student self-enrollment, with optional signup sheets and member visibility settings.
</Accordion>

<Accordion title="Create new user profile">
  Creates a new user account in the blackboard learn system with detailed profile information. this endpoint allows for the creation of user profiles with comprehensive data, including personal details, educational information, institutional and system roles, contact information, and localization preferences. it should be used when adding new users to the system, such as during student enrollment, faculty onboarding, or administrative staff addition. the endpoint requires at least the user's name, username, and password, but allows for extensive customization of the user profile with optional fields. it's important to note that some fields have specific formats or enumerated values that must be adhered to for successful user creation.
</Accordion>

<Accordion title="Update course information by courseid">
  The patchcourse endpoint allows for updating specific details and settings of an existing course in the blackboard learn system. it is used when modifications to course properties such as name, description, availability, enrollment options, or localization settings are needed. this endpoint supports partial updates, meaning only the fields that require changes need to be included in the request body. it's particularly useful for making adjustments to course settings after initial creation or for updating course information based on changes in the academic calendar or institutional policies. however, it's important to note that some settings, like allowing guests or observers, are only modifiable for classic courses, and certain operations may be restricted when a course is in a closed and complete state.
</Accordion>

<Accordion title="Create a class course">
  Creates a new course in the blackboard learn system with specified settings and configurations. this endpoint allows administrators or instructors to set up a course with various parameters including its basic information, availability, enrollment options, and localization settings. it's particularly useful when setting up new courses for an academic term or creating specialized learning environments. the endpoint requires at minimum a course id and name, but offers extensive customization through optional parameters. it's important to note that some settings, like ultra status, can significantly impact the course's interface and functionality, so careful consideration should be given when configuring these options.
</Accordion>

<Accordion title="Update institutional hierarchy user node">
  Updates a user's information or association within a specific node of the institutional hierarchy in blackboard. this endpoint is used to modify a user's relationship or details within a particular organizational unit, such as a department, school, or other institutional division. it allows for the management of user data in the context of the institution's structure, enabling administrators to keep user information accurate and up-to-date within the hierarchy. this tool should be used when there's a need to change a user's status, role, or other attributes specific to their position within a certain part of the institution. it's particularly useful for large educational organizations with complex hierarchical structures.
</Accordion>

<Accordion title="Delete adaptive release rule criterion">
  Deletes a specific criterion from an adaptive release rule for a content item within a blackboard course. this endpoint allows instructors or course administrators to remove individual conditions that control when content becomes available to students. use this when you need to modify an existing adaptive release rule by removing a particular criterion, such as a date restriction or grade requirement. the deletion is permanent and cannot be undone, so use with caution. this operation does not affect other criteria within the same rule or other rules applied to the content item.
</Accordion>

<Accordion title="Delete course content group by id">
  This endpoint deletes a specific group associated with a content item within a blackboard course. it is used to remove group assignments or collaborations tied to particular course content. the operation is irreversible and should be used with caution, as it will permanently remove the group's association with the content item. this can affect student access and collaboration settings for the specified content. the endpoint should be used when reorganizing course structure, removing outdated group assignments, or cleaning up course content. it does not delete the content item itself or the course, only the group's association with the content. note that this operation may impact students currently assigned to the group, potentially affecting their access to the content item.
</Accordion>

<Accordion title="Delete user criterion from course content rule">
  Removes a specific user from an adaptive release rule criterion for a particular content item within a course. this endpoint is used to modify the conditions under which course content is made available to individual students. it should be used when an instructor or administrator wants to exclude a user from a previously set adaptive release criterion. this action may be necessary when updating course accessibility or correcting mistakenly applied criteria. the endpoint does not provide information about the rule or criterion itself, nor does it return any data about the removed user. it's important to note that this operation is irreversible, and re-adding the user would require a separate api call.
</Accordion>

<Accordion title="Delete lti domain by id">
  Deletes a specific lti (learning tools interoperability) domain from the blackboard learning management system. this endpoint is used to remove an existing domain configuration, which may include associated lti tool integrations and settings. it should be used when an institution needs to discontinue the use of a particular lti domain, perhaps due to changes in tool usage, administrative restructuring, or cleanup of unused integrations. caution should be exercised when using this endpoint, as deletion is permanent and may affect existing course content or tool accessibility that relies on the deleted domain.
</Accordion>

<Accordion title="Delete course content attachment">
  Deletes a specific attachment from a content item within a course in blackboard learn. this endpoint should be used when an instructor or authorized user needs to remove an attachment from course materials. it permanently removes the specified attachment from the content, and this action cannot be undone. the endpoint requires precise identification of the course, content item, and attachment using their respective ids. it's important to note that this operation only removes the attachment and does not affect the content item itself or other attachments.
</Accordion>

<Accordion title="Delete category by type and id">
  This endpoint deletes a specific category from the blackboard catalog based on the provided category type and id. it should be used when an administrator or authorized user needs to remove a category that is no longer needed or relevant. the operation is permanent and cannot be undone, so it should be used with caution. this endpoint is particularly useful for catalog maintenance, such as removing outdated course categories or reorganizing the catalog structure. it does not return any content upon successful deletion, typically responding with a 204 no content status. be aware that deleting a category may affect related items or sub-categories, depending on the blackboard system's configuration.
</Accordion>

<Accordion title="Delete user course meetings">
  Deletes all meeting attendance records for a specific user within a particular course in the blackboard system. this endpoint is used when an administrator or instructor needs to remove all attendance data for a student, which may be necessary for course transfers, data corrections, or privacy compliance. it should be used with caution as it permanently removes all attendance records for the specified user in the given course. this operation cannot be undone, so it's important to verify the necessity of this action before proceeding. the endpoint does not provide any information about the deleted records or return a list of affected meetings.
</Accordion>

<Accordion title="Delete user from course meetings">
  This endpoint removes a user from a meeting within a specific course in the blackboard learning management system. it should be used when an administrator or instructor needs to revoke a user's access to a particular course meeting, such as when a student drops a course or a teaching assistant's role changes. the operation is permanent and cannot be undone through this api, so it should be used with caution. this endpoint does not provide any information about the success of the operation or the current state of the meeting after the deletion.
</Accordion>

<Accordion title="Delete course meeting">
  Deletes all meetings associated with a specific course in the blackboard learn platform. this endpoint should be used when an instructor or administrator needs to remove virtual sessions or scheduled meetings from a course, potentially at the end of a term or when restructuring the course schedule. it's important to note that this operation may be irreversible and could affect all meetings linked to the specified course. use with caution, as it might impact student access to past or upcoming virtual sessions. the endpoint does not provide options for selective deletion of individual meetings, so it should only be used when intending to remove all meetings from the course.
</Accordion>

<Accordion title="Delete gradebook period by course id">
  Deletes a specific gradebook period from a course in the blackboard learning management system. this endpoint allows administrators or instructors to remove a grading period that is no longer needed or was created in error. it should be used when restructuring the gradebook's temporal organization or when cleaning up unused grading periods. this operation is permanent and cannot be undone, so it should be used with caution. the endpoint does not return the deleted data, only performs the deletion action.
</Accordion>

<Accordion title="Delete institution node admin">
  Removes an administrator's access from a specific node in the institutional hierarchy of blackboard learn. this endpoint should be used when you need to revoke administrative privileges for a user at a particular level of the institution's structure. it's particularly useful for managing access control and maintaining the security of the institutional hierarchy. the operation is permanent and immediate, so it should be used with caution. this endpoint does not delete the user account itself; it only removes the administrative role for the specified node. note that this action may affect the user's ability to manage courses, users, or other resources associated with the given node and its sub-nodes.
</Accordion>

<Accordion title="Delete calendar item by type and id">
  This endpoint deletes a specific calendar item from the blackboard learn system. it allows users to remove events from personal, course, organization, or institution calendars. the endpoint should be used when a calendar item needs to be permanently removed from the system, such as canceling an event or correcting erroneously created entries. it's important to note that this operation is irreversible, and once an item is deleted, it cannot be recovered through the api. users should exercise caution when invoking this endpoint to avoid unintentional loss of calendar data. the endpoint requires precise identification of the calendar item through its type and unique id, ensuring accurate removal of the intended event.
</Accordion>

<Accordion title="Delete user from institutional node">
  This endpoint removes a specified user from a particular node within the institutional hierarchy of blackboard learn. it is used to disassociate a user (such as a student, faculty member, or staff) from a specific organizational unit (e.g., school, department, or program) in the institution's structure. this operation is typically performed when a user no longer needs access to or association with a particular part of the institution, such as when a student changes departments or a faculty member leaves a specific program. the endpoint does not delete the user from the system entirely, but only removes their association with the specified node. it's important to note that this action may affect the user's access rights and visibility within the blackboard learn environment related to the specific node.
</Accordion>

<Accordion title="Delete course grade notation by id">
  Deletes a specific grade notation from a course's gradebook in blackboard learn. this endpoint should be used when an instructor or administrator needs to remove an existing grade notation that is no longer relevant or was created in error. it permanently removes the specified grade notation from the system, so it should be used with caution. this operation cannot be undone, so it's important to verify the correct gradenotationid before deletion. the endpoint does not return the deleted data; it typically only confirms the successful deletion or reports an error if the deletion fails.
</Accordion>

<Accordion title="Delete data source by id">
  Deletes a specific data source from the blackboard learn platform. this endpoint should be used when an administrator needs to permanently remove a data source, such as those related to users, courses, or enrollments, from the system. it's crucial to use this endpoint with caution as the deletion is irreversible and may impact associated data. this operation is particularly useful for cleaning up obsolete or erroneous data sources, but should not be used on active data sources that are still in use. note that deleting a data source does not automatically remove the data that was previously associated with it.
</Accordion>

<Accordion title="Delete course group by ids">
  This endpoint deletes a specific group from a course in the blackboard learning management system. it is used to remove a group that is no longer needed or has been created in error. the operation is permanent and cannot be undone, so it should be used with caution. this endpoint is particularly useful for course administrators or instructors who need to manage group structures within their courses. it should not be used to temporarily disable a group; instead, it permanently removes the group and all associated data from the course. note that this action does not affect the individual user accounts of group members, only the group itself within the specified course.
</Accordion>

<Accordion title="Delete announcement by id">
  Deletes a specific announcement from the blackboard learning management system (lms) using its unique identifier. this endpoint should be used when an instructor, administrator, or authorized user needs to permanently remove an announcement from a course or the system. it's particularly useful for managing outdated information or correcting mistakenly posted announcements. the deletion is irreversible, so users should exercise caution when invoking this endpoint. this tool does not provide a way to archive or recover deleted announcements, nor does it return the content of the deleted announcement.
</Accordion>

<Accordion title="Delete course from category list">
  Removes a specific course from a designated category within the blackboard learning management system (lms) catalog. this endpoint is used when you need to disassociate a course from a particular category, which can be useful for reorganizing the course catalog, updating course classifications, or managing access control based on categories. it should be used cautiously as it permanently removes the course-category association. this operation does not delete the course itself from the system; it only removes the association between the course and the specified category. the endpoint requires precise identification of both the category (through categorytype and categoryid) and the course (through courseid) to ensure accurate removal of the correct association.
</Accordion>

<Accordion title="Delete course assessment question">
  Deletes a specific question from an assessment within a blackboard course. this endpoint allows instructors or course administrators to remove individual questions from existing assessments, which can be useful for updating or refining assessment content. the operation is permanent and cannot be undone, so it should be used with caution. this endpoint is particularly useful when modifying assessments after they've been created, such as removing outdated or incorrect questions. it should not be used to temporarily hide questions; instead, consider using other blackboard features for that purpose. note that deleting a question may affect the overall structure and scoring of the assessment, so it's important to review and adjust the assessment settings after using this endpoint.
</Accordion>

<Accordion title="Delete pronoun by id">
  Deletes a specific pronoun setting from the blackboard learning management system. this endpoint is used to remove a user's pronoun preference from the system, identified by a unique pronounid. it should be used when a pronoun setting is no longer needed, such as when a user wants to change their pronoun preference or when an administrator needs to remove an incorrect or outdated setting. the operation is irreversible, so caution should be exercised when using this endpoint. it's important to note that this endpoint only deletes the pronoun setting and does not affect any other user data or settings in the system.
</Accordion>

<Accordion title="Delete course by id">
  Deletes a specific course from the blackboard learning management system. this endpoint permanently removes all course data, including content, assignments, and student records associated with the specified course. it should be used with caution, typically at the end of an academic term or when a course is no longer needed. once a course is deleted, it cannot be recovered through the api. this operation is irreversible and should only be performed by users with appropriate permissions, such as system administrators or course managers.
</Accordion>

<Accordion title="Delete all records in meeting">
  Deletes all attendance records in the course meeting for a given meeting id. the 'course.attendance.delete' entitlement is required to delete attendance records. **since**: 3500.7.0
</Accordion>

<Accordion title="Delete lt i placement by id">
  This endpoint deletes a specific learning tools interoperability (lti) placement from the blackboard learn platform. lti placements define where and how external learning tools are integrated within the blackboard user interface. use this endpoint when you need to remove an lti tool integration from a specific location in the blackboard environment. this action is permanent and cannot be undone, so it should be used with caution. the deletion will remove the placement configuration but does not affect the lti tool provider registration itself. be aware that removing a placement may impact users who rely on the tool at that specific location within blackboard.
</Accordion>

<Accordion title="Delete gradebook attempt file">
  Deletes a specific file associated with an attempt in a course's gradebook within the blackboard learn environment. this endpoint should be used when an instructor or administrator needs to remove a file that was incorrectly uploaded or is no longer relevant to a student's attempt. it permanently removes the file from the system, so it should be used with caution. this operation cannot be undone, and the file cannot be recovered once deleted. the endpoint does not provide any information about the deleted file or confirm its previous existence.
</Accordion>

<Accordion title="Delete course rubric">
  Deletes a specific rubric associated with a given course in the blackboard learn system. this endpoint should be used when an instructor or administrator needs to permanently remove a rubric from a course, such as when the rubric is no longer relevant or has been replaced. the operation is irreversible, so caution should be exercised before deletion. this endpoint does not return the deleted rubric data; it only performs the deletion operation. it's important to note that deleting a rubric may impact any assignments or assessments that were using it, so those should be updated accordingly after deletion.
</Accordion>

<Accordion title="Delete user by id">
  This endpoint permanently deletes a user account from the blackboard learn platform. it should be used when an administrator needs to remove a user's access and information from the system, such as when a student graduates or an employee leaves the institution. the deletion is irreversible, so it should be used with caution. once deleted, all associated data, including course enrollments, submissions, and personal information, will be permanently removed. this endpoint does not provide a way to archive or temporarily deactivate a user; it only performs a complete deletion. it's crucial to verify the userid and ensure that any necessary data has been backed up before proceeding with the deletion.
</Accordion>

<Accordion title="Delete course meeting">
  This endpoint deletes a specific meeting within a course in the blackboard learning management system. it should be used when an administrator or instructor needs to remove a scheduled meeting from a course, such as cancelling a virtual class session or removing an outdated meeting entry. the operation is irreversible, so it should be used with caution. this endpoint only performs the deletion and does not return any information about the deleted meeting or provide options for rescheduling. it's important to note that this action may affect student schedules and course planning, so proper communication with course participants is advised before deleting a meeting.
</Accordion>

<Accordion title="Delete course message by id">
  This endpoint deletes a specific message within a course in the blackboard learning management system. it should be used when an instructor or authorized user needs to remove a particular message from a course's communication thread. the deletion is permanent and cannot be undone, so it should be used with caution. this tool is particularly useful for managing course content, removing outdated or inappropriate messages, or maintaining a clean communication environment within the course. note that this action may be subject to user permissions, and the ability to delete messages might be restricted to certain roles within the course.
</Accordion>

<Accordion title="Delete user observer">
  This endpoint removes a specific observer from a user's list of observers in the blackboard learning management system. it is used to terminate the observer-user relationship, revoking the observer's ability to monitor or view the specified user's activities and information. the endpoint should be called when an institution or administrator needs to discontinue an observer's access to a particular user's data, such as when a parent's observing privileges for a student are revoked or when a teacher's monitoring of a student is no longer required. this operation is irreversible, and re-establishing the observer relationship would require creating a new connection. the endpoint does not provide any information about the observer or user; it simply performs the deletion of the relationship.
</Accordion>

<Accordion title="Delete attendance record">
  Delete attendance record for meeting.it will delete meeting attendance within a course meeting. the 'course.attendance.delete' entitlement is required to delete attendance record. **since**: 3500.7.0
</Accordion>

<Accordion title="Delete rubric association">
  Deletes a specific rubric association within a course in the blackboard learn platform. this endpoint removes the link between a rubric and its associated item (such as an assignment or assessment) in a given course. it should be used when an instructor or administrator needs to disassociate a rubric from a particular course item, perhaps due to changes in assessment criteria or course structure. this operation is permanent and cannot be undone, so it should be used with caution. the endpoint does not return any content upon successful deletion, indicating that the association has been removed from the system.
</Accordion>

<Accordion title="Delete term by termid">
  The deleteterm endpoint removes a specific academic term from the blackboard learning management system. it should be used when an administrator needs to permanently remove a term that is no longer needed, such as an outdated or erroneously created term. this operation is irreversible and will delete all associated data for the specified term, including course associations and enrollment information. it's crucial to use this endpoint with caution, as it may have far-reaching consequences on the institution's academic records and student data. before deletion, ensure that all necessary data has been backed up or migrated if required.
</Accordion>

<Accordion title="Download course content attachment">
  Downloads a specific attachment from a course's content in the blackboard learning management system. this endpoint retrieves the file associated with the given attachmentid, which is linked to a particular content item (contentid) within a specific course (courseid). it's useful for programmatically accessing course materials, such as lecture slides, assignment documents, or supplementary resources. the endpoint returns the raw file data, allowing for direct download or further processing of the attachment content.
</Accordion>

<Accordion title="Delete institutional hierarchy node by nodeid">
  Deletes a specific node from the institutional hierarchy in blackboard learn. this endpoint should be used when an administrator needs to remove a node, such as a department, school, or program, from the institution's organizational structure. it permanently removes the specified node and its association within the hierarchy. caution should be exercised when using this endpoint, as deleting a node may have cascading effects on courses, users, or other entities associated with that node. it's important to note that this operation cannot be undone, so it should only be used when you are certain that the node and its data are no longer needed.
</Accordion>

<Accordion title="Delete group in course">
  This endpoint deletes a specific group within a course in the blackboard learning management system. it is used to remove a group that is no longer needed or to clean up the course structure. the operation is permanent and cannot be undone, so it should be used with caution. this endpoint is particularly useful for instructors or administrators who need to manage course organization, especially when restructuring group activities or at the end of a term. it does not provide any information about the deleted group or its members; it simply removes the group from the course.
</Accordion>

<Accordion title="Delete gradebook column by id">
  Deletes a specific gradebook column from a course in the blackboard learn system. this endpoint should be used when an instructor or administrator needs to permanently remove a column from the gradebook, such as when a graded item is no longer relevant or was created in error. it's important to note that this action is irreversible and will permanently delete all associated grade data for all students in the course. use this endpoint with caution, as it may have significant implications for course grading and student records. this operation cannot be undone, so it's recommended to have a backup of the data before proceeding with the deletion.
</Accordion>

<Accordion title="Delete course content by id">
  Deletes a specific content item from a course in the blackboard learning management system. this endpoint should be used when an administrator or authorized user needs to remove outdated, incorrect, or unnecessary learning materials from a course. it permanently removes the specified content, so it should be used with caution. this operation cannot be undone, and once content is deleted, it cannot be recovered through the api. the endpoint requires both a valid course id and content id to function correctly.
</Accordion>

<Accordion title="Retrieve user grades for course column">
  Retrieves the grades for all users associated with a specific gradebook column in a particular blackboard course. this endpoint is useful for instructors or administrators who need to access and analyze grade data for a single assignment or grade item across all students in the course. it provides a comprehensive view of student performance for a specific graded component. the tool should be used when there's a need to review or export grades for a particular assignment, quiz, or other graded item. it does not modify any grade data and is intended for read-only operations. note that the response will likely include sensitive student information, so proper authorization and data handling practices should be observed.
</Accordion>

<Accordion title="Delete user from course group">
  Removes a specific user from a particular group within a course in the blackboard learning management system. this endpoint is used when an instructor or administrator needs to remove a student or participant from a group, perhaps due to course changes, group reorganization, or student withdrawal. it's important to note that this action only removes the user from the specified group, not from the entire course. use this endpoint with caution, as it immediately revokes the user's access to group-specific content and collaborations.
</Accordion>

<Accordion title="Retrieve course attempt file">
  Retrieves a specific file associated with a student's attempt in a course's gradebook within the blackboard learn system. this endpoint allows authorized users, such as instructors or administrators, to access individual files submitted as part of a student's assignment or assessment attempt. it can be used to review submitted work, download attachments, or verify file contents for grading purposes. the endpoint requires precise identification of the course, attempt, and file, ensuring accurate and secure access to the requested gradebook data.
</Accordion>

<Accordion title="Delete specific course node">
  Removes a specific course from a designated node in the institutional hierarchy of blackboard learn. this endpoint is used for managing the organizational structure of courses within an institution's blackboard environment. it allows administrators to disassociate a course from a particular hierarchical node, which can be useful for reorganizing content, archiving old courses, or correcting misplaced courses. the operation is permanent and should be used with caution, as it may affect the visibility and accessibility of the course within the institutional structure. this endpoint does not delete the course itself from the system; it only removes the association between the course and the specified hierarchical node.
</Accordion>

<Accordion title="Delete group set in course">
  This endpoint deletes a specific group set within a course in the blackboard learning management system. it permanently removes the entire group set, including all associated groups and their memberships, from the specified course. this operation should be used with caution as it cannot be undone and will affect all students assigned to groups within the set. the endpoint is particularly useful for instructors or administrators who need to restructure group assignments or remove outdated group configurations. it should not be used to temporarily disable group functionality, as deletion is permanent. note that this operation does not affect the course structure itself or any other group sets within the course.
</Accordion>

<Accordion title="Update user grade details by course">
  Updates a specific user's grade information within a course's gradebook column in the blackboard learning management system. this endpoint allows instructors or authorized users to modify various aspects of a student's grade, including the textual representation, numerical score, private notes, student feedback, and exemption status. it's particularly useful for manual grade columns or when grades have been manually overridden in attempt-based columns. the endpoint provides flexibility in grading practices, enabling detailed feedback and grade management for individual students within a course.
</Accordion>

<Accordion title="Fetch course category by id">
  Retrieves a list of categories for a specific course within the blackboard learning management system. this endpoint allows developers to access the organizational structure of a course, providing information about how content is categorized and arranged. it should be used when there's a need to understand or display the content structure of a blackboard course, such as for content navigation or course mapping purposes. the endpoint focuses solely on category information and does not return the actual content within these categories. it's particularly useful for applications that need to mirror or interact with blackboard's course organization.
</Accordion>

<Accordion title="Get gradebook column details">
  Retrieves detailed information about a specific gradebook column for a particular course in the blackboard learning management system. this endpoint allows educators and administrators to access the configuration and content of individual grading components within a course's gradebook. it should be used when detailed information about a specific grading column is needed, such as its name, points possible, visibility settings, or associated assignments. the endpoint does not modify any data and is suitable for read-only operations. it's important to note that this endpoint only provides information for a single column and does not return data about student grades or submissions.
</Accordion>

<Accordion title="Delete course content adaptive release rule">
  Removes a specific group from a criterion within an adaptive release rule for a particular content item in a blackboard course. this endpoint is used to modify the access conditions for course content by eliminating a group's inclusion in the release criteria. it should be used when an instructor or course administrator wants to adjust the visibility rules for content, specifically by removing a group's access under certain conditions. this operation is permanent and immediately affects the adaptive release settings for the specified content.
</Accordion>

<Accordion title="Retrieve course content adaptive release rule criterion">
  Retrieves detailed information about a specific criterion within an adaptive release rule for a particular content item in a blackboard learn course. this endpoint allows instructors or administrators to examine the conditions set for releasing content to students. it should be used when reviewing or troubleshooting adaptive release settings, or when preparing to modify existing criteria. the tool provides granular access to individual criterion details, enabling precise management of content availability. note that this endpoint only retrieves information and does not modify any settings.
</Accordion>

<Accordion title="Fetch user criteria from course content rule">
  Retrieves a list of users who meet a specific criterion within an adaptive release rule for a particular content item in a blackboard learn course. this endpoint is used to identify which users have satisfied the conditions set by the adaptive release criterion, allowing administrators or instructors to monitor and manage access to course content. it's particularly useful for tracking student progress, assessing the effectiveness of adaptive release strategies, and ensuring that content is being accessed as intended. the endpoint does not modify any data or grant access; it only provides information about which users currently meet the specified criterion.
</Accordion>

<Accordion title="Fetch gradebook attempt files">
  Retrieves the files associated with a specific gradebook attempt for a given course in the blackboard learning management system. this endpoint allows access to student-submitted files for a particular assignment or assessment attempt. it is useful for instructors or systems integrating with blackboard to review submissions, facilitate grading processes, or archive student work. the endpoint should be used when there's a need to access the actual file content of student submissions, rather than just metadata about the attempt. note that this endpoint only provides access to files and does not include other attempt details such as scores or feedback.
</Accordion>

<Accordion title="Retrieve user meetings in course">
  Retrieves detailed information about a specific user's participation or engagement in meetings for a particular course within the blackboard learning management system. this endpoint is useful for instructors, administrators, or analytics tools to gather data on individual student involvement in course activities. it should be used when detailed user-level meeting data is required, such as for attendance tracking, participation analysis, or performance evaluation. the endpoint will not provide aggregate course data or information about users not associated with the specified course. it's important to note that the exact details returned may depend on the course settings and the user's role within the course.
</Accordion>

<Accordion title="Retrieve rubric evaluation by association">
  Retrieves the evaluations associated with a specific rubric for a particular course and rubric association in the blackboard learning management system. this endpoint is designed for instructors, administrators, or authorized personnel to access and review assessment data based on predefined rubric criteria. it should be used when detailed evaluation information is needed for a specific course, rubric, and its application context (association). the endpoint provides a targeted view of assessment data, focusing solely on the evaluations tied to the specified parameters. it does not modify any data and is intended for read-only access to evaluation information.
</Accordion>

<Accordion title="Retrieve attempt receipt by id">
  Retrieves detailed information about a specific attempt receipt in the blackboard learning management system. this endpoint allows users to access data related to a student's attempt on an assessment, test, or other evaluated activity. it should be used when detailed information about a particular attempt is needed, such as for reviewing student performance, grading, or addressing disputes. the endpoint provides a snapshot of the attempt, which may include timestamps, scores, and other relevant metadata. it does not modify any data and is intended for read-only access to attempt information.
</Accordion>

<Accordion title="Get announcement by id">
  Retrieves a specific announcement from the blackboard learn platform using its unique identifier. this endpoint allows users to fetch detailed information about a single announcement, such as its title, content, publication date, and author. it's particularly useful when you need to display or process information about a known announcement. the endpoint should be used when you have the specific id of an announcement and require its full details. note that this endpoint only retrieves existing announcements and cannot be used to create, modify, or delete announcements.
</Accordion>

<Accordion title="List announcements">
  Retrieves a list of announcements from the blackboard learn platform. this endpoint allows users to fetch announcements, which are important messages or updates shared within courses or across the institution. it can be used to display recent announcements to students, instructors, or administrators, keeping them informed about course-related information, deadlines, or institutional news. the endpoint supports optional filtering by course and pagination of results. it's particularly useful for building dashboards, notification systems, or integrating blackboard announcements into external applications. note that the specific content and visibility of announcements may depend on the user's role and permissions within the blackboard learn system.
</Accordion>

<Accordion title="Get calendars">
  Get the list of calendars. this endpoint will return all calendars viewable by the user. all users can request a list of calendars viewable to them. **since**: 3400.9.0
</Accordion>

<Accordion title="Fetch rubric evaluation for group attempt column">
  Retrieves the rubric evaluations for a specific group attempt within a gradebook column of a blackboard course. this endpoint is designed to fetch detailed assessment data based on predefined rubric criteria for group assignments or projects. it should be used when instructors or authorized users need to access or review the structured feedback and scoring for a particular group's work. the tool is particularly useful for courses that incorporate collaborative assignments and utilize rubrics for standardized evaluation. it provides a comprehensive view of how a group's work was assessed across various rubric criteria, enabling thorough analysis of group performance and facilitating transparent grading practices. note that this endpoint specifically deals with group attempts, so it may not be suitable for individual student assessments or non-rubric based evaluations.
</Accordion>

<Accordion title="Get course meeting download url">
  Retrieves a download url for meeting-related resources within a specific blackboard course. this endpoint should be used when access to downloadable content associated with course meetings is required, such as meeting recordings, shared documents, or other meeting-specific materials. the tool returns a url that can be used to download the meeting resources, allowing for easy access to important course-related content. it's important to note that this endpoint only provides the url for downloading and does not actually transfer the file content. the specific type of meeting resources available may vary depending on the course configuration and meeting settings in blackboard.
</Accordion>

<Accordion title="Fetch calendar item by type and id">
  Retrieves detailed information about a specific calendar item from the blackboard learning management system. this endpoint allows you to fetch data for a single calendar entry, such as an event, appointment, or assignment, based on its type and unique identifier. use this when you need to access or display comprehensive information about a particular item in a user's or course's calendar. the endpoint is particularly useful for building integrations that sync calendar data or for displaying detailed event information in external applications. note that this endpoint only retrieves existing calendar items and cannot be used to create, modify, or delete calendar entries.
</Accordion>

<Accordion title="Get course content group details">
  Retrieves detailed information about a specific group within a content item of a course in the blackboard learn platform. this endpoint is used to access group-related data, such as group name, description, membership, and any associated settings or properties. it should be used when you need to fetch comprehensive information about a particular group in the context of a specific course and content item. the endpoint does not modify any data and is suitable for read-only operations. it's particularly useful for applications that need to display or process group information within the structure of blackboard's course content organization.
</Accordion>

<Accordion title="Fetch category details by id">
  Retrieves detailed information about a specific category in the blackboard catalog system. this endpoint allows users to access category data based on the category type and its unique identifier. it is useful for obtaining metadata, structure, or any other relevant information about a particular category within the educational content organization. the endpoint should be used when detailed information about a specific category is needed, such as when populating category details in a user interface or when synchronizing category information with external systems. it provides a focused view of a single category and does not return information about items within the category or related categories.
</Accordion>

<Accordion title="Retrieve category type details">
  Retrieves a list of categories from the blackboard catalog based on the specified category type. this endpoint is used to fetch organized groups of resources or content within the blackboard learn platform, such as course categories, program categories, or departmental categories. it's particularly useful for applications that need to display or manage the structure of educational content within blackboard. the endpoint should be used when you need to populate category listings, build navigation menus, or gather information about how content is organized in the blackboard system. note that this endpoint only provides category information and does not return the actual content within those categories.
</Accordion>

<Accordion title="Retrieve course content groups">
  Retrieves the groups associated with a specific content item within a blackboard course. this endpoint is useful for understanding the group structure or permissions related to particular course content. it should be used when you need to list all groups that have access to or are associated with a specific piece of content in a course. the endpoint does not modify any data and is intended for read-only operations. note that it does not provide detailed information about the groups themselves, only their association with the specified content.
</Accordion>

<Accordion title="Get course content adaptive release group criteria">
  Retrieves the groups associated with a specific criterion of an adaptive release rule for a particular content item within a blackboard course. this endpoint is used to get information about which groups are part of the conditions for releasing content based on the adaptive release feature. it's particularly useful when you need to review or audit the adaptive release settings for a course, especially the group-based criteria. the endpoint does not modify any data and is intended for read-only operations. it's important to note that this endpoint only retrieves group information for a single criterion and does not provide a comprehensive view of all adaptive release rules or criteria for the content item.
</Accordion>

<Accordion title="Fetch learning session data">
  Retrieves a list of active sessions from the blackboard learn platform. this endpoint provides information about ongoing learning activities, such as class meetings, online discussions, or interactive modules. it can be used to monitor current engagement, track attendance, or gather data on session participation. the tool is particularly useful for administrators or instructors who need an overview of active learning sessions across the platform. note that the specific details returned for each session may vary depending on the user's permissions and the session type. this endpoint does not create or modify sessions; it is for retrieval purposes only.
</Accordion>

<Accordion title="Get course meetings">
  Retrieves a list of meetings associated with a specific course in the blackboard learning management system. this endpoint is used to fetch details about scheduled meetings, such as virtual classroom sessions, office hours, or other course-related events. it provides educators and students with up-to-date information on upcoming or past meetings for a particular course. the endpoint should be used when you need to display or manage the meeting schedule for a course. it will not provide information about meetings across multiple courses or institution-wide events. the response likely includes meeting titles, dates, times, durations, and possibly attendance information, though the exact details are not specified in the schema.
</Accordion>

<Accordion title="Retrieve grade attempt by course and column id">
  Retrieves detailed information about a specific attempt for a gradebook column within a course in the blackboard learn system. this endpoint allows users to access individual submission data, such as scores, comments, or other relevant information associated with a student's attempt on a particular graded item. it is particularly useful for instructors or administrators who need to review or analyze individual student performances on assignments or assessments. the endpoint should be used when detailed information about a specific submission is required, rather than aggregate data for the entire column or course.
</Accordion>

<Accordion title="Get calendar items">
  Retrieves calendar items from the blackboard learn platform. this endpoint allows users to fetch a list of calendar events, which may include course schedules, assignment deadlines, and institution-wide events. it provides access to the integrated calendar system within blackboard learn, enabling applications to synchronize with or display blackboard calendar data. this tool is particularly useful for building applications that need to display or manage academic schedules, deadlines, and events from blackboard. note that the response may include various types of calendar items such as course events, office hours, and gradebook deadlines. the endpoint does not provide functionality for creating, updating, or deleting calendar items; it is read-only.
</Accordion>

<Accordion title="Retrieve course content by ids">
  Retrieves specific content within a blackboard course using the course id and content id. this endpoint allows users to access detailed information about a particular content item, such as a lecture, assignment, or resource, within the context of a specific course. it's useful for applications that need to display or process individual course materials. the endpoint should be used when detailed information about a specific piece of course content is required, rather than for retrieving a list of all content in a course. note that this endpoint only provides information about the content and does not include user-specific data like submission status or grades.
</Accordion>

<Accordion title="Retrieve course details">
  Retrieves detailed information about a specific course in the blackboard learn system. this endpoint is used to access course data such as title, description, availability, enrollment information, and other course-specific attributes. it's particularly useful for applications that need to display or process course information outside of the blackboard learn interface. the endpoint should be used when detailed information about a single course is required, rather than for bulk operations or listing multiple courses. note that the exact fields returned may depend on the user's permissions and the course's configuration within blackboard learn.
</Accordion>

<Accordion title="Retrieve gradebook attempts">
  Retrieves attempt data for a specific gradebook column within a course in the blackboard learn platform. this endpoint allows users to access detailed information about student attempts for a particular assessment or assignment. it's useful for analyzing student performance, tracking submission patterns, and gathering data for educational analytics. the endpoint should be used when detailed information about student interactions with a specific gradebook item is needed, but it won't provide an overview of the entire gradebook or course structure.
</Accordion>

<Accordion title="List courses">
  Retrieves a list of courses from the blackboard learning management system. this endpoint allows users to fetch information about multiple courses at once, providing an overview of the available courses within the institution's blackboard environment. it's particularly useful for applications that need to display course catalogs, manage course enrollments, or synchronize course data with external systems. the endpoint returns course-related data, which may include course ids, names, descriptions, and other relevant metadata. however, it's important to note that the exact details returned for each course are not specified in the given schema and may vary based on system configurations or user permissions. this tool should be used when you need to obtain a broad view of courses in the blackboard system, such as for course discovery or administrative purposes. it may not provide in-depth details about individual courses, which might require separate, course-specific api calls.
</Accordion>

<Accordion title="Retrieve course role by role id">
  Retrieves detailed information about a specific course role in blackboard learn using its unique identifier. this endpoint is used to fetch the properties, permissions, and settings associated with a particular role within a course. it's essential for understanding the access levels and capabilities assigned to different user types in the blackboard learning environment. use this endpoint when you need to review or verify the configuration of a course role, such as instructor, teaching assistant, or student. the returned data can be used for role management, troubleshooting access issues, or ensuring proper permissions are set for different user categories. note that this endpoint only provides read access to role information and cannot be used to modify role settings.
</Accordion>

<Accordion title="Get course resource children">
  Retrieves a list of child resources associated with a specific resource within a blackboard course. this endpoint is useful for exploring the hierarchical structure of course materials, such as folders, documents, or assignments nested within a parent resource. use this when you need to display or process the contents of a particular course resource. the endpoint returns only direct child resources and does not provide details about the parent resource itself or any grandchild resources. it's particularly helpful for building course content navigation or for analyzing the structure of course materials.
</Accordion>

<Accordion title="Fetch course roles information">
  Retrieves a list of available course roles in the blackboard learn system. this endpoint allows users to fetch all predefined roles that can be assigned to users within courses. it is useful for administrators and developers who need to understand the available role options when managing course memberships or setting up integrations. the endpoint does not create, modify, or delete roles; it only provides read access to the existing role definitions. use this endpoint when you need to display role options, validate role assignments, or gather information about the roles structure in your blackboard learn instance.
</Accordion>

<Accordion title="Get course gradebook logs">
  Retrieves the gradebook logs for a specific course in the blackboard learning management system. this endpoint provides a historical record of all gradebook-related activities and changes within the specified course. it's particularly useful for instructors and administrators who need to audit grade modifications, track changes over time, or investigate discrepancies in student grades. the logs typically include information such as the date and time of changes, the user who made the changes, and the nature of the modifications (e.g., grade updates, column additions, or deletions). this tool should be used when detailed tracking of gradebook activities is required, but it does not provide real-time grade data or allow for grade modifications.
</Accordion>

<Accordion title="Get data source by id">
  Retrieves detailed information about a specific data source within the blackboard learn platform. this endpoint allows you to access metadata and configuration details for a particular data source, which can be crucial for understanding the origin and nature of data within the blackboard ecosystem. use this endpoint when you need to verify data source information, troubleshoot data-related issues, or integrate external systems with blackboard learn. the tool provides a comprehensive view of a single data source but does not modify or create new data sources. it's particularly useful for administrators and developers working on data management and integration tasks within educational institutions using blackboard.
</Accordion>

<Accordion title="Retrieve course content release criteria">
  Retrieves the criteria associated with a specific adaptive release rule for a particular content item within a blackboard course. this endpoint allows instructors or administrators to view the conditions that must be met for students to access the content. it's useful for reviewing or auditing adaptive release settings without modifying them. the endpoint doesn't provide information about whether students have met the criteria, only the criteria themselves. use this when you need to understand or verify the access conditions for specific course content.
</Accordion>

<Accordion title="Get course gradebook group attempts">
  Retrieves group attempts data for a specific gradebook column within a course in blackboard learn. this endpoint allows users to access detailed information about group submissions, including submission dates, grades, and potentially group member contributions for a particular grading item. it is particularly useful for instructors or administrators who need to analyze group performance or review the history of group submissions for a specific assignment or grading criteria. the endpoint supports both ultra and original course views, making it versatile across different blackboard learn interfaces. use this when you need to gather comprehensive data about group work and collaborative assignments within a course's gradebook structure.
</Accordion>

<Accordion title="Get course resource">
  Retrieves a specific resource from a particular course within the blackboard learning management system. this endpoint is used to access detailed information about a single course resource, such as a document, assignment, or any other learning material. it should be used when you need to fetch the properties or content of a specific resource within a known course. the endpoint requires both the course id and resource id to be specified in the path. it's important to note that this endpoint only retrieves the resource information and does not modify or delete the resource. access to the resource may be subject to user permissions within the blackboard system.
</Accordion>

<Accordion title="Fetch data source list">
  Retrieves a list of data sources available in the blackboard learning management system. this endpoint provides information about various data sources that can be used for integrating external systems, reporting, or data analysis within the blackboard platform. it should be used when you need to obtain an overview of all available data sources or when preparing to work with specific data sets in blackboard. the endpoint does not modify any data and is safe for frequent calls, but be aware that the list of data sources may be extensive for large institutions.
</Accordion>

<Accordion title="Retrieve course child details">
  Retrieves detailed information about a specific child course within a parent course in the blackboard learn platform. this endpoint is useful for accessing hierarchical course structures, allowing developers to fetch data about nested or sub-courses. use this when you need to gather information about a particular child course, such as its name, description, or specific attributes related to its parent-child relationship. the endpoint requires both the parent course id and the child course id to uniquely identify the requested child course within the blackboard learn system.
</Accordion>

<Accordion title="Retrieve coursediscussion details">
  Retrieves detailed information about a specific discussion thread within a course on the blackboard learn platform. this endpoint allows users to access the content, metadata, and other relevant details of a discussion, enabling them to view or analyze discussion activities without directly accessing the blackboard user interface. it should be used when detailed information about a particular discussion is needed, such as for reporting, content management, or integration with other educational tools. the endpoint requires both the course id and discussion id to be specified, ensuring precise retrieval of the desired discussion data.
</Accordion>

<Accordion title="Retrieve user gradebook column">
  Retrieves a specific user's grade for a particular gradebook column in a blackboard course. this endpoint is useful for accessing individual student performance data within a course, allowing for targeted grade retrieval and analysis. it should be used when detailed grade information for a single student on a specific assignment or gradebook entry is needed. the endpoint provides focused access to gradebook data, which is particularly valuable for generating individual student reports, conducting performance reviews, or integrating with external grade management systems.
</Accordion>

<Accordion title="List child courses for a given course">
  Retrieves a list of child courses or sub-courses associated with a specified parent course in the blackboard learn platform. this endpoint is useful for exploring the hierarchical structure of courses, such as main courses and their associated sections or modules. it should be used when you need to obtain information about the sub-components of a particular course. the endpoint does not provide detailed information about the child courses; it likely returns a list of basic details such as course ids and names. it's important to note that this endpoint may not be applicable for courses without any child elements.
</Accordion>

<Accordion title="Fetch gradebook column logs">
  Retrieves the log entries for a specific gradebook column within a blackboard course. this endpoint provides a detailed history of all actions and changes made to the specified gradebook column, including grade modifications, updates to comments, and other relevant activities. it is particularly useful for auditing purposes, allowing educators and administrators to track and review the complete history of a gradebook column. the endpoint should be used when there's a need to investigate grading discrepancies, verify changes, or maintain a record of grading activities for compliance and transparency. note that this endpoint only returns logs for a single gradebook column; to get a comprehensive view of all gradebook activities, you may need to make multiple calls for different columns.
</Accordion>

<Accordion title="Get attendance record">
  Returns a course meeting attendance information for the given meeting and user id. the "course.attendance.view" entitlement is required to view a course meeting attendance. **since**: 3500.7.0
</Accordion>

<Accordion title="List gradebook columns for users">
  Retrieves user data associated with a specific gradebook column for a given course in blackboard. this endpoint allows educators and administrators to access detailed information about students' performance or participation in a particular graded item or category. it should be used when there's a need to analyze or report on student data for a specific gradebook column, such as assignment scores or participation grades. the endpoint provides a focused view of user data, limited to the context of the specified course and gradebook column, and does not include overall course performance or data from other columns.
</Accordion>

<Accordion title="Get last changed grade column for user">
  Retrieves information about the last changes made to a specific gradebook column for a particular course in blackboard. this endpoint is useful for tracking recent modifications to grades, comments, or other gradebook data, enhancing transparency and accountability in the grading process. it provides details about the most recent updates, potentially including the user who made the change and the timestamp of the modification. this tool should be used when there's a need to monitor or audit recent activity in a specific gradebook column, such as verifying when the last grade was entered or identifying who made the most recent changes. it's particularly valuable for instructors and administrators who need to keep track of grading activities and ensure the accuracy and timeliness of gradebook entries.
</Accordion>

<Accordion title="Get cross list set by course id">
  Retrieves the cross-listed course set for a specified course in blackboard learn. this endpoint is used to obtain information about courses that are linked together, typically representing different sections of the same course that share content. it's particularly useful for administrators or instructors managing multiple sections of a course with shared materials. the endpoint returns details about the cross-listed courses, which may include their ids, names, and other relevant information. use this when you need to identify or manage courses that are part of a cross-listed set. note that this endpoint only provides information about the cross-listed courses and does not modify any course data.
</Accordion>

<Accordion title="Get course discussion threads">
  Retrieves all discussions associated with a specific course in the blackboard learning management system. this endpoint allows developers to access the discussion forums and threads for a particular course, enabling integration of course discussions into external applications or custom dashboards. it's particularly useful for building tools that aggregate or analyze student engagement in course discussions. the endpoint returns a collection of discussion objects, likely including details such as discussion titles, creation dates, and potentially the number of posts or participants. it should be used when you need a comprehensive view of all discussions within a course, but note that it may not include the actual content of individual posts or replies.
</Accordion>

<Accordion title="Retrieve user sessions by user id">
  Retrieves the active or historical sessions for a specific user in the blackboard learn platform. this endpoint allows developers to access detailed information about a user's interaction with the system, including login times, duration, and potentially other session-related data. it is particularly useful for tracking user activity, analyzing engagement patterns, or implementing custom analytics for educational institutions. the endpoint should be used when there's a need to monitor or report on individual user activity within the blackboard environment. it does not provide real-time session management capabilities, such as terminating active sessions.
</Accordion>

<Accordion title="Retrieve course alignments by id">
  Retrieves the course goal alignments for a specified course in blackboard. this endpoint allows users to fetch detailed information about how course goals are linked to specific learning objectives within a particular course. it is essential for educators and administrators who need to understand or analyze the structure of course objectives and their relationships to broader educational goals. the endpoint should be used when reviewing course design, preparing for accreditation processes, or assessing curriculum coherence. it does not modify any alignments; it only provides a read-only view of the existing structure. the response likely includes a list of goals, associated objectives, and potentially metadata about these alignments.
</Accordion>

<Accordion title="Retrieve contentcollection resource">
  Retrieves a specific resource from a content collection in blackboard learn. this endpoint allows developers to access detailed information about a particular resource, such as a document, video, or other educational material, stored within blackboard's content management system. it is particularly useful when you need to retrieve metadata or content details for a known resource, perhaps to display it in a custom interface or to verify its properties. the endpoint requires a valid resourceid to function correctly and will likely return comprehensive details about the resource, including its name, type, size, and associated metadata. however, it may not provide the actual content of the resource, depending on blackboard's implementation.
</Accordion>

<Accordion title="Get attendance records by meeting id">
  Returns a list of course meeting attendance for a given meeting id. the "course.attendance.view" entitlement is required to view a course meeting attendance. **since**: 3500.7.0
</Accordion>

<Accordion title="Retrieve course contents">
  Retrieves the contents of a specific course in the blackboard learn platform. this endpoint allows you to fetch all learning materials, resources, and content items associated with a given course. it should be used when you need to access or display the structure and components of a course, such as modules, assignments, documents, or other learning objects. the endpoint provides a comprehensive view of the course content, which can be useful for building course outlines, content management interfaces, or synchronizing course materials with external systems. note that this endpoint only retrieves the content structure and metadata; it does not download the actual content files. to access specific content items, you may need to use additional api calls based on the information provided by this endpoint.
</Accordion>

<Accordion title="Retrieve children goals by id">
  Retrieves the child elements (sub-goals, tasks, or related items) of a specified goal in the blackboard learning management system. this endpoint is used to fetch the hierarchical structure of educational objectives, allowing users to view and manage the breakdown of a parent goal into its component parts. it's particularly useful for educators and administrators who need to track the progress of complex, multi-layered learning objectives or course structures. the endpoint should be used when there's a need to understand the sub-components of a specific goal or to navigate through the goal hierarchy. it will not provide detailed information about the parent goal itself, only its immediate children.
</Accordion>

<Accordion title="Retrieve catalog category children">
  Retrieves the child categories of a specified parent category within the blackboard catalog system. this endpoint allows users to navigate through the hierarchical structure of categories, which is crucial for organizing and accessing educational content. it should be used when exploring the category tree, building category-based navigation, or when needing to list subcategories of a specific parent category. the endpoint is particularly useful for applications that need to mirror or interact with blackboard's content organization structure. note that this endpoint only provides direct children of the specified parent category and does not recursively fetch all descendants.
</Accordion>

<Accordion title="Get course meeting details">
  Retrieves detailed information about a specific meeting within a course in the blackboard learning management system. this endpoint is used to fetch comprehensive data about a scheduled meeting, including its date, time, duration, participants, and any associated resources or links. it's particularly useful for applications that need to display or manage course-related events and schedules. the endpoint requires both the course id and meeting id to uniquely identify the requested meeting. it should be used when detailed information about a single meeting is needed, rather than for listing all meetings in a course.
</Accordion>

<Accordion title="Retrieve users from course">
  Retrieves a list of users enrolled in a specific course within the blackboard learning management system. this endpoint is used to access information about students, instructors, and other roles associated with a particular course. it's particularly useful for course management, generating class rosters, or analyzing course participation. the endpoint returns user details such as ids, names, roles, and enrollment statuses, but does not provide access to sensitive information like grades or private user data. use this when you need an overview of course membership or to verify enrollment status for specific users.
</Accordion>

<Accordion title="Retrieve course content children">
  Retrieves a list of child content items for a specific content within a blackboard learn course. this endpoint is used to navigate the hierarchical structure of course materials, allowing users to explore sub-items or nested content within a parent content item. it's particularly useful for building course content navigation systems or for analyzing the structure of course materials. the endpoint returns only direct children of the specified content, not deeper levels of the hierarchy. it should be used when you need to display or process the immediate sub-items of a given course content, but not for searching or retrieving specific content across the entire course.
</Accordion>

<Accordion title="Get discussion messages for course">
  Retrieves all messages within a specific discussion for a given course in the blackboard learning management system. this endpoint allows users to fetch the entire conversation thread, including all posts and replies, for a particular discussion topic. it's useful for displaying the full context of a discussion, enabling students and instructors to review past interactions, and facilitating asynchronous communication in online learning environments. the endpoint should be used when a comprehensive view of a discussion is needed, such as for moderation, grading, or catching up on missed conversations. it does not provide capabilities for posting new messages or editing existing ones; separate endpoints would be required for those actions.
</Accordion>

<Accordion title="Retrieve lti domain listings">
  Retrieves a list of lti (learning tools interoperability) domains registered with the blackboard learn platform. this endpoint is used to obtain information about the external tools and platforms that have been integrated with blackboard using the lti specification. it provides essential data for managing and troubleshooting lti integrations within the blackboard learn environment. the returned list of domains can be used to verify the correct configuration of lti tools, ensure security by checking authorized domains, and audit the current integrations. this endpoint is particularly useful for administrators and developers working on lti integrations with blackboard learn.
</Accordion>

<Accordion title="Fetch goal set category goals">
  This endpoint retrieves a list of goals associated with a specific category within a goal set in the blackboard learning management system. it allows administrators and educators to access and review the goals that have been set for a particular category, enabling them to align course objectives with institutional goals. the endpoint is useful for goal management, curriculum planning, and ensuring educational alignment across courses and programs. it should be used when there's a need to review, assess, or report on the goals within a specific category of a goal set. note that this endpoint only provides read access to the goals and does not allow for creation, modification, or deletion of goals.
</Accordion>

<Accordion title="Retrieve goal set by id">
  Retrieves detailed information about a specific goal set within the blackboard learning management system. this endpoint allows educators and administrators to access comprehensive data about a particular collection of educational objectives or targets. it should be used when there's a need to review, analyze, or integrate goal set information into other educational processes or reports. the endpoint provides a snapshot of the goal set's current state and structure but does not allow for modifications. it's particularly useful for tracking progress, aligning curricula, or generating reports on educational objectives across courses or programs.
</Accordion>

<Accordion title="Get goal set category by id">
  Retrieves detailed information about a specific goal category within a designated goal set in the blackboard learn platform. this endpoint allows users to access the properties and metadata of a particular goal category, which is useful for understanding the structure and organization of goals within a course or program. it should be used when detailed information about a specific goal category is needed, such as when displaying category details or preparing for goal management tasks. the endpoint does not modify any data and is intended for read-only operations.
</Accordion>

<Accordion title="Get course content attachment">
  Retrieves the attachments associated with a specific content item within a blackboard course. this endpoint allows users to access files, documents, or other resources that have been attached to a particular piece of course content. it's useful for applications that need to display or process course materials, such as displaying lecture slides, assignment instructions, or supplementary reading materials. the endpoint should be used when there's a need to access or download attachments related to a specific content item in a course. it will not provide the actual content itself, only the attachments linked to that content. this tool is particularly valuable for building integrations that enhance the learning experience by providing easy access to course resources.
</Accordion>

<Accordion title="Retrieve goal sets">
  Retrieves a list of goal sets from the blackboard learn platform. this endpoint allows users to fetch collections of goals, which are likely used for organizing and categorizing educational objectives within the system. it's part of the public api, making it suitable for integration with external applications or systems that need to access goal-related data. use this endpoint when you need to obtain an overview of the goal sets available in the blackboard environment. it's particularly useful for applications that manage or display educational objectives, track student progress, or provide insights into the structure of learning goals within an institution. note that this endpoint returns goal sets, not individual goals. it may not provide detailed information about the specific goals within each set. additionally, as it's a get request without parameters, it might return all available goal sets, which could be a large dataset for extensive blackboard implementations.
</Accordion>

<Accordion title="Retrieve course message folders">
  Retrieves a list of message folders for a specific course in the blackboard learning management system. this endpoint allows users to access the organizational structure of course messages, providing an overview of how communication is categorized within the course. it should be used when needing to understand the message folder hierarchy or before performing operations on specific message folders. the endpoint returns only the folder structure and does not include the actual messages within these folders. it's particularly useful for applications that need to display or manage course communication organization.
</Accordion>

<Accordion title="Get gradebook periods by course and period id">
  Retrieves detailed information about a specific gradebook period within a course in the blackboard learning management system. this endpoint allows users to access important data related to a particular grading period, such as its start and end dates, associated assignments, and any specific grading policies. it's particularly useful for instructors or administrators who need to review or manage the structure of their course's grading periods. the endpoint should be used when detailed information about a single gradebook period is required, rather than a list of all periods. note that this endpoint does not modify any data; it's for retrieval purposes only.
</Accordion>

<Accordion title="Get system info">
  Retrieves system information about the blackboard learn platform. this endpoint provides essential metadata about the current state of the blackboard system, which can include details such as the platform version, configuration settings, and operational status. it is particularly useful for administrators, developers, and integration partners who need to understand the system's capabilities, ensure compatibility, or troubleshoot issues. the endpoint should be used when up-to-date information about the blackboard system is required, such as during initial setup, maintenance, or when developing integrations. it's important to note that this endpoint likely provides high-level system information and may not include sensitive or user-specific data.
</Accordion>

<Accordion title="Retrieve course gradebook periods">
  Retrieves the gradebook periods for a specified course in the blackboard learning management system. this endpoint allows users to fetch information about the temporal structure of grade entries and assessments within a particular course. it is useful for understanding how the course's grading is organized over time, which can be essential for course management, grade reporting, and student performance tracking. the endpoint should be used when there's a need to review or analyze the grading structure of a specific course, particularly for administrative or reporting purposes. it does not modify any data and is meant for read-only operations.
</Accordion>

<Accordion title="List course gradebook columns">
  Retrieves a list of gradebook columns for a specified course in the blackboard learn environment. this endpoint allows users to access detailed information about the structure and components of a course's gradebook. it should be used when there's a need to view or analyze the grading schema for a particular course, such as when integrating external grading tools or performing academic audits. the endpoint provides a comprehensive overview of how grades are organized within the course but does not include actual student grades or scores. it's particularly useful for understanding the weighting and categorization of different assignments and assessments within the course.
</Accordion>

<Accordion title="Retrieve course gradebook categories">
  Retrieves the list of gradebook categories for a specific course in the blackboard learning management system. this endpoint allows users to fetch the organizational structure of a course's gradebook, including the categories used to group different types of assessments and assignments. it is particularly useful for understanding how grades are organized within a course, which can aid in grade calculations, reporting, and overall course management. the endpoint should be used when there's a need to view or analyze the grading structure of a particular course, but it will not provide actual grade data for students.
</Accordion>

<Accordion title="Get hierarchy node by node id">
  Retrieves detailed information about a specific node within the institutional hierarchy of blackboard. this endpoint allows users to fetch data about a particular component or entity in the educational institution's structure. it should be used when specific information about a node, such as its attributes, relationships, or metadata, is needed. the endpoint is useful for applications that require navigation or display of the institutional hierarchy, or for integrations that need to synchronize node data with external systems. note that this endpoint only provides information for a single node; to retrieve the entire hierarchy or multiple nodes, separate api calls may be necessary.
</Accordion>

<Accordion title="Get course content attachment">
  Retrieves detailed information about a specific attachment associated with a particular content item within a blackboard course. this endpoint allows users to access metadata and potentially the content of an attachment, such as a document, image, or other file types, that has been added to course materials. it should be used when detailed information about a specific attachment is needed, such as for displaying file properties, preparing download links, or verifying attachment availability. the endpoint does not modify the attachment or course content; it is solely for retrieval purposes. note that this endpoint requires precise identification of the course, content item, and attachment, making it useful for targeted access but not for broad queries or searches across multiple courses or content items.
</Accordion>

<Accordion title="Retrieve lti domain details by domainid">
  Retrieves detailed information about a specific lti (learning tools interoperability) domain within the blackboard learn system. this endpoint is used to fetch configuration details, status, and other relevant information for a particular lti domain integration. it's particularly useful for administrators and developers who need to manage or troubleshoot lti tool integrations with blackboard. the endpoint should be used when specific information about an lti domain is required, such as verifying its configuration or checking its current status. it will not modify any domain settings; it's a read-only operation.
</Accordion>

<Accordion title="Get goal alignments by goalid">
  Retrieves the alignments associated with a specific educational goal in the blackboard learning management system. this endpoint allows users to fetch the learning activities or assessments that are linked to a particular goal, enabling educators and administrators to understand how curriculum elements are mapped to educational objectives. it should be used when there's a need to review or analyze the alignment of course content with specific learning outcomes. the endpoint provides a comprehensive view of how a goal is integrated into the curriculum but does not modify any alignment data.
</Accordion>

<Accordion title="Fetch institutional hierarchy nodes">
  Retrieves information about the nodes within the institutional hierarchy of a blackboard learning environment. this endpoint allows users to fetch data representing the organizational structure of an educational institution, such as departments, schools, or other administrative units. it's particularly useful for understanding the layout and relationships of different entities within the institution's blackboard setup. the endpoint should be used when needing to map out the institutional structure, populate organization charts, or when integrating systems that require knowledge of the institution's hierarchy. note that this endpoint only provides structural information and may not include detailed data about each node's operations or members.
</Accordion>

<Accordion title="Retrieves institution role by id">
  Retrieves detailed information about a specific institutional role in the blackboard learning management system. this endpoint should be used when you need to access the properties, permissions, or settings associated with a particular role within an educational institution. it provides valuable data for role management, user access control, and system administration tasks. the endpoint is particularly useful for administrators or developers who need to verify role configurations or integrate role-based access control into their applications. note that this endpoint only retrieves role information and cannot be used to modify or create new roles.
</Accordion>

<Accordion title="Retrieve gradebook category by id">
  Retrieves detailed information about a specific gradebook category within a course in the blackboard learning management system. this endpoint allows users to access important data about how grades are organized and weighted within a course, which is crucial for understanding the grading structure. it should be used when needing to review or verify the setup of a particular grading category, such as its name, weight in the overall grade, and potentially associated grade items. this tool is particularly useful for instructors, teaching assistants, or administrators who need to audit or manage the grading system for a course. note that this endpoint only provides information about the category itself and may not include the actual grades or student data associated with it.
</Accordion>

<Accordion title="Retrieve course nodes">
  Retrieves a list of nodes (modules or units) for a specific course in the blackboard learning management system. this endpoint allows developers to access the structure and content organization of a course, enabling them to build applications that can navigate or display course content. it should be used when there's a need to understand the layout of a course, such as for creating a course outline or building a custom course navigation interface. the endpoint focuses solely on retrieving node information and does not modify any course data. note that while this endpoint provides the structure of the course, it may not include the actual content of each node, which might require additional api calls.
</Accordion>

<Accordion title="Retrieve proctoring services">
  Retrieves a list of available proctoring services integrated with the blackboard learn platform. this endpoint is part of blackboard's proctoring services framework and is designed to support online examination security. it should be used when administrators or instructors need to view the proctoring options available for configuring secure assessments in the ultra course view. the endpoint provides information about the integrated third-party proctoring solutions but does not include details about individual exam configurations or student data. note that the actual implementation of proctoring services may require additional setup and configuration within the blackboard learn environment.
</Accordion>

<Accordion title="Fetch privacy policies">
  Retrieves the current privacy policy for the blackboard system. this endpoint provides access to the most up-to-date privacy policy information, which is crucial for understanding how user data is handled and protected within the blackboard platform. it should be used when administrators, educators, or students need to review or reference the privacy policy, especially in situations involving data protection compliance or user rights inquiries. the endpoint returns the full text of the privacy policy, but does not provide version history or allow for policy modifications.
</Accordion>

<Accordion title="Retrieve proctoring service by id">
  Retrieves detailed information about a specific proctoring service integrated with blackboard learn. this endpoint allows users to fetch configuration details, availability status, and other relevant information for a particular online exam proctoring solution. it's particularly useful for administrators and instructors who need to verify or review the settings of a proctoring service before configuring exams. the endpoint should be used when specific details about a proctoring service are required, such as during exam setup or troubleshooting integration issues. note that this endpoint only provides information about the service itself and does not include data about individual proctored exams or student sessions.
</Accordion>

<Accordion title="Get user nodes for user id">
  Retrieves a list of nodes associated with a specific user in the blackboard learn platform. nodes typically represent courses, organizations, or content areas that the user has access to. this endpoint is useful for obtaining an overview of a user's course enrollments or accessible content areas. it should be used when you need to list all the educational resources available to a particular user. the endpoint does not provide detailed information about the courses or content itself, only the basic node information and access levels.
</Accordion>

<Accordion title="List grade notations for course">
  Retrieves the grade notations for a specific course's gradebook in the blackboard learning management system. grade notations are symbols or short texts used to represent specific grading statuses or conditions (e.g., 'a', 'b+', 'incomplete', 'withdrawn'). this endpoint should be used when you need to fetch the complete list of grade notations configured for a particular course, which can be useful for understanding the grading scheme or for integrating with other systems. it does not modify any data and is typically used for reporting or display purposes. note that this endpoint only provides the notation definitions and does not return actual grades assigned to students.
</Accordion>

<Accordion title="Get learning goals">
  The getgoals endpoint retrieves a list of educational goals within the blackboard learning management system. it provides access to goal information that can be used to track student progress, align curriculum with objectives, or generate reports on learning outcomes. this endpoint is particularly useful for administrators, instructors, or integrated systems that need to assess or manage educational targets across courses or programs. the endpoint returns all available goals without requiring specific parameters, making it suitable for general goal overviews or as a first step in more detailed goal analysis. however, it may not provide granular filtering options in this version, so additional processing might be needed for specific use cases. while the endpoint is labeled as 'public', users should verify access rights as some implementations may still require authentication or have usage limitations to protect sensitive educational data.
</Accordion>

<Accordion title="Retrieve course grade notation">
  Retrieves detailed information about a specific grade notation within a course's gradebook in the blackboard learning management system. this endpoint allows users to fetch individual grade notation data, which may include the notation symbol, description, and associated grading rules. it should be used when precise information about a particular grade notation is needed, such as during grade reviews or when updating grading policies. the endpoint does not modify any data and is suitable for read-only operations. note that it only returns data for a single grade notation; to retrieve multiple notations, separate api calls would be required for each.
</Accordion>

<Accordion title="Get review status of user in course content">
  Retrieves the review status of a specific content item for a particular user within a blackboard learn course. this endpoint is useful for instructors or administrators to track whether a student has reviewed or interacted with a particular piece of course content. it can be used to monitor student engagement, ensure compliance with course requirements, or identify students who may need additional support. the endpoint does not modify any data and is intended for read-only operations. it's important to note that this endpoint only provides the review status and does not give detailed information about the user's interaction with the content.
</Accordion>

<Accordion title="Retrieve courses for institutional node">
  Retrieves a list of courses associated with a specific node in the institutional hierarchy of blackboard. this endpoint is used to fetch all courses linked to a particular organizational unit (such as a department, faculty, or program) within the educational institution's structure. it provides a way to navigate and explore the course offerings based on the hierarchical organization of the institution. the endpoint should be used when you need to list or enumerate courses for a specific segment of the institution, as defined by the hierarchy node. it does not provide detailed information about individual courses, only their association with the specified node.
</Accordion>

<Accordion title="List child nodes by node id">
  Retrieves the immediate child nodes of a specified parent node in the blackboard learn institutional hierarchy. this endpoint is used to navigate and explore the hierarchical structure of an educational institution, allowing administrators and authorized users to view the subordinate entities (such as departments, programs, or courses) under a given node. it's particularly useful for building user interfaces that display the institutional structure or for programmatically traversing the hierarchy. the endpoint returns only direct children and does not provide information about deeper levels of the hierarchy in a single call.
</Accordion>

<Accordion title="Fetch rubric list for course">
  Retrieves all rubrics associated with a specific course in the blackboard learn platform. this endpoint allows users to access the grading criteria and assessment tools set up for a particular course. it's useful for instructors, teaching assistants, or administrators who need to review, analyze, or manage the rubrics used for assignments and assessments within a course. the endpoint returns a list of rubrics, including their titles, descriptions, and criteria, which are essential for maintaining consistent and transparent grading practices. it should be used when there's a need to programmatically access or audit the assessment structure of a course. note that this endpoint only provides read access to rubrics and does not allow for creation, modification, or deletion of rubrics.
</Accordion>

<Accordion title="Retrieve participants of course message">
  Retrieves a list of participants for a specific message within a blackboard course. this endpoint allows users to access information about who is involved in a particular course message, which can be useful for tracking student engagement, managing communication, or analyzing participation patterns. it should be used when you need to know who has access to or has interacted with a specific message in a course. the endpoint does not provide the content of the message or detailed information about the participants beyond their identification within the system.
</Accordion>

<Accordion title="Retrieve discussion message reply">
  Retrieves all replies to a specific message within a discussion thread of a course in the blackboard learning management system. this endpoint allows users to access the responses and interactions related to a particular message in a course discussion. it is useful for viewing the conversation thread, monitoring student engagement, or gathering information about a specific topic within the course discussion. the endpoint should be used when there's a need to review or analyze the replies to a particular message, such as for grading participation or facilitating further discussion. it does not provide information about other messages in the discussion or allow for creating or modifying replies; it is strictly for retrieving existing replies to the specified message.
</Accordion>

<Accordion title="Retrieve course rubric associations">
  Retrieves the associations of a specific rubric within a given course in blackboard learn. this endpoint allows users to fetch information about how a particular rubric is linked to various course elements such as assignments, discussions, or other assessable items. it's useful for understanding the application of rubrics across different components of a course, aiding in consistent assessment practices. the endpoint requires both a course id and a rubric id to pinpoint the exact associations being queried. it does not create, modify, or delete associations; it only provides read access to existing rubric-course element relationships.
</Accordion>

<Accordion title="Retrieve system role by id">
  Retrieves detailed information about a specific system role in the blackboard learning management system. this endpoint should be used when you need to access the properties, permissions, or other attributes associated with a particular role. it's useful for administrators or developers who need to understand or verify the capabilities assigned to different user types within blackboard. the endpoint returns comprehensive data about the requested role, which may include its name, description, associated permissions, and any custom settings. however, it does not modify role information or provide a list of users assigned to the role.
</Accordion>

<Accordion title="Get course performance content review status">
  Retrieves the content review status for a specific course in the blackboard learning management system. this endpoint provides information about the current state of content reviews within the course, which may include details such as the number of items pending review, items that have been reviewed, or the overall progress of the review process. it is particularly useful for instructors, course designers, or administrators who need to monitor the quality assurance process of course materials. the tool should be used when there's a need to check the progress or status of content reviews for a particular course, especially in scenarios where courses undergo regular content audits or quality checks. it does not modify any course content or review status; it only retrieves the current state of reviews.
</Accordion>

<Accordion title="Retrieve pronouns information">
  Retrieves the list of available pronouns in the blackboard learning management system. this endpoint is used to fetch the predefined set of pronouns that users can choose from when setting up or updating their profile. it's particularly useful for applications that need to synchronize or display pronoun options consistent with the blackboard system. the endpoint returns all currently supported pronouns, which can be used for user interface elements like dropdown menus or form fields. it should be called when initializing user profile forms or when updating the list of available pronouns in integrated systems. note that this endpoint does not provide individual user's chosen pronouns, but rather the system-wide list of pronoun options.
</Accordion>

<Accordion title="Retrieve term by id">
  Retrieves detailed information about a specific academic term in the blackboard learn system. this endpoint is used to fetch comprehensive data about a term, such as its name, start date, end date, and any associated metadata. it's particularly useful for applications that need to synchronize term information or display term details to users. the endpoint should be used when specific term information is required, rather than a list of all terms. note that this endpoint only provides details for a single term; to get information about multiple terms, separate requests must be made for each termid.
</Accordion>

<Accordion title="Retrieve rubric association for course">
  Retrieves detailed information about a specific rubric association within a blackboard learn course. this endpoint allows users to access the configuration and application details of a rubric to a particular assessment or assignment. it is particularly useful for understanding how grading criteria are applied to specific coursework, enabling instructors and administrators to review and manage assessment structures. the tool should be used when detailed information about rubric implementation for a specific assignment is needed, such as during course setup, grading processes, or when analyzing assessment methodologies. it does not modify any data and is solely for retrieval purposes.
</Accordion>

<Accordion title="Get upload settings">
  Retrieves the current upload settings for the blackboard learn platform. this endpoint allows administrators and authorized users to fetch the configuration parameters related to file uploads within the blackboard system. it provides information about various aspects of file upload handling, such as maximum file size limits, allowed file types, storage configurations, and any other relevant upload-related settings. this tool should be used when there's a need to review or verify the current upload policies and constraints in place for the blackboard instance. it does not modify any settings; it only returns the existing configuration.
</Accordion>

<Accordion title="Get gradebook schema for course">
  Retrieves the gradebook schemas for a specific course in the blackboard learning management system. this endpoint allows developers to access the structure and format of the gradebook data for a given course, which is crucial for understanding how grades are organized and stored within blackboard. it can be used when integrating external grading systems, developing custom grade reporting tools, or when needing to understand the grading structure of a particular course. the endpoint returns the schemas without actual grade data, focusing solely on the structural aspects of the gradebook.
</Accordion>

<Accordion title="Retrieve sis dataset log by id">
  Retrieves a specific student information system (sis) dataset from the blackboard learn platform using its unique identifier. this endpoint is used to access detailed information about a particular sis dataset, which may include student records, course enrollments, or other education-related data integrated into blackboard. it's particularly useful for administrators and developers who need to audit, analyze, or synchronize sis data with external systems. the endpoint should be used when specific dataset details are required, rather than for bulk data retrieval. note that access to sis datasets may be restricted based on user roles and permissions within the blackboard system.
</Accordion>

<Accordion title="Retrieve goal by id">
  Retrieves detailed information about a specific learning goal within the blackboard learn platform. this endpoint allows educators and administrators to access comprehensive data about an individual goal, including its description, associated courses, and progress metrics. use this when you need to review or analyze a particular learning objective. the tool returns only information about the requested goal and does not provide an overview of all goals or modify any goal data. it's particularly useful for tracking student progress, curriculum planning, and ensuring alignment with educational standards.
</Accordion>

<Accordion title="Fetch oauth2 tokeninfo">
  Retrieves detailed information about a specified oauth2 token used for authentication in the blackboard learn api. this endpoint allows developers to verify the validity, scope, and associated details of an access token. it should be used when an application needs to check the current state or permissions of a token, such as during user session management or before making api calls. the endpoint does not refresh or modify the token; it only provides read-only information about the token's current state.
</Accordion>

<Accordion title="Get assessment questions by course and assessment id">
  Retrieves a list of questions for a specific assessment within a blackboard course. this endpoint allows users to access the questions associated with a particular assessment, such as a quiz, test, or assignment, in a given course. it's useful for instructors or administrators who need to review, analyze, or export assessment questions. the endpoint requires both a course identifier and an assessment identifier to pinpoint the exact set of questions to retrieve. it should be used when detailed information about assessment questions is needed, but it does not provide information about student responses or scores. note that the accessibility of this data may depend on the user's permissions within the blackboard system.
</Accordion>

<Accordion title="List system roles">
  Retrieves a list of all system roles defined in the blackboard learn platform. this endpoint provides comprehensive information about the various roles that can be assigned to users within the system, including their associated permissions and access levels. it is particularly useful for administrators and developers who need to understand the role structure of the blackboard learn instance, manage user permissions, or integrate role-based access control in their applications. the endpoint should be used when a complete overview of the system's role hierarchy is required, but it should not be relied upon for real-time permission checks of individual users.
</Accordion>

<Accordion title="Fetch terms list">
  Retrieves a list of academic terms or information about specific terms in the blackboard learning management system. this endpoint provides access to term definitions, including start and end dates, term names, and other relevant metadata. it's useful for applications that need to synchronize academic calendars, manage course schedules, or provide term-based information to users. the endpoint supports pagination and field selection, allowing for efficient data retrieval and reduced payload sizes when only specific term information is needed. it should be used when building integrations that require up-to-date term information or when displaying term-related data in external applications connected to blackboard.
</Accordion>

<Accordion title="Retrieve admin info by nodeid and userid">
  Retrieves the administrative status of a specific user for a particular node within the blackboard institutional hierarchy. this endpoint allows you to check whether a user has administrative privileges for a given organizational unit, such as a department or course. use this endpoint when you need to verify a user's administrative role or permissions within a specific part of the institution's structure. the endpoint provides information about the user's admin status but does not modify any permissions. it's particularly useful for access control, auditing, or displaying user roles in management interfaces.
</Accordion>

<Accordion title="Retrieve node admins">
  Retrieves the list of administrators associated with a specific node in the blackboard institutional hierarchy. this endpoint is used to fetch administrative information for a particular organizational unit, such as a department, school, or program within an educational institution. it provides insights into the management structure and helps in understanding who has administrative access to various parts of the institutional hierarchy. this tool is particularly useful for system administrators, it staff, or institutional managers who need to review or manage administrative roles within the blackboard system.
</Accordion>

<Accordion title="Get course rubric by course id">
  Retrieves a specific rubric for a given course in the blackboard learning management system. this endpoint allows users to access detailed information about a rubric, including its criteria, scoring methods, and any associated metadata. it is particularly useful for instructors or administrators who need to review or integrate rubric data into other systems or workflows. the endpoint should be used when detailed rubric information is required for a known course and rubric combination, but it will not modify or create new rubrics.
</Accordion>

<Accordion title="Retrieve toc items by course id">
  Retrieves the table of contents (toc) items for a specified course in the blackboard learning management system. this endpoint provides access to the structured organization of educational materials within a course, including modules, lessons, assignments, and other content types. it should be used when needing to display or analyze the content structure of a course, such as for building a course navigation interface or auditing course materials. the endpoint returns only the toc structure and does not include the actual content of the items. it's particularly useful for applications that need to understand or replicate the course layout without accessing the full content details.
</Accordion>

<Accordion title="Get rubric associations for gradebook columns">
  Retrieves the rubric associations for a specific gradebook column within a blackboard course. this endpoint allows users to access detailed information about how rubrics are connected to a particular grading column, which is crucial for understanding the assessment criteria and grading structure. it should be used when there's a need to review or analyze the rubric setup for a specific gradable item in a course. the tool is particularly useful for instructors, course designers, or administrators who need to ensure that the appropriate rubrics are linked to the correct gradebook columns. note that this endpoint only provides information about existing associations and does not allow for creating, modifying, or deleting these associations.
</Accordion>

<Accordion title="List institution roles">
  Retrieves a list of all institution roles defined within the blackboard learn environment. this endpoint is crucial for administrators and developers who need to understand and manage the various roles available in their institution's blackboard system. it provides a comprehensive overview of the role structure, which is essential for user management, access control, and permission assignment across the platform. the endpoint should be used when setting up new user accounts, auditing existing roles, or integrating role-based access control in external applications. note that this endpoint only retrieves role information and does not allow for creating, modifying, or deleting roles.
</Accordion>

<Accordion title="Retrieve course resources by id">
  Retrieves a list of resources associated with a specific course in the blackboard learning management system (lms). this endpoint allows users to access educational materials, such as assignments, readings, and other study materials, that are linked to a particular course. it should be used when there's a need to fetch all available resources for a given course, which can be useful for building course content viewers, resource management tools, or for synchronizing course materials with external systems. the endpoint does not provide the actual content of the resources, but rather metadata and references to access them. it's important to note that the accessibility of resources may depend on the user's permissions within the blackboard system.
</Accordion>

<Accordion title="Retrieve user avatar by userid">
  Retrieves the avatar (profile picture) for a specified user in the blackboard learn platform. this endpoint allows you to fetch the current profile image associated with a user's account based on their unique user id. it should be used when you need to display or access a user's avatar within your application or integration. the endpoint returns the image data directly, which can be used for rendering the avatar or storing it locally. note that this endpoint only provides the avatar image and does not include any other user profile information. if the user has not set an avatar, the endpoint may return a default image or an appropriate error response.
</Accordion>

<Accordion title="Get user pronunciation audio">
  Retrieves the pronunciation audio associated with a specific user's profile in blackboard learn. this endpoint allows applications to access the audio file that contains the correct pronunciation of the user's name. it should be used when there's a need to play or display the audio pronunciation of a user's name, such as in user directory listings, class rosters, or personalized greetings. the audio file returned may be in a common audio format (e.g., mp3, wav). if no pronunciation audio has been set for the user, the endpoint may return a 404 error or an empty response. this tool does not upload or modify the pronunciation audio; it is for retrieval purposes only.
</Accordion>

<Accordion title="Retrieve rubric evaluation for attempt">
  Retrieves the rubric evaluations for a specific attempt on a gradebook item within a blackboard course. this endpoint allows instructors or administrators to access detailed rubric-based assessment data for a particular student's submission. it is useful for reviewing grading decisions, providing feedback, or analyzing assessment outcomes. the tool should be used when detailed information about how a specific assignment attempt was evaluated against rubric criteria is needed. it does not modify any data and is intended for read-only access to evaluation information.
</Accordion>

<Accordion title="Retrieve task by id">
  Retrieves detailed information about a specific system task in the blackboard learn platform. this endpoint allows developers to fetch the current status, details, and metadata of an individual task identified by its unique taskid. it should be used when monitoring or tracking the progress of system-level operations, such as batch processes, system updates, or administrative functions. the endpoint provides up-to-date information about the task but does not allow modification of the task itself. it's particularly useful for integrations that need to synchronize with blackboard's system tasks or provide status updates to users.
</Accordion>

<Accordion title="Retrieve assessment question">
  Retrieves detailed information about a specific question within an assessment for a particular course in the blackboard learning management system. this endpoint allows users to access question content, type, scoring information, and other relevant details. it should be used when detailed information about a single question is needed, such as for review, editing, or analysis purposes. the endpoint does not modify the question; it only provides read access to the existing data. note that the response will not include student answers or performance data related to the question.
</Accordion>

<Accordion title="Fetch course task details">
  Retrieves detailed information about a specific task within a course in the blackboard learn platform. this endpoint allows users to fetch comprehensive data about an individual assignment, activity, or any other task associated with a particular course. it should be used when detailed information about a single task is needed, such as viewing assignment instructions, due dates, or associated materials. the endpoint is particularly useful for building interfaces that display task details to students or instructors, or for integrating task information into external learning tools. note that this endpoint only provides information about the task itself and does not include submission data or grades.
</Accordion>

<Accordion title="Get institutional node tool information">
  Retrieves detailed information about a specific tool associated with a particular node in the blackboard institutional hierarchy. this endpoint is used to fetch configuration, settings, or status details for a given tool type within a specific organizational unit (node) of an educational institution. it allows developers to access and potentially manage tool-specific data for various components of the blackboard learning environment. this endpoint should be used when detailed information about a particular tool's implementation or settings within a specific context (e.g., a course or department) is needed. it does not modify any data and is primarily for information retrieval purposes.
</Accordion>

<Accordion title="Retrieve system version information">
  Retrieves the current version information of the blackboard learn system. this endpoint should be used when developers or administrators need to check the specific version of the blackboard instance they are working with. it's particularly useful for ensuring compatibility with other tools or services that integrate with blackboard, or for troubleshooting version-specific issues. the endpoint returns version details of the system, which may include the major, minor, and patch version numbers. it does not provide information about individual components or modules within the blackboard system, focusing solely on the overall system version.
</Accordion>

<Accordion title="Retrieve gradebook column by course and column ids">
  Retrieves detailed information about a specific gradebook column within a particular course in the blackboard learning management system. this endpoint allows users to access the properties and settings of an individual grading column, such as its name, description, points possible, and grading type. it should be used when detailed information about a specific grading component is needed, for example, when reviewing or auditing the grading structure of a course. the endpoint provides read-only access and does not allow modification of the column data. it's particularly useful for instructors, teaching assistants, or administrators who need to verify or analyze the setup of their course gradebook without making changes.
</Accordion>

<Accordion title="Retrieve course group by ids">
  Retrieves detailed information about a specific group within a particular course in the blackboard learning management system. this endpoint is used to access group data, which may include the group's name, description, membership, and other relevant details. it's particularly useful for instructors or administrators who need to manage or review group activities within a course. the endpoint should be used when specific group information is required, such as for displaying group details, verifying group settings, or preparing reports on group-based activities. it does not modify any data and is intended for read-only operations.
</Accordion>

<Accordion title="Retrieve user gradebook column">
  Retrieves a specific user's grade for a particular gradebook column in a blackboard learn course. this endpoint allows instructors or administrators to fetch individual grade entries, providing a targeted way to access student performance data. it's particularly useful for generating individual student reports, verifying grade entries, or integrating with external grading systems. the endpoint returns the grade value and potentially additional metadata such as submission date or feedback. it should be used when precise, individual grade information is needed, rather than for bulk grade retrieval across multiple students or columns.
</Accordion>

<Accordion title="Retrieve users in institutional node">
  Retrieves a list of users associated with a specific node in the blackboard learn institutional hierarchy. this endpoint allows administrators and authorized users to fetch user information within the context of the institution's organizational structure. it is particularly useful for managing user access, roles, and permissions at different levels of the institutional hierarchy. the endpoint should be used when there's a need to audit or review user assignments within a specific department, faculty, or sub-institution. it provides a comprehensive view of user associations but does not modify any user data. note that the response may be paginated for large user sets, and additional api calls might be necessary to retrieve the complete list of users for nodes with a high number of associated accounts.
</Accordion>

<Accordion title="Update user in course group">
  Updates a user's information within a specific group of a course in blackboard learn. this endpoint allows for modifying user-related data or settings in the context of a particular course group. it should be used when changes need to be made to a user's status, role, or other attributes specific to their participation in a group within a course. the endpoint doesn't create new user entries or move users between groups; it's specifically for updating existing user information. note that the actual data being updated is likely sent in the request body, which is not detailed in the provided schema. ensure you have the necessary permissions to modify user data within the specified course and group before using this endpoint.
</Accordion>

<Accordion title="Retrieve loginas sessions">
  Retrieves active login sessions for users in the blackboard learning management system. this endpoint is used to monitor and manage current user sessions across the platform. it provides a list of all ongoing login sessions, which can be crucial for system administrators to track user activity, troubleshoot access issues, or enforce security policies. the tool should be used when there's a need to audit active user sessions or investigate potential unauthorized access. it does not provide historical session data or allow for direct session manipulation.
</Accordion>

<Accordion title="Retrieve user in course group">
  Retrieves detailed information about a specific user within a group in a blackboard learn course. this endpoint allows developers to access user data in the context of both the course and the group, providing insights into the user's role, permissions, and activities within that specific group and course. use this endpoint when you need to fetch user-specific information related to their participation in a particular group within a course. it's particularly useful for generating reports, managing group activities, or personalizing user experiences within the course and group context. note that this endpoint only provides information about the user in relation to the specified group and course; it does not return general user profile data or information about the user's participation in other courses or groups.
</Accordion>

<Accordion title="Fetch goal set categories">
  Retrieves the categories associated with a specific goal set in the blackboard learning management system. this endpoint is used to fetch the organizational structure of educational objectives within a predefined set of goals. it should be used when needing to understand or display the categorization of learning objectives for a particular goal set, such as when building course structures or reporting on educational outcomes. the endpoint returns only the categories within the specified goal set and does not provide detailed information about the goals themselves. this tool is particularly useful for administrators and instructors who need to manage and organize educational goals across courses or programs.
</Accordion>

<Accordion title="Retrieve gradebook entry for user in course">
  Retrieves detailed gradebook information for a specific user within a particular course in the blackboard learning management system. this endpoint allows educators, administrators, or authorized users to access individual student performance data, including grades, assignments, and other relevant gradebook entries. it should be used when detailed grade information for a single student in a specific course is required, such as for progress monitoring or generating individual reports. the endpoint does not provide aggregate data for multiple students or courses and cannot be used to modify gradebook entries.
</Accordion>

<Accordion title="List users in course group">
  Retrieves a list of users belonging to a specific group within a course in the blackboard learning management system. this endpoint is useful for obtaining detailed information about group members, such as their names, roles, and other relevant data. it should be used when you need to access user information for a particular group in a course, for example, to manage group activities or assess group participation. the endpoint does not modify any data and is intended for read-only operations. it may not provide real-time updates if user information has changed very recently.
</Accordion>

<Accordion title="List course group users">
  Retrieves a list of users belonging to a specific group within a blackboard learn course. this endpoint is used to access user information for group-based activities, collaborative assignments, or administrative purposes. it provides details about the members of a particular group, which can be useful for instructors or administrators managing course activities. the endpoint should be used when you need to obtain user data for a specific group context, rather than for the entire course. it's important to note that this endpoint only provides user information within the scope of the specified group and course, and does not offer details about user activities or performance outside of this context.
</Accordion>

<Accordion title="Fetch types of goal sets">
  Retrieves a list of available goal set types in the blackboard learn system. this endpoint allows users to fetch information about the different categories or classifications of goal sets that can be created or managed within the learning management system. it is useful for understanding the structure and organization of educational objectives or learning outcomes in blackboard. the endpoint should be used when planning to create new goal sets or when needing an overview of the existing goal set categories. it does not provide specific goals or content within these sets, only the types or categories available for organization.
</Accordion>

<Accordion title="Get group details from course api">
  Retrieves detailed information about a specific group within a blackboard course. this endpoint is used to fetch comprehensive data about a group, including its name, description, membership details, and other relevant attributes. it's particularly useful for applications that need to display or manage group information within the context of a course. the endpoint should be used when detailed group information is required, such as for group management interfaces or when populating group-specific views in an application integrated with blackboard. it does not modify any group data and is intended for read-only operations. note that this endpoint focuses on a single group and does not provide a list of all groups in a course or allow for group creation or modification.
</Accordion>

<Accordion title="Retrieve rubric evaluation details">
  Retrieves detailed information about a specific rubric evaluation within a blackboard course. this endpoint allows users to access the assessment data, including scores and feedback, for a particular rubric evaluation associated with a course component. it is useful for instructors reviewing assessments, students viewing their feedback, or administrators analyzing evaluation data. the endpoint requires specific identifiers for the course, rubric, association, and evaluation to pinpoint the exact evaluation record. it should be used when detailed evaluation data is needed, but won't provide an overview of multiple evaluations or allow modifications to the evaluation.
</Accordion>

<Accordion title="Retrieve users list">
  The getusersendpoint retrieves user information from the blackboard learn system. this endpoint allows you to fetch a list of users with their associated details, supporting various query parameters for filtering, sorting, and pagination. it's particularly useful for applications that need to synchronize user data, manage user accounts, or display user information within an educational context. the endpoint returns user data in a structured format, likely including fields such as user ids, usernames, email addresses, and other relevant profile information. while it provides comprehensive user data, it does not modify user information - separate endpoints would be required for user creation, updates, or deletion. use this endpoint when you need to access user data for reporting, user management, or integration purposes within your blackboard-connected application.
</Accordion>

<Accordion title="Add course gradebook column">
  Creates a new grade column in a blackboard course's gradebook. this endpoint allows instructors or administrators to add a new column for recording and managing student grades within a specific course. it provides extensive customization options for grading methods, score calculations, student visibility, and anonymous grading. use this endpoint when setting up a new assignment, exam, or other gradable item in a course. it's particularly useful for configuring complex grading scenarios or when integrating external grading systems with blackboard.
</Accordion>

<Accordion title="Modify announcement details">
  This endpoint allows you to update an existing course announcement in the blackboard learn platform. it can modify the announcement's title, body content, draft status, and availability settings. the body content supports rich text formatting using bbml (blackboard markup language), enabling the creation of visually appealing and structured announcements. use this endpoint when you need to edit or refine an announcement's content, change its visibility, or update its publication status. it's particularly useful for correcting errors, adding new information, or adjusting the timing of announcement visibility to students.
</Accordion>

<Accordion title="Create new course with json input">
  Creates a new course in the blackboard learn system with specified attributes and settings. this endpoint allows for the creation of both academic courses and organizational units, with extensive customization options for course properties, availability, enrollment methods, and localization. it should be used when setting up new courses or organizations within blackboard, either manually or as part of an automated provisioning process. the endpoint provides flexibility in course setup, supporting both ultra and classic course views, various availability and enrollment options, and integration with external systems through data source and external id fields. however, it's important to note that some settings are specific to either ultra or classic courses, and certain parameters may have interdependencies or require specific permissions to modify.
</Accordion>

<Accordion title="Retrieve course content adaptive release rules">
  Retrieves the adaptive release rules associated with a specific content item within a blackboard course. this endpoint allows instructors or administrators to view the conditions under which the content becomes available to students. it should be used when there's a need to understand or audit the release criteria for a particular piece of course content. the tool returns details about the rules, which may include date, grade, membership, or review status criteria. it's particularly useful for managing complex content release strategies or troubleshooting student access issues. note that this endpoint only provides information about existing rules and does not allow for creation or modification of rules.
</Accordion>

<Accordion title="Fetch course groups by id">
  Retrieves a list of all groups associated with a specific course in the blackboard learning management system. this endpoint is useful for obtaining information about the various student groups, project teams, or study circles within a particular course. it should be used when you need to access group data for course management, reporting, or to facilitate group-based activities and assignments. the endpoint provides a comprehensive view of the group structure within a course but does not modify any group information. note that this endpoint only returns group data and does not include detailed information about individual group members or their activities.
</Accordion>

<Accordion title="Retrieve user from course group">
  Retrieves detailed information about a specific user's membership or role within a group in a particular course on the blackboard platform. this endpoint is used to access user-specific data in the context of their group participation within a course. it provides information such as the user's role in the group, join date, or any custom attributes related to their group membership. this endpoint should be used when you need to verify a user's status within a group or gather details about their group-related activities in a specific course. it does not modify any data and is purely for information retrieval purposes. note that this endpoint only returns data for a single user in a single group and course context; it cannot be used to fetch multiple users or compare across different groups or courses simultaneously.
</Accordion>

<Accordion title="Retrieve user courses by id">
  Retrieves a list of courses associated with a specific user in the blackboard learn platform. this endpoint is used to fetch all courses that a user is enrolled in or has access to, providing essential information for course management and user-specific content delivery. it's particularly useful for generating user dashboards, course listings, or when syncing course data with external systems. the endpoint returns course details but does not provide in-depth information about course content or student performance within those courses.
</Accordion>

<Accordion title="Retrieve course group information">
  Retrieves detailed information about a specific group set within a course in the blackboard learning management system. this endpoint allows users to fetch the properties and configuration of a particular group set, which may include details such as the group set name, description, availability, and associated groups. it is useful for obtaining up-to-date information about how groups are organized within a course, which can be valuable for course management and student collaboration purposes. this endpoint should be used when detailed information about a specific group set is needed, rather than a list of all group sets in a course. it does not modify the group set or its associated groups; it only provides read access to the existing data.
</Accordion>

<Accordion title="Patch gradebook column">
  This endpoint allows for updating specific properties of an existing grade column within a course's gradebook in the blackboard learn platform. it provides granular control over various aspects of the grade column, including its metadata, scoring configuration, visibility to students, and grading settings. the patch operation supports partial updates, meaning you can modify individual properties without affecting others. this is particularly useful for adjusting grade column settings throughout the academic term, such as changing due dates, modifying scoring models, or updating anonymous grading configurations. note that this endpoint does not create new grade columns or delete existing ones; it is specifically for modifying properties of an already existing grade column identified by the courseid and columnid.
</Accordion>

<Accordion title="Retrieve user by id">
  Retrieves detailed information about a specific user in the blackboard learn system. this endpoint allows you to fetch user profile data, such as name, email, system role, and other relevant details associated with the user account. it should be used when you need to access or display information about a particular user, such as for user management tasks, profile displays, or data synchronization between systems. the endpoint returns only the publicly available information about the user and does not provide access to sensitive or private data. it's important to note that while this is a public api endpoint, the actual data returned may still be subject to user privacy settings and system-wide access controls.
</Accordion>

<Accordion title="Get user course by id">
  Retrieves detailed information about a specific user within a particular course in the blackboard learning management system. this endpoint is used to fetch user-specific data in the context of a given course, which may include enrollment status, role in the course, progress, or other relevant details. it should be used when you need to access or verify a user's information or status within a specific course. this endpoint is particularly useful for generating reports, checking user progress, or managing course-specific user data. note that it only provides information for a single user-course combination and does not return data about the user across multiple courses or course-wide user lists.
</Accordion>

<Accordion title="List course group sets">
  Retrieves a list of groups within a specific group set for a given course in the blackboard learning management system. this endpoint allows educators and administrators to access detailed information about the groups created within a particular group set, facilitating management of student collaborations and assignments. it should be used when there's a need to view or analyze the structure of groups within a course, such as for attendance tracking, assignment distribution, or organizing collaborative activities. this endpoint is particularly useful for applications that need to synchronize group data with external systems or generate reports on course organization.
</Accordion>

<Accordion title="Retrieve lti placement by id">
  Retrieves detailed information about a specific lti (learning tools interoperability) placement within the blackboard learn platform. this endpoint allows developers and administrators to fetch the configuration, settings, and integration details for a particular lti tool placement identified by its unique placementid. use this endpoint when you need to inspect or verify the setup of an lti tool within blackboard courses or content areas. the returned data may include information such as the tool's name, description, launch url, and custom parameters. this endpoint is particularly useful for troubleshooting lti integrations or gathering information for reporting purposes.
</Accordion>

<Accordion title="Get content collection resources children">
  Retrieves a list of child resources for a specified parent resource within the blackboard content collection. this endpoint is used to navigate through the hierarchical structure of educational content, allowing users to explore sub-items or nested resources within a given parent resource. it's particularly useful for applications that need to display or manage the content structure of blackboard courses or materials. the endpoint returns only direct children of the specified resource, not the entire subtree, making it suitable for building tree-like navigation or content exploration features. note that this endpoint does not provide the actual content of the resources, only their metadata and structural information.
</Accordion>

<Accordion title="Retrieve course list">
  Retrieves a list of courses from the blackboard learn environment. this endpoint is essential for applications that need to access and display course information within the learning management system (lms). it allows developers to fetch course data for various purposes such as building course catalogs, managing enrollments, or syncing course information with external systems. the endpoint is part of the public v2 api, making it suitable for integration with third-party services. while it provides a comprehensive list of courses, it may not include detailed course content or student-specific information, which might require separate api calls.
</Accordion>

<Accordion title="Retrieve observees of user profile">
  Retrieves a list of observees associated with a specific user in the blackboard learning management system. this endpoint is used to fetch information about individuals or entities that the specified user is authorized to observe or monitor within the system. it is particularly useful for scenarios where a user, such as a parent or guardian, needs to access data about students they are responsible for. the endpoint returns details about the observees, which may include their identifiers, names, and potentially other relevant information depending on the system's configuration and privacy settings. it should be used when there's a need to gather information about the relationship between a user and their observees in an educational context.
</Accordion>

<Accordion title="Fetch content collection resources">
  Retrieves a list of resources from a specified content collection within a blackboard learn course. this endpoint enables access to various educational materials in a course's content collection. it supports pagination and is useful for applications that need to display or manage course resources. note that it only provides resource metadata, not the full content.
</Accordion>

<Accordion title="Get user observers by id">
  Retrieves the list of observers associated with a specific user in the blackboard learning management system. this endpoint is used to fetch information about individuals or entities that have been granted observer access to a particular user's activities and progress. it's particularly useful for administrators, instructors, or guardians who need to monitor a student's performance and engagement within the blackboard platform. the endpoint returns details about each observer, which may include their roles, permissions, and relationship to the observed user. this tool should be used when there's a need to review or manage the observers for a given user, such as during student progress reviews or when updating access permissions.
</Accordion>

<Accordion title="Fetch messages for course id">
  Retrieves all messages associated with a specific course in the blackboard learning management system. this endpoint is used to access course-related communication, announcements, and notifications. it provides a comprehensive view of all messages within the context of a particular course, which can include instructor announcements, student discussions, and system notifications. this tool should be used when there's a need to gather all communication related to a specific course, such as for auditing purposes or to provide a complete message history to students or instructors. it does not allow for filtering or searching messages; all messages for the specified course are returned.
</Accordion>

<Accordion title="Get courses for category">
  Retrieves a list of courses associated with a specific category in the blackboard catalog. this endpoint allows users to fetch course information based on the category type and category id, providing a way to browse or search for courses within a particular organizational structure. it's useful for applications that need to display course offerings for a given department, subject area, or other categorical groupings. the endpoint should be used when you need to present users with a filtered view of courses or when populating course selection interfaces tied to specific categories in the blackboard system.
</Accordion>

<Accordion title="Retrieve course group sets">
  Retrieves all group sets associated with a specific course in the blackboard learning management system. group sets are collections of groups within a course that can be used for various collaborative activities, such as group projects, discussions, or assignments. this endpoint should be used when you need to obtain an overview of the group structure within a course, such as when preparing for group assignments or managing course organization. it provides a list of group sets, but does not include detailed information about individual groups within each set. this endpoint is particularly useful for instructors or administrators who need to manage or review the group organization of a course.
</Accordion>

<Accordion title="Fetch lti placements">
  Retrieves a list of all available lti (learning tools interoperability) placements within the blackboard learn environment. this endpoint allows developers and administrators to obtain information about where external learning tools can be integrated within the blackboard platform. it's particularly useful when setting up or managing lti tool integrations, as it provides insight into the possible locations where these tools can be placed. the response likely includes details such as placement ids, names, and descriptions, though specific return fields are not provided in the schema. use this endpoint when you need to explore or verify lti integration options in blackboard.
</Accordion>

<Accordion title="Delete child course association">
  Deletes a specified child course from a parent course in the blackboard learning management system. this endpoint is used to remove a sub-course or section from the main course structure, helping to organize and manage course hierarchies. it should be used when restructuring courses, removing outdated sections, or cleaning up course catalogs. this operation is permanent and cannot be undone, so it should be used with caution. the endpoint requires both the parent course id and the child course id to ensure precise deletion of the correct course relationship.
</Accordion>

<Accordion title="Obtain oauth2 token via post">
  Obtains an oauth2 token for authenticating and authorizing requests to the blackboard api. this endpoint is essential for securing access to blackboard's resources and should be used before making any api calls that require authentication. the token obtained from this endpoint is typically valid for a limited time and should be refreshed periodically. this endpoint supports both client credentials flow for server-to-server interactions and authorization code flow for user-centric operations. it's important to note that the token should be kept secure and not exposed to end-users or in client-side code.
</Accordion>

<Accordion title="Patch hierarchy node tool settings">
  This endpoint allows you to update the settings of a specific tool within a node of blackboard's institutional hierarchy. it provides granular control over tool availability and configuration for different user types (regular, guest, and observer). use this endpoint when you need to modify existing tool settings, such as enabling/disabling a tool, locking its configuration, or adjusting its applicability for different user roles. this is particularly useful for managing tool access across various levels of an institution's structure, ensuring appropriate permissions and visibility for different user categories.
</Accordion>

<Accordion title="Update category details by type">
  Updates specific details of a category in the blackboard catalog system. this endpoint allows modification of various category attributes such as title, description, front page visibility, availability, access restrictions, and associated institution roles. it's used to manage and organize the catalog structure, controlling how categories are presented and accessed within the blackboard learning environment. the endpoint requires specifying both the category type and id in the url path to target the correct category for updates. it's particularly useful for administrators or content managers who need to refine category settings or adjust access permissions.
</Accordion>

<Accordion title="Delete discussion message by id">
  This endpoint allows for the deletion of a specific message within a discussion thread in a blackboard course. it should be used when an instructor or authorized user needs to remove inappropriate, outdated, or incorrect content from a course discussion. the operation is irreversible, so it should be used with caution. this endpoint only deletes the specified message and does not affect other messages in the discussion or the discussion thread itself. it's important to note that deleting a parent message may have implications for its child messages or the structure of the discussion thread, depending on how blackboard handles such deletions.
</Accordion>

<Accordion title="Post discussion message in course">
  Posts a new message to a specific discussion within a blackboard learn course. this endpoint allows users to contribute to course discussions by adding new messages, supporting both general course discussions and group-specific discussions. it provides options for setting the message status, enabling features like draft saving and soft deletion. the endpoint is essential for facilitating student engagement and collaborative learning through structured, asynchronous communication within the blackboard platform.
</Accordion>

<Accordion title="Delete gradebook column in course">
  Deletes a specific gradebook column from a course in blackboard learn. this endpoint allows instructors or administrators to remove a column from the gradebook, which may be necessary for course restructuring or correcting errors in grade calculations. it should be used with caution as the deletion is permanent and may affect overall grade calculations. this operation is available in both ultra and original experiences of blackboard learn. note that this action cannot be undone, and all associated grade data for the column will be permanently removed.
</Accordion>

<Accordion title="Patch grade information for user">
  The updategrade endpoint allows instructors to modify various aspects of a student's grade for a specific course and gradebook column in the blackboard learning management system. this patch operation enables overriding grades, adding instructor notes and feedback, marking grades as exempt from course grade calculations, and associating predefined grade notations. it's particularly useful for handling manual grade entries, overriding automatically calculated grades, and managing special grading circumstances. the endpoint should be used when there's a need to adjust individual student grades outside of the standard grading process, provide detailed feedback, or apply special grading considerations. it's important to note that this endpoint modifies existing grade entries and does not create new ones; it should not be used for initial grade submissions.
</Accordion>

<Accordion title="Update attempt status in gradebook">
  This endpoint allows for updating specific attributes of a gradebook attempt for a particular course, column, and attempt id. it is used to modify various aspects of a student's submission, including its status, score, feedback, and grading properties. the patch operation enables partial updates, allowing instructors to change only the necessary fields without affecting others. this tool is particularly useful for managing the grading process, providing feedback to students, and handling special grading scenarios such as exemptions or multiple attempts. it should be used when there's a need to update any information related to a specific gradebook entry, but not for creating new attempts or retrieving attempt information. note that some status values are deprecated, and changing the reconciliationmode requires also providing a new score.
</Accordion>

<Accordion title="Patch data source by external id">
  This endpoint allows for updating specific attributes of an existing data source in the blackboard system. it uses the patch method to apply partial modifications to a data source identified by its unique datasourceid. the primary use case is to update the external id or description of a data source, enabling better synchronization with external systems and improved documentation within blackboard. this endpoint should be used when there's a need to modify data source metadata without changing its core functionality or relationships within the system. it's particularly useful for maintaining accurate and up-to-date information about data sources used in educational institutions integrated with blackboard.
</Accordion>

<Accordion title="Delete course by courseid">
  The deletecourse endpoint permanently removes a specific course from the blackboard learn platform. this operation deletes all associated course content, assignments, and student data for the specified course. it should be used with extreme caution, typically only when a course is no longer needed and all necessary data has been backed up. this action is irreversible, so it's crucial to verify the courseid before execution. the endpoint is part of the v2 api, indicating it's a more recent version of the blackboard learn rest api.
</Accordion>

<Accordion title="Download course gradebook attempt file">
  This endpoint allows for downloading a specific file associated with a student's attempt on an assignment within a blackboard course. it retrieves the file content based on the provided course, attempt, and file identifiers. this tool should be used when access to the actual file submitted by a student is required, such as for grading, review, or archival purposes. it's particularly useful for assignments that involve file submissions like essays, projects, or any document-based work. the endpoint does not provide metadata about the file or attempt; it solely focuses on file retrieval.
</Accordion>

<Accordion title="Patch adaptiverelease criterion">
  Updates a specific criterion within an adaptive release rule for a course content item in blackboard learn. this endpoint allows instructors or administrators to modify the conditions under which course materials become available to students. it can be used to adjust release criteria based on dates, grades, user progress, or other factors supported by blackboard's adaptive release feature. the endpoint should be used when fine-tuning content visibility rules or correcting existing criteria. it's important to note that this operation only modifies the specified criterion and does not affect other criteria within the same rule or other rules for the content item. proper understanding of the adaptive release feature and careful consideration of the impact on student access is recommended before making changes.
</Accordion>

<Accordion title="Delete user from course group">
  This endpoint removes a specific user from a designated group within a course in blackboard learn. it is used when an administrator or instructor needs to adjust group membership, such as when a student changes project teams or is no longer part of a specific study group. the operation is final and will immediately revoke the user's access to group-specific resources and activities. it should be used cautiously, as removing a user from a group may affect their ability to participate in group-related coursework. this endpoint does not remove the user from the course itself, only from the specified group within the course.
</Accordion>

<Accordion title="Modify system announcement details">
  This endpoint allows you to update an existing system announcement in blackboard. it provides the ability to modify the announcement's title, content (using bbml formatting), availability settings, and display options. use this endpoint when you need to change the content or visibility of a specific announcement, such as extending its duration, updating its message, or adjusting where it appears in the blackboard interface. the update is partial, meaning you only need to include the fields you want to change. be cautious when updating availability settings, as changes may immediately affect the announcement's visibility to users.
</Accordion>

<Accordion title="Patch course content">
  This endpoint allows you to update existing content within a specific blackboard learn course. it provides extensive control over content properties, including title, body, description, position, availability, and more. use this endpoint when you need to modify course content attributes, reorganize content structure, or adjust content visibility and access settings. the endpoint is particularly useful for content management tasks such as updating content details, moving content between folders, setting adaptive release rules, or changing content types. note that while you can update various aspects of the content, you cannot create new content or delete existing content using this endpoint. be aware of the specific content handler types supported and their respective documentation when dealing with specialized content types.
</Accordion>

<Accordion title="Patch calendar item by type and id">
  This endpoint allows you to update an existing calendar item in the blackboard system. it can be used to modify various aspects of an event, assignment, or other calendar entries, including basic details, recurrence settings, and lti (learning tools interoperability) integration. the endpoint is particularly useful for making changes to scheduled items, adjusting dates, updating descriptions, or linking to external learning resources. it supports both one-time and recurring events, with detailed options for setting recurrence patterns. note that some properties, such as dynamiccalendaritemprops, are read-only and cannot be modified through this endpoint.
</Accordion>

<Accordion title="Update attendance record">
  Update the course meeting attendance data for the given course/organization. the "course.attendance.modify" entitlement is required to update a course meeting attendance. the "course.attendance.view" entitlement is required to view a course meeting attendance. **since**: 3500.7.0
</Accordion>

<Accordion title="Patch course meeting details">
  This endpoint allows you to update the details of a specific meeting within a course in the blackboard learning management system. it uses a patch request to modify one or more attributes of an existing meeting, such as its title, description, start and end times, or associated external link. this tool is particularly useful for making changes to scheduled meetings, correcting information, or updating virtual meeting links without having to recreate the entire meeting entry. when using this endpoint, you can selectively update only the fields that need to be changed, leaving other attributes untouched. note that you must have appropriate permissions within the blackboard system to modify course meetings, and changes made through this api will be reflected in the course's meeting schedule visible to students and instructors.
</Accordion>

<Accordion title="Update course discussion details">
  Updates a specific discussion forum within a blackboard learn course. this endpoint allows for partial updates to discussion properties such as title, availability, grading options, and the main topic content. it is used when modifying existing discussions without creating a new one or altering read-only metadata. the endpoint supports bbml formatting for rich text content in the topic body. note that this operation only affects the discussion settings and main topic; it does not modify individual replies or nested messages within the discussion thread.
</Accordion>

<Accordion title="Patch grade notation for course">
  This endpoint allows you to update an existing grade notation for a specific course in the blackboard learning management system. it's used to modify the performance code and/or description associated with a grade notation in the course's gradebook. this tool is particularly useful for administrators or instructors who need to adjust grading scales or clarify the meaning of certain grade notations. the update is performed by specifying the course id and grade notation id in the path, and providing the new code and/or description in the request body. note that this endpoint only updates existing grade notations and cannot be used to create new ones or delete existing notations.
</Accordion>

<Accordion title="Update course group details">
  Updates the properties of an existing group within a specific course in the blackboard learn platform. this endpoint allows for modifying various aspects of a group, including its name, description, availability to students, and enrollment settings. it's particularly useful for instructors or administrators who need to adjust group configurations after initial creation, such as changing access permissions, updating descriptive information, or modifying enrollment limits. the endpoint supports rich text formatting through bbml in description fields, enabling the creation of detailed, well-formatted group information. when using this endpoint, be aware that changes may immediately affect student access and group visibility within the course.
</Accordion>

<Accordion title="Delete course announcement by id">
  This endpoint deletes a specific announcement within a course in the blackboard learn platform. it allows administrators or authorized users to remove outdated, incorrect, or unnecessary announcements from a course, helping to maintain clear and relevant communication. the operation is irreversible, so it should be used with caution. this tool is particularly useful for content clean-up, managing course information, and ensuring that students only see current and applicable announcements.
</Accordion>

<Accordion title="Update course group information">
  Updates an existing group within a specified course in the blackboard learn system. this endpoint allows for modification of various group properties including its external id, name, description, availability status, and enrollment settings. it's particularly useful for adjusting group configurations after initial creation, such as changing visibility, updating enrollment limits, or modifying the signup process. the endpoint supports rich text formatting through bbml for descriptions, enabling detailed and well-formatted group information. use this when you need to alter any aspect of an existing group's setup or presentation to students within a course.
</Accordion>

<Accordion title="Update discussion message status">
  Updates a specific message within a course discussion on the blackboard platform. this endpoint allows for modifying the status and/or content of an existing message. it can be used to publish drafts, soft-delete messages, or update the body text of a message. the update is partial, meaning you can modify either the status, the body, or both without affecting the other fields. this endpoint is particularly useful for moderating discussions, editing messages for clarity, or managing the visibility of messages within a course context. note that updating a message's status may affect its visibility to other users in the discussion.
</Accordion>

<Accordion title="Update grading period info">
  Updates a specific grading period within a course's gradebook in the blackboard learn system. this endpoint allows for modification of various attributes of an existing grading period, including its title, description, position in the gradebook, date settings, and temporal coverage. it's used when course instructors or administrators need to adjust grading period details after initial creation, such as extending deadlines or reorganizing the gradebook structure. the endpoint provides flexibility in updating individual fields without requiring all parameters to be specified. it's particularly useful for managing the chronological structure of a course and associating gradable items with specific time frames.
</Accordion>

<Accordion title="Update institution node by id">
  This endpoint allows for updating specific properties of a node within the institutional hierarchy of blackboard. it is used to modify existing nodes, enabling administrators to keep the institutional structure up-to-date. the endpoint supports partial updates, meaning only the provided fields will be modified. it's particularly useful for renaming nodes, updating descriptions, changing external identifiers, or restructuring the hierarchy by updating parent relationships. however, it cannot be used to create new nodes or delete existing ones. care should be taken when modifying the parentid to ensure the integrity of the hierarchical structure is maintained.
</Accordion>

<Accordion title="Update lti domain configuration">
  This endpoint allows updating an existing lti (learning tools interoperability) domain configuration in the blackboard learn platform. it is used to modify various settings related to lti tool integration, including domain information, security settings, user data sharing preferences, and service permissions. the endpoint is particularly useful when changes need to be made to an existing lti tool configuration, such as updating the primary domain, modifying data sharing settings, or adjusting service permissions. it provides fine-grained control over how the lti tool interacts with blackboard learn and what data it can access. this endpoint should be used carefully, as changes to these settings can significantly impact the functionality and security of the lti integration.
</Accordion>

<Accordion title="Update admin node roles">
  Updates the roles of an administrative user for a specific node within the institutional hierarchy of blackboard. this endpoint allows you to modify the permissions and responsibilities of an admin user by assigning or changing their roles for a particular node. it is used when you need to adjust an admin's access or capabilities within a specific part of the institution's structure. the endpoint requires the node id, user id, and a list of roles to be assigned. it's important to note that this operation replaces the existing roles for the user at the specified node, so all desired roles should be included in the request.
</Accordion>

<Accordion title="Retrieve course gradebook column attempts">
  Retrieves attempt data for a specific gradebook column within a blackboard course. this endpoint allows instructors and administrators to access detailed information about student attempts on assignments, tests, or other graded activities associated with the specified gradebook column. it is particularly useful for tracking student progress, analyzing performance trends, and gathering data for assessment purposes. the endpoint should be used when detailed information about individual student attempts is needed, such as for grading, providing feedback, or generating reports. it does not modify any data and is intended for read-only access to attempt information.
</Accordion>

<Accordion title="Get course gradebook attempt">
  Retrieves detailed information about a specific attempt for a gradebook column in a blackboard course. this endpoint allows instructors or authorized users to access individual student attempt data, including scores, submission dates, and potentially feedback. it's particularly useful for tracking student progress, reviewing specific submissions, or addressing grade inquiries. the endpoint should be used when detailed information about a single attempt is needed, rather than for bulk data retrieval or when an overview of all attempts is required.
</Accordion>

<Accordion title="Update gradebook column">
  This endpoint updates a specific grade column in a course's gradebook. it allows modification of column details, scoring settings, availability, grading options, and rubric associations. use it to adjust existing columns for changes in course structure or grading policies. note that some fields are version-specific or limited by course type (classic vs ultra).
</Accordion>

<Accordion title="Patch course details by id">
  Updates an existing course in blackboard learn with the provided information. this endpoint allows modification of various course attributes including basic details, availability settings, enrollment options, and localization preferences. it's particularly useful for administrators or instructors who need to adjust course settings after initial creation, such as changing the course name, updating its availability, or modifying enrollment options. the endpoint supports partial updates, meaning only the fields that need to be changed should be included in the request body. note that some settings, like allowing guests or observers, are only modifiable for classic courses, while others apply to both classic and ultra courses. care should be taken when using the 'closedcomplete' status, as it can limit further updates, especially for ultra courses.
</Accordion>

<Accordion title="Update attendance records">
  Creates or updates attendance records for the meeting for all users in the course. user required both of the entitlements below. if the user does not have the required entitlements,no records are created or modified. entitlement | user access ------------|----------- course.attendance.create | create course/organization course meeting attendance course.attendance.modify | update course/organization meeting attendance **since**: 3500.7.0
</Accordion>

<Accordion title="Patch term details by termid">
  Updates an existing term in the blackboard learn platform. this endpoint allows modification of various term properties, including its external id, name, description, availability settings, and duration. it's particularly useful for adjusting term dates, changing access settings, or updating term information after initial creation. the endpoint supports partial updates, meaning you only need to include the fields you want to modify. note that some settings, like duration type, may require additional fields to be updated simultaneously for consistency.
</Accordion>

<Accordion title="Patch course content review status">
  Updates the review status of a specific content item for a particular user within a blackboard learn course. this endpoint allows for marking course materials as reviewed or not reviewed, which can be useful for tracking student progress or ensuring compliance with course requirements. it should be used when a user has completed reviewing a piece of content or when their review status needs to be reset. this operation is particularly useful for self-paced learning scenarios or when instructors need to monitor student engagement with course materials. the endpoint is available from blackboard learn api version 3700.16.0 onwards.
</Accordion>

<Accordion title="Update pronoun status by id">
  Updates the information for a specific pronoun in the blackboard system. this endpoint allows modification of an existing pronoun's name and status, identified by the pronoun id in the url path. it's used to manage the list of available pronouns that users can select for their profiles, supporting inclusive identity representation. the endpoint should be used when administrators need to edit pronoun details or change approval statuses. note that this operation only updates the specified fields and does not affect other pronoun attributes not included in the request.
</Accordion>

<Accordion title="Update rubric evaluation">
  Updates a specific rubric evaluation for a course in the blackboard learning management system. this endpoint allows for modifying the scores and feedback for individual criteria within a rubric that has been associated with a course item (such as an assignment or discussion). it is used when an instructor needs to adjust their evaluation of a student's work using a predefined rubric. the update can include changes to scores for different rubric cells and detailed feedback using blackboard's rich text format (bbml). this endpoint is particularly useful for refining assessments, providing more detailed feedback, or correcting errors in previous evaluations.
</Accordion>

<Accordion title="Update course toc item">
  Updates the visibility settings for a specific table of contents (toc) item within a blackboard course. this endpoint allows you to modify guest and observer access permissions for a particular toc item. use this when you need to change who can view certain course content, such as during course setup or when adjusting access throughout the semester. the endpoint only updates visibility settings and does not modify other properties of the toc item. note that this operation may affect course accessibility and should be used carefully to ensure compliance with institutional policies.
</Accordion>

<Accordion title="Update lti placement details">
  This endpoint allows you to update an existing lti (learning tools interoperability) placement in the blackboard learning management system. it provides granular control over various aspects of the placement, including its name, description, icon, url, visibility settings, grading capabilities, and custom launch parameters. use this endpoint when you need to modify the properties of an existing lti integration, such as changing its availability, updating its display information, or adjusting its behavior within courses. the endpoint is particularly useful for administrators or instructors who need to fine-tune the integration of external learning tools with blackboard.
</Accordion>

<Accordion title="Modify user enrollment in course">
  Updates a user's membership details within a specific blackboard course. this endpoint allows for modifying various aspects of a user's enrollment, including their role, availability, and position within the course hierarchy. it's particularly useful for managing cross-listed courses, updating user roles, and adjusting instructor display orders. the endpoint should be used when changes to a user's course membership are required, such as promoting a teaching assistant to an instructor or updating a user's availability status. it does not provide functionality for adding or removing users from a course.
</Accordion>

<Accordion title="Modify assessment question">
  This endpoint allows you to update an existing question within a specific assessment in a blackboard course. it provides the ability to modify various aspects of the question, including its title, content, scoring, feedback, and positioning within the assessment. this tool is particularly useful for refining assessment questions after initial creation, adjusting difficulty levels, or incorporating new information into existing questions. it supports a wide range of question types, from simple multiple-choice to complex ai-driven chat questions, making it versatile for different educational needs. when using this endpoint, ensure that the updates maintain the integrity and educational objectives of the assessment.
</Accordion>

<Accordion title="Update course primary node status">
  Updates the association between a course and a node in the blackboard learn institutional hierarchy. this endpoint allows you to modify the primary status of a course-node association. use this when you need to change whether a specific node is the primary association for a course, which can affect how the course is organized and displayed within the institutional hierarchy. this operation is particularly useful for managing course placements in complex institutional structures with multiple hierarchical levels. note that this endpoint only modifies the 'isprimary' status and does not create or delete associations.
</Accordion>

<Accordion title="Patch course rubric details">
  Updates a specific rubric within a blackboard learn course. this endpoint allows for modification of various aspects of an existing rubric, including its title, description, type, and detailed grading criteria. it's used to refine assessment tools, adjust grading scales, or modify evaluation criteria without creating an entirely new rubric. the update can encompass changes to the rubric's structure (columns and rows) as well as the specific grading details in each cell. this functionality is particularly useful for instructors who need to fine-tune their assessment methods based on course progression or student feedback. note that this endpoint modifies an existing rubric; it cannot be used to create a new one or to delete a rubric entirely.
</Accordion>

<Accordion title="Update course message read status">
  Updates the read status of a specific message within a blackboard course. this endpoint allows you to mark a message as read or unread, which can be useful for tracking user engagement or managing message statuses. use this when you need to update the read status of a particular message, such as when a user views a message or wants to mark it as unread for later attention. the endpoint only modifies the read status and does not affect other properties of the message or return the updated message content.
</Accordion>

<Accordion title="Create new uploads">
  Uploads a file to the blackboard learn platform. this endpoint allows users to add various types of educational content, such as documents, images, or multimedia files, to courses or other areas within blackboard. it should be used when new materials need to be added to the platform or existing content needs to be updated. the endpoint handles the file transfer process, but does not automatically associate the uploaded file with any specific course or content area; additional api calls may be required for such organization. note that file size limits and supported file types may vary depending on the specific blackboard learn instance configuration.
</Accordion>

<Accordion title="Update rubric association settings">
  Updates the properties of a rubric association within a specific blackboard course. this endpoint allows for modifying various aspects of how a rubric is associated with course content, including its visibility to students and its use in grading. it can be used to adjust rubric settings after initial setup, enabling instructors to fine-tune their assessment strategies. the endpoint is particularly useful for changing rubric visibility or toggling whether the rubric is used for grading without creating a new association. note that this endpoint updates an existing association; it cannot create new associations or completely remove existing ones.
</Accordion>

<Accordion title="Get course groups">
  Retrieves a list of all groups associated with a specific course in the blackboard learning management system. this endpoint allows educators and administrators to access information about the various student groups created within a particular course. it is useful for managing course structure, facilitating group assignments, and organizing collaborative activities. the endpoint returns details about each group, which may include group names, descriptions, and member counts. it should be used when there's a need to review or manage the group structure of a course. note that this endpoint only provides group information and does not allow for the modification of groups or their memberships.
</Accordion>

<Accordion title="Update user information">
  Updates a user's profile in the blackboard learning management system. this endpoint allows for partial or complete updates to various aspects of a user's account, including personal information, contact details, system roles, and preferences. it's particularly useful for synchronizing user data with external systems, managing user accounts, or allowing users to update their own information. the endpoint supports granular updates, meaning you can modify specific fields without affecting others. be cautious when updating sensitive information like passwords or system roles, as these changes can significantly impact the user's access and experience within the blackboard system.
</Accordion>


# Bolna
Source: https://docs.push.ai/integrations/bolna



Create conversational voice agents using Bolna AI to enhance interactions, streamline operations and automate support.

<Accordion title="Get all agents">
  List all agents
</Accordion>

<Accordion title="Retrieve batch details by id">
  Retrieve a batch
</Accordion>

<Accordion title="Get all phone numbers">
  List all phone numbers for your account
</Accordion>

<Accordion title="Retrieve batch execution list">
  Retrieve all executions from a batch
</Accordion>

<Accordion title="Schedule batch by id">
  Schedule a batch for calling via agent
</Accordion>

<Accordion title="Setup inbound call for agent">
  Add agent for inbound calls
</Accordion>

<Accordion title="Stop batch by id">
  Stop a running batch
</Accordion>

<Accordion title="Retrieve agent by id">
  Retrieve an agent
</Accordion>

<Accordion title="Retrieve agent execution status">
  Retrieve all executions by an agent
</Accordion>

<Accordion title="Make a phone call from agent">
  Initiate calls
</Accordion>

<Accordion title="Delete batch by id">
  Delete a batch
</Accordion>

<Accordion title="Delete agent by id">
  Delete an agent
</Accordion>

<Accordion title="Retrieve agent execution details">
  Retrieve specific execution by an agent
</Accordion>

<Accordion title="Fetch all batches by agent id">
  List all batches for agent
</Accordion>

<Accordion title="Get execution by id">
  Retrieve specific execution by `execution id`
</Accordion>


# Borneo
Source: https://docs.push.ai/integrations/borneo



Borneo is a data security and privacy platform designed for sensitive data discovery and remediation.

<Accordion title="Add discovered recipients">
  Adds multiple discovered recipients to the system as confirmed recipients. this endpoint should be used when you have a list of previously discovered recipient ids that you want to officially add to your recipient database. it's particularly useful for bulk operations where multiple recipients need to be added simultaneously. the endpoint accepts an array of unique uuids, allowing for efficient processing of multiple recipients in a single api call. note that this endpoint only adds recipients; it does not provide any information about the recipients or perform any other actions beyond adding them to the system.
</Accordion>

<Accordion title="Create employee with json payload">
  Creates a new employee record in the borneo integration platform. this endpoint allows you to add an employee to the system with various details such as personal information, job-related data, and organizational structure. it's primarily used when onboarding new employees or updating the system with employee information from external sources. the endpoint captures both mandatory fields (name, surname, createdby) and optional fields for a comprehensive employee profile. it's particularly useful for hr systems integration, allowing synchronization with external apis through the referenceid field. note that while it collects employment dates, it doesn't automatically handle employee status changes or departures; these would likely require separate api calls or processes.
</Accordion>

<Accordion title="Create domain with polling frequency">
  Creates a new domain within the borneo integration platform, allowing for automatic polling and management of connected systems or applications. this endpoint is used to set up a new integration point with a specific name and polling frequency. it should be used when establishing a new connection or integration within the borneo ecosystem. the endpoint is particularly useful for setting up automated data synchronization or workflow triggers between different business applications. it does not provide information about existing domains or modify existing ones; it is strictly for creating new domains.
</Accordion>

<Accordion title="Archive discovered recipient">
  Archives a specific discovered recipient in the borneo platform. this endpoint is used to move a discovered recipient's data into an archived state, which may be useful for compliance, data retention, or organizational purposes. it should be called when you need to store historical data about a recipient that has been identified through borneo's data visibility and privacy automation processes. the endpoint uses a post method, suggesting it may trigger backend processes to properly archive the recipient's data. note that this operation might affect the visibility or accessibility of the recipient's data in other parts of the system.
</Accordion>

<Accordion title="Create headquarter entry">
  Creates a new headquarters entry in the borneo integration platform. this endpoint allows users to register the main office or primary location of a company or organization within the system. it captures essential information about the headquarters, including its name, address, and associated identifiers. use this endpoint when setting up a new company profile or updating the primary business location. the endpoint ensures data consistency by enforcing specific formatting rules for each field. it's particularly useful for organizations managing multiple locations or integrating headquarters data with other business systems.
</Accordion>

<Accordion title="Create legal document entry">
  Creates or uploads a new legal document in the borneo integration platform with specified metadata. this endpoint allows users to add various types of legal documents, such as privacy policies or data processing agreements, to the system. it captures essential information about the document, including its location, type, applicable region, and discovery settings. use this endpoint when you need to integrate new legal documents into your workflow or update existing ones with new versions. the tool is particularly useful for maintaining a centralized repository of legal documents across different regions and categories within your organization.
</Accordion>

<Accordion title="Create processing activity threshold">
  Creates a new threshold for a specific data processing activity in the context of lopdp (law on personal data protection) compliance. this endpoint is used to define and assess various risk factors associated with data processing activities. it allows for the creation of detailed risk profiles by setting multiple boolean flags for different aspects of data processing, such as systematic personal assessment, large-scale observation, and handling of sensitive data. the threshold can be saved as a draft or activated immediately. this tool is essential for organizations to evaluate and document their data processing activities for compliance purposes and risk management.
</Accordion>

<Accordion title="Delete dashboard report by id">
  Deletes a specific dashboard report from the borneo integration platform. this endpoint should be used when you need to permanently remove a dashboard report that is no longer needed or relevant. it's important to note that this action is irreversible, and once a report is deleted, it cannot be recovered. use this endpoint with caution, ensuring that the report is no longer required before deletion. the endpoint does not return the deleted report data, so make sure to retrieve any necessary information before deletion if needed.
</Accordion>

<Accordion title="Delete department by id">
  Deletes a specific department from the borneo platform using its unique identifier. this endpoint should be used when you need to remove a department that is no longer relevant or has been decommissioned. it's important to note that this operation is irreversible and will permanently remove all data associated with the specified department. use this endpoint with caution, as it may impact resource management and organizational structure within the borneo context. before deletion, ensure that all necessary data has been backed up or transferred to other relevant departments if required.
</Accordion>

<Accordion title="Delete domain by id">
  Deletes a specific domain from the borneo integration platform. this endpoint permanently removes all data and configurations associated with the specified domain. use this operation with caution, as it cannot be undone. it should be used when a domain is no longer needed or when cleaning up unused resources. this operation may have cascading effects on related integrations or workflows, so ensure all dependencies are considered before deletion. the api will likely require appropriate authentication and authorization to perform this sensitive operation.
</Accordion>

<Accordion title="Delete asset by id">
  The deleteasset endpoint removes a specific asset from the borneo integration platform. this operation is used when an asset needs to be permanently deleted from the system, such as when it's no longer relevant or has been decommissioned. the deletion is irreversible, so it should be used with caution. this endpoint is particularly useful for maintaining an up-to-date asset inventory, cleaning up obsolete data, or managing system resources. it's important to note that deleting an asset may have implications on related data or integrations, so users should ensure that the asset is no longer needed before proceeding with deletion.
</Accordion>

<Accordion title="Create threshold for processing activity">
  Creates a new threshold for a specific data processing activity in the borneo integration platform. this endpoint is used to define and set various characteristics and risk factors associated with a data processing activity, which is crucial for privacy compliance and risk assessment. the threshold creation process captures detailed information about the nature, scope, and potential impact of data processing, allowing organizations to evaluate and manage privacy risks effectively. use this endpoint when setting up new data processing activities or updating the risk profile of existing ones. the created threshold can be in either 'draft' or 'activated' status, allowing for review before finalizing. note that while many parameters are optional, providing comprehensive information ensures a more accurate risk assessment.
</Accordion>

<Accordion title="Create new asset">
  Creates a new asset in the borneo integration platform. this endpoint allows users to add various types of assets to their inventory, ranging from hardware and software applications to office furniture and documentation. it's primarily used when onboarding new resources or updating the asset registry. the endpoint captures essential information about each asset, including its type, location, and associated identifiers. it's particularly useful for organizations managing diverse asset portfolios across multiple locations. note that while creating an asset, only the name and type are required, allowing for flexible asset management workflows.
</Accordion>

<Accordion title="Delete data breach by id">
  Deletes a specific data breach evaluation record from the borneo system. this endpoint should be used when an organization needs to remove an evaluation record, typically in cases where the record is no longer relevant, contains errors, or needs to be purged for compliance reasons. the operation is irreversible, so it should be used with caution. this tool is part of borneo's databreachmanagement functionality, supporting the platform's data protection and privacy management capabilities. it helps maintain an accurate and up-to-date record of data breach evaluations, which is crucial for regulatory compliance and risk management.
</Accordion>

<Accordion title="Delete employee by id">
  Deletes an employee record from the borneo system using the specified employee id. this endpoint should be used when an employee leaves the organization or when their record needs to be permanently removed from the system. once deleted, the employee data cannot be recovered through the api, so use this endpoint with caution. it's recommended to archive or backup employee data before deletion if retention is required for compliance or record-keeping purposes. this operation is final and irreversible within the borneo platform.
</Accordion>

<Accordion title="Create recipient with details">
  Creates a new recipient in the borneo integration platform. this endpoint is used to register and manage detailed information about entities that receive or process data within the system. it captures essential details for compliance with data protection regulations, including the recipient's role, location, data storage information, and associated legal documents like data processing agreements (dpas). the endpoint is particularly useful for organizations managing complex data ecosystems with multiple partners, vendors, or internal departments. it should be used when onboarding new data recipients or updating existing recipient information to maintain accurate records for auditing and compliance purposes. note that while many fields are optional, providing comprehensive information enhances the system's ability to manage data flow and compliance effectively.
</Accordion>

<Accordion title="Delete category by label">
  Deletes a specific category from the borneo integration platform using its unique label. this endpoint should be used when you need to remove an entire category and all its associated data from the system. it's particularly useful for cleaning up outdated or unnecessary categories. be cautious when using this endpoint, as the deletion is permanent and cannot be undone. this operation will fail if the specified category doesn't exist or if there are any dependencies preventing its deletion.
</Accordion>

<Accordion title="Delete dpia by id">
  Deletes a specific data protection impact assessment (dpia) from the borneo system. this endpoint should be used when a dpia is no longer needed or relevant, such as when a project has been completed or cancelled, or when the assessment needs to be removed due to policy changes. the operation is irreversible, so it should be used with caution. once deleted, the dpia and its associated data cannot be recovered through the api. this endpoint is part of borneo's data privacy management features, allowing organizations to maintain an up-to-date repository of their dpias.
</Accordion>

<Accordion title="Create and schedule cloud resource scan">
  The createscan endpoint initiates a new scan operation in the borneo integration platform, allowing users to configure and schedule data scans across various cloud resources. this powerful tool enables users to set up both one-time and recurring scans, with extensive customization options for resource selection, data inspection policies, and scan limits. it's particularly useful for compliance checks, sensitive data discovery, and regular security audits across cloud environments. the endpoint supports a wide range of resource types and provides flexible scheduling options, from immediate execution to complex cron-based recurring scans. users should carefully consider the scan configuration to balance thoroughness with resource utilization, especially for large-scale environments. while highly versatile, users should note that some features may be resource-type dependent, and should refer to borneo's documentation for specific connector and filter support.
</Accordion>

<Accordion title="Delete lopdp threshold by id">
  This endpoint deletes a specific lopdp (local public data protection) threshold from the borneo integration platform. it is used to remove outdated, incorrect, or no longer applicable thresholds related to data protection regulations. the deletion is permanent and cannot be undone, so it should be used with caution. this endpoint is particularly useful when updating compliance settings or when certain thresholds are no longer relevant due to changes in regulations or business processes. it should not be used for temporary disabling of thresholds; instead, use it only when the threshold needs to be completely removed from the system.
</Accordion>

<Accordion title="Delete processing activity by id">
  Deletes a specific processing activity from the borneo integration platform. this endpoint should be used when you need to permanently remove a data processing activity that is no longer required or valid. it's important to note that this action is irreversible, and once a processing activity is deleted, it cannot be recovered. use this endpoint with caution, as it may impact existing data flows or integrations that depend on the deleted activity. the endpoint does not return the deleted data; it typically returns a success status if the deletion was completed successfully.
</Accordion>

<Accordion title="Delete legal document by id">
  Deletes a specific legal document from the borneo platform using its unique identifier. this endpoint should be used when a document needs to be permanently removed from the system, such as when it's no longer relevant, outdated, or to comply with data retention policies. it's important to note that this operation is irreversible and should be used with caution. the deletion process ensures compliance with gdpr and fedramp standards, maintaining a secure audit trail of the action. before deletion, ensure that all necessary backups or archival processes have been completed, as the document will no longer be accessible through the system after this operation.
</Accordion>

<Accordion title="Delete recipient by id">
  Deletes a specific recipient from the borneo integration platform. this endpoint should be used when you need to permanently remove a recipient's information from the system, such as when a contact is no longer valid or when correcting erroneous entries. the operation is irreversible, so it should be used with caution. once a recipient is deleted, any associated data or integration settings for that recipient will also be removed. this endpoint is particularly useful for maintaining data hygiene and complying with data retention policies.
</Accordion>

<Accordion title="Create new infotype category">
  Creates a new infotype category in the borneo integration platform, allowing users to organize and group related sensitive data types. this endpoint is used to establish a structured hierarchy for managing various infotypes, such as pii, pfi, and phi, enhancing data protection and compliance efforts. the created category serves as a container for specific infotypes, facilitating efficient data classification and management within the borneo ecosystem.
</Accordion>

<Accordion title="Delete tag from resource">
  The deletetags endpoint removes specified tags from resources in the borneo integration platform. it allows users to delete tags based on their key, and optionally, their value, from a set of resources defined either by a filter or a list of resource ids. this endpoint is useful for maintaining clean and organized resource tagging, especially when tags become obsolete or need to be updated en masse. it's particularly helpful for bulk tag removal across multiple resources or resource types. however, users should exercise caution as tag deletion is irreversible and may affect resource management and organization within the borneo platform.
</Accordion>

<Accordion title="Disable dashboard user by username">
  Disables a specified user account in the borneo dashboard, preventing further access to the system. this endpoint should be used when an administrator needs to revoke a user's access to the borneo integration platform, such as when an employee leaves the organization or their role changes. the operation is not reversible through this endpoint, so it should be used with caution. note that disabling a user does not delete their account or associated data; it only restricts their ability to log in and use the dashboard.
</Accordion>

<Accordion title="Access scan iteration by id">
  Retrieves detailed information about a specific scan iteration in the borneo integration platform. this endpoint allows users to fetch the current status, results, and metadata associated with a particular scan iteration. it should be used when monitoring the progress of a scan, analyzing results, or troubleshooting integration workflows. the endpoint provides a snapshot of the scan iteration at the time of the request and may not reflect real-time updates if the scan is still in progress. it's particularly useful for auditing, reporting, and maintaining a history of scan operations within borneo's automation and integration processes.
</Accordion>

<Accordion title="Create dashboard user">
  Creates a new dashboard user in the borneo integration platform with specified roles, organizational access, and authentication settings. this endpoint allows for granular control over user permissions across different organizations and departments within the borneo ecosystem. it supports integration with external identity providers (okta or gcp) for authentication. use this endpoint when onboarding new users or updating existing user permissions. note that while only the email is required, it's recommended to provide comprehensive role and organization information for proper access control.
</Accordion>

<Accordion title="Delete headquarters by id">
  Deletes a specific headquarters record from the borneo system. this endpoint should be used when you need to permanently remove a headquarters entry from your organization's data. it's particularly useful for cleaning up obsolete or erroneous headquarters data. exercise caution when using this endpoint, as the deletion is irreversible and will remove all associated data for the specified headquarters. ensure you have the correct headquarterid before proceeding with the deletion to avoid unintended data loss. this operation may have cascading effects on related data, such as employee records or location-based configurations.
</Accordion>

<Accordion title="Create department with translations">
  Creates a new department in the borneo integration platform. this endpoint allows you to add a department to the system with support for multilingual information. it's particularly useful when setting up the organizational structure within borneo or when expanding to new regions requiring localized department names. the endpoint should be used when you need to establish a new department entity that other parts of the system can reference. it's important to note that this endpoint only creates the department and does not associate it with any specific workflows or integrations - those would need to be set up separately.
</Accordion>

<Accordion title="Delete threshold by id">
  Deletes a specific threshold from the borneo integration platform. this endpoint should be used when you need to remove a threshold that is no longer required for monitoring or alerting purposes within your integrations. it permanently removes the threshold configuration from the system, so use with caution. this operation cannot be undone, and once a threshold is deleted, any associated alerts or monitoring rules will cease to function. ensure that the threshold is no longer needed before deletion to avoid disrupting active monitoring processes.
</Accordion>

<Accordion title="Create dpia for processing activity">
  Creates a new data protection impact assessment (dpia) for a specific processing activity in the borneo application. this endpoint allows users to comprehensively assess and document privacy risks associated with data processing, including confidentiality, integrity, and availability risks. it should be used when initiating a new dpia process or updating an existing one with detailed risk assessments and mitigation measures. the tool provides a structured approach to evaluating privacy concerns and ensuring compliance with data protection regulations. however, it does not automatically implement any risk mitigation measures; it only facilitates the assessment and documentation process.
</Accordion>

<Accordion title="Download dashboard report">
  The downloaddashboardreport endpoint allows users to download specific types of dashboard reports from the borneo integration platform. this post endpoint is designed to generate and retrieve comprehensive reports related to privacy operations, data discovery, and data flow within an organization's systems. it should be used when detailed insights into data management, privacy compliance, or data flow visualizations are required. the endpoint is particularly useful for privacy officers, data analysts, or system administrators who need to review or present aggregated data on the organization's data handling practices. note that the report generation process may take some time depending on the complexity and amount of data being analyzed, so users should be prepared for a potential delay before receiving the downloaded report.
</Accordion>

<Accordion title="Enable dashboard user">
  Enables dashboard access for a specified user in the borneo integration platform. this endpoint is used to grant or restore a user's ability to view and interact with dashboards within the system. it should be called when an administrator needs to activate a user's dashboard privileges, such as after initial account creation or if access was previously revoked. the endpoint only handles enabling access and does not provide information about the user's current access status or other account details. note that this operation does not create a new user account; it assumes the specified username already exists in the system.
</Accordion>

<Accordion title="Download dashboard report edition">
  Downloads a specific dashboard report edition from the borneo integration platform. this endpoint allows users to retrieve a particular version or iteration of a dashboard report by providing its unique identifier. it should be used when a user needs to access or save a specific report edition, perhaps for archival purposes, offline analysis, or to compare different versions of a report. the endpoint accepts a post request with a json payload containing the report edition id. it's important to note that this tool only handles the download process and does not provide functionalities for listing available reports, creating new reports, or modifying existing ones. users should ensure they have the correct reporteditionid before making the request, as the schema does not specify any error handling for invalid ids.
</Accordion>

<Accordion title="Create processing activity">
  Creates a new processing activity in the borneo integration platform. this endpoint allows users to define and configure detailed attributes of a data processing activity, including its purpose, legal basis, data sources, subjects, retention policies, and organizational roles. it's essential for organizations to document their data processing activities for compliance with data protection regulations. use this endpoint when setting up a new data processing workflow or updating existing processes in your organization's data management strategy.
</Accordion>

<Accordion title="Filter and sort assets list">
  The listassets endpoint retrieves a customized list of assets from borneo. it supports flexible filtering and sorting, enabling efficient asset management. use this endpoint for generating reports, conducting audits, or searching specific items. while powerful, it may not provide detailed asset information in the initial response.
</Accordion>

<Accordion title="Get headquarters by id">
  Retrieves detailed information about a specific headquarters registered in the borneo system. this endpoint allows users to access comprehensive data about an organization's headquarters, which may include its location, data governance practices, compliance status, and security measures. it's particularly useful for auditing purposes, reviewing data management strategies, or assessing the overall data security posture of a specific organizational unit. the endpoint should be used when detailed information about a particular headquarters is needed, especially in the context of data security and governance. it may not provide real-time operational data or information about other organizational units not classified as headquarters.
</Accordion>

<Accordion title="Export processing activities list">
  This endpoint exports a filtered list of processing activities in specified formats and languages. it allows users to retrieve data about various data processing activities, which can be customized using multiple filter criteria. the export can be generated in csv, pdf, or doc formats, supporting multiple languages for localization. this tool is particularly useful for generating reports, conducting audits, or sharing processing activity information with stakeholders in their preferred format and language. note that at least one export format and a language must be specified for a successful request.
</Accordion>

<Accordion title="List headquarters with sorting">
  The headquarters list endpoint retrieves a paginated list of headquarters records from borneo. it supports efficient querying of large datasets through pagination and custom sorting. this endpoint is ideal for applications needing to display or process headquarters information in batches, such as for reports or dashboards. it offers flexible result retrieval and sorting capabilities, but lacks built-in filtering options.
</Accordion>

<Accordion title="Get insight by type and id">
  Retrieves a specific insight from the borneo platform based on its type and unique identifier. this endpoint is crucial for accessing detailed information about data observability, security, privacy, or compliance issues identified by borneo's ml-powered classifiers. use this when you need to fetch comprehensive data about a particular finding, such as sensitive data trends, privacy violations, or security gaps. the endpoint provides focused, in-depth information about a single insight, making it ideal for detailed investigations or generating specific reports. it does not provide aggregated data or lists of multiple insights; for those purposes, you would need to use a different endpoint.
</Accordion>

<Accordion title="Fetch data breach evaluation">
  Retrieves detailed information about a specific evaluated data breach incident. this endpoint should be used when you need to access comprehensive details about a particular data breach that has been assessed within the borneo platform. it provides insights into the nature, scope, and potential impact of the breach, which can be crucial for incident response, compliance reporting, and risk assessment. the tool is particularly useful for security teams, compliance officers, and data protection officers who need to review or report on specific data breach incidents. note that this endpoint only provides information about breaches that have already been evaluated and recorded in the system; it cannot be used to report new breaches or assess ongoing incidents.
</Accordion>

<Accordion title="List filtered sorted categories">
  The listcategories endpoint allows users to retrieve a list of categories from the borneo integration platform. it provides flexible options for filtering and sorting the results, enabling efficient category management and exploration. this endpoint is particularly useful when you need to fetch a subset of categories or organize them in a specific order for display or processing purposes. the response will include category information based on the applied filters and sorting criteria. note that this endpoint does not create, update, or delete categories; it is solely for retrieving existing category data.
</Accordion>

<Accordion title="List insight filters">
  The list-filters endpoint retrieves a list of available filters for data insights, specifically focused on file extension filters. this tool is used to obtain filtering options for managing and analyzing data within borneo's integration platform. it's particularly useful when users need to understand or apply filters based on file types in their data streams or integration processes. the endpoint requires a specific scan id, suggesting that filters are contextual to particular data scans or integration jobs. currently, the tool is limited to listing file extension filters, which may be used for data categorization, processing, or compliance purposes in data integration workflows.
</Accordion>

<Accordion title="Export inventory resource list">
  Exports a filtered and sorted list of inventory resources from the borneo integration platform. this endpoint allows for extensive customization of the exported data, including pagination, field selection, sorting, and filtering based on various criteria such as account, region, resource type, and tags. it also provides options to include aggregated statistics from child resources, violation metrics, and framework exception counts. use this endpoint when you need to retrieve a comprehensive, customized view of your inventory resources for analysis, reporting, or integration with other systems. the exported data can be further processed or used for compliance, resource management, or security auditing purposes. note that the response may be paginated for large result sets, requiring multiple api calls to retrieve all data.
</Accordion>

<Accordion title="Evaluate data breach impact">
  This endpoint allows users to evaluate and document details of a data breach incident. it is used to capture comprehensive information about a breach, including notifications made, affected parties, and an overall assessment. the endpoint supports saving evaluations as drafts, enabling users to revisit and complete the documentation process over multiple sessions if needed. the tool should be used when there's a need to record and assess the impact and response to a data breach, whether it's a new incident or an update to an existing evaluation. it's particularly useful for compliance purposes, helping organizations track their breach notification efforts and maintain detailed records of each incident. it's important to note that this endpoint does not automatically notify authorities or affected parties; it merely records whether such notifications have been made. users should ensure they follow appropriate breach notification procedures separately from using this tool.
</Accordion>

<Accordion title="Export insight page using scanid">
  The exportpageinsight endpoint allows users to export filtered inspection results from a specific scan in the borneo integration platform. this tool is particularly useful for retrieving and analyzing detailed information about scanned pages, resources, and detected info types. it provides extensive filtering capabilities to customize the exported data according to various criteria such as resource types, user associations, file types, and detection confidence levels. the endpoint should be used when a comprehensive export of scan results is needed, especially for further analysis or reporting purposes. it's important to note that while the filtering options are extensive, the performance may be affected when exporting large datasets with multiple complex filters applied simultaneously.
</Accordion>

<Accordion title="List scans with filters">
  The list scans endpoint retrieves a filtered and sorted list of scans from the borneo integration platform. it allows users to query scan data with extensive filtering options, including search terms, scan types, connector ids, resources, data planes, and scan statuses. the endpoint supports pagination for handling large result sets and provides control over the returned fields and sorting order. this tool is particularly useful for monitoring scan activities, analyzing scan results across different resources and connectors, and managing large-scale scanning operations in cloud environments.
</Accordion>

<Accordion title="Export filtered leaf resources">
  The listleafresources endpoint exports a comprehensive list of leaf resources in the borneo integration platform, allowing for extensive filtering, sorting, and detailed information retrieval. it's designed to facilitate data discovery, classification, and management across various cloud providers and services. this endpoint is particularly useful for conducting audits, managing data governance, or preparing reports on resource usage and sensitive data distribution across the organization's digital landscape. the function supports a wide range of filtering options, enabling precise querying based on resource attributes, metadata, and detected sensitive information. users can customize the output by sorting results and requesting detailed column-level information on detected infotypes. while powerful, users should be mindful of potential performance impacts when requesting detailed information or using complex filters on large datasets.
</Accordion>

<Accordion title="List filter options for recipients">
  Lists the available filters for recipients in the borneo integration platform based on the specified filter type. this endpoint allows users to retrieve either category-based or role-based filters, which can be used to manage and organize recipients for targeted data distribution or notification purposes. use this endpoint when you need to access the current set of filters available for recipient management, either by categories or roles. it provides a comprehensive list of filters but does not apply or modify any filters; it's purely for retrieval purposes. this tool is particularly useful for administrators or integrators who need to understand the current filter structure before applying filters to recipients or setting up data distribution rules.
</Accordion>

<Accordion title="List events with filters">
  Lists and retrieves events based on specified criteria, with options for filtering, sorting, and pagination. this endpoint is designed for querying event data in the borneo integration platform, allowing users to fetch events related to various entities such as issues, resources, scans, and users. it offers flexible querying capabilities through its filter object, custom sorting, and efficient pagination for handling large datasets. use this endpoint when you need to search, analyze, or monitor events within your borneo-integrated systems. the endpoint is particularly useful for generating reports, tracking specific issues, or monitoring system activities across different resources and users.
</Accordion>

<Accordion title="Filter and list inspection results">
  The insightlistpost endpoint retrieves a list of inspection results from the borneo integration platform. it allows users to fetch either scan-level or page-level results based on specified criteria. this endpoint is particularly useful for analyzing data security and compliance across various resources and scans. it supports extensive filtering options, pagination for large result sets, and customizable sorting, making it ideal for generating comprehensive reports or conducting detailed investigations into data insights. the endpoint should be used when a detailed overview of inspection results is required, but it may not provide real-time updates for ongoing scans.
</Accordion>

<Accordion title="Get domain by id">
  Retrieves detailed information about a specific domain within the borneo integration platform. this endpoint should be used when you need to access the current configuration, status, or other attributes of a particular domain. it provides a comprehensive view of the domain's settings, which can be useful for auditing, troubleshooting, or gathering information for further operations. the endpoint does not modify any domain data and is safe for frequent use. however, it's important to note that this endpoint only retrieves information for a single domain at a time and does not provide aggregated data across multiple domains.
</Accordion>

<Accordion title="List scan execution results">
  The listscanexecutions endpoint retrieves and filters inspection results from scan executions in the borneo integration platform. it allows users to query scan results with highly granular control, supporting filtering by scan ids, resource ids, infotypes, statuses, and confidence levels. this endpoint is particularly useful for analyzing scan outcomes, tracking specific resources, and managing large datasets through pagination and sorting capabilities. it should be used when you need to review or analyze the results of previous scans, especially when dealing with a large number of scanned resources or when looking for specific types of detected information. the endpoint does not perform new scans; it only retrieves and organizes existing scan results. keep in mind that the response may be truncated if there are more results than the specified page size, requiring the use of the nexttoken for subsequent requests to retrieve all relevant data.
</Accordion>

<Accordion title="Post log audit records with filter criteria">
  The retrieveauditlogs endpoint fetches filtered audit logs from borneo. it offers extensive filtering options for precise log retrieval across various cloud platforms and system components. use it for investigations, troubleshooting, and compliance checks. supports pagination with a 10,000 entry limit per call.
</Accordion>

<Accordion title="List data breaches with filters">
  The listdatabreaches endpoint retrieves a list of data breaches based on specified filter conditions, allowing for detailed searching and sorting of breach information. it supports pagination for handling large result sets and provides flexible filtering options including free-text search, authority notification status, owner, and breach status. this endpoint is particularly useful for compliance teams, security analysts, and it administrators who need to monitor, review, or report on data breach incidents within their organization. the tool facilitates efficient data breach management, enabling users to quickly locate specific incidents or generate comprehensive reports based on various criteria.
</Accordion>

<Accordion title="Post connector with filtering options">
  Retrieves a filtered and sorted list of connectors from the borneo integration platform. this endpoint allows you to search, filter, and paginate through available connectors based on various criteria such as names, states, types, and associated resources. it's particularly useful for managing large numbers of connectors, monitoring their states, or finding specific connectors within your integration ecosystem. the endpoint supports advanced filtering options, pagination for handling large result sets, and customizable sorting to organize the returned data. use this when you need to audit your connector inventory, check the status of multiple connectors, or find connectors matching specific criteria.
</Accordion>

<Accordion title="Post support chat query">
  The post /support/chat endpoint handles chat support interactions in borneo. it processes user queries for real-time assistance with platform issues or inquiries. use this endpoint to start or continue support conversations, enabling interactive problem-solving within borneo's ecosystem. not suitable for non-support communications or large data submissions.
</Accordion>

<Accordion title="Post resource stats with deleted resources">
  Retrieves statistics about resources within the borneo integration platform. this endpoint provides valuable insights into the current state and usage of resources in your borneo environment. it can be used to monitor resource utilization, track changes over time, and inform decision-making about resource management and scaling. the endpoint allows for optional inclusion of deleted resources in the statistics, providing flexibility in data analysis. it's particularly useful for administrators and developers who need to understand the overall resource landscape of their borneo implementation. note that this endpoint focuses on aggregated statistics and may not provide detailed information about individual resources.
</Accordion>

<Accordion title="Put tom status and note">
  Updates a specific technical operating model (tom) in the borneo integration platform. this endpoint allows users to modify the implementation status of a tom, add explanatory notes, and attach relevant documentation. it's primarily used for tracking and managing the lifecycle of toms within an organization's integration processes. the endpoint is particularly useful when the status of a tom changes, when additional context needs to be provided, or when supporting documents need to be linked to the tom. it should be used to keep tom information up-to-date and to maintain a clear record of tom progress and associated documentation.
</Accordion>

<Accordion title="List inventory resources with filters">
  Retrieves a comprehensive list of resources from borneo's inventory. supports detailed filtering, sorting, and pagination for efficient resource management and analysis across multiple cloud providers. ideal for security auditing, compliance monitoring, and inventory management tasks.
</Accordion>

<Accordion title="Post accounts with filter and sort options">
  The listaccounts endpoint retrieves a filtered and sorted list of accounts from the borneo platform. it supports complex querying based on various criteria, offers pagination for large datasets, and allows custom sorting. while providing extensive filtering, it doesn't return detailed account information or support real-time updates.
</Accordion>

<Accordion title="Post current dashboard user">
  Retrieves or updates information about the currently authenticated user in the borneo dashboard. this endpoint is designed to provide or modify user-specific data within the context of the borneo integration platform's dashboard. it should be used when the application needs to access or update the current user's profile, preferences, or permissions. the endpoint relies on the existing authentication context to identify the user, eliminating the need for additional parameters. it's important to note that this endpoint may not provide general user management functions and is specifically tailored for the authenticated user's dashboard experience.
</Accordion>

<Accordion title="Reset dashboard user password">
  Initiates a password reset process for a specified dashboard user in the borneo platform. this endpoint should be used when a user has forgotten their password or needs to change it for security reasons. it triggers the password reset mechanism, which typically involves sending a reset link or temporary password to the user's registered email address. this tool does not actually change the password but starts the secure reset process. it's important to note that this endpoint doesn't return the new password or reset token directly for security reasons.
</Accordion>

<Accordion title="Post filtered access logs">
  The listaccesslogs endpoint retrieves and filters access logs from the borneo integration platform. it allows users to search, filter, and paginate through logs based on various criteria such as user email, operation type, request id, and time range. this endpoint is essential for monitoring system activity, troubleshooting issues, and maintaining security compliance. use this endpoint when you need to analyze system usage, track specific user actions, or investigate particular requests or operations. it's particularly useful for auditing purposes, performance monitoring, and identifying patterns or anomalies in system access. the endpoint supports detailed filtering options, allowing for precise log retrieval. however, it's important to note that the results are limited to api logs only, and the maximum number of logs returned per call is capped at 10,000. for comprehensive log analysis, multiple calls may be necessary using the pagination feature.
</Accordion>

<Accordion title="List toms with filter and pagination options">
  The listtoms endpoint retrieves a filtered, sorted, and paginated list of toms from the borneo integration platform. it allows for complex querying of tom objects based on various criteria such as text search, categories, types, statuses, and ids. the endpoint supports pagination for handling large result sets and provides sorting capabilities for customized data presentation. this tool is ideal for browsing, searching, and analyzing collections of toms within the borneo system, enabling efficient data exploration and management. it should be used when a comprehensive view of toms is needed, subject to specific filtering and sorting requirements. the endpoint does not create, update, or delete toms; it is purely for retrieval and listing purposes.
</Accordion>

<Accordion title="List scan iterations with filter">
  The listscaniterations endpoint allows users to retrieve a paginated list of scan iterations with customizable filtering, sorting, and field selection options. this post request is ideal for querying and analyzing scan iteration data across multiple scans or resources. use it to fetch specific subsets of scan iterations, sort results based on various criteria, and control the amount of data returned in each api call. the endpoint supports efficient pagination for handling large datasets, making it suitable for both small-scale queries and extensive data analysis tasks. it's particularly useful for monitoring scan progress, auditing scan history, or gathering insights across multiple scan iterations.
</Accordion>

<Accordion title="Post classification stats">
  Retrieves statistical information about resource classifications based on the specified filter criteria. this endpoint allows you to query classification data for resources in the borneo integration platform. use this when you need to analyze the distribution or frequency of specific classifications within your integrated data. the endpoint returns aggregated statistics, not individual resource details. it's particularly useful for generating reports, monitoring classification trends, or validating the effectiveness of your classification processes within borneo.
</Accordion>

<Accordion title="Remove dashboard user by username">
  Removes a specified user from the dashboard in the borneo integration platform. this endpoint should be used when you need to revoke a user's access to the dashboard, typically during offboarding processes or when adjusting user permissions. the operation is irreversible, so use it with caution. it only removes the user from the dashboard and does not affect their overall account status in the borneo platform. this endpoint is particularly useful for administrators managing user access to specific dashboards within the system.
</Accordion>

<Accordion title="Post resource lineage filter">
  Retrieves the lineage information for a specified resource within the borneo integration platform. this endpoint allows users to trace the data flow both upstream and downstream from a given resource, providing crucial insights into data provenance and impact analysis. it's particularly useful for data governance, compliance tracking, and understanding data transformations within your integrated systems. the endpoint requires specifying the resource id and the depth of lineage to explore in both directions, enabling fine-grained control over the scope of the lineage query. use this when you need to understand the origin, transformations, and downstream effects of your data resources in borneo.
</Accordion>

<Accordion title="Resume scan by id">
  The resumedatascan endpoint allows users to resume a previously paused or interrupted data scan operation within the borneo integration platform. this put request is used to continue the scanning process for privacy risks or data vulnerabilities that was halted earlier. the endpoint is particularly useful in scenarios where a scan was temporarily stopped due to system maintenance, network issues, or intentional pausing. it should be used when there's a need to complete an unfinished scan without starting the entire process from the beginning. this tool doesn't initiate new scans or modify the scan parameters; it simply continues the existing scan from where it left off.
</Accordion>

<Accordion title="Post scan resource status">
  Retrieves and filters the resource status for a specific scan iteration in the borneo integration platform. this endpoint allows users to fetch detailed information about the status of resources associated with a particular scan, supporting pagination for large datasets and filtering by resource name. it's particularly useful for monitoring the progress of scans, troubleshooting issues with specific resources, or gathering data for reporting purposes. the endpoint should be used when detailed status information about scan resources is required, especially when dealing with large-scale scans that may involve numerous resources. note that while it supports retrieving up to 10,000 records per call, for very large scans, multiple calls using the nexttoken may be necessary to retrieve all data.
</Accordion>

<Accordion title="List user profile with filters and sorting">
  The listuserprofiles endpoint retrieves a paginated and filterable list of user profiles from borneo. it supports custom querying with search, field selection, sorting, and pagination. ideal for user management, reporting, and data synchronization tasks. the endpoint offers flexible data retrieval, optimizing for efficiency. note the 10,000 item limit per request, requiring pagination for larger datasets.
</Accordion>

<Accordion title="Retrieve account details by id">
  Retrieves detailed information for a specific account within the borneo integration platform. this endpoint should be used when you need to access comprehensive account data, including settings, permissions, integration configurations, and other relevant information associated with the account. it's particularly useful for account management tasks, auditing, or when displaying account details in a user interface. the endpoint returns the most up-to-date information available for the specified account. note that this endpoint does not provide real-time data security or privacy observability information; for those features, you may need to use separate dedicated endpoints within the borneo api.
</Accordion>

<Accordion title="Get resource inventory by id">
  Retrieves detailed inventory information for a specific resource identified by its unique resourceid. this endpoint is designed to provide up-to-date data on the quantity, quality, and status of resources managed by borneo resource investments ltd., such as mineral deposits or gold mines. it should be used when accurate, current inventory data is needed for resource planning, reporting, or analysis purposes. the endpoint returns comprehensive inventory details, which may include resource quantity, grade, extraction status, and other relevant metrics. however, it does not provide historical inventory data or future projections; it only reflects the current state of the resource inventory.
</Accordion>

<Accordion title="List issues with filters">
  The listissues endpoint allows users to retrieve a filtered and sorted list of issues from the borneo integration platform. it provides extensive filtering capabilities to narrow down results based on various criteria such as resources, cloud accounts, issue states, and severities. the endpoint supports pagination for handling large result sets efficiently and allows customization of the returned data through column selection and inclusion of related resources. this powerful querying tool is essential for monitoring, troubleshooting, and managing issues across integrated systems and cloud environments in borneo.
</Accordion>

<Accordion title="Post dashboard report">
  Creates or schedules a dashboard report in the borneo integration platform for privacy operations and data discovery. this endpoint allows users to generate various types of reports, including privacy ops dashboard, data discovery dashboard, and privacy ops data flow. it supports both immediate and scheduled report generation with flexible frequency options. the tool is designed to help organizations track sensitive data, ensure compliance, and manage privacy across their infrastructure. use this endpoint when you need to set up regular privacy and data discovery reports or generate one-time reports for immediate analysis. note that the endpoint does not provide real-time data but rather creates reports based on the most recent data available at the time of report generation.
</Accordion>

<Accordion title="Retrieve department information">
  Retrieves detailed information about a specific department within the borneo integration platform. this endpoint is part of the departmentsapi and is used to fetch comprehensive data about a single department, including its configuration, associated workflows, and integration settings. it's particularly useful when you need to review or audit a department's setup within the borneo ecosystem. the endpoint should be used when detailed information about a specific department is required, such as during troubleshooting, reporting, or when updating department configurations. note that this endpoint only provides read access to department data and cannot be used to modify department information.
</Accordion>

<Accordion title="Retrieve discovered document by id">
  Retrieves detailed information about a specific discovered document within the borneo system. this endpoint allows users to access metadata, content, or processing status of a document that has been ingested, processed, or otherwise managed by borneo's document management capabilities. it should be used when detailed information about a particular document is needed, such as during workflow processing, auditing, or information retrieval tasks. the endpoint is particularly useful for tracking the lifecycle of a document within borneo's ecosystem, from discovery to final processing or archival stages. note that this endpoint only provides information about a single document; for bulk operations or document listings, a different endpoint would be more appropriate.
</Accordion>

<Accordion title="Retrieve discovered infotype by id">
  Retrieves detailed information about a specific discovered infotype from the borneo platform. this endpoint is used to access the characteristics, classification, and metadata of a particular data type that has been identified and categorized during the data discovery process. it is particularly useful for understanding the nature of sensitive or important data within your organization's systems. the endpoint should be used when you need to review or analyze the properties of a specific discovered infotype, such as its sensitivity level, applicable compliance rules, or prevalence in your data landscape. it does not modify or create new infotypes; it only provides read access to existing discovered infotype information.
</Accordion>

<Accordion title="Export recipients list with filter">
  The exportrecipientslist endpoint generates and exports a list of recipients based on specified criteria. it allows for flexible data extraction in multiple formats (csv, pdf, or doc) with extensive filtering options. this endpoint is ideal for generating reports, performing data analysis, or creating backups of recipient information. it can handle complex queries to narrow down the recipient list based on various attributes such as categories, roles, processing activities, and more. however, it does not provide real-time updates and should be used for point-in-time exports rather than live data access. the endpoint is particularly useful for compliance reporting, auditing, or transferring recipient data to other systems.
</Accordion>

<Accordion title="Retrieve employee details by id">
  Retrieves detailed information for a specific employee within the borneo integration platform. this endpoint should be used when you need to access comprehensive data about an individual employee, such as their personal details, job information, or any other relevant data stored in the system. it's particularly useful for displaying employee profiles, verifying employee information, or as part of more complex workflows that require up-to-date employee data. the endpoint returns a single employee record based on the provided employee id. note that this endpoint only retrieves data and does not modify any employee information. it should not be used for bulk data retrieval or when you need summarized information about multiple employees.
</Accordion>

<Accordion title="Retrieve discovered recipient by id">
  Retrieves detailed information about a specific discovered recipient using their unique identifier. this endpoint is part of the recipient management and discovery process within the borneo integration platform. it should be used when you need to access comprehensive data about a particular recipient that has been identified or discovered by the system. the endpoint is useful for verifying recipient details, updating records, or integrating recipient information into other workflows. note that this endpoint only provides information for recipients that have already been discovered and added to the system; it cannot be used to search for new recipients or modify existing recipient data.
</Accordion>

<Accordion title="Filter employee list">
  The filteremployeelist endpoint allows you to retrieve a filtered list of employees based on specified criteria. this post operation is designed for querying employee data within the borneo integration platform, enabling efficient data retrieval for various business processes and integrations. use this endpoint when you need to fetch a subset of employee records matching particular conditions, such as department, job title, or hire date. the endpoint supports pagination for handling large result sets, making it suitable for applications that need to display or process employee data in manageable chunks. note that the specific filterable fields may vary depending on your borneo instance configuration and available employee data.
</Accordion>

<Accordion title="Post data breach information">
  Creates a new data breach report in the borneo platform. this endpoint allows users to submit comprehensive information about a data breach incident, including details about the occurrence, discovery, affected data and individuals, security measures, and follow-up actions. the report can be saved as a draft or submitted as a final version. it supports multiple languages and allows for the inclusion of additional related information through uuids. this tool should be used when documenting and reporting data breach incidents within an organization, helping to ensure compliance with data protection regulations and facilitating incident response and analysis. it's particularly useful for security teams, compliance officers, and data protection officers who need to maintain detailed records of data breaches.
</Accordion>

<Accordion title="Retrieve asset by id">
  Retrieves detailed information about a specific asset within the borneo integration platform. this endpoint allows users to fetch comprehensive data about a single asset, including its properties, metadata, and current status. it should be used when detailed information about a particular asset is needed, such as during asset management, auditing, or when integrating asset data with other systems. the endpoint provides a snapshot of the asset's current state and attributes, which can be crucial for decision-making in data governance, security analysis, or integration processes. note that this endpoint only retrieves information and does not modify the asset in any way. it may not provide historical data or version history of the asset, focusing instead on its current state.
</Accordion>

<Accordion title="List data breach filters">
  Retrieves a list of available filter options for data breaches in the borneo platform. this endpoint allows users to obtain specific filter criteria based on either the owner of the data breach or its current status. it's particularly useful for preparing dynamic filter options in user interfaces or for understanding the range of possible values when filtering data breaches. the endpoint should be called when setting up data breach management dashboards or when implementing search and filter functionality for data breach records. note that this endpoint only provides filter options and does not return actual data breach information.
</Accordion>

<Accordion title="Retrieve lopdp threshold by id">
  Retrieves detailed information about a specific lopdp (logical object data point) threshold configuration within the borneo integration platform. this endpoint is used to access the settings and parameters of a particular threshold, which are crucial for monitoring system performance and triggering alerts. it should be used when detailed information about a specific threshold's configuration is needed, such as during system audits, troubleshooting, or when adjusting monitoring parameters. the endpoint does not modify any settings; it only provides read access to the existing configuration. keep in mind that the response will likely include sensitive system configuration data, so access should be restricted to authorized personnel.
</Accordion>

<Accordion title="Retrieve processing activity by id">
  Retrieves detailed information about a specific processing activity within the borneo platform. this endpoint allows users to access comprehensive data related to a particular data processing task or workflow, including its current status, associated metadata, and any relevant compliance information. it is particularly useful for monitoring ongoing activities, auditing past processes, or gathering information for reporting purposes. the endpoint should be used when detailed insights into a single processing activity are required, but it won't provide an overview of multiple activities or system-wide statistics.
</Accordion>

<Accordion title="Filter recipients list">
  The filterrecipientslist endpoint allows users to retrieve a filtered list of recipients based on specified criteria. this post method endpoint is designed to narrow down a potentially large set of recipients to a more manageable subset that meets certain conditions. it's particularly useful for targeting specific groups of recipients for communication, data analysis, or other operations within the borneo integration platform. the endpoint supports pagination to handle large result sets efficiently. while it provides powerful filtering capabilities, users should be aware that the performance may vary depending on the complexity of the filter criteria and the size of the recipient database. this endpoint should be used when there's a need to identify and work with a specific subset of recipients rather than the entire list.
</Accordion>

<Accordion title="Retrieve error details by id">
  The geterrordetails endpoint retrieves detailed information about a specific error in the borneo integration platform using its unique identifier. this tool is designed to provide comprehensive error data, including error type, description, timestamp, and any associated metadata, which is crucial for effective error management and resolution. it should be used when investigating specific error occurrences, troubleshooting issues, or gathering data for error analysis and reporting. the endpoint is particularly useful for system administrators, developers, and support teams who need to access detailed error information quickly. however, it does not provide aggregated error statistics or perform any error resolution actions; it's purely for fetching individual error details.
</Accordion>

<Accordion title="List departments with sort and pagination">
  The listdepartments endpoint retrieves a list of departments within the borneo integration platform. it offers flexible querying with filtering, pagination, and sorting options. use this endpoint to explore organizational structure, manage department hierarchies, or integrate department information into other systems. note that it does not support creating, updating, or deleting departments.
</Accordion>

<Accordion title="Retrieve issue by id">
  Retrieves detailed information about a specific issue in the borneo system. this endpoint should be used when you need to fetch comprehensive data about a particular issue, such as its current status, associated tasks, or related workflow information. it's particularly useful for tracking the progress of data integration processes, workflow automation tasks, or privacy compliance issues. the endpoint returns a single issue's details and does not provide a list or summary of multiple issues. note that the exact structure of the returned data is not specified in the given schema, so users should be prepared to handle various fields related to issue management in borneo's context.
</Accordion>

<Accordion title="Get scan by scanid">
  Retrieves detailed information about a specific data scan performed by borneo's data risk remediation platform. this endpoint allows users to fetch the results and metadata of a particular scan, including identified sensitive data, compliance status, and any automated tagging applied. it should be used when you need to review the outcome of a specific scan, track the progress of ongoing scans, or audit historical scan data. the endpoint focuses solely on providing scan-related information and does not modify any data or trigger new scans.
</Accordion>

<Accordion title="Retrieve connector by id">
  Retrieves detailed information about a specific connector in the borneo integration platform. this endpoint allows you to fetch the configuration, status, and other relevant details of a connector using its unique identifier. use this endpoint when you need to inspect or troubleshoot a particular connector's settings or performance. it's particularly useful for administrators or developers managing integrations within the borneo ecosystem. the endpoint will not modify any connector settings; it's a read-only operation designed for information retrieval only.
</Accordion>

<Accordion title="Retrieve legal document by id">
  Retrieves a specific legal document from the borneo system using its unique identifier. this endpoint is designed to access individual legal documents related to borneo, such as the native courts ordinance, the malaysia agreement, or other important legal frameworks and governance documents. it should be used when detailed information about a particular legal document is required. the endpoint returns the full content and metadata of the requested document. it does not provide search functionality or return multiple documents; for those purposes, a separate endpoint would be necessary.
</Accordion>

<Accordion title="Post discovered recipient by id">
  Updates or processes information for a specific discovered recipient user in the borneo integration platform. this endpoint allows you to interact with user data that has been automatically discovered by the system, potentially as part of the integration process between different applications. use this when you need to modify, confirm, or take action on a discovered user's information. the exact actions performed depend on the request body (not specified in the schema) but may include tasks such as confirming the user's identity, updating their details, or initiating further integration steps. this endpoint is specific to individual users and requires the unique discoveredrecipientid to target the correct record.
</Accordion>

<Accordion title="Retrieve data breach by id">
  Retrieves detailed information about a specific data breach incident using its unique identifier. this endpoint is crucial for investigating and managing data breaches within the borneo platform. it provides comprehensive details about the breach, which may include the date of occurrence, affected data types, potential impact, and current status of the breach. use this endpoint when you need in-depth information about a particular data breach for compliance reporting, incident response, or forensic analysis. the endpoint focuses solely on providing information and does not perform any actions or modifications related to the data breach.
</Accordion>

<Accordion title="Retrieve recipient details">
  Retrieves detailed information about a specific recipient identified by their unique recipientid within the borneo integration platform. this endpoint is used to fetch comprehensive data about a recipient, which may include personal details, contact information, associated accounts, or any other relevant data stored in the borneo system. it's particularly useful when you need to access or display a recipient's full profile or verify their information. the endpoint should be used when detailed recipient information is required for operations such as data verification, profile updates, or displaying recipient details in a user interface. note that this endpoint only provides read access to recipient data and cannot be used to modify recipient information.
</Accordion>

<Accordion title="Retrieve dpia by id">
  Retrieves a specific data protection impact assessment (dpia) using its unique identifier. this endpoint is used to access detailed information about a particular dpia, which is crucial for understanding and managing privacy risks associated with data processing activities in borneo's conservation and resource management efforts. it should be used when detailed information about a specific dpia is required, such as for reviewing, updating, or referencing the assessment. the endpoint does not provide a list of all dpias or create new ones; it is specifically for retrieving individual dpia records. users should ensure they have the correct dpia identifier before making the request, as incorrect identifiers will likely result in a "not found" error.
</Accordion>

<Accordion title="Retrieve resource catalog by id">
  Retrieves detailed information about a specific resource from the borneo catalog using its unique identifier. this endpoint is used to access comprehensive data about a particular resource, which could include metadata, associated files, or other relevant information. it should be used when detailed information about a known resource is required, such as for display purposes or further processing within an integration workflow. the endpoint will not modify the resource or return information about multiple resources. it's important to note that the response structure is not specified in the given schema, so users should refer to borneo's documentation for the exact format of the returned data.
</Accordion>

<Accordion title="Scan legal document byid">
  Initiates a scanning process for a specified legal document within the borneo integration platform. this endpoint is used to digitize and process a legal document, making it available for further analysis, storage, or integration with other systems. the scan operation is asynchronous, meaning it will start the scanning process but may not immediately return the results. use this endpoint when you need to convert a physical or digital legal document into a format that can be easily managed and searched within the borneo ecosystem. it's particularly useful for automating the intake of new legal documents into the system. note that this endpoint only initiates the scan and does not provide immediate access to the scanned content; additional api calls may be required to retrieve the processed document or check the scan status.
</Accordion>

<Accordion title="Retrieve tom by id">
  Retrieves detailed information about a specific tom resource using its unique identifier. this endpoint is crucial for accessing individual tom data within the borneo integration platform. it should be used when you need to fetch comprehensive details about a particular tom, such as its configuration, status, or associated metadata. the endpoint is particularly useful for monitoring, updating, or troubleshooting specific tom instances in your integration workflows. note that this endpoint only provides information for a single tom and cannot be used to list or search multiple toms simultaneously.
</Accordion>

<Accordion title="Get threshold by id">
  Retrieves detailed information about a specific threshold setting in the borneo integration platform. this endpoint allows users to fetch the configuration and current status of a particular threshold, which may be used for monitoring, alerting, or controlling data flows between integrated systems. it should be used when detailed information about a known threshold is required, such as during system audits, troubleshooting, or when adjusting integration workflows. the endpoint will not modify the threshold settings; it is for retrieval purposes only. users should ensure they have the correct thresholdid before making the request, as invalid ids will likely result in error responses.
</Accordion>

<Accordion title="Stop scan via scanid">
  Stops an ongoing scan operation in the borneo integration platform. this endpoint allows users to halt a specific scan process that is currently in progress. it should be used when there's a need to interrupt a scan before its natural completion, such as when the scan is taking too long, consuming excessive resources, or if the desired information has already been obtained. the endpoint requires the unique identifier of the scan to be stopped, ensuring precise control over individual scan operations. it's important to note that stopping a scan may result in incomplete data collection or analysis, so it should be used judiciously. this operation is irreversible; once stopped, a scan cannot be resumed and would need to be restarted if further scanning is required.
</Accordion>

<Accordion title="Trigger dashboard report by report id">
  Triggers the generation or retrieval of a specific dashboard report in the borneo integration platform. this endpoint is used to initiate the process of compiling and presenting data for a predefined dashboard report. it's particularly useful when you need to refresh or generate an up-to-date version of a report on demand. the endpoint should be called when a user or system requires the latest data to be reflected in a dashboard report. it's important to note that this endpoint only initiates the report generation process and may not immediately return the report data. depending on the complexity and size of the report, there might be a processing time before the actual report becomes available.
</Accordion>

<Accordion title="Retrieve recipient processing activities">
  Retrieves a paginated list of processing activities associated with a specific recipient in the borneo integration platform. this endpoint allows you to fetch and navigate through large sets of processing activity data efficiently. it supports sorting and pagination to help manage the volume of data returned. use this endpoint when you need to review or analyze the processing activities for a particular recipient, such as for compliance audits or data governance purposes. the endpoint does not provide filtering capabilities beyond the recipient id, so all processing activities for the specified recipient will be included in the results.
</Accordion>

<Accordion title="Fetch dashboard report by id">
  Retrieves a specific dashboard report from the borneo integration platform. this endpoint allows users to access detailed analytics and reporting data for a particular dashboard, providing insights into data exchange, workflow automation, and potentially sensitive data breach information. it should be used when a user needs to view or analyze a specific report's contents, such as performance metrics, data sharing statistics, or privacy incident details. the endpoint is particularly useful for generating up-to-date reports for monitoring and decision-making purposes. note that this endpoint only retrieves existing reports and does not generate new ones or modify report data.
</Accordion>

<Accordion title="List discovered document">
  Retrieves a list of discovered documents in the borneo integration platform, allowing for flexible querying, filtering, and sorting of results. this endpoint is used to fetch information about documents that have been discovered by the system, such as newly added files, deleted documents, or items with specific statuses. it supports pagination for handling large datasets and provides sorting capabilities to organize the results according to user preferences. use this endpoint when you need to review, monitor, or analyze the discovered documents within your borneo integration environment.
</Accordion>

<Accordion title="Update asset information by id">
  The updateasset endpoint allows you to modify the details of an existing asset in the borneo integration platform. this put operation at `/assets/\{assetid\}` updates the specified asset's information, including its name, type, associated ids, and location details. it's crucial for maintaining accurate and up-to-date asset records within the system. use this endpoint when you need to change any attribute of an asset, such as its name, type, or location. the endpoint requires at least the asset's name and type, with options to update additional properties like associated tom ids and location information. note that this operation will overwrite the existing asset data, so include all required fields even if only updating a subset of properties.
</Accordion>

<Accordion title="Mark scan false positives by id">
  Marks specified reports as false positives within a given scan in the borneo platform. this endpoint is used to refine scan results by identifying and flagging reports that are determined to be false alarms. it helps in improving the accuracy of security scans and reducing noise in the results. the function takes a scan id and a list of report uuids to be marked as false positives. it should be used when security analysts or automated systems have reviewed scan results and identified certain findings as non-issues or false alarms. this action helps in training the system and improving future scan accuracy. note that this operation is likely irreversible, so care should be taken to ensure only genuinely false positive reports are marked.
</Accordion>

<Accordion title="List discovered infotypes">
  The listdiscoveredinfotypes endpoint retrieves discovered info types from borneo, supporting flexible querying, filtering, sorting, and pagination. it's used for exploring sensitive information identified in your data ecosystem, aiding in data governance and compliance monitoring. the endpoint offers advanced filtering and efficient handling of large datasets.
</Accordion>

<Accordion title="Update category infotypes">
  Updates the infotypes associated with a specific category in the borneo integration platform. this endpoint allows you to modify the list of infotypes belonging to a category and optionally update the category's description. it's used for maintaining and organizing the classification of data types within the system, which is crucial for efficient data exchange and workflow automation. the endpoint replaces the entire list of infotypes for the specified category, so it should be used carefully to ensure no unintended removal of existing infotypes. this operation is particularly useful when restructuring data classifications or when new types of information need to be incorporated into existing categories.
</Accordion>

<Accordion title="Retrieve data resource statistics">
  Retrieves comprehensive statistical information about data resources across the borneo integration platform. this endpoint provides valuable insights into the overall data landscape, including metrics related to data security, privacy intelligence, and observability. it should be used when you need a high-level overview of your data resources, including potential security risks, privacy compliance status, and data distribution across integrated systems. the endpoint does not accept any parameters, suggesting it returns a complete snapshot of data stats for all accessible resources. keep in mind that the response may be extensive and could take longer to process for large-scale integrations with numerous data sources.
</Accordion>

<Accordion title="List discovered recipients">
  Lists and retrieves discovered recipients in the borneo integration platform. this endpoint allows for paginated, sorted, and filtered access to the discovered recipients data. it's designed for efficiently managing and exploring large sets of recipient information, supporting various query parameters for customized result sets. use this endpoint when you need to browse, search, or analyze discovered recipients based on specific criteria or in a particular order.
</Accordion>

<Accordion title="Submit detailed scan results">
  Retrieves detailed insights for a specific scan iteration of a particular resource in the borneo integration platform. this endpoint allows users to access in-depth information about scan results, which can be used for thorough analysis, troubleshooting, or reporting purposes. it's particularly useful when you need to examine the outcomes of a specific scan iteration in detail, either for the entire scan or for a specific page within the scan results. the endpoint requires both the resource and scan iteration identifiers to ensure precise retrieval of the relevant data. use this when you need comprehensive information about a scan's findings, especially in scenarios involving data quality assessment, integration verification, or system health checks.
</Accordion>

<Accordion title="Pause scan by id">
  The pausescan endpoint allows users to temporarily halt an ongoing scan process in the borneo integration platform. this tool is used to pause the scanning and analysis of sensitive data within connected systems or data streams. it's particularly useful when you need to temporarily suspend data processing for maintenance, to manage system resources, or to address any issues that may have arisen during the scan. the endpoint should be used when there's a need to interrupt a scan without completely terminating it, allowing for later resumption. it's important to note that this action doesn't delete or reset the scan progress; it simply suspends further processing until explicitly resumed. the pause operation is immediate, but any in-progress data processing may complete before the pause takes full effect.
</Accordion>

<Accordion title="Get category by label">
  Retrieves detailed information about a specific category within borneo's data classification system using the category's unique label. this endpoint is used to fetch metadata, attributes, and potentially associated data points for a given category. it's particularly useful for understanding the structure and properties of a category, which can be crucial for data governance, compliance reporting, and workflow automation tasks. the endpoint should be used when detailed information about a specific category is needed, such as during data discovery processes, access governance reviews, or when setting up data lineage mappings. it does not modify any data and is primarily for information retrieval purposes.
</Accordion>

<Accordion title="Submit chat feedback">
  The submitchatfeedback endpoint allows users to provide feedback on a chat support interaction within the borneo integration platform. this endpoint is crucial for collecting user satisfaction data, which can be used to improve the quality of support and enhance the overall user experience. it should be called after a chat support session has concluded, enabling users to rate their interaction with the support team. the feedback submitted through this endpoint can help borneo identify areas for improvement in their support processes and recognize high-performing support agents. note that this endpoint focuses solely on collecting numerical ratings and does not appear to support additional comments or detailed feedback.
</Accordion>

<Accordion title="Retrieve resource columns">
  Retrieves column information for resources in the borneo integration platform. this endpoint allows users to fetch metadata about the structure of resources, including column names, data types, and potentially other attributes. it's particularly useful when you need to understand the schema of available resources for integration purposes or data analysis. the endpoint returns a comprehensive list of columns across all accessible resources, enabling developers to plan data mappings, transformations, or queries effectively. note that while this endpoint provides structural information, it does not return the actual data contained within the columns.
</Accordion>

<Accordion title="List error details from filtered scan iterations">
  The errorlist endpoint retrieves errors related to scan iterations in borneo. it offers flexible filtering, sorting, and pagination for efficient error analysis. use for debugging, monitoring, or reporting across various scans and resources. supports up to 10,000 records per call.
</Accordion>

<Accordion title="Get user profile by id">
  Retrieves the user profile information for a specific user in the borneo integration platform. this endpoint should be used when detailed information about a user's profile is needed, such as for displaying user data, verifying user details, or performing user-related operations within the borneo ecosystem. the endpoint focuses on providing user-specific data while maintaining borneo's emphasis on data security and privacy observability. it's important to note that this endpoint only retrieves profile information and does not modify or delete user data. the response will likely include various user attributes, but the exact structure and fields are not specified in the given schema.
</Accordion>

<Accordion title="List processing activities filters">
  This endpoint retrieves a list of available filters for processing activities in the pops (processing of personal data) dashboard. it allows users to obtain filter options based on various categories related to data processing activities. the endpoint is designed to support dynamic filtering capabilities in the dashboard, enabling users to refine their view of processing activities according to different criteria. use this endpoint when you need to populate filter options in the user interface or when preparing to filter the main processing activities list. it's important to note that this endpoint only returns the available filter options and does not perform the actual filtering of processing activities.
</Accordion>

<Accordion title="List dashboard report editions">
  Lists the editions of a specific dashboard report in the borneo integration platform. this endpoint allows users to retrieve a paginated list of dashboard report editions, with options for sorting and specifying the number of results per page. it's particularly useful for managing and reviewing multiple versions or iterations of a dashboard report, enabling users to track changes over time or select specific editions for further analysis or comparison. the endpoint supports efficient navigation through large sets of editions using pagination tokens and customizable sorting, making it suitable for applications that need to display or process dashboard report history.
</Accordion>

<Accordion title="Get dashboard report edition by id">
  Retrieves a specific edition of a dashboard report from the borneo integration platform. this endpoint is used to fetch detailed information about a particular version of a report, allowing users to access historical data or compare different iterations of the same report. it's particularly useful for tracking changes in business event impacts over time or analyzing data from specific periods. the endpoint should be used when there's a need to review or analyze a specific report edition, rather than just the most recent data. it may not provide real-time updates and is limited to retrieving one report edition at a time.
</Accordion>

<Accordion title="List dashboard users with filters">
  Lists and filters dashboard users in the borneo integration platform based on specified criteria. this endpoint allows retrieval of user data filtered by roles, tenant, organization, and departments. it's useful for user management, access control, and generating reports on user distribution across different organizational units. the endpoint supports complex queries by combining multiple filter criteria, enabling precise user data retrieval for various administrative and analytical purposes.
</Accordion>

<Accordion title="Poll domain by id">
  This endpoint allows you to initiate a poll operation or submit data for a specific domain within the borneo integration platform. it is used when you need to gather information, trigger a data collection process, or update the status of a particular domain identified by its unique domainid. the post method suggests that you're sending data to the server, possibly to start a new poll, update an existing one, or submit responses to a poll. this endpoint should be used when interacting with domain-specific polling functionality in borneo, such as collecting integration status updates or triggering scheduled data synchronizations. it's important to note that the exact behavior and data requirements may vary depending on the specific implementation and purpose of polling in your borneo setup.
</Accordion>

<Accordion title="List dashboard reports with filters">
  Retrieves a list of dashboard reports from the borneo integration platform, allowing for filtered, paginated, and sorted results. this endpoint is useful for obtaining an overview of available reports, such as privacy operations dashboards, data discovery dashboards, and privacy ops data flow reports. it supports complex querying through its filter object, enabling users to search by name, type, and frequency. the endpoint facilitates efficient data retrieval through pagination and customizable sorting, making it ideal for applications that need to display or process large sets of report data. use this when you need to fetch multiple dashboard reports at once, especially when implementing report listing features or performing bulk operations on report data.
</Accordion>

<Accordion title="List domains with pagination and sorting">
  Retrieves a list of domains in the borneo integration platform with support for pagination and custom sorting. this endpoint allows users to fetch domain information in manageable chunks and order the results based on specific criteria. it's particularly useful for applications that need to display or process large sets of domain data efficiently. the endpoint does not provide filtering capabilities, so all domains accessible to the authenticated user will be listed. use this when you need to enumerate or browse through the domains registered in your borneo account, such as for administrative purposes or to populate domain selection interfaces.
</Accordion>

<Accordion title="Get cloud account by id">
  Retrieves detailed information about a specific cloud account within the borneo integration platform. this endpoint should be used when you need to access or verify the configuration, status, or properties of a particular cloud account. it provides essential data for account management, such as associated services, integration status, and account-specific settings. this tool is particularly useful for administrators managing multiple cloud accounts or for auditing purposes. note that it only retrieves information and does not modify the account in any way. the endpoint may not provide sensitive information like access keys or full credential details for security reasons.
</Accordion>

<Accordion title="List employees with filters">
  Retrieves a list of employees based on specified filtering and sorting criteria. this endpoint allows for flexible querying of employee data, supporting both simple and complex search scenarios. it can be used to find employees by name, filter by departments, and sort the results based on various attributes. the endpoint is particularly useful for generating reports, populating employee directories, or performing data analysis on the workforce. it does not modify any employee data and is intended for read-only operations. note that the response structure and pagination details are not specified in the given schema, so additional documentation may be needed for handling large result sets.
</Accordion>

<Accordion title="Get department filter list">
  The filterdepartmentlist endpoint allows users to retrieve a filtered list of departments from the borneo integration platform. it accepts various filtering criteria to narrow down the results based on department attributes such as name, location, or size. this endpoint is particularly useful for searching specific departments or generating customized department lists for reporting or integration purposes. the filtered results can be sorted and paginated for easier data handling and display. while it provides powerful filtering capabilities, it does not modify any department data and is intended for read-only operations.
</Accordion>

<Accordion title="List legal documents with pagination">
  Retrieves a paginated and sortable list of legal documents based on specified filter criteria. this endpoint allows for efficient searching, filtering, and organizing of legal documents within the borneo integration platform. it supports free-text search on document names, filtering by document status, and custom sorting options. use this endpoint when you need to fetch multiple legal documents that match specific criteria or when you want to implement a paginated document browsing feature in your application. the endpoint is particularly useful for document management systems, legal workflow automation, or any scenario requiring bulk retrieval of legal document metadata.
</Accordion>

<Accordion title="List or filter recipients">
  The listrecipients endpoint retrieves a paginated and filtered list of recipients from the borneo application. it allows for extensive customization of the query through sorting and filtering options, making it suitable for various recipient management and data integration tasks. the endpoint supports pagination for efficient handling of large datasets and provides detailed filtering capabilities to narrow down results based on multiple criteria such as categories, roles, status, and associated entities. this tool is ideal for generating reports, auditing recipient data, or populating user interfaces with recipient information. it should be used when a comprehensive view of recipients is needed, with the ability to apply complex filters and sort the results as required. the endpoint does not modify any data and is solely for retrieval purposes.
</Accordion>

<Accordion title="List processing activities">
  Listprocessingactivities retrieves a list of processing activities with extensive filtering, sorting, and pagination. it's ideal for auditing, reporting, or managing data processing activities. the endpoint supports complex querying via the 'filter' object and efficient pagination. while powerful for retrieval, it doesn't modify records.
</Accordion>

<Accordion title="List leaf resources with filters">
  The listleafresources endpoint retrieves and filters leaf resources from borneo's catalog. it supports detailed searching across various criteria, enabling efficient resource management and discovery. users can paginate results, include additional information, and sort outputs as needed.
</Accordion>

<Accordion title="Update dashboard report frequency and recipients">
  Updates the settings of an existing dashboard report in the borneo integration platform. this endpoint allows you to modify the recipients, roles, and frequency of a specific dashboard report. use this when you need to change who receives the report, adjust access permissions, or alter the schedule for report generation. the function is particularly useful for maintaining up-to-date distribution lists and ensuring that reports are generated and sent at the most appropriate intervals for your organization's needs. note that this endpoint only updates the report settings and does not generate or send the report itself.
</Accordion>

<Accordion title="Update discovered infotype status">
  Updates the status of a specific discovered infotype in the borneo integration platform. this endpoint allows users to change the state of an infotype that has been identified during data discovery processes. it is used to manage the lifecycle of discovered infotypes, enabling actions such as approval, ignoring, or deletion. the endpoint should be called when there's a need to change the current status of a discovered infotype, typically as part of data governance or classification workflows. it's important to note that this endpoint only updates the status and doesn't provide additional information about the infotype itself.
</Accordion>

<Accordion title="Update data breach entry">
  The updatedatabreach endpoint allows users to create or update detailed information about a specific data breach incident in the borneo integration platform. this endpoint is crucial for maintaining accurate and comprehensive records of data breach incidents, which is essential for compliance, risk management, and improving security measures. the endpoint captures a wide range of information about the data breach, including its occurrence, discovery, affected parties, potential consequences, and measures taken in response. it provides flexibility by allowing users to save the information as a draft or finalize the report. this endpoint should be used when there's a need to document a new data breach or update existing information about a breach. it's particularly useful for security teams, compliance officers, and risk management professionals who need to maintain detailed records of security incidents.
</Accordion>

<Accordion title="Update dashboard user roles">
  Updates the roles and department associations for a specified user across multiple organizations in the borneo dashboard. this endpoint allows administrators to modify a user's access levels and departmental affiliations within the borneo system. it's particularly useful for managing user permissions when responsibilities change or when adjusting access across different organizations and departments. the endpoint requires specifying the username and at least one organization with assigned roles. department associations are optional but must be provided as valid uuids when included. this tool should be used when there's a need to modify existing user role configurations, not for creating new users or removing users from the system entirely.
</Accordion>

<Accordion title="Update dashboard user details">
  Updates the information of an existing dashboard user in the borneo integration platform. this endpoint allows you to modify the name associated with a user's account while maintaining their unique username. it should be used when there's a need to update a user's display name or correct any errors in the existing name. the endpoint requires both the username (for identification) and the new name to be provided. it's important to note that this operation only updates the user's name and does not affect any other user data or permissions.
</Accordion>

<Accordion title="Update domain details">
  Updates the properties of an existing domain within the borneo integration platform. this endpoint allows you to modify the name and polling frequency of a specific domain identified by its unique domainid. use this when you need to rename a domain or adjust its automated polling schedule. it's particularly useful for fine-tuning the integration processes or adapting to changing business requirements. the endpoint doesn't provide information about other domain properties or the success of the update operation, so additional verification may be necessary after making changes.
</Accordion>

<Accordion title="Update department name">
  This endpoint updates the information of an existing department within the borneo integration platform. it allows you to modify the name of a specific department identified by its unique departmentid. use this endpoint when you need to rename a department or correct its name in the system. the endpoint is particularly useful for maintaining accurate organizational structure data, which is crucial for workflow automation and integration processes. note that this operation only updates the department's name and does not affect any other attributes or associations of the department. ensure that the new name adheres to your organization's naming conventions and accurately represents the department's function.
</Accordion>

<Accordion title="Update discovered document status">
  This endpoint updates the status of a specific discovered document in the borneo integration platform. it is used as part of the workflow automation process to manage the lifecycle of documents within the system. the endpoint accepts a document id and a new status, allowing users to change how the document is treated in subsequent processes. this tool should be used when there's a need to modify the processing state of a discovered document, such as marking it for deletion or indicating that it has been successfully added to the system. it's important to note that this endpoint only updates the status and doesn't perform any other operations on the document itself.
</Accordion>

<Accordion title="Update dpia by id">
  Updates an existing data protection impact assessment (dpia) in the borneo system. this endpoint allows for comprehensive modification of a dpia's privacy framework, risk assessments (confidentiality, integrity, and availability), and associated metadata. it's used to refine and complete a dpia throughout its lifecycle, from draft to activation. the tool supports detailed documentation of privacy principles, risk analyses, and mitigation measures. it's particularly useful for privacy professionals and data protection officers managing complex data processing activities. note that activating a dpia requires filling in numerous mandatory fields, ensuring a thorough privacy impact assessment.
</Accordion>

<Accordion title="Update employee by id">
  Updates the information of an existing employee in the borneo integration platform. this endpoint allows you to modify various details of an employee's record, including personal information, job-related data, and organizational relationships. it's primarily used for maintaining up-to-date employee records, reflecting changes in positions, departments, or personal details. the endpoint requires the employee's unique identifier and accepts a json object containing the updated information. while it offers flexibility in updating multiple fields, it's important to note that the email address must remain unique within the company. this tool should be used whenever there are changes to an employee's information that need to be reflected in the system, but should not be used for creating new employee records or for bulk updates.
</Accordion>

<Accordion title="Verify email with id and token">
  Completes the email verification process for a user account in the borneo integration platform. this endpoint is called when a user clicks on the verification link sent to their email address. it validates the provided verificationid and token to confirm the user's email address. this is a crucial step in the user authentication workflow, ensuring that users have provided valid email addresses and helping to prevent unauthorized access. the endpoint should only be used once per verification attempt, as tokens are typically single-use and time-limited for security reasons. note that this endpoint doesn't handle the initial request for email verification or resending verification emails; it's specifically for completing the verification process.
</Accordion>

<Accordion title="Update recipient status via id">
  Updates the status and automation status of a specific recipient in the borneo integration platform. this endpoint allows users to modify a recipient's overall status (archived or validated) and their automation status (ignored, created, or new). it's particularly useful for managing recipient data lifecycle and controlling how recipients are handled in automated workflows. the endpoint should be used when there's a need to change a recipient's status due to changes in their relevance or to adjust their interaction with automated processes. it's important to note that this endpoint only updates status information and does not modify other recipient details.
</Accordion>

<Accordion title="Update headquarter details by id">
  Updates the information for an existing headquarter in the borneo integration platform. this endpoint allows you to modify various details of a headquarter, such as its name, address, and associated tom ids. it should be used when there are changes to a headquarter's information or when correcting existing data. the endpoint requires the headquarter's unique identifier and accepts a json payload with the updated information. it enforces strict validation rules to ensure data integrity and consistency across the platform. note that while some fields are optional, others (name, city, address, and country) are mandatory and must be provided with each update request.
</Accordion>

<Accordion title="Update threshold by id">
  Updates an existing threshold in the borneo integration platform with new settings and information related to data processing and compliance. this endpoint allows you to modify various aspects of a threshold, including its status, comments, and multiple boolean flags that define the characteristics of the data processing activities. use this endpoint when you need to adjust the parameters of a threshold to reflect changes in data handling practices, compliance requirements, or to activate a draft threshold. the endpoint is particularly useful for maintaining up-to-date records of data processing activities and ensuring compliance with data protection regulations. note that updating a threshold does not automatically apply the changes to ongoing data processing; it may require additional steps to implement the updated settings in your data workflows.
</Accordion>

<Accordion title="Update lopdp threshold by id">
  Updates the lopdp (likely operational privacy data protection) threshold settings for a specific threshold identified by the lopdpthresholdid. this endpoint allows you to modify various data protection and privacy compliance parameters related to data processing activities. use this endpoint when you need to adjust risk assessments, update processing characteristics, or change the status of a threshold. the endpoint is crucial for maintaining up-to-date privacy impact assessments and ensuring compliance with data protection regulations. note that this endpoint only updates the threshold settings and does not perform any actual data processing or risk mitigation actions.
</Accordion>

<Accordion title="Update recipient details by id">
  Updates the information of an existing recipient in the borneo integration platform. this endpoint allows you to modify various details of a recipient, including their name, business information, status, categories, roles, and data protection-related information. it's used when you need to change or update any aspect of a recipient's profile, such as updating their dpa status, changing their role, or modifying their data storage locations. this endpoint is particularly useful for maintaining up-to-date records of your business partners and ensuring compliance with data protection regulations. note that some fields are required and must be included in every update request, while others are optional and can be omitted if no changes are needed.
</Accordion>

<Accordion title="Update processing activity details">
  This endpoint updates an existing processing activity in a data privacy management system. it modifies details about personal data processing, crucial for compliance with regulations like gdpr. use it to update activity status, purpose, legal basis, data subjects, and more. only 'active' and 'name' fields are required, but providing comprehensive information is recommended for accurate records.
</Accordion>


# Box
Source: https://docs.push.ai/integrations/box



Cloud content management and file sharing service for businesses.

<Accordion title="Create metadata instance on file">
  Applies an instance of a metadata template to a file. in most cases only values that are present in the metadata template will be accepted, except for the `global.properties` template which accepts any key-value pair.
</Accordion>

<Accordion title="Create metadata cascade policy">
  Creates a new metadata cascade policy that applies a given metadata template to a given folder and automatically cascades it down to any files within that folder. in order for the policy to be applied a metadata instance must first be applied to the folder the policy is to be applied to.
</Accordion>

<Accordion title="Commit upload session">
  Close an upload session and create a file from the uploaded chunks. the actual endpoint url is returned by the [`create upload session`](e://post-files-upload-sessions) and [`get upload session`](e://get-files-upload-sessions-id) endpoints.
</Accordion>

<Accordion title="Create slack integration mapping">
  Creates a [slack integration mapping](https://support.box.com/hc/en-us/articles/4415585987859-box-as-the-content-layer-for-slack) by mapping a slack channel to a box item. you need admin or co-admin role to use this endpoint.
</Accordion>

<Accordion title="Create comment">
  Adds a comment by the user to a specific file, or as a reply to an other comment.
</Accordion>

<Accordion title="Create metadata instance on folder">
  Applies an instance of a metadata template to a folder. in most cases only values that are present in the metadata template will be accepted, except for the `global.properties` template which accepts any key-value pair. to display the metadata template in the box web app the enterprise needs to be configured to enable **cascading folder level metadata** for the user in the admin console.
</Accordion>

<Accordion title="Create collaboration">
  Adds a collaboration for a single user or a single group to a file or folder. collaborations can be created using email address, user ids, or a group ids. if a collaboration is being created with a group, access to this endpoint is dependent on the group's ability to be invited. if collaboration is in `pending` status, the following fields are redacted: - `login` and `name` are hidden if a collaboration was created using `user id`, - `name` is hidden if a collaboration was created using `login`.
</Accordion>

<Accordion title="Ask question">
  Sends an ai request to supported llms and returns an answer specifically focused on the user's question given the provided context.
</Accordion>

<Accordion title="Add domain to list of allowed collaboration domains">
  Creates a new entry in the list of allowed domains to allow collaboration for.
</Accordion>

<Accordion title="Create retention policy">
  Creates a retention policy.
</Accordion>

<Accordion title="Create task">
  Creates a single task on a file. this task is not assigned to any user and will need to be assigned separately.
</Accordion>

<Accordion title="Create teams integration mapping">
  Creates a [teams integration mapping](https://support.box.com/hc/en-us/articles/360044681474-using-box-for-teams) by mapping a teams channel to a box item. you need admin or co-admin role to use this endpoint.
</Accordion>

<Accordion title="Create user">
  Creates a new managed user in an enterprise. this endpoint is only available to users and applications with the right admin permissions.
</Accordion>

<Accordion title="Delete ai agent">
  Deletes an ai agent using the provided parameters.
</Accordion>

<Accordion title="Create shield information barrier">
  Creates a shield information barrier to separate individuals/groups within the same firm and prevents confidential information passing between them.
</Accordion>

<Accordion title="Delete folder">
  Deletes a folder, either permanently or by moving it to the trash.
</Accordion>

<Accordion title="Create shield information barrier segment">
  Creates a shield information barrier segment.
</Accordion>

<Accordion title="Create email alias">
  Adds a new email alias to a user account..
</Accordion>

<Accordion title="Delete file">
  Deletes a file, either permanently or by moving it to the trash. the enterprise settings determine whether the item will be permanently deleted from box or moved to the trash.
</Accordion>

<Accordion title="Create terms of service">
  Creates a terms of service for a given enterprise and type of user.
</Accordion>

<Accordion title="Delete file request">
  Deletes a file request permanently.
</Accordion>

<Accordion title="Create user exemption from collaboration domain restrictions">
  Exempts a user from the restrictions set out by the allowed list of domains for collaborations.
</Accordion>

<Accordion title="Create shield information barrier report">
  Creates a shield information barrier report for a given barrier.
</Accordion>

<Accordion title="Create folder">
  Creates a new empty folder within the specified parent folder.
</Accordion>

<Accordion title="Delete folder lock">
  Deletes a folder lock on a given folder. you must be authenticated as the owner or co-owner of the folder to use this endpoint.
</Accordion>

<Accordion title="Create user invite">
  Invites an existing external user to join an enterprise. the existing user can not be part of another enterprise and must already have a box account. once invited, the user will receive an email and are prompted to accept the invitation within the box web application. this method requires the "manage an enterprise" scope enabled for the application, which can be enabled within the developer console.
</Accordion>

<Accordion title="Delete retention policy">
  Permanently deletes a retention policy.
</Accordion>

<Accordion title="Delete shield information barrier segment member by id">
  Deletes a shield information barrier segment member based on provided id.
</Accordion>

<Accordion title="Create folder lock">
  Creates a folder lock on a folder, preventing it from being moved and/or deleted. you must be authenticated as the owner or co-owner of the folder to use this endpoint.
</Accordion>

<Accordion title="Create upload session">
  Creates an upload session for a new file.
</Accordion>

<Accordion title="Delete shield information barrier segment restriction by id">
  Delete shield information barrier segment restriction based on provided id.
</Accordion>

<Accordion title="Create terms of service status for new user">
  Sets the status for a terms of service for a user.
</Accordion>

<Accordion title="Delete shield information barrier segment">
  Deletes the shield information barrier segment based on provided id.
</Accordion>

<Accordion title="Create group">
  Creates a new group of users in an enterprise. only users with admin permissions can create new groups.
</Accordion>

<Accordion title="Copy file">
  Creates a copy of a file.
</Accordion>

<Accordion title="Delete slack integration mapping">
  Deletes a [slack integration mapping](https://support.box.com/hc/en-us/articles/4415585987859-box-as-the-content-layer-for-slack). you need admin or co-admin role to use this endpoint.
</Accordion>

<Accordion title="Create webhook">
  Creates a webhook.
</Accordion>

<Accordion title="Delete user avatar">
  Removes an existing user avatar. you cannot reverse this operation.
</Accordion>

<Accordion title="Create upload session for existing file">
  Creates an upload session for an existing file.
</Accordion>

<Accordion title="Download zip archive">
  Returns the contents of a `zip` archive in binary format. this url does not require any form of authentication and could be used in a user's browser to download the archive to a user's device. by default, this url is only valid for a few seconds from the creation of the request for this archive. once a download has started it can not be stopped and resumed, instead a new request for a zip archive would need to be created. the url of this endpoint should not be considered as fixed. instead, use the \[create zip download]\(e://post zip downloads) api to request to create a `zip` archive, and then follow the `download url` field in the response to this endpoint.
</Accordion>

<Accordion title="Delete teams integration mapping">
  Deletes a [teams integration mapping](https://support.box.com/hc/en-us/articles/360044681474-using-box-for-teams). you need admin or co-admin role to use this endpoint.
</Accordion>

<Accordion title="Download file">
  Returns the contents of a file in binary format.
</Accordion>

<Accordion title="Delete user">
  Deletes a user. by default this will fail if the user still owns any content. move their owned content first before proceeding, or use the `force` field to delete the user and their files.
</Accordion>

<Accordion title="Find app item for shared link">
  Returns the app item represented by a shared link. the link can originate from the current enterprise or another.
</Accordion>

<Accordion title="Create jobs to terminate users session">
  Validates the roles and permissions of the user, and creates asynchronous jobs to terminate the user's sessions. returns the status for the post request.
</Accordion>

<Accordion title="Extract metadata structured">
  Sends an ai request to supported large language models (llms) and returns extracted metadata as a set of key-value pairs. for this request, you either need a metadata template or a list of fields you want to extract. input is **either** a metadata template or a list of fields to ensure the structure. to learn more about creating templates, see [creating metadata templates in the admin console](https://support.box.com/hc/en-us/articles/360044194033-customizing-metadata-templates) or use the [metadata template api](g://metadata/templates/create).
</Accordion>

<Accordion title="Find web link for shared link">
  Returns the web link represented by a shared link. a shared web link can be represented by a shared link, which can originate within the current enterprise or within another. this endpoint allows an application to retrieve information about a shared web link when only given a shared link.
</Accordion>

<Accordion title="Create jobs to terminate user group session">
  Validates the roles and permissions of the group, and creates asynchronous jobs to terminate the group's sessions. returns the status for the post request.
</Accordion>

<Accordion title="Force apply metadata cascade policy to folder">
  Force the metadata on a folder with a metadata cascade policy to be applied to all of its children. this can be used after creating a new cascade policy to enforce the metadata to be cascaded down to all existing files within that folder.
</Accordion>

<Accordion title="Create legal hold policy">
  Create a new legal hold policy.
</Accordion>

<Accordion title="Create metadata template">
  Creates a new metadata template that can be applied to files and folders.
</Accordion>

<Accordion title="Create web link">
  Creates a web link object within a folder.
</Accordion>

<Accordion title="Find metadata template by instance id">
  Finds a metadata template by searching for the id of an instance of the template.
</Accordion>

<Accordion title="Find folder for shared link">
  Return the folder represented by a shared link. a shared folder can be represented by a shared link, which can originate within the current enterprise or within another. this endpoint allows an application to retrieve information about a shared folder when only given a shared link.
</Accordion>

<Accordion title="Create zip download">
  Creates a request to download multiple files and folders as a single `zip` archive file. this api does not return the archive but instead performs all the checks to ensure that the user has access to all the items, and then returns a `download url` and a `status url` that can be used to download the archive. the limit for an archive is either the account's upload limit or 10,000 files, whichever is met first. **note**: downloading a large file can be affected by various factors such as distance, network latency, bandwidth, and congestion, as well as packet loss ratio and current server load. for these reasons we recommend that a maximum zip archive total size does not exceed 25gb.
</Accordion>

<Accordion title="Extract metadata freeform">
  Sends an ai request to supported large language models (llms) and extracts metadata in form of key-value pairs. in this request, both the prompt and the output can be freeform. metadata template setup before sending the request is not required.
</Accordion>

<Accordion title="Find file for shared link">
  Returns the file represented by a shared link. a shared file can be represented by a shared link, which can originate within the current enterprise or within another. this endpoint allows an application to retrieve information about a shared file when only given a shared link. the `shared link permission options` array field can be returned by requesting it in the `fields` query parameter.
</Accordion>

<Accordion title="Copy file request">
  Copies an existing file request that is already present on one folder, and applies it to another folder.
</Accordion>

<Accordion title="Assign legal hold policy">
  Assign a legal hold to a file, file version, folder, or user.
</Accordion>

<Accordion title="Generate text">
  Sends an ai request to supported large language models (llms) and returns generated text based on the provided prompt.
</Accordion>

<Accordion title="Copy folder">
  Creates a copy of a folder within a destination folder. the original folder will not be changed.
</Accordion>

<Accordion title="Assign retention policy">
  Assigns a retention policy to an item.
</Accordion>

<Accordion title="Assign storage policy">
  Creates a storage policy assignment for an enterprise or user.
</Accordion>

<Accordion title="Create shield information barrier segment member">
  Creates a new shield information barrier segment member.
</Accordion>

<Accordion title="Add or update user avatar">
  Adds or updates a user avatar.
</Accordion>

<Accordion title="Add classification to folder">
  Adds a classification to a folder by specifying the label of the classification to add. this api can also be called by including the enterprise id in the url explicitly, for example `/folders/:id/enterprise 12345/securityclassification-6vmvochwuwo`.
</Accordion>

<Accordion title="Add classification to file">
  Adds a classification to a file by specifying the label of the classification to add. this api can also be called by including the enterprise id in the url explicitly, for example `/files/:id//enterprise 12345/securityclassification-6vmvochwuwo`.
</Accordion>

<Accordion title="Add initial classifications">
  When an enterprise does not yet have any classifications, this api call initializes the classification template with an initial set of classifications. if an enterprise already has a classification, the template will already exist and instead an api call should be made to add additional classifications.
</Accordion>

<Accordion title="Assign task">
  Assigns a task to a user. a task can be assigned to more than one user by creating multiple assignments.
</Accordion>

<Accordion title="Authorize user">
  Authorize a user by sending them through the [box](https://box.com) website and request their permission to act on their behalf. this is the first step when authenticating a user using oauth 2.0. to request a user's authorization to use the box apis on their behalf you will need to send a user to the url with this format.
</Accordion>

<Accordion title="Cancel box sign request">
  Cancels a sign request.
</Accordion>

<Accordion title="Add shared link to file">
  Adds a shared link to a file.
</Accordion>

<Accordion title="Create ai agent">
  Creates an ai agent. at least one of the following capabilities must be provided: `ask`, `text gen`, `extract`.
</Accordion>

<Accordion title="Create box skill cards on file">
  Applies one or more box skills metadata cards to a file.
</Accordion>

<Accordion title="Add shared link to folder">
  Adds a shared link to a folder.
</Accordion>

<Accordion title="Change shield information barrier status">
  Change status of shield information barrier with the specified id.
</Accordion>

<Accordion title="Create box sign request">
  Creates a signature request. this involves preparing a document for signing and sending the signature request to signers.
</Accordion>

<Accordion title="Add shared link to web link">
  Adds a shared link to a web link.
</Accordion>

<Accordion title="Create shield information barrier segment restriction">
  Creates a shield information barrier segment restriction object.
</Accordion>

<Accordion title="Apply watermark to folder">
  Applies or update a watermark on a folder.
</Accordion>

<Accordion title="Apply watermark to file">
  Applies or update a watermark on a file.
</Accordion>

<Accordion title="Get ai agent by agent id">
  Gets an ai agent using the `agent id` parameter.
</Accordion>

<Accordion title="Add user to group">
  Creates a group membership. only users with admin-level permissions will be able to use this api.
</Accordion>

<Accordion title="Get ai agent default configuration">
  Get the ai agent default config
</Accordion>

<Accordion title="Get box sign template by id">
  Fetches details of a specific box sign template.
</Accordion>

<Accordion title="Get trashed file">
  Retrieves a file that has been moved to the trash. please note that only if the file itself has been moved to the trash can it be retrieved with this api call. if instead one of its parent folders was moved to the trash, only that folder can be inspected using the \[`get /folders/:id/trash`]\(e://get folders id trash) api. to list all items that have been moved to the trash, please use the [`get /folders/trash/items`](e://get-folders-trash-items/) api.
</Accordion>

<Accordion title="Get shield information barrier report by id">
  Retrieves a shield information barrier report by its id.
</Accordion>

<Accordion title="Get watermark for folder">
  Retrieve the watermark for a folder.
</Accordion>

<Accordion title="Get shared link for web link">
  Gets the information for a shared link on a web link.
</Accordion>

<Accordion title="Get classification on file">
  Retrieves the classification metadata instance that has been applied to a file. this api can also be called by including the enterprise id in the url explicitly, for example `/files/:id//enterprise 12345/securityclassification-6vmvochwuwo`.
</Accordion>

<Accordion title="Get terms of service">
  Fetches a specific terms of service.
</Accordion>

<Accordion title="Get events long poll endpoint">
  The listevents endpoint provides information about the events available in the box system. this options method allows developers to discover the capabilities and requirements for interacting with the /events endpoint. it's particularly useful for understanding the types of events that can be monitored, the format of event data, and any constraints or limitations on event retrieval. this endpoint should be used when setting up event monitoring or webhook integrations to ensure proper configuration and understanding of the event system. while it doesn't directly fetch events, it offers crucial metadata for effectively working with box's event streaming and notification features.
</Accordion>

<Accordion title="Get collaboration">
  Retrieves a single collaboration.
</Accordion>

<Accordion title="Get box sign request by id">
  Gets a sign request by id.
</Accordion>

<Accordion title="Get classification on folder">
  Retrieves the classification metadata instance that has been applied to a folder. this api can also be called by including the enterprise id in the url explicitly, for example `/folders/:id/enterprise 12345/securityclassification-6vmvochwuwo`.
</Accordion>

<Accordion title="Get files under retention">
  Returns a list of files under retention for a retention policy assignment.
</Accordion>

<Accordion title="Get user invite status">
  Returns the status of a user invite.
</Accordion>

<Accordion title="Get allowed collaboration domain">
  Returns a domain that has been deemed safe to create collaborations for within the current enterprise.
</Accordion>

<Accordion title="Get watermark on file">
  Retrieve the watermark for a file.
</Accordion>

<Accordion title="Get metadata cascade policy">
  Retrieve a specific metadata cascade policy assigned to a folder.
</Accordion>

<Accordion title="Get webhook">
  Retrieves a specific webhook
</Accordion>

<Accordion title="Get collection by id">
  Retrieves a collection by its id.
</Accordion>

<Accordion title="List all file versions">
  Retrieve a list of the past versions for a file. versions are only tracked by box users with premium accounts. to fetch the id of the current version of a file, use the `get /file/:id` api.
</Accordion>

<Accordion title="Get file information">
  Retrieves the details about a file.
</Accordion>

<Accordion title="List file collaborations">
  Retrieves a list of pending and active collaborations for a file. this returns all the users that have access to the file or have been invited to the file.
</Accordion>

<Accordion title="List all global metadata templates">
  Used to retrieve all generic, global metadata templates available to all enterprises using box.
</Accordion>

<Accordion title="List collection items">
  Retrieves the files and/or folders contained within this collection.
</Accordion>

<Accordion title="Get current user">
  Retrieves information about the user who is currently authenticated. in the case of a client-side authenticated oauth 2.0 application this will be the user who authorized the app. in the case of a jwt, server-side authenticated application this will be the service account that belongs to the application by default. use the `as-user` header to change who this api call is made on behalf of.
</Accordion>

<Accordion title="List box sign templates">
  Gets box sign templates created by a user.
</Accordion>

<Accordion title="List file version legal holds">
  Get a list of file versions on legal hold for a legal hold assignment. due to ongoing re-architecture efforts this api might not return all file versions for this policy id. instead, this api will only return file versions held in the legacy architecture. two new endpoints will available to request any file versions held in the new architecture. for file versions held in the new architecture, the `get /legal hold policy assignments/:id/file versions on hold` api can be used to return all past file versions available for this policy assignment, and the `get /legal hold policy assignments/:id/files on hold` api can be used to return any current (latest) versions of a file under legal hold. the `get /legal hold policy assignments?policy id=\{id\}` api can be used to find a list of policy assignments for a given policy id. once the re-architecture is completed this api will be deprecated.
</Accordion>

<Accordion title="List file comments">
  Retrieves a list of comments for a file.
</Accordion>

<Accordion title="List box skill cards on file">
  List the box skills metadata cards that are attached to a file.
</Accordion>

<Accordion title="Get comment">
  Retrieves the message and metadata for a specific comment, as well as information on the user who created the comment.
</Accordion>

<Accordion title="List all collections">
  Retrieves all collections for a given user. currently, only the `favorites` collection is supported.
</Accordion>

<Accordion title="List all legal hold policies">
  Retrieves a list of legal hold policies that belong to an enterprise.
</Accordion>

<Accordion title="Get metadata instance on file">
  Retrieves the instance of a metadata template that has been applied to a file.
</Accordion>

<Accordion title="Get metadata instance on folder">
  Retrieves the instance of a metadata template that has been applied to a folder. this can not be used on the root folder with id `0`.
</Accordion>

<Accordion title="List folder collaborations">
  Retrieves a list of pending and active collaborations for a folder. this returns all the users that have access to the folder or have been invited to the folder.
</Accordion>

<Accordion title="Get web link">
  Retrieve information about a web link.
</Accordion>

<Accordion title="Get file request">
  Retrieves the information about a file request.
</Accordion>

<Accordion title="List folder app item associations">
  **this is a beta feature, which means that its availability might be limited.** returns all app items the folder is associated with. this includes app items associated with ancestors of the folder. assuming the context user has access to the folder, the type/ids are revealed even if the context user does not have **view** permission on the app item.
</Accordion>

<Accordion title="List folder locks">
  Retrieves folder lock details for a given folder. you must be authenticated as the owner or co-owner of the folder to use this endpoint.
</Accordion>

<Accordion title="List groups for enterprise">
  Retrieves all of the groups for a given enterprise. the user must have admin permissions to inspect enterprise's groups.
</Accordion>

<Accordion title="List file version retentions">
  Retrieves all file version retentions for the given enterprise. **note**: file retention api is now **deprecated**. to get information about files and file versions under retention, see [files under retention](e://get-retention-policy-assignments-id-files-under-retention) or [file versions under retention](e://get-retention-policy-assignments-id-file-versions-under-retention) endpoints.
</Accordion>

<Accordion title="List metadata instances on file">
  Retrieves all metadata for a given file.
</Accordion>

<Accordion title="List members of group">
  Retrieves all the members for a group. only members of this group or users with admin-level permissions will be able to use this api.
</Accordion>

<Accordion title="List group collaborations">
  Retrieves all the collaborations for a group. the user must have admin permissions to inspect enterprise's groups. each collaboration object has details on which files or folders the group has access to and with what role.
</Accordion>

<Accordion title="List items in folder">
  Retrieves a page of items in a folder. these items can be files, folders, and web links. to request more information about the folder itself, like its size, use the [get a folder](#get-folders-id) endpoint instead.
</Accordion>

<Accordion title="List all metadata templates for enterprise">
  Used to retrieve all metadata templates created to be used specifically within the user's enterprise
</Accordion>

<Accordion title="Get device pin">
  Retrieves information about an individual device pin.
</Accordion>

<Accordion title="Get metadata template by id">
  Retrieves a metadata template by its id.
</Accordion>

<Accordion title="Get trashed folder">
  Retrieves a folder that has been moved to the trash. please note that only if the folder itself has been moved to the trash can it be retrieved with this api call. if instead one of its parent folders was moved to the trash, only that folder can be inspected using the \[`get /folders/:id/trash`]\(e://get folders id trash) api. to list all items that have been moved to the trash, please use the [`get /folders/trash/items`](e://get-folders-trash-items/) api.
</Accordion>

<Accordion title="List legal hold policy assignments">
  Retrieves a list of items a legal hold policy has been assigned to.
</Accordion>

<Accordion title="List metadata instances on folder">
  Retrieves all metadata for a given folder. this can not be used on the root folder with id `0`.
</Accordion>

<Accordion title="List all webhooks">
  Returns all defined webhooks for the requesting application. this api only returns webhooks that are applied to files or folders that are owned by the authenticated user. this means that an admin can not see webhooks created by a service account unless the admin has access to those folders, and vice versa.
</Accordion>

<Accordion title="Get zip download status">
  Returns the download status of a `zip` archive, allowing an application to inspect the progress of the download as well as the number of items that might have been skipped. this endpoint can only be accessed once the download has started. subsequently this endpoint is valid for 12 hours from the start of the download. the url of this endpoint should not be considered as fixed. instead, use the \[create zip download]\(e://post zip downloads) api to request to create a `zip` archive, and then follow the `status url` field in the response to this endpoint.
</Accordion>

<Accordion title="Get file thumbnail">
  Retrieves a thumbnail, or smaller image representation, of a file. sizes of `32x32`,`64x64`, `128x128`, and `256x256` can be returned in the `.png` format and sizes of `32x32`, `160x160`, and `320x320` can be returned in the `.jpg` format. thumbnails can be generated for the image and video file formats listed \[found on our community site]\[1]. \[1]: [https://community.box.com/t5/migrating-and-previewing-content/file-types-and-fonts-supported-in-box-content-preview/ta-p/327](https://community.box.com/t5/migrating-and-previewing-content/file-types-and-fonts-supported-in-box-content-preview/ta-p/327)
</Accordion>

<Accordion title="List parts">
  Return a list of the chunks uploaded to the upload session so far. the actual endpoint url is returned by the [`create upload session`](e://post-files-upload-sessions) and [`get upload session`](e://get-files-upload-sessions-id) endpoints.
</Accordion>

<Accordion title="List enterprise device pins">
  Retrieves all the device pins within an enterprise. the user must have admin privileges, and the application needs the "manage enterprise" scope to make this call.
</Accordion>

<Accordion title="List previous file versions for legal hold policy assignment">
  Get a list of previous file versions for a legal hold assignment. in some cases you may only need the latest file versions instead. in these cases, use the `get /legal hold policy assignments/:id/files on hold` api instead to return any current (latest) versions of a file for this legal hold policy assignment. due to ongoing re-architecture efforts this api might not return all files held for this policy id. instead, this api will only return past file versions held in the newly developed architecture. the `get /file version legal holds` api can be used to fetch current and past versions of files held within the legacy architecture. this endpoint does not support returning any content that is on hold due to a custodian collaborating on a hub. the `get /legal hold policy assignments?policy id=\{id\}` api can be used to find a list of policy assignments for a given policy id.
</Accordion>

<Accordion title="List retention policy assignments">
  Returns a list of all retention policy assignments associated with a specified retention policy.
</Accordion>

<Accordion title="List pending collaborations">
  Retrieves all pending collaboration invites for this user.
</Accordion>

<Accordion title="List metadata cascade policies">
  Retrieves a list of all the metadata cascade policies that are applied to a given folder. this can not be used on the root folder with id `0`.
</Accordion>

<Accordion title="List shield information barriers">
  Retrieves a list of shield information barrier objects for the enterprise of jwt.
</Accordion>

<Accordion title="Get metadata template by name">
  Retrieves a metadata template by its `scope` and `templatekey` values. to find the `scope` and `templatekey` for a template, list all templates for an enterprise or globally, or list all templates applied to a file or folder.
</Accordion>

<Accordion title="Get trashed web link">
  Retrieves a web link that has been moved to the trash.
</Accordion>

<Accordion title="List box sign requests">
  Gets signature requests created by a user. if the `sign files` and/or `parent folder` are deleted, the signature request will not return in the list.
</Accordion>

<Accordion title="Get shield information barrier segment member by id">
  Retrieves a shield information barrier segment member by its id.
</Accordion>

<Accordion title="List recently accessed items">
  Returns information about the recent items accessed by a user, either in the last 90 days or up to the last 1000 items accessed.
</Accordion>

<Accordion title="List retention policies">
  Retrieves all of the retention policies for an enterprise.
</Accordion>

<Accordion title="Get retention on file">
  Returns information about a file version retention. **note**: file retention api is now **deprecated**. to get information about files and file versions under retention, see [files under retention](e://get-retention-policy-assignments-id-files-under-retention) or [file versions under retention](e://get-retention-policy-assignments-id-file-versions-under-retention) endpoints.
</Accordion>

<Accordion title="Get file version">
  Retrieve a specific version of a file. versions are only tracked for box users with premium accounts.
</Accordion>

<Accordion title="List shield information barrier reports">
  Lists shield information barrier reports.
</Accordion>

<Accordion title="List shield information barrier segments">
  Retrieves a list of shield information barrier segment objects for the specified information barrier id.
</Accordion>

<Accordion title="List ai agents">
  Lists ai agents based on the provided parameters.
</Accordion>

<Accordion title="Get upload session">
  Return information about an upload session. the actual endpoint url is returned by the [`create upload session`](e://post-files-upload-sessions) endpoint.
</Accordion>

<Accordion title="Get storage policy">
  Fetches a specific storage policy.
</Accordion>

<Accordion title="List shield information barrier segment restrictions">
  Lists shield information barrier segment restrictions based on provided segment id.
</Accordion>

<Accordion title="List shield information barrier segment members">
  Lists shield information barrier segment members based on provided segment ids.
</Accordion>

<Accordion title="Get file versions under retention">
  Returns a list of file versions under retention for a retention policy assignment.
</Accordion>

<Accordion title="Get shield information barrier with specified id">
  Get shield information barrier based on provided id.
</Accordion>

<Accordion title="Get shield information barrier segment with specified id">
  Retrieves shield information barrier segment based on provided id..
</Accordion>

<Accordion title="Get retention policy assignment">
  Retrieves a retention policy assignment
</Accordion>

<Accordion title="Get storage policy assignment">
  Fetches a specific storage policy assignment.
</Accordion>

<Accordion title="Get file version legal hold">
  Retrieves information about the legal hold policies assigned to a file version.
</Accordion>

<Accordion title="Get user avatar">
  Retrieves an image of a the user's avatar.
</Accordion>

<Accordion title="Get shield information barrier segment restriction by id">
  Retrieves a shield information barrier segment restriction based on provided id.
</Accordion>

<Accordion title="Get retention policy">
  Retrieves a retention policy.
</Accordion>

<Accordion title="Get user">
  Retrieves information about a user in the enterprise. the application and the authenticated user need to have the permission to look up users in the entire enterprise. this endpoint also returns a limited set of information for external users who are collaborated on content owned by the enterprise for authenticated users with the right scopes. in this case, disallowed fields will return null instead.
</Accordion>

<Accordion title="List allowed collaboration domains">
  Returns the list domains that have been deemed safe to create collaborations for within the current enterprise.
</Accordion>

<Accordion title="List enterprise users">
  Returns a list of all users for the enterprise along with their `user id`, `public name`, and `login`. the application and the authenticated user need to have the permission to look up users in the entire enterprise.
</Accordion>

<Accordion title="Get task assignment">
  Retrieves information about a task assignment.
</Accordion>

<Accordion title="Get group membership">
  Retrieves a specific group membership. only admins of this group or users with admin-level permissions will be able to use this api.
</Accordion>

<Accordion title="Get shared link for file">
  Gets the information for a shared link on a file.
</Accordion>

<Accordion title="Get folder information">
  Retrieves details for a folder, including the first 100 entries in the folder. passing `sort`, `direction`, `offset`, and `limit` parameters in query allows you to manage the list of returned [folder items](r://folder--full#param-item-collection). to fetch more items within the folder, use the [get items in a folder](e://get-folders-id-items) endpoint.
</Accordion>

<Accordion title="Get user exempt from collaboration domain restrictions">
  Returns a users who has been exempt from the collaboration domain restrictions.
</Accordion>

<Accordion title="Get task">
  Retrieves information about a specific task.
</Accordion>

<Accordion title="List file app item associations">
  **this is a beta feature, which means that its availability might be limited.** returns all app items the file is associated with. this includes app items associated with ancestors of the file. assuming the context user has access to the file, the type/ids are revealed even if the context user does not have **view** permission on the app item.
</Accordion>

<Accordion title="Get group">
  Retrieves information about a group. only members of this group or users with admin-level permissions will be able to use this api.
</Accordion>

<Accordion title="List all classifications">
  Retrieves the classification metadata template and lists all the classifications available to this enterprise. this api can also be called by including the enterprise id in the url explicitly, for example `/metadata templates/enterprise 12345/securityclassification-6vmvochwuwo/schema`.
</Accordion>

<Accordion title="Get legal hold policy">
  Retrieve a legal hold policy.
</Accordion>

<Accordion title="Get legal hold policy assignment">
  Retrieve a legal hold policy assignment.
</Accordion>

<Accordion title="Get shared link for folder">
  Gets the information for a shared link on a folder.
</Accordion>

<Accordion title="List storage policies">
  Fetches all the storage policies in the enterprise.
</Accordion>

<Accordion title="List user s email aliases">
  Retrieves all email aliases for a user. the collection does not include the primary login for the user.
</Accordion>

<Accordion title="List storage policy assignments">
  Fetches all the storage policy assignment for an enterprise or user.
</Accordion>

<Accordion title="List trashed items">
  Retrieves the files and folders that have been moved to the trash. any attribute in the full files or folders objects can be passed in with the `fields` parameter to retrieve those specific attributes that are not returned by default. this endpoint defaults to use offset-based pagination, yet also supports marker-based pagination using the `marker` parameter.
</Accordion>

<Accordion title="List terms of service user statuses">
  Retrieves an overview of users and their status for a terms of service, including whether they have accepted the terms and when.
</Accordion>

<Accordion title="List tasks on file">
  Retrieves a list of all the tasks for a file. this endpoint does not support pagination.
</Accordion>

<Accordion title="Unassign legal hold policy">
  Remove a legal hold from an item. this is an asynchronous process. the policy will not be fully removed yet when the response returns.
</Accordion>

<Accordion title="List task assignments">
  Lists all of the assignments for a given task.
</Accordion>

<Accordion title="Remove metadata instance from folder">
  Deletes a piece of folder metadata.
</Accordion>

<Accordion title="Remove collaboration">
  Deletes a single collaboration.
</Accordion>

<Accordion title="Remove watermark from file">
  Removes the watermark from a file.
</Accordion>

<Accordion title="Remove user from list of users exempt from domain restrictions">
  Removes a user's exemption from the restrictions set out by the allowed list of domains for collaborations.
</Accordion>

<Accordion title="List user s groups">
  Retrieves all the groups for a user. only members of this group or users with admin-level permissions will be able to use this api.
</Accordion>

<Accordion title="List user and enterprise events">
  Returns up to a year of past events for a given user or for the entire enterprise. by default this returns events for the authenticated user. to retrieve events for the entire enterprise, set the `stream type` to `admin logs streaming` for live monitoring of new events, or `admin logs` for querying across historical events. the user making the api call will need to have admin privileges, and the application will need to have the scope `manage enterprise properties` checked.
</Accordion>

<Accordion title="List teams integration mappings">
  Lists [teams integration mappings](https://support.box.com/hc/en-us/articles/360044681474-using-box-for-teams) in a users' enterprise. you need admin or co-admin role to use this endpoint.
</Accordion>

<Accordion title="List slack integration mappings">
  Lists [slack integration mappings](https://support.box.com/hc/en-us/articles/4415585987859-box-as-the-content-layer-for-slack) in a users' enterprise. you need admin or co-admin role to use this endpoint.
</Accordion>

<Accordion title="Remove classification from folder">
  Removes any classifications from a folder. this api can also be called by including the enterprise id in the url explicitly, for example `/folders/:id/enterprise 12345/securityclassification-6vmvochwuwo`.
</Accordion>

<Accordion title="Remove watermark from folder">
  Removes the watermark from a folder.
</Accordion>

<Accordion title="Restore folder">
  Restores a folder that has been moved to the trash. an optional new parent id can be provided to restore the folder to in case the original folder has been deleted. during this operation, part of the file tree will be locked, mainly the source folder and all of its descendants, as well as the destination folder. for the duration of the operation, no other move, copy, delete, or restore operation can performed on any of the locked folders.
</Accordion>

<Accordion title="List terms of services">
  Returns the current terms of service text and settings for the enterprise.
</Accordion>

<Accordion title="Update file">
  Updates a file. this can be used to rename or move a file, create a shared link, or lock a file.
</Accordion>

<Accordion title="Update comment">
  Update the message of a comment.
</Accordion>

<Accordion title="Update folder">
  Updates a folder. this can be also be used to move the folder, create shared links, update collaborations, and more.
</Accordion>

<Accordion title="Update storage policy assignment">
  Updates a specific storage policy assignment.
</Accordion>

<Accordion title="Update legal hold policy">
  Update legal hold policy.
</Accordion>

<Accordion title="Remove webhook">
  Deletes a webhook.
</Accordion>

<Accordion title="Restore web link">
  Restores a web link that has been moved to the trash. an optional new parent id can be provided to restore the web link to in case the original folder has been deleted.
</Accordion>

<Accordion title="List workflows">
  Returns list of workflows that act on a given `folder id`, and have a flow with a trigger type of `workflow manual start`. you application must be authorized to use the `manage box relay` application scope within the developer console in to use this endpoint.
</Accordion>

<Accordion title="Unassign storage policy">
  Delete a storage policy assignment. deleting a storage policy assignment on a user will have the user inherit the enterprise's default storage policy. there is a rate limit for calling this endpoint of only twice per user in a 24 hour time frame.
</Accordion>

<Accordion title="Remove comment">
  Permanently deletes a comment.
</Accordion>

<Accordion title="Update group membership">
  Updates a user's group membership. only admins of this group or users with admin-level permissions will be able to use this api.
</Accordion>

<Accordion title="Update file request">
  Updates a file request. this can be used to activate or deactivate a file request.
</Accordion>

<Accordion title="Update group">
  Updates a specific group. only admins of this group or users with admin-level permissions will be able to use this api.
</Accordion>

<Accordion title="Update retention policy">
  Updates a retention policy.
</Accordion>

<Accordion title="Permanently remove file">
  Permanently deletes a file that is in the trash. this action cannot be undone.
</Accordion>

<Accordion title="Remove device pin">
  Deletes an individual device pin.
</Accordion>

<Accordion title="Update terms of service">
  Updates a specific terms of service.
</Accordion>

<Accordion title="Unassign task">
  Deletes a specific task assignment.
</Accordion>

<Accordion title="Update slack integration mapping">
  Updates a [slack integration mapping](https://support.box.com/hc/en-us/articles/4415585987859-box-as-the-content-layer-for-slack). supports updating the box folder id and options. you need admin or co-admin role to use this endpoint.
</Accordion>

<Accordion title="Update shared link on file">
  Updates a shared link on a file.
</Accordion>

<Accordion title="Permanently remove folder">
  Permanently deletes a folder that is in the trash. this action cannot be undone.
</Accordion>

<Accordion title="Update task">
  Updates a task. this can be used to update a task's configuration, or to update its completion state.
</Accordion>

<Accordion title="Update teams integration mapping">
  Updates a [teams integration mapping](https://support.box.com/hc/en-us/articles/360044681474-using-box-for-teams). supports updating the box folder id and options. you need admin or co-admin role to use this endpoint.
</Accordion>

<Accordion title="Review files on legal hold policy assignment">
  Get a list of files with current file versions for a legal hold assignment. in some cases you may want to get previous file versions instead. in these cases, use the `get /legal hold policy assignments/:id/file versions on hold` api instead to return any previous versions of a file for this legal hold policy assignment. due to ongoing re-architecture efforts this api might not return all file versions held for this policy id. instead, this api will only return the latest file version held in the newly developed architecture. the `get /file version legal holds` api can be used to fetch current and past versions of files held within the legacy architecture. this endpoint does not support returning any content that is on hold due to a custodian collaborating on a hub. the `get /legal hold policy assignments?policy id=\{id\}` api can be used to find a list of policy assignments for a given policy id.
</Accordion>

<Accordion title="Update task assignment">
  Updates a task assignment. this endpoint can be used to update the state of a task assigned to a user.
</Accordion>

<Accordion title="Remove web link">
  Deletes a web link.
</Accordion>

<Accordion title="Remove domain from list of allowed collaboration domains">
  Removes a domain from the list of domains that have been deemed safe to create collaborations for within the current enterprise.
</Accordion>

<Accordion title="Update ai agent">
  Updates an ai agent.
</Accordion>

<Accordion title="Update webhook">
  Updates a webhook.
</Accordion>

<Accordion title="Update shared link on folder">
  Updates a shared link on a folder.
</Accordion>

<Accordion title="Update terms of service status for existing user">
  Updates the status for a terms of service for a user.
</Accordion>

<Accordion title="Upload file">
  Uploads a small file to box. for file sizes over 50mb we recommend using the chunk upload apis. the `attributes` part of the body must come **before** the `file` part. requests that do not follow this format when uploading the file will receive a http `400` error with a `metadata after file contents` error code.
</Accordion>

<Accordion title="Update web link">
  Updates a web link object.
</Accordion>

<Accordion title="Remove metadata template">
  Delete a metadata template and its instances. this deletion is permanent and can not be reversed.
</Accordion>

<Accordion title="Remove email alias">
  Removes an email alias from a user.
</Accordion>

<Accordion title="Update user">
  Updates a managed or app user in an enterprise. this endpoint is only available to users and applications with the right admin permissions.
</Accordion>

<Accordion title="Permanently remove web link">
  Permanently deletes a web link that is in the trash. this action cannot be undone.
</Accordion>

<Accordion title="Upload part of file">
  Uploads a chunk of a file for an upload session. the actual endpoint url is returned by the [`create upload session`](e://post-files-upload-sessions) and [`get upload session`](e://get-files-upload-sessions-id) endpoints.
</Accordion>

<Accordion title="Remove file version">
  Move a file version to the trash. versions are only tracked for box users with premium accounts.
</Accordion>

<Accordion title="Remove retention policy assignment">
  Removes a retention policy assignment applied to content.
</Accordion>

<Accordion title="Request access token">
  Request an access token using either a client-side obtained oauth 2.0 authorization code or a server-side jwt assertion. an access token is a string that enables box to verify that a request belongs to an authorized session. in the normal order of operations you will begin by requesting authentication from the [authorize](#get-authorize) endpoint and box will send you an authorization code. you will then send this code to this endpoint to exchange it for an access token. the returned access token can then be used to make box api calls.
</Accordion>

<Accordion title="Preflight check before upload">
  Performs a check to verify that a file will be accepted by box before you upload the entire file.
</Accordion>

<Accordion title="Upload file version">
  Update a file's content. for file sizes over 50mb we recommend using the chunk upload apis. the `attributes` part of the body must come **before** the `file` part. requests that do not follow this format when uploading the file will receive a http `400` error with a `metadata after file contents` error code.
</Accordion>

<Accordion title="Update shared link on web link">
  Updates a shared link on a web link.
</Accordion>

<Accordion title="Resend box sign request">
  Resends a signature request email to all outstanding signers.
</Accordion>

<Accordion title="Remove group">
  Permanently deletes a group. only users with admin-level permissions will be able to use this api.
</Accordion>

<Accordion title="Remove shared link from folder">
  Removes a shared link from a folder.
</Accordion>

<Accordion title="Restore file">
  Restores a file that has been moved to the trash. an optional new parent id can be provided to restore the file to in case the original folder has been deleted.
</Accordion>

<Accordion title="Restore file version">
  Restores a specific version of a file after it was deleted. don't use this endpoint to restore box notes, as it works with file formats such as pdf, doc, pptx or similar.
</Accordion>

<Accordion title="Update shield information barrier segment with specified id">
  Updates the shield information barrier segment based on provided id..
</Accordion>

<Accordion title="Update all box skill cards on file">
  An alternative method that can be used to overwrite and update all box skill metadata cards on a file.
</Accordion>

<Accordion title="Revoke access token">
  Revoke an active access token, effectively logging a user out that has been previously authenticated.
</Accordion>

<Accordion title="List users exempt from collaboration domain restrictions">
  Returns a list of users who have been exempt from the collaboration domain restrictions.
</Accordion>

<Accordion title="Remove shared link from file">
  Removes a shared link from a file.
</Accordion>

<Accordion title="Promote file version">
  Promote a specific version of a file. if previous versions exist, this method can be used to promote one of the older versions to the top of the version history. this creates a new copy of the old version and puts it at the top of the versions history. the file will have the exact same contents as the older version, with the same hash digest, `etag`, and name as the original. other properties such as comments do not get updated to their former values. don't use this endpoint to restore box notes, as it works with file formats such as pdf, doc, pptx or similar.
</Accordion>

<Accordion title="Remove shared link from web link">
  Removes a shared link from a web link.
</Accordion>

<Accordion title="Remove task">
  Removes a task from a file.
</Accordion>

<Accordion title="Remove metadata instance from file">
  Deletes a piece of file metadata.
</Accordion>

<Accordion title="Update collaboration">
  Updates a collaboration. can be used to change the owner of an item, or to accept collaboration invites.
</Accordion>

<Accordion title="Starts workflow based on request body">
  Initiates a flow with a trigger type of `workflow manual start`. you application must be authorized to use the `manage box relay` application scope within the developer console.
</Accordion>

<Accordion title="Refresh access token">
  Refresh an access token using its client id, secret, and refresh token.
</Accordion>

<Accordion title="Remove legal hold policy">
  Delete an existing legal hold policy. this is an asynchronous process. the policy will not be fully deleted yet when the response returns.
</Accordion>

<Accordion title="Transfer owned folders">
  Transfers ownership of a specific folder (with id 0) from one user to another in the box cloud storage system. this endpoint should be used when you need to change the owner of a user's root folder, effectively transferring all of their content to another user. it's particularly useful in scenarios such as employee offboarding or role transitions within an organization. the operation is irreversible, so it should be used with caution. note that this endpoint specifically targets the folder with id 0, which typically represents a user's root folder in box.
</Accordion>

<Accordion title="Remove metadata cascade policy">
  Deletes a metadata cascade policy.
</Accordion>

<Accordion title="Remove classification from file">
  Removes any classifications from a file. this api can also be called by including the enterprise id in the url explicitly, for example `/files/:id//enterprise 12345/securityclassification-6vmvochwuwo`.
</Accordion>

<Accordion title="Remove user from group">
  Deletes a specific group membership. only admins of this group or users with admin-level permissions will be able to use this api.
</Accordion>

<Accordion title="Remove upload session">
  Abort an upload session and discard all data uploaded. this cannot be reversed. the actual endpoint url is returned by the [`create upload session`](e://post-files-upload-sessions) and [`get upload session`](e://get-files-upload-sessions-id) endpoints.
</Accordion>

<Accordion title="Remove box skill cards from file">
  Removes any box skills cards metadata from a file.
</Accordion>

<Accordion title="Search for content">
  Searches for files, folders, web links, and shared files across the users content or across the entire enterprise.
</Accordion>

<Accordion title="Query files folders by metadata">
  Create a search using sql-like syntax to return items that match specific metadata. by default, this endpoint returns only the most basic info about the items for which the query matches. to get additional fields for each item, including any of the metadata, use the `fields` attribute in the query.
</Accordion>


# Brevo
Source: https://docs.push.ai/integrations/brevo



Brevo (formerly Sendinblue) delivers email marketing, SMS campaigns, and marketing automation solutions, empowering businesses to nurture leads, engage audiences, and drive conversions

<Accordion title="Activate the ecommerce app">
  Getting access to brevo ecommerce.
</Accordion>

<Accordion title="Add existing contacts to a list">
  This endpoint allows adding existing contacts to a specific list by its id. users can add contacts through their email addresses or ids, with a max limit of 150 per request. successful additions and failures are reported in the response.
</Accordion>

<Accordion title="Add a new domain to the list of blocked domains">
  Blocks a new domain in order to avoid messages being sent to the same
</Accordion>

<Accordion title="Add email and or sms credits to a specific child account">
  This post endpoint lets resellers add email/sms credits to a child account using 'childidentifier'. it needs json input for the credit amount. successful requests update both child and reseller credit balances, with error handling via specific codes.
</Accordion>

<Accordion title="Brevo Aggregate Email Activity">
  This endpoint will show the aggregated stats for past 90 days by default if `startdate` and `enddate` or `days` is not passed. the date range can not exceed 90 days
</Accordion>

<Accordion title="Authenticate a domain">
  The put endpoint '/senders/domains/\{domainname}/authenticate' authenticates domain names, returning success with details or errors for bad requests or non-existent domains.
</Accordion>

<Accordion title="Associate a dedicated ip to the child">
  To assign a dedicated ip to a reseller's child account, send a post request to `/reseller/children/\{childidentifier\}/ips/associate` with the child's id and ip address. possible responses: 204 (success), 400 (bad request), 404 (child not found).
</Accordion>

<Accordion title="Brevo Check Reseller Child Account Creation Status">
  This endpoint allows resellers to check if a child account has been successfully created by providing the child's identifier. it returns a boolean status and handles errors such as bad requests or unauthorized access.
</Accordion>

<Accordion title="Check user permission">
  This endpoint fetches permissions for a user based on email, detailing their status and privileges (e.g., manage email campaigns) or returns errors for bad requests.
</Accordion>

<Accordion title="Check admin user permissions">
  This endpoint checks an admin's permissions via email, supporting a get request for detailed user status, group associations, and feature access specifics, including api keys, plans, and management of users and apps.
</Accordion>

<Accordion title="Create and send a whatsapp campaign">
  Create and manage whatsapp campaigns by specifying details like name, template id, schedule, and recipients. essential fields include template id and recipient info. it generates success confirmation or detailed errors.
</Accordion>

<Accordion title="Create an event">
  Create an event to track a contact's interaction.
</Accordion>

<Accordion title="Create a deal">
  Endpoint '/crm/deals' allows for deal creation with required name & optional attributes like owner, amount, pipeline, & stage. supports json requests & returns the created deal id with 201 or 400 for invalid data.
</Accordion>

<Accordion title="Creates an sms campaign">
  To create an sms campaign, define details like name, sender, message, recipients, and schedule. messages must comply with length limits and have opt-out info. success or error codes indicate campaign status.
</Accordion>

<Accordion title="Create a domain for a child account">
  Endpoint allows resellers to create a domain for a child account by specifying the child's identifier. it requires a json body with the domain. responses include domain added, bad request, unauthorized reseller, and child not found scenarios.
</Accordion>

<Accordion title="Create categories in batch">
  This endpoint enables batch creation and optional update of e-commerce categories via json, requiring unique ids for each. it reports counts of new and updated categories or provides error details on failures.
</Accordion>

<Accordion title="Create an api key for a sub account">
  This endpoint will generate an api v3 key for a sub account
</Accordion>

<Accordion title="Create an email campaign">
  This endpoint allows creation of email campaigns with json, detailing name, sender, and content. it requires essential fields, supports html and a/b testing. success yields a 201 status and campaign id; failures return a 400 error.
</Accordion>

<Accordion title="Delete an external feed">
  This endpoint will delete an external feed.
</Accordion>

<Accordion title="Delete a group">
  This endpoint allows you to delete a group of sub-organizations. when a group is deleted, the sub-organizations are no longer part of this group. the users associated with the group are no longer associated with the group once deleted.
</Accordion>

<Accordion title="Delete a webhook">
  Delete an existing webhook by its id. returns "webhook deleted" on success or detailed error messages for failures like invalid parameters, permissions issues, and more.
</Accordion>

<Accordion title="Creates a reseller child">
  This endpoint creates reseller child accounts requiring company info, email, and password in json. it returns a 201 status, authkey, and id on success, or 400/403 errors for bad requests or insufficient permissions.
</Accordion>

<Accordion title="Create contact attribute">
  This endpoint enables creating contact attributes in various categories by specifying an attribute name and category, accepting json objects with attribute details. success returns a 201 status; failures return an error message.
</Accordion>

<Accordion title="Delete a folder and all its lists">
  This endpoint deletes a contact folder and its lists using a folderid. success results in a 204 status, while errors return 400 or 404 with details.
</Accordion>

<Accordion title="Create an external feed">
  This endpoint will create an external feed.
</Accordion>

<Accordion title="Delete an inactive email template">
  Delete an inactive email template by its id. supports error responses for bad requests and cases where the template id is not found.
</Accordion>

<Accordion title="Create an email template">
  The endpoint enables creating custom transactional email templates with details like sender, subject, content, etc. successful creations yield a 201 status and template id; failures return errors and codes.
</Accordion>

<Accordion title="Create a folder">
  Endpoint "/contacts/folders" allows creating a contact folder. send a post request with the folder's name in json format. on success, returns a 201 status with the created folder's id. possible errors include bad requests and specific failure codes.
</Accordion>

<Accordion title="Export an sms campaign s recipients">
  It returns the background process id which on completion calls the notify url that you have set in the input.
</Accordion>

<Accordion title="Export all webhook events">
  This endpoint will submit a request to get the history of webhooks in the csv file. the link to download the csv file will be sent to the webhook that was provided in the notifyurl.
</Accordion>

<Accordion title="Download a file">
  This endpoint allows downloading a file by id. specify `id` in the path to request a file. successful requests return a temporary link to download the file, valid for 5 minutes. responses may include errors for invalid data or if the file is not found.
</Accordion>

<Accordion title="Create contact via doi double opt in flow">
  This endpoint enables the creation of a contact through the double opt-in (doi) process. it requires the contact's email, template id, redirection url, and list ids for inclusion. responses indicate contact creation, update, or errors.
</Accordion>

<Accordion title="Delete a whatsapp campaign">
  Deletes a specified whatsapp campaign by campaignid. on success, returns a 204 status with no content. errors lead to a 400 or 404 response, detailing the issue with error codes and messages.
</Accordion>

<Accordion title="Enable disable sub account application s">
  Api endpoints for the corporate owner to enable/disable applications on the sub-account
</Accordion>

<Accordion title="Delete hardbounces">
  Delete hardbounces. to use carefully (e.g. in case of temporary isp failures)
</Accordion>

<Accordion title="Export contacts">
  It returns the background process id which on completion calls the notify url that you have set in the input. file will be available in csv.
</Accordion>

<Accordion title="Create a group of sub accounts">
  This endpoint allows to create a group of sub-accounts
</Accordion>

<Accordion title="Get all folders">
  This api endpoint fetches contact folders with pagination and optional sorting. it supports page size, index, and sorting direction, defaulting values if unspecified. it returns folder id, name, and contact counts, handling errors like bad requests.
</Accordion>

<Accordion title="Delete an sms campaign">
  This endpoint allows for the deletion of an sms campaign by campaignid. it responds with a 204 code on successful deletion, and error codes (400 or 404) for failures like invalid request or campaign id not found.
</Accordion>

<Accordion title="Generate sso token to access sub account">
  This endpoint generates an sso token to authenticate and access a sub-account of the master using the account endpoint [https://account-app.brevo.com/account/login/sub-account/sso/\[token](https://account-app.brevo.com/account/login/sub-account/sso/\[token)], where \[token] will be replaced by the actual token.
</Accordion>

<Accordion title="Get all deals">
  The `get /crm/deals` endpoint fetches a list of deals with optional filters (name, company, contact ids), supporting pagination (`offset`, `limit`) and sort order, returning deal details and linked entities.
</Accordion>

<Accordion title="Generate sso token to access admin account">
  This endpoint generates an sso token to authenticate and access the admin account using the endpoint [https://account-app.brevo.com/account/login/corporate/sso/\[token](https://account-app.brevo.com/account/login/corporate/sso/\[token)], where \[token] will be replaced by the actual token.
</Accordion>

<Accordion title="Brevo Filter Transactional Emails List">
  This endpoint will show the list of emails for past 30 days by default. to retrieve emails before that time, please pass startdate and enddate in query filters.
</Accordion>

<Accordion title="Get all companies">
  This endpoint retrieves a list of companies with optional filters, supports pagination, sorting, and limits, includes company details in responses, and provides error specifics.
</Accordion>

<Accordion title="Brevo Delete Reseller Child By Id">
  Delete a reseller's child account using their identifier. requires the child's id or auth key. success or failure responses include status codes 204 (deleted), 400 (bad request), 403 (unauthorized), or 404 (not found).
</Accordion>

<Accordion title="Create a company">
  This api endpoint enables creating a company with details (name, attributes, country code) in json. it returns a unique id upon success, and specific error codes and messages for issues like invalid data.
</Accordion>

<Accordion title="Create a list">
  The '/contacts/lists' post endpoint creates a contact list in a folder by its id and list name, returning the new list's id on success or error codes and messages on failure.
</Accordion>

<Accordion title="Export the recipients of an email campaign">
  Export email campaign recipients by post to '/emailcampaigns/\{campaignid}/exportrecipients' with the id and recipient type (e.g., 'openers', 'clickers') in the body. an optional webhook url for notifications can be included.
</Accordion>

<Accordion title="Get all sender domains for a specific child account">
  Fetch all verified sender domains for a specific reseller's child account by providing the child's identifier. returns domain status and examples of successful calls. handles errors for bad requests, unauthorized access, and resource not found.
</Accordion>

<Accordion title="Delete an smtp transactional log">
  This endpoint deletes smtp logs using a message id or email, confirms with a 204 status, and gives error details for issues like bad requests or missing message ids.
</Accordion>

<Accordion title="Get all pipelines">
  This endpoint (`/crm/pipeline/details/all`) retrieves all pipeline details, including names, ids, and stages. it returns an array of pipeline objects on success or error codes for invalid requests.
</Accordion>

<Accordion title="Create coupons for a coupon collection">
  The '/coupons' post endpoint enables coupon creation in collections, requiring 'collectionid' (uuidv4) and 'coupons' array. it returns 204, 400, 401, 404 statuses based on the request's nature.
</Accordion>

<Accordion title="Delete a list">
  Deletes a contact list by its id. returns a 204 response if successful, or errors such as 400 (bad request) and 404 (list id not found) with detailed codes and messages for failure reasons.
</Accordion>

<Accordion title="Get all task types">
  This endpoint retrieves all task types, returning their ids and titles in json format. it's tagged under "tasks" with a successful response indicating the detailed task types available.
</Accordion>

<Accordion title="Create a new domain">
  This api endpoint (`post /senders/domains`) adds a new domain, requiring a domain name in json format in the body. it returns the domain id, name, a success message, and dns verification records upon success or error messages and codes if it fails.
</Accordion>

<Accordion title="Get all notes">
  This endpoint retrieves crm notes, supporting filters (entity type, ids, date range), pagination, and sorting by creation date. it returns note content, ids, author, timestamps, and issues a 400 error for invalid queries.
</Accordion>

<Accordion title="Get all the dedicated ips for your account">
  Retrieve a list of dedicated ip addresses for your account, including ip details such as id, ip address, status (active/inactive), and associated domain.
</Accordion>

<Accordion title="Get all the dedicated ips for a sender">
  This endpoint fetches a list of dedicated ips for a sender using their senderid, detailing each ip's address, domain, and weight. it handles success, bad requests, and unfound sender ids.
</Accordion>

<Accordion title="Create a contact">
  This endpoint allows creating or updating a contact with various options like email, sms settings, and custom attributes. successful creation returns the contact id, while updates and errors have specific responses.
</Accordion>

<Accordion title="Get all tasks">
  This endpoint fetches a filtered task list based on type, status, assignee, contacts, deals, and company ids within a date range. it offers pagination, sorting, and outputs tasks' details including ids, names, and linked entities.
</Accordion>

<Accordion title="Get all files">
  This endpoint retrieves files filtered by entity types, ids, dates, and supports pagination and sorting. it filters by companies, deals, contacts, etc., offering details like name and size. errors have codes and messages for invalid requests.
</Accordion>

<Accordion title="Create a new sender">
  The post `/senders` endpoint creates new senders with name, email (requires verification), and optional dedicated ips (with domain and weight). returns sender id, spf, dkim statuses, or error codes/messages.
</Accordion>

<Accordion title="Get all the contacts">
  This endpoint fetches contacts with pagination and supports filtering by creation or modification dates, and sorting. parameters: limit, offset, modifiedsince, createdsince, sort, segmentid, listids. returns contact details and count.
</Accordion>

<Accordion title="Delete scheduled emails by batchid or messageid">
  Delete scheduled batch of emails by batchid or single scheduled email by messageid
</Accordion>

<Accordion title="Delete a company">
  Delete a company by id. requires the company id in the path. success results in a 204 status, while errors return 400 (invalid data) or 404 (not found) with detailed error messages.
</Accordion>

<Accordion title="Get all your sms activity unaggregated events">
  This endpoint retrieves detailed sms event stats, allowing for pagination, date range, and phone number/event type/tag filtering. it includes specifics like message id and bounce reasons, with error handling.
</Accordion>

<Accordion title="Delete a message sent by an agent">
  Only agents’ messages can be deleted.
</Accordion>

<Accordion title="Create orders in batch">
  Create multiple orders at one time instead of one order at a time
</Accordion>

<Accordion title="Get all your coupon collections">
  The `/couponcollections` endpoint provides access to all coupon collections, supporting pagination, sorting by creation date, and includes important details like id, name, default coupon, creation and expiry dates, and coupon counts.
</Accordion>

<Accordion title="Fetch all events history for one particular received email">
  This endpoint will show the list of all events history for one particular received email.
</Accordion>

<Accordion title="Get all the lists">
  The endpoint fetches all contact lists, supporting pagination (via `limit` and `offset`), sorting (by creation time), and filtering. it returns details like ids, names, subscriber counts, and folder ids.
</Accordion>

<Accordion title="Get all the segments">
  The get endpoint '/contacts/segments' retrieves segments, allowing filtering, pagination via 'limit' and 'offset', and sorting with 'sort'. it returns listings including id, name, category, and last update time.
</Accordion>

<Accordion title="Get all webhooks">
  Retrieve all webhooks via a get request to the `/webhooks` endpoint, with filter and sort options by type and date. the response includes description, url, id, events, creation/modification dates, and details on batching, authentication, and headers.
</Accordion>

<Accordion title="Create a coupon collection">
  Create a coupon collection by sending json with 'name' and 'defaultcoupon'. success returns the new collection's uuid. errors detailed for bad requests and unauthorized access.
</Accordion>

<Accordion title="Create products in batch">
  The `/products/batch` endpoint allows for batch creation and updating of products in an ecommerce system. it accepts a json request body detailing product information, such as id, name, and price. responses include counts of created and updated products.
</Accordion>

<Accordion title="Fetch all external feeds">
  This endpoint can fetch all created external feeds.
</Accordion>

<Accordion title="Delete sub account from group">
  This endpoint allows you to remove a sub-organization from a group.
</Accordion>

<Accordion title="Get an automated message">
  This endpoint fetches an automated message by id, detailing its id, type, text, sender, and creation time, and includes error codes for invalid data or not found items.
</Accordion>

<Accordion title="Create a new sub account under a master account">
  This endpoint will create a new sub-account under a master account
</Accordion>

<Accordion title="Get all your whatsapp activity unaggregated events">
  This endpoint will show the unaggregated statistics for whatsapp activity (30 days by default if `startdate` and `enddate` or `days` is not passed. the date range can not exceed 90 days)
</Accordion>

<Accordion title="Get all your transactional email activity unaggregated events">
  This endpoint will show the aggregated stats for past 30 days by default if `startdate` and `enddate` or `days` is not passed. the date range can not exceed 90 days
</Accordion>

<Accordion title="Get an email campaign report">
  Retrieve comprehensive reports for email campaigns by supplying the campaign id and optional stat filters, covering everything from global stats and link analytics to recipient interactions.
</Accordion>

<Accordion title="Get an sms campaign">
  This endpoint provides detailed data on an sms campaign, including content, status, schedule, sender, dates, recipient data, and delivery statistics, with error handling for invalid requests.
</Accordion>

<Accordion title="Delete a note">
  Endpoint `/crm/notes/\{id\}` allows deleting a specific note by its id. it returns a 204 status code when successful, or a 400/404 with error details if the request fails. essential for managing crm notes efficiently.
</Accordion>

<Accordion title="Get an a b test email campaign results">
  Obtain winning version of an a/b test email campaign
</Accordion>

<Accordion title="Get a category details">
  This ecommerce endpoint retrieves details of a specific category by id, including its name, creation and modification timestamps, and url. responses include successful details retrieval, bad request errors, and not found errors for invalid ids.
</Accordion>

<Accordion title="Delete a contact">
  Delete a contact using an id or email via 'identifier.' successful deletions return 204; failures may yield 400, 404, or 405 errors if attempting to delete a registered email.
</Accordion>

<Accordion title="Get an external feed by uuid">
  This endpoint will update an external feed.
</Accordion>

<Accordion title="Get a company">
  Retrieve company details by id. provides company attributes, linked contacts & deals. errors for invalid id or missing company.
</Accordion>

<Accordion title="Fetch scheduled emails by batchid or messageid">
  Fetch scheduled batch of emails by batchid or single scheduled email by messageid (can retrieve data upto 30 days old)
</Accordion>

<Accordion title="Get a child account s details">
  This endpoint enables resellers to fetch child account details using an auth key or id, offering data on company info, credits, email/sms usage, and tech specifics such as ips and api keys. it also details responses for invalid or unauthorized requests.
</Accordion>

<Accordion title="Get a contact s details">
  This endpoint provides the last 90 days' contact stats by default. for older data, use the get contact campaign stats endpoint with specific date ranges. more info: [https://developers.brevo.com/reference/contacts-7#getcontactstats](https://developers.brevo.com/reference/contacts-7#getcontactstats)
</Accordion>

<Accordion title="Get a coupon collection by id">
  Fetch a specific coupon collection's details by id, including name, creation date, and coupon metrics. returns errors for bad requests, unauthorized access, or if not found.
</Accordion>

<Accordion title="Dissociate a dedicated ip to the child">
  This endpoint lets resellers remove a dedicated ip from a child account by providing the child's identifier and the ip address. a successful removal returns a 204 status, with failures giving 400 or 404 errors based on the issue.
</Accordion>

<Accordion title="Delete a contact from a list">
  This endpoint enables users to delete specific, a batch, or all contacts from a list using `listid`. contacts can be specified by emails, ids, or selecting `all`. the response details successes, failures, and a process id for batch deletions.
</Accordion>

<Accordion title="Create update a category">
  This endpoint facilitates the creation or update of ecommerce categories, requiring json details like id for updates, and name for creation. creation returns status 201 with the category's id; updates return 204. errors give a 400 status.
</Accordion>

<Accordion title="Create a note">
  This endpoint enables users to create notes in the crm with text and linked ids (contact, deal, company), returning the note's id or errors for invalid inputs/formats.
</Accordion>

<Accordion title="Delete a domain">
  Deletes a specified domain from the system. requires the domain name in the path. responses include success (200 ok, domain deleted), bad request (400, with various error codes), and not found (404, domain does not exist).
</Accordion>

<Accordion title="Delete a sender">
  This api endpoint deletes a sender by id, requiring an integer id. successful deletions return a 204 code, while errors return 400 with details and 404 if the id is not found.
</Accordion>

<Accordion title="Create a whatsapp template">
  This endpoint enables whatsapp campaign template creation, requiring `name`, `language`, `category`, and `bodytext`. `mediaurl` and `headertext` are optional. success returns a 201 status and template id; failures return error details.
</Accordion>

<Accordion title="Delete a file">
  This endpoint allows for the deletion of a specific file by id. on success, it returns a 204 status. errors related to invalid data or file not found are handled with 400 and 404 statuses, respectively, detailing the nature of the failure.
</Accordion>

<Accordion title="Delete a task">
  This endpoint deletes a specified task by its id. success returns 204 with no content. errors yield a 400 for invalid requests, detailing the issue, or a 404 if the task id isn't found, with specific error messages and codes provided for clarity.
</Accordion>

<Accordion title="Delete a sub account">
  Endpoint `/corporate/subaccount/\{id\}` allows for deletion of a specified sub-account by id. it returns `204` if successful, `400` for bad requests (e.g., invalid parameters), and `404` if the sub-account is not found.
</Accordion>

<Accordion title="Delete a deal">
  This endpoint allows for the deletion of a specified deal by its id. upon successful deletion, a 204 status is returned. errors are detailed with specific codes and messages for issues like invalid data (400) or missing ids (404).
</Accordion>

<Accordion title="Create a webhook">
  The "/webhooks" endpoint enables webhook creation via a json payload specifying the events, url, and optional settings (description, batch mode, auth, headers, type). it returns the webhook's id upon success, and detailed error messages for bad requests.
</Accordion>

<Accordion title="Delete an automated message">
  This endpoint deletes an automated message by its id, responds with 204 if successful, and provides error codes 400 or 404 with details if it fails.
</Accordion>

<Accordion title="Create update a product">
  This endpoint facilitates creating or updating ecommerce products, allowing post of details like id and price. it returns 201 for creation (including product id) or 204 for updates, and a 400 error for invalid requests.
</Accordion>

<Accordion title="Create a task">
  This endpoint enables users to create tasks in the crm, requiring task name, type id, and due date, with options for additional details. successful creation yields a unique task id.
</Accordion>

<Accordion title="Delete an attribute">
  Delete a specific attribute from a contact by specifying its category and name. categories include normal, transactional, etc. successful deletion returns a 204 status. errors return relevant codes such as 'bad request' or 'attribute not found'.
</Accordion>

<Accordion title="Delete an email campaign">
  This endpoint allows for the deletion of an email campaign by providing the campaign's id. on success, it confirms the deletion without content. errors return detailed messages for issues like bad requests or if the campaign id is not found.
</Accordion>

<Accordion title="Get a message">
  Fetches a specific message in a conversation by its id. supports detailed object including message id, type (agent/visitor), text, agent and visitor info, timestamps, and file attachments if any. errors for invalid requests or missing items are detailed.
</Accordion>

<Accordion title="Get a list s details">
  This get endpoint fetches details about a contact list using its listid, including id, name, subscribers, blacklisted contacts, and email campaign stats with optional date range. it returns list details, error messages, or a 404 error if not found.
</Accordion>

<Accordion title="Get a group details">
  This endpoint allows you to retrieve a specific group’s information such as the list of sub-organizations and the user associated with the group.
</Accordion>

<Accordion title="Get a webhook details">
  Retrieve details of a specific webhook by its id, including events it's configured for, type (marketing/transactional), creation/modification dates, url, description, and more. supports error handling for bad requests and unfound ids.
</Accordion>

<Accordion title="Get a deal">
  This get endpoint fetches details for a deal using its id, including attributes and linked contacts/companies. it requires an 'id' parameter and returns status codes 200, 400 for invalid ids, and 404 for missing deals.
</Accordion>

<Accordion title="Get pipeline stages">
  This endpoint is deprecated. prefer /crm/pipeline/details/\{pipelineid} instead.
</Accordion>

<Accordion title="Get file details">
  This endpoint fetches detailed file information by id, including name, authorid, and more. responses vary from successful retrieval (200) to invalid data (400) and not found (404).
</Accordion>

<Accordion title="Get company attributes">
  This endpoint retrieves a list of company attributes, including names, labels, types, options, and required status in json format. suitable for understanding company data structure.
</Accordion>

<Accordion title="Get a note">
  The `/crm/notes/\{id\}` endpoint supports get requests to fetch details of a specific note by id, including text, linked contacts, deals, author information, and timestamps, with responses for successful retrieval, invalid data, or note not found.
</Accordion>

<Accordion title="Get sub account details">
  This endpoint will provide the details for the specified sub-account company
</Accordion>

<Accordion title="Get lists in a folder">
  This openapi endpoint fetches lists from a contact folder with options for limit, offset, and sort. it details list id, name, subscriber count, supports sorting, pagination, and flags errors like bad requests or missing folders.
</Accordion>

<Accordion title="Get contacts in a list">
  This endpoint fetches contacts from a specific list with filter, pagination, and sorting options. it supports detailed queries, including attributes and status, and handles errors like bad requests and missing list ids.
</Accordion>

<Accordion title="Get a shared template url">
  Get a unique url to share & import an email template from one brevo account to another.
</Accordion>

<Accordion title="Get email campaigns statistics for a contact">
  Fetches email campaign stats for a contact by email/id with optional date filters (max 90 days), including sent messages, deliveries, opens, clicks, bounces, complaints, and unsubscribes.
</Accordion>

<Accordion title="Get order details">
  Get all the orders
</Accordion>

<Accordion title="Get a pipeline">
  Access deal pipeline details by id. fetch the name, id, and stages of a specific pipeline to manage deals effectively. returns data in json format. error codes included for invalid requests.
</Accordion>

<Accordion title="Get session token to access brevo sso">
  It returns a session \[token] which will remain valid for a short period of time. a child account will be able to access a white-labeled section by using the following url pattern => https\:/email.mydomain.com/login/sso?token=\[token]
</Accordion>

<Accordion title="Get the details of requested master account">
  This endpoint will provide the details of the master account.
</Accordion>

<Accordion title="Get deal attributes">
  This endpoint (`/crm/attributes/deals`) fetches deal attributes, returning an array of attribute details including internal name, label, type, options, and if required.
</Accordion>

<Accordion title="Get the list of all your senders">
  The "/senders" \[get] endpoint fetches a list of account senders, allowing ip/domain filtering. it reveals sender id, name, email, status, and ips, supports dedicated ip filters, and reports success or bad request errors.
</Accordion>

<Accordion title="Get the list of all admin users">
  This endpoint allows you to list all admin users of your admin account
</Accordion>

<Accordion title="Get the list of all the events for the received emails">
  This endpoint will show the list of all the events for the received emails.
</Accordion>

<Accordion title="Get the list of groups">
  This endpoint allows you to list all groups created on your admin account.
</Accordion>

<Accordion title="Get the list of blocked or unsubscribed transactional contacts">
  Retrieve a list of contacts blocked or unsubscribed from transactional emails within a specified date range. supports pagination, sender filtering, and sorting.
</Accordion>

<Accordion title="Get the personalized content of a sent transactional email">
  Fetch the content of a sent transactional email using its unique id. this includes email details like recipient, subject, send date, events, body content, and attachment count.
</Accordion>

<Accordion title="Get the list of all your domains">
  The `/senders/domains` endpoint provides a complete list of domains linked to your account, detailing each domain's id, name, auth status, verification status, and any dedicated ips, along with property details and error information for invalid requests.
</Accordion>

<Accordion title="List all attributes">
  This get endpoint at '/contacts/attributes' lists all available contact attributes in your account. it responds with attribute details including name, category (normal, transactional, etc.), type (text, date, etc.), and enumeration for category types.
</Accordion>

<Accordion title="Link and unlink company with contact and deal">
  This endpoint allows for updating a company's links to contacts and deals via provided ids, requiring a json with id arrays. successful updates return code 204, and validation errors yield a 400 status.
</Accordion>

<Accordion title="Import contacts">
  It returns the background process id which on completion calls the notify url that you have set in the input. **note**: - any contact attribute that doesn't exist in your account will be ignored at import end.
</Accordion>

<Accordion title="Get the list of all the sub accounts of the master account">
  This endpoint will provide the list all the sub-accounts of the master account.
</Accordion>

<Accordion title="Get the list of all children accounts">
  The `/reseller/children` endpoint enables resellers to view child account info, supporting pagination via `limit` and `offset`. it shows details like name, email, credits, and handles errors like unauthorized access.
</Accordion>

<Accordion title="Get the list of email templates">
  This endpoint retrieves a list of email templates, allowing filtering by status, pagination through limit and offset parameters, and sorting by creation order. supports querying active/inactive templates and customization on returned results.
</Accordion>

<Accordion title="Get a whatsapp campaign">
  This endpoint fetches details of a whatsapp campaign by id, including its name, status, sender, recipients, template, and dates, plus error messages for invalid or absent campaigns.
</Accordion>

<Accordion title="Link and unlink a deal with contacts and companies">
  This endpoint patch `/crm/deals/link-unlink/\{id\}` links/unlinks deals with contacts/companies by id. it requires a deal id and json with contact/company ids. it returns a 204 status for success or 400 for invalid data.
</Accordion>

<Accordion title="Revoke an admin user">
  This endpoint allows to revoke/remove an invited member of your admin account
</Accordion>

<Accordion title="Get the list of all your users">
  This endpoint fetches invited organization users, detailing their email, ownership, activation status, and feature access (e.g., marketing, conversations, crm). responses can be successful user data or a 400 error for bad requests.
</Accordion>

<Accordion title="Get user activity logs">
  This endpoint fetches organization user activity logs, allows date range filtering, and supports pagination. it returns activities with details like type, time, email, ip, and browser info.
</Accordion>

<Accordion title="Returns the information for all your created sms campaigns">
  This endpoint delivers detailed sms campaign data, including the ability to filter by status, date, and sort. it supports queries for various parameters, offering insights into content, scheduling, sender, recipients, and performance metrics.
</Accordion>

<Accordion title="Get a product s details">
  This ecommerce endpoint allows fetching product details by id, including its name, dates, images, and metadata. it supports get requests, and provides error codes and messages for issues like bad requests or missing product ids.
</Accordion>

<Accordion title="Return the informations for a process">
  Retrieve process details by id, including its name, status, and export url upon completion. supports querying with the process id and returns response codes for success (200), bad request (400), or not found (404).
</Accordion>

<Accordion title="Return all your products">
  This ecommerce api allows for detailed product searches with filters (e.g., price, categories), and supports pagination. it offers thorough product information, including images and metadata.
</Accordion>

<Accordion title="Send invitation to an admin user">
  This endpoint invites members to manage the admin account. it details permissions for features like my plan, api (none), user management, and app management (not in entv2), with a note on conditional access based on the 'all features access' flag.
</Accordion>

<Accordion title="Send a message as an agent">
  This endpoint enables agents to send messages in `conversations` using a json with `visitorid` and `text` required, and optional fields like `agentid`. success returns message details; failures return error codes.
</Accordion>

<Accordion title="Get your account information plan and credits details">
  This endpoint retrieves detailed account information, including user's personal details (name, email, company, address), plan specifics, credits, transactional email account status, and marketing automation platform activation.
</Accordion>

<Accordion title="Revoke user permission">
  The put endpoint '/organization/user/invitation/revoke/\{email}' revokes user permissions via email, returning status and credit notes on success, and manages unauthorized access with error codes and messages.
</Accordion>

<Accordion title="Returns the template information">
  Fetch email template details by templateid for transactional emails, including name, subject, status, content, and more. supports fetching by template id with a path parameter. responses include success and error cases.
</Accordion>

<Accordion title="Get the list of blocked domains">
  Get the list of blocked domains
</Accordion>

<Accordion title="Send a template to your test list">
  The `/smtp/templates/\{templateid\}/sendtest` endpoint sends a template email to a test list or specified addresses, with `templateid` and optional `emailto`. max 50 emails/day. responses: 204 (success), 400 (bad request), 404 (id not found).
</Accordion>

<Accordion title="Send your sms campaign immediately">
  This endpoint enables sending an sms campaign instantly via post to '/smscampaigns/\{campaignid}/sendnow', needing a campaignid. it returns 204 for success, and errors 400, 402, or 404 for various failures.
</Accordion>

<Accordion title="Send sms message to a mobile number">
  The '/transactionalsms/smd' post endpoint sends sms (transactional/marketing), requiring sender, recipient, content, and options. success leads to a 201 status, messageid, credits used; failures return error codes/messages.
</Accordion>

<Accordion title="Managing the status of the order">
  Manages the transactional status of the order
</Accordion>

<Accordion title="Send invitation to user">
  Brevo provides email, calls, and automations with customizable access levels. permissions vary by plan, with `all features access` for complete control. selection of features and permissions is crucial when adding users.
</Accordion>

<Accordion title="Send the report of a campaign">
  A pdf will be sent to the specified email addresses
</Accordion>

<Accordion title="Send an automated message to a visitor">
  Example of automated messages: order status, announce new features in your web app, etc.
</Accordion>

<Accordion title="Unblock an existing domain from the list of blocked domains">
  Unblocks an existing domain from the list of blocked domains
</Accordion>

<Accordion title="Update an email campaign status">
  Update email campaign status (suspended, archive, etc.) using its id. requires id in path, new status in json. successful updates return 204, 400 for bad requests, 404 if id not found.
</Accordion>

<Accordion title="Sets agent s status to online for 2 3 minutes">
  We recommend pinging this endpoint every minute for as long as the agent has to be considered online.
</Accordion>

<Accordion title="Get your sms activity aggregated over a period of time">
  Fetch aggregated sms activity reports over a specified period using start/end dates or a number of past days. includes metrics like delivered, bounced, and replied sms. filters available for specific tags.
</Accordion>

<Accordion title="Send an email campaign immediately based on campaignid">
  This endpoint sends an email campaign instantly via post, requiring a campaignid in the path. responses include success (204), invalid request errors (400), insufficient credits (402), and invalid campaign id errors (404).
</Accordion>

<Accordion title="Send a test sms campaign">
  Endpoint allows sending a test sms for a specific campaign by id. requires the recipient's mobile number in json format. responds with success or error detailing issues like invalid parameters or campaign id not found.
</Accordion>

<Accordion title="Send your whatsapp template for approval">
  This endpoint sends whatsapp campaign templates for approval, requiring a template id. a successful submission returns a 200 status; errors return specific codes and messages for issues like bad requests or unauthorized access.
</Accordion>

<Accordion title="Update an external feed">
  This endpoint will update an external feed.
</Accordion>

<Accordion title="Update an email template">
  Update a transactional email template by specifying a template id and providing updated details such as tag, sender info, template name, content, and more. supports modifying template status and attaching files via url.
</Accordion>

<Accordion title="Update a campaign s status">
  Endpoint updates sms campaign status via put; include campaign id, desired status in body. supports various statuses; successful updates return 204, errors may return 400 or 404.
</Accordion>

<Accordion title="Unblock or resubscribe a transactional contact">
  To unblock a transactional email contact, send a delete request to `/smtp/blockedcontacts/\{email\}` with their email in the url. possible responses are 204 (unblocked), 400 (bad request), and 404 (email not found).
</Accordion>

<Accordion title="Update a company">
  This endpoint allows for the partial update of a company's details by its id. it requires a json body with company details, such as name and attributes, and responds with updated company information. errors are returned for invalid data or not found ids.
</Accordion>

<Accordion title="Update an email campaign">
  This endpoint updates email campaign details, including tags, content, schedule, and sender info. features a/b testing, ip warmup, and metrics. it also handles errors for invalid inputs or missing ids.
</Accordion>

<Accordion title="Send a transactional email">
  This endpoint lets users send or schedule transactional emails with customizable sender details, recipients, content, attachments, and headers. it supports tags and templates for management and personalization.
</Accordion>

<Accordion title="Update an automated message">
  Update a message by its id by sending the new text in json format. successful updates show the updated message details; failures return error codes and messages.
</Accordion>

<Accordion title="Remove email and or sms credits from a specific child account">
  This endpoint enables resellers to deduct email/sms credits from a child account using `childidentifier`. requests must specify credit amounts. responses may confirm removal or report errors such as unauthorized access or account not found.
</Accordion>

<Accordion title="Update a group of sub accounts">
  This endpoint allows to update a group of sub-accounts
</Accordion>

<Accordion title="Update a folder">
  The put endpoint `/contacts/folders/\{folderid\}` updates a contact folder's name using its id and a json payload. it returns 204 on success, 400 for bad requests, and 404 if the id is not found.
</Accordion>

<Accordion title="Update a coupon collection by id">
  This endpoint allows updating a coupon collection's default coupon by specifying its id. provide the id in the path and updated values in the json body. responses include success (200 with details), bad request (400), and unauthorized (401).
</Accordion>

<Accordion title="Remove reseller child s sender domain">
  This endpoint enables resellers to delete domains for a child account using the child's id and domain name, ensuring secure removal by managing potential errors and unauthorized access.
</Accordion>

<Accordion title="Update a list">
  Update contact lists by id. accepts renaming the list or moving it to a different folder. requires `listid` in the path and json body with `name` or `folderid`. returns `204` on success or specific error codes for failures such as `400` and `404`.
</Accordion>

<Accordion title="Get your sms activity aggregated per day">
  Get daily aggregated sms reports covering requests, deliveries, and more, customizable by date, days past, and tags, with detailed stats and sorting options.
</Accordion>

<Accordion title="Update a contact">
  This endpoint updates a contact's details, including attributes and blacklist statuses, using either an id or email. it accepts a json body and returns codes for success (204), bad request (400), or not found (404).
</Accordion>

<Accordion title="Resend  cancel admin user invitation">
  This endpoint will allow the user to: - resend an admin user invitation - cancel an admin user invitation
</Accordion>

<Accordion title="Update a message sent by an agent">
  Only agents’ messages can be edited.
</Accordion>

<Accordion title="Send a whatsapp message">
  This endpoint is used to send a whatsapp message.

  (**the first message you send using the api must contain a template id. you must create a template on whatsapp on the brevo platform to fetch the template id.**)
</Accordion>

<Accordion title="Return all the processes for your account">
  This api endpoint fetches all account processes, enabling result customization (limit, offset, sort) and showing process ids, names, statuses, and export urls. it supports pagination and sorting.
</Accordion>

<Accordion title="Update a note">
  This endpoint updates a note by id, allowing changes to text, contacts, deals, and companies. it requires a json body with text and optional linked ids. on success, it returns http 204, and for errors, returns 400, 404, or 415.
</Accordion>

<Accordion title="Return all your categories">
  The `/categories` endpoint supports pagination, sorting, and filtering for retrieving categories. it provides details like id, name, urls, and timestamps along with the total count, and handles errors for invalid requests.
</Accordion>

<Accordion title="Update a sender">
  Update a sender's details by senderid, including name, email, and dedicated ips. supports replacing all existing ips with new ones if specified. errors for bad requests or missing sender id are handled with specific codes and messages.
</Accordion>

<Accordion title="Update a webhook">
  Update a webhook by including its id in the path and updating details in the request body like description, url, and more. successful updates return 204, while invalid requests return 400, and missing webhook ids return 404.
</Accordion>

<Accordion title="Update a task">
  This endpoint permits updating specific crm task details (e.g., name, duration, type, date, notes, status, assignments, linked entities) and reminders. it returns error messages for invalid data or missing task id.
</Accordion>

<Accordion title="Return all your created email campaigns">
  This endpoint fetches email campaigns based on filters like type, status, and stats. it allows queries by date, supports pagination, and sorting, returning comprehensive details on campaigns, their statistics, and recipient information.
</Accordion>

<Accordion title="Return all your created whatsapp templates">
  This endpoint fetches created whatsapp template messages, offering filters like dates, pagination, and sorting. parameters: startdate, enddate, limit, offset, sort, source. it returns details such as id, name, status, and creation date.
</Accordion>

<Accordion title="Get your transactional email activity aggregated per day">
  This endpoint provides daily reports on email activities like requests, deliveries, and clicks, with filters by date or tags, and sorting options. it also supports pagination with customizable settings.
</Accordion>

<Accordion title="Return all your created whatsapp campaigns">
  This endpoint fetches whatsapp campaigns, allowing filters by date, pagination, and sort by modification. it provides campaign name, status, template id, and message stats.
</Accordion>

<Accordion title="Update a whatsapp campaign">
  Update whatsapp campaign details like name, status, schedule, and recipients using the campaign id. supports campaign edits, rescheduling, and recipient list updates. responses detail update success, deletion, or errors like bad requests.
</Accordion>

<Accordion title="Send an email campaign to your test list">
  This endpoint sends test email campaigns, specified by `campaignid`, to up to 50 recipients daily. it returns a 204 code for success and provides detailed messages for failures due to invalid emails or limit breaches.
</Accordion>

<Accordion title="Returns a folder s details">
  This endpoint fetches details of a specific contacts folder including id, name, and subscriber counts based on the provided `foldergb` input. it returns folder details or errors for bad requests or when the folder id isn't found.
</Accordion>

<Accordion title="Update an sms campaign">
  This endpoint updates an sms campaign by id, allowing modifications to its name, sender, content, recipient lists, schedule, and more. success returns a 204 status; errors yield 400 or 404 with details.
</Accordion>

<Accordion title="Send an sms campaign s report">
  Send report of sent and archived campaign, to the specified email addresses, with respective data and a pdf attachment in detail.
</Accordion>

<Accordion title="Retrieve inbound attachment with download token">
  This endpoint will retrieve inbound attachment with download token.
</Accordion>

<Accordion title="Update a deal">
  This endpoint updates a deal's details using its id, requiring a path 'id' parameter and a json body with the information. success returns a 204 code; errors have specific codes/messages for invalid data or missing id.
</Accordion>

<Accordion title="Get your whatsapp api account information">
  Access whatsapp api account details including business id, sending limits, and phone number quality. view account, phone number, and business verification statuses. handle errors with specific codes and messages.
</Accordion>

<Accordion title="Get a task">
  Get details of a specific task by its id in the crm system. requires the task's unique string id. returns task details, including type, name, and related contacts, deals, and companies. possible errors: 400 (invalid id) and 404 (task not found).
</Accordion>

<Accordion title="Resend  cancel invitation">
  This endpoint lets users resend or cancel an email invitation by specifying the action and user email, providing success confirmation or unauthorized access errors.
</Accordion>

<Accordion title="Update reseller child s sender domain">
  Update a reseller's child sender domain by specifying childidentifier and domainname. requires the new domain value in the request. supports error handling for invalid requests and permissions.
</Accordion>

<Accordion title="Brevo Update Child Info Based On Id">
  This endpoint updates a reseller's child profile using their identifier, allowing changes to email, names, company, and password. it handles incorrect inputs or unauthorized actions with detailed error messages.
</Accordion>

<Accordion title="Update multiple contacts">
  The `/contacts/batch` `post` endpoint enables bulk contact updates, including emails, sms, external ids, and more. it requires a structured object with identifiers and update values. responses indicate success (204) or error (400) with messages.
</Accordion>

<Accordion title="Upload an image to your account s image gallery">
  Upload an image to the image gallery in your account. this post endpoint at '/emailcampaigns/images' requires an 'imageurl' (absolute url, max 2mb, formats: jpeg, jpg, png, bmp, gif) and optional 'name'. successful uploads return the image url.
</Accordion>

<Accordion title="Update sub account plan">
  This endpoint will update the sub-account plan
</Accordion>

<Accordion title="Update contact attribute">
  This api endpoint updates a contact attribute, requiring its category and name. it accepts a new value or values with labels in the request, responding with `204` for success, or error codes like `400`/`404` for invalid requests or not found attributes.
</Accordion>

<Accordion title="Brevo Update Child Account Status By Identifier">
  Update a reseller's child account status by id, including email, sms, marketing, and platform preferences. requires child id and status in json. responses show update success or errors for invalid requests/permissions.
</Accordion>

<Accordion title="Update permission for a user">
  Brevo provides features like email campaigns, deals, and calls with customizable user access levels, including creation and editing. ensure to specify the appropriate permission level for each user based on your plan for an optimal experience.
</Accordion>

<Accordion title="Validate sender using otp">
  Validates a sender with a provided otp via put request on '/senders/\{senderid}/validate'. requires senderid in the path and an otp in the json body. responses include 204 (verified), 400 (bad request), and 404 (sender id not found).
</Accordion>

<Accordion title="Upload a file">
  The `post /crm/files` endpoint enables file uploads, linking them to crm entities. it requires multipart/form-data and returns ids upon success or error details on failure.
</Accordion>

<Accordion title="Validate domain configuration">
  This api endpoint checks a domain's verification, authentication, and dns records by requiring a `domainname`. it returns the domain's statuses and records on success, or error messages on failure.
</Accordion>


# Browseai
Source: https://docs.push.ai/integrations/browseai



Browse.ai allows you to turn any website into an API using its advanced web automation and data extraction tools, enabling easy monitoring and data retrieval from websites.

<Accordion title="Delete a specific task">
  This tool allows you to delete a specific task in browseai by its task id. it is used for cleaning up completed or failed tasks, managing resources, and maintaining your task list.
</Accordion>

<Accordion title="Create Webhook">
  This tool creates a new webhook for a browseai robot. webhooks are used to receive notifications when tasks are completed or data changes are detected. the webhook will be called with the task details when specific events occur. it is useful for: - setting up automated notifications for task completion - receiving real-time updates when changes are detected - integrating browseai with your own systems - automating workflows based on robot task results the webhook can be configured to trigger on different events: - task.completed: when a task is successfully completed - task.failed: when a task fails - changes.detected: when changes are detected during monitoring
</Accordion>

<Accordion title="Delete a specific monitor">
  This tool allows users to delete a specific monitor from their browse ai account. it uses the delete method and requires a valid monitor id.
</Accordion>

<Accordion title="Get Robots List">
  This tool retrieves a list of all robots under your account in browse ai. each robot represents an automated task that can be trained to perform various web operations like opening webpages, logging in, clicking buttons, filling forms, extracting data, and monitoring changes. it is useful for: - getting an overview of all your automated tasks - checking the status of your robots - retrieving robot ids for use with other api endpoints - monitoring when robots were last updated or created
</Accordion>

<Accordion title="Get Task Details">
  This tool retrieves detailed information about a specific task in browse ai by its task id. it returns comprehensive details including the task's status, execution results, associated metadata, timestamps, and configuration. it complements existing tools by providing an in-depth view of individual task execution, including metadata and error details if applicable.
</Accordion>

<Accordion title="Get Robot Tasks">
  This tool retrieves all tasks associated with a specific robot in browse ai. it provides a paginated list of tasks with their details including status, input parameters, captured data, screenshots, and lists. it is useful for: - monitoring task execution status - retrieving captured data and screenshots - analyzing task execution history - debugging robot performance
</Accordion>

<Accordion title="Run Robot">
  This tool allows you to trigger the execution of a browseai robot on demand. the tool will run a specified robot with the provided parameters and return the task details. it requires a robot id and optional input parameters (such as url, search term, or other parameters) to configure the robot's execution. it is useful for: - starting robot executions programmatically - automating data collection tasks - triggering robots with custom parameters - integrating robot execution in workflows
</Accordion>

<Accordion title="Bulk Run Tasks">
  This action allows users to bulk run up to 50,000 tasks using a specified robot. it provides a post endpoint at /v2/robots/\{robotid}/bulk-tasks and supports parameters such as robot id (required), title (required), and input parameters (required). this bulk operation is essential for large-scale data extraction.
</Accordion>

<Accordion title="Create Monitor">
  This tool creates a new monitor for a specific robot in browse ai. it allows you to configure a monitor with a schedule (frequency and interval) for automatic execution, along with optional custom name and input parameters, enabling automated tracking of website changes.
</Accordion>


# Browserbase tool
Source: https://docs.push.ai/integrations/browserbase_tool



A browsing app that gets a URL, reads its contents, and returns it.

<Accordion title="Browserbase load tool">
  Load webpages url in a headless browser using browserbase and return the contents.
</Accordion>


# Bugbug
Source: https://docs.push.ai/integrations/bugbug



Template description for bugbug

<Accordion title="List suites">
  List all available test suites in the bugbug platform. this tool makes a get request to the /suites/ endpoint and returns a list of available test suites with pagination support.
</Accordion>

<Accordion title="Get test run details">
  Get detailed information about test runs from bugbug. this action retrieves test run details with optional filtering parameters.
</Accordion>

<Accordion title="List tests">
  Retrieves a list of all available tests in the bugbug account. this action provides access to all tests in the account with pagination support. it returns basic information about each test including its id, name, description, and timestamps.
</Accordion>

<Accordion title="Run test">
  Execute a test in bugbug and return the test run details. this action allows you to run a specific test with optional configuration for browser, device, viewport, and variable overrides. it returns detailed information about the test run including step-by-step execution status.
</Accordion>


# Cal
Source: https://docs.push.ai/integrations/cal



Cal simplifies meeting coordination by providing shareable booking pages, calendar syncing, and availability management to streamline the scheduling process

<Accordion title="Cancel booking via uid">
  Cancels a specific booking in the cal.com system using the provided booking uid. this endpoint should be used when a user or system needs to cancel a previously scheduled event or appointment. it allows for programmatic cancellation of bookings, which can be useful for integrations or automated workflows. the cancellation is initiated by sending a post request to this endpoint, and it will likely trigger any associated cancellation policies or notifications set up in the cal.com system. note that this action is typically irreversible, so it should be used with caution and proper confirmation from the user or system initiating the cancellation.
</Accordion>

<Accordion title="Check calendar version 2">
  The checkcalendaravailability endpoint retrieves the availability status of a specified calendar. it allows users to check free/busy times, ensuring efficient scheduling and resource management. this endpoint is particularly useful when you need to determine suitable time slots for scheduling events or meetings. it provides a snapshot of the calendar's current availability without exposing detailed event information. use this endpoint before attempting to schedule new events to avoid conflicts and optimize time management. note that the endpoint may have limitations on how far into the future it can check availability, and the granularity of the availability data may vary depending on the calendar's settings and the api's capabilities.
</Accordion>

<Accordion title="Create membership for organization">
  This endpoint adds a new member to an organization or updates an existing member's role and settings within the organization. it allows for the specification of the user's role, acceptance status, and impersonation settings. use this endpoint when you need to invite new members to your organization, change a member's role, or update their membership settings. the endpoint requires at least the user id and role to be specified, with optional parameters for fine-tuning the membership details. note that this endpoint does not handle the actual user creation process; the specified user id must correspond to an existing user in the system.
</Accordion>

<Accordion title="Connect to calendar">
  Retrieves the connection status or initiates a connection process for a specific calendar with external services or applications. this endpoint is used to check if a calendar is already connected or to start the integration process with other platforms, such as team collaboration tools or third-party scheduling services. it's particularly useful when setting up new integrations or troubleshooting existing connections. the endpoint does not modify the calendar itself but focuses on its external connectivity. note that the actual connection process may require additional steps or authorization, which might not be handled directly by this endpoint.
</Accordion>

<Accordion title="Check gcal synchronization status">
  The gcal check endpoint is used to verify the connection status and synchronization between cal and a user's google calendar account. this get request allows developers to quickly check if the integration is active and functioning correctly. it's particularly useful when setting up or troubleshooting cal's google calendar integration. the endpoint doesn't modify any calendar data; it only retrieves the current status. while specific parameters are not defined, the response likely includes information about the connection status, last sync time, and any potential issues with the integration. use this endpoint when you need to ensure that cal can access and sync with the user's google calendar before performing other calendar-related operations.
</Accordion>

<Accordion title="Confirm booking by uid">
  Confirms a specific booking in the cal system using its unique identifier. this endpoint should be used when a user or system needs to finalize and approve a previously created booking. it marks the booking as confirmed, which may trigger additional actions such as sending confirmation emails or updating availability. this endpoint is crucial for completing the booking process and should only be called once per booking. it does not provide the ability to modify booking details; for that, a separate update endpoint should be used prior to confirmation.
</Accordion>

<Accordion title="Check ics feed calendar endpoint">
  Checks the validity and accessibility of an ics (icalendar subscription) feed. this endpoint verifies if the provided ics feed url is properly formatted, accessible, and contains valid calendar data. it should be used before integrating an external ics feed into the cal application or when troubleshooting issues with existing feed connections. the tool helps identify potential problems with the feed, such as incorrect urls, server issues, or malformed icalendar data. it does not modify or import the feed data; it only performs a validation check. users should ensure they have the necessary permissions to access the feed url before using this endpoint.
</Accordion>

<Accordion title="Create organization webhook by orgid">
  Creates a new webhook for an organization in cal.com. this endpoint allows you to set up automated notifications for various booking and meeting events. use it to integrate cal.com with your applications, enabling real-time updates and actions based on scheduling activities. the webhook can be customized with specific triggers, a payload template, and security features. it's particularly useful for synchronizing cal.com events with external systems, automating workflows, or maintaining up-to-date records in connected applications.
</Accordion>

<Accordion title="Create organization attributes">
  Creates a new custom attribute for an organization in the cal.com platform. this endpoint allows for the definition of various types of attributes (text, number, single select, or multi-select) that can be used to customize the behavior and data collection within the organization's cal.com instance. it's particularly useful for adding new fields to event bookings, user profiles, or other customizable areas of the application. the attribute creation process requires specifying the attribute's name, a unique slug, its data type, and any associated options for select-type attributes. this endpoint should be used when setting up new organizational features, expanding data collection capabilities, or implementing custom workflows within cal.com. it's important to note that while the attribute is created with this call, additional steps may be needed to integrate it into specific areas of the cal.com interface or functionality.
</Accordion>

<Accordion title="Add organization attribute option">
  Adds a new option to a specific attribute of an organization. this endpoint allows you to expand the list of available choices for a particular attribute by creating a new option with a display value and a unique identifier (slug). it's useful for dynamically extending the capabilities of attributes, such as adding new categories, tags, or selectable options for organization-specific features. the endpoint requires both the organization id and attribute id to ensure the new option is added to the correct attribute of the specific organization. use this when you need to introduce new, valid selections for an existing attribute in the system.
</Accordion>

<Accordion title="Create oauth client user">
  Creates a new managed user for a specific oauth client in the cal.com scheduling system. this endpoint is used to set up a user profile with initial scheduling preferences, including email, name, time format, week start day, timezone, locale, and avatar url. it's particularly useful for integrating cal.com's scheduling capabilities into third-party applications or services. the endpoint requires at least the user's email and name, with other parameters being optional but highly recommended for a complete user setup. note that if a timezone is not provided, the user won't have a default schedule, which may limit their ability to use certain features until manually set up.
</Accordion>

<Accordion title="Create oauth client webhook configuration">
  Creates a new webhook for a specific oauth client in cal.com, enabling real-time notifications for various booking and meeting events. this endpoint allows you to configure custom event triggers, specify a subscriber url for receiving notifications, and optionally customize the payload template. use this when you need to integrate cal.com events with external systems or automate workflows based on scheduling activities. the webhook can be set to active immediately or created in an inactive state for later activation. proper configuration of triggers and the subscriber url is crucial for effective event monitoring and integration.
</Accordion>

<Accordion title="Check stripe status">
  The stripe check endpoint is used to verify the status of the stripe integration within the cal scheduling system. it allows users to check if their stripe account is properly connected and functioning for payment processing related to scheduled events or services. this endpoint should be used when there's a need to confirm the health of the stripe integration, such as during initial setup, troubleshooting, or routine system checks. it provides a quick way to ensure that the payment processing capabilities are ready for use without initiating any actual transactions. note that this endpoint does not provide detailed stripe account information or process any payments; it's purely for checking the integration status.
</Accordion>

<Accordion title="Create phone call event">
  Creates a new phone call event for a specific event type within a team and organization using the cal.com api. this endpoint allows you to set up automated phone calls with customizable details for both the scheduler and the guest. it's particularly useful for scheduling check-in calls, appointments, or any scenario where a phone call needs to be integrated into an event workflow. the endpoint supports different template types and allows for personalized messaging options. use this when you need to automate phone call scheduling as part of your event management process. note that this endpoint requires valid phone numbers in e.164 format and a cal api key for authentication. it does not handle the actual phone call execution but rather sets up the event in the cal.com system.
</Accordion>

<Accordion title="Create team membership with role">
  Adds a new member to a specified team within the cal application. this endpoint allows you to invite users to join a team, set their initial role, and configure their membership settings. use this when you need to expand your team, assign roles to new members, or modify existing memberships. the endpoint requires the team id and user id, with optional parameters to customize the membership details. it's particularly useful for team administrators and owners managing their organization's structure in cal.
</Accordion>

<Accordion title="Create or update team profile">
  Creates a new team in the cal.com application with customizable properties for appearance, scheduling, and functionality. this endpoint allows you to set up a team with a unique name, visual branding (logo and banner), privacy settings, and default scheduling parameters. it's ideal for organizations looking to establish a new group within their cal.com account for collaborative scheduling and event management. the endpoint offers extensive customization options, from basic team information to advanced settings like timezone preferences and member acceptance policies. use this when you need to programmatically create and configure teams in cal.com, especially useful for large organizations or when automating team setup processes.
</Accordion>

<Accordion title="Create team in organization">
  Creates a new team within an organization in the cal scheduling api. this endpoint allows for the creation of a customizable team with various branding, scheduling, and privacy options. it should be used when setting up a new team within an existing organization, enabling collaborative scheduling and shared resources. the endpoint provides extensive customization capabilities but requires careful consideration of optional parameters to fully utilize its features. note that while many parameters are optional, they significantly impact the team's appearance and functionality, so it's recommended to review and set as many relevant parameters as possible during creation.
</Accordion>

<Accordion title="Check team stripe integration status">
  Retrieves the stripe integration status and related information for a specific team in the cal application. this endpoint should be used when you need to verify a team's stripe account status, check subscription details, or confirm payment information. it provides a quick way to assess the health and status of a team's integration with stripe for payment processing and subscription management. the endpoint does not modify any data and is safe for frequent checks. however, it should not be used excessively due to potential rate limiting. note that this endpoint only provides status information and does not allow for modifications to the team's stripe settings.
</Accordion>

<Accordion title="Delete event type by id">
  Deletes a specific event type from the cal scheduling system. this endpoint should be used when you need to permanently remove an event type configuration from your account. it's particularly useful for cleaning up obsolete or unused event types, streamlining your scheduling options. the operation is irreversible, so it should be used with caution. once an event type is deleted, any associated scheduling links will become invalid, and it will no longer be available for booking. this endpoint does not affect any existing bookings made using this event type prior to deletion.
</Accordion>

<Accordion title="Create phone call for event type">
  Creates a new phone call event type within a specified team's calendar system. this endpoint allows users to set up structured phone call events with customizable details such as caller and recipient information, event status, and call scripts. it's particularly useful for scheduling and managing phone appointments, check-ins, or any recurring phone-based events within a team context. the created event type can be used as a template for future phone call scheduling, streamlining the process of setting up similar calls. note that this endpoint only creates the event type structure and does not schedule actual calls; it prepares the system for future call scheduling based on the defined parameters.
</Accordion>

<Accordion title="Create user availability schedule">
  Creates a new schedule in the cal.com api, allowing users to define their availability patterns and exceptions. this endpoint is used to set up regular working hours, custom availability for specific days of the week, and overrides for particular dates. it's particularly useful for managing complex schedules or when setting up a new user in the system. the created schedule can be used to control when events can be booked with the user. note that while you can create multiple schedules, only one can be set as the default per user.
</Accordion>

<Accordion title="Delete conference app connection">
  Disconnects an active conferencing session for a specified application integration in cal. this endpoint should be used when you need to programmatically end or terminate an ongoing conference call or meeting. it's particularly useful for automating the process of closing conferences, ensuring that sessions are properly concluded and resources are freed up. the endpoint doesn't provide information about the disconnected session or return a list of active sessions. use this endpoint with caution, as it will immediately terminate the specified conference, potentially disrupting ongoing communications if used incorrectly.
</Accordion>

<Accordion title="Create user schedule in organization">
  Creates a new schedule for a specific user within an organization, defining their availability for booking events. this endpoint allows for detailed customization of a user's schedule, including regular weekly availability and date-specific overrides. it's particularly useful for setting up different scheduling scenarios, such as office hours, meeting availabilities, or special event timeslots. the created schedule can be set as the default for the user, which will be used for event types not tied to a specific schedule. when creating a schedule, consider the user's time zone and any recurring patterns in their availability to ensure accurate and efficient scheduling.
</Accordion>

<Accordion title="Add member to team using org and team id">
  Adds a new member to a specified team within an organization. this endpoint allows you to create a team membership by associating a user with a team and defining their role and permissions. it's used when you need to expand your team, assign new roles, or invite users to collaborate within a specific organizational structure. the endpoint requires the organization id and team id as path parameters, and accepts a json payload with user details and role information. it's particularly useful for team management, role assignment, and controlling user access within the cal application.
</Accordion>

<Accordion title="Delete membership in team">
  Removes a user's membership from a specific team within an organization. this endpoint should be used when you need to revoke a user's access to a team, such as when they leave the team or the organization. the operation is permanent and cannot be undone, so it should be used with caution. once a membership is deleted, the user will lose all access and permissions associated with that team. this endpoint does not remove the user from the organization entirely, only from the specified team.
</Accordion>

<Accordion title="Delete organization attribute">
  Deletes a specific attribute from an organization in the cal system. this endpoint should be used when you need to remove custom data or settings associated with an organization. it permanently removes the specified attribute, so use with caution. the endpoint is particularly useful for cleaning up obsolete data or correcting erroneously added attributes. note that this operation cannot be undone, and any integrations or features relying on the deleted attribute may be affected.
</Accordion>

<Accordion title="Delete oauth client webhook">
  Deletes a specific webhook associated with an oauth client in the cal application. this endpoint is used to remove a webhook subscription, effectively stopping any further notifications or callbacks that were previously set up for the specified oauth client. it should be used when you no longer need to receive real-time updates for certain events related to the oauth client. this operation is permanent and cannot be undone, so it should be used with caution. the endpoint requires both the oauth client id and the specific webhook id to ensure precise targeting of the webhook to be deleted.
</Accordion>

<Accordion title="Delete event type in team">
  Deletes a specific event type associated with a team in the cal scheduling system. this endpoint should be used when you need to permanently remove an event type configuration from a team's available scheduling options. it's particularly useful for cleaning up outdated or unused event types, or when restructuring a team's scheduling workflow. the operation is irreversible, so it should be used with caution. this endpoint doesn't return any data upon successful deletion, typically responding with a 204 no content status. it's important to note that deleting an event type will affect any existing schedules or integrations that rely on this event type, so ensure all dependencies are addressed before deletion.
</Accordion>

<Accordion title="Decline booking with reason">
  Declines a specific booking that requires confirmation in the cal scheduling system. this endpoint should be used when a host needs to reject or cancel a previously scheduled event. it requires providing a reason for declining, which helps maintain clear communication with the attendee. the endpoint is specifically for bookings that are in a state requiring confirmation and should not be used for already confirmed or past events. note that declining a booking is typically irreversible, so it should be used carefully. this action may trigger notifications to the attendee based on the cal system's configuration.
</Accordion>

<Accordion title="Create webhook for event type">
  Creates a new webhook for a specific event type in cal.com. this endpoint allows you to set up real-time notifications for various booking-related events, enabling integration with external services or applications. you can customize the webhook by specifying triggers, defining a payload template, and setting security parameters. use this when you need to automate actions or update external systems based on cal.com booking events. the webhook can be configured to handle multiple trigger events, providing flexibility in how you respond to different booking scenarios. note that proper configuration of the subscriberurl and handling of incoming webhook data is crucial for successful integration.
</Accordion>

<Accordion title="Delete oauth client user">
  Deletes a user's association with a specific oauth client in the cal application. this endpoint is used to revoke a user's access to resources managed by a particular oauth client, effectively removing their permissions and connection to that client. it should be used when you need to terminate a user's relationship with a specific application or service integrated with cal, such as when an employee leaves an organization or when access needs to be revoked for security reasons. this operation is permanent and cannot be undone, so it should be used with caution. the endpoint does not delete the user account from the cal system entirely, but only removes the association with the specified oauth client.
</Accordion>

<Accordion title="Delete organization attribute option">
  Deletes a specific option associated with an attribute of an organization in the cal system. this endpoint is used to remove configuration settings or options that are no longer needed for a particular organization's attribute. it provides granular control over organization-level configurations by allowing the removal of individual options. the endpoint should be used when you need to clean up or modify the available options for an organization's attribute. it's important to note that this operation is irreversible, so caution should be exercised when using this endpoint. the deletion will only affect the specified option and will not impact other options or the attribute itself.
</Accordion>

<Accordion title="Create team event types with custom options">
  This endpoint creates a new event type for a team within an organization in the cal scheduling system. it allows for extensive customization of event properties including duration, booking fields, location options, recurrence patterns, and team member assignments. use this endpoint when you need to set up a new type of schedulable event for your team, such as team meetings, client consultations, or product demos. the event type created will be available for booking through the cal platform, integrating with specified calendars and following the defined scheduling rules. note that while this endpoint offers a wide range of customization options, some advanced features like workflow integrations or complex recurrence patterns may require additional setup or api calls.
</Accordion>

<Accordion title="Create team event type">
  The createteameventtype endpoint creates a new event type for a team in cal. it defines parameters like duration, title, and hosts for team-wide events such as "strategy sessions" or "demo calls". this endpoint allows for customization of scheduling rules, booking limits, and appearance settings, providing control over the event's presentation and scheduling strategy.
</Accordion>

<Accordion title="Delete team memberships by id">
  Removes a user's membership from a specific team within the cal application. this endpoint should be used when you need to revoke a user's access to a team, such as when an employee leaves a project or organization. the deletion is permanent and cannot be undone, so it should be used with caution. this operation only removes the user from the specified team; it does not delete the user's account from the cal application. after successful deletion, the user will no longer have access to the team's resources or events.
</Accordion>

<Accordion title="Delete user from organization">
  Removes a specified user from a given organization within the cal scheduling system. this endpoint should be used when an administrator or authorized user needs to revoke a user's membership or access to an organization, such as when an employee leaves a company or a team member's role changes. the operation is permanent and will immediately remove all associated permissions and access rights the user had within that organization. it's important to note that this action does not delete the user account from the cal system entirely, but only removes their association with the specific organization. use with caution as it cannot be undone through this api, and may require manual re-addition of the user if done in error.
</Accordion>

<Accordion title="Delete schedule by id">
  Deletes a specific schedule from the cal application using its unique identifier. this endpoint should be used when you need to permanently remove a schedule from the system, such as when an event is cancelled or a recurring schedule is no longer needed. it's important to note that this action is irreversible; once a schedule is deleted, it cannot be recovered through the api. use this endpoint with caution, especially for schedules associated with upcoming or important events. the success of the deletion is typically indicated by the http status code of the response, with a 200 or 204 status suggesting successful removal.
</Accordion>

<Accordion title="Delete webhooks for eventtype">
  Deletes a webhook associated with a specific event type in the cal api. this endpoint is used to remove a previously configured webhook for a particular event type, effectively stopping any further notifications for that event type. it should be used when you no longer need to receive real-time updates about a specific event type or when you want to reconfigure your webhook settings. the operation is irreversible, so care should be taken to ensure that the correct eventtypeid is provided. this endpoint does not return the deleted webhook details, so it's recommended to retrieve and store any necessary information before deletion.
</Accordion>

<Accordion title="Delete org webhook">
  Deletes a specific webhook associated with an organization in the cal api. this endpoint is used to permanently remove a webhook configuration, stopping any further notifications or callbacks that were previously set up for that webhook. it should be used when you no longer need to receive updates for the events that the webhook was configured for, or when you want to clean up unused webhook configurations. this operation is irreversible, so it should be used with caution. once a webhook is deleted, you will need to create a new webhook if you want to receive notifications again in the future.
</Accordion>

<Accordion title="Get stripe connect info">
  Retrieves the current stripe connect account information associated with the cal user's account. this endpoint is used to check the status of the stripe connect integration, including account details, verification status, and payout information. it's particularly useful for users who want to manage their payment settings or troubleshoot issues related to stripe payments in their cal account. the endpoint does not modify any data and is safe for frequent calls. however, it doesn't provide real-time payment transaction details or allow for account modifications. use this endpoint when setting up stripe integration, verifying account status, or displaying account information to the user within the cal application.
</Accordion>

<Accordion title="Get all timezones">
  The get timezones endpoint retrieves a comprehensive list of valid time zone codes and ids supported by the cal scheduling api. this endpoint is essential for applications that need to manage appointments and events across different geographical regions. it provides the necessary data to ensure accurate time representation and conversion when scheduling events or displaying times to users in various locations. use this endpoint when you need to populate timezone selection dropdowns, validate user-inputted timezones, or synchronize timezone information across your application. the returned list can be used to localize event times, ensure correct timestamp generation, and facilitate scheduling for participants in different time zones. while the endpoint provides timezone information, it does not offer details about daylight saving time transitions or utc offsets for specific dates. for such precise time calculations, additional processing or separate api calls may be necessary.
</Accordion>

<Accordion title="Patch organization attribute option">
  Updates a specific option within an organization's attribute. this endpoint allows for partial modifications of an existing option, enabling you to change either its value, its slug, or both. it's particularly useful for maintaining and adjusting organizational settings or configurations over time. use this when you need to modify an option without replacing the entire attribute or creating a new option. the endpoint requires specific identifiers for the organization, attribute, and option to ensure precise updates. it's important to note that this operation may affect any systems or processes that rely on the original option values, so it should be used with caution and proper validation.
</Accordion>

<Accordion title="Mark booking absent for uid">
  Marks specified attendees or the host as absent for a particular booking in the cal.com scheduling system. this endpoint is used to update the attendance status after a scheduled event has occurred. it allows for recording absences of either the host, specific attendees, or both. this tool is particularly useful for maintaining accurate attendance records, which can be crucial for follow-ups, rescheduling, or analyzing participation trends in your organization's events.
</Accordion>

<Accordion title="Modify org attribute by id">
  Updates a specific attribute for an organization in the cal scheduling system. this endpoint allows for partial modifications to an existing attribute, such as changing its name, slug, type, or enabled status. it's particularly useful when you need to adjust attribute settings without replacing the entire attribute object. the endpoint should be used when fine-tuning organizational attributes to better suit evolving business needs or to correct attribute information. it's important to note that this operation only updates the specified fields, leaving others unchanged. care should be taken when modifying the 'type' field, as changing an attribute's type may have implications for existing data associated with that attribute.
</Accordion>

<Accordion title="Get schedule for user in team">
  Retrieves the schedules for a specific user within a team and organization context. this endpoint allows you to fetch all scheduled events or appointments for a particular user, considering their association with a specific team and organization. it's useful for getting an overview of a user's availability, upcoming events, or for synchronizing schedules across different systems. the endpoint should be used when you need to access or display a user's schedule within the context of their team and organization, such as for team planning, resource allocation, or integrating with external calendar systems. note that this endpoint only provides schedule information and does not allow for modifications to the schedules.
</Accordion>

<Accordion title="Delete team by id">
  Deletes a specific team from the cal system using its unique identifier. this endpoint should be used when you need to permanently remove a team and all its associated data from the application. it's important to note that this action is irreversible and will remove all team-related information, including member associations, scheduled events, and team-specific settings. use this endpoint with caution, ensuring that you have the correct teamid and necessary permissions to delete the team. this operation cannot be undone, so it's recommended to implement confirmation steps in your application before making this call.
</Accordion>

<Accordion title="Delete selected calendars">
  Removes one or more calendars from the list of selected calendars for the authenticated user. this endpoint is used to unselect or deactivate specific calendars within the cal application, affecting their visibility and usage in scheduling operations. it should be used when a user wants to stop using certain calendars for availability checks, event creation, or other cal functionalities. this operation does not delete the actual calendar data but rather removes it from the active selection. be cautious when using this endpoint, as it may impact existing scheduled events or availability if the deselected calendars were being used for those purposes.
</Accordion>

<Accordion title="Get available slots info">
  Retrieves a list of available time slots for scheduling within the cal system. this endpoint is used to check availability for booking events or meetings. it returns a collection of free time slots within the specified date range, considering existing bookings and configured availability. use this endpoint when you need to display available times to users for scheduling purposes or to check if specific time slots are free. the response will include the start and end times of each available slot, but won't provide details about existing bookings or blocked times.
</Accordion>

<Accordion title="Modify organization membership by id">
  Updates the details of a specific membership within an organization. this endpoint allows modification of a membership's acceptance status, role, and impersonation settings. it should be used when there's a need to change a member's status, promote or demote their role, or adjust their impersonation privileges. the endpoint requires the organization id and membership id to be specified in the url path. note that this operation may have significant implications for the member's access and capabilities within the organization, so it should be used cautiously and typically requires appropriate authorization.
</Accordion>

<Accordion title="Patch organization user details">
  Updates specific information for a user within a given organization. this endpoint allows for partial updates to user details, enabling administrators or authorized personnel to modify user attributes without replacing the entire user object. it should be used when changes to a user's information are required, such as updating contact details, changing roles, or modifying permissions. the endpoint accepts json input for flexible updates to various user properties. note that while the endpoint allows for updates, it does not provide information about which specific fields can be modified; refer to the api documentation for a complete list of updatable user properties.
</Accordion>

<Accordion title="Delete organization membership">
  Removes a user's membership from a specific organization within the cal system. this endpoint should be used when you need to terminate a user's association with an organization, such as when an employee leaves a company or a team member is removed from a project. the operation is irreversible, so it should be used with caution. once a membership is deleted, the user will lose all access and permissions associated with that organization. this endpoint does not provide any information about the deleted membership or confirm its previous existence; it simply performs the deletion if the provided identifiers are valid.
</Accordion>

<Accordion title="Post webhook event">
  Creates a new webhook subscription in cal.com to receive real-time notifications for specified events. this endpoint allows you to set up automated notifications for various booking-related activities, such as creations, reschedulings, cancellations, and more. use this to integrate cal.com events with your application, enabling real-time updates and automated workflows. the webhook can be customized with specific triggers and a payload template to fit your integration needs. it's essential for building responsive, event-driven applications that interact with cal.com's scheduling system.
</Accordion>

<Accordion title="Delete selected slot">
  Deletes a previously selected time slot from the cal scheduling system. this endpoint should be used when a user wants to remove a specific time slot they had previously marked as available for scheduling or evaluating other users. it's particularly useful for managing availability in dynamic scheduling environments where plans may change frequently. the operation is irreversible, so it should be used with caution. while the endpoint doesn't require any parameters in the url or body, it likely relies on authentication to identify the user whose selected slot is being deleted.
</Accordion>

<Accordion title="Delete user attribute option">
  Deletes a specific attribute option for a user within an organization. this endpoint is used to remove custom attribute options that are no longer needed or relevant for the user or organization. it should be used when you want to permanently remove an attribute option, such as a deprecated skill, role, or any other custom field associated with the user in the organizational context. the operation is irreversible, so it should be used with caution. this endpoint does not return the deleted data; it typically returns a success status upon completion.
</Accordion>

<Accordion title="Retrieve booking details by uid">
  Retrieves detailed information about a specific booking using its unique identifier (uid). this endpoint allows you to fetch comprehensive data about a single booking, including its status, associated event details, attendee information, and any custom fields. it's particularly useful when you need to access or verify the details of a specific booking, such as when updating a calendar, sending reminders, or managing event logistics. the endpoint returns the most up-to-date information about the booking, reflecting any changes or updates that may have occurred since it was created. note that this endpoint only provides information for existing bookings; it will return an error if the specified bookinguid does not exist or has been deleted.
</Accordion>

<Accordion title="Reassign booking to another user">
  This endpoint allows you to reassign a booking from one user to another within the cal scheduling system. it's used when a scheduled event needs to be transferred to a different host or team member. the endpoint requires the unique identifier of the booking to be reassigned and the user id of the new assignee. you can also provide a reason for the reassignment, which is useful for communication and record-keeping. this function is particularly helpful for managing team schedules, handling conflicts, or redistributing workload. note that this endpoint doesn't handle the logistics of informing participants about the change; that should be managed separately if required.
</Accordion>

<Accordion title="Reassign booking with uid">
  Reassigns a specific booking to another team member. this endpoint allows for the transfer of a booking from one team member to another, typically used when a team member becomes unavailable or to optimize scheduling. it should be used when there's a need to change the assignee of an existing booking without canceling or creating a new one. the endpoint requires the unique identifier of the booking to be reassigned. it's important to note that this operation may have implications on the availability of both the original and the new assignee, and may trigger notifications to relevant parties. the endpoint does not provide information about the new assignee or the reason for reassignment in the request, suggesting these details may need to be managed separately or through a different process.
</Accordion>

<Accordion title="Retrieve calendar busy times">
  Retrieves busy time slots for specified calendars within a given time range. this endpoint is used to check when calendars are occupied, helping users find available time slots for scheduling meetings or events. it returns a list of time ranges during which the queried calendars are busy. this tool is essential for implementing smart scheduling features, conflict detection, and optimizing meeting arrangements. it does not provide detailed event information or free time slots directly - only the busy periods. the response should be used in conjunction with desired meeting durations to determine suitable scheduling options.
</Accordion>

<Accordion title="Delete user schedule">
  Deletes a specific schedule for a user within an organization. this endpoint allows for the permanent removal of a schedule, which can be useful for cleaning up outdated or unwanted schedules. it should be used when a schedule is no longer needed or when reorganizing a user's calendar structure. the operation is irreversible, so caution should be exercised when invoking this endpoint. it does not return the deleted schedule data, only performs the deletion action.
</Accordion>

<Accordion title="Retrieve event type by id">
  Retrieves detailed information about a specific event type in the cal.com system using its unique identifier. this endpoint is useful when you need to access the complete set of properties and settings for a particular event type, such as its name, duration, availability, and any custom fields. it should be used when you have the event type id and require its full details, for instance, when editing an event type or displaying its information to users. the endpoint will not create, update, or delete event types; it is solely for fetching existing data. keep in mind that the response will only include information for the specified event type and not for any associated events or bookings.
</Accordion>

<Accordion title="Retrieve my information">
  Retrieves the profile information for the currently authenticated user. this endpoint provides access to the user's personal and account details, which may include name, email, preferences, and other relevant profile data. it should be used when the application needs to display or process the logged-in user's information. the endpoint does not accept any parameters, as it relies on the authentication context to identify the user. while it offers a comprehensive view of the user's profile, it does not provide information about the user's events, schedules, or team-related data, which may require separate api calls.
</Accordion>

<Accordion title="Retrieve membership from organization">
  Retrieves detailed information about a specific membership within an organization. this endpoint is used to fetch the current status, role, and other relevant details of a user's membership in a particular organization. it's particularly useful for checking a member's current standing, permissions, or any custom attributes associated with their membership. the endpoint should be used when you need to verify or review the specifics of an individual's association with an organization. it does not modify any data and is purely for information retrieval. note that this endpoint will not provide information about other members or the organization as a whole - it's focused solely on the specified membership.
</Accordion>

<Accordion title="Retrieve oauth client user by id">
  Retrieves detailed information about a specific user associated with a particular oauth client in the cal application. this endpoint is useful for oauth client applications that need to access or verify user data within their authorized scope. it should be used when an oauth client needs to fetch up-to-date information about a user, such as profile details, permissions, or custom attributes related to the client's integration. the endpoint provides a focused view of the user in the context of the oauth client and does not return information about the user's interactions with other oauth clients or general account details unrelated to the specified client.
</Accordion>

<Accordion title="Retrieve organization webhook by id">
  Retrieves detailed information about a specific webhook within an organization. this endpoint allows you to fetch the current configuration, status, and other relevant details of a webhook using its unique identifier. use this when you need to inspect or verify the settings of an existing webhook, such as its target url, triggered events, or active status. the endpoint is particularly useful for troubleshooting webhook-related issues or when you need to review webhook configurations without modifying them. note that this endpoint only provides information and does not modify the webhook in any way.
</Accordion>

<Accordion title="Retrieve oauth client webhook by id">
  Retrieves detailed information about a specific webhook associated with an oauth client in the cal application. this endpoint allows you to fetch the current configuration and status of a webhook, including its target url, subscribed events, and any other relevant metadata. use this when you need to verify a webhook's setup, troubleshoot webhook-related issues, or gather information for webhook management. it's particularly useful for developers integrating cal's event notifications into their applications. the endpoint does not modify any data and is safe for frequent calls, but remember it only provides information for a single webhook at a time.
</Accordion>

<Accordion title="Post selected calendars">
  The postselectedcalendars endpoint allows users to select or update calendars for integration within the cal application. this endpoint is used to associate a specific calendar from an external service with the user's cal account. it should be used when setting up new calendar integrations or modifying existing ones. the endpoint requires information about the integration type, an external identifier for the calendar, and the associated credential id for authentication. this ensures that cal can properly sync and manage events from the selected external calendar. note that this endpoint does not retrieve or modify calendar data directly; it only establishes the connection between cal and the external calendar service.
</Accordion>

<Accordion title="Retrieve calendar list">
  Retrieves a list of calendars associated with the authenticated user's account. this endpoint allows users to fetch all their available calendars, which can be useful for displaying calendar options, managing multiple calendars, or integrating calendar selection into other applications. it should be used when an overview of all calendars is needed, such as when initializing a calendar view or allowing users to choose which calendars to display or modify. the endpoint likely returns basic information about each calendar, such as its id, name, and possibly metadata like color or visibility settings. note that this endpoint may not provide detailed event information for each calendar; separate api calls might be required to fetch events for specific calendars.
</Accordion>

<Accordion title="Refresh oauth token for client id">
  Refreshes an oauth access token for a managed user in the cal application. this endpoint should be used when an existing access token has expired or is about to expire, allowing continued access to cal's api without requiring the user to re-authenticate. it takes a previously issued refresh token and returns a new access token. this process is crucial for maintaining uninterrupted access to cal's services for integrated applications. note that this endpoint is specifically for managed users within the cal ecosystem and should not be used for regular user authentication flows.
</Accordion>

<Accordion title="Retrieve provider details">
  Retrieves detailed information about a specific provider in the cal scheduling system using their unique client id. this endpoint should be used when you need to access a provider's profile, availability, or other related data for scheduling purposes. it's particularly useful for displaying provider information to users, verifying a provider's existence in the system, or fetching data to populate scheduling interfaces. the endpoint returns comprehensive details about the provider, which may include their name, specialties, available time slots, and any custom settings they've configured. note that this endpoint only retrieves information and does not modify any provider data. for real-time availability, you may need to use additional endpoints in conjunction with this one.
</Accordion>

<Accordion title="Retrieve schedules list">
  Retrieves a list of schedules from the cal.com api. this endpoint allows users to fetch all available schedules associated with their account or organization. it provides an overview of the scheduling options set up within the system, which can be useful for managing and reviewing existing schedules. the endpoint should be used when you need to display a comprehensive list of schedules, such as in a dashboard or when preparing to create or modify events. it's important to note that this endpoint likely returns basic schedule information and may not include detailed event data for each schedule. for more specific schedule details or to filter results, additional api calls or parameters may be required.
</Accordion>

<Accordion title="Retrieve organization attributes">
  Retrieves the attributes associated with a specific organization in the cal application. this endpoint allows you to fetch various characteristics, settings, or properties of an organization identified by its unique id. use this endpoint when you need to access detailed information about an organization's configuration or status within the cal system. the retrieved attributes may include organization-wide settings, preferences, or any other relevant metadata that cal maintains for organizations. this endpoint is particularly useful for applications that need to synchronize or display organization-specific information from cal.
</Accordion>

<Accordion title="Retrieve current team for organization">
  Retrieves information about the current user's team within a specified organization. this endpoint is used to fetch details related to the authenticated user's team membership and organizational context. it's particularly useful when you need to understand the user's role, permissions, or team structure within a specific organization. the endpoint returns data about the team(s) the user belongs to, which may include team names, ids, roles, and other relevant team-specific information. it should be used when building features that require team-aware functionality or when displaying team-related information in user interfaces. note that this endpoint only provides information for the authenticated user and does not allow querying team information for other users.
</Accordion>

<Accordion title="Retrieve team event types">
  Retrieves a list of event types associated with a specific team in the cal scheduling system. this endpoint is used to fetch all available event types that can be scheduled or managed within the context of the specified team. it's particularly useful for applications that need to display or process the various types of events a team can handle, such as different meeting durations, purposes, or configurations. the endpoint should be used when you need to present scheduling options to team members or integrate team-specific event types into a larger workflow. it does not create, modify, or delete event types, nor does it provide detailed information about individual events or team members' availability. the response likely includes basic information about each event type, such as its name, duration, and any custom fields, but the exact structure of the returned data is not specified in the given schema.
</Accordion>

<Accordion title="Reschedule booking by uid">
  Reschedules an existing booking in the cal system to a new date and time. this endpoint allows users to change the scheduled time of an appointment or event without canceling and recreating it. it should be used when a user needs to modify the timing of an existing booking due to changes in availability or preferences. the endpoint takes the unique identifier of the booking and likely expects new scheduling details in the request body (not specified in the given schema). it's important to note that this operation modifies an existing booking, so it should be used carefully to avoid conflicts with other scheduled events or availability constraints. the endpoint does not provide information about available time slots; it's assumed that the new schedule has been validated beforehand.
</Accordion>

<Accordion title="Post user to organization">
  This endpoint adds a new user to an organization within the cal scheduling system. it allows for the creation of a user profile with customizable settings including appearance preferences, time zone, locale, and organizational role. the endpoint is typically used when onboarding new team members to an organization's cal instance. it provides extensive customization options but requires only the user's email address as a mandatory field. other parameters allow for fine-tuning the user's experience within cal, from visual preferences to scheduling behaviors. note that while many fields are optional, setting them during user creation can streamline the onboarding process and ensure a consistent experience across the organization.
</Accordion>

<Accordion title="Retrieve team memberships for organization">
  Retrieves a list of memberships for a specific team within an organization. this endpoint allows you to fetch detailed information about all users who are members of the specified team, including their roles (e.g., member, maintainer) and membership states (e.g., active, pending). use this endpoint when you need to audit team composition, manage access control, or generate reports on team structure. it's particularly useful for organization administrators and team leads who need to oversee team membership. note that this endpoint only provides information about existing memberships and does not allow for modification of team composition.
</Accordion>

<Accordion title="Retrieve team memberships">
  Retrieves a list of memberships for a specific team in the cal scheduling application. this endpoint allows you to fetch detailed information about all members associated with a given team, including their roles and current status within the team. it's particularly useful for team managers or administrators who need to review the composition of their team, check member roles, or audit team access. the endpoint should be used when you need a comprehensive overview of a team's structure and membership status. note that this endpoint only provides membership information and does not allow for modifications to team composition or member roles.
</Accordion>

<Accordion title="Reserve slot for event">
  The reservetimeslot endpoint allows users to reserve a specific time slot for an event in the cal scheduling system. it is used to secure a desired time frame for a particular event type, ensuring that the slot is marked as unavailable for other potential bookings. this endpoint should be called when a user has selected an available time slot and wishes to temporarily hold it while completing the booking process. it's particularly useful in scenarios where there might be high demand for certain time slots, helping to prevent double-bookings. the reservation is made using utc timestamps, which ensures consistency across different time zones. for events with multiple seats, an optional booking uid can be provided to associate the reservation with a specific seat or participant.
</Accordion>

<Accordion title="Delete team from organization">
  Deletes a specific team from an organization. this endpoint permanently removes the team and all its associated data from the system. it should be used when a team is no longer needed or when restructuring the organization. caution should be exercised as this action is irreversible and will affect all team members and any projects or events associated with the team. the endpoint requires both the organization id and team id to ensure precise targeting of the team to be deleted, preventing accidental removals. it does not provide any information about the deleted team or its members after the operation.
</Accordion>

<Accordion title="Patch team details by id">
  Updates the details and settings of a specific team in the cal scheduling system. this endpoint allows modification of various team properties such as name, branding, time preferences, and visibility settings. it's used when team administrators need to change team information or adjust team-wide settings. the endpoint requires the team's unique identifier in the url path and accepts a json payload with the properties to be updated. not all properties need to be included in every request; only the provided fields will be updated. this endpoint is particularly useful for maintaining up-to-date team information and customizing the team's appearance and behavior within the cal platform.
</Accordion>

<Accordion title="Get conference oauth authorization url">
  Generates an oauth authorization url for a specified conferencing application. this endpoint is used to initiate the oauth flow, allowing cal.com to integrate with various conferencing platforms. the generated url should be used to redirect users to the conferencing app's authorization page, where they can grant cal.com permission to access their conferencing account. this is a crucial step in setting up seamless video conferencing integration within cal.com's scheduling system. the endpoint should be called when a user wants to connect a new conferencing app to their cal.com account or when refreshing existing integrations.
</Accordion>

<Accordion title="Retrieve team membership details">
  Retrieves detailed information about a specific membership within a team. this endpoint should be used when you need to access the current status, role, or other attributes of a particular team member. it provides a comprehensive view of the membership, including the member's information, their role in the team, and any other relevant details. this tool is particularly useful for team management, auditing team composition, or verifying a member's status. note that it only returns information for a single membership and does not provide a list of all team members.
</Accordion>

<Accordion title="Retrieve default conferencing settings">
  Retrieves the default conferencing settings for the cal.com application. this endpoint allows users to fetch the pre-configured conferencing options that are set as default for the account or organization. it can be used to understand the current conferencing setup without making any changes. the returned information likely includes details such as the preferred video conferencing platform, default meeting duration, and other relevant conferencing parameters. this endpoint is particularly useful when setting up new events or when you need to ensure consistency across multiple schedulers within an organization. it does not modify any settings and is safe to use for read-only operations.
</Accordion>

<Accordion title="Retrieve attribute options for org">
  Retrieves the available options for a specific attribute within an organization. this endpoint is used to fetch the list of possible values or configurations associated with a particular attribute. it's particularly useful when you need to populate dropdown menus, checkboxes, or other form elements with predefined options specific to an organization's attribute. the endpoint should be used when you need to display or update attribute options in your application's user interface or when processing organization-specific data that relies on these attribute values. it does not modify any data and is intended for read-only operations. keep in mind that the returned options are specific to the given organization and attribute, and may vary between different organizations or attributes.
</Accordion>

<Accordion title="Retrieve v2 conferencing info">
  Retrieves the conferencing details and capabilities for the authenticated user or organization within the cal application. this endpoint provides information about available video conferencing integrations, settings, and options that can be used for scheduling and managing virtual meetings. it should be used when setting up new events that require video conferencing or when checking the current conferencing configuration. the endpoint does not modify any settings; it only returns the existing configuration. note that the specific conferencing providers and features available may depend on the user's subscription level or organization settings.
</Accordion>

<Accordion title="Retrieve users in organization">
  Retrieves a list of users associated with a specific organization in the cal api system. this endpoint is used to obtain information about all users belonging to the organization identified by the provided orgid. it's particularly useful for organization administrators or integration systems that need to manage or review user memberships. the endpoint returns user details, which may include usernames, email addresses, roles, or other relevant information. it should be used when you need a comprehensive view of an organization's user base, such as for auditing purposes or user management tasks. note that this endpoint does not provide detailed scheduling information for individual users; it focuses solely on user membership within the organization.
</Accordion>

<Accordion title="Retrieve webhooks for event type">
  Retrieves all webhooks associated with a specific event type in the cal scheduling system. this endpoint allows users to fetch detailed information about the configured webhooks for a particular event type, such as team meetings or client consultations. it's useful for auditing webhook configurations, troubleshooting notification issues, or gathering information for reporting purposes. the endpoint returns a list of webhook objects, likely including details such as webhook urls, event subscriptions, and current status. it should be used when you need to review or manage the external integrations and notifications set up for a specific type of event in your cal instance.
</Accordion>

<Accordion title="Retrieve team details in organization">
  Retrieves a list of teams associated with a specific organization in the cal system. this endpoint should be used when you need to get an overview of all teams within an organization, such as for team management, resource allocation, or reporting purposes. it provides a comprehensive list of teams, which can be useful for administrators or managers who need to manage multiple teams within their organization. the endpoint does not provide detailed information about individual team members or their schedules; it focuses solely on team-level data. use this endpoint when you need to display or process team information in bulk for a given organization.
</Accordion>

<Accordion title="Retrieve webhook details for oauth client">
  Retrieves a list of webhooks associated with a specific oauth client in the cal scheduling system. this endpoint allows developers to get information about all webhook subscriptions for a particular oauth client, enabling them to manage and monitor event notifications. use this endpoint when you need to review, audit, or manage the webhook configurations for a given oauth client. it provides details such as the subscribed events, target urls, and current status of each webhook. this endpoint is particularly useful for applications that integrate with cal and need to maintain their webhook subscriptions.
</Accordion>

<Accordion title="Delete webhook by id">
  Deletes a specific webhook from the cal api system using its unique identifier. this endpoint should be used when you want to remove a previously configured webhook, stopping it from receiving further notifications or updates. it's particularly useful for cleaning up unused webhooks or updating your notification preferences. the operation is irreversible, so use it with caution. once deleted, you'll need to create a new webhook if you want to receive notifications again for the same events.
</Accordion>

<Accordion title="Save calendar ics feeds">
  Imports and saves ics (icalendar) feed urls into the cal calendar system. this endpoint allows users to add external calendar data to their cal account by providing one or more ics feed urls. it's particularly useful for syncing events from other calendar services or importing recurring events from external sources. the imported feeds can be set as read-only or writable, depending on whether you want to allow modifications to the imported events through the cal api. use this endpoint when you need to integrate external calendar data into your cal account or when setting up initial calendar synchronization for a user.
</Accordion>

<Accordion title="Save oauth credentials via gcal api">
  Saves the oauth credentials obtained from google calendar authorization process. this endpoint is crucial for completing the oauth flow and establishing a connection between cal and a user's google calendar. it should be called after successfully obtaining the authorization code from google's oauth server. the saved credentials allow cal to make authorized requests to the google calendar api on behalf of the user. this endpoint is typically used programmatically as part of the oauth implementation and not directly by end-users. note that while the schema doesn't specify parameters, the authorization code or tokens are likely passed through query parameters or headers.
</Accordion>

<Accordion title="Retrieve webhooks list">
  Retrieves a list of all configured webhooks for the authenticated user or application in the cal scheduling system. this endpoint allows users to view and manage their existing webhook subscriptions, which are used for real-time notifications about events such as new appointments, cancellations, or updates. it should be used when you need to audit your webhook configurations, check the status of existing webhooks, or gather information before modifying webhook settings. the response typically includes details such as webhook urls, associated events, and current status. note that this endpoint does not create new webhooks or modify existing ones; it is purely for retrieving information. the number of webhooks returned may be limited, and pagination might be required for accounts with a large number of webhook subscriptions.
</Accordion>

<Accordion title="Retrieve organization attributes options">
  Retrieves all attribute options for a specific user within an organization in cal.com. this endpoint is used to fetch the available options for managing attributes tailored to a particular user's context within the organizational structure. it's particularly useful when you need to populate user-specific attribute settings or display customized options in user interfaces. the endpoint should be called when initializing user-specific forms, updating user profiles, or when needing to make decisions based on a user's available attribute options within their organization. note that this endpoint only retrieves the options and does not modify any data.
</Accordion>

<Accordion title="Save stripe details">
  The v2 stripe save endpoint is designed to save or update stripe integration settings for a cal user's account. this get request initiates the process of storing stripe-related information, such as api keys or account details, in the cal system. it's primarily used when setting up or modifying stripe integration for payment processing within cal's scheduling platform. while the endpoint doesn't appear to accept parameters, it likely relies on authenticated user context to determine which account to update. note that using a get method for saving data is unconventional and may have specific implementation reasons or could potentially be a schema error. users should be cautious and refer to additional documentation for the exact behavior and any required headers or authentication methods.
</Accordion>

<Accordion title="Save calendar entry">
  Saves or updates the specified calendar in the cal api. this endpoint is used to persist changes made to a calendar's properties or settings. it should be called after making modifications to a calendar to ensure the changes are stored on the server. the endpoint uses an http get method, which is unusual for a save operation and may indicate that it's designed for simple updates or to trigger a save action on the server side. due to the lack of a request body, this endpoint may be limited in the amount of data it can update. it's best used for simple save operations or to trigger server-side saving of previously cached changes. this endpoint does not return the saved calendar data, so a separate get request may be needed to confirm the changes.
</Accordion>

<Accordion title="Retrieve team membership by id">
  Retrieves detailed information about a specific membership within a team in an organization. this endpoint is used to fetch individual member details, including their role, status, and other relevant information within the context of a particular team and organization. it's particularly useful for auditing team compositions, verifying member roles, or retrieving specific member data for administrative purposes. the endpoint follows a hierarchical structure, requiring identifiers for the organization, team, and specific membership to pinpoint the exact record. note that this endpoint only provides read access to membership information and cannot be used to modify or create new memberships.
</Accordion>

<Accordion title="Retrieve organization webhooks by orgid">
  Retrieves a list of webhooks configured for a specific organization in the cal.com api. this endpoint allows users to fetch details about all webhooks associated with the given organization, including their configured urls, event triggers, and current status. it should be used when you need to review or audit the webhook integrations for an organization, such as checking which external services are receiving notifications from cal.com. the endpoint provides a comprehensive view of webhook configurations but does not modify or create new webhooks. note that the response may be paginated for organizations with a large number of webhooks, and additional calls might be needed to retrieve the full list.
</Accordion>

<Accordion title="Set default conferencing app">
  Sets the default conferencing application for a specific app in the cal scheduling system. this endpoint allows users to define which conferencing tool (e.g., zoom, google meet, microsoft teams) should be used by default when creating new events or meetings for a particular application. it's useful for standardizing the conferencing experience across an organization or for individual users who prefer a specific platform. the endpoint should be used when configuring or updating the default conferencing settings for an app. it's important to note that this endpoint only sets the default and does not create or modify any existing meetings or events.
</Accordion>

<Accordion title="Get teams list">
  Retrieves a list of teams associated with the authenticated user's account in the cal.com application. this endpoint is used to fetch information about all teams the user is a part of, including team names, members, and potentially other relevant details such as team settings or permissions. it's particularly useful for applications that need to display a user's team affiliations or perform team-based operations. the endpoint does not accept any parameters, suggesting it returns a comprehensive list of teams without filtering. note that while it provides an overview of teams, it may not include detailed scheduling information or specific event data for each team.
</Accordion>

<Accordion title="Update destination calendar integration">
  Updates the destination calendars for cal integration with external calendar services. this endpoint allows you to specify which external calendar should be used for syncing events and managing scheduling. use this when you need to change or set up the primary calendar for integration with cal. the endpoint requires you to provide both the type of calendar service (integration) and the specific calendar identifier (externalid) within that service. this ensures that cal connects to the correct external calendar for seamless event management and synchronization. note that this endpoint only updates the destination calendar settings and does not perform the actual synchronization of events.
</Accordion>

<Accordion title="Patch webhook event type">
  This endpoint allows you to update an existing webhook associated with a specific event type in cal.com. it provides functionality to modify the webhook's payload template, activation status, subscriber url, trigger events, and secret key. use this endpoint when you need to change the configuration of an existing webhook, such as adjusting the events it responds to or updating the destination url for notifications. this tool is particularly useful for maintaining and fine-tuning your integration with cal.com's event management system. note that you must provide the eventtypeid and webhookid in the path to identify the specific webhook you want to update.
</Accordion>

<Accordion title="Post calendar credentials">
  This endpoint allows you to create or update credentials for a specific calendar in the cal system. it is used to establish or modify the authentication details required for cal to interact with external calendar services on behalf of the user. this operation is essential for integrating cal with various calendar providers, enabling features such as availability checks and event synchronization. use this endpoint when setting up a new calendar integration or when credentials need to be refreshed due to expiration or changes in the external service. note that the specific credential format and requirements may vary depending on the calendar service being integrated, and proper security measures should be implemented to protect sensitive credential information.
</Accordion>

<Accordion title="Delete webhook for event type">
  Deletes a specific webhook associated with an event type in the cal application. this endpoint should be used when you want to remove a webhook configuration, such as when you no longer need real-time notifications for a particular event type or when you're updating your integration settings. the operation is irreversible, so use it with caution. this endpoint only removes the webhook configuration and does not affect the event type itself or any other webhooks associated with other event types.
</Accordion>

<Accordion title="Update oauth client webhook">
  Updates an existing webhook configuration for a specific oauth client. this endpoint allows you to modify various aspects of a webhook, including its payload template, active status, subscriber url, trigger events, and secret key. use this when you need to change the behavior or settings of an already configured webhook, such as updating the events it responds to or modifying the payload structure. the endpoint is particularly useful for maintaining and adjusting webhook integrations as your application's needs evolve. note that this operation only updates the specified fields; any fields not included in the request will retain their current values.
</Accordion>

<Accordion title="Update schedule by id">
  Updates an existing schedule in the cal api, allowing for partial modifications to various schedule properties. this endpoint is used to change schedule details such as name, time zone, regular availability patterns, default status, and specific date overrides. it provides flexibility in managing recurring schedules while accommodating exceptions for special dates or events. the endpoint should be used when adjustments to an existing schedule are needed, rather than creating a new schedule from scratch. it's particularly useful for fine-tuning availability patterns, updating schedule metadata, or adding exceptions to regular schedules. note that this endpoint only updates the specified fields, leaving unmentioned properties unchanged.
</Accordion>

<Accordion title="Disconnect calendar using credential id">
  Disconnects a specific calendar from the cal service by deleting its associated credential. this endpoint should be used when a user wants to remove a calendar integration, such as when switching to a different calendar provider or revoking access to a previously connected calendar. the operation is irreversible, so it should be used with caution. it's important to note that this action only removes the connection between cal and the external calendar; it does not delete any events or data within the calendar itself. after disconnection, cal will no longer have access to read or modify events in the disconnected calendar.
</Accordion>

<Accordion title="Get team information by teamid">
  Retrieves detailed information about a specific team within the cal application. this endpoint allows you to fetch comprehensive data about a team, which may include team name, members, settings, and other relevant information. use this endpoint when you need to access or display team details in your application, or when you need to verify team information before performing team-related operations. the endpoint provides a snapshot of the team's current state and does not modify any team data. note that the specific fields returned in the response may vary based on the team's configuration and the user's permissions.
</Accordion>

<Accordion title="Post org attribute option by user">
  Creates a new attribute option for a specific user within an organization. this endpoint is part of the advanced configuration system for managing user attributes. it allows for the addition of custom attribute options, which can be used to extend the functionality of the cal scheduling system for specific organizational needs. use this endpoint when you need to add new options to existing attributes for a user, such as custom availability settings, specialized event types, or user-specific preferences. the endpoint requires the organization id, user id, and attribute id to ensure the new option is correctly associated with the right user and attribute within the organizational structure.
</Accordion>

<Accordion title="Get team details by org id and team id">
  Retrieves detailed information about a specific team within an organization. this endpoint allows you to fetch comprehensive data about a team, including its members, roles, and any associated metadata. it should be used when you need to access up-to-date information about a particular team's structure or composition within an organizational context. the endpoint is particularly useful for scenarios involving team management, resource allocation, or when integrating team data with other systems. it does not modify any team data and is intended for read-only operations. note that this endpoint only provides information for a single team at a time and does not support batch retrieval of multiple teams.
</Accordion>

<Accordion title="Get webhook by id">
  Retrieves detailed information about a specific webhook registered in the cal api. this endpoint allows you to fetch the configuration, status, and other relevant details of a webhook using its unique identifier. use this endpoint when you need to review or verify the settings of an existing webhook, such as its target url, subscribed events, or last triggered timestamp. it's particularly useful for troubleshooting webhook-related issues or auditing your webhook configurations. the endpoint returns comprehensive information about the webhook but does not modify any existing settings. note that this endpoint only provides details for webhooks that you have permission to access within your cal account.
</Accordion>

<Accordion title="Post new booking request">
  Creates a new booking in the cal scheduling system. this endpoint allows for the creation of standard, instant, or recurring bookings based on the provided parameters. it's designed to integrate seamlessly with various event types and accommodate different booking scenarios. use this endpoint when you need to programmatically schedule meetings or events, manage attendees, and customize booking details. the endpoint is versatile, handling single occurrences as well as recurring events, and supports additional features like custom metadata and booking field responses. note that some parameters are specific to certain booking types (e.g., 'instant' for team events, 'recurrencecount' for recurring bookings).
</Accordion>

<Accordion title="Get google calendar oauth authentication url">
  Generates the oauth 2.0 authorization url for google calendar integration with cal. this endpoint is used to initiate the authentication process, allowing users to grant cal permission to access their google calendar data. the returned url should be opened in a web browser, where users can log in to their google account and authorize the application. this is a critical first step in setting up the google calendar integration for cal, enabling features such as availability checks and event synchronization. note that this endpoint only provides the authorization url and does not complete the oauth flow; additional steps will be required to exchange the authorization code for access tokens.
</Accordion>

<Accordion title="List organization memberships">
  Retrieves a list of all memberships for a specific organization. this endpoint is used to get an overview of users associated with the organization, including their membership status (e.g., active, pending, invited). it's particularly useful for organization administrators to manage team members, review access levels, and track invitations. the endpoint returns details such as user information, roles, and membership dates. use this when you need to audit organization membership, prepare for user management tasks, or integrate member information into other systems. note that it does not modify any membership data and is read-only.
</Accordion>

<Accordion title="Post conferencing app connect">
  Initiates a connection to a specified conferencing application for virtual meeting setup. this endpoint is used to establish the necessary link between cal.com and the chosen conferencing platform, enabling seamless integration for scheduling and joining virtual meetings. it should be called when a user wants to set up or join a conference call through cal.com's interface. the endpoint handles the initial handshake and authentication process with the specified conferencing app, but does not actually create or schedule the meeting itself. note that the success of the connection depends on proper configuration and permissions for the specified app within cal.com's settings.
</Accordion>

<Accordion title="Get event type by team id">
  Retrieves detailed information about a specific event type within a team's context in the cal scheduling system. this endpoint is used to fetch the configuration, settings, and other relevant details of an event type associated with a particular team. it's particularly useful when you need to review or display the properties of an event type, such as its name, duration, availability, or any custom fields. this endpoint should be used when integrating team-specific event types into other applications or when building team management interfaces within cal. note that this endpoint only provides read access to the event type data and cannot be used to modify the event type. for any changes, a separate update endpoint would be required.
</Accordion>

<Accordion title="Fetch event type details">
  Retrieves detailed information about a specific event type within a team and organization. this endpoint is used to fetch the configuration, settings, and other relevant details of a particular event type. it's particularly useful when you need to review or display the characteristics of an event type, such as its duration, availability, or custom fields. the endpoint requires the organization id, team id, and event type id to pinpoint the exact event type. it should be used when detailed information about a specific event type is needed, rather than for listing multiple event types or creating new ones. note that this endpoint only provides read access to the event type data and cannot be used to modify the event type.
</Accordion>

<Accordion title="Fetch all bookings">
  Retrieves a list of bookings from the cal scheduling system. this endpoint allows you to fetch booking information, which may include details such as appointment times, attendee information, and booking status. it supports pagination and filtering options to manage large datasets and narrow down results based on specific criteria such as date range and booking status. use this endpoint when you need to access and display booking data, generate reports, or synchronize reservation information with other systems. the endpoint does not create, modify, or delete bookings; it is designed for read-only operations on existing booking data.
</Accordion>

<Accordion title="List team event types by org and team id">
  Retrieves a list of event types associated with a specific team within an organization. this endpoint is used to fetch all available scheduling options (event types) that have been set up for a particular team, allowing for efficient management of team-specific scheduling capabilities. it's particularly useful when you need to review or display the various types of meetings or appointments a team can schedule. the response likely includes details such as event type names, durations, and any custom fields associated with each event type. this endpoint should be used when you need to present scheduling options to team members or integrate team-specific scheduling capabilities into other applications.
</Accordion>

<Accordion title="Fetch schedule by id">
  Retrieves detailed information about a specific schedule using its unique identifier. this endpoint allows users to access comprehensive data about a particular schedule, including event details, time slots, and any associated metadata. it's particularly useful when you need to view or update an existing schedule, or when integrating schedule information into other applications. the endpoint returns the most up-to-date information for the specified schedule, making it ideal for real-time schedule management and synchronization across different platforms or services. note that this endpoint only provides read access to the schedule data and does not allow modifications to the schedule itself.
</Accordion>

<Accordion title="List event types">
  Retrieves a list of all available event types in the cal scheduling system. this endpoint provides comprehensive details about each event type, including display names, severity levels, and short descriptions. it's particularly useful for applications that need to present cal's event options to users or integrate cal's event types into their own interfaces. the endpoint supports pagination for efficient handling of large numbers of event types and allows filtering by slug for more targeted queries. use this endpoint when you need to display or manage the full range of scheduling options available in your cal integration. note that this endpoint does not create or modify event types; it's purely for retrieval and listing purposes.
</Accordion>

<Accordion title="Get Organization ID">
  Get the organization id of the user.
</Accordion>

<Accordion title="Fetch user schedule by org id">
  Retrieves a specific user's schedule within an organization. this endpoint allows you to fetch detailed information about a user's schedule, including events, availability, and time slots. it is particularly useful for viewing and managing individual user schedules in an organizational context. use this endpoint when you need to access or display a user's schedule, check their availability, or integrate their calendar information into other systems. the endpoint requires specific identifiers for the organization, user, and schedule to ensure accurate retrieval of the desired schedule information.
</Accordion>

<Accordion title="Fetch organization attribute by id">
  Retrieves a specific attribute associated with an organization in the cal application. this endpoint allows you to fetch detailed information about a single attribute of an organization, providing granular access to organization data. use this when you need to access a particular piece of information about an organization without retrieving all of its data. the endpoint requires both the organization id and the specific attribute id to pinpoint the exact information needed. it's particularly useful for applications that need to frequently check or update specific organization attributes without the overhead of fetching or processing complete organization profiles.
</Accordion>

<Accordion title="Get oauth clients user">
  Retrieves a list of users associated with a specified oauth client. this endpoint is useful for administrators or system integrators who need to manage user access or permissions for a particular oauth client. it provides visibility into which users have authorized or are linked to the client application. the endpoint should be used when you need to audit user access, manage user permissions, or gather user information related to a specific oauth client. it's important to note that this endpoint only returns user information and does not modify any user or client settings. the response will likely include basic user details, but may not contain sensitive information or full user profiles.
</Accordion>

<Accordion title="Get organization teams event types">
  Retrieves a list of event types associated with teams in a specified organization. this endpoint allows you to fetch all the available event types that have been configured for teams within the organization identified by the provided orgid. use this endpoint when you need to display or manage the various event types that teams can use for scheduling within your organization. the response will likely include details such as event type names, durations, and any custom fields or settings associated with each event type. this information is crucial for understanding the different scheduling options available to teams and can be used to populate user interfaces or to make decisions about scheduling workflows. note that this endpoint only provides information about event types and does not allow for creation, modification, or deletion of event types. for those operations, you would need to use separate endpoints specifically designed for those purposes.
</Accordion>

<Accordion title="Get organization schedules">
  Retrieves all schedules associated with a specific organization in the cal scheduling system. this endpoint allows users to fetch a comprehensive list of schedules, including events, appointments, and other time-based entries, for a given organization. it's particularly useful for applications that need to display or manage multiple schedules within an organizational context. the endpoint should be used when there's a need to get an overview of all scheduling activities for an organization, such as for reporting, synchronization with other systems, or displaying a master calendar. it does not provide detailed information about individual events; for that, you would need to use a separate endpoint specific to event details. the response likely includes basic information about each schedule, such as ids, names, and possibly summary statistics, but the exact structure of the returned data is not specified in the provided schema.
</Accordion>

<Accordion title="Get organization user schedules">
  Retrieves the schedules for a specific user within an organization. this endpoint allows you to fetch all schedule information associated with a particular user, including their availability, booked events, and any recurring patterns. it's useful for applications that need to display or analyze a user's calendar data, such as for team coordination or resource planning. the endpoint should be used when you need up-to-date schedule information for a known user within a specific organization. it does not provide the ability to modify schedules or create new events. note that the response may be paginated for users with extensive schedule data, and you may need to handle pagination to retrieve the complete schedule.
</Accordion>

<Accordion title="Fetch provider access token">
  Retrieves an access token for a specific client from the cal api provider. this endpoint is used as part of the authentication process to obtain a token that can be used for subsequent api calls. the access token serves as a credential to authenticate and authorize the client's requests to protected resources within the cal api. this endpoint should be called when a client application needs to initiate or refresh its authentication session. it's important to note that this endpoint does not provide any scheduling or event management functionality directly; it's solely for obtaining the necessary credentials for api access. the retrieved access token should be securely stored and used in the authorization header for other cal api endpoints.
</Accordion>

<Accordion title="Get default schedule details">
  Retrieves the default schedule configuration from the cal api. this endpoint is used to fetch the pre-configured default schedule settings, which can serve as a starting point or fallback for creating new schedules or managing existing ones. it provides essential information about the standard scheduling setup without requiring any additional parameters. use this endpoint when you need to access or review the base scheduling configuration for your cal integration. note that this endpoint only returns the default schedule and does not provide information about custom or user-specific schedules. the returned data can be used to understand the system's default behavior and as a reference for creating or modifying other schedules.
</Accordion>

<Accordion title="Handle conferencing oauth callback for app">
  Handles the oauth callback for conferencing applications integrated with cal. this endpoint is called by the conferencing service provider after a user has granted authorization to integrate the conferencing app with cal. it completes the oauth flow by exchanging the authorization code for an access token, which cal then uses to interact with the conferencing api on behalf of the user. this endpoint should be used as the redirect uri when setting up the oauth integration with the conferencing service provider. it's important to note that this endpoint is part of the authentication process and should not be called directly by client applications. the response from this endpoint typically redirects the user back to the cal application with the authentication result.
</Accordion>

<Accordion title="Fetch webhook by eventtypeid">
  Retrieves detailed information about a specific webhook associated with a particular event type in the cal scheduling system. this endpoint allows users to fetch the configuration and status of a webhook, which is crucial for managing integrations and ensuring proper event notifications. it should be used when you need to review or troubleshoot a specific webhook setup for an event type. the endpoint provides information such as the webhook's target url, subscribed events, and current status, but does not modify the webhook configuration. note that this endpoint retrieves data for a single webhook and cannot be used to list multiple webhooks or modify webhook settings.
</Accordion>

<Accordion title="Update oauth client user settings">
  Updates a user's profile and scheduling preferences in the cal.com system. this endpoint allows modification of various user attributes, including personal information (email, name, avatar), time preferences (time format, time zone, week start day), and system settings (default schedule, locale). it's designed for customizing a user's experience within cal.com, ensuring that scheduling, display, and communication align with the user's preferences. this endpoint should be used when a user needs to change their profile information or adjust their scheduling settings. it's particularly useful after initial account creation or when a user's circumstances change (e.g., moving to a new time zone). note that while the schema doesn't explicitly mark any fields as required, typically the email and name fields are essential for user identification.
</Accordion>

<Accordion title="Force refresh user oauth client">
  Force refreshes oauth tokens for a specific client and user. this endpoint is used to manually trigger a refresh of access and refresh tokens without waiting for the normal expiration process. it's particularly useful when tokens have become invalid or when immediate access with fresh tokens is required. the operation is performed on the server-side and returns new oauth tokens. use this endpoint cautiously and only when necessary, as frequent force refreshes may be rate-limited or flagged as suspicious activity.
</Accordion>

<Accordion title="Update webhook by id">
  The updatewebhook endpoint allows you to modify an existing webhook configuration in cal.com. it enables you to update various aspects of a webhook, including its payload template, active status, subscriber url, event triggers, and secret key. this endpoint is useful when you need to change the behavior or destination of an existing webhook without creating a new one. it's particularly helpful for adjusting notification preferences, updating the payload format, or modifying the events that trigger the webhook. note that this endpoint updates only the fields you provide; any fields not included in the request will retain their current values.
</Accordion>

<Accordion title="Update webhook for organization">
  The updatewebhook endpoint allows you to modify an existing webhook configuration for a specific organization in cal.com. this endpoint is used to update various aspects of a webhook, including its payload template, active status, subscriber url, trigger events, and secret. it's particularly useful when you need to change the behavior or destination of webhook notifications without creating a new webhook. use this endpoint when you want to adjust how and when your application receives real-time updates about events in cal.com, such as bookings, meetings, or form submissions. note that updating a webhook does not affect any historical data or previously sent notifications; it only changes how future notifications will be handled.
</Accordion>

<Accordion title="Update team membership properties">
  Updates specific attributes of a team membership within an organization. this endpoint allows for modifying the acceptance status, role, and impersonation settings of a team member. it's used to manage team dynamics, adjust member permissions, and control access levels within the organization. the endpoint supports partial updates, meaning you can modify one or more properties without affecting others. use this when you need to change a member's role, confirm their acceptance of an invitation, or adjust their impersonation privileges. note that this endpoint doesn't add or remove members from a team; it only modifies existing memberships.
</Accordion>

<Accordion title="Update user profile details">
  Updates the user preferences and profile information for the authenticated user in the cal scheduling api. this endpoint allows for partial updates, meaning you can provide only the fields you want to change without affecting other settings. use this endpoint to customize the user experience, including time format, week start day, language preferences, and profile details. the endpoint accepts various parameters to tailor the cal application to the user's needs, such as email, name, time format (12 or 24-hour), default schedule, preferred week start day, time zone, locale, and avatar url. this flexibility enables a personalized scheduling experience across different cultural and personal preferences. it's important to note that all parameters are optional, allowing for granular updates to specific preferences without modifying others. when using this endpoint, ensure that the provided values adhere to the specified formats and constraints for each parameter to avoid errors.
</Accordion>

<Accordion title="Update team information by id">
  The updateteam endpoint allows you to modify various properties of an existing team within an organization in the cal application. this patch operation enables partial updates, meaning you can change specific team attributes without needing to provide all team information. use this endpoint when you need to update team details such as name, visual branding elements, privacy settings, time-related preferences, or booking configurations. it's particularly useful for keeping team information current, adjusting team visibility, or modifying scheduling parameters. the endpoint accepts a json payload with the properties to be updated, offering flexibility in managing team characteristics. note that while most fields are optional, allowing for targeted updates, any provided field will overwrite the existing value for that property. be cautious when updating critical fields like 'slug' or 'timezone' as they may affect team accessibility and scheduling functionality.
</Accordion>

<Accordion title="Update user schedule in organization">
  Updates a specific user's schedule within an organization. this endpoint allows for modifying various aspects of a schedule, including its name, time zone, regular availability, and date-specific overrides. it's particularly useful for adjusting a user's availability patterns, setting up recurring schedules, and managing exceptions for specific dates. the endpoint should be used when there's a need to change an existing schedule, such as updating office hours, adjusting for seasonal changes, or accommodating temporary schedule modifications. it's important to note that this is a patch operation, meaning it will only update the fields provided in the request body, leaving other existing schedule details unchanged. the endpoint requires careful consideration of time zones and date formats to ensure accurate scheduling across different regions.
</Accordion>

<Accordion title="Update team membership by id">
  Updates the properties of a specific team membership in cal. this endpoint allows for modifying a team member's acceptance status, role, and impersonation settings. it's used when you need to change a member's status within a team, adjust their permissions, or update security settings. the endpoint provides flexibility in managing team dynamics and member access levels. note that this is a partial update, so only the fields you specify will be modified.
</Accordion>


# Calendly
Source: https://docs.push.ai/integrations/calendly



Calendly is an appointment scheduling tool that automates meeting invitations, availability checks, and reminders, helping individuals and teams avoid email back-and-forth

<Accordion title="Cancel event">
  Cancels specified event.
</Accordion>

<Accordion title="Get organization membership">
  Returns information about a user's organization membership
</Accordion>

<Accordion title="Get current user">
  Returns basic information about your user account.
</Accordion>

<Accordion title="List event type hosts">
  Fetch list of event type hosts
</Accordion>

<Accordion title="Get routing form">
  Get a specified routing form.
</Accordion>

<Accordion title="List event type available times">
  Returns a list of available times for an event type within a specified date range. date range can be no greater than 1 week (7 days). **note:** \* this endpoint does not support traditional keyset pagination.
</Accordion>

<Accordion title="Get user">
  Returns information about a specified user.
</Accordion>

<Accordion title="List group relationships">
  Returns a list of group relationships - a given owner can have one membership record, but multiple admin records
</Accordion>

<Accordion title="List organization memberships">
  The endpoint lists organization memberships for users and all users in an organization, and retrieves the organization uri, using `user` and `organization` options.
</Accordion>

<Accordion title="List groups">
  Returns a list of groups.
</Accordion>

<Accordion title="Get user availability schedule">
  This will return the availability schedule of the given uuid.
</Accordion>

<Accordion title="List organization invitations">
  Returns a list of organization invitations that were sent to the organization's members.
</Accordion>

<Accordion title="Get event">
  Returns information about a specified event.
</Accordion>

<Accordion title="Remove user from organization">
  Removes a user from an organization. notes: \* to remove users, the caller must have admin rights for the organization \* an organization owner can’t be removed
</Accordion>

<Accordion title="Invite user to organization">
  Invites a user to an organization.
</Accordion>

<Accordion title="Get webhook subscription">
  Get a specified webhook subscription.
</Accordion>

<Accordion title="Revoke user s organization invitation">
  Use this to revoke an organization invitation to an organization. once revoked, the invitation link that was sent to the invitee is no longer valid.
</Accordion>

<Accordion title="List activity log entries">
  \<!-- theme: info --> > this endpoint requires an \<strong>enterprise\</strong> subscription. returns a list of activity log entries
</Accordion>

<Accordion title="List events">
  The api returns event lists, filtered by 'organization', 'user', or 'group'. admin privileges are needed for organization/group filters. admins can also view events of a specific user or group within their org. users can view their personal events.
</Accordion>

<Accordion title="Create invitee no show">
  Marks an invitee as a no show.
</Accordion>

<Accordion title="List outgoing communications">
  \<!-- theme: info --> > this endpoint requires an \<strong>enterprise\</strong> subscription. returns a list of outgoing sms communications.
</Accordion>

<Accordion title="List event invitees">
  Returns a list of invitees for an event.
</Accordion>

<Accordion title="Create one off event type">
  Creates one-off event type
</Accordion>

<Accordion title="Get event invitee">
  Returns information about a specified invitee (person invited to an event).
</Accordion>

<Accordion title="Get event type">
  Returns information about a specified event type.
</Accordion>

<Accordion title="List user busy times">
  Fetches a week-max list of user events, both internal and external (if conflict check set), in ascending order without keyset pagination support.
</Accordion>

<Accordion title="Create share">
  Calendly's "customize once and share" feature lets you tailor one-on-one events for each invitee without creating a new event type. unspecified parameters default to the original event settings.
</Accordion>

<Accordion title="List routing forms">
  Get a list of routing forms for a specified organization.
</Accordion>

<Accordion title="Get group">
  Returns information about a specified group.
</Accordion>

<Accordion title="List user availability schedules">
  Returns the availability schedules of the given user.
</Accordion>

<Accordion title="Get group relationship">
  Returns a group relationship by uuid
</Accordion>

<Accordion title="Create single use scheduling link">
  Creates a single-use scheduling link.
</Accordion>

<Accordion title="Get invitee no show">
  Returns information about a specified invitee no show.
</Accordion>

<Accordion title="Get organization invitation">
  Returns an organization invitation that was sent to the organization's members.
</Accordion>

<Accordion title="Delete invitee no show">
  Undoes marking an invitee as a no show.
</Accordion>

<Accordion title="Delete invitee data">
  Use this endpoint with an enterprise subscription to request the removal of invitee data from past organization events. deletion may take up to a week.
</Accordion>

<Accordion title="Create webhook subscription">
  Webhook subscriptions can be created for organizations, users, or groups. organizational ones cover all events; user/group ones are entity-specific. some events support several scopes, so create subscriptions accordingly.
</Accordion>

<Accordion title="List user s event types">
  This endpoint retrieves all event types linked to a particular user within an organization, requiring either `organization` or `user` as mandatory query parameters.
</Accordion>

<Accordion title="Delete scheduled event data">
  Enterprise subscription holders can use this endpoint to request deletion of scheduled events data within a past 24-month range; process may take up to 7 days.
</Accordion>

<Accordion title="Delete webhook subscription">
  Delete a webhook subscription.
</Accordion>

<Accordion title="List webhook subscriptions">
  Get a list of webhook subscriptions for a specified organization or user.
</Accordion>


# Canva
Source: https://docs.push.ai/integrations/canva



Canva offers a drag-and-drop design suite for creating social media graphics, presentations, and marketing materials with prebuilt templates and a vast element library

<Accordion title="Access user specific brand templates list">
  This year, brand template ids will change; integrations storing them must update within 6 months. also, api use requires canva enterprise membership.
</Accordion>

<Accordion title="Create canva design with optional asset">
  Create a new canva design using a preset or custom dimensions, and add an asset with `asset id` from a user's project using relevant apis.
</Accordion>

<Accordion title="Create comment reply in design">
  This preview api allows replying to comments within a design on canva, with a limit of 100 replies per comment. users should note potential unannounced changes, and that preview apis are not eligible for public integrations.
</Accordion>

<Accordion title="Create design comment in preview api">
  This api is in preview and may change without notice; integrations using it won't pass review. it allows creating comments on a design, with a limit of 1000 comments per design.
</Accordion>

<Accordion title="Create user or sub folder">
  This api creates a folder in a canva user's projects at the top level or within another folder, returning the new folder's id and additional details upon success.
</Accordion>

<Accordion title="Delete asset by id">
  You can delete an asset by specifying its `assetid`. this operation mirrors the behavior in the canva ui. deleting an item moves it to the trash. deleting an asset doesn't remove it from designs that already use it.
</Accordion>

<Accordion title="Exchange oauth 2 0 access or refresh token">
  The oauth 2.0 endpoint issues time-limited (4-hour) access tokens of up to 4kb for user authorization via codes or refresh tokens. it requires client id/secret for authentication.
</Accordion>

<Accordion title="Fetch asset upload job status">
  Summarize asset upload outcome by repeatedly calling the endpoint until a 'success' or 'failed' status is received after using the create asset upload job api.
</Accordion>

<Accordion title="Fetch design metadata and access information">
  Gets the metadata for a design. this includes owner information, urls for editing and viewing, and thumbnail information.
</Accordion>

<Accordion title="Fetch canva connect signing public keys">
  The api for verifying canva webhooks, 'connect/keys,' is in preview, meaning unstable, not for public integrations, and provides a rotating jwk for signature verification to prevent replay attacks. cache keys for efficiency.
</Accordion>

<Accordion title="Fetch current user details">
  Returns the user id, team id, and display name of the user account associated with the provided access token.
</Accordion>

<Accordion title="Get design export job result">
  Get the outcome of a canva design export job; if done, receive download links for the design’s pages. for details, visit the create design export job api documentation.
</Accordion>

<Accordion title="Initiates canva design export job">
  Canva's new job feature exports designs in multiple formats using a design id, with provided download links. the export status can be tracked via an api. exports with 'pro' quality may fail if the design contains unpaid premium elements.
</Accordion>

<Accordion title="Initiate canva design autofill job">
  Upcoming brand template id updates require migration within 6 months. canva enterprise users can auto-fill designs using various data types, including experimental chart data. monitor jobs with specific api.
</Accordion>

<Accordion title="Retrieve design autofill job status">
  Api users with canva enterprise membership can retrieve design autofill job results, potentially requiring multiple requests until a `success` or `failed` status is received.
</Accordion>

<Accordion title="Retrieve folder details by id">
  Gets the name and other details of a folder using a folder's `folderid`.
</Accordion>

<Accordion title="Retrieve asset metadata by id">
  You can retrieve the metadata of an asset by specifying its `assetid`.
</Accordion>

<Accordion title="List folder items by type with sorting">
  Lists the items in a folder, including each item's `type`. folders can contain: - other folders. - designs, such as instagram posts, presentations, and documents ([canva docs](https://www.canva.com/create/documents/)). - image assets.
</Accordion>

<Accordion title="Remove folder and move contents to trash">
  Deletes a folder by moving the user's content to trash and reassigning other users' content to their top-level projects.
</Accordion>

<Accordion title="Canva Retrieve User Profile Data">
  Currently, this returns the display name of the user account associated with the provided access token. more user information is expected to be included in the future.
</Accordion>

<Accordion title="Retrieve brand template dataset definition">
  Canva's brand template ids will change later this year, including a 6-month integration migration. api access requires enterprise membership, providing autofill for images, text, and charts, although chart data could change during preview.
</Accordion>

<Accordion title="Revoke oauth tokens">
  Revoke a refresh token to end its lineage and user consent, requiring re-authentication. authenticate using either basic access with base64-encoded credentials or body parameters with client id and secret.
</Accordion>

<Accordion title="Retrieve canva enterprise brand template metadata">
  Upcoming update will change brand template ids; integrations must migrate within 6 months. api use requires canva enterprise membership.
</Accordion>

<Accordion title="Retrieve a specific design comment">
  This preview api is subject to unannounced changes and can't be used in public integrations. it retrieves a comment, details of which are on canva help center.
</Accordion>

<Accordion title="List canva user design metadata with filters and sorting">
  Provides a summary of canva user designs, includes search filtering, and allows showing both self-created and shared designs with sorting options.
</Accordion>

<Accordion title="Move item to specified folder">
  Transfers an item to a different folder by specifying both the destination folder's id and the item's id. if the item is in various folders, an error occurs; manual relocation via canva ui is required.
</Accordion>

<Accordion title="Retrieve design import job status">
  Gets the status and results of design import jobs created using the [create design import job api](https://www.canva.dev/docs/connect/api-reference/design-imports/create-design-import-job/).
</Accordion>

<Accordion title="Retrieve app public key set">
  Returns the json web key set (public keys) of an app. these keys are used to verify jwts sent to app backends.
</Accordion>

<Accordion title="List design pages with pagination">
  Preview api for canva: subject to unannounced changes and not for public integrations. lists metadata for design pages with optional `offset` and `limit`; not applicable to all design types.
</Accordion>

<Accordion title="Update folder details by id">
  Updates a folder's details using its `folderid`. currently, you can only update a folder's name.
</Accordion>

<Accordion title="Update asset s name and tags by id">
  You can update the name and tags of an asset by specifying its `assetid`. updating the tags replaces all existing tags of the asset.
</Accordion>

<Accordion title="Validate oauth token properties">
  Check an access token's validity and properties via introspection, requiring authentication. use basic access (base64 encoded `client id:client secret`) or body parameters for credentialing.
</Accordion>


# Canvas
Source: https://docs.push.ai/integrations/canvas



The Canvas API provides programmatic access to various learning
management features of the Canvas platform, including courses, users,
enrollments, grades, and more. It supports OAuth2 for secure
authentication and authorization.

<Accordion title="Create Account Notification">
  Creates a new global notification for an account in canvas.
</Accordion>

<Accordion title="Get Enrollment by ID">
  Get an enrollment object by enrollment id
</Accordion>

<Accordion title="List Available Reports">
  Lists available reports in canvas.
</Accordion>

<Accordion title="List Assignment Submissions">
  Lists assignment submissions in canvas.
</Accordion>

<Accordion title="Create Page for a Course">
  Creates a page for a course in canvas.
</Accordion>

<Accordion title="List Pages for a Course">
  Lists pages for a course in canvas.
</Accordion>

<Accordion title="List Courses for a User">
  Lists courses for a user in canvas. returns a paginated list of active courses for this user. to view the course list for a user other than yourself, you must be either an observer of that user or an administrator.
</Accordion>

<Accordion title="Create Appointment Group">
  Creates an appointment group in canvas.
</Accordion>

<Accordion title="Get User Course Progress">
  Returns progress information for a specific user in a course. the user can query their own progress using 'self' as the user id. to query another user's progress, the requester must be a teacher, administrator, or linked observer.
</Accordion>

<Accordion title="Export Content">
  Exports content in a course in canvas.
</Accordion>

<Accordion title="List Sent Content Shares">
  Lists sent content shares in canvas.
</Accordion>

<Accordion title="Retrieve Enrollment Term">
  Retrieves an enrollment term in canvas. note: the specified account must be a root account, not a sub-account. for more details see: [https://canvas.instructure.com/doc/api/enrollment](https://canvas.instructure.com/doc/api/enrollment) terms.html
</Accordion>

<Accordion title="List Users in Account">
  Lists users in an account in canvas.
</Accordion>

<Accordion title="Start a Report">
  Starts a report in canvas.
</Accordion>

<Accordion title="Get Assignment">
  Gets an assignment in canvas.
</Accordion>

<Accordion title="Get All Assignments">
  Gets all assignments in a course in canvas.
</Accordion>

<Accordion title="List Quizzes in Course">
  Lists quizzes in a canvas course.
</Accordion>

<Accordion title="Update File Name">
  Updates the name of a file in canvas.
</Accordion>

<Accordion title="Translate File Reference">
  Translates a file reference for a course in canvas.
</Accordion>

<Accordion title="List Submissions">
  Lists submissions for a specific assignment, grader, and date in canvas.
</Accordion>

<Accordion title="Update Course Settings">
  Updates course settings in canvas.
</Accordion>

<Accordion title="Get User Participation Analytics">
  Returns page view hits grouped by hour and participation details for a student in a course. page views are returned as a hash with iso8601 dates as keys, bucketed by hour. participations are returned as an array of hashes, sorted oldest to newest.
</Accordion>

<Accordion title="List Calendar Events for a User">
  Lists calendar events for a user in canvas.
</Accordion>

<Accordion title="Get Course Activity">
  Gets activity analytics for a course in canvas.
</Accordion>

<Accordion title="Update Quiz Submission Scores">
  Updates student question scores and comments for a quiz submission.
</Accordion>

<Accordion title="Update Appointment Group">
  Updates an appointment group in canvas.
</Accordion>

<Accordion title="Create Assignment">
  Creates an assignment in canvas.
</Accordion>

<Accordion title="Create Assignment Override">
  Creates an assignment override in canvas.
</Accordion>

<Accordion title="Update Page for a Course">
  Updates a page for a course in canvas.
</Accordion>

<Accordion title="List Communication Channels">
  Lists communication channels for a user in canvas.
</Accordion>

<Accordion title="Upload Submission File">
  Uploads a file to a submission in canvas.
</Accordion>

<Accordion title="Update User Settings">
  Updates a user's settings in canvas.
</Accordion>

<Accordion title="Get User Profile">
  Gets a user's profile in canvas.
</Accordion>

<Accordion title="Upload Course File">
  Uploads a file to a canvas course.
</Accordion>

<Accordion title="Get Gradebook History Days">
  Returns a list of day objects containing dates and graders who worked on those dates. each day object contains a date and an array of graders who worked on that date.
</Accordion>

<Accordion title="Update Course">
  Update an existing course
</Accordion>

<Accordion title="List Communication Messages">
  Lists communication messages for a user in canvas.
</Accordion>

<Accordion title="Get Current User">
  Gets details of the current user in canvas.
</Accordion>

<Accordion title="Create Quiz">
  Creates a quiz in canvas.
</Accordion>

<Accordion title="Get Page for a Course">
  Gets a page for a course in canvas.
</Accordion>

<Accordion title="Create Calendar Event">
  Create and return a new calendar event
</Accordion>

<Accordion title="List Submissions from Multiple Assignments">
  Lists submissions for multiple assignments in canvas.
</Accordion>

<Accordion title="Get Completed Statistics">
  Gets completed statistics for an account in canvas.
</Accordion>

<Accordion title="Grade or Comment on Submission">
  Grades or comments on a submission in canvas.
</Accordion>

<Accordion title="Create Communication Channel">
  Creates a communication channel for a user in canvas.
</Accordion>

<Accordion title="List Content Exports">
  Lists content exports in a course in canvas.
</Accordion>

<Accordion title="Create Quiz Question">
  Creates a quiz question in canvas.
</Accordion>

<Accordion title="Create Content Share">
  Creates a content share in canvas. this action allows sharing content directly between two or more users. requires proper authentication and valid user ids.
</Accordion>

<Accordion title="List Uncollated Submission Versions">
  Lists uncollated submission versions for a specific course in canvas.
</Accordion>

<Accordion title="Delete Appointment Group">
  Deletes an appointment group in canvas.
</Accordion>

<Accordion title="Get Quiz Submissions">
  Gets all quiz submissions for a quiz in canvas.
</Accordion>

<Accordion title="List Accounts for Course Admins">
  Lists accounts for course admins in canvas.
</Accordion>

<Accordion title="List All Folders">
  Lists all folders in a canvas course, user, or group context.
</Accordion>

<Accordion title="Delete Assignment">
  Deletes an assignment in canvas.
</Accordion>

<Accordion title="Get Report Status">
  Gets the status of a report in canvas.
</Accordion>

<Accordion title="List Appointment Groups">
  Gets appointment groups in canvas.
</Accordion>

<Accordion title="Get Current Statistics">
  Gets current statistics for an account in canvas.
</Accordion>

<Accordion title="List Course Users">
  Returns the paginated list of users in a course, optionally including their enrollments.
</Accordion>

<Accordion title="Delete Quiz">
  Deletes a quiz in canvas.
</Accordion>

<Accordion title="List Folders">
  Lists all folders within the specified folder in canvas.
</Accordion>

<Accordion title="Create Conversation">
  Creates a conversation in canvas.
</Accordion>

<Accordion title="Get Single Submission">
  Gets a single submission in canvas.
</Accordion>

<Accordion title="Get a single Course">
  Gets a single course in canvas.
</Accordion>

<Accordion title="Delete Folder">
  Deletes a folder in canvas.
</Accordion>

<Accordion title="Get Current Grades">
  Gets current grades for an account in canvas.
</Accordion>

<Accordion title="Get User Assignment Analytics">
  Returns assignment analytics data for a specific student in a course. the data includes assignment details, grade statistics, and the student's submission information.
</Accordion>

<Accordion title="List Files">
  Lists files for a course in canvas.
</Accordion>

<Accordion title="Get Term Grades">
  Gets department level current data for term grades in canvas.
</Accordion>

<Accordion title="Get Completed Grades">
  Gets grade distribution data for completed courses in an account in canvas. this action returns a dictionary containing the distribution of grades for students in completed courses. each data point represents one student's final grade in one course. the response contains grade scores (0-100) as keys and the number of students achieving that grade as values. grades are binned to the nearest integer score. required permissions: - account level analytics access - view all grades permission
</Accordion>

<Accordion title="Get Term Statistics">
  Gets term statistics for an account in canvas.
</Accordion>

<Accordion title="List Courses">
  Lists all courses in canvas.
</Accordion>

<Accordion title="List Discussion Topics">
  Returns the paginated list of discussion topics for a course.
</Accordion>

<Accordion title="Create Enrollment">
  Creates an enrollment in canvas for a user in a course.
</Accordion>

<Accordion title="Create Module">
  Creates a module in canvas.
</Accordion>

<Accordion title="Edit Quiz">
  Edits a quiz in canvas.
</Accordion>

<Accordion title="Create Folder">
  Creates a folder in canvas within the specified context (course, user, group, folder, or account).
</Accordion>

<Accordion title="Edit Assignment">
  Edits an assignment in canvas.
</Accordion>

<Accordion title="Create Discussion Topic">
  Creates a new discussion topic for a course in canvas.
</Accordion>

<Accordion title="Create Course">
  Creates a new course in canvas.
</Accordion>


# Chatwork
Source: https://docs.push.ai/integrations/chatwork



Chatwork is a team communication platform featuring group chats, file sharing, and task management, aiming to enhance collaboration and productivity for businesses

<Accordion title="Get My Chatwork Status">
  This tool retrieves the current status of the authenticated user, including unread message counts and task status. it provides a quick overview of unread messages, mentions, and tasks, making it valuable for monitoring chatwork activity and building automation workflows.
</Accordion>

<Accordion title="Delete Message">
  This tool allows you to delete a specific message from a chatwork room by calling the delete endpoint at [https://api.chatwork.com/v2/rooms/\\\{room](https://api.chatwork.com/v2/rooms/\\\{room) id}/messages/\{message id}. it requires authentication using a chatwork api token provided in the x-chatworktoken header, and the necessary permissions to delete messages in the specified room.
</Accordion>

<Accordion title="Get Chatwork Rooms">
  This tool retrieves a list of all chat rooms associated with the authenticated chatwork account. it includes group chats, direct chats, and personal chats, and does not require any additional parameters beyond authentication.
</Accordion>

<Accordion title="Get Room Members">
  This tool retrieves a list of all members in a specified chatwork room using the endpoint get /rooms/\{room id}/members. it provides essential details like account id, role, name, chatwork id, organization id, and organization name, complementing the existing suite of room management tools.
</Accordion>

<Accordion title="Get Room Messages">
  This tool retrieves messages from a specific chatwork room using the get [https://api.chatwork.com/v2/rooms/\\\{room](https://api.chatwork.com/v2/rooms/\\\{room) id}/messages endpoint. it requires a room id parameter and an optional force flag to refresh the cache by retrieving the 100 newest messages.
</Accordion>

<Accordion title="Upload File to Chatwork Room">
  This tool allows users to upload files to a specific chatwork room. it enables file sharing functionality within the chatwork platform by providing an endpoint to upload files (along with an optional message) to a given room.
</Accordion>

<Accordion title="Get Chatwork File">
  This tool retrieves information about a specific file in a chat room. the api endpoint get /v2/rooms/\{room id}/files/\{file id} provides file details such as file id, account id, message id, filename, filesize, upload time, and download url, which are useful for retrieving file metadata, verifying file existence, and managing file sharing within chatwork.
</Accordion>

<Accordion title="Get Chatwork Contacts">
  This tool retrieves a list of all contacts from chatwork. it is a fundamental tool that fetches all contact information such as account id, room id, name, chatwork id, organization details, department, and avatar image url, without needing additional parameters beyond authentication.
</Accordion>


# Clickup
Source: https://docs.push.ai/integrations/clickup



ClickUp unifies tasks, docs, goals, and chat in a single platform, allowing teams to plan, organize, and collaborate across projects with customizable workflows

<Accordion title="Create webhook">
  Set up a webhook to monitor for events.

  we do not have a dedicated ip address for webhooks. we use our domain name and dynamic addressing.
</Accordion>

<Accordion title="Change tag names from time entries">
  Rename an time entry label.
</Accordion>

<Accordion title="Delete checklist item">
  Delete a line item from a task checklist.
</Accordion>

<Accordion title="Add guest to list">
  Share a list with a guest. ***note:** this endpoint is only available to workspaces on our [enterprise plan](https://clickup.com/pricing).*
</Accordion>

<Accordion title="Delete a time entry">
  Delete a time entry from a workspace.
</Accordion>

<Accordion title="Get authorized teams workspaces">
  View the workspaces available to the authenticated user.\<\<DEPRECATED use get\_authorized\_teams\_workspaces>>
</Accordion>

<Accordion title="Create folder view">
  Add a list, board, calendar, table, timeline, workload, activity, map, chat, or gantt view to a folder.
</Accordion>

<Accordion title="Add guest to task">
  Share a task with a guest. ***note:** this endpoint is only available to workspaces on our [enterprise plan](https://clickup.com/pricing).*
</Accordion>

<Accordion title="Create space view">
  Add a list, board, calendar, table, timeline, workload, activity, map, chat, or gantt view to a space.
</Accordion>

<Accordion title="Get authorized user">
  View the details of the authenticated user's clickup account.\<\<DEPRECATED use get\_authorized\_user>>
</Accordion>

<Accordion title="Delete comment">
  Delete a task comment.
</Accordion>

<Accordion title="Delete checklist">
  Delete a checklist from a task.
</Accordion>

<Accordion title="Create workspace everything level view">
  Add a list, board, calendar, table, timeline, workload, activity, map, chat, or gantt view at the everything level of a workspace.
</Accordion>

<Accordion title="Create task">
  Create a new task.
</Accordion>

<Accordion title="Delete folder">
  Delete a folder from your workspace.
</Accordion>

<Accordion title="Delete key result">
  Delete a target from a goal.
</Accordion>

<Accordion title="Delete list">
  Delete a list from your workspace.
</Accordion>

<Accordion title="Create goal">
  Add a new goal to a workspace.
</Accordion>

<Accordion title="Delete goal">
  Remove a goal from your workspace.
</Accordion>

<Accordion title="Create a time entry">
  Create a time entry. ***note:** a time entry that has a negative duration means that timer is currently running for that user.*
</Accordion>

<Accordion title="Create chat view comment">
  Add a new comment to a chat view.
</Accordion>

<Accordion title="Add tags from time entries">
  Add a label to a time entry.
</Accordion>

<Accordion title="Create task attachment">
  Upload a file to a task as an attachment. ***note:** this request uses multipart/form-data as the content type.*
</Accordion>

<Accordion title="Delete space">
  Delete a space from your workspace.
</Accordion>

<Accordion title="Delete space tag">
  Delete a task tag from a space.
</Accordion>

<Accordion title="Delete dependency">
  Remove the dependency relationship between two or more tasks.
</Accordion>

<Accordion title="Create task comment">
  Add a new comment to a task.
</Accordion>

<Accordion title="Delete task link">
  Remove the link between two tasks.
</Accordion>

<Accordion title="Delete task">
  Delete a task from your workspace.
</Accordion>

<Accordion title="Add tag to task">
  Add a tag to a task.
</Accordion>

<Accordion title="Delete team">
  This endpoint removes a user group from a workspace, per clickup documentation. `team id` is the workspace id, and `group id` is the user group id.
</Accordion>

<Accordion title="Create key result">
  Add a target to a goal.
</Accordion>

<Accordion title="Add dependency">
  Set a task as waiting on or blocking another task.
</Accordion>

<Accordion title="Create task from template">
  Create a new task using a task template.
</Accordion>

<Accordion title="Create checklist">
  Add a new checklist to a task.
</Accordion>

<Accordion title="Delete time tracked">
  ***note:** this is a legacy time tracking endpoint. we recommend using the time tracking api endpoints to manage time entries.*
</Accordion>

<Accordion title="Delete webhook">
  Delete a webhook to stop monitoring the events and locations of the webhook.
</Accordion>

<Accordion title="Delete view">
  Deletes a specific view by its id. requires 'view id' as a string parameter in the path. successful deletion returns 200 with an empty json object.
</Accordion>

<Accordion title="Add task link">
  Link two tasks together.
</Accordion>

<Accordion title="Edit checklist">
  Rename a task checklist, or reorder a checklist so it appears above or below other checklists on a task.
</Accordion>

<Accordion title="Edit key result">
  Update a target.
</Accordion>

<Accordion title="Create checklist item">
  Add a line item to a task checklist.
</Accordion>

<Accordion title="Add task to list">
  Add a task to an additional list. ***note:** this endpoint requires the [tasks in multiple list clickapp](https://help.clickup.com/hc/en-us/articles/6309958824727-tasks-in-multiple-lists) to be enabled.*
</Accordion>

<Accordion title="Add guest to folder">
  Share a folder with a guest. ***note:** this endpoint is only available to workspaces on our [enterprise plan](https://clickup.com/pricing).*
</Accordion>

<Accordion title="Create folder">
  Add a new folder to a space.\<\<DEPRECATED use create\_folder>>
</Accordion>

<Accordion title="Create task attachment">
  Upload a file to a task as an attachment. ***note:** this request uses multipart/form-data as the content type.*\<\<DEPRECATED use create\_task\_attachment>>
</Accordion>

<Accordion title="Get folder">
  View the lists within a folder.\<\<DEPRECATED use get\_folder>>
</Accordion>

<Accordion title="Edit checklist item">
  Update an individual line item in a task checklist. you can rename it, set the assignee, mark it as resolved, or nest it under another checklist item.
</Accordion>

<Accordion title="Create list">
  Add a new list to a folder.
</Accordion>

<Accordion title="Get access token">
  The text outlines api authentication via personal tokens and oauth flow, stating oauth tokens can't be used in "try it" feature or tested via web browsers.\<\<DEPRECATED use get\_access\_token>>
</Accordion>

<Accordion title="Get authorized user">
  View the details of the authenticated user's clickup account.
</Accordion>

<Accordion title="Create team">
  The endpoint allows creating teams within workspaces, assigning tasks, and managing ids for both. adding a view-only guest as a paid member may result in extra charges due to automatic seat addition.
</Accordion>

<Accordion title="Get chat view comments">
  View comments from a chat view. if you do not include the `start` and `start id` parameters, this endpoint will return the most recent 25 comments. use the `start` and `start id` parameters of the oldest comment to retrieve the next 25 comments.
</Accordion>

<Accordion title="Get accessible custom fields">
  View the custom fields available on tasks in a specific list.
</Accordion>

<Accordion title="Get authorized teams workspaces">
  View the workspaces available to the authenticated user.
</Accordion>

<Accordion title="Get folders">
  View the folders in a space.\<\<DEPRECATED use get\_folders>>
</Accordion>

<Accordion title="Get access token">
  The text outlines api authentication via personal tokens and oauth flow, stating oauth tokens can't be used in "try it" feature or tested via web browsers.
</Accordion>

<Accordion title="Get all tags from time entries">
  View all the labels that have been applied to time entries in a workspace.
</Accordion>

<Accordion title="Get bulk tasks time in status">
  View how long two or more tasks have been in each status.
</Accordion>

<Accordion title="Get custom task types">
  View the custom task types available in a workspace.
</Accordion>

<Accordion title="Edit user on workspace">
  Update a user's name and role. ***note:** this endpoint is only available to workspaces on our [enterprise plan](https://clickup.com/pricing).*
</Accordion>

<Accordion title="Create list comment">
  Add a comment to a list.
</Accordion>

<Accordion title="Get folder">
  View the lists within a folder.
</Accordion>

<Accordion title="Get folderless lists">
  View the lists in a space that aren't located in a folder.
</Accordion>

<Accordion title="Edit space tag">
  Update a task tag.
</Accordion>

<Accordion title="Get custom roles">
  View the custom roles available in a workspace.
</Accordion>

<Accordion title="Get filtered team tasks">
  View the tasks that meet specific criteria from a workspace. responses are limited to 100 tasks per page. you can only view task information of tasks you can access.
</Accordion>

<Accordion title="Edit time tracked">
  ***note:** this is a legacy time tracking endpoint. we recommend using the time tracking api endpoints to manage time entries.*
</Accordion>

<Accordion title="Create folderless list">
  Add a new list in a space.
</Accordion>

<Accordion title="Edit guest on workspace">
  Rename and configure options for a guest. ***note:** this endpoint is only available to workspaces on our [enterprise plan](https://clickup.com/pricing).*
</Accordion>

<Accordion title="Create space">
  Add a new space to a workspace.
</Accordion>

<Accordion title="Create list view">
  Add a list, board, calendar, table, timeline, workload, activity, map, chat, or gantt view to a list.
</Accordion>

<Accordion title="Create space tag">
  Add a new task tag to a space.
</Accordion>

<Accordion title="Create folder">
  Add a new folder to a space.
</Accordion>

<Accordion title="Get space tags">
  View the task tags available in a space.
</Accordion>

<Accordion title="Get task s time in status">
  View how long a task has been in each status. the total time in status clickapp must first be enabled by the workspace owner or an admin.
</Accordion>

<Accordion title="Get guest">
  View information about a guest. ***note:** this endpoint is only available to workspaces on our [enterprise plan](https://clickup.com/pricing).*
</Accordion>

<Accordion title="Get folders">
  View the folders in a space.
</Accordion>

<Accordion title="Get list members">
  View the people who have access to a list.
</Accordion>

<Accordion title="Get spaces">
  View the spaces avialable in a workspace. you can only get member info in private spaces.
</Accordion>

<Accordion title="Get folder views">
  View the task and page views available for a folder.
</Accordion>

<Accordion title="Get list views">
  View the task and page views available for a list.

  views and required views are separate responses.
</Accordion>

<Accordion title="Get goals">
  View the goals available in a workspace.
</Accordion>

<Accordion title="Get task templates">
  View the task templates available in a workspace.
</Accordion>

<Accordion title="Get space">
  View the spaces available in a workspace.
</Accordion>

<Accordion title="Get task">
  View information about a task. you can only view task information of tasks you can access. tasks with attachments will return an "attachments" response.
</Accordion>

<Accordion title="Get tasks">
  This api endpoint allows viewing up to 100 tasks per page, limited to tasks within the specified `list id` that have it as their home list. tasks from other home lists aren't included.
</Accordion>

<Accordion title="Get goal">
  View the details of a goal including its targets.
</Accordion>

<Accordion title="Get list">
  View information about a list.
</Accordion>

<Accordion title="Get task members">
  View the people who have access to a task.
</Accordion>

<Accordion title="Get running time entry">
  View a time entry that's currently tracking time for the authenticated user. ***note:** a time entry that has a negative duration means that timer is currently running for that user.*
</Accordion>

<Accordion title="Get workspace seats">
  View the used, total, and available member and guest seats for a workspace.
</Accordion>

<Accordion title="Get view">
  View information about a specific task or page view.
</Accordion>

<Accordion title="Get view tasks">
  See all visible tasks in a view in clickup.
</Accordion>

<Accordion title="Get singular time entry">
  View a single time entry. ***note:** a time entry that has a negative duration means that timer is currently running for that user.*
</Accordion>

<Accordion title="Get tracked time">
  ***note:** this is a legacy time tracking endpoint. we recommend using the time tracking api endpoints to manage time entries.*
</Accordion>

<Accordion title="Get task comments">
  View task comments. if you do not include the `start` and `start id` parameters, this endpoint will return the most recent 25 comments. use the `start` and `start id` parameters of the oldest comment to retrieve the next 25 comments.
</Accordion>

<Accordion title="Get time entry history">
  View a list of changes made to a time entry.
</Accordion>

<Accordion title="Remove custom field value">
  Remove the data from a custom field on a task. this does not delete the option from the custom field.
</Accordion>

<Accordion title="Remove guest from folder">
  Revoke a guest's access to a folder. ***note:** this endpoint is only available to workspaces on our [enterprise plan](https://clickup.com/pricing).*
</Accordion>

<Accordion title="Invite guest to workspace">
  To invite a guest to your workspace, use the "invite user to workspace" endpoint. then, use specific endpoints to grant access to folders, lists, or tasks. note: available only for enterprise plan.
</Accordion>

<Accordion title="Get list comments">
  To view comments on a list, omitting `start` and `start id` shows the latest 25 comments. for earlier ones, use the `start` and `start id` of the oldest comment to get the next 25.
</Accordion>

<Accordion title="Remove user from workspace">
  Deactivate a user from a workspace. ***note:** this endpoint is only available to workspaces on our [enterprise plan](https://clickup.com/pricing).*
</Accordion>

<Accordion title="Get space">
  View the spaces available in a workspace.\<\<DEPRECATED use get\_space>>
</Accordion>

<Accordion title="Get space views">
  View the task and page views available for a space.
</Accordion>

<Accordion title="Get lists">
  View the lists within a folder.
</Accordion>

<Accordion title="Remove task from list">
  This api endpoint allows for removing a task from an extra list, not its original list, requiring the tasks in multiple list clickapp to be enabled.
</Accordion>

<Accordion title="Get spaces">
  View the spaces avialable in a workspace. you can only get member info in private spaces.\<\<DEPRECATED use get\_spaces>>
</Accordion>

<Accordion title="Start a time entry">
  Start a timer for the authenticated user.
</Accordion>

<Accordion title="Invite user to workspace">
  Invite someone to your workspace as a member through a specific endpoint. note: guest invitations and this feature are exclusive to workspaces on the enterprise plan.
</Accordion>

<Accordion title="Get task">
  View information about a task. you can only view task information of tasks you can access. tasks with attachments will return an "attachments" response.\<\<DEPRECATED use get\_task>>
</Accordion>

<Accordion title="Get lists">
  View the lists within a folder.\<\<DEPRECATED use get\_lists>>
</Accordion>

<Accordion title="Get workspace plan">
  View the current [plan](https://clickup.com/pricing) for the specified workspace.\<\<DEPRECATED use get\_workspace\_plan>>
</Accordion>

<Accordion title="Stop a time entry">
  Stop a timer that's currently running for the authenticated user.
</Accordion>

<Accordion title="Set custom field value">
  To add data to a task's custom field, obtain the `task id` and the custom field's `field id` (uuid). use the "get accessible custom fields" or "get task" api endpoints to find the `field id`.
</Accordion>

<Accordion title="Create checklist">
  Add a new checklist to a task.\<\<DEPRECATED use create\_checklist>>
</Accordion>

<Accordion title="Shared hierarchy">
  View the tasks, lists, and folders that have been shared with the authenticated user.
</Accordion>

<Accordion title="Get workspace seats">
  View the used, total, and available member and guest seats for a workspace.\<\<DEPRECATED use get\_workspace\_seats>>
</Accordion>

<Accordion title="Get tasks">
  This api endpoint allows viewing up to 100 tasks per page, limited to tasks within the specified `list id` that have it as their home list. tasks from other home lists aren't included.\<\<DEPRECATED use get\_tasks>>
</Accordion>

<Accordion title="Update folder">
  Rename a folder.
</Accordion>

<Accordion title="Track time">
  ***note:** this is a legacy time tracking endpoint. we recommend using the time tracking api endpoints to manage time entries.*
</Accordion>

<Accordion title="Update goal">
  Rename a goal, set the due date, replace the description, add or remove owners, and set the goal color.
</Accordion>

<Accordion title="Update comment">
  Replace the content of a task commment, assign a comment, and mark a comment as resolved.
</Accordion>

<Accordion title="Update a time entry">
  Update the details of a time entry.
</Accordion>

<Accordion title="Create team">
  The endpoint allows creating teams within workspaces, assigning tasks, and managing ids for both. adding a view-only guest as a paid member may result in extra charges due to automatic seat addition.\<\<DEPRECATED use create\_team>>
</Accordion>

<Accordion title="Get time entries within a date range">
  This api endpoint retrieves time entries for the past 30 days for the user or others using the `assignee` parameter, and allows filtering by `space id` or `task id`. negative durations show active timers.
</Accordion>

<Accordion title="Remove tag from task">
  Remove a tag from a task. this does not delete the tag from the space.
</Accordion>

<Accordion title="Update task">
  Update a task by including one or more fields in the request body.
</Accordion>

<Accordion title="Get list members">
  View the people who have access to a list.\<\<DEPRECATED use get\_list\_members>>
</Accordion>

<Accordion title="Get teams">
  This endpoint allows viewing user groups (teams) in a workspace, where `team id` is the workspace id, and `group id` is a user group id in api documentation.
</Accordion>

<Accordion title="Get space views">
  View the task and page views available for a space.\<\<DEPRECATED use get\_space\_views>>
</Accordion>

<Accordion title="Remove guest from list">
  Revoke a guest's access to a list. ***note:** this endpoint is only available to workspaces on our [enterprise plan](https://clickup.com/pricing).*
</Accordion>

<Accordion title="Get user">
  View information about a user in a workspace. ***note:** this endpoint is only available to workspaces on our [enterprise plan](https://clickup.com/pricing).*
</Accordion>

<Accordion title="Get workspace everything level views">
  View the task and page views available at the everything level of a workspace.\<\<DEPRECATED use get\_workspace\_everything\_level\_views>>
</Accordion>

<Accordion title="Update list">
  Rename a list, update the list info description, set a due date/time, set the list's priority, set an assignee, set or remove the list color.
</Accordion>

<Accordion title="Remove tags from time entries">
  Remove labels from time entries. this does not remove the label from a workspace.
</Accordion>

<Accordion title="Update webhook">
  Update a webhook to change the events to be monitored.
</Accordion>

<Accordion title="Remove guest from task">
  Revoke a guest's access to a task. ***note:** this endpoint is only available to workspaces on our [enterprise plan](https://clickup.com/pricing).*
</Accordion>

<Accordion title="Get webhooks">
  View the webhooks created via the api for a workspace. this endpoint returns webhooks created by the authenticated user.
</Accordion>

<Accordion title="Remove guest from workspace">
  Revoke a guest's access to a workspace. ***note:** this endpoint is only available to workspaces on our [enterprise plan](https://clickup.com/pricing).*
</Accordion>

<Accordion title="Get workspace everything level views">
  View the task and page views available at the everything level of a workspace.
</Accordion>

<Accordion title="Get workspace plan">
  View the current [plan](https://clickup.com/pricing) for the specified workspace.
</Accordion>

<Accordion title="Update view">
  Rename a view, update the grouping, sorting, filters, columns, and settings of a view.
</Accordion>

<Accordion title="Update space">
  Rename, set the space color, and enable clickapps for a space.
</Accordion>

<Accordion title="Update team">
  The endpoint controls user group assignments in a workspace, requiring 'team id' and 'group id'. adding a view-only guest as a paid member incurs prorated charges for additional seats.
</Accordion>


# Coda
Source: https://docs.push.ai/integrations/coda



Collaborative workspace platform that transforms documents into powerful tools for team productivity and project management

<Accordion title="Add a permission for pack">
  Create or modify user, workspace, or global permissions for a given pack.
</Accordion>

<Accordion title="Add a maker for pack">
  Set a maker for a given pack. used to display makers for a pack in the corresponding packs page.
</Accordion>

<Accordion title="Add custom domain">
  Add a custom domain to a published doc.
</Accordion>

<Accordion title="Add a category for pack">
  Add a publishing category for a given pack.
</Accordion>

<Accordion title="Begin content export">
  Initiate an export of content for the given page.
</Accordion>

<Accordion title="Create a new pack release">
  Creates a new pack release based on an existing pack version.
</Accordion>

<Accordion title="Create doc">
  Creates a new coda doc, optionally copying an existing doc. note that creating a doc requires you to be a doc maker in the applicable workspace (or be auto-promoted to one).
</Accordion>

<Accordion title="Delete multiple rows">
  Deletes the specified rows from the table or view. this endpoint will always return a 202. row deletions are generally processed within several seconds.
</Accordion>

<Accordion title="Delete a page">
  Deletes the specified page.
</Accordion>

<Accordion title="Content export status">
  Check the status of a page content export
</Accordion>

<Accordion title="Gets custom doc domains providers">
  Gets the provider (ie. godaddy) of a custom domain.
</Accordion>

<Accordion title="Delete a category for pack">
  Delete a publishing category for a given pack.
</Accordion>

<Accordion title="Create pack">
  Creates a new pack, essentially registering a new pack id. the contents of the pack will be uploaded separately.
</Accordion>

<Accordion title="Delete row">
  Deletes the specified row from the table or view. this endpoint will always return a 202, so long as the row exists and is accessible (and the update is structurally valid). row deletions are generally processed within several seconds. when deleting using a name as opposed to an id, an arbitrary row will be removed.
</Accordion>

<Accordion title="Deletes a custom domain">
  Deletes a custom domain from a published doc.
</Accordion>

<Accordion title="Delete a permission for pack">
  Delete user, workspace, or global permissions for a given pack.
</Accordion>

<Accordion title="Add permission">
  Adds a new permission to the doc.
</Accordion>

<Accordion title="Delete a maker for pack">
  Delete a maker for a given pack, who will not be displayed in the corresponding packs page.
</Accordion>

<Accordion title="Create a page">
  Create a new page in a doc. note that creating a page requires you to be a doc maker in the applicable workspace.
</Accordion>

<Accordion title="Delete pack">
  Delete a given pack.
</Accordion>

<Accordion title="Get acl settings">
  Returns settings associated with acls for this coda doc.
</Accordion>

<Accordion title="Gets the json schema for pack configuration">
  Returns a json schema applicable for customizing the pack using pack configurations.
</Accordion>

<Accordion title="Delete doc">
  Deletes a doc.
</Accordion>

<Accordion title="Get a column">
  Returns details about a column in a table.
</Accordion>

<Accordion title="Get a control">
  Returns info on a control.
</Accordion>

<Accordion title="Delete permission">
  Deletes an existing permission.
</Accordion>

<Accordion title="Get analytics last updated day">
  Returns days based on pacific standard time when analytics were last updated.
</Accordion>

<Accordion title="Fetch grouped logs by pack org root ingestion id">
  Retrieve the grouped logs of a pack for debugging purpose.
</Accordion>

<Accordion title="Fetch ingestion executions for pack">
  Retrieve the ingestion execution ids of a root ingestion for debugging purpose.
</Accordion>

<Accordion title="Get a table">
  Returns details about a specific table or view.
</Accordion>

<Accordion title="Get a row">
  Returns details about a row in a table.
</Accordion>

<Accordion title="List columns">
  Returns a list of columns in a table.
</Accordion>

<Accordion title="List categories for pack">
  List publishing categories for a given pack.
</Accordion>

<Accordion title="List controls">
  Returns a list of controls in a coda doc.
</Accordion>

<Accordion title="Get sharing metadata">
  Returns metadata associated with sharing for this coda doc.
</Accordion>

<Accordion title="Get a formula">
  Returns info on a formula.
</Accordion>

<Accordion title="List featured docs for a pack">
  Returns a list of featured doc ids for a pack.
</Accordion>

<Accordion title="Get doc categories">
  Gets all available doc categories.
</Accordion>

<Accordion title="Get the difference between two pack versions">
  Gets information about the difference between the specified previous version and next version of a pack.
</Accordion>

<Accordion title="Get the next valid version for a pack">
  Get the next valid version based on the proposed metadata.
</Accordion>

<Accordion title="Get info about a doc">
  Returns metadata for the specified doc.
</Accordion>

<Accordion title="List makers for pack">
  List makers for a given pack.
</Accordion>

<Accordion title="List packs">
  Get the list of accessible packs.
</Accordion>

<Accordion title="Get a page">
  Returns details about a page.
</Accordion>

<Accordion title="Get doc analytics summary">
  Returns summarized analytics data for available docs.
</Accordion>

<Accordion title="Get a single pack">
  Returns a single pack.
</Accordion>

<Accordion title="List pages">
  Returns a list of pages in a coda doc.
</Accordion>

<Accordion title="List custom doc domains">
  List all custom domains for a published doc.
</Accordion>

<Accordion title="List pack analytics">
  Returns analytics data for packs the user can edit.
</Accordion>

<Accordion title="List workspace roles">
  Returns a list of the counts of users over time by role for the workspace.
</Accordion>

<Accordion title="Publish doc">
  Update publish settings for a doc.
</Accordion>

<Accordion title="List tables">
  Returns a list of tables in a coda doc.
</Accordion>

<Accordion title="List permissions for a pack">
  Get user, workspace, and/or global permissions for a given pack.
</Accordion>

<Accordion title="List page analytics">
  Returns analytics data for a given doc within the day. this method will return a 401 if the given doc is not in an enterprise workspace.
</Accordion>

<Accordion title="List workspace users">
  Returns a list of members in the given workspace. this list will be ordered with the requesting user first and then ordered by role.
</Accordion>

<Accordion title="Pack source code upload complete">
  Note the completion of the upload of a pack source code.
</Accordion>

<Accordion title="List formulas">
  Returns a list of named formulas in a coda doc.
</Accordion>

<Accordion title="Push a button">
  Pushes a button on a row in a table. authorization note: this action is available to api tokens that are authorized to write to the table. however, the underlying button can perform any action on the document, including writing to other tables and performing pack actions.
</Accordion>

<Accordion title="Patch the system connection credentials of the pack">
  Patch the system connection credentials of the pack.
</Accordion>

<Accordion title="Pack version upload complete">
  Note the completion of the upload of a pack version bundle in order to create that pack version.
</Accordion>

<Accordion title="List pack formula analytics">
  Returns analytics data for pack formulas.
</Accordion>

<Accordion title="List the versions for a pack">
  Get the list of versions of a pack.
</Accordion>

<Accordion title="Get mutation status">
  Get the status for an asynchronous mutation to know whether or not it has been completed. each api endpoint that mutates a document will return a request id that you can pass to this endpoint to check the completion status. status information is not guaranteed to be available for more than one day after the mutation was completed. it is intended to be used shortly after the request was made.
</Accordion>

<Accordion title="Get detailed listing information for a pack">
  Get detailed listing information for a pack.
</Accordion>

<Accordion title="Retrieve the information for a specific log">
  Retrieve the ingestion execution ids of a root ingestion for debugging purpose.
</Accordion>

<Accordion title="Retrieve the grouped logs of a pack">
  Retrieve the grouped logs of a pack for debugging purpose.
</Accordion>

<Accordion title="Get pack analytics summary">
  Returns summarized analytics data for packs the user can edit.
</Accordion>

<Accordion title="Register pack version">
  Registers a new pack version. this simply returns a signed url to use for uploading the pack version definition. following the completion of the upload, post to /apis/v1/packs/\{packid}/versions/\{packversion} trigger the rest of the creation process.
</Accordion>

<Accordion title="List table rows">
  Retrieves rows from a specific table within a coda document. this endpoint allows you to fetch data from your coda tables programmatically, enabling integration with other systems or data analysis tools. use this when you need to access the content of a table in your coda document, such as for reporting, data synchronization, or building custom views of your data outside of coda. the endpoint supports pagination for large tables and allows you to control the number of rows returned per request. it's important to note that this endpoint only retrieves data and doesn't modify the table contents.
</Accordion>

<Accordion title="Retrieve the logs of a ingestion">
  Retrieve the logs of a ingestion for debugging purpose.
</Accordion>

<Accordion title="List doc analytics">
  Returns analytics data for available docs per day.
</Accordion>

<Accordion title="Set the system connection credentials of the pack">
  Set the system connection credentials of the pack.
</Accordion>

<Accordion title="Set the oauth configurations of the pack">
  Set the oauth configurations of the pack, including client id and secret.
</Accordion>

<Accordion title="Pack asset upload complete">
  Note the completion of the upload of a pack asset.
</Accordion>

<Accordion title="Update acl settings">
  Update settings associated with acls for this coda doc.
</Accordion>

<Accordion title="Resolve browser link">
  Given a browser link to a coda object, attempts to find it and return metadata that can be used to get more info on it. returns a 400 if the url does not appear to be a coda url or a 404 if the resource cannot be located with the current credentials.
</Accordion>

<Accordion title="Retrieve the logs of a pack">
  Retrieve the logs of a pack for debugging purpose.
</Accordion>

<Accordion title="Updates a custom domain">
  Updates properties of a document's custom domain.
</Accordion>

<Accordion title="Trigger automation">
  Triggers webhook-invoked automation
</Accordion>

<Accordion title="List permissions">
  Returns a list of permissions for this coda doc.
</Accordion>

<Accordion title="Retrieve the oauth configuration of the pack">
  Retrieve the oauth configuration of the pack for display purpose. secrets will be returned with masks.
</Accordion>

<Accordion title="Updates user role">
  Updates the workspace user role of a user that matches the parameters. only succeeds if the requesting user has admin permissions in the workspace.
</Accordion>

<Accordion title="Update an existing pack release">
  Update details of a pack release.
</Accordion>

<Accordion title="Retrieve the system connection metadata of the pack">
  Retrieve the system connection metadata of the pack.
</Accordion>

<Accordion title="Search principals">
  Searches for user and group principals matching the query that this doc can be shared with. at most 20 results will be returned for both users and groups. if no query is given then no results are returned.
</Accordion>

<Accordion title="Update a page">
  Update properties for a page. note that updating a page title or icon requires you to be a doc maker in the applicable workspace.
</Accordion>

<Accordion title="Update doc">
  Updates metadata for a doc. note that updating a doc title requires you to be a doc maker in the applicable workspace.
</Accordion>

<Accordion title="Get the source code for a pack version">
  Get temporary links used to download the source code for the given packid and version
</Accordion>

<Accordion title="Update pack">
  Update an existing pack for non-versioned fields.
</Accordion>

<Accordion title="Unpublish doc">
  Unpublishes a doc.
</Accordion>

<Accordion title="Update featured docs for a pack">
  Create or replace the featured docs for a pack.
</Accordion>

<Accordion title="Upload a pack asset">
  Request a signed s3 url to upload your pack asset.
</Accordion>

<Accordion title="List the pack listings accessible to a user">
  Get listings of public packs and packs created by you.
</Accordion>

<Accordion title="Upload pack source code">
  Request a signed s3 url to upload your pack source code.
</Accordion>

<Accordion title="Get user info">
  Returns basic info about the current user.
</Accordion>

<Accordion title="List the releases for a pack">
  Get the list of releases of a pack.
</Accordion>

<Accordion title="List available docs">
  Returns a list of coda docs accessible by the user, and which they have opened at least once. these are returned in the same order as on the docs page: reverse chronological by the latest event relevant to the user (last viewed, edited, or shared).
</Accordion>


# Codeinterpreter
Source: https://docs.push.ai/integrations/codeinterpreter



CodeInterpreter extends Python-based coding environments with integrated data analysis, enabling developers to run scripts, visualize results, and prototype solutions inside supported platforms

<Accordion title="Execute Code">
  Execute python code in a sandbox and return any result, stdout, stderr, and error. use /home/user folder to write/read files. try to not use plt.show() as the code is executed remotely. use files for image/chart output instead.
</Accordion>

<Accordion title="Upload File">
  Upload a file to the sandbox environment. the files should be uploaded to the /home/user folder.
</Accordion>

<Accordion title="Get File">
  Get a file from the sandbox and returns the file. the files should be read from /home/user folder.
</Accordion>

<Accordion title="Run Terminal Command">
  Run a command in the terminal and returns the stdout, stderr, and error code. use /home/user folder to write/read files.
</Accordion>


# Coinbase
Source: https://docs.push.ai/integrations/coinbase



Coinbase provides APIs for cryptocurrency trading and management.

<Accordion title="Get Wallet Info">
  Retrieve detailed information about a single wallet from coinbase via the cdp sdk.
</Accordion>

<Accordion title="List Wallets">
  Retrieve all wallets from coinbase via the cdp sdk.
</Accordion>

<Accordion title="Check Transfer">
  Action to retrieve a transfer by wallet id, address id, and transfer id using the cdp sdk get transfer(...) endpoint.
</Accordion>

<Accordion title="Send Tokens">
  Sends tokens from one cdp wallet to another or to an external address using the cdp sdk. this action supports both internal transfers between cdp wallets and external transfers to blockchain addresses. it handles gasless transfers for supported assets and optional batching for optimized processing.
</Accordion>

<Accordion title="Coinbase Coinbase Faucet">
  Requests testnet funds (e.g. eth, usdc) for a given wallet using the cdp sdk. note: this only works on test networks that support a faucet (e.g. base sepolia).
</Accordion>

<Accordion title="Create Wallet">
  Create a new wallet in coinbase, optionally using server signing (custodial / 2-of-2 mpc).
</Accordion>


# Composio
Source: https://docs.push.ai/integrations/composio



Composio enables AI Agents and LLMs to authenticate and integrate with various tools via function calling.

<Accordion title="Enable Trigger">
  Enable a specific trigger for the authenticated user.
</Accordion>

<Accordion title="List Apps">
  List all the available apps on composio with filtering options.
</Accordion>

<Accordion title="Execute Action">
  Execute an action using the composio api.
</Accordion>

<Accordion title="List Triggers">
  List available triggers and their configuration schemas.
</Accordion>

<Accordion title="Get Required Parameters">
  This action retrieves the necessary parameters required to initiate a connection with a specified tool. for instance, linear may need an 'api key', zendesk might require a 'subdomain', and slack could need a 'webhook url'. the required parameters vary based on the authentication scheme employed. for example, api key authentication requires an api key, whereas oauth2 typically does not require any parameters because it involves redirecting the user to the tool's website for authorization.
</Accordion>

<Accordion title="Advanced Use Case Search">
  Apps are like github, linear, gmail, etc. actions are like send email, create issue, etc programmatic functions that can be used to perform the action. not all apps support all actions. some apps support only a subset of actions that might be possible to perform with that app. use this action to search for apps that can be used to perform a specific use case. this list is only probabilistic. search apps for a specified usecase. so for example, if use case is to "send an email" this action will return all the apps that can be used to send email. similarly if use case is to "create a github issue" this action will return all the apps that can be used to create a github issue. after using this, to confirm whether the application can indeed potentially support the use case, use the action retrieve actions.
</Accordion>

<Accordion title="Retrieve Actions">
  Apps are like github, linear, gmail, etc. actions are like send email, create issue, etc programmatic functions that can be used to perform the action. get actions for a given usecase using similarity search. this actions are most relevant to the usecase but still might not be actual actions needed for the usecase. this decision should be made by you. this should be used to narrow down for an app, and find the most relevant actions for the usecase. in some cases, you might want to even check if the usecase is supported by the app or not.
</Accordion>

<Accordion title="Retrieve Apps">
  Apps are like github, linear, gmail, etc. actions are like send email, create issue, etc programmatic functions that can be used to perform the action. not all apps support all actions. some apps support only a subset of actions that might be possible to perform with that app. use this action to retrieve the apps that can be used to perform the action. this list is only probabilistic. retrieve apps for a specified usecase. so for example, if use case is to "send an email" this action will return all the apps that can be used to send email. similarly if use case is to "create a github issue" this action will return all the apps that can be used to create a github issue. after using this, to confirm whether the application can indeed potentially support the use case, use the action retrieve actions.
</Accordion>

<Accordion title="Check Active Connection">
  Check if any active connections exist for a given tool or status of the connection with a specific id. if an active connection exists, the tool will return true, otherwise it will return false. active connections allow an agent to perform any actions on top of the tool.
</Accordion>

<Accordion title="Get Response Schema">
  Retrieves the response schema for a specified composio action. this action fetches the complete response schema definition for any valid composio action, returning it as a dictionary that describes the expected response structure.
</Accordion>

<Accordion title="Initiate Connection">
  Initiate a connection to a tool with the given parameters. for example, linear might require an api key to create a connection, which we can get by calling get required parameters. to create a new connection, we need to call create connection with the required parameters. similarly, zendesk might require a subdomain to create a connection, which we can get by calling get required parameters. to create a new connection, we need to call create connection with the subdomain.
</Accordion>

<Accordion title="Wait For Connection">
  Wait for a connection to be established for a given tool or check the status of a connection with a specific id. wait for a given amount of time and then check again the status of the connection.
</Accordion>


# Composio search
Source: https://docs.push.ai/integrations/composio_search



Composio Search is an all-in-one tool for searching and scraping the web.

<Accordion title="Composio Image Search">
  The imagesearch class performs an image search using the composio image search api, to target image data and information. it uses the google images search engine through the composio image search api to fetch relevant image information based on the input query.
</Accordion>

<Accordion title="Composio Finance Search">
  The financesearch class utilizes the composio finance search api to conduct financial searches, focusing on financial data and stock information. it leverages the google finance search engine via the composio finance search api to retrieve pertinent financial details based on the provided query.
</Accordion>

<Accordion title="Composio Google Events Search">
  The eventsearch class enables scraping of google events search queries. it conducts an event search using the composio events search api, retrieving information on events such as concerts, festivals, and other activities based on the provided query.
</Accordion>

<Accordion title="Composio DuckDuckGo Search">
  The duckduckgosearch class utilizes the composio duckduckgo search api to perform searches, focusing on web information and details. it leverages the duckduckgo search engine via the composio duckduckgo search api to retrieve relevant web data based on the provided query.
</Accordion>

<Accordion title="Composio News Search">
  The newssearch class performs a news-specific search using the composio news search api. this class extends the functionality of the base action class to specifically target news articles related to the given query. by utilizing the google news search engine through the composio news search api, it fetches the most relevant news articles based on the input query. the `newssearch` class is particularly useful for applications that need to retrieve and display the latest news articles about a specific topic. it leverages the powerful search capabilities of google's news search engine, ensuring that the returned results are current and relevant.
</Accordion>

<Accordion title="Composio Scholar Search">
  Scholar api allows you to scrape results from a google scholar search query. the scholarsearch class performs an academic search using the composio scholar search api, academic papers and scholarly articles. it uses the google scholar search engine through the serp api to fetch relevant academic information based on the input query.
</Accordion>

<Accordion title="Composio Google Maps Search">
  The googlemapssearch class performs a location-specific search using the composio goolge maps search api. this class extends the functionality of the base action class to specifically target locations related to the given query. by utilizing the google maps search engine through the composio goolge maps search api, it fetches the most relevant location data based on the input query. the `googlemapssearch` class is particularly useful for applications that need to retrieve and display location information about a specific area. it leverages the powerful search capabilities of google's maps search engine, ensuring that the returned results are accurate and relevant.
</Accordion>

<Accordion title="Composio Shopping Search">
  The shoppingsearch class performs a product search using the composio shopping search api.it specifically target shopping results related to the given query. by utilizing the google shopping search engine through the composio shopping search api, it fetches the most relevant product listings based on the input query. the `shoppingsearch` class is particularly useful for applications that need to retrieve and display the latest product listings and shopping results for a specific item. it leverages the powerful search capabilities of google's shopping search engine, ensuring that the returned results are current and relevant.
</Accordion>

<Accordion title="Composio LLM Search">
  The composio llm search class serves as a gateway to the composio llm search api, allowing users to perform searches across a broad range of content with multiple filtering options. it accommodates complex queries, including both keyword and phrase searches, with additional parameters to fine-tune the search results. this class enables a tailored search experience by allowing users to specify the search depth, include images and direct answers, apply domain-specific filters, and control the number of results returned. it is designed to meet various search requirements, from quick lookups to in-depth research.
</Accordion>

<Accordion title="Composio Google Search">
  Perform a google search using the composio google search api.
</Accordion>

<Accordion title="Composio Similarlinks">
  Perform a search to find similar links and retrieve a list of relevant results. the search can optionally return contents.
</Accordion>

<Accordion title="Composio Trends Search">
  The trendssearch class performs a trend search using the google trends search api, to target trend data and information. it uses the google trends search engine through the google trends search api to fetch relevant trend information based on the input query.
</Accordion>


# Confluence
Source: https://docs.push.ai/integrations/confluence



A tool for team collaboration and knowledge management.

<Accordion title="Convert content ids to content types">
  Converts a list of content ids into their associated content types. this is useful for users migrating from v1 to v2 who may have stored just content ids without their associated type. this will return types as they should be used in v2. notably, this will return `inline-comment` for inline comments and `footer-comment` for footer comments, which is distinct from them both being represented by `comment` in v1. **\[permissions]\([https://confluence.atlassian.com/x/](https://confluence.atlassian.com/x/) aozkw) required**: permission to view the requested content. any content that the user does not have permission to view or does not exist will map to `null` in the response.
</Accordion>

<Accordion title="Create blog post">
  Creates a new blog post in the space specified by the spaceid. by default this will create the blog post as a non-draft, unless the status is specified as draft. if creating a non-draft, the title must not be empty. currently only supports the storage representation specified in the body.representation enums below
</Accordion>

<Accordion title="Create content property for comment">
  Creates a new content property for a comment. **\[permissions]\([https://confluence.atlassian.com/x/](https://confluence.atlassian.com/x/) aozkw) required**: permission to update the comment.
</Accordion>

<Accordion title="Create content property for blog post">
  Creates a new property for a blogpost. **\[permissions]\([https://confluence.atlassian.com/x/](https://confluence.atlassian.com/x/) aozkw) required**: permission to update the blog post.
</Accordion>

<Accordion title="Delete content property for smart link in the content tree by id">
  Deletes a content property for a smart link in the content tree by its id. **\[permissions]\([https://confluence.atlassian.com/x/](https://confluence.atlassian.com/x/) aozkw) required**: permission to edit the smart link in the content tree.
</Accordion>

<Accordion title="Check site access for a list of emails">
  Returns the list of emails from the input list that do not have access to site. **\[permissions]\([https://confluence.atlassian.com/x/](https://confluence.atlassian.com/x/) aozkw) required**: permission to access the confluence site ('can use' global permission).
</Accordion>

<Accordion title="Create bulk user lookup using ids">
  Returns user details for the ids provided in the request body. **\[permissions]\([https://confluence.atlassian.com/x/](https://confluence.atlassian.com/x/) aozkw) required**: permission to access the confluence site ('can use' global permission). the user must be able to view user profiles in the confluence site.
</Accordion>

<Accordion title="Create whiteboard">
  Creates a whiteboard in the space. **\[permissions]\([https://confluence.atlassian.com/x/](https://confluence.atlassian.com/x/) aozkw) required**: permission to view the corresponding space. permission to create a whiteboard in the space.
</Accordion>

<Accordion title="Create space property in space">
  Creates a new space property. **\[permissions]\([https://confluence.atlassian.com/x/](https://confluence.atlassian.com/x/) aozkw) required**: permission to access the confluence site ('can use' global permission) and 'admin' permission for the space.
</Accordion>

<Accordion title="Create space">
  Creates a space as specified in the payload. **\[permissions]\([https://confluence.atlassian.com/x/](https://confluence.atlassian.com/x/) aozkw) required**: permission to create spaces.
</Accordion>

<Accordion title="Delete space property by id">
  Deletes a space property by its id. **\[permissions]\([https://confluence.atlassian.com/x/](https://confluence.atlassian.com/x/) aozkw) required**: permission to access the confluence site ('can use' global permission) and 'admin' permission for the space.
</Accordion>

<Accordion title="Get all ancestors of smart link in content tree">
  Returns all ancestors for a given smart link in the content tree by id in top-to-bottom order (that is, the highest ancestor is the first item in the response payload). the number of results is limited by the `limit` parameter and additional results (if available) will be available by calling this endpoint with the id of first ancestor in the response payload. this endpoint returns minimal information about each ancestor. to fetch more details, use a related endpoint, such as [get smart link in the content tree by id](https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-smart-link/#api-embeds-id-get). **\[permissions]\([https://confluence.atlassian.com/x/](https://confluence.atlassian.com/x/) aozkw) required**: permission to access the confluence site ('can use' global permission). permission to view the smart link in the content tree and its corresponding space
</Accordion>

<Accordion title="Get all ancestors of page">
  Returns all ancestors for a given page by id in top-to-bottom order (that is, the highest ancestor is the first item in the response payload). the number of results is limited by the `limit` parameter and additional results (if available) will be available by calling this endpoint with the id of first ancestor in the response payload. this endpoint returns minimal information about each ancestor. to fetch more details, use a related endpoint, such as [get page by id](https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-page/#api-pages-id-get). **\[permissions]\([https://confluence.atlassian.com/x/](https://confluence.atlassian.com/x/) aozkw) required**: permission to access the confluence site ('can use' global permission).
</Accordion>

<Accordion title="Delete content property for whiteboard by id">
  Deletes a content property for a whiteboard by its id. **\[permissions]\([https://confluence.atlassian.com/x/](https://confluence.atlassian.com/x/) aozkw) required**: permission to edit the whiteboard.
</Accordion>

<Accordion title="Create content property for database">
  Creates a new content property for a database. **\[permissions]\([https://confluence.atlassian.com/x/](https://confluence.atlassian.com/x/) aozkw) required**: permission to update the database.
</Accordion>

<Accordion title="Create content property for page">
  Creates a new content property for a page. **\[permissions]\([https://confluence.atlassian.com/x/](https://confluence.atlassian.com/x/) aozkw) required**: permission to update the page.
</Accordion>

<Accordion title="Create content property for folder">
  Creates a new content property for a folder. **\[permissions]\([https://confluence.atlassian.com/x/](https://confluence.atlassian.com/x/) aozkw) required**: permission to update the folder.
</Accordion>

<Accordion title="Get all ancestors of whiteboard">
  Returns all ancestors for a given whiteboard by id in top-to-bottom order (that is, the highest ancestor is the first item in the response payload). the number of results is limited by the `limit` parameter and additional results (if available) will be available by calling this endpoint with the id of first ancestor in the response payload. this endpoint returns minimal information about each ancestor. to fetch more details, use a related endpoint, such as [get whiteboard by id](https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-whiteboard/#api-whiteboards-id-get). **\[permissions]\([https://confluence.atlassian.com/x/](https://confluence.atlassian.com/x/) aozkw) required**: permission to access the confluence site ('can use' global permission). permission to view the whiteboard and its corresponding space
</Accordion>

<Accordion title="Get attachments">
  Returns all attachments. the number of results is limited by the `limit` parameter and additional results (if available) will be available through the `next` url present in the `link` response header. **\[permissions]\([https://confluence.atlassian.com/x/](https://confluence.atlassian.com/x/) aozkw) required**: permission to view the container of the attachment.
</Accordion>

<Accordion title="Create content property for attachment">
  Creates a new content property for an attachment. **\[permissions]\([https://confluence.atlassian.com/x/](https://confluence.atlassian.com/x/) aozkw) required**: permission to update the attachment.
</Accordion>

<Accordion title="Get blog posts in space">
  Returns all blog posts in a space. the number of results is limited by the `limit` parameter and additional results (if available) will be available through the `next` url present in the `link` response header. **\[permissions]\([https://confluence.atlassian.com/x/](https://confluence.atlassian.com/x/) aozkw) required**: permission to access the confluence site ('can use' global permission) and view the space. only blog posts that the user has permission to view will be returned.
</Accordion>

<Accordion title="Get blog post classification level">
  Returns the [classification level](https://developer.atlassian.com/cloud/admin/dlp/rest/intro/#classification%20level) for a specific blog post. **\[permissions]\([https://confluence.atlassian.com/x/](https://confluence.atlassian.com/x/) aozkw) required**: 'permission to access the confluence site ('can use' global permission) and permission to view the blog post. 'permission to edit the blog post is required if trying to view classification level for a draft.
</Accordion>

<Accordion title="Get blog post by id">
  Returns a specific blog post. **\[permissions]\([https://confluence.atlassian.com/x/](https://confluence.atlassian.com/x/) aozkw) required**: permission to view the blog post and its corresponding space.
</Accordion>

<Accordion title="Delete whiteboard">
  Delete a whiteboard by id. deleting a whiteboard moves the whiteboard to the trash, where it can be restored later **\[permissions]\([https://confluence.atlassian.com/x/](https://confluence.atlassian.com/x/) aozkw) required**: permission to view the whiteboard and its corresponding space. permission to delete whiteboards in the space.
</Accordion>

<Accordion title="Delete custom content">
  Delete a custom content by id. deleting a custom content will either move it to the trash or permanently delete it (purge it), depending on the apisupport. to permanently delete a **trashed** custom content, the endpoint must be called with the following param `purge=true`. **\[permissions]\([https://confluence.atlassian.com/x/](https://confluence.atlassian.com/x/) aozkw) required**: permission to view the content of the page or blogpost and its corresponding space. permission to delete custom content in the space. permission to administer the space (if attempting to purge).
</Accordion>

<Accordion title="Get available space permissions">
  Retrieves the available space permissions. **\[permissions]\([https://confluence.atlassian.com/x/](https://confluence.atlassian.com/x/) aozkw) required**: permission to access the confluence site.
</Accordion>

<Accordion title="Get blog post versions">
  Returns the versions of specific blog post. **\[permissions]\([https://confluence.atlassian.com/x/](https://confluence.atlassian.com/x/) aozkw) required**: permission to view the blog post and its corresponding space.
</Accordion>

<Accordion title="Get attachments for blog post">
  Returns the attachments of specific blog post. the number of results is limited by the `limit` parameter and additional results (if available) will be available through the `next` url present in the `link` response header. **\[permissions]\([https://confluence.atlassian.com/x/](https://confluence.atlassian.com/x/) aozkw) required**: permission to view the content of the blog post and its corresponding space.
</Accordion>

<Accordion title="Get attachment versions">
  Returns the versions of specific attachment. **\[permissions]\([https://confluence.atlassian.com/x/](https://confluence.atlassian.com/x/) aozkw) required**: permission to view the attachment and its corresponding space.
</Accordion>

<Accordion title="Create content property for smart link in the content tree">
  Creates a new content property for a smart link in the content tree. **\[permissions]\([https://confluence.atlassian.com/x/](https://confluence.atlassian.com/x/) aozkw) required**: permission to update the smart link in the content tree.
</Accordion>

<Accordion title="Get account ids of likes for blog post">
  Returns the account ids of likes of specific blog post. **\[permissions]\([https://confluence.atlassian.com/x/](https://confluence.atlassian.com/x/) aozkw) required**: permission to view the content of the blog post and its corresponding space.
</Accordion>

<Accordion title="Get children footer comments">
  Returns the children footer comments of specific comment. the number of results is limited by the `limit` parameter and additional results (if available) will be available through the `next` url present in the `link` response header. **\[permissions]\([https://confluence.atlassian.com/x/](https://confluence.atlassian.com/x/) aozkw) required**: permission to view the content of the page and its corresponding space.
</Accordion>

<Accordion title="Get content properties for blog post">
  Retrieves all content properties tied to a specified blog post. **\[permissions]\([https://confluence.atlassian.com/x/](https://confluence.atlassian.com/x/) aozkw) required**: permission to view the blog post.
</Accordion>

<Accordion title="Get content properties for comment">
  Retrieves content properties attached to a specified comment. **\[permissions]\([https://confluence.atlassian.com/x/](https://confluence.atlassian.com/x/) aozkw) required**: permission to view the comment.
</Accordion>

<Accordion title="Get content properties for custom content">
  Retrieves content properties tied to a specified custom content. **\[permissions]\([https://confluence.atlassian.com/x/](https://confluence.atlassian.com/x/) aozkw) required**: permission to view the custom content.
</Accordion>

<Accordion title="Get content properties for database">
  Retrieves content properties tied to a specified database. **\[permissions]\([https://confluence.atlassian.com/x/](https://confluence.atlassian.com/x/) aozkw) required**: permission to view the database.
</Accordion>

<Accordion title="Create content property for custom content">
  Creates a new content property for a piece of custom content. **\[permissions]\([https://confluence.atlassian.com/x/](https://confluence.atlassian.com/x/) aozkw) required**: permission to update the custom content.
</Accordion>

<Accordion title="Delete database">
  Delete a database by id. deleting a database moves the database to the trash, where it can be restored later **\[permissions]\([https://confluence.atlassian.com/x/](https://confluence.atlassian.com/x/) aozkw) required**: permission to view the database and its corresponding space. permission to delete databases in the space.
</Accordion>

<Accordion title="Get account ids of likes for footer comment">
  Returns the account ids of likes of specific footer comment. **\[permissions]\([https://confluence.atlassian.com/x/](https://confluence.atlassian.com/x/) aozkw) required**: permission to view the content of the page/blogpost and its corresponding space.
</Accordion>

<Accordion title="Get children inline comments">
  Returns the children inline comments of specific comment. the number of results is limited by the `limit` parameter and additional results (if available) will be available through the `next` url present in the `link` response header. **\[permissions]\([https://confluence.atlassian.com/x/](https://confluence.atlassian.com/x/) aozkw) required**: permission to view the content of the page and its corresponding space.
</Accordion>

<Accordion title="Create content property for whiteboard">
  Creates a new content property for a whiteboard. **\[permissions]\([https://confluence.atlassian.com/x/](https://confluence.atlassian.com/x/) aozkw) required**: permission to update the whiteboard.
</Accordion>

<Accordion title="Get attachments for custom content">
  Returns the attachments of specific custom content. the number of results is limited by the `limit` parameter and additional results (if available) will be available through the `next` url present in the `link` response header. **\[permissions]\([https://confluence.atlassian.com/x/](https://confluence.atlassian.com/x/) aozkw) required**: permission to view the content of the custom content and its corresponding space.
</Accordion>

<Accordion title="Get content properties for folder">
  Retrieves content properties tied to a specified folder. **\[permissions]\([https://confluence.atlassian.com/x/](https://confluence.atlassian.com/x/) aozkw) required**: permission to view the folder.
</Accordion>

<Accordion title="Get content properties for smart link in the content tree">
  Retrieves content properties tied to a specified smart link in the content tree. **\[permissions]\([https://confluence.atlassian.com/x/](https://confluence.atlassian.com/x/) aozkw) required**: permission to view the smart link in the content tree.
</Accordion>

<Accordion title="Delete attachment">
  Delete an attachment by id. deleting an attachment moves the attachment to the trash, where it can be restored later. to permanently delete an attachment (or "purge" it), the endpoint must be called on a **trashed** attachment with the following param `purge=true`. **\[permissions]\([https://confluence.atlassian.com/x/](https://confluence.atlassian.com/x/) aozkw) required**: permission to view the container of the attachment. permission to delete attachments in the space. permission to administer the space (if attempting to purge).
</Accordion>

<Accordion title="Get content property for comment by id">
  Retrieves a specific content property by id that is attached to a specified comment. **\[permissions]\([https://confluence.atlassian.com/x/](https://confluence.atlassian.com/x/) aozkw) required**: permission to view the comment.
</Accordion>

<Accordion title="Get content properties for page">
  Retrieves content properties tied to a specified page. **\[permissions]\([https://confluence.atlassian.com/x/](https://confluence.atlassian.com/x/) aozkw) required**: permission to view the page.
</Accordion>

<Accordion title="Get content property for blog post by id">
  Retrieves a specific content property by id that is attached to a specified blog post. **\[permissions]\([https://confluence.atlassian.com/x/](https://confluence.atlassian.com/x/) aozkw) required**: permission to view the blog post.
</Accordion>

<Accordion title="Get available space roles">
  Retrieves the available space roles. **\[permissions]\([https://confluence.atlassian.com/x/](https://confluence.atlassian.com/x/) aozkw) required**: permission to access the confluence site; if requesting a certain space's roles, permission to view the space.
</Accordion>

<Accordion title="Get content property for custom content by id">
  Retrieves a specific content property by id that is attached to a specified custom content. **\[permissions]\([https://confluence.atlassian.com/x/](https://confluence.atlassian.com/x/) aozkw) required**: permission to view the page.
</Accordion>

<Accordion title="Get content property for database by id">
  Retrieves a specific content property by id that is attached to a specified database. **\[permissions]\([https://confluence.atlassian.com/x/](https://confluence.atlassian.com/x/) aozkw) required**: permission to view the database.
</Accordion>

<Accordion title="Delete folder">
  Delete a folder by id. deleting a folder moves the folder to the trash, where it can be restored later **\[permissions]\([https://confluence.atlassian.com/x/](https://confluence.atlassian.com/x/) aozkw) required**: permission to view the folder and its corresponding space. permission to delete folders in the space.
</Accordion>

<Accordion title="Get attachments for label">
  Returns the attachments of specified label. the number of results is limited by the `limit` parameter and additional results (if available) will be available through the `next` url present in the `link` response header. **\[permissions]\([https://confluence.atlassian.com/x/](https://confluence.atlassian.com/x/) aozkw) required**: permission to view the attachment and its corresponding space.
</Accordion>

<Accordion title="Get content property for folder by id">
  Retrieves a specific content property by id that is attached to a specified folder. **\[permissions]\([https://confluence.atlassian.com/x/](https://confluence.atlassian.com/x/) aozkw) required**: permission to view the folder.
</Accordion>

<Accordion title="Get content property for page by id">
  Retrieves a specific content property by id that is attached to a specified page. **\[permissions]\([https://confluence.atlassian.com/x/](https://confluence.atlassian.com/x/) aozkw) required**: permission to view the page.
</Accordion>

<Accordion title="Get content property for smart link in the content tree by id">
  Retrieves a specific content property by id that is attached to a specified smart link in the content tree. **\[permissions]\([https://confluence.atlassian.com/x/](https://confluence.atlassian.com/x/) aozkw) required**: permission to view the smart link in the content tree.
</Accordion>

<Accordion title="Get child custom content">
  Returns all child custom content for given custom content id. the number of results is limited by the `limit` parameter and additional results (if available) will be available through the `next` url present in the `link` response header. **\[permissions]\([https://confluence.atlassian.com/x/](https://confluence.atlassian.com/x/) aozkw) required**: permission to access the confluence site ('can use' global permission). only custom content that the user has permission to view will be returned.
</Accordion>

<Accordion title="Get content property for whiteboard by id">
  Retrieves a specific content property by id that is attached to a specified whiteboard. **\[permissions]\([https://confluence.atlassian.com/x/](https://confluence.atlassian.com/x/) aozkw) required**: permission to view the whiteboard.
</Accordion>

<Accordion title="Delete footer comment">
  Deletes a footer comment. this is a permanent deletion and cannot be reverted. **\[permissions]\([https://confluence.atlassian.com/x/](https://confluence.atlassian.com/x/) aozkw) required**: permission to view the content of the page or blogpost and its corresponding space. permission to delete comments in the space.
</Accordion>

<Accordion title="Get account ids of likes for inline comment">
  Returns the account ids of likes of specific inline comment. **\[permissions]\([https://confluence.atlassian.com/x/](https://confluence.atlassian.com/x/) aozkw) required**: permission to view the content of the page/blogpost and its corresponding space.
</Accordion>

<Accordion title="Create custom content">
  Creates a new custom content in the given space, page, blogpost or other custom content. only one of `spaceid`, `pageid`, `blogpostid`, or `customcontentid` is required in the request body. **\[permissions]\([https://confluence.atlassian.com/x/](https://confluence.atlassian.com/x/) aozkw) required**: permission to view the content of the page or blogpost and its corresponding space. permission to create custom content in the space.
</Accordion>

<Accordion title="Get custom content by id">
  Returns a specific piece of custom content. **\[permissions]\([https://confluence.atlassian.com/x/](https://confluence.atlassian.com/x/) aozkw) required**: permission to view the custom content, the container of the custom content, and the corresponding space (if different from the container).
</Accordion>

<Accordion title="Get custom content by type in page">
  Returns all custom content for a given type within a given page. the number of results is limited by the `limit` parameter and additional results (if available) will be available through the `next` url present in the `link` response header. **\[permissions]\([https://confluence.atlassian.com/x/](https://confluence.atlassian.com/x/) aozkw) required**: permission to view the custom content, the container of the custom content (page), and the corresponding space.
</Accordion>

<Accordion title="Get content properties for whiteboard">
  Retrieves content properties tied to a specified whiteboard. **\[permissions]\([https://confluence.atlassian.com/x/](https://confluence.atlassian.com/x/) aozkw) required**: permission to view the whiteboard.
</Accordion>

<Accordion title="Get custom content by type in blog post">
  Returns all custom content for a given type within a given blogpost. the number of results is limited by the `limit` parameter and additional results (if available) will be available through the `next` url present in the `link` response header. **\[permissions]\([https://confluence.atlassian.com/x/](https://confluence.atlassian.com/x/) aozkw) required**: permission to view the custom content, the container of the custom content (blog post), and the corresponding space.
</Accordion>

<Accordion title="Delete blog post">
  Delete a blog post by id. by default this will delete blog posts that are non-drafts. to delete a blog post that is a draft, the endpoint must be called on a draft with the following param `draft=true`. discarded drafts are not sent to the trash and are permanently deleted. deleting a blog post that is not a draft moves the blog post to the trash, where it can be restored later. to permanently delete a blog post (or "purge" it), the endpoint must be called on a **trashed** blog post with the following param `purge=true`. **\[permissions]\([https://confluence.atlassian.com/x/](https://confluence.atlassian.com/x/) aozkw) required**: permission to view the blog post and its corresponding space. permission to delete blog posts in the space. permission to administer the space (if attempting to purge).
</Accordion>

<Accordion title="Get blog posts">
  Returns all blog posts. the number of results is limited by the `limit` parameter and additional results (if available) will be available through the `next` url present in the `link` response header. **\[permissions]\([https://confluence.atlassian.com/x/](https://confluence.atlassian.com/x/) aozkw) required**: permission to access the confluence site ('can use' global permission). only blog posts that the user has permission to view will be returned.
</Accordion>

<Accordion title="Get custom content comments">
  Returns the comments of the specific custom content. the number of results is limited by the `limit` parameter and additional results (if available) will be available through the `next` url present in the `link` response header. **\[permissions]\([https://confluence.atlassian.com/x/](https://confluence.atlassian.com/x/) aozkw) required**: permission to view the custom content and its corresponding containers.
</Accordion>

<Accordion title="Create database">
  Creates a database in the space. **\[permissions]\([https://confluence.atlassian.com/x/](https://confluence.atlassian.com/x/) aozkw) required**: permission to view the corresponding space. permission to create a database in the space.
</Accordion>

<Accordion title="Get account ids of likes for page">
  Returns the account ids of likes of specific page. **\[permissions]\([https://confluence.atlassian.com/x/](https://confluence.atlassian.com/x/) aozkw) required**: permission to view the content of the page and its corresponding space.
</Accordion>

<Accordion title="Get custom content by type in space">
  Returns all custom content for a given type within a given space. the number of results is limited by the `limit` parameter and additional results (if available) will be available through the `next` url present in the `link` response header. **\[permissions]\([https://confluence.atlassian.com/x/](https://confluence.atlassian.com/x/) aozkw) required**: permission to view the custom content and the corresponding space.
</Accordion>

<Accordion title="Get custom content by type">
  Returns all custom content for a given type. the number of results is limited by the `limit` parameter and additional results (if available) will be available through the `next` url present in the `link` response header. **\[permissions]\([https://confluence.atlassian.com/x/](https://confluence.atlassian.com/x/) aozkw) required**: permission to view the custom content, the container of the custom content, and the corresponding space (if different from the container).
</Accordion>

<Accordion title="Get attachments for page">
  Returns the attachments of specific page. the number of results is limited by the `limit` parameter and additional results (if available) will be available through the `next` url present in the `link` response header. **\[permissions]\([https://confluence.atlassian.com/x/](https://confluence.atlassian.com/x/) aozkw) required**: permission to view the content of the page and its corresponding space.
</Accordion>

<Accordion title="Delete inline comment">
  Deletes an inline comment. this is a permanent deletion and cannot be reverted. **\[permissions]\([https://confluence.atlassian.com/x/](https://confluence.atlassian.com/x/) aozkw) required**: permission to view the content of the page or blogpost and its corresponding space. permission to delete comments in the space.
</Accordion>

<Accordion title="Get custom content versions">
  Returns the versions of specific custom content. **\[permissions]\([https://confluence.atlassian.com/x/](https://confluence.atlassian.com/x/) aozkw) required**: permission to view the custom content and its corresponding page and space.
</Accordion>

<Accordion title="Create folder">
  Creates a folder in the space. **\[permissions]\([https://confluence.atlassian.com/x/](https://confluence.atlassian.com/x/) aozkw) required**: permission to view the corresponding space. permission to create a folder in the space.
</Accordion>

<Accordion title="Get blog posts for label">
  Returns the blogposts of specified label. the number of results is limited by the `limit` parameter and additional results (if available) will be available through the `next` url present in the `link` response header. **\[permissions]\([https://confluence.atlassian.com/x/](https://confluence.atlassian.com/x/) aozkw) required**: permission to view the content of the page and its corresponding space.
</Accordion>

<Accordion title="Get all ancestors of database">
  Returns all ancestors for a given database by id in top-to-bottom order (that is, the highest ancestor is the first item in the response payload). the number of results is limited by the `limit` parameter and additional results (if available) will be available by calling this endpoint with the id of first ancestor in the response payload. this endpoint returns minimal information about each ancestor. to fetch more details, use a related endpoint, such as [get database by id](https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-database/#api-databases-id-get). **\[permissions]\([https://confluence.atlassian.com/x/](https://confluence.atlassian.com/x/) aozkw) required**: permission to access the confluence site ('can use' global permission). permission to view the database and its corresponding space
</Accordion>

<Accordion title="Delete content property for attachment by id">
  Deletes a content property for an attachment by its id. **\[permissions]\([https://confluence.atlassian.com/x/](https://confluence.atlassian.com/x/) aozkw) required**: permission to attachment the page.
</Accordion>

<Accordion title="Delete page">
  Delete a page by id. by default this will delete pages that are non-drafts. to delete a page that is a draft, the endpoint must be called on a draft with the following param `draft=true`. discarded drafts are not sent to the trash and are permanently deleted. deleting a page moves the page to the trash, where it can be restored later. to permanently delete a page (or "purge" it), the endpoint must be called on a **trashed** page with the following param `purge=true`. **\[permissions]\([https://confluence.atlassian.com/x/](https://confluence.atlassian.com/x/) aozkw) required**: permission to view the page and its corresponding space. permission to delete pages in the space. permission to administer the space (if attempting to purge).
</Accordion>

<Accordion title="Get all ancestors of folder">
  Returns all ancestors for a given folder by id in top-to-bottom order (that is, the highest ancestor is the first item in the response payload). the number of results is limited by the `limit` parameter and additional results (if available) will be available by calling this endpoint with the id of first ancestor in the response payload. this endpoint returns minimal information about each ancestor. to fetch more details, use a related endpoint, such as [get folder by id](https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-smart-link/#api-folders-id-get). **\[permissions]\([https://confluence.atlassian.com/x/](https://confluence.atlassian.com/x/) aozkw) required**: permission to access the confluence site ('can use' global permission). permission to view the folder and its corresponding space
</Accordion>

<Accordion title="Get child pages">
  Returns all child pages for given page id. the number of results is limited by the `limit` parameter and additional results (if available) will be available through the `next` url present in the `link` response header. **\[permissions]\([https://confluence.atlassian.com/x/](https://confluence.atlassian.com/x/) aozkw) required**: permission to access the confluence site ('can use' global permission). only pages that the user has permission to view will be returned.
</Accordion>

<Accordion title="Get attachment by id">
  Returns a specific attachment. **\[permissions]\([https://confluence.atlassian.com/x/](https://confluence.atlassian.com/x/) aozkw) required**: permission to view the attachment's container.
</Accordion>

<Accordion title="Create footer comment">
  Create a footer comment. the footer comment can be made against several locations: - at the top level (specifying pageid or blogpostid in the request body) - as a reply (specifying parentcommentid in the request body) - against an attachment (note: this is different than the comments added via the attachment properties page on the ui, which are referred to as version comments) - against a custom content **\[permissions]\([https://confluence.atlassian.com/x/](https://confluence.atlassian.com/x/) aozkw) required**: permission to view the content of the page or blogpost and its corresponding space. permission to create comments in the space.
</Accordion>

<Accordion title="Get content property for attachment by id">
  Retrieves a specific content property by id that is attached to a specified attachment. **\[permissions]\([https://confluence.atlassian.com/x/](https://confluence.atlassian.com/x/) aozkw) required**: permission to view the attachment.
</Accordion>

<Accordion title="Delete content property for blogpost by id">
  Deletes a content property for a blogpost by its id. **\[permissions]\([https://confluence.atlassian.com/x/](https://confluence.atlassian.com/x/) aozkw) required**: permission to edit the blog post.
</Accordion>

<Accordion title="Delete space default classification level">
  Returns the [default classification level](https://support.atlassian.com/security-and-access-policies/docs/what-is-a-default-classification-level/) for a specific space. **\[permissions]\([https://confluence.atlassian.com/x/](https://confluence.atlassian.com/x/) aozkw) required**: 'permission to access the confluence site ('can use' global permission) and 'admin' permission for the space.
</Accordion>

<Accordion title="Get content properties for attachment">
  Retrieves all content properties tied to a specified attachment. **\[permissions]\([https://confluence.atlassian.com/x/](https://confluence.atlassian.com/x/) aozkw) required**: permission to view the attachment.
</Accordion>

<Accordion title="Delete smart link in the content tree">
  Delete a smart link in the content tree by id. deleting a smart link in the content tree moves the smart link to the trash, where it can be restored later **\[permissions]\([https://confluence.atlassian.com/x/](https://confluence.atlassian.com/x/) aozkw) required**: permission to view the smart link in the content tree and its corresponding space. permission to delete smart links in the content tree in the space.
</Accordion>

<Accordion title="Delete content property for comment by id">
  Deletes a content property for a comment by its id. **\[permissions]\([https://confluence.atlassian.com/x/](https://confluence.atlassian.com/x/) aozkw) required**: permission to edit the comment.
</Accordion>

<Accordion title="Create smart link in the content tree">
  Creates a smart link in the content tree in the space. **\[permissions]\([https://confluence.atlassian.com/x/](https://confluence.atlassian.com/x/) aozkw) required**: permission to view the corresponding space. permission to create a smart link in the content tree in the space.
</Accordion>

<Accordion title="Delete content property for database by id">
  Deletes a content property for a database by its id. **\[permissions]\([https://confluence.atlassian.com/x/](https://confluence.atlassian.com/x/) aozkw) required**: permission to edit the database.
</Accordion>

<Accordion title="Get attachment comments">
  Returns the comments of the specific attachment. the number of results is limited by the `limit` parameter and additional results (if available) will be available through the `next` url present in the `link` response header. **\[permissions]\([https://confluence.atlassian.com/x/](https://confluence.atlassian.com/x/) aozkw) required**: permission to view the attachment and its corresponding containers.
</Accordion>

<Accordion title="Delete content property for page by id">
  Deletes a content property for a page by its id. **\[permissions]\([https://confluence.atlassian.com/x/](https://confluence.atlassian.com/x/) aozkw) required**: permission to edit the page.
</Accordion>

<Accordion title="Create page">
  Creates a page in the space. pages are created as published by default unless specified as a draft in the status field. if creating a published page, the title must be specified. **\[permissions]\([https://confluence.atlassian.com/x/](https://confluence.atlassian.com/x/) aozkw) required**: permission to view the corresponding space. permission to create a page in the space.
</Accordion>

<Accordion title="Delete content property for folder by id">
  Deletes a content property for a folder by its id. **\[permissions]\([https://confluence.atlassian.com/x/](https://confluence.atlassian.com/x/) aozkw) required**: permission to edit the folder.
</Accordion>

<Accordion title="Delete content property for custom content by id">
  Deletes a content property for a piece of custom content by its id. **\[permissions]\([https://confluence.atlassian.com/x/](https://confluence.atlassian.com/x/) aozkw) required**: permission to edit the custom content.
</Accordion>

<Accordion title="Create inline comment">
  Create an inline comment. this can be at the top level (specifying pageid or blogpostid in the request body) or as a reply (specifying parentcommentid in the request body). note the inlinecommentproperties object in the request body is used to select the text the inline comment should be tied to. this is what determines the text highlighting when viewing a page in confluence. **\[permissions]\([https://confluence.atlassian.com/x/](https://confluence.atlassian.com/x/) aozkw) required**: permission to view the content of the page or blogpost and its corresponding space. permission to create comments in the space.
</Accordion>

<Accordion title="Get permitted operations for attachment">
  Returns the permitted operations on specific attachment. **\[permissions]\([https://confluence.atlassian.com/x/](https://confluence.atlassian.com/x/) aozkw) required**: permission to view the parent content of the attachment and its corresponding space.
</Accordion>

<Accordion title="Get page versions">
  Returns the versions of specific page. **\[permissions]\([https://confluence.atlassian.com/x/](https://confluence.atlassian.com/x/) aozkw) required**: permission to view the page and its corresponding space.
</Accordion>

<Accordion title="Get folder by id">
  Returns a specific folder. **\[permissions]\([https://confluence.atlassian.com/x/](https://confluence.atlassian.com/x/) aozkw) required**: permission to view the folder and its corresponding space.
</Accordion>

<Accordion title="Get database by id">
  Returns a specific database. **\[permissions]\([https://confluence.atlassian.com/x/](https://confluence.atlassian.com/x/) aozkw) required**: permission to view the database and its corresponding space.
</Accordion>

<Accordion title="Get like count for blog post">
  Returns the count of likes of specific blog post. **\[permissions]\([https://confluence.atlassian.com/x/](https://confluence.atlassian.com/x/) aozkw) required**: permission to view the content of the blog post and its corresponding space.
</Accordion>

<Accordion title="Get labels for space content">
  Returns the labels of space content (pages, blogposts etc). the number of results is limited by the `limit` parameter and additional results (if available) will be available through the `next` url present in the `link` response header. **\[permissions]\([https://confluence.atlassian.com/x/](https://confluence.atlassian.com/x/) aozkw) required**: permission to view the space. only labels that the user has permission to view will be returned.
</Accordion>

<Accordion title="Get database classification level">
  Returns the [classification level](https://developer.atlassian.com/cloud/admin/dlp/rest/intro/#classification%20level) for a specific database. **\[permissions]\([https://confluence.atlassian.com/x/](https://confluence.atlassian.com/x/) aozkw) required**: 'permission to access the confluence site ('can use' global permission) and permission to view the database.
</Accordion>

<Accordion title="Get permitted operations for page">
  Returns the permitted operations on specific page. **\[permissions]\([https://confluence.atlassian.com/x/](https://confluence.atlassian.com/x/) aozkw) required**: permission to view the parent content of the page and its corresponding space.
</Accordion>

<Accordion title="Get permitted operations for space">
  Returns the permitted operations on specific space. **\[permissions]\([https://confluence.atlassian.com/x/](https://confluence.atlassian.com/x/) aozkw) required**: permission to view the corresponding space.
</Accordion>

<Accordion title="Get space role assignments">
  Retrieves the space role assignments. **\[permissions]\([https://confluence.atlassian.com/x/](https://confluence.atlassian.com/x/) aozkw) required**: permission to view the space.
</Accordion>

<Accordion title="Get space property by id">
  Retrieve a space property by its id. **\[permissions]\([https://confluence.atlassian.com/x/](https://confluence.atlassian.com/x/) aozkw) required**: permission to access the confluence site ('can use' global permission) and 'view' permission for the space.
</Accordion>

<Accordion title="Get footer comment by id">
  Retrieves a footer comment by id **\[permissions]\([https://confluence.atlassian.com/x/](https://confluence.atlassian.com/x/) aozkw) required**: permission to view the content of the container and its corresponding space.
</Accordion>

<Accordion title="Get inline comments">
  Returns all inline comments. the number of results is limited by the `limit` parameter and additional results (if available) will be available through the `next` url present in the `link` response header. **\[permissions]\([https://confluence.atlassian.com/x/](https://confluence.atlassian.com/x/) aozkw) required**: permission to view the content of the page and its corresponding space.
</Accordion>

<Accordion title="Get data policy metadata for the workspace">
  Returns data policy metadata for the workspace. **[permissions](#permissions) required:** only apps can make this request. permission to access the confluence site ('can use' global permission).
</Accordion>

<Accordion title="Get footer comments for blog post">
  Returns the root footer comments of specific blog post. the number of results is limited by the `limit` parameter and additional results (if available) will be available through the `next` url present in the `link` response header. **\[permissions]\([https://confluence.atlassian.com/x/](https://confluence.atlassian.com/x/) aozkw) required**: permission to view the content of the blog post and its corresponding space.
</Accordion>

<Accordion title="Get footer comment versions">
  Retrieves the versions of the specified footer comment. **\[permissions]\([https://confluence.atlassian.com/x/](https://confluence.atlassian.com/x/) aozkw) required**: permission to view the content of the page or blog post and its corresponding space.
</Accordion>

<Accordion title="Get footer comments">
  Returns all footer comments. the number of results is limited by the `limit` parameter and additional results (if available) will be available through the `next` url present in the `link` response header. **\[permissions]\([https://confluence.atlassian.com/x/](https://confluence.atlassian.com/x/) aozkw) required**: permission to view the content of the container and its corresponding space.
</Accordion>

<Accordion title="Get space role by id">
  Retrieves the space role by id. **\[permissions]\([https://confluence.atlassian.com/x/](https://confluence.atlassian.com/x/) aozkw) required**: permission to access the confluence site.
</Accordion>

<Accordion title="Get version details for inline comment version">
  Retrieves version details for the specified inline comment version. **\[permissions]\([https://confluence.atlassian.com/x/](https://confluence.atlassian.com/x/) aozkw) required**: permission to view the content of the page or blog post and its corresponding space.
</Accordion>

<Accordion title="Get version details for page version">
  Retrieves version details for the specified page and version number. **\[permissions]\([https://confluence.atlassian.com/x/](https://confluence.atlassian.com/x/) aozkw) required**: permission to view the page.
</Accordion>

<Accordion title="Get whiteboard classification level">
  Returns the [classification level](https://developer.atlassian.com/cloud/admin/dlp/rest/intro/#classification%20level) for a specific whiteboard. **\[permissions]\([https://confluence.atlassian.com/x/](https://confluence.atlassian.com/x/) aozkw) required**: 'permission to access the confluence site ('can use' global permission) and permission to view the whiteboard.
</Accordion>

<Accordion title="Get smart link in the content tree by id">
  Returns a specific smart link in the content tree. **\[permissions]\([https://confluence.atlassian.com/x/](https://confluence.atlassian.com/x/) aozkw) required**: permission to view the smart link in the content tree and its corresponding space.
</Accordion>

<Accordion title="Get like count for footer comment">
  Returns the count of likes of specific footer comment. **\[permissions]\([https://confluence.atlassian.com/x/](https://confluence.atlassian.com/x/) aozkw) required**: permission to view the content of the page/blogpost and its corresponding space.
</Accordion>

<Accordion title="Reset blog post classification level">
  Resets the [classification level](https://developer.atlassian.com/cloud/admin/dlp/rest/intro/#classification%20level) for a specific blog post for the space [default classification level](https://support.atlassian.com/security-and-access-policies/docs/what-is-a-default-classification-level/). **\[permissions]\([https://confluence.atlassian.com/x/](https://confluence.atlassian.com/x/) aozkw) required**: 'permission to access the confluence site ('can use' global permission) and permission to view the blog post.
</Accordion>

<Accordion title="Get spaces with data policies">
  Returns all spaces. the results will be sorted by id ascending. the number of results is limited by the `limit` parameter and additional results (if available) will be available through the `next` url present in the `link` response header. **\[permissions]\([https://confluence.atlassian.com/x/](https://confluence.atlassian.com/x/) aozkw) required**: only apps can make this request. permission to access the confluence site ('can use' global permission). only spaces that the app has permission to view will be returned.
</Accordion>

<Accordion title="Reset whiteboard classification level">
  Resets the [classification level](https://developer.atlassian.com/cloud/admin/dlp/rest/intro/#classification%20level) for a specific whiteboard for the space [default classification level](https://support.atlassian.com/security-and-access-policies/docs/what-is-a-default-classification-level/). **\[permissions]\([https://confluence.atlassian.com/x/](https://confluence.atlassian.com/x/) aozkw) required**: 'permission to access the confluence site ('can use' global permission) and permission to view the whiteboard.
</Accordion>

<Accordion title="Invite a list of emails to the site">
  Invite a list of emails to the site. ignores all invalid emails and no action is taken for the emails that already have access to the site. \<b>note:\</b> this api is asynchronous and may take some time to complete. **\[permissions]\([https://confluence.atlassian.com/x/](https://confluence.atlassian.com/x/) aozkw) required**: permission to access the confluence site ('can use' global permission).
</Accordion>

<Accordion title="Reset database classification level">
  Resets the [classification level](https://developer.atlassian.com/cloud/admin/dlp/rest/intro/#classification%20level) for a specific database for the space [default classification level](https://support.atlassian.com/security-and-access-policies/docs/what-is-a-default-classification-level/). **\[permissions]\([https://confluence.atlassian.com/x/](https://confluence.atlassian.com/x/) aozkw) required**: 'permission to access the confluence site ('can use' global permission) and permission to view the database.
</Accordion>

<Accordion title="Get spaces">
  Returns all spaces. the results will be sorted by id ascending. the number of results is limited by the `limit` parameter and additional results (if available) will be available through the `next` url present in the `link` response header. **\[permissions]\([https://confluence.atlassian.com/x/](https://confluence.atlassian.com/x/) aozkw) required**: permission to access the confluence site ('can use' global permission). only spaces that the user has permission to view will be returned.
</Accordion>

<Accordion title="Get footer comments for page">
  Returns the root footer comments of specific page. the number of results is limited by the `limit` parameter and additional results (if available) will be available through the `next` url present in the `link` response header. **\[permissions]\([https://confluence.atlassian.com/x/](https://confluence.atlassian.com/x/) aozkw) required**: permission to view the content of the page and its corresponding space.
</Accordion>

<Accordion title="Get inline comments for blog post">
  Returns the root inline comments of specific blog post. the number of results is limited by the `limit` parameter and additional results (if available) will be available through the `next` url present in the `link` response header. **\[permissions]\([https://confluence.atlassian.com/x/](https://confluence.atlassian.com/x/) aozkw) required**: permission to view the content of the blog post and its corresponding space.
</Accordion>

<Accordion title="Get tasks">
  Returns all tasks. the number of results is limited by the `limit` parameter and additional results (if available) will be available through the `next` url present in the `link` response header. **\[permissions]\([https://confluence.atlassian.com/x/](https://confluence.atlassian.com/x/) aozkw) required**: permission to access the confluence site ('can use' global permission). only tasks that the user has permission to view will be returned.
</Accordion>

<Accordion title="Get whiteboard by id">
  Returns a specific whiteboard. **\[permissions]\([https://confluence.atlassian.com/x/](https://confluence.atlassian.com/x/) aozkw) required**: permission to view the whiteboard and its corresponding space.
</Accordion>

<Accordion title="Reset page classification level">
  Resets the [classification level](https://developer.atlassian.com/cloud/admin/dlp/rest/intro/#classification%20level) for a specific page for the space [default classification level](https://support.atlassian.com/security-and-access-policies/docs/what-is-a-default-classification-level/). **\[permissions]\([https://confluence.atlassian.com/x/](https://confluence.atlassian.com/x/) aozkw) required**: 'permission to access the confluence site ('can use' global permission) and permission to view the page.
</Accordion>

<Accordion title="Update blog post">
  Update a blog post by id. **\[permissions]\([https://confluence.atlassian.com/x/](https://confluence.atlassian.com/x/) aozkw) required**: permission to view the blog post and its corresponding space. permission to update blog posts in the space.
</Accordion>

<Accordion title="Update content property for page by id">
  Update a content property for a page by its id. **\[permissions]\([https://confluence.atlassian.com/x/](https://confluence.atlassian.com/x/) aozkw) required**: permission to edit the page.
</Accordion>

<Accordion title="Get task by id">
  Returns a specific task. **\[permissions]\([https://confluence.atlassian.com/x/](https://confluence.atlassian.com/x/) aozkw) required**: permission to view the containing page or blog post and its corresponding space.
</Accordion>

<Accordion title="Set space role assignments">
  Sets space role assignments as specified in the payload. **\[permissions]\([https://confluence.atlassian.com/x/](https://confluence.atlassian.com/x/) aozkw) required**: permission to manage roles in the space.
</Accordion>

<Accordion title="Get space by id">
  Returns a specific space. **\[permissions]\([https://confluence.atlassian.com/x/](https://confluence.atlassian.com/x/) aozkw) required**: permission to view the space.
</Accordion>

<Accordion title="Update content property for blog post by id">
  Update a content property for blog post by its id. **\[permissions]\([https://confluence.atlassian.com/x/](https://confluence.atlassian.com/x/) aozkw) required**: permission to edit the blog post.
</Accordion>

<Accordion title="Update content property for folder by id">
  Update a content property for a folder by its id. **\[permissions]\([https://confluence.atlassian.com/x/](https://confluence.atlassian.com/x/) aozkw) required**: permission to edit the folder.
</Accordion>

<Accordion title="Search Content">
  Searches for content using the confluence query language (cql).
</Accordion>

<Accordion title="Update footer comment">
  Update a footer comment. this can be used to update the body text of a comment. **\[permissions]\([https://confluence.atlassian.com/x/](https://confluence.atlassian.com/x/) aozkw) required**: permission to view the content of the page or blogpost and its corresponding space. permission to create comments in the space.
</Accordion>

<Accordion title="Update database classification level">
  Updates the [classification level](https://developer.atlassian.com/cloud/admin/dlp/rest/intro/#classification%20level) for a specific database. **\[permissions]\([https://confluence.atlassian.com/x/](https://confluence.atlassian.com/x/) aozkw) required**: 'permission to access the confluence site ('can use' global permission) and permission to edit the database.
</Accordion>

<Accordion title="Update inline comment">
  Update an inline comment. this can be used to update the body text of a comment and/or to resolve the comment **\[permissions]\([https://confluence.atlassian.com/x/](https://confluence.atlassian.com/x/) aozkw) required**: permission to view the content of the page or blogpost and its corresponding space. permission to create comments in the space.
</Accordion>

<Accordion title="Get space default classification level">
  Returns the [default classification level](https://support.atlassian.com/security-and-access-policies/docs/what-is-a-default-classification-level/) for a specific space. **\[permissions]\([https://confluence.atlassian.com/x/](https://confluence.atlassian.com/x/) aozkw) required**: 'permission to access the confluence site ('can use' global permission) and permission to view the space.
</Accordion>

<Accordion title="Update content property for whiteboard by id">
  Update a content property for a whiteboard by its id. **\[permissions]\([https://confluence.atlassian.com/x/](https://confluence.atlassian.com/x/) aozkw) required**: permission to edit the whiteboard.
</Accordion>

<Accordion title="Update content property for smart link in the content tree by id">
  Update a content property for a smart link in the content tree by its id. **\[permissions]\([https://confluence.atlassian.com/x/](https://confluence.atlassian.com/x/) aozkw) required**: permission to edit the smart link in the content tree.
</Accordion>

<Accordion title="Get permitted operations for a database">
  Returns the permitted operations on specific database. **\[permissions]\([https://confluence.atlassian.com/x/](https://confluence.atlassian.com/x/) aozkw) required**: permission to view the database and its corresponding space.
</Accordion>

<Accordion title="Update blog post classification level">
  Updates the [classification level](https://developer.atlassian.com/cloud/admin/dlp/rest/intro/#classification%20level) for a specific blog post. **\[permissions]\([https://confluence.atlassian.com/x/](https://confluence.atlassian.com/x/) aozkw) required**: 'permission to access the confluence site ('can use' global permission) and permission to edit the blog post.
</Accordion>

<Accordion title="Update content property for comment by id">
  Update a content property for a comment by its id. **\[permissions]\([https://confluence.atlassian.com/x/](https://confluence.atlassian.com/x/) aozkw) required**: permission to edit the comment.
</Accordion>

<Accordion title="Update space property by id">
  Update a space property by its id. **\[permissions]\([https://confluence.atlassian.com/x/](https://confluence.atlassian.com/x/) aozkw) required**: permission to access the confluence site ('can use' global permission) and 'admin' permission for the space.
</Accordion>

<Accordion title="Update page">
  Update a page by id. when the "current" version is updated, the provided body content is considered as the latest version. this latest body content will be attempted to be merged into the draft version through a content reconciliation algorithm. if two versions are significantly diverged, the latest provided content may entirely override what was previously in the draft. **\[permissions]\([https://confluence.atlassian.com/x/](https://confluence.atlassian.com/x/) aozkw) required**: permission to view the page and its corresponding space. permission to update pages in the space.
</Accordion>

<Accordion title="Get version details for attachment version">
  Retrieves version details for the specified attachment and version number. **\[permissions]\([https://confluence.atlassian.com/x/](https://confluence.atlassian.com/x/) aozkw) required**: permission to view the attachment.
</Accordion>

<Accordion title="Update page classification level">
  Updates the [classification level](https://developer.atlassian.com/cloud/admin/dlp/rest/intro/#classification%20level) for a specific page. **\[permissions]\([https://confluence.atlassian.com/x/](https://confluence.atlassian.com/x/) aozkw) required**: 'permission to access the confluence site ('can use' global permission) and permission to edit the page.
</Accordion>

<Accordion title="Update space default classification level">
  Update the [default classification level](https://support.atlassian.com/security-and-access-policies/docs/what-is-a-default-classification-level/) for a specific space. **\[permissions]\([https://confluence.atlassian.com/x/](https://confluence.atlassian.com/x/) aozkw) required**: 'permission to access the confluence site ('can use' global permission) and 'admin' permission for the space.
</Accordion>

<Accordion title="Get space permissions assignments">
  Returns space permission assignments for a specific space. **\[permissions]\([https://confluence.atlassian.com/x/](https://confluence.atlassian.com/x/) aozkw) required**: permission to view the space.
</Accordion>

<Accordion title="Update custom content">
  Update a custom content by id. `spaceid` is always required and maximum one of `pageid`, `blogpostid`, or `customcontentid` is allowed in the request body. **\[permissions]\([https://confluence.atlassian.com/x/](https://confluence.atlassian.com/x/) aozkw) required**: permission to view the content of the page or blogpost and its corresponding space. permission to update custom content in the space.
</Accordion>

<Accordion title="Update task">
  Update a task by id. this endpoint currently only supports updating task status. **\[permissions]\([https://confluence.atlassian.com/x/](https://confluence.atlassian.com/x/) aozkw) required**: permission to edit the containing page or blog post and view its corresponding space.
</Accordion>

<Accordion title="Update whiteboard classification level">
  Updates the [classification level](https://developer.atlassian.com/cloud/admin/dlp/rest/intro/#classification%20level) for a specific whiteboard. **\[permissions]\([https://confluence.atlassian.com/x/](https://confluence.atlassian.com/x/) aozkw) required**: 'permission to access the confluence site ('can use' global permission) and permission to edit the whiteboard.
</Accordion>

<Accordion title="Update content property for attachment by id">
  Update a content property for attachment by its id. **\[permissions]\([https://confluence.atlassian.com/x/](https://confluence.atlassian.com/x/) aozkw) required**: permission to edit the attachment.
</Accordion>

<Accordion title="Get permitted operations for a folder">
  Returns the permitted operations on specific folder. **\[permissions]\([https://confluence.atlassian.com/x/](https://confluence.atlassian.com/x/) aozkw) required**: permission to view the folder and its corresponding space.
</Accordion>

<Accordion title="Get space properties in space">
  Returns all properties for the given space. space properties are a key-value storage associated with a space. the limit parameter specifies the maximum number of results returned in a single response. use the `link` response header to paginate through additional results. **\[permissions]\([https://confluence.atlassian.com/x/](https://confluence.atlassian.com/x/) aozkw) required**: permission to access the confluence site ('can use' global permission) and 'view' permission for the space.
</Accordion>

<Accordion title="Get version details for blog post version">
  Retrieves version details for the specified blog post and version number. **\[permissions]\([https://confluence.atlassian.com/x/](https://confluence.atlassian.com/x/) aozkw) required**: permission to view the blog post.
</Accordion>

<Accordion title="Update content property for custom content by id">
  Update a content property for a piece of custom content by its id. **\[permissions]\([https://confluence.atlassian.com/x/](https://confluence.atlassian.com/x/) aozkw) required**: permission to edit the custom content.
</Accordion>

<Accordion title="Get like count for inline comment">
  Returns the count of likes of specific inline comment. **\[permissions]\([https://confluence.atlassian.com/x/](https://confluence.atlassian.com/x/) aozkw) required**: permission to view the content of the page/blogpost and its corresponding space.
</Accordion>

<Accordion title="Get list of classification levels">
  Returns a list of [classification levels](https://developer.atlassian.com/cloud/admin/dlp/rest/intro/#classification%20level) available. **\[permissions]\([https://confluence.atlassian.com/x/](https://confluence.atlassian.com/x/) aozkw) required**: 'permission to access the confluence site ('can use' global permission).
</Accordion>

<Accordion title="Get like count for page">
  Returns the count of likes of specific page. **\[permissions]\([https://confluence.atlassian.com/x/](https://confluence.atlassian.com/x/) aozkw) required**: permission to view the content of the page and its corresponding space.
</Accordion>

<Accordion title="Search Users">
  Searches for users using user-specific queries from the confluence query language (cql).
</Accordion>

<Accordion title="Get pages">
  Returns all pages. the number of results is limited by the `limit` parameter and additional results (if available) will be available through the `next` url present in the `link` response header. **\[permissions]\([https://confluence.atlassian.com/x/](https://confluence.atlassian.com/x/) aozkw) required**: permission to access the confluence site ('can use' global permission). only pages that the user has permission to view will be returned.
</Accordion>

<Accordion title="Get inline comments for page">
  Returns the root inline comments of specific page. the number of results is limited by the `limit` parameter and additional results (if available) will be available through the `next` url present in the `link` response header. **\[permissions]\([https://confluence.atlassian.com/x/](https://confluence.atlassian.com/x/) aozkw) required**: permission to view the content of the page and its corresponding space.
</Accordion>

<Accordion title="Get pages in space">
  Returns all pages in a space. the number of results is limited by the `limit` parameter and additional results (if available) will be available through the `next` url present in the `link` response header. **\[permissions]\([https://confluence.atlassian.com/x/](https://confluence.atlassian.com/x/) aozkw) required**: permission to access the confluence site ('can use' global permission) and 'view' permission for the space. only pages that the user has permission to view will be returned.
</Accordion>

<Accordion title="Get page classification level">
  Returns the [classification level](https://developer.atlassian.com/cloud/admin/dlp/rest/intro/#classification%20level) for a specific page. **\[permissions]\([https://confluence.atlassian.com/x/](https://confluence.atlassian.com/x/) aozkw) required**: 'permission to access the confluence site ('can use' global permission) and permission to view the page. 'permission to edit the page is required if trying to view classification level for a draft.
</Accordion>

<Accordion title="Get inline comment by id">
  Retrieves an inline comment by id **\[permissions]\([https://confluence.atlassian.com/x/](https://confluence.atlassian.com/x/) aozkw) required**: permission to view the content of the page or blogpost and its corresponding space.
</Accordion>

<Accordion title="Update content property for database by id">
  Update a content property for a database by its id. **\[permissions]\([https://confluence.atlassian.com/x/](https://confluence.atlassian.com/x/) aozkw) required**: permission to edit the database.
</Accordion>

<Accordion title="Get version details for custom content version">
  Retrieves version details for the specified custom content and version number. **\[permissions]\([https://confluence.atlassian.com/x/](https://confluence.atlassian.com/x/) aozkw) required**: permission to view the page.
</Accordion>

<Accordion title="Get labels">
  Returns all labels. the number of results is limited by the `limit` parameter and additional results (if available) will be available through the `next` url present in the `link` response header. **\[permissions]\([https://confluence.atlassian.com/x/](https://confluence.atlassian.com/x/) aozkw) required**: permission to access the confluence site ('can use' global permission). only labels that the user has permission to view will be returned.
</Accordion>

<Accordion title="Get inline comment versions">
  Retrieves the versions of the specified inline comment. **\[permissions]\([https://confluence.atlassian.com/x/](https://confluence.atlassian.com/x/) aozkw) required**: permission to view the content of the page or blog post and its corresponding space.
</Accordion>

<Accordion title="Get pages for label">
  Returns the pages of specified label. the number of results is limited by the `limit` parameter and additional results (if available) will be available through the `next` url present in the `link` response header. **\[permissions]\([https://confluence.atlassian.com/x/](https://confluence.atlassian.com/x/) aozkw) required**: permission to view the content of the page and its corresponding space.
</Accordion>

<Accordion title="Get labels for custom content">
  Returns the labels for a specific piece of custom content. the number of results is limited by the `limit` parameter and additional results (if available) will be available through the `next` url present in the `link` response header. **\[permissions]\([https://confluence.atlassian.com/x/](https://confluence.atlassian.com/x/) aozkw) required**: permission to view the custom content and its corresponding space. only labels that the user has permission to view will be returned.
</Accordion>

<Accordion title="Get page by id">
  Returns a specific page. **\[permissions]\([https://confluence.atlassian.com/x/](https://confluence.atlassian.com/x/) aozkw) required**: permission to view the page and its corresponding space.
</Accordion>

<Accordion title="Get labels for page">
  Returns the labels of specific page. the number of results is limited by the `limit` parameter and additional results (if available) will be available through the `next` url present in the `link` response header. **\[permissions]\([https://confluence.atlassian.com/x/](https://confluence.atlassian.com/x/) aozkw) required**: permission to view the content of the page and its corresponding space. only labels that the user has permission to view will be returned.
</Accordion>

<Accordion title="Get permitted operations for blog post">
  Returns the permitted operations on specific blog post. **\[permissions]\([https://confluence.atlassian.com/x/](https://confluence.atlassian.com/x/) aozkw) required**: permission to view the parent content of the blog post and its corresponding space.
</Accordion>

<Accordion title="Get labels for blog post">
  Returns the labels of specific blog post. the number of results is limited by the `limit` parameter and additional results (if available) will be available through the `next` url present in the `link` response header. **\[permissions]\([https://confluence.atlassian.com/x/](https://confluence.atlassian.com/x/) aozkw) required**: permission to view the content of the blog post and its corresponding space. only labels that the user has permission to view will be returned.
</Accordion>

<Accordion title="Get permitted operations for a smart link in the content tree">
  Returns the permitted operations on specific smart link in the content tree. **\[permissions]\([https://confluence.atlassian.com/x/](https://confluence.atlassian.com/x/) aozkw) required**: permission to view the smart link in the content tree and its corresponding space.
</Accordion>

<Accordion title="Get permitted operations for a whiteboard">
  Returns the permitted operations on specific whiteboard. **\[permissions]\([https://confluence.atlassian.com/x/](https://confluence.atlassian.com/x/) aozkw) required**: permission to view the whiteboard and its corresponding space.
</Accordion>

<Accordion title="Get labels for space">
  Returns the labels of specific space. the number of results is limited by the `limit` parameter and additional results (if available) will be available through the `next` url present in the `link` response header. **\[permissions]\([https://confluence.atlassian.com/x/](https://confluence.atlassian.com/x/) aozkw) required**: permission to view the space. only labels that the user has permission to view will be returned.
</Accordion>

<Accordion title="Get permitted operations for footer comment">
  Returns the permitted operations on specific footer comment. **\[permissions]\([https://confluence.atlassian.com/x/](https://confluence.atlassian.com/x/) aozkw) required**: permission to view the parent content of the footer comment and its corresponding space.
</Accordion>

<Accordion title="Get permitted operations for inline comment">
  Returns the permitted operations on specific inline comment. **\[permissions]\([https://confluence.atlassian.com/x/](https://confluence.atlassian.com/x/) aozkw) required**: permission to view the parent content of the inline comment and its corresponding space.
</Accordion>

<Accordion title="Get version details for footer comment version">
  Retrieves version details for the specified footer comment version. **\[permissions]\([https://confluence.atlassian.com/x/](https://confluence.atlassian.com/x/) aozkw) required**: permission to view the content of the page or blog post and its corresponding space.
</Accordion>

<Accordion title="Get labels for attachment">
  Returns the labels of specific attachment. the number of results is limited by the `limit` parameter and additional results (if available) will be available through the `next` url present in the `link` response header. **\[permissions]\([https://confluence.atlassian.com/x/](https://confluence.atlassian.com/x/) aozkw) required**: permission to view the parent content of the attachment and its corresponding space. only labels that the user has permission to view will be returned.
</Accordion>

<Accordion title="Get permitted operations for custom content">
  Returns the permitted operations on specific custom content. **\[permissions]\([https://confluence.atlassian.com/x/](https://confluence.atlassian.com/x/) aozkw) required**: permission to view the parent content of the custom content and its corresponding space.
</Accordion>


# Contentful
Source: https://docs.push.ai/integrations/contentful



Contentful provides a content platform with APIs for managing and
delivering content to apps and websites.

<Accordion title="Update space">
  Updates the name of a specific space. notes: - the version number is required to ensure you're updating the latest version of the space. - you can get the current version from the sys.version field when fetching space details. - only the name of the space can be updated.
</Accordion>

<Accordion title="Get space">
  Retrieves details of a specific space by its id. this action is used to get information about a single space in contentful.
</Accordion>

<Accordion title="List spaces">
  Lists all spaces that the authenticated user has access to in contentful. this is a fundamental operation needed before performing any other content management actions since most operations require a space id.
</Accordion>


# Crustdata
Source: https://docs.push.ai/integrations/crustdata



CrustData is an AI-powered data intelligence platform that provides real-time company and people data via APIs and webhooks, empowering B2B sales teams, AI SDRs, and investors to act on live signals

<Accordion title="Filter decision makers data">
  Filters and retrieves decision maker data from the crustdata b2b saas integration platform based on complex criteria. this endpoint allows for advanced querying of decision maker information using a combination of filters, pagination, sorting, and title-based filtering. it's designed for scenarios where specific subsets of decision maker data need to be extracted or analyzed. the endpoint supports nested logical conditions in filters, enabling highly targeted data retrieval. use this when you need to perform detailed analysis or reporting on decision makers across various organizations or industries. note that the endpoint requires careful structuring of the request body to effectively utilize its advanced filtering capabilities.
</Accordion>

<Accordion title="Fetch investor portfolio data">
  Retrieves comprehensive investor portfolio data from the data lab section of the crustdata api. this endpoint provides access to detailed information about investor portfolios, including investment holdings, performance metrics, and other relevant data points. it is designed to support investment analysis, portfolio management, and decision-making processes in a b2b context. the endpoint should be used when detailed investor portfolio information is required for tasks such as investment screening, performance tracking, or generating analytical reports. it's important to note that this endpoint may not provide real-time data and the frequency of updates should be verified in the api documentation. additionally, users should be aware of any data privacy and usage restrictions that may apply to the retrieved investor information.
</Accordion>

<Accordion title="Enrich person screener">
  The screener person enrich endpoint enriches person data by providing additional information based on the given query. it allows users to retrieve detailed information about individuals, which can be useful for various purposes such as customer profiling, lead generation, or data verification. this endpoint should be used when you need to augment existing person data with additional details or verify information about a specific individual. the enrichment process draws from crustdata's extensive database and real-time data sources to provide up-to-date and comprehensive information. users can customize the response by specifying the exact fields they need, optimizing data transfer and processing. note that the availability and accuracy of enriched data may vary depending on the input provided and the information available in crustdata's systems.
</Accordion>

<Accordion title="Fetch headcount by facet timeseries">
  Retrieves headcount data as a timeseries with faceted analysis capabilities. this endpoint allows users to fetch detailed headcount information over time, applying complex filters, pagination, and sorting. it's particularly useful for hr analytics, workforce planning, and organizational growth analysis. the endpoint supports nested logical operations in its filtering mechanism, enabling highly specific queries. users can paginate through large datasets and sort results based on multiple criteria. while powerful, this endpoint requires careful construction of the filters parameter to ensure accurate data retrieval. it should be used when detailed, time-based headcount analysis is needed, but may not be suitable for simple, non-time-series headcount queries or for real-time data needs due to its complexity.
</Accordion>

<Accordion title="Post funding milestone timeseries data">
  The fundingmilestonetimeseries endpoint retrieves time-series data related to funding milestones for companies. it allows for complex querying of funding events over time, with flexible filtering, pagination, and sorting options. this endpoint is particularly useful for analyzing funding trends, comparing company funding histories, or tracking specific funding events across multiple organizations. the data returned is based on the specified filters and can be tailored to focus on particular time ranges, funding stages, or company characteristics. while it provides comprehensive funding milestone data, it does not include detailed company information beyond what's directly related to funding events.
</Accordion>

<Accordion title="Post web traffic data">
  Retrieves filtered and sorted web traffic data from the crustdata platform. this endpoint allows for complex querying of web traffic information using nested conditions and logical operators. it supports pagination for handling large datasets and provides sorting capabilities for customized data presentation. use this endpoint when you need to analyze web traffic patterns, filter data based on specific criteria, or extract insights from your web analytics. the endpoint is particularly useful for generating reports, identifying trends, or monitoring key performance indicators related to web traffic.
</Accordion>

<Accordion title="Retrieve linkedin posts">
  Retrieves linkedin posts for a specified company using crustdata's screener functionality. this endpoint allows users to gather social media data from linkedin, which can be used for analyzing company activity, engagement, and sentiment. it's particularly useful for b2b marketers, sales professionals, and analysts who need insights into a company's social media presence and content strategy. the endpoint supports filtering by date range and customizing the response fields, making it versatile for various use cases such as competitive analysis, lead generation, and market research. note that the availability and completeness of data may depend on the company's linkedin activity and privacy settings.
</Accordion>

<Accordion title="Post job listings table data">
  This endpoint retrieves filtered and sorted job listings data for specified company tickers from a chosen dataset in the crustdata platform. it allows for highly customizable queries with complex filtering conditions, pagination, and sorting options. the endpoint is designed for bulk data retrieval and analysis of job market trends across multiple companies. use this endpoint when you need to fetch and analyze job listing data for specific companies, apply custom filters to narrow down the results, or when you want to paginate through large sets of job data. it's particularly useful for market research, competitive analysis, or tracking employment trends in specific industries or companies. note that this endpoint requires careful construction of the request body, especially for the filters parameter, which can support nested logical conditions. the performance and response time may vary depending on the complexity of the filters and the amount of data requested.
</Accordion>

<Accordion title="Post headcount timeseries data">
  Retrieves filtered and sorted headcount timeseries data from the crustdata data lab. this endpoint allows for complex querying of historical headcount information, enabling users to analyze workforce trends over time. it supports advanced filtering with nested conditions, pagination for handling large datasets, and customizable sorting. ideal for generating reports, conducting workforce analysis, or integrating headcount data into third-party business intelligence tools. note that the specifics of the returned data structure are not provided in the given schema.
</Accordion>

<Accordion title="Search companies with filters">
  The companysearch endpoint enables users to search and filter companies using the crustdata api. it provides a powerful mechanism for querying company data based on multiple criteria, supporting complex filtering and pagination. this endpoint is ideal for applications that need to retrieve specific sets of company information, such as financial analysis tools, market research platforms, or business intelligence systems. the search functionality allows for precise data retrieval, enhancing the efficiency of data integration and analysis processes in b2b scenarios. users should be aware that the endpoint requires careful construction of filter objects and proper use of pagination to ensure optimal performance and accurate results.
</Accordion>

<Accordion title="Search linkedin posts by keyword">
  This endpoint enables searching for linkedin posts using a specific keyword. it allows users to retrieve relevant content from linkedin by specifying a search term, along with options for pagination, sorting, and filtering by post date. the function is particularly useful for conducting market research, competitor analysis, or tracking industry trends on the linkedin platform. users can fine-tune their search results by choosing how to sort the posts (by relevance or date) and selecting a specific time frame for the content. the endpoint returns paginated results, allowing for efficient navigation through large sets of matching posts.
</Accordion>

<Accordion title="Screener company information">
  The getcompanyscreener endpoint allows users to search and filter companies based on various criteria such as headcount, growth rate, funding, and more. it provides a powerful way to identify specific companies that meet predefined conditions. this endpoint is particularly useful for tasks like lead generation, market research, and competitive analysis. the endpoint returns a list of companies matching the specified criteria, with each company entry containing key information such as name, industry, headcount, funding details, and growth metrics. users can customize their search using multiple filters, sort the results, and paginate through large result sets. note that the accuracy of the data depends on crustdata's real-time data collection and update frequency.
</Accordion>

<Accordion title="Search for job id in screener">
  The screener person search endpoint allows users to search for persons associated with a specific job id within the crustdata b2b saas integration platform. this post request accepts a json payload containing a job id and returns relevant person data linked to that job. it's particularly useful for scenarios where you need to quickly retrieve all individuals connected to a particular job or project. the endpoint is part of the platform's screening functionality, enabling efficient filtering of person records based on job-related criteria. while it provides a focused search based on job id, it may not offer advanced filtering options or return comprehensive job details.
</Accordion>

<Accordion title="Screen metrics and filter conditions">
  The screendata endpoint enables advanced data screening and filtering on the crustdata platform. it allows users to construct complex queries for retrieving specific datasets based on custom metrics, filtering conditions, and sorting criteria. use this endpoint for targeted data extraction, custom reporting, or data analysis within the b2b saas integration ecosystem. note that while powerful, complex queries may impact performance with large datasets.
</Accordion>


# D2lbrightspace
Source: https://docs.push.ai/integrations/d2lbrightspace



D2L Brightspace provides APIs for building custom integrations and add-ons
for the D2L Brightspace platform.

<Accordion title="Get Quiz">
  Retrieves a specific quiz from an org unit. returns a quizreaddata json block containing the quiz's properties. requires oauth2 scope: - quizzing:quizzes:read available in api versions 1.75+ (lms v20.24.5+)
</Accordion>

<Accordion title="Get Users">
  Retrieves data for one or more users from d2l brightspace. requires oauth2 scope: - users:userdata:read available in api versions 1.46+ (lms v20.24.3+) notes: - all search parameters (orgdefinedid, username, externalemail) are optional - returns paginated results when using bookmark parameter
</Accordion>

<Accordion title="Get Quizzes">
  Retrieves all quizzes belonging to an org unit. returns an objectlistpage json block containing a list of quizreaddata blocks. requires oauth2 scope: - quizzing:quizzes:read available in api versions 1.75+ (lms v20.24.5+)
</Accordion>

<Accordion title="Update User">
  Updates an existing user entity in d2l brightspace. requires oauth2 scope: - users:userdata:update available in api versions 1.46+ (lms v20.24.3+) notes: - firstname and lastname update preferred names if set, otherwise update legal names - externalemail must be null or a valid email address - orgdefinedid must be unique across the organization if provided - pronouns: use empty string ("") to reset, null to keep existing value
</Accordion>

<Accordion title="Get Course Template Schema">
  Retrieves the list of parent org unit type constraints for course offerings built on this template. returns a json array of schemaelement blocks defining the allowed parent organizational unit types for course templates. available in api versions 1.46+ (lms v20.24.3+)
</Accordion>

<Accordion title="Get Course Template">
  Retrieves a course template from d2l brightspace. returns a coursetemplate json block with the template's information. available in api versions 1.46+ (lms v20.24.3+)
</Accordion>

<Accordion title="Get Role by ID">
  Retrieves a particular user role from d2l brightspace by its id. requires oauth2 scope: - role:detail:read available in api versions 1.46+ (lms v20.24.3+)
</Accordion>

<Accordion title="Get Course Schema">
  Retrieves the list of parent org unit type constraints for course offerings. returns a json array of schemaelement blocks defining the allowed parent organizational unit types for courses. available in api versions 1.46+ (lms v20.24.3+)
</Accordion>

<Accordion title="Create Course Template">
  Creates a new course template in d2l brightspace. notes: - course template code limitations: max 50 chars, no special chars: \ : \* ? " \< > | ' # , % & - path: leave empty if path enforcement is enabled requires oauth2 scope: - orgunits:coursetemplate:create available in api versions 1.46+ (lms v20.24.3+)
</Accordion>

<Accordion title="Get Quiz Access">
  Retrieves a list of users with access to a specified quiz. returns an objectlistpage json block containing a list of useraccess blocks. can filter by specific user id or role id. requires oauth2 scope: - quizzing:access:read available in api versions 1.75+ (lms v20.24.5+)
</Accordion>

<Accordion title="Get User by ID">
  Retrieves data for a particular user from d2l brightspace. requires oauth2 scope: - users:userdata:read available in api versions 1.46+ (lms v20.24.3+)
</Accordion>

<Accordion title="Create Grade Object">
  Creates a new grade object for a particular org unit. the grade object can be one of four types: 1. numeric: for numeric grades with max points 2. passfail: for pass/fail assessments 3. selectbox: for predefined grade options 4. text: for text-only feedback returns a gradeobject json block containing the created grade object's data, including its assigned id. requires oauth2 scope: - grades:gradeobjects:write available in api versions 1.75+ (lms v20.24.5+)
</Accordion>

<Accordion title="Get Quiz Attempt">
  Retrieves a specific quiz attempt. returns a quizattemptdata json block containing the attempt's properties. requires oauth2 scope: - quizzing:attempts:read available in api versions 1.75+ (lms v20.24.5+)
</Accordion>

<Accordion title="Get Current User Information">
  Retrieves the current user context's user information from d2l brightspace. requires one of these oauth2 scopes: - users:profile:read - users:own profile:read available in api versions 1.46+ (lms v20.24.3+)
</Accordion>

<Accordion title="Get Quiz Attempts">
  Retrieves a list of attempts for a quiz. can optionally filter attempts for a specific user. returns an objectlistpage json block containing a list of quizattemptdata blocks. requires oauth2 scope: - quizzing:attempts:read available in api versions 1.75+ (lms v20.24.5+)
</Accordion>

<Accordion title="Update Course Offering">
  Updates an existing course offering in d2l brightspace. notes: - course code limitations: max 50 chars, no special chars: \ : \* ? " \< > | ' # , % & - startdate/enddate: null values won't overwrite existing dates - canselfregister: required for api v1.27+, not supported before v1.27 - description: ignored in api versions 1.25 and earlier requires oauth2 scope: - orgunits:course:update available in api versions 1.46+ (lms v20.24.3+)
</Accordion>

<Accordion title="Get Quiz Categories">
  Retrieves all quiz categories belonging to an org unit. returns an objectlistpage json block containing a list of quizcategoryreaddata blocks. requires oauth2 scope: - quizzing:quizzes:read available in api versions 1.75+ (lms v20.24.5+)
</Accordion>

<Accordion title="Copy Role">
  Creates a new role copied from an existing role in d2l brightspace. notes: - the new role will not have any capabilities upon the old role from which it was created - some capabilities will be copied for the new role (e.g., if old role users could impersonate other old role users, new role users will be able to impersonate other new role users) - additional capabilities must be manually created after copying requires oauth2 scope: - role:detail:create available in api versions unstable (lms v10.4.10+)
</Accordion>

<Accordion title="Update Course Template">
  Updates an existing course template in d2l brightspace. notes: - this action completely replaces the template's data with the provided values - course template code limitations: max 50 chars, no special chars: \ : \* ? " \< > | ' # , % & available in api versions 1.46+ (lms v20.24.3+)
</Accordion>

<Accordion title="Update Grade Object">
  Updates a specific grade object. the grade object can be one of four types: 1. numeric: for numeric grades with max points 2. passfail: for pass/fail assessments 3. selectbox: for predefined grade options 4. text: for text-only feedback note: the provided data completely replaces the existing grade object's data. returns a gradeobject json block containing the updated grade object's data. requires oauth2 scope: - grades:gradeobjects:write available in api versions 1.75+ (lms v20.24.5+)
</Accordion>

<Accordion title="Get Enrolled Roles">
  Retrieves a list of all enrolled user roles the calling user can view in an org unit. returns a json array of role data blocks containing the properties of all user roles that the calling user context has permission to view and that are currently enrolled in the provided org unit. requires oauth2 scope: - role:detail:read available in api versions 1.46+ (lms v20.24.3+)
</Accordion>

<Accordion title="Get Quiz Category">
  Retrieves a specific quiz category from an org unit. returns a quizcategoryreaddata json block containing the category's properties. requires oauth2 scope: - quizzing:quizzes:read available in api versions 1.75+ (lms v20.24.5+)
</Accordion>

<Accordion title="Create Quiz">
  Creates a new quiz in d2l brightspace. notes: - numberofattemptsallowed must be between 1 and 10 (inclusive) or null for unlimited - password must not be empty or whitespace if provided - notificationemail must be a valid email address if provided - timelimitvalue: 0 for no limit (with isenforced false), or 1-9999 for enforced limit - deductionpercentage must be between 0 and 100 if provided - as of le api v1.71: - latelimitminutes is ignored - latesubmissionoption 1 is treated as 2 (autosubmitattempt) - submissiongraceperiod is not used - pagingtypeid added in le api v1.78 - date fields should be in utc format requires oauth2 scopes: - quizzing:quizzes:read - quizzing:quizzes:create available in api versions 1.75+ (lms v20.24.5+)
</Accordion>

<Accordion title="Get Quiz Questions">
  Retrieves all questions in a quiz. returns an objectlistpage json block containing a list of questiondata blocks. requires oauth2 scope: - quizzing:quizzes:read available in api versions 1.75+ (lms v20.24.5+)
</Accordion>

<Accordion title="Get Grade Access">
  Retrieves a list of users with access to a specified grade. returns an objectlistpage containing useraccess blocks. can optionally filter by specific user id or role id. requires oauth2 scope: - grades:access:read available in api versions 1.75+ (lms v20.24.5+)
</Accordion>

<Accordion title="Get Roles">
  Retrieves a list of all known user roles in d2l brightspace. returns a list of role data blocks containing the properties of all user roles that the calling user context has permission to manage. requires oauth2 scope: - role:detail:read available in api versions 1.46+ (lms v20.24.3+)
</Accordion>

<Accordion title="Create User">
  Creates a new user entity in d2l brightspace. requires oauth2 scope: - users:userdata:create available in api versions 1.46+ (lms v20.24.3+) notes: - firstname and lastname are used as legal names - externalemail must be null or a valid email address - orgdefinedid must be unique across the organization if provided - preferred names must be set separately after user creation
</Accordion>

<Accordion title="Update Grade Setup">
  Updates the grades configuration for an org unit. expects a gradesetupinfo json block containing: - gradingsystem: the grading system type - isnullgradezero: whether null grades should be treated as zero - defaultgradeschemeid: id of the default grade scheme returns the updated gradesetupinfo json block. requires oauth2 scope: - grades:gradesettings:write available in api versions 1.75+ (lms v20.24.5+)
</Accordion>

<Accordion title="Get Grade Object">
  Retrieves a specific grade object for a particular org unit. returns a gradeobject json block containing the grade object's properties. requires oauth2 scope: - grades:gradeobjects:read available in api versions 1.75+ (lms v20.24.5+)
</Accordion>

<Accordion title="Get Grade Objects">
  Retrieves all current grade objects for a particular org unit. returns an array of grade objects. requires oauth2 scope: - grades:gradeobjects:read available in api versions 1.75+ (lms v20.24.5+)
</Accordion>

<Accordion title="Delete Course Template">
  Deletes a course template from d2l brightspace. requires oauth2 scope: - orgunits:course:delete available in api versions 1.46+ (lms v20.24.3+)
</Accordion>

<Accordion title="Get Course Offering">
  Retrieves a specific course offering from d2l brightspace. returns a courseoffering json block with the course's information. requires oauth2 scope: - orgunits:course:read available in api versions 1.46+ (lms v20.24.3+)
</Accordion>

<Accordion title="Update Quiz Category">
  Updates an existing quiz category in d2l brightspace. returns a quizcategoryreaddata json block containing: - categoryid: the id of the category - name: the name of the category - sortorder: the sort order value requires oauth2 scopes: - quizzing:quizzes:read - quizzing:quizzes:write available in api versions 1.75+ (lms v20.24.5+)
</Accordion>

<Accordion title="Delete User">
  Deletes a user entity from d2l brightspace. requires oauth2 scope: - users:userdata:delete available in api versions 1.46+ (lms v20.24.3+)
</Accordion>

<Accordion title="Delete User Demographics">
  Deletes one or more of a particular user's associated demographics entries. notes: - if entry ids are provided, only those specific entries will be deleted - if entry ids are not provided, all demographics entries for the user will be deleted requires oauth2 scope: - demographics:user:delete available in api versions 1.46+ (lms v20.24.3+)
</Accordion>

<Accordion title="Get Grade Statistics">
  Retrieves statistics for a specified grade item. returns a gradestatisticsinfo json block containing statistical data about the grade item. requires oauth2 scope: - grades:gradestatistics:read available in api versions 1.75+ (lms v20.24.5+)
</Accordion>

<Accordion title="Get Grade Setup">
  Retrieves the grades configuration for an org unit. returns a gradesetupinfo json block containing the grades setup information. requires oauth2 scope: - grades:gradesettings:read available in api versions 1.75+ (lms v20.24.5+)
</Accordion>

<Accordion title="Delete Grade Object">
  Deletes a specific grade object from an org unit. requires oauth2 scope: - grades:gradeobjects:delete available in api versions 1.75+ (lms v20.24.5+)
</Accordion>

<Accordion title="Delete Course">
  Deletes a course offering from d2l brightspace. requires oauth2 scope: - orgunits:course:delete available in api versions 1.46+ (lms v20.24.3+)
</Accordion>

<Accordion title="Delete Quiz">
  Deletes a quiz from d2l brightspace. requires oauth2 scope: - quizzing:quizzes:delete available in api versions 1.75+ (lms v20.24.5+)
</Accordion>

<Accordion title="Get Org Unit Demographics">
  Retrieves all demographics entries for users enrolled in a particular org unit. notes: - filters are applied cumulatively (all conditions must match) - when using id lists in filters, matching any id in the list satisfies that filter - for example: with roleids=\[1,2], userids=\[3,4], search="value": \* users must have role 1 or 2 (either role matches) \* and must have id 3 or 4 (either id matches) \* and must have a field matching "value" - results are paged; use bookmark parameter for subsequent pages requires oauth2 scope: - demographics:orgunit:read available in api versions 1.46+ (lms v20.24.3+)
</Accordion>

<Accordion title="Delete Quiz Category">
  Deletes a quiz category from d2l brightspace. requires oauth2 scope: - quizzing:quizzes:delete available in api versions 1.75+ (lms v20.24.5+)
</Accordion>

<Accordion title="Update Quiz">
  Updates an existing quiz in d2l brightspace. notes: - this action updates only the provided quiz properties - numberofattemptsallowed must be between 1 and 10 (inclusive) or null for unlimited - password must not be empty or whitespace if provided - notificationemail must be a valid email address if provided - timelimitvalue: 0 for no limit (with isenforced false), or 1-9999 for enforced limit - deductionpercentage must be between 0 and 100 if provided - cannot restrict shared quizzes for special access - cannot set auto-submit for quizzes with mandatory questions - as of le api v1.71: - latelimitminutes is ignored - latesubmissionoption 1 is treated as 2 (autosubmitattempt) - submissiongraceperiod is not used - pagingtypeid added in le api v1.78 - date fields should be in utc format requires oauth2 scopes: - quizzing:quizzes:read - quizzing:quizzes:write available in api versions 1.75+ (lms v20.24.5+)
</Accordion>


# Dialpad
Source: https://docs.push.ai/integrations/dialpad



Dialpad is a cloud-based business phone system and contact center platform that enables voice, video, messages and meetings across your existing devices

<Accordion title="Add operator to office">
  This endpoint adds a new operator to a specific office within the dialpad system. it allows administrators to assign users or rooms as operators, enhancing the office's communication capabilities. the endpoint requires the office id (specified in the path), the operator's id, and the type of operator (user or room). optionally, the role of the new operator can be set to either standard operator or admin. use this endpoint when you need to expand or modify the operator team for a particular office, ensuring efficient call handling and management within the dialpad platform.
</Accordion>

<Accordion title="Access control policies listing">
  Retrieves a list of access control policies for the authenticated dialpad company. this endpoint allows company administrators to view all custom sets of permissions defined for ai contact center settings. it should be used when auditing existing policies, preparing to assign roles to users, or before creating new policies to avoid duplication. the endpoint provides an overview of all policies but does not include detailed permission sets for each policy. for specific policy details, a separate api call may be required.
</Accordion>

<Accordion title="Assign number to call router">
  This endpoint assigns a phone number to a specific call router in the dialpad system. it allows users to either provide a full phone number for assignment or specify an area code to automatically select an available number within that region. the assigned number can optionally be set as the primary number for the call router. this functionality is crucial for setting up and managing call routing within an organization, enabling efficient distribution of incoming calls to the appropriate departments or individuals.
</Accordion>

<Accordion title="Assign fax line to target">
  Creates and assigns a new fax line to a specified target (user or department) in the dialpad system. this endpoint allows you to set up a fax line with various options, including reserved numbers, area code-based searches, or toll-free numbers. use this when you need to provision a new fax line for a user or department, or when you want to assign an existing number as a fax line. the endpoint is flexible, allowing for different types of fax line assignments based on your specific needs and available numbers. note that the assignment process is immediate, and the fax line will be ready for use once the api call is successful. however, this endpoint does not handle the actual sending or receiving of faxes; it only sets up the line for future use.
</Accordion>

<Accordion title="Assign phone number to target">
  Assigns a phone number to a specified target within the dialpad system. this endpoint allows you to either assign a specific number or request a number from a given area code. it can be used to add new numbers to various entities such as users, departments, or call centers. the assigned number can optionally be set as the primary number for the target. this tool is particularly useful for managing phone number assignments across different parts of your dialpad organization, enabling flexible number allocation and management.
</Accordion>

<Accordion title="Assign phone number to office">
  This endpoint assigns a phone number to a specific office in the dialpad system. it allows you to either specify a particular phone number or request an available number from a given area code. the assigned number can optionally be set as the primary number for the office. use this endpoint when you need to add a new phone number to an office or change the office's primary number. it's particularly useful for setting up new offices or modifying existing office phone configurations. note that this endpoint does not handle number porting or releasing existing numbers; it's specifically for assigning available numbers within the dialpad system.
</Accordion>

<Accordion title="Add participant to call">
  Adds a new participant to an existing call in the dialpad system. this endpoint allows you to include additional members in an ongoing call by specifying either a phone number or a target within your dialpad organization. use this when you need to add someone to a call that is already in progress, such as bringing in an expert or including a manager in a customer service call. the endpoint requires the id of the existing call and the details of the new participant. it's important to note that the target, if used, must have a primary number assigned in the dialpad system.
</Accordion>

<Accordion title="Assign phone number to room">
  Assigns a phone number to a specified room in dialpad. this endpoint allows you to either assign a specific phone number or request a number from a given area code. it's useful for setting up new rooms or updating existing ones with additional or primary phone numbers. the assigned number can optionally be set as the primary number for the room. use this endpoint when you need to manage phone number assignments for dialpad rooms programmatically.
</Accordion>

<Accordion title="Assign policy to user by id">
  Assigns an access control policy to a specific user within the dialpad system. this endpoint allows administrators to grant customized settings permissions to users at various levels of the organization: company-wide, for specific offices, or for contact centers. it's particularly useful for implementing role-based access control (rbac) and managing user permissions across different parts of the dialpad platform. the endpoint should be used when setting up new users, modifying existing user permissions, or implementing changes in the organizational structure that require updates to access control policies. note that this feature is part of an early adopter program and may be subject to changes or limitations.
</Accordion>

<Accordion title="Assign phone number to user">
  This endpoint assigns a phone number to a specific dialpad user. it allows for either searching for an available number within a given area code or assigning a specific number to the user. the assigned number can optionally be set as the user's primary number. use this endpoint when you need to provide a user with a new phone number or add an additional number to their account. it's particularly useful for setting up new users or expanding the communication capabilities of existing users. note that this endpoint doesn't handle number porting or transferring existing numbers between users.
</Accordion>

<Accordion title="Create access control policy">
  Creates a new access control policy in dialpad, defining a set of permissions and their application scope. this endpoint allows administrators to establish granular control over various dialpad features and settings. it's used to manage user access and configure operational parameters across different levels of the organization. the policy created can encompass a wide range of permissions, from agent settings to ai configurations, enabling customized access control tailored to specific organizational needs. this tool is essential for setting up and maintaining a secure, well-organized communication environment within dialpad.
</Accordion>

<Accordion title="Add blocked phone numbers">
  Adds specified phone numbers to the blocked list in dialpad. this endpoint allows users to block unwanted or spam numbers, preventing incoming calls or messages from these numbers. it accepts a list of e.164 formatted phone numbers and adds them to the user's blocked list. this tool should be used when there's a need to block multiple phone numbers at once, enhancing the platform's call and message filtering capabilities. it's particularly useful for maintaining communication hygiene and reducing unwanted interactions. note that this operation is additive; it doesn't replace the existing blocked list but appends to it.
</Accordion>

<Accordion title="Create callback">
  Creates a callback request in a dialpad call center. this endpoint allows you to initiate a callback to a specified phone number through a designated call center. it's useful for implementing features like "request a call" on websites or applications, or for scheduling return calls to customers. the endpoint doesn't immediately place the call but queues it in the specified call center for an agent to handle. note that while both parameters are optional, at least one should be provided for a meaningful request. if no call center id is specified, the system may use a default or return an error, depending on your account configuration.
</Accordion>

<Accordion title="Create call router configuration">
  Creates a new call router in the dialpad system, allowing for custom call routing logic based on a specified url. this endpoint configures essential settings for the call router, including its name, default target for fallback scenarios, and the routing url for decision-making. it's used when setting up a new automated call distribution system or when implementing custom call routing logic for an office. the call router can be enabled or disabled, and includes an optional security feature through a signature secret. note that this endpoint only creates the call router; additional setup may be required in the dialpad interface or through other api calls to fully integrate it into the calling workflow.
</Accordion>

<Accordion title="Create call review share link">
  Creates a shareable link for a specific call review in the dialpad platform. this endpoint allows users to generate a url that can be used to share call recordings or summaries with others, either within the company or publicly. it's particularly useful for sharing important call information, training materials, or for compliance purposes. the function provides control over the privacy level of the shared content, allowing for secure sharing within an organization or broader distribution as needed.
</Accordion>

<Accordion title="Create agent status subscription">
  Creates or updates an agent status subscription for real-time monitoring of contact center agent statuses in dialpad. this endpoint allows you to configure event notifications for changes in agent availability, such as when agents become available, busy, or go off-duty. use this when setting up integrations that require up-to-date information on agent statuses for workforce management, real-time dashboards, or automated workflows. the subscription can be associated with a specific webhook or websocket endpoint for receiving the status updates. note that this endpoint only configures the subscription; you need to separately set up the webhook or websocket to receive the actual event data.
</Accordion>

<Accordion title="Create pin for international room calls">
  Creates a pin for protected international calls from a dialpad room. this endpoint generates a unique pin that can be used to authenticate and authorize international calls made from a specific dialpad room. it's particularly useful for businesses that want to control and track international calling capabilities within their organization. the generated pin adds an extra layer of security, ensuring that only authorized users can make international calls from the room. use this endpoint when you need to set up or refresh international calling access for a room, especially in scenarios where you want to monitor usage or restrict access to certain team members.
</Accordion>

<Accordion title="Create custom ivr with audio file">
  Creates a new custom interactive voice response (ivr) system within the dialpad platform. this endpoint allows you to define and configure an ivr workflow by specifying its type, associated audio file, and target assignment. use this when setting up automated phone menus, call routing systems, or customized voice interactions for different parts of your dialpad organization. the ivr can be assigned to various entities like call centers, departments, or individual users, providing flexibility in managing call flows and customer interactions.
</Accordion>

<Accordion title="Attach labels to call">
  Creates or updates labels for a specific call in the dialpad system. this endpoint allows you to attach one or more labels to a call, which can be used for categorization, filtering, or tracking purposes. the function takes a call id and an array of label strings, replacing any existing labels on the call with the provided set. use this when you need to categorize a call or update its existing labels. the endpoint is particularly useful for integrating call labeling into automated workflows or custom applications built on top of dialpad. note that this operation will overwrite any previously existing labels on the call.
</Accordion>

<Accordion title="Create room in office via post">
  Creates a new room within a specified office in the dialpad system. this endpoint is used to set up physical or virtual spaces for collaboration, meetings, or other communication purposes. it allows you to define a room with a name and associate it with a specific office. this is particularly useful for organizations managing multiple locations or wanting to organize their communication spaces efficiently. the created room can then be used for various purposes such as scheduling meetings, assigning resources, or managing call routing within the dialpad platform.
</Accordion>

<Accordion title="Add department operator by id">
  Adds a new operator to a specific department in dialpad. this endpoint allows you to assign either a user or a room as an operator, with the option to specify their role. it's used to manage call handling and department operations by adding new operators or updating existing ones with different roles. the department id is specified in the url path. use this when setting up new departments, expanding existing ones, or adjusting operator assignments and roles within a department.
</Accordion>

<Accordion title="Configure call center settings">
  This endpoint creates a new call center within the dialpad system with customizable settings for call handling, routing, operational hours, and advanced features. it allows for detailed configuration of call center behavior, including auto-recording, hold queue management, alert thresholds, and voice intelligence integration. use this endpoint when setting up a new call center or department that requires specific call routing and management capabilities. the endpoint provides extensive customization options but requires careful consideration of settings to ensure optimal call center operation.
</Accordion>

<Accordion title="Create channel endpoint">
  Creates a new communication channel within the dialpad platform. this endpoint allows users to set up a dedicated space for team collaboration, discussions, or topic-specific conversations. it's particularly useful for organizing communication within a company or project. the created channel can be either public or private, providing flexibility in managing access and information sharing. use this endpoint when you need to programmatically create channels for various teams, projects, or departments, streamlining the process of setting up communication structures within dialpad.
</Accordion>

<Accordion title="Add member to coaching team">
  Adds a new member to a specific coaching team in dialpad. this endpoint allows you to assign a user to a coaching team with a designated role, enabling effective team management and performance monitoring. use this when you need to include a new coach or trainee in an existing coaching team. the endpoint requires the coaching team id in the url path and the member details in the request body. it's particularly useful for setting up or expanding coaching teams for call center training and quality assurance purposes.
</Accordion>

<Accordion title="Delete access control policy by id">
  Deletes a specific access control policy from the dialpad system. this endpoint allows company administrators to remove custom permission settings that were previously created for managing user roles and access within the dialpad platform. it should be used when a particular access control policy is no longer needed or requires complete removal from the system. this operation is permanent and cannot be undone, so it should be used with caution. the endpoint does not return the deleted policy details; it typically returns a success status upon successful deletion.
</Accordion>

<Accordion title="Create sms event subscription">
  Creates a new sms event subscription in the dialpad api, allowing users to receive notifications for inbound and/or outbound sms messages. this endpoint enables fine-grained control over sms event monitoring, including options for filtering by direction, target, and message type. it's particularly useful for integrating real-time sms notifications into external systems or applications. the subscription can be configured to include or exclude internal company messages and to provide updates on message delivery statuses. use this endpoint when setting up new sms monitoring systems or when adjusting existing subscription parameters.
</Accordion>

<Accordion title="Create user with auto assign">
  Creates a new user account in the dialpad system with the specified details. this endpoint allows you to add a new user to your dialpad organization, set up their basic profile information, assign them to an office, and optionally auto-assign a phone number. it's particularly useful for bulk user creation or when integrating dialpad user management with other systems. the endpoint requires at minimum an email and office id, with options to further customize the user's profile and permissions through additional parameters. note that while a license can be specified, it defaults to 'talk' if not provided, ensuring that the new user has basic dialpad functionality.
</Accordion>

<Accordion title="Create webhook post endpoint">
  Creates a new webhook integration for receiving real-time event notifications from dialpad. this endpoint allows you to specify a url where dialpad will send event data when specific actions occur within the dialpad system. it's essential for building responsive, event-driven integrations with dialpad. the endpoint also supports an optional secret for verifying the authenticity of incoming webhook requests, enhancing security. use this when you need to set up automated workflows or sync dialpad events with external systems.
</Accordion>

<Accordion title="Add member to channel">
  Adds a new member to a specified channel within the dialpad communication platform. this endpoint allows you to expand the membership of a channel by providing the user id of the person you want to add. it's particularly useful for programmatically managing channel memberships, such as when onboarding new team members or reorganizing communication structures. the endpoint should be used when you need to include a user in a channel's conversations and collaborations. note that this operation only adds the user to the channel; it does not create new users or channels. ensure that both the channel id (specified in the url) and the user id (provided in the request body) exist in your dialpad organization before making this call.
</Accordion>

<Accordion title="Delete agent status by id">
  Deletes a specific agent status subscription identified by its unique id. this endpoint is used to stop receiving real-time updates about an agent's status (e.g., available, busy, off-duty) in the dialpad system. it should be used when you no longer need to track the status changes for a particular agent or when cleaning up unused subscriptions. the operation is irreversible, so care should be taken to ensure the correct subscription id is provided. this endpoint does not return the deleted subscription details; it typically returns a success status code upon successful deletion.
</Accordion>

<Accordion title="Deauthorize oauth2 session">
  Deauthorizes (revokes) an oauth2 access token, effectively terminating the application's access to the dialpad api. this endpoint should be used when an application needs to invalidate its current access token, such as during user logout, when suspending an integration, or in response to potential security threats. it's an essential security measure to prevent unauthorized access once a token is no longer needed or potentially compromised. note that after deauthorization, the application will need to re-authenticate to obtain a new access token for future api calls. this endpoint does not return any specific data; a successful call simply invalidates the token.
</Accordion>

<Accordion title="Delete call center by id">
  Deletes a specific call center from the dialpad system. this endpoint should be used when you need to permanently remove a call center from your dialpad account. it's important to note that this action is irreversible and will affect all associated resources, such as agents, call logs, and configurations linked to the specified call center. before using this endpoint, ensure that all necessary data has been backed up or migrated. this operation may have significant implications for ongoing operations, so it should be used with caution and typically requires appropriate authorization.
</Accordion>

<Accordion title="Create schedule reports endpoint">
  Creates a scheduled report in the dialpad system for various types of communication data. this endpoint allows users to automate the generation and delivery of reports on a regular basis, such as call logs, user statistics, or voicemails. it's particularly useful for managers, administrators, and analysts who need consistent, periodic insights into communication patterns and performance metrics. the endpoint offers flexible scheduling options, including daily, weekly, or monthly frequencies, and can target specific organizational units or user groups. use this when you need to set up recurring reports for monitoring, compliance, or analytical purposes. note that this endpoint creates a new schedule; to modify existing schedules, use the appropriate update endpoint.
</Accordion>

<Accordion title="Add operator to call center">
  This endpoint adds a new operator to a specified call center in the dialpad system. it allows for the configuration of the operator's role, skill level, and license type, as well as managing phone number retention when switching to a support license. use this endpoint when you need to expand your call center team or adjust an existing user's role within the call center. the endpoint is particularly useful for setting up new operators with specific skill levels and roles, which can help in optimizing call routing and management within the call center. note that while adding an operator, careful consideration should be given to the license type and role assigned, as these affect the operator's capabilities and the associated costs.
</Accordion>

<Accordion title="Delete callreviewsharelink by id">
  This endpoint deletes a specific call review share link in the dialpad system. it's used to revoke access to a previously shared call review, ensuring that the link can no longer be used to view the associated call information. this action is permanent and should be used when you want to immediately prevent further access to a shared call review, such as when sensitive information was mistakenly shared or when the review is no longer relevant. once deleted, the share link cannot be recovered, and anyone attempting to use it will receive an error.
</Accordion>

<Accordion title="Delete channel by id">
  Deletes a specific channel from the dialpad communication platform. this endpoint should be used when you need to remove a communication channel that is no longer needed or has become obsolete. it permanently removes the channel and all associated data, so it should be used with caution. this operation cannot be undone, and once a channel is deleted, it cannot be recovered. the endpoint is useful for maintaining a clean and organized communication structure within your dialpad account.
</Accordion>

<Accordion title="Delete call subscription by id">
  Deletes a specific call subscription from the dialpad system. this endpoint should be used when an application no longer needs to receive real-time notifications for a particular call-related event or functionality. it allows developers to clean up unused subscriptions, potentially freeing up resources and reducing unnecessary data processing. the deletion is permanent and cannot be undone, so use this endpoint with caution. it's important to note that this operation only affects the specified subscription and does not impact any other active subscriptions or ongoing calls.
</Accordion>

<Accordion title="Delete department resource">
  Deletes a specific department from the dialpad system. this endpoint should be used when you need to remove a department that is no longer needed or has been deprecated within your organization's structure. the operation is irreversible, so it should be used with caution. once a department is deleted, all associated data, such as user assignments and resource allocations, may be affected. this endpoint is particularly useful for maintaining an up-to-date organizational structure in dialpad, especially during restructuring or when cleaning up obsolete departments.
</Accordion>

<Accordion title="Delete deskphone in room">
  This endpoint removes a specific deskphone from a designated room within the dialpad system. it's used to unassign or decommission a deskphone from a particular shared space, such as a conference room or reception area. the operation is permanent and should be used with caution as it will disassociate the deskphone from the room, potentially affecting call routing and room communication capabilities. this endpoint is particularly useful during office reorganizations, when updating room phone setups, or when removing faulty devices from the system. note that this operation only removes the association between the deskphone and the room; it does not delete the deskphone from the overall dialpad account.
</Accordion>

<Accordion title="Delete channel member by id">
  Removes a specified member from a dialpad channel. this endpoint allows you to delete a user from a particular channel, effectively revoking their access and participation in that channel's communications. it should be used when you need to remove a team member from a specific collaboration space, such as when an employee changes roles or leaves the organization. the endpoint requires the channel id (specified in the url path) and the user id of the member to be removed. note that this action is irreversible, and the removed member will lose access to the channel's history and future communications. it's important to ensure you have the necessary permissions to remove members before using this endpoint.
</Accordion>

<Accordion title="Delete contact by id">
  Deletes a specific contact from the dialpad system using the provided contact id. this endpoint should be used when you need to permanently remove a contact's information from your dialpad account. it's important to note that this action is irreversible, and once a contact is deleted, it cannot be recovered through the api. use this endpoint with caution, ensuring that you have verified the correct contact id before deletion. this operation affects both shared company contacts and user-specific local contacts, depending on the scope of the provided id.
</Accordion>

<Accordion title="Delete number via api">
  Deletes a specific phone number from the user's dialpad account. this endpoint should be used when a phone number is no longer needed and needs to be removed from the system. it's important to note that this action is irreversible, and once a number is deleted, it may not be possible to reclaim the same number. this endpoint is particularly useful for managing phone inventory, removing temporary numbers, or cleaning up unused numbers to optimize resource allocation. the deletion process may have implications on call routing, billing, and other phone-related features within dialpad, so it should be used with caution and only when the user is certain that the number is no longer required.
</Accordion>

<Accordion title="Create new contact entry">
  The createcontact endpoint adds a new contact to dialpad's system. use it to create local or shared contacts with comprehensive information. ideal for user onboarding, data migration, or system integrations. supports various contact details, with some fields restricted to single-line entries for consistency.
</Accordion>

<Accordion title="Delete customivr by targettype and ivrtype">
  Deletes a custom interactive voice response (ivr) configuration from a specified target in the dialpad system. this endpoint is used to remove ivr settings, allowing for the reset or reconfiguration of call routing and automated response systems. it's particularly useful when updating ivr workflows or when a specific ivr configuration is no longer needed. the operation affects the ivr settings for the specified target type and id, with an option to limit the change to either inbound or outbound calls in call center contexts. this endpoint should be used cautiously, as deleting an ivr configuration is irreversible and may impact existing call routing processes.
</Accordion>

<Accordion title="Delete deskphone by user id">
  Deletes a specific deskphone associated with a user in the dialpad system. this endpoint should be used when you need to remove a deskphone from a user's account, such as when the device is no longer in use or needs to be reassigned. the operation is permanent and cannot be undone, so it should be used with caution. this endpoint is particularly useful for managing hardware inventory and ensuring that user accounts accurately reflect their current device assignments.
</Accordion>

<Accordion title="Create secondary office">
  Creates a new office within the dialpad system with specified configurations and settings. this endpoint allows you to set up a new office location or entity, including its billing information, operational hours, routing options, and various communication preferences. use this when you need to add a new office to your dialpad organization, such as when expanding to a new location or setting up a separate department with its own communication settings. the endpoint requires several mandatory parameters for basic office setup and billing, while offering numerous optional parameters for fine-tuning office operations and call handling. note that some settings, like voice intelligence and e911 address, may have regulatory implications depending on your location and should be configured carefully.
</Accordion>

<Accordion title="Delete callrouter by id">
  Deletes a specific call router from the dialpad system. this endpoint should be used when you need to remove an existing call routing configuration, such as when restructuring your call flow or decommissioning outdated routing rules. the deletion is permanent and cannot be undone, so use with caution. this operation will immediately affect incoming calls that were previously handled by the deleted router, potentially disrupting call flows if not properly managed. ensure that any dependencies on the call router (e.g., dids or mainline menu routings) are updated before deletion to maintain smooth call handling.
</Accordion>

<Accordion title="Create new department record">
  Creates a new department within the dialpad system with customizable settings for call handling, operating hours, and advanced features. this endpoint allows for detailed configuration of department properties, including automatic call recording, hold queue management, custom operating hours, call routing strategies, and voice intelligence settings. it's particularly useful for setting up complex call flow structures within an organization, enabling efficient call distribution and management. the endpoint requires specifying the department name and associated office id, with numerous optional parameters for fine-tuning department behavior. it's important to note that some default values are applied if optional parameters are not provided, ensuring a functional department setup even with minimal configuration.
</Accordion>

<Accordion title="Delete operator from department">
  Removes a specified operator from a department in the dialpad system. this endpoint is used to update department operator assignments by removing either a user or a room from the list of operators for a given department. it's particularly useful for managing call routing and department resources. the endpoint requires both the operator's unique id and type (user or room) to ensure accurate removal. use this when reorganizing department structures, changing operator assignments, or updating call handling workflows. note that this action is irreversible and may affect ongoing call routing for the department.
</Accordion>

<Accordion title="Delete office operator by id">
  Removes a specified operator (user or room) from a particular office in the dialpad system. this endpoint is used to manage the association between operators and offices, allowing administrators to control access and permissions within the organization's structure. it should be used when you need to disassociate a user or a room from an office, such as when an employee changes departments or a shared space is no longer used for a specific office. the endpoint requires both the operator's id and type to ensure precise removal of the correct entity. note that this action does not delete the user or room from the system entirely; it only removes their association with the specified office.
</Accordion>

<Accordion title="Delete recording share link by id">
  Deletes a specific recording share link in the dialpad system. this endpoint is used to revoke access to a shared recording by removing the associated link. it should be called when you want to prevent further access to a recording through a previously generated share link. this action is permanent and cannot be undone, so use it cautiously. the endpoint is particularly useful for maintaining privacy and controlling access to sensitive or outdated recorded content.
</Accordion>

<Accordion title="Format phone numbers">
  The format phone number endpoint is used to standardize and format phone numbers within the dialpad ecosystem. this tool takes a raw phone number input and converts it into a specified or default format, ensuring consistency across the platform. it's particularly useful when integrating new contact information, preparing numbers for display, or standardizing data for call routing purposes. the endpoint supports various input formats and can adapt to different country-specific number structures, making it versatile for international use. however, it's important to note that this tool is for formatting purposes only and does not validate the existence or operability of the phone number.
</Accordion>

<Accordion title="Delete sms subscription by id">
  Deletes a specific sms subscription from the dialpad system. this endpoint should be used when you want to cancel or remove an existing sms subscription, such as when a user no longer needs sms services or wants to change their subscription plan. the operation is irreversible, so it should be used with caution. once deleted, the subscription and its associated settings will no longer be available. this endpoint only handles the deletion process and does not provide any information about the subscription being deleted. it's important to ensure that you have the correct subscription id before making this call, as there is no way to recover a mistakenly deleted subscription.
</Accordion>

<Accordion title="Delete operator from call center">
  Removes a specified operator from a call center in the dialpad system. this endpoint should be used when you need to disassociate an agent or user from a particular call center, such as when an employee changes roles or leaves the organization. the operation is permanent and cannot be undone through this api. if you need to re-add the operator to the call center, you would need to use a separate api call. note that this endpoint only removes the operator's association with the call center; it does not delete the user account from dialpad.
</Accordion>

<Accordion title="List channels api">
  Retrieves a list of all available communication channels in the dialpad platform. this endpoint provides an overview of the various channels that can be used for voice, sms, and other digital engagement methods within dialpad. it should be used when you need to obtain information about the communication options available to your account or organization. the endpoint returns details about each channel, which may include channel ids, types (e.g., voice, sms), and their current status. this tool is particularly useful for applications that need to dynamically adjust their communication strategies based on available channels or for monitoring the health and availability of different communication methods in dialpad. note that this endpoint likely returns only basic channel information and may not include detailed usage statistics or real-time activity data.
</Accordion>

<Accordion title="Patch access control policy by id">
  This endpoint allows you to update an existing access control policy in the dialpad system. it provides the ability to modify various attributes of a policy, including its name, description, associated permissions, and state. this endpoint is particularly useful for adjusting policy settings as organizational needs change or for reactivating deleted policies. it's important to note that only company administrators can perform this operation, and care should be taken when modifying permissions to ensure appropriate access levels are maintained. the endpoint doesn't return the updated policy details, so a separate get request may be necessary to confirm changes.
</Accordion>

<Accordion title="Get departments by office id">
  Retrieves a list of all departments associated with a specific office in the dialpad system. this endpoint is essential for understanding the organizational structure within a company's dialpad account. it should be used when there's a need to view, manage, or analyze the departmental breakdown of a particular office. the endpoint provides a comprehensive overview of the office's internal structure, which can be valuable for administrative tasks, reporting, or integration with other systems. note that this endpoint only returns department information and does not provide details about individual users within those departments.
</Accordion>

<Accordion title="Fetch call byid">
  Retrieves detailed information about a specific call using its unique identifier. this endpoint allows developers to access comprehensive data about a particular call made through the dialpad platform. it should be used when you need to fetch specific call details for purposes such as logging, analysis, or displaying call information to users. the endpoint provides a snapshot of the call at the time of the request, including details like duration, participants, and call status. it does not provide real-time updates for ongoing calls; for that, you would need to poll the endpoint or use a different real-time communication method. this endpoint is particularly useful for applications that need to integrate call history or detailed call records from dialpad.
</Accordion>

<Accordion title="List offices endpoint">
  Retrieves a list of offices within the dialpad platform. this endpoint provides access to office information, which is crucial for managing multiple offices in an organization using dialpad. it should be used when you need to obtain an overview of all offices or gather specific details about offices registered in the dialpad system. the endpoint likely returns essential information such as office names, locations, administrators, and possibly user counts or other relevant metadata. it's important to note that this endpoint does not modify any office data and is intended for read-only operations. keep in mind that the returned data may be subject to the user's permissions within the dialpad system.
</Accordion>

<Accordion title="Get subscription contact by id">
  Retrieves the subscription information for a specific contact in the dialpad system. this endpoint allows you to access details about a contact's current subscription status, type, and related information. use this when you need to check or verify the subscription details for a particular contact, such as during account management or support processes. the endpoint focuses solely on subscription data and does not provide other contact information or modify any existing data. it's particularly useful for scenarios involving subscription management, billing inquiries, or when integrating dialpad's contact subscription system with other applications.
</Accordion>

<Accordion title="List users">
  Retrieves a list of users from the dialpad system. this endpoint allows you to fetch user account information, which is essential for user management and provisioning tasks. it can be used to sync user data with external systems, perform audits, or gather information for reporting purposes. the endpoint likely supports pagination and filtering options to manage large sets of user data efficiently. however, it does not provide real-time updates or webhook functionality for user changes - separate endpoints or features would be needed for those use cases.
</Accordion>

<Accordion title="Fetch call transcript by id">
  Retrieves the transcript for a specific call in the dialpad system. this endpoint allows you to fetch the text representation of the spoken content from a particular call or meeting. it's useful for reviewing conversation details, analyzing call content, or creating searchable records of communications. the transcript is generated using dialpad's ai-powered transcription feature, which provides accurate text conversion of audio content. use this endpoint when you need to access the written record of a call for purposes such as quality assurance, training, or content analysis. note that the availability and accuracy of transcripts may depend on the audio quality of the original call and the capabilities of the ai transcription system.
</Accordion>

<Accordion title="List conference rooms">
  Retrieves a list of conference rooms available in the dialpad system. this endpoint allows users to fetch information about both virtual and physical conference rooms set up within their dialpad account. it can be used to gather details such as room names, capacities, and configurations for scheduling or managing meetings. the endpoint is particularly useful for applications that need to display available conference rooms or integrate dialpad's room information into third-party scheduling systems. note that this endpoint does not provide real-time availability of rooms or allow for booking; it's primarily for listing and describing the configured rooms.
</Accordion>

<Accordion title="Get available licenses for an office">
  Retrieves the number of available (unused) licenses for a specific office within a dialpad organization. this endpoint is used to check the current license capacity and availability before assigning new licenses to users or features. it provides essential information for office administrators to manage their license inventory effectively. the endpoint should be used when planning user onboarding, upgrading subscriptions, or performing license audits. note that this endpoint only returns information about unassigned licenses and does not provide details about currently assigned licenses or their usage.
</Accordion>

<Accordion title="Delete schedule report by id">
  Deletes a specific scheduled report from the dialpad system. this endpoint allows users to permanently remove a previously configured report that was set up for automatic generation and delivery. it should be used when a particular scheduled report is no longer needed or when you want to stop the automatic generation of a specific report. this operation cannot be undone, so it should be used with caution. the endpoint will not provide any information about the deleted report; it will only confirm the successful deletion or return an error if the operation fails.
</Accordion>

<Accordion title="Get call labels">
  Retrieves a list of all available call labels in the dialpad system. this endpoint allows users to fetch the current set of labels that can be applied to calls for categorization and management purposes. it's particularly useful for applications that need to display or use the full range of call labeling options in their interface or logic. the endpoint returns a collection of call labels, likely including their names and any associated metadata. it should be used when initializing call management interfaces or when needing to synchronize local label data with the current state in dialpad. note that this endpoint does not provide information about which labels are applied to specific calls; it only returns the set of available labels.
</Accordion>

<Accordion title="Delete room by id">
  Deletes a specific room from the dialpad system using its unique identifier. this endpoint should be used when you need to remove a room that is no longer in use or has been decommissioned, such as a closed conference room or a removed reception desk. the deletion is permanent and cannot be undone, so use this endpoint with caution. it's important to note that deleting a room will also remove any associated configurations, such as room phone settings or extensions. this operation is part of dialpad's room management functionality and helps maintain an up-to-date inventory of active rooms in your organization.
</Accordion>

<Accordion title="Retrieve access control policy assignments">
  Retrieves the assignments of a specific access control policy in dialpad. this endpoint allows company administrators to view which users, roles, or groups have been assigned to a particular access control policy. it's useful for auditing and managing permissions within the dialpad platform. the endpoint returns a list of assignments, which may include user ids, role names, or group identifiers associated with the specified policy. use this when you need to review or verify the current assignments of an access control policy, such as during security audits or when updating user permissions. note that this endpoint only provides assignment information and does not allow for modifying the assignments.
</Accordion>

<Accordion title="Get call center status by id">
  Retrieves the current operational status of a specific call center in the dialpad system. this endpoint allows you to get real-time information about a call center's state, which can include details such as whether it's active, the number of agents available, current call volume, or any ongoing issues. it's particularly useful for monitoring call center performance, making informed decisions about resource allocation, or triggering automated workflows based on the call center's status. the endpoint should be used when you need up-to-the-minute information about a call center's operational condition, but it does not provide historical data or detailed analytics.
</Accordion>

<Accordion title="Get user deskphones">
  Retrieves detailed information about a specific deskphone associated with a particular user in the dialpad system. this endpoint is useful when you need to access or verify the configuration, status, or other attributes of a user's deskphone. it should be used when you have both the user's id and the specific deskphone id, and need to fetch the most up-to-date information about that device. this endpoint does not modify any data and is safe for frequent calls, but consider caching the results if you're making multiple requests for the same deskphone in a short period.
</Accordion>

<Accordion title="Patch websocket signature secret">
  Updates the signature secret for a specific websocket connection in the dialpad platform. this endpoint allows you to modify the authentication mechanism used to validate incoming requests to the websocket. use this when you need to rotate the secret for security reasons or when setting up a new authentication scheme for an existing websocket. the update affects future validations and may require updating the secret on the client-side as well. be cautious when using this endpoint, as it can potentially disrupt active connections if not managed properly. note that setting the secret to null effectively removes any signature validation for the websocket, which should only be done if alternative security measures are in place.
</Accordion>

<Accordion title="Patch agent status event subscription">
  Updates an existing agent status subscription in the dialpad system. this endpoint allows you to modify the configuration of a subscription that tracks changes in agent statuses within a contact center environment. use this to adjust the subscription's enabled state, change the associated logging endpoint, or update the agent type. it's particularly useful for maintaining up-to-date event tracking setups as your contact center needs evolve. note that all fields are optional, allowing for partial updates to the subscription. be cautious when changing the endpoint id, as this will affect where status change events are sent.
</Accordion>

<Accordion title="Post call event subscription">
  Creates a new call event subscription in the dialpad system, allowing real-time notifications for various call states and actions. this endpoint enables developers to set up targeted event streams for specific call centers, users, or other entities within dialpad. use this when you need to monitor call activities, automate workflows based on call states, or integrate dialpad's call data with external systems. the subscription can be fine-tuned to listen for specific call states and target types, making it versatile for various use cases such as call monitoring, analytics, or custom integrations. note that while the subscription can be created with this endpoint, you'll need to have a properly configured webhook or websocket to receive the events.
</Accordion>

<Accordion title="Get user caller id">
  Retrieves the caller id information for a specific user in the dialpad system. this endpoint allows you to fetch the current caller id settings associated with a user's account, which may include their display name, phone number, or other identifying information used when making outbound calls. it's particularly useful for administrators or integrations that need to verify or display a user's current caller id configuration. the endpoint should be used when you need to check or display a user's caller id settings, but not for modifying these settings. note that this endpoint only provides read access to the caller id information and cannot be used to update or change the caller id settings.
</Accordion>

<Accordion title="Patch subscription changelog endpoint">
  Updates an existing change log event subscription in the dialpad system. this endpoint allows you to modify the status of a subscription and associate it with a specific logging endpoint. use this when you need to enable or disable notifications for system changes or when you want to change the destination for these notifications. the endpoint is particularly useful for managing event-driven integrations and maintaining up-to-date information flows between dialpad and external systems. note that updating a subscription does not create new events; it only affects future notifications for the specified change log.
</Accordion>

<Accordion title="Patch call router by id">
  Updates an existing call router in the dialpad system. this endpoint allows you to modify various settings of a call router, including its default target, enabled state, name, office association, error handling, routing url, and authentication secret. use this when you need to change the behavior or configuration of an existing call router. the endpoint is particularly useful for adjusting routing logic, updating fallback options, or managing error states. note that while all parameters are optional, providing at least one is necessary to make meaningful changes. be cautious when updating critical parameters like the routing url or secret, as incorrect values could disrupt call routing.
</Accordion>

<Accordion title="Patch user active call recording">
  Updates the call recording settings for an active call of a specific dialpad user. this endpoint allows real-time management of call recording features during an ongoing call, including enabling or disabling recording, controlling the playback of recording indication messages, and specifying the scope of recording for group calls. it should be used when there's a need to dynamically change recording settings mid-call, such as for compliance purposes or user preferences. this endpoint is only effective for active calls and will not affect future calls or general user settings. note that all parameters are optional, allowing for granular control over specific aspects of call recording without affecting others.
</Accordion>

<Accordion title="Get deskphones for user parent id">
  Retrieves a list of deskphones associated with a specific user in the dialpad system. this endpoint is useful for managing and tracking the deskphone inventory assigned to individual users within an organization. it can be used to audit user equipment, troubleshoot connectivity issues, or gather information for user setup and onboarding processes. the endpoint returns details about all deskphones linked to the specified user, which may include information such as deskphone models, serial numbers, and configuration status. this tool should be used when you need to obtain a comprehensive view of a user's assigned deskphone equipment in dialpad.
</Accordion>

<Accordion title="Get deskphones in rooms">
  Retrieves a list of deskphones associated with a specific room in the dialpad system. this endpoint is used to get detailed information about the communication devices deployed in shared spaces such as conference rooms, reception areas, or phone booths. it provides an overview of the deskphones' configuration and status within the context of a particular room. use this endpoint when you need to inventory, manage, or troubleshoot deskphones in a specific location. the response likely includes details such as deskphone models, serial numbers, configuration status, and any associated user information. this tool is particularly useful for it administrators and facilities managers who need to maintain an up-to-date record of communication equipment in various rooms across the organization.
</Accordion>

<Accordion title="Remove blocked numbers">
  Removes specified phone numbers from the blocked list in the dialpad system. this endpoint allows you to unblock multiple phone numbers in a single api call, streamlining the process of managing blocked numbers. use this when you need to restore communication capabilities with previously blocked numbers, such as when a number is no longer considered spam or when a block was applied in error. the endpoint accepts a list of e164 formatted numbers, ensuring standardized input across different countries and number formats. note that this operation is irreversible; once numbers are removed from the blocked list, they will be able to communicate with your dialpad account unless blocked again.
</Accordion>

<Accordion title="Get call review share link by id">
  Retrieves or generates a share link for a specific call review in the dialpad system. this endpoint allows users to obtain a unique url that can be used to share call review data, including summaries, transcripts, or analysis, with other team members or external parties. the share link provides a convenient way to collaborate on call reviews without requiring direct access to the dialpad platform. this tool should be used when a user needs to distribute call review information quickly and securely. it's particularly useful for managers sharing feedback, trainers providing examples, or team members collaborating on customer interactions. the endpoint does not provide the actual call review content, only the means to access it via the generated link.
</Accordion>

<Accordion title="Get user e911 details">
  Retrieves the enhanced 911 (e911) information for a specific user in the dialpad system. this endpoint provides critical location data associated with the user's account, which is essential for emergency services to accurately locate the caller during an emergency. it should be used when setting up or verifying a user's emergency contact information, ensuring compliance with e911 regulations for voip services. the tool returns the current e911 configuration for the specified user, including registered address and any additional location details. it's important to note that this endpoint only retrieves information and does not modify any e911 settings.
</Accordion>

<Accordion title="Retrieve access control policy by id">
  Retrieves detailed information about a specific access control policy in the dialpad system. this endpoint allows administrators to fetch the configuration and settings of a particular policy, which defines custom permissions and access levels for users within the dialpad platform. use this endpoint when you need to review or audit the settings of an existing access control policy. it's particularly useful for verifying policy details before making modifications or when troubleshooting access-related issues. the endpoint returns comprehensive information about the policy but does not allow for modifications; separate endpoints would be used for updating policies.
</Accordion>

<Accordion title="Post subscription change log event">
  Creates or updates a subscription for changelog events in the dialpad system. this endpoint allows developers to set up real-time notifications for changes and updates within dialpad, such as api modifications, feature releases, or system updates. by configuring this subscription, you can ensure your application stays informed about important changes that may affect its integration with dialpad. the subscription can be enabled or disabled as needed, and notifications are sent to a pre-configured webhook or websocket endpoint. use this when you need to monitor dialpad's evolving features and api changes to maintain compatibility and leverage new functionalities promptly.
</Accordion>

<Accordion title="Retrieve callcenter operators by id">
  Retrieves a list of operators associated with a specific call center in dialpad. this endpoint allows you to fetch detailed information about the operators working in a particular call center, which is essential for managing call center operations, monitoring staff, and optimizing workload distribution. use this endpoint when you need to view the current roster of operators, check staffing levels, or gather operator details for reporting purposes. the endpoint returns operator information but does not provide real-time status updates or allow modifications to operator data. it's particularly useful for integrations that require synchronization of call center staff information with external systems or for building custom dashboards to monitor call center composition.
</Accordion>

<Accordion title="Fetch custom ivrs">
  Retrieves a list of all custom interactive voice response (ivr) configurations associated with the authenticated dialpad account. this endpoint allows developers to fetch comprehensive details about the custom ivrs set up in their dialpad system, including menu structures, voice prompts, and routing rules. it's particularly useful for auditing existing ivr setups, gathering information for reporting purposes, or syncing ivr configurations with external systems. the endpoint returns all custom ivrs by default, without requiring any parameters. however, it does not provide real-time analytics or call logs related to these ivrs. use this endpoint when you need an overview of your ivr landscape or when preparing to make bulk updates to your ivr configurations.
</Accordion>

<Accordion title="Retrieve agent status subscription">
  Retrieves a list of agent status subscriptions from the dialpad system. this endpoint allows you to fetch real-time information about the current subscriptions to agent status events. it is useful for monitoring which agents or systems are subscribed to receive updates about changes in agent statuses, such as availability or activity. this tool should be used when you need to audit or manage the subscriptions related to agent status events in your dialpad integration. note that this endpoint does not provide the actual agent statuses, but rather information about the subscriptions to these status updates.
</Accordion>

<Accordion title="Get webhooks information">
  Retrieves a list of all webhooks configured for the authenticated user's dialpad account. this endpoint allows developers to view and manage their existing webhook subscriptions for various communication events such as calls, sms, contacts, and agent status changes. it should be used when you need to audit your current webhook configurations, verify the status of your integrations, or gather information before modifying existing webhooks. the endpoint provides an overview of active webhooks but does not include detailed event data or allow for webhook creation or modification.
</Accordion>

<Accordion title="Retrieve agent status by id">
  Retrieves detailed information about a specific agent status subscription using its unique identifier. this endpoint is used to fetch the current configuration and settings of an agent status subscription, which may include details such as the associated agent, status types being tracked, and any custom off-duty statuses. it's particularly useful for administrators or supervisors who need to review or troubleshoot individual agent status subscriptions. the endpoint does not modify any data and is safe for frequent calls to keep the client application updated with the latest subscription information. note that this endpoint only provides details for a single subscription and cannot be used to list multiple subscriptions or modify existing ones.
</Accordion>

<Accordion title="Post users screenpop uri">
  Triggers a screen pop for a specific dialpad user, displaying relevant information during a call or communication event. this endpoint should be used when you need to automatically present contextual data to a user's screen, such as customer information from a crm system. it's particularly useful in contact center scenarios where agents need quick access to caller details. the screen pop url can be a web page or a custom uri to launch a native application. note that this endpoint does not retrieve or send any customer data directly; it only initiates the display of the specified url on the user's device.
</Accordion>

<Accordion title="Retrieve call centers information">
  Retrieves a list of call centers and their associated information from the dialpad platform. this endpoint allows developers to fetch details about all call centers configured in the dialpad account, including their settings, agent statuses, and operational metrics. it's particularly useful for applications that need to monitor or manage multiple call centers, analyze call center performance, or integrate call center data with other systems. the endpoint returns comprehensive data about each call center, which can be used for reporting, dashboard creation, or automating call center management tasks. note that this endpoint provides a high-level overview of call centers and may not include granular details about individual calls or agents.
</Accordion>

<Accordion title="Retrieve blocked phone numbers">
  Retrieves a comprehensive list of all phone numbers that have been blocked through the dialpad api. this endpoint is useful for managing call blocking settings and reviewing the current state of blocked numbers associated with your dialpad account. it provides a straightforward way to fetch all blocked numbers without the need for additional parameters. use this endpoint when you need to audit your blocked number list, verify if a specific number is blocked, or prepare for bulk operations on blocked numbers. keep in mind that this endpoint only returns numbers blocked via the api and may not include numbers blocked through other methods in the dialpad interface.
</Accordion>

<Accordion title="Fetch operators for office id">
  Retrieves a list of operators associated with a specific office in dialpad. this endpoint should be used when you need to get information about the operators managing calls and operations within a particular office. it's useful for auditing office structure, managing call center operations, or gathering data for reporting purposes. the endpoint returns details about the operators, which may include their names, ids, roles, and current statuses. note that this endpoint only provides information about operators and does not allow for modifying operator data or office structure.
</Accordion>

<Accordion title="Retrieve call center by id">
  Retrieves detailed information about a specific call center in the dialpad system. this endpoint allows you to fetch comprehensive data about a call center, including its configuration, associated agents, and operational metrics. use this when you need to access or review the current state and settings of a particular call center. the endpoint is particularly useful for administrators managing multiple call centers or for integrations that need up-to-date call center information. note that this endpoint only provides read access and cannot be used to modify call center details.
</Accordion>

<Accordion title="Retrieve call routers v2 api">
  Retrieves a list of call routers configured in the dialpad system. this endpoint allows you to fetch information about the call routing setup in your dialpad account, including details such as router identifiers, associated dedicated dids, and routing rules. it's particularly useful for auditing your current call routing configuration or gathering data for reporting purposes. the endpoint provides read-only access to call router information and does not allow modifications to the routing setup. use this when you need to review your call routing structure or integrate call routing information into your applications for advanced call management or analytics.
</Accordion>

<Accordion title="Patch user status">
  Updates the status of a specific user in the dialpad system. this endpoint allows you to set or modify a user's status message and optionally specify an expiration time for that status. it's particularly useful for indicating a user's availability, current activity, or temporary absence. the endpoint should be used when you need to programmatically update a user's status, such as integrating with calendar systems, automatic out-of-office settings, or custom workflow automations. it's important to note that this endpoint updates the status for a single user identified by their id in the url path. the status update is immediate, and if an expiration is set, the status will automatically clear at the specified time. this tool does not retrieve the current status; it only updates it. if you need to fetch the current status before updating, you would need to use a separate get endpoint (not provided in this schema).
</Accordion>

<Accordion title="Post websocket connection secret">
  Creates a websocket connection for real-time communication with the dialpad platform. this endpoint enables applications to establish a persistent, full-duplex connection for receiving live updates and event notifications from dialpad. use this when you need to implement features that require instant updates, such as live call status changes, message delivery notifications, or agent availability updates. the websocket connection allows for efficient, low-latency communication, reducing the need for frequent polling of other api endpoints. note that while this endpoint creates the connection, you'll need to implement appropriate event listeners and handlers in your application to process the incoming data streams effectively.
</Accordion>

<Accordion title="Retrieve callrouter by id">
  Retrieves detailed information about a specific call router in the dialpad system. this endpoint allows developers to fetch the configuration and status of a call router by providing its unique identifier. use this when you need to check the current settings, routing rules, or other properties of a particular call router. it's particularly useful for auditing your call routing setup or before making changes to an existing router. the endpoint returns read-only data and does not modify any settings.
</Accordion>

<Accordion title="Retrieve app settings">
  Retrieves the current application settings for the authenticated dialpad account. this endpoint provides access to various configuration options and preferences set for the dialpad application. it should be used when you need to review or audit the current app settings, such as user interface preferences, notification settings, or integration configurations. the endpoint returns a comprehensive list of all available settings, which can be useful for troubleshooting, customization, or ensuring consistency across different instances of the application. note that this endpoint is read-only and does not allow for modifying settings; separate endpoints would be required for updating individual settings.
</Accordion>

<Accordion title="Retrieve call subscription by id">
  Retrieves detailed information about a specific call subscription in the dialpad system. this endpoint allows developers to access the current state and configuration of a call subscription, which is used for tracking and receiving notifications about call-related events. it's particularly useful for monitoring the status of automated workflows or integrations that depend on call data. the endpoint should be used when you need to check the details of a single, known call subscription, such as its activation status, associated phone numbers, or event types it's configured to track. it will not modify the subscription or return data about multiple subscriptions.
</Accordion>

<Accordion title="Modify contact details using id">
  Updates an existing contact's information in the dialpad system. this endpoint allows for partial updates of contact details, including personal information, communication details, and associated urls. it's used when you need to modify or add information to an existing contact record. the endpoint supports updating multiple fields simultaneously, making it efficient for bulk changes or comprehensive contact updates. note that all fields are optional, allowing for targeted updates without affecting other contact information. when updating list-based fields like emails or phones, the provided lists will replace the existing data entirely.
</Accordion>

<Accordion title="Retrieve channel by id">
  Retrieves detailed information about a specific communication channel in the dialpad platform using its unique identifier. this endpoint allows developers to fetch comprehensive data about a particular channel, which can include its type (e.g., voice, video, or messaging), current status, associated users or groups, and other relevant metadata. it is particularly useful when you need to access or verify the properties of a specific channel within your application. the endpoint should be used when detailed information about a known channel is required, such as during channel management tasks, reporting, or when integrating channel-specific features into your application. note that this endpoint only provides information for a single channel at a time and does not support batch retrieval or listing of multiple channels.
</Accordion>

<Accordion title="Retrieve blocked number details">
  Retrieves information about a specific blocked number in the dialpad system. this endpoint allows users or administrators to check if a particular phone number is currently blocked. it's useful for verifying the status of a number before attempting communication or when reviewing security settings. the endpoint returns details about the blocked number, which may include when it was blocked and any associated metadata. it should be used when there's a need to confirm the blocked status of a specific number, but it won't provide a list of all blocked numbers or modify any existing blocks.
</Accordion>

<Accordion title="Fetch scheduled reports">
  Retrieves a list of scheduled reports from the dialpad system. this endpoint allows users to fetch information about reports that have been set up for automatic generation on a regular basis. it's particularly useful for administrators or users who need to review or manage the scheduled reporting configuration within their dialpad account. the endpoint supports filtering by report type, frequency, and date range, making it easy to find specific scheduled reports. it should be used when there's a need to audit existing report schedules, verify report configurations, or gather information about automated reporting processes in place. note that this endpoint only provides metadata about the scheduled reports, not the actual report content itself. it's ideal for getting an overview of reporting activities but not for accessing the report data directly.
</Accordion>

<Accordion title="Retrieve coaching teams information">
  Retrieves information about coaching teams in the dialpad platform. this endpoint allows users to fetch details about existing coaching teams, which are essential for managing call monitoring, feedback, and agent performance improvement. it provides an overview of team structures, including coaches, trainees, and associated settings. the endpoint is useful for administrators and managers who need to review or manage coaching team configurations across the organization. note that while this endpoint retrieves team information, it does not modify any team settings or structures.
</Accordion>

<Accordion title="Reassign phone number to target">
  Assigns or reassigns a phone number to a specific target within the dialpad system. this endpoint allows you to associate a phone number with various entities such as users, departments, call centers, or other supported target types. use this when you need to allocate or reallocate phone numbers across your dialpad organization. the endpoint is particularly useful for managing phone number assignments during user onboarding, department restructuring, or call center setup. note that this operation may affect existing call routing and should be used cautiously in production environments.
</Accordion>

<Accordion title="Retrieve coaching team by id">
  Retrieves detailed information about a specific coaching team in dialpad. this endpoint allows users to fetch comprehensive data about a coaching team, including its configuration, members (coaches and trainees), settings, and potentially performance metrics. it should be used when detailed information about a particular coaching team is needed, such as for displaying team details, verifying settings, or analyzing team performance. the endpoint provides a snapshot of the coaching team's current state and does not modify any data. it's particularly useful for managers or administrators who need to review or audit coaching team setups.
</Accordion>

<Accordion title="Fetch transcript url by call id">
  Retrieves the url of a transcript for a specific call in the dialpad system. this endpoint allows developers to access the text version of a call's audio content by providing the unique identifier of the call. the returned url can be used to fetch the actual transcript content. this tool is particularly useful when you need to programmatically access call transcripts for analysis, record-keeping, or integration with other systems. it should be used when a user needs to obtain the transcript url for a known call id, but not for directly retrieving the transcript content itself.
</Accordion>

<Accordion title="Retrieve contact list">
  Retrieves a list of contacts from the dialpad platform. this endpoint allows you to fetch contact information, which is crucial for managing user data and communication records within your dialpad-integrated application. it supports pagination, searching, and sorting to efficiently handle large contact lists. use this endpoint when you need to access or display contact information, sync contacts with other systems, or perform contact-related operations in your application. the endpoint returns basic contact details, but may not include sensitive information or full communication history.
</Accordion>

<Accordion title="Redeem access or refresh token">
  The oauth 2.0 token endpoint for dialpad's api is used to obtain access tokens for authenticating api requests. it supports two grant types: authorization code and refresh token. for the authorization code flow, it exchanges an authorization code for an access token, enabling secure user authentication without exposing credentials. the refresh token flow allows obtaining a new access token when the current one expires, maintaining long-term access without user intervention. this endpoint is crucial for implementing oauth 2.0 authentication in applications integrating with dialpad's api, ensuring secure and authorized access to user data and dialpad services.
</Accordion>

<Accordion title="Retrieve contact by id">
  Retrieves detailed information for a specific contact in your dialpad account using the contact's unique identifier. this endpoint allows you to fetch comprehensive data about a single contact, including their name, phone numbers, email addresses, and any custom fields associated with the contact. use this when you need to access or display detailed information about a particular contact in your application. the endpoint is useful for scenarios such as populating contact details in a crm integration or displaying contact information during an active call. note that this endpoint only retrieves information for one contact at a time and does not support batch retrieval or searching across multiple contacts.
</Accordion>

<Accordion title="Fetch user details by id">
  Retrieves detailed information about a specific user in the dialpad system. this endpoint is used to fetch comprehensive user data, including profile details, account settings, and associated communication information. it's particularly useful for user management tasks, such as verifying user information, updating records in external systems, or displaying user profiles in integrated applications. the endpoint returns a single user object based on the provided user id. it should be used when detailed information about a particular user is needed, but it will not provide aggregate data or information about multiple users simultaneously. note that the specific fields returned may depend on the requester's permissions and the user's privacy settings.
</Accordion>

<Accordion title="Get deskphone by parent id">
  Retrieves detailed information about a specific deskphone within a designated room or parent entity in the dialpad system. this endpoint is useful for obtaining the current configuration, status, and attributes of a particular deskphone device. it should be used when you need to access or verify the details of a single deskphone, such as during troubleshooting, inventory management, or when updating device settings. the endpoint does not modify any data and is intended for read-only operations. keep in mind that the response will only provide information about the specified deskphone and will not include details about other devices or the parent entity itself.
</Accordion>

<Accordion title="Retrieve department operators by id">
  Retrieves a list of operators associated with a specific department in dialpad. this endpoint allows you to fetch detailed information about the operators assigned to a particular department, enabling efficient management of department resources and personnel. use this endpoint when you need to review, audit, or manage the operators within a specific department. the response likely includes operator details such as names, contact information, and roles. note that this endpoint does not modify any department or operator data; it is for retrieval purposes only. it's particularly useful for administrative tasks, reporting, and ensuring proper staffing across departments.
</Accordion>

<Accordion title="Retrieve company data">
  Retrieves detailed information about a specific company within the dialpad platform. this endpoint allows developers to access various company-level data, such as company name, settings, and other relevant details. it should be used when an application needs to fetch or display company information, update local records, or verify company-specific configurations. the endpoint provides a comprehensive view of a company's profile in dialpad but does not modify any data. note that the specific fields returned may depend on the user's permissions and the company's privacy settings.
</Accordion>

<Accordion title="Retrieve e911 office details">
  Retrieves the enhanced 911 (e911) settings for a specific office within the dialpad communication platform. this endpoint allows administrators to fetch crucial emergency service configuration details associated with a particular office location. it should be used when auditing or verifying e911 compliance, updating emergency response information, or integrating office-specific emergency settings into external systems. the endpoint provides read-only access to e911 data and does not allow modifications. it's important to note that this tool only retrieves settings for a single office at a time and does not provide aggregate data across multiple offices.
</Accordion>

<Accordion title="Retrieve list of departments">
  Retrieves a list of departments for a specified office within the dialpad organization. this endpoint is essential for obtaining the organizational structure and can be used to populate department selectors, generate reports, or manage team assignments. it returns basic information about each department, such as its name, id, and possibly the number of members. the endpoint should be used when needing an up-to-date view of the departmental structure within an office. it does not provide detailed information about individual department members or historical data about department changes. pagination parameters may be necessary for offices with a large number of departments to manage response sizes and api performance.
</Accordion>

<Accordion title="Retrieve members of coaching team by id">
  Retrieves a list of members belonging to a specific coaching team in dialpad. this endpoint allows you to fetch all users assigned to a particular coaching team, including both coaches and trainees. it's useful for getting an overview of team composition, managing team members, or integrating team information into other systems. the endpoint returns member details, which may include user ids, names, roles, and other relevant information. use this when you need to review or analyze the current membership of a coaching team, or when syncing team data with external applications.
</Accordion>

<Accordion title="Retrieve numbers via api v2">
  Retrieves a list of phone numbers associated with the user's dialpad account. this endpoint allows users to view all the phone numbers they have access to, which may include both assigned and unassigned numbers. it's useful for inventory management, number allocation, and auditing purposes. the endpoint returns basic information about each number, such as its value, status, and associated user or department. it does not modify any data and is safe for frequent polling. note that the response may be paginated for large number inventories, and additional calls may be needed to retrieve the full list.
</Accordion>

<Accordion title="Retrieve department by id">
  Retrieves detailed information about a specific department within the dialpad organization. this endpoint allows you to fetch comprehensive data about a department, including its name, description, member count, and other relevant attributes. use this endpoint when you need to access or display information about a particular department, such as for department management interfaces or generating reports. the endpoint returns the most up-to-date information available for the specified department. note that this endpoint only provides read access to department data and cannot be used to modify department information.
</Accordion>

<Accordion title="Retrieve conference meetings">
  Retrieves information about conference meetings in the dialpad platform. this endpoint allows users to fetch details about scheduled, ongoing, or past conference meetings, providing valuable data for managing and analyzing virtual collaboration sessions. it can be used to obtain an overview of meeting activities, track usage patterns, or gather information for reporting purposes. the endpoint is particularly useful for administrators or team leaders who need to monitor conference usage across their organization. note that while this endpoint retrieves meeting data, it does not provide real-time control over active meetings or allow for meeting creation or modification.
</Accordion>

<Accordion title="Retrieve office plan by id">
  Retrieves the current plan details for a specific office in your dialpad organization. this endpoint allows you to fetch information about the subscribed features, limitations, and other plan-specific details for a given office. use this endpoint when you need to review or verify the current plan status of an office, such as during account management or when considering plan upgrades. the response will likely include details such as the plan name, included features, user limits, and any custom configurations. note that this endpoint only provides read-only access to plan information and cannot be used to modify or update the office plan.
</Accordion>

<Accordion title="Get office call centers">
  Retrieves a list of call centers associated with a specific office in the dialpad platform. this endpoint allows administrators and developers to fetch information about all call centers within a given office, which is useful for managing and organizing communication resources. use this endpoint when you need to get an overview of call center units within an office, such as for reporting, resource allocation, or integration purposes. the endpoint returns basic information about each call center, but detailed configuration or real-time status may require additional api calls.
</Accordion>

<Accordion title="Retrieve office by id">
  Retrieves detailed information about a specific office within the dialpad system. this endpoint should be used when you need to access comprehensive data about a particular office, such as its name, location, assigned users, or custom settings. it's particularly useful for administrative tasks, reporting, or displaying office information in integrated applications. the endpoint returns all available details for the specified office, making it efficient for obtaining a complete office profile in a single api call. however, it does not allow for modifying office information or retrieving data for multiple offices simultaneously.
</Accordion>

<Accordion title="Get operator skills by call center and user">
  Retrieves the skill information for a specific operator within a designated call center. this endpoint allows you to access details about an operator's assigned skills, which are crucial for efficient call routing and task assignment in the call center environment. use this endpoint when you need to review or verify an operator's capabilities, such as language proficiency, technical expertise, or customer service specialization. the retrieved information can be valuable for workforce management, skill-based routing configurations, and ensuring optimal operator-to-task matching. note that this endpoint only provides skill data and does not allow for skill modification; separate endpoints would be required for updating skills.
</Accordion>

<Accordion title="Hangup call via id">
  Terminates an active call in the dialpad system. this endpoint should be used when you need to programmatically end a specific ongoing call. it's particularly useful for automated call management, such as in customer service systems or when integrating dialpad's functionality into other applications. the endpoint has a rate limit of 1200 requests per minute, allowing for high-volume usage in busy call centers or large-scale communication systems. note that this action is irreversible; once a call is hung up, it cannot be reinstated, and a new call would need to be initiated if further communication is required.
</Accordion>

<Accordion title="Get call subscription details">
  Retrieves a list of call subscriptions associated with the authenticated user's account in the dialpad platform. this endpoint allows developers to fetch details about existing call event subscriptions, which are used to receive real-time updates on call states and activities. it should be used when an application needs to monitor or manage the current set of call subscriptions, such as for auditing purposes or to verify the existence of specific subscriptions. the endpoint does not create, modify, or delete subscriptions; it only provides read access to the existing subscription data. note that the response may include various types of call subscriptions, and developers should be prepared to handle different subscription formats or filters that may be present in the returned data.
</Accordion>

<Accordion title="Delete user by id">
  Deletes a user from the dialpad system based on the provided user id. this endpoint should be used when permanently removing a user's account and associated data from dialpad. it's important to note that deleted users can be restored for up to 72 hours after deletion, after which their records are anonymized. use this endpoint with caution as it will remove the user's access to dialpad services and may affect team structures or ongoing communications. this operation cannot be undone after the 72-hour restoration period.
</Accordion>

<Accordion title="Get channel members by id">
  Retrieves a list of members for a specific channel in dialpad. this endpoint allows you to fetch user information for all members associated with the given channel id. it's useful for obtaining an overview of channel participants, which can be helpful for managing team collaboration, assigning tasks, or analyzing channel activity. the endpoint should be used when you need to access member details for a particular channel, such as when displaying member lists, checking channel membership, or performing channel-related operations that require knowledge of its members. note that this endpoint only provides member information and does not modify the channel or its membership.
</Accordion>

<Accordion title="Delete subscription changelog by id">
  Deletes a specific changelog entry from a subscription in the dialpad system. this endpoint is used to permanently remove a record of changes made to a subscription, which could include modifications to webhook configurations, event subscriptions, or other subscription-related settings. it should be used when you need to clean up or remove outdated or erroneous changelog entries. be cautious when using this endpoint, as deleting changelog entries may affect auditing and tracking capabilities. note that this operation is irreversible, and once a changelog entry is deleted, it cannot be recovered. this endpoint is part of dialpad's subscription management api and helps maintain an accurate and up-to-date record of subscription changes.
</Accordion>

<Accordion title="Retrieve coaching stats v2">
  The getstatistics endpoint retrieves comprehensive statistics for various aspects of dialpad usage, including calls, customer satisfaction (csat), dispositions, on-duty status, recordings, screen shares, texts, and voicemails. it offers flexible options for targeting specific users, groups, or offices, and allows for customized date ranges and aggregation methods. this endpoint is particularly useful for analyzing performance metrics, tracking customer satisfaction, and gaining insights into communication patterns within an organization. it supports both aggregated statistics and individual record retrieval, making it versatile for different analytical needs. however, users should note that certain stat types (like csat and dispositions) require specific targeting parameters and only support individual record retrieval.
</Accordion>

<Accordion title="Get phone number details">
  Retrieves detailed information about a specific phone number associated with the dialpad account. this endpoint allows you to fetch comprehensive data about a single phone number, including its current status, assigned user or department, tags, and other relevant attributes. use this endpoint when you need to access or verify the details of a particular phone number within your dialpad system. it's particularly useful for auditing phone number assignments, checking number status, or retrieving associated metadata. the endpoint does not modify any data and is safe for frequent use, making it ideal for real-time information retrieval or periodic synchronization with external systems.
</Accordion>

<Accordion title="Initiate ivr call api endpoint">
  Initiates an outbound ivr (interactive voice response) call using the dialpad api. this endpoint allows you to programmatically start a call to a specified phone number from a designated group within your dialpad organization, such as a call center, department, or office. it's particularly useful for automating outbound calls, implementing scheduled call campaigns, or integrating dialpad's calling capabilities into your own applications. the endpoint provides options for customizing the call with additional data and managing the displayed caller id, enhancing flexibility in various use cases like customer service, sales outreach, or automated notifications.
</Accordion>

<Accordion title="Modify webhook configuration">
  Updates an existing webhook configuration in the dialpad api. this endpoint allows you to modify the destination url and/or the secret used for request validation of a specific webhook. use this when you need to change where webhook events are sent or update the security settings of an existing webhook. the endpoint is particularly useful for maintaining webhook configurations as your integration evolves or when you need to rotate security credentials. note that updating these settings will affect all future events for this webhook, so ensure your receiving endpoint is prepared for the changes before updating.
</Accordion>

<Accordion title="Move user to specified office">
  Updates a user's office assignment within the dialpad system. this endpoint allows administrators to move a user from their current office to a different office. it should be used when there's a need to change a user's organizational association, such as during departmental transfers or office relocations. the operation is performed by specifying the user's id in the url path and optionally providing the new office id in the request body. if no office id is provided, the user's current office assignment remains unchanged. this endpoint is particularly useful for managing organizational structure and ensuring users are correctly associated with their respective offices in dialpad.
</Accordion>

<Accordion title="Delete subscription contact by id">
  Deletes a specific subscription contact from the dialpad system. this endpoint should be used when you need to remove a contact from your subscription list, such as when a user unsubscribes or when cleaning up outdated contact information. the operation is irreversible, so use it with caution. this endpoint only handles the deletion process and does not return the deleted contact's information. it's important to note that this action may affect any ongoing subscriptions or notifications associated with the deleted contact.
</Accordion>

<Accordion title="Post recording share link">
  Creates a shareable link for a specific recording in dialpad, such as a call recording or voicemail. this endpoint allows users to generate a link that can be used to share recordings with others, with customizable privacy settings. it should be used when you need to create a url for sharing a recording outside of the dialpad interface. the endpoint requires specifying the recording id and type, and optionally allows setting the privacy level of the share link. note that this endpoint only creates the share link; it does not modify the recording itself or its storage location.
</Accordion>

<Accordion title="Delete webhook by id">
  Deletes a specific webhook subscription from the dialpad platform using its unique identifier. this endpoint should be used when you want to stop receiving real-time event notifications for a particular webhook. it's important to note that once a webhook is deleted, it cannot be recovered, and you will need to create a new webhook subscription if you wish to receive events again. this operation is useful for managing webhook subscriptions, especially when cleaning up outdated or unnecessary event listeners in your integration with dialpad.
</Accordion>

<Accordion title="Patch department details by id">
  Updates the settings and configuration of a specific department in the dialpad system. this endpoint allows for comprehensive modification of department properties, including operating hours, call routing strategies, hold queue settings, and voice intelligence features. it's particularly useful for adjusting department behavior to match changing business needs or to optimize call handling efficiency. the endpoint supports partial updates, allowing you to modify only the specific fields you need to change without affecting other settings.
</Accordion>

<Accordion title="Delete websocket connection by id">
  Closes and removes a specific websocket connection in the dialpad system. this endpoint should be used when an application needs to programmatically terminate a real-time event subscription or clean up unused websocket connections. it's particularly useful for managing resources and ensuring that inactive or unnecessary websocket connections are properly closed. this operation is irreversible, so it should be used with caution. once a websocket is deleted, any active subscriptions or real-time data streams associated with it will be immediately terminated.
</Accordion>

<Accordion title="Modify operator skill level">
  Updates the skill level of a specific operator in a designated call center. this endpoint allows administrators to adjust an operator's proficiency rating, which can be used for call routing, performance tracking, and workforce management. the skill level is represented as an integer from 0 to 100, with higher values indicating greater expertise. use this endpoint when you need to modify an operator's skill level based on performance reviews, training completion, or changes in responsibilities. it's particularly useful for maintaining an up-to-date and accurate representation of your call center team's capabilities.
</Accordion>

<Accordion title="Initiate outbound call via api">
  The initiateoutboundcall endpoint allows you to programmatically initiate an outbound call using the dialpad api. this tool is used to place calls on behalf of a dialpad user to a specified phone number. it supports various customization options, including setting custom caller id, associating the call with a group, and enabling consult mode for handling multiple calls. use this endpoint when you need to automate outbound calling in your application, such as for customer outreach, automated notifications, or integrating calling capabilities into your workflow. the endpoint is particularly useful for scenarios requiring programmatic call initiation, but it does not handle the actual call audio or provide real-time call control. be aware that the call's success depends on the user's dialpad account status and permissions.
</Accordion>

<Accordion title="Modify custom ivr settings">
  Updates a custom interactive voice response (ivr) configuration for a specific target within the dialpad system. this endpoint allows you to assign an existing ivr workflow to a particular target (such as a call center or department) and specify its application for inbound, outbound, or both types of calls. it's particularly useful for customizing call routing and auto-recording settings in call centers. the endpoint requires specifying the target type, target id, and ivr type in the url path, along with the ivr id in the request body. use this when you need to modify ivr settings for specific departments or call centers in your dialpad organization.
</Accordion>

<Accordion title="Oauth2 authorize endpoint">
  Initiates the oauth 2.0 authorization process for the dialpad api. this endpoint is the entry point for obtaining user consent and generating an authorization code, which can later be exchanged for an access token. it should be used when an application needs to request permission to access a user's dialpad resources. the endpoint will redirect the user to dialpad's login and consent page. after the user grants permission, they will be redirected back to the specified redirect uri with an authorization code. this endpoint is crucial for implementing secure, user-authorized access to dialpad's api features.
</Accordion>

<Accordion title="Get rooms list">
  Retrieves a list of all available meeting rooms or spaces within the dialpad system. this endpoint is essential for managing and organizing video-enabled meetings, allowing users to view and select appropriate meeting spaces for their needs. it provides an overview of both physical conference rooms and virtual meeting spaces, supporting dialpad's hybrid team collaboration features. use this endpoint when you need to display available rooms, check room capabilities, or integrate room selection into scheduling workflows. the response likely includes details such as room names, capacities, available equipment (e.g., poly studio x integration), and potentially real-time availability status. this endpoint does not create or modify rooms; it's purely for fetching room information. keep in mind that the returned data may need to be combined with calendar integration data to provide a complete picture of room availability.
</Accordion>

<Accordion title="Retrieve call information">
  Retrieves call information from the dialpad system. this endpoint allows you to fetch details about one or more calls, which may include call duration, participants, timestamps, and other relevant metadata. it can be used to gather historical call data for analysis, reporting, or integration with other systems. the endpoint does not provide real-time call control or the ability to initiate new calls. note that the specific details returned may vary based on user permissions and the scope of the api token used.
</Accordion>

<Accordion title="Get recording share link by id">
  Retrieves detailed information about a specific recording share link in the dialpad system. this endpoint allows you to fetch the current status, settings, and metadata associated with a previously created share link for a call recording. it's particularly useful when you need to verify the current state of a share link, check its expiration status, or retrieve the associated recording details. the endpoint should be used when you have a valid recording share link id and need to access its up-to-date information. note that this endpoint only provides information about the share link itself and does not return the actual recording content.
</Accordion>

<Accordion title="Initiate user call with group options">
  Initiates an outbound call for a specified dialpad user. this endpoint allows you to programmatically start a phone call to a given number, with options to customize the call's properties such as the caller id and associated group. it's particularly useful for automating outbound calling processes or integrating dialpad's calling capabilities into other applications. the endpoint supports additional features like custom data association for call tracking and the ability to initiate calls through specific organizational groups. note that while the endpoint doesn't explicitly mark any parameters as required, a valid destination phone number is necessary to initiate a call.
</Accordion>

<Accordion title="Retrieve schedule report by id">
  Retrieves detailed information about a specific scheduled report in the dialpad system. this endpoint allows you to fetch the configuration and metadata of a pre-defined report, which may include communication metrics, analytics, or other relevant data aggregated from dialpad's communication platform. use this endpoint when you need to access or review the settings of a particular scheduled report, such as its frequency, included data points, or last run time. it's particularly useful for auditing report configurations or preparing to update existing reports. note that this endpoint only retrieves the report configuration, not the actual report data itself. to get the latest generated report content, you may need to use a separate endpoint or check if this response includes a link to the most recent report output.
</Accordion>

<Accordion title="Retrieve specific webhook by id">
  Retrieves detailed information about a specific webhook configuration in the dialpad system. this endpoint allows developers to fetch the current status, settings, and event subscriptions for a particular webhook identified by its unique id. use this endpoint when you need to check the configuration of an existing webhook, verify its status, or retrieve its associated event types. it's particularly useful for troubleshooting webhook-related issues or auditing webhook configurations. the endpoint returns comprehensive data about the webhook, including its target url, subscribed events, and any custom headers or authentication settings.
</Accordion>

<Accordion title="Retrieve off duty status by office id">
  Retrieves the list of custom off-duty statuses for a specific office within the dialpad system. this endpoint is used to fetch and manage the availability statuses of agents assigned to a particular office. it provides administrators and supervisors with insights into why agents might be stepping away from their desks, helping to track and understand agent activity. the endpoint should be used when there's a need to review, update, or manage the off-duty status options for a given office. it's particularly useful for larger organizations with multiple offices that may have different sets of off-duty statuses. note that this endpoint only retrieves the statuses and does not provide real-time information about which agents are currently using each status.
</Accordion>

<Accordion title="Retrieve subscription change log by id">
  Retrieves the changelog for a specific subscription in the dialpad system. this endpoint allows you to access a historical record of changes made to a particular subscription, including updates, modifications, or status changes. it is useful for auditing purposes, troubleshooting issues, or tracking the evolution of a subscription over time. the endpoint returns a chronological list of changes, likely including details such as the date of change, type of change, and any relevant metadata. note that this endpoint only provides changelog information and does not allow for modifying the subscription itself.
</Accordion>

<Accordion title="Retrieve sms opt out by company id">
  Retrieves the sms opt-out list for a specific company within the dialpad platform. this endpoint allows you to fetch all phone numbers that have opted out of receiving sms messages from the specified company. use this endpoint when you need to check which recipients have unsubscribed from sms communications, ensuring compliance with messaging regulations and user preferences. the returned list can be used to update your contact database or messaging system to prevent sending unwanted messages. note that this endpoint only provides the opt-out information and does not modify the opt-out status of any recipients.
</Accordion>

<Accordion title="Retrieve user devices list">
  Retrieves a list of devices associated with users in the dialpad system. this endpoint allows you to fetch information about various communication devices used within your dialpad organization, such as desk phones, softphones, or mobile devices. use this endpoint when you need to inventory or manage the devices connected to user accounts, track device usage, or troubleshoot device-related issues. the response likely includes details such as device type, status, associated user, and device-specific information. this tool is particularly useful for administrators managing a large number of devices across their organization or for integrating device information into custom dashboards or management systems. note that while the endpoint doesn't specify any parameters, it may support query parameters for filtering results, such as by user id or device type. the exact structure of the response and any available filters would need to be confirmed in the full api documentation.
</Accordion>

<Accordion title="Retrieve websocket connection">
  Retrieves information about websocket connections or initiates a websocket connection for real-time event subscriptions with dialpad. this endpoint is essential for applications that require live updates and real-time communication capabilities within the dialpad platform. it enables developers to establish a persistent connection for receiving instant notifications about various events such as calls, sms, contacts, agent status, and system changes. use this endpoint when building applications that need to react immediately to dialpad events or maintain a live data stream. note that while this endpoint provides the websocket connection details, you may need to implement the websocket client separately to handle the actual connection and data exchange.
</Accordion>

<Accordion title="Retrieve teams for office id">
  Retrieves a list of teams associated with a specific office in the dialpad organization. this endpoint is useful for getting an overview of the team structure within a particular office, which can be valuable for administrative tasks, reporting, or integrating dialpad's organizational structure with other systems. it should be used when you need to obtain information about multiple teams within a single office context. the endpoint will not provide detailed information about individual team members or their communications; it focuses solely on team-level data within the specified office.
</Accordion>

<Accordion title="Update room details">
  Updates the configuration of a specific dialpad room identified by its id. this endpoint allows you to modify the room's name and manage its assigned phone numbers. use this when you need to rename a room, update its phone number assignments, or reorder existing phone numbers. the endpoint is particularly useful for maintaining accurate room information and adjusting telephony settings as your organization's needs change. note that this is a partial update operation, so only the fields you provide will be modified. be cautious when updating phone numbers, as reordering or removing numbers from the list will affect their assignment to the room.
</Accordion>

<Accordion title="Retrieve room information by id">
  Retrieves detailed information about a specific room in the dialpad system. this endpoint allows you to fetch the current state, settings, and properties of a virtual collaboration space identified by its unique id. use this when you need to access up-to-date information about a particular room, such as its name, participants, or configuration. the endpoint is particularly useful for applications that need to display room details or make decisions based on a room's current status. note that this endpoint only provides information and does not modify the room in any way.
</Accordion>

<Accordion title="Retrieve subscription change log">
  Retrieves the changelog for dialpad api subscriptions. this endpoint provides a historical record of changes and updates made to subscription events and notifications within the dialpad system. it's useful for tracking modifications to webhooks, event subscriptions, and other notification-related configurations over time. the changelog can help developers understand when and how subscription settings have been altered, aiding in troubleshooting and maintaining up-to-date integrations. note that while the endpoint doesn't appear to require specific parameters, it may support optional query parameters for filtering or pagination, which are not visible in the provided schema.
</Accordion>

<Accordion title="Update call review share link privacy">
  Updates the privacy settings of an existing call review share link in dialpad. this endpoint allows you to modify the accessibility of a shared call recording, controlling whether it can be viewed only by company members or by anyone with the link. use this when you need to adjust the visibility of a previously shared call review, either to increase security by limiting access to the company or to allow broader access by making it public. it's particularly useful for managing sensitive information in call recordings or adapting to changing collaboration needs. note that this endpoint only modifies the privacy settings and does not create new share links or alter the content of the call review itself.
</Accordion>

<Accordion title="Retrieve operator duty status">
  Retrieves the current duty status of a specific call center operator in dialpad. this endpoint allows you to check whether an operator is active (available to receive inbound calls) or off-duty (not available for calls). use this endpoint when you need to determine an operator's availability in real-time, such as for load balancing, scheduling, or monitoring operator activity. the endpoint provides a snapshot of the operator's current status and does not include historical data or future scheduled statuses. it's particularly useful for systems that need to make routing decisions based on operator availability or for creating dashboards that display team capacity.
</Accordion>

<Accordion title="Retrieve websocket by id">
  Retrieves detailed information about a specific websocket connection using its unique identifier. this endpoint allows developers to query the status, metadata, and other relevant details of an active or recent websocket connection in the dialpad system. it's particularly useful for monitoring real-time event subscriptions, troubleshooting connection issues, or auditing websocket usage. the endpoint should be used when you need to inspect or verify the state of a particular websocket connection, such as checking if it's still active or retrieving its configuration. note that this endpoint provides information about the connection itself and may not include the actual event data being transmitted through the websocket.
</Accordion>

<Accordion title="Retrieve sms subscription by id">
  Retrieves detailed information about a specific sms subscription in dialpad. this endpoint allows developers to fetch the current status, configuration, and other relevant details of an sms subscription by providing its unique identifier. use this endpoint when you need to check the properties of an existing sms subscription, such as its active status, associated phone number, or any custom settings. it's particularly useful for managing and monitoring sms capabilities within your dialpad integration. note that this endpoint only provides read access to subscription data and cannot be used to modify or create new subscriptions.
</Accordion>

<Accordion title="Retrieve stat by id">
  Retrieves detailed statistics and analytics data for a specific entity within the dialpad platform. this endpoint allows you to access performance metrics, communication data, and other relevant statistics for a user, team, or call center identified by the provided id. use this endpoint when you need to analyze the performance or usage patterns of a particular entity within your dialpad organization. the data returned may include call volumes, average call durations, customer satisfaction scores, and other communication metrics. note that the specific metrics available may vary depending on the type of entity (user, team, or call center) and your organization's settings. this endpoint is particularly useful for generating reports, monitoring performance, and making data-driven decisions to improve communication efficiency and effectiveness.
</Accordion>

<Accordion title="Retrieve sms subscriptions">
  Retrieves a list of sms subscriptions associated with the authenticated user's dialpad account. this endpoint allows users to view and manage their current sms subscription plans and settings. it should be used when you need to obtain information about active sms subscriptions, such as subscription status, plan details, or associated phone numbers. the endpoint provides an overview of sms-related services but does not allow for modification of subscriptions. note that this endpoint may have pagination for large numbers of subscriptions, and additional calls might be necessary to retrieve the complete list.
</Accordion>

<Accordion title="Update call center settings by id">
  Updates the configuration of an existing call center in the dialpad platform. this endpoint allows for comprehensive modifications to call center settings, including operational hours, routing strategies, hold queue management, alerts, and advanced features like auto call recording and voice intelligence. it's particularly useful for adjusting call center operations to meet changing business needs or to optimize performance based on analytics. the endpoint provides granular control over various aspects of call center management, enabling customization of everything from service level alerts to dtmf menu options for both open and closed states. when using this endpoint, carefully consider the interdependencies between different settings to ensure a cohesive call center configuration.
</Accordion>

<Accordion title="Send sms with optional media and group sender">
  The sendsms endpoint allows you to send sms or mms messages through the dialpad platform to one or multiple recipients. this versatile tool supports various sender identification methods, group messaging, and media attachments. use it to programmatically send text or multimedia messages, integrate with dialpad channels, and leverage organizational structures for messaging. the endpoint is particularly useful for automating communication workflows, sending notifications, or implementing messaging features within applications integrated with dialpad. note that while the endpoint offers flexibility in number formatting and sender identification, proper authorization and adherence to messaging regulations are assumed to be handled separately.
</Accordion>

<Accordion title="Subscribe contact event">
  Creates a new contact event subscription in the dialpad platform, allowing you to receive real-time updates about changes to contacts. this endpoint enables you to subscribe to events for either local (personal) or shared (organization-wide) contacts. use this when you need to integrate contact management functionalities or automate workflows based on contact updates in your dialpad-connected application. the subscription can be linked to a specific logging endpoint (webhook or websocket) for event delivery and can be enabled or disabled upon creation. note that you must have previously set up a logging endpoint to receive the events if you specify an endpoint id.
</Accordion>

<Accordion title="Toggle user do not disturb status">
  The toggleuserdonotdisturb endpoint allows you to update the do not disturb (dnd) status for a specific user in the dialpad system. this powerful feature enables programmatic control over a user's availability, helping to manage notifications and improve focus time. the endpoint can be used to enable or disable dnd for an individual user, and optionally within the context of a specific group (such as a call center, department, or office). this granular control makes it ideal for implementing custom availability management solutions or integrating with external scheduling systems. keep in mind that changing a user's dnd status may affect their ability to receive incoming communications, so use this endpoint judiciously and in accordance with your organization's communication policies.
</Accordion>

<Accordion title="Retrieve user device by id">
  Retrieves detailed information about a specific user device associated with a dialpad account. this endpoint allows developers to fetch the current state and configuration of a particular device by providing its unique identifier. use this when you need to access up-to-date information about a user's device, such as its type, status, or associated settings. the endpoint is particularly useful for device management, troubleshooting, or syncing device information across integrated systems. note that this endpoint only provides read access to device data and cannot be used to modify device settings.
</Accordion>

<Accordion title="Set user caller id by id">
  Sets or blocks the caller id for a specific dialpad user. this endpoint allows you to define the phone number that will be displayed when the user makes outgoing calls, or to block the caller id entirely. use this when you need to customize how a user's calls appear to recipients or to ensure privacy by blocking the caller id. the endpoint is particularly useful for managing professional appearances in business communications or for compliance with privacy regulations. note that this setting affects all outgoing calls made by the user through the dialpad platform.
</Accordion>

<Accordion title="Toggle vi call for user by id">
  Toggles the voice intelligence (vi) feature for a specific dialpad user. this endpoint allows administrators to enable or disable vi capabilities for individual users, which includes features like real-time transcription, sentiment analysis, and smart notes during calls. use this endpoint when you need to manage vi access on a per-user basis, such as when onboarding new team members or adjusting feature access based on user roles or requirements. the endpoint requires the user's id in the url path and accepts a boolean parameter to set the vi status. note that this operation may affect billing or feature availability for the specified user, so it should be used judiciously and in accordance with your organization's policies.
</Accordion>

<Accordion title="Transfer call to destination">
  Transfers an active call within the dialpad system to a new destination. this endpoint allows for flexible call routing by enabling transfers to another ongoing call, a specific phone number, or a predefined target within the dialpad ecosystem (such as a call center, department, office, or user). it provides options to specify the transfer state and attach custom data to the call. use this endpoint when you need to programmatically redirect an ongoing call, implement call forwarding logic, or integrate dialpad's call transfer functionality into your application's workflow. note that the success of the transfer may depend on the availability and settings of the destination.
</Accordion>

<Accordion title="Unassign office number">
  This endpoint unassigns a specific phone number from a dialpad office. it is used to remove the association between a phone number and an office, which can be helpful for reorganizing phone number allocations or preparing a number for reassignment. the endpoint should be used when an administrator needs to free up a phone number from its current office assignment. it's important to note that this action only unassigns the number from the office and does not delete the number from the dialpad account. after unassignment, the number becomes available for reassignment to other offices or users within the organization. ensure that unassigning a number won't disrupt ongoing communications or routing rules associated with that number.
</Accordion>

<Accordion title="Unassign access control policy from user">
  This endpoint unassigns a user from a specific access control policy in dialpad. it allows for granular control over policy assignments by supporting unassignment at different target levels (company, office, or call center). the endpoint can be used to remove a user's access to specific settings or features defined by the policy. it's particularly useful when modifying user permissions or during role changes within the organization. the endpoint provides flexibility in unassigning from a single target or all associated targets simultaneously.
</Accordion>

<Accordion title="Unassign room phone number">
  This endpoint unassigns a phone number from a specific room in the dialpad system. it allows you to remove a previously assigned phone number from a room, freeing it up for potential reassignment or to adjust room configurations. use this when you need to change the phone number associated with a room or when decommissioning a room's phone capabilities. the operation is irreversible, so ensure you want to remove the number before making the api call. note that this endpoint doesn't provide information about the success of the operation or the current state of the room after unassignment.
</Accordion>

<Accordion title="Unpark call by user id">
  Unparks a previously parked call in the dialpad system. this endpoint allows you to retrieve a call that was temporarily placed on hold (parked) and assign it to a specific user for handling. it's particularly useful in call center or team environments where calls may need to be transferred or picked up by different team members. the endpoint should be used when a parked call needs to be reactivated and connected to a user. it's important to note that this action may affect call routing and should be used judiciously to ensure proper call flow management.
</Accordion>

<Accordion title="Unassign user phone number">
  Unassigns a specified phone number from a user's dialpad account. this endpoint should be used when you need to remove a phone number association from a particular user, such as when an employee changes roles or leaves the organization. it allows for efficient management of phone number resources within your dialpad system. the operation is irreversible, so ensure that you want to remove the number from the user before making the api call. note that this endpoint only unassigns the number; it does not delete the number from your dialpad account or make it available for immediate reassignment to another user.
</Accordion>

<Accordion title="Retrieve user personas by id">
  Retrieves all personas associated with a specific user in the dialpad system. this endpoint allows you to fetch the various identities or roles that a user can assume when making calls, providing detailed information about each persona. use this endpoint when you need to display or manage the different caller identities available to a user. the response will include a list of persona objects, each containing information such as the persona name, phone number, and any associated metadata. this endpoint is particularly useful for applications that need to offer users a choice of outbound caller identities or for administrative purposes to review a user's available personas.
</Accordion>

<Accordion title="Validate callback request">
  Validates a callback request for the dialpad system. this endpoint is used to check if a callback can be successfully initiated for a given call center and phone number. it helps ensure that the necessary information is correct and available before actually placing the callback. use this endpoint when you need to verify the validity of a callback request, such as before scheduling or queuing a callback. the endpoint does not initiate the actual callback; it only performs validation. note that both parameters are optional, allowing for flexible validation scenarios, but providing both ensures the most comprehensive validation.
</Accordion>

<Accordion title="Retrieve subscription contacts">
  Retrieves subscription information for contacts in the dialpad system. this endpoint allows you to fetch details about contact event subscriptions, which are crucial for receiving real-time notifications about contact-related events such as updates, calls, or sms activities. use this endpoint when you need to monitor or manage the current contact subscriptions in your dialpad integration. it provides a comprehensive view of all active contact subscriptions, enabling you to track which contact events you're currently listening to. note that this endpoint likely returns all contact subscriptions associated with your account, and may not support filtering or pagination in the request.
</Accordion>

<Accordion title="Update call subscription by id">
  Updates an existing call event subscription in the dialpad system. this endpoint allows you to modify various aspects of a subscription, including the call states to monitor, the subscription's active status, associated logging endpoint, and event filtering criteria. use this when you need to adjust the behavior of an existing subscription, such as changing which call events you receive notifications for or updating the target of the subscription. it's particularly useful for fine-tuning your application's integration with dialpad's real-time call event system. note that this endpoint updates only the specified fields; unspecified fields retain their current values.
</Accordion>

<Accordion title="Update contact information">
  Updates an existing contact's information in the dialpad system. this endpoint allows you to modify various details of a contact, including their name, company, contact information, and job details. it's particularly useful for keeping contact records up-to-date or correcting information. the endpoint requires at least the first name, last name, and a unique identifier (uid) to update a contact. other fields such as email addresses, phone numbers, and urls can be optionally updated. note that this endpoint overwrites existing data, so include all current information along with any changes to avoid unintended data loss.
</Accordion>

<Accordion title="Update operator duty status">
  Updates the duty status of a specific call center operator in dialpad. this endpoint allows you to change an operator's availability and optionally provide a reason for their status. use this when you need to manage operator schedules, indicate break times, or adjust availability in real-time. the endpoint is crucial for maintaining up-to-date operator statuses, which directly impact call routing and overall call center efficiency. note that this operation only updates the duty status and reason; it does not modify any other operator information or settings.
</Accordion>

<Accordion title="Update contact subscription by id">
  Updates an existing contact event subscription in the dialpad system. this endpoint allows you to modify the configuration of a subscription, including changing the contact type it listens for, enabling or disabling the subscription, and associating it with a different logging endpoint. use this when you need to adjust the behavior of an existing contact event subscription, such as changing its scope from local to shared contacts or temporarily disabling event notifications. the subscription id must be provided in the url path. note that this endpoint only updates the specified fields; any fields not included in the request will retain their current values.
</Accordion>

<Accordion title="Update schedule report settings">
  The updatescheduledreport endpoint allows you to modify the settings of an existing scheduled report in dialpad. this powerful tool enables fine-tuning of report generation parameters, including frequency, timing, type, and scope. use this endpoint when you need to adjust report schedules, change report types, update target information, or modify other settings of a previously configured report. the endpoint is particularly useful for adapting reporting needs as your organization's requirements evolve. it provides flexibility in managing various aspects of scheduled reports, from basic timing adjustments to more complex changes in report focus and delivery. keep in mind that this endpoint updates an existing report schedule; it does not create new schedules or generate reports on demand. also, note that some parameters are interdependent (e.g., frequency, at, and on day), so ensure their values are consistent when making updates.
</Accordion>

<Accordion title="Update e911 address for office">
  This endpoint updates the enhanced 911 (e911) address for a specific office in dialpad. it allows you to modify crucial location information used by emergency services to accurately locate the office in case of an emergency call. the endpoint can update the address for the office itself and optionally for all users associated with that office. it also provides an option to validate the address using dialpad's service, ensuring the highest possible accuracy for emergency response. use this endpoint when setting up a new office, relocating an existing office, or correcting address information. it's particularly important for maintaining compliance with e911 regulations and ensuring employee safety.
</Accordion>

<Accordion title="Update e911 address for user">
  Updates the e911 address for a specified user in the dialpad system. this endpoint allows you to modify the emergency location information associated with a user's account, ensuring accurate dispatch of emergency services if needed. the updated address will be used for e911 services, which provide precise location data to emergency responders. this tool should be used when a user's physical location changes or when correcting inaccurate e911 address information. it's crucial for maintaining compliance with e911 regulations and ensuring user safety. the endpoint requires detailed address information and offers an option for address validation to improve accuracy.
</Accordion>

<Accordion title="Update sms subscription settings">
  Updates an existing sms event subscription in the dialpad api. this endpoint allows you to modify various aspects of an sms subscription, such as its direction, enabled status, associated endpoint, and target settings. use this when you need to change the configuration of an existing sms event subscription to adjust its behavior or scope. the endpoint provides flexibility in updating multiple parameters simultaneously, allowing for fine-tuned control over sms event notifications. note that all parameters are optional, so you can update only the specific fields you want to change without affecting the others.
</Accordion>

<Accordion title="Update recording share link privacy">
  Updates the privacy settings of a specific recording share link in dialpad. this endpoint allows you to modify who can access a shared call recording by changing its privacy state. use this when you need to adjust the visibility of a recording, such as making it public for external sharing or restricting it to company-only access. the endpoint requires the id of the recording share link to be updated, which should be provided in the url path. note that this operation only changes the privacy settings and does not create or delete the share link itself.
</Accordion>

<Accordion title="Update ivr details by id">
  Updates an existing custom interactive voice response (ivr) workflow in the dialpad system. this endpoint allows you to modify the name and description of a specific ivr identified by its unique id. use this when you need to rename an ivr or update its description to reflect changes in its purpose or functionality. the operation is partial, meaning you can update either the name, the description, or both without affecting other properties of the ivr. this endpoint is particularly useful for maintaining accurate and up-to-date documentation of your ivr systems, especially in large-scale deployments where clear labeling is crucial. note that this operation only updates metadata and does not alter the actual call flow or logic of the ivr.
</Accordion>

<Accordion title="Update user information by id">
  This endpoint allows you to update various aspects of a user's profile and settings in the dialpad system. it provides comprehensive control over user management, including personal information, administrative roles, communication settings, and account status. use this endpoint when you need to modify existing user data, such as changing contact details, adjusting administrative privileges, updating license types, or managing phone numbers and extensions. the endpoint is particularly useful for keeping user information up-to-date and managing user access within the dialpad platform. note that some changes, like updating license types or office assignments, may have billing implications. ensure you have the necessary permissions and understand the impact of changes before using this endpoint.
</Accordion>


# Discord
Source: https://docs.push.ai/integrations/discord



An instant messaging and VoIP social platform.

<Accordion title="Create guild scheduled event">
  Creates a new scheduled event in a discord guild. this endpoint allows you to set up various types of events, including external events, stage instances, and voice events. the created event will be visible to guild members and can include details such as name, description, start and end times, and location (for external events). use this endpoint when you want to programmatically create and manage events for your discord community. the event's visibility is limited to guild members only, and the structure of the request varies based on the type of event being created.
</Accordion>

<Accordion title="Create channel webhook">
  Creates a new webhook for a specified discord channel. this endpoint allows you to set up an automated way to send messages to a discord channel from external applications or services. the webhook can be customized with a name and an optional avatar. use this endpoint when you need to integrate external services with discord or automate message posting to a specific channel. the created webhook will provide a unique url that can be used to send messages to the channel without requiring a bot token. note that webhook creation is subject to discord's rate limits and server permissions, so ensure you have the necessary rights to create webhooks in the specified channel.
</Accordion>

<Accordion title="Create guild emoji">
  Creates a new custom emoji for a specific discord guild (server). this endpoint allows you to upload an image and set a name for the emoji, which can then be used within the guild's text channels and reactions. optionally, you can restrict the emoji's usage to specific roles. use this when you want to add new custom emojis to enrich communication within your discord community. the created emoji will be immediately available for use after successful creation. note that guilds have limits on the number of custom emojis they can have, which depends on the guild's boost level. ensure that your application handles potential rate limits or emoji limit errors gracefully.
</Accordion>

<Accordion title="Bulk delete messages in channel">
  The bulkdeletemessages endpoint allows for the deletion of multiple messages simultaneously within a specified discord channel. this endpoint is particularly useful for cleaning up large amounts of messages efficiently, such as during moderation tasks or channel maintenance. it should be used when you need to remove multiple messages at once, saving time compared to deleting messages individually. the endpoint requires a minimum of 2 and a maximum of 100 unique message ids to be provided. it's important to note that this operation may not be immediate, and the api will return a successful response even if the deletion is still in progress. be cautious when using this endpoint, as deleted messages cannot be recovered. this bulk delete function is limited to messages that are less than two weeks old. for deleting older messages, you'll need to use individual delete requests for each message.
</Accordion>

<Accordion title="Create thread in message channel">
  Creates a new thread from an existing message in a discord channel. this endpoint allows you to start a focused discussion based on a specific message, organizing conversations within busy channels. the new thread will be associated with the original message and appear in the channel's thread list. use this when you want to branch off a conversation from the main channel into a more specific topic. the thread can have its own set of permissions, auto-archive duration, and rate limiting. note that you must have the necessary permissions in the channel to create a thread, and the original message must still be visible in the channel.
</Accordion>

<Accordion title="Create role with guild id">
  Creates a new role within a specified discord guild (server). this endpoint allows for the customization of various role properties, including name, permissions, color, and display options. it's particularly useful for programmatically managing server structures, implementing role-based access control, or creating specialized roles for events or categories. the created role can be assigned to users to grant them specific permissions and visual distinctions within the guild. note that while all parameters are optional, providing values for key properties like name and permissions is recommended for immediate role utility. be mindful of permission settings to maintain server security.
</Accordion>

<Accordion title="Bulk ban users in guild with message deletion option">
  The bulkbanusers endpoint allows server administrators to ban multiple users from a discord guild (server) simultaneously. this powerful moderation tool is designed for efficiently managing large-scale infractions or cleaning up a server from unwanted users. it can ban up to 200 users in a single request and optionally delete their recent messages. this endpoint should be used when there's a need to remove multiple problematic users quickly, such as during a raid or when cleaning up after a spam attack. it's important to note that this action is irreversible and should be used with caution. the endpoint doesn't provide information about the success of individual bans within the bulk request.
</Accordion>

<Accordion title="Delete channel recipient">
  Removes a user (recipient) from a specific discord channel. this endpoint is used to manage channel membership by removing individual users. it's particularly useful for administrative purposes, such as removing inactive members or managing private channel access. the operation is irreversible and will immediately revoke the user's access to the channel. this endpoint should be used cautiously, as it affects user access and channel composition. it does not provide any feedback on the success of the operation, so additional verification may be necessary after calling this endpoint.
</Accordion>

<Accordion title="Delete channel permission override">
  Deletes a specific permission overwrite for a discord channel. this endpoint is used to remove custom permissions that have been set for a particular user or role within a channel. it's particularly useful when you want to reset a user's or role's permissions to the default channel or category permissions. the operation is irreversible, so it should be used with caution. this tool doesn't return the deleted overwrite data; it simply removes the specified overwrite. it's important to note that this action may immediately affect the target user's or role's ability to interact with the channel, depending on the overwrite that was removed.
</Accordion>

<Accordion title="Crosspost channel message">
  Crossposts a message to all channels that have been set up to receive announcements from the source channel. this endpoint allows you to publish a message from an announcement channel to its followers, effectively distributing the content to multiple channels simultaneously. it should be used when you want to broadcast important information, updates, or announcements to a wider audience across different servers or channels. this operation is typically restricted to messages in announcement channels and requires appropriate permissions. note that a message can only be crossposted once, and attempting to crosspost an already crossposted message will result in an error.
</Accordion>

<Accordion title="Delete guild by id">
  Deletes a guild (server) from discord permanently. this endpoint should be used with extreme caution as it will remove all data associated with the guild, including channels, roles, and messages. it is an irreversible action that can only be performed by the guild owner. this operation is typically used when a community needs to be completely shut down or when cleaning up test servers. it should not be used for temporary removals or as a moderation tool. be aware that this action cannot be undone, and all guild data will be lost upon deletion.
</Accordion>

<Accordion title="Delete guild emoji by id">
  Deletes a custom emoji from a specified discord guild (server). this endpoint is used to permanently remove a custom emoji, freeing up space for new emojis if the guild has reached its emoji limit. it should be used when server administrators or users with the manage guild expressions permission want to remove outdated or unwanted custom emojis. the operation is irreversible, so caution should be exercised when using this endpoint. note that this endpoint cannot be used to delete default discord emojis or emojis from other servers.
</Accordion>

<Accordion title="Delete guild command">
  Deletes a specific application command from a discord guild (server). this endpoint is used to remove a previously registered slash command, user command, or message command associated with your application in a particular guild. it's particularly useful for managing your application's command list, especially when you want to remove outdated or unnecessary commands. the deletion is permanent and cannot be undone, so use this endpoint with caution. this operation helps in maintaining a clean and relevant set of commands for your discord bot or application within a specific server.
</Accordion>

<Accordion title="Delete reaction from message">
  Deletes all reactions from a specific message in a discord channel. this endpoint removes every emoji reaction that has been added to the message, effectively clearing its reaction list. it should be used when you want to remove all user interactions in the form of emoji reactions from a particular message. this action is useful for moderation purposes or when refreshing the state of a message. the endpoint requires 'manage messages' permission and affects all users' reactions, not just the bot's. it does not delete the message itself, only the associated reactions.
</Accordion>

<Accordion title="Delete role from guild">
  Deletes a specific role from a discord guild. this endpoint permanently removes the role identified by the role id from the guild specified by the guild id. it should be used when you need to completely remove a role from a guild's hierarchy, including all associated permissions and assignments. this action is irreversible, so it should be used with caution. the endpoint is particularly useful for cleaning up outdated roles or restructuring a guild's permission system. it does not provide any information about the deleted role or affect other roles in the guild.
</Accordion>

<Accordion title="Delete guild member by id">
  Removes a member from a specified discord guild (server). this endpoint allows you to programmatically kick a user from a server, effectively ending their membership. it should be used when you need to remove a user from a guild, either for moderation purposes or as part of automated server management. this action is permanent and will require the user to be re-invited if they wish to rejoin the guild. note that this endpoint requires appropriate permissions to execute, typically reserved for guild administrators or bots with member management capabilities. the operation is immediate and cannot be undone through the api.
</Accordion>

<Accordion title="Delete original webhook message">
  Deletes the original message sent by a specific webhook in a discord channel. this endpoint is used to remove the initial content posted by a webhook, which can be useful for cleaning up outdated information or correcting errors in automated messages. it specifically targets the first message sent by the webhook, not any subsequent edits or additional messages. this operation is permanent and cannot be undone, so it should be used with caution. the endpoint requires both the webhook id and token for authentication and to precisely identify the message to be deleted.
</Accordion>

<Accordion title="Delete guild integration">
  Deletes a specific integration from a discord guild. this endpoint is used to remove an external service or bot integration that has been previously added to the server. it should be used when an integration is no longer needed or causing issues within the guild. the deletion is permanent and cannot be undone, so it should be used with caution. this operation requires appropriate permissions within the guild to manage integrations.
</Accordion>

<Accordion title="Add recipient to group channel">
  Adds a recipient (user) to a discord channel, specifically designed for managing group direct messages (dms). this endpoint allows you to include a new user in an existing group dm or potentially add a user to other types of channels. it requires the channel id and user id to be specified in the path, with optional parameters for user authentication and nickname customization. use this endpoint when you need to programmatically add users to group conversations or channels in discord applications.
</Accordion>

<Accordion title="Create guild sticker">
  Creates a new custom sticker for a specific discord guild. this endpoint allows guild administrators or users with appropriate permissions to upload and add new stickers to their guild's collection. the sticker can be used by members in chat messages to express emotions or add visual flair. use this endpoint when you want to programmatically add new stickers to a guild, such as for custom integrations or automated sticker management systems. note that there are limits on the number of stickers a guild can have based on various factors like boost level.
</Accordion>

<Accordion title="Delete stage instance by channel id">
  Deletes an existing stage instance associated with a specific channel in a discord server. this endpoint is used to end and remove a live stage, effectively concluding the audio event or activity. it should be called when you want to terminate a stage instance, such as when an event has concluded or needs to be canceled. the deletion is permanent and cannot be undone, so use this endpoint with caution. this tool is particularly useful for automating the lifecycle management of stage events in discord servers.
</Accordion>

<Accordion title="Delete user reaction on message">
  Removes the authenticated user's reaction (emoji) from a specific message in a discord channel. this endpoint is used when a user wants to undo their reaction to a message. it's particularly useful in situations where a user wants to change their reaction or remove it entirely. the endpoint only affects the authenticated user's own reaction and cannot be used to remove other users' reactions. it's important to note that this action is irreversible, and once a reaction is removed, it cannot be automatically restored - the user would need to add the reaction again if desired.
</Accordion>

<Accordion title="Delete guild member role">
  Removes a specific role from a guild member in discord. this endpoint is used to modify a user's roles within a server, specifically by removing a designated role. it's particularly useful for managing permissions and access levels within a guild. the operation is performed by specifying the guild id, user id, and role id in the url path. this tool should be used when you need to revoke certain privileges or change a member's status within a guild. it's important to note that this action is immediate and irreversible through this call alone - to undo it, you would need to add the role back using a separate api call. the endpoint doesn't return the updated member object, so if you need to confirm the new role configuration, you'll need to fetch the member's details separately after this operation.
</Accordion>

<Accordion title="Delete user reaction from message">
  Removes a specific user's reaction from a message in a discord channel. this endpoint is used to programmatically delete a single emoji reaction made by a particular user on a given message. it's useful for moderation purposes, cleaning up reactions, or managing user interactions within a discord bot or application. the operation is idempotent, meaning repeated calls with the same parameters will not cause errors or additional side effects if the reaction has already been removed.
</Accordion>

<Accordion title="Delete guild scheduled event">
  Deletes a specific scheduled event from a discord guild. this endpoint should be used when you want to permanently remove a scheduled event from a guild's calendar. it requires the guild id and the scheduled event id to precisely target the event for deletion. this action is irreversible, so it should be used with caution. the endpoint is particularly useful for cleaning up past events, canceling upcoming events, or managing the guild's event list. note that this operation likely requires appropriate permissions within the guild to execute successfully.
</Accordion>

<Accordion title="Delete channel message reaction by emoji">
  Removes a specific emoji reaction from a message in a discord channel. this endpoint allows for precise control over message reactions, enabling the deletion of a particular emoji reaction associated with a specific message. it should be used when you need to programmatically remove reactions, such as for moderation purposes or managing bot-added reactions. the endpoint is particularly useful for cleaning up reactions or removing inappropriate content. note that this operation is irreversible, and you must have the necessary permissions in the discord server to remove reactions.
</Accordion>

<Accordion title="Delete channel thread member">
  Removes a specified user from a thread within a discord channel. this endpoint is used to manage thread membership by forcibly removing a user from the thread conversation. it should be used when a user needs to be excluded from a thread, such as for moderation purposes or when their participation is no longer required. the endpoint does not provide any information about the removed user or the thread status after the operation. it's important to note that this action may have implications on the user's ability to view or participate in the thread, depending on the channel and thread settings.
</Accordion>

<Accordion title="Delete webhook using id and token">
  Deletes a specific discord webhook using its unique identifier and associated token. this endpoint permanently removes the webhook from the discord system, preventing any further messages from being sent through it. use this endpoint when you no longer need the webhook, such as when decommissioning integrations or cleaning up unused resources. once deleted, the webhook cannot be recovered, and any attempts to use the deleted webhook's url will fail. this operation is irreversible, so ensure you have the correct webhook id and token before proceeding with the deletion.
</Accordion>

<Accordion title="Delete webhook by id">
  Deletes a specific discord webhook using its unique identifier. this endpoint permanently removes the webhook, terminating any integrations or automated messages associated with it. use this when you want to discontinue a webhook's functionality or clean up unused webhooks. it's important to note that this action is irreversible, and once deleted, the webhook cannot be recovered. this endpoint should be used cautiously, ensuring that the webhook is no longer needed before deletion.
</Accordion>

<Accordion title="Delete guild sticker">
  Deletes a specific sticker from a discord guild (server). this endpoint allows guild administrators or users with the appropriate permissions to permanently remove a custom sticker from their server. use this when you want to delete outdated, inappropriate, or unused stickers from your guild. once deleted, the sticker cannot be recovered and will no longer be available for use in the guild. this operation is irreversible, so it should be used with caution. the endpoint requires both the guild id and the sticker id to ensure precise removal of the intended sticker.
</Accordion>

<Accordion title="Create guild template">
  Creates a new guild template for the specified discord guild. this endpoint allows users to create a snapshot of the current guild's settings, roles, and channels, which can be used as a blueprint for creating new guilds quickly. the template includes the guild's structure but not its content. use this when you want to save the current guild configuration for future use or to share with others for easy replication of your guild setup. the created template can be accessed and managed using other template-related endpoints.
</Accordion>

<Accordion title="Update guild member information">
  This endpoint allows you to add a new member to a discord guild (server) or update an existing member's information. it provides functionality to set or modify a member's nickname, role assignments, voice channel status (mute/deaf), and other flags within the guild. this tool should be used when you need to programmatically add users to a guild or update their guild-specific properties. it's particularly useful for automating member management tasks or integrating discord guild operations into external applications. note that this endpoint requires proper authorization and an oauth2 access token for the user being added or modified. be aware that some changes, like role assignments, may have significant impacts on the member's permissions within the guild.
</Accordion>

<Accordion title="Delete application command">
  Deletes a specific command from a discord application. this endpoint is used to permanently remove a command that is no longer needed or has become obsolete. it's particularly useful for maintaining a clean and relevant set of commands for your discord bot or application. the deletion is irreversible, so use this endpoint with caution. it should be called when you want to completely remove a command's functionality from your application, such as during updates or when phasing out features. this operation does not affect other commands or the application's overall functionality.
</Accordion>

<Accordion title="Delete webhook message">
  Deletes a specific message that was previously sent through a discord webhook. this endpoint allows for the removal of individual messages from a channel, providing control over content posted via webhooks. it should be used when you need to remove or retract a message sent by your application through a webhook, such as correcting mistakes or removing outdated information. the operation is permanent and cannot be undone, so use it cautiously. note that this endpoint can only delete messages sent by the webhook itself, not messages from other users or bots.
</Accordion>

<Accordion title="Assign role to guild member">
  Adds a specific role to a member within a discord guild (server). this endpoint is used to assign additional permissions or status to a user by giving them a predefined role. it's particularly useful for automated role management, such as assigning roles based on user actions or time spent in the server. the operation requires the guild id, user id, and role id to be specified in the url path. this endpoint should be used when you need to programmatically update a user's roles without manual intervention. note that the user must already be a member of the guild, and the role must exist within the guild for the operation to succeed. the endpoint doesn't return the updated member object, so you may need to fetch the member's information separately to confirm the role addition.
</Accordion>

<Accordion title="Add follower to channel via webhook">
  Adds a follower to a specific discord channel. this endpoint allows you to create a follower relationship between two channels, enabling content from one channel to be automatically shared with another. it's particularly useful for content creators or community managers who want to distribute updates across multiple channels or servers. the follower relationship is established using webhooks, which allows for real-time notifications and content sharing. this endpoint should be used when you want to expand the reach of a channel's content or create a network of interconnected channels. it's important to note that both channels must be within servers where the authenticated user has appropriate permissions. the endpoint doesn't provide information about existing followers or allow for bulk following operations.
</Accordion>

<Accordion title="Retrieve message from channel">
  Retrieves a specific message from a discord channel. this endpoint allows you to fetch detailed information about a single message, including its content, author, timestamp, and any attachments or embeds. it's particularly useful for bot development, message logging, or implementing features that require analysis or manipulation of specific messages. the endpoint should be used when you need to access or verify the contents of a particular message within a channel. it does not provide information about other messages in the channel or modify the message in any way. note that you must have the necessary permissions to view the message in the specified channel.\<\<DEPRECATED use get\_message>>
</Accordion>

<Accordion title="Post interaction callback">
  This endpoint allows you to send a response to a discord interaction. it's used to reply to various types of interactions, such as slash commands, message components, or modals. the response can be immediate or deferred, and can include messages, embeds, components, or modals. use this endpoint when you need to acknowledge an interaction or provide a response to user input. it's particularly useful for creating interactive bot experiences, handling command inputs, or updating messages based on user actions. the endpoint is versatile, supporting different response types, but it's important to match the response type with the interaction context. for example, you can't respond with a modal to a message component interaction. also, note that some response types have time limits (e.g., initial responses must be sent within 3 seconds) and content restrictions (e.g., message length limits).
</Accordion>

<Accordion title="Github action webhooks processing">
  This endpoint executes a github webhook, processing various github events and sending corresponding notifications to a discord channel. it serves as a bridge between github and discord, allowing real-time updates about repository activities to be relayed to discord users. the webhook can handle a wide range of github events, including but not limited to pushes, pull requests, issues, comments, and releases. the endpoint should be used when you want to set up automated notifications in discord for github repository events. it's particularly useful for development teams who want to stay informed about project updates, code reviews, and discussions without leaving their discord environment. while this webhook provides comprehensive event data, it's important to note that it doesn't allow for direct interaction with github from discord. it's a one-way communication channel from github to discord. additionally, the webhook payload has a maximum size limit, which might affect extremely large events or comments.
</Accordion>

<Accordion title="Post webhook with embeds and components">
  This endpoint allows you to execute a discord webhook, enabling you to send messages, embeds, and interactive components to a specific discord channel. it's useful for integrating external services with discord, sending automated notifications, or creating custom bot-like interactions without a full bot implementation. the webhook can be customized with a username and avatar, and supports thread interactions. use this when you need to push information to discord channels programmatically, especially for notifications, updates, or interactive messages. note that webhook usage is subject to discord's rate limits, and the webhook url should be kept secure as it bypasses normal authentication.
</Accordion>

<Accordion title="Add reaction to message">
  Adds a reaction to a specific message in a discord channel. this endpoint allows users or bots to add an emoji reaction to a particular message, identified by its channel and message ids. it's commonly used to provide quick feedback, show agreement, or participate in polls within discord conversations. the reaction is added on behalf of the authenticated user or bot (indicated by '@me' in the endpoint). this tool should be used when you want to programmatically add reactions to messages, such as for automated responses or interactive bot features. it's important to note that this endpoint only adds the reaction and does not provide any information about existing reactions on the message.
</Accordion>

<Accordion title="Delete guild auto moderation rule">
  Deletes a specific auto-moderation rule from a discord guild (server). this endpoint should be used when you want to permanently remove an existing auto-moderation rule from a guild's settings. it's particularly useful for updating a guild's moderation strategy or removing outdated or unnecessary rules. the deletion is irreversible, so it should be used with caution. this endpoint only deletes the rule; it does not provide information about the rule before deletion or allow for retrieving deleted rules.
</Accordion>

<Accordion title="Post to slack webhook">
  This endpoint allows you to send messages to a discord channel using a slack-compatible webhook format. it supports simple text messages as well as rich content with attachments, custom usernames, and icons. use this endpoint when you want to integrate external services or applications with discord, leveraging the familiar slack webhook format. it's particularly useful for sending notifications, updates, or formatted reports to a discord channel. the endpoint accepts various content types, including json, form-urlencoded, and multipart form data, providing flexibility in how you structure your requests. keep in mind the character limits for text fields and the maximum number of attachments to ensure your messages are delivered successfully.
</Accordion>

<Accordion title="Get current user data">
  Retrieves detailed information about the currently authenticated user on discord. this endpoint should be used when an application needs to access the profile data of the user who has authorized the application. it returns comprehensive user information, including username, discriminator, avatar, email (if authorized), and other relevant account details. this endpoint is essential for personalizing user experiences within discord applications and should be called when initializing a user session or when up-to-date user information is required. note that the endpoint does not provide information about the user's guilds or relationships; separate endpoints exist for those purposes.\<\<DEPRECATED use get\_my\_user>>
</Accordion>

<Accordion title="Add or update thread member">
  Adds a user to a thread within a specified discord channel. this endpoint is used to include a user in an existing thread, allowing them to participate in the discussion. it should be used when you want to bring a user into a thread conversation, either to involve them in an ongoing discussion or to grant them access to a private thread. the endpoint is particularly useful for managing thread membership programmatically, such as when implementing custom thread management features or automating user inclusion in relevant discussions. note that this action may be subject to permission checks, and the user being added must have access to the parent channel.
</Accordion>

<Accordion title="Get your applications">
  Retrieves detailed information about the current authenticated application. this endpoint allows developers to access various attributes and settings of their discord application or bot. it's particularly useful for self-inspection, verifying application details, or dynamically adjusting application behavior based on its current configuration. the endpoint returns comprehensive data about the application, which may include its name, description, icon, bot user information, and other relevant metadata. while specific return fields are not detailed in the schema, developers can expect a rich set of application-related information. this endpoint should be used when an application needs to introspect its own properties or verify its current state within the discord ecosystem.\<\<DEPRECATED use get\_my\_application>>
</Accordion>

<Accordion title="Get oauth2 applications for current user">
  Retrieves detailed information about the current oauth2 application authenticated with discord. this endpoint allows developers to access metadata and settings for their application, such as the app's name, icon, description, and other relevant details. it's particularly useful for applications that need to verify their own identity or fetch up-to-date configuration information. the endpoint should be used when an application needs to self-inspect or update its own information dynamically. note that this endpoint only provides information about the authenticated application and cannot be used to query details of other discord applications.\<\<DEPRECATED use get\_my\_oauth2\_application>>
</Accordion>

<Accordion title="Get oauth2 keys">
  Retrieves the oauth2 public keys used for verifying access tokens issued by discord. this endpoint is crucial for implementing secure token validation in applications that integrate with discord's oauth2 authentication system. it should be used when setting up or updating an application's authentication process to ensure proper verification of discord-issued tokens. the endpoint returns a set of public keys in json web key (jwk) format, which can be used to verify the signatures of discord's json web tokens (jwts). note that the keys may be rotated periodically, so applications should be prepared to handle multiple keys and update their key cache as needed.\<\<DEPRECATED use get\_public\_keys>>
</Accordion>

<Accordion title="Post message to channel">
  This endpoint allows you to create and send a new message in a specified discord channel. it supports various content types including plain text, rich embeds, interactive components, stickers, and file attachments. the message can be customized with allowed mentions, flags, and text-to-speech options. it's primarily used for sending messages programmatically, such as bot responses or automated notifications. the endpoint is versatile, allowing for simple text messages or complex, interactive content with multiple embeds and components. however, it's important to note the various limitations on content length, number of embeds, and attachments to ensure the message adheres to discord's guidelines.
</Accordion>

<Accordion title="Modify guild ban settings">
  This endpoint bans a specified user from a discord guild (server) and optionally deletes their recent messages. it allows moderators to remove problematic users and clean up their content in one action. the ban is permanent until manually lifted. use this endpoint when you need to immediately remove a user's access to a guild and optionally purge their recent message history. it's particularly useful for handling severe rule violations or spam incidents. note that this action requires appropriate permissions and should be used judiciously as it significantly impacts the targeted user's ability to interact with the guild.
</Accordion>

<Accordion title="Retrieve user by id">
  Retrieves detailed information about a specific discord user based on their unique user id. this endpoint allows developers to access public user data, which may include the user's username, avatar, account creation date, and other relevant information. it's particularly useful for applications that need to display user profiles, manage user interactions, or integrate discord user data into their services. the endpoint should be used when specific user details are required, but it will not provide information about the user's activities, messages, or server memberships. note that some user information may be limited based on privacy settings or if the user has restricted access to their profile.\<\<DEPRECATED use get\_user>>
</Accordion>

<Accordion title="Delete guild template by code">
  Deletes a specific guild template from a discord server. this endpoint is used to permanently remove a template that is no longer needed or has become outdated. it's particularly useful for server administrators who want to manage their template inventory, ensuring only relevant and up-to-date templates are available. the deletion is irreversible, so it should be used with caution. this tool doesn't provide any confirmation or return the deleted template's details, it simply removes the specified template from the system.
</Accordion>

<Accordion title="Get user role connection">
  Retrieves the role connection information for the authenticated user in relation to a specific discord application. this endpoint allows developers to fetch details about how a user's discord account is linked to roles within the application, which is crucial for managing permissions and access control. it should be used when an application needs to verify or update a user's role connections, such as during authentication processes or when syncing external service permissions with discord roles. the endpoint provides only the role connection data for the specified application and does not return general user information or role connections for other applications.
</Accordion>

<Accordion title="Retrieve application details">
  Retrieves detailed information about a specific discord application. this endpoint allows developers to fetch comprehensive data about their application, including its name, description, icon, bot user details (if applicable), and other relevant settings. use this endpoint when you need to access or verify your application's current configuration on the discord platform. it's particularly useful for applications that need to dynamically adjust their behavior based on their current settings or for debugging purposes. note that this endpoint only provides read access to the application details and cannot be used to modify the application.
</Accordion>

<Accordion title="Retrieve auto moderation rule">
  Retrieves detailed information about a specific auto-moderation rule within a discord guild. this endpoint allows developers to fetch the configuration and settings of an individual rule, including its trigger type, actions, exempt roles and channels, and enabled status. it should be used when you need to review or audit the settings of a particular auto-moderation rule. the endpoint is particularly useful for debugging rule behavior, verifying rule settings, or displaying rule details in a management interface. note that this endpoint only retrieves information and does not modify the rule in any way.
</Accordion>

<Accordion title="Retrieve application role metadata">
  Retrieves the role connection metadata for a specific discord application. this endpoint is used to fetch information about how the application integrates with discord's role system, including any custom requirements or verifications set up for role assignments. it's particularly useful for developers managing applications that utilize discord's linked roles feature. the retrieved metadata can include details about the conditions users must meet to be granted certain roles within discord servers where the application is integrated. this endpoint should be used when setting up or managing role connections for a discord application, or when needing to verify the current role connection configuration. it does not modify any data and is intended for read-only operations.
</Accordion>

<Accordion title="Retrieve bot gateway">
  Retrieves the websocket url and additional metadata required for a bot to connect to discord's gateway. this endpoint is essential for bot developers who need to establish a real-time connection to receive events and updates from discord. it provides the necessary information to initiate a websocket connection, including the gateway url and recommendations for sharding. use this endpoint before connecting your bot to the gateway to ensure you have the most up-to-date connection information. note that this endpoint is specifically for bots and should not be used for user accounts or other types of integrations.
</Accordion>

<Accordion title="Get gateway details">
  Retrieves the websocket url required to connect to discord's gateway. this endpoint is essential for applications that need real-time communication with discord, such as bots or interactive clients. the gateway allows clients to receive events and updates from discord without the need for constant polling. use this endpoint to obtain the websocket url before establishing a connection to receive real-time events like messages, presence updates, and other discord state changes. note that while this endpoint provides the connection url, actual websocket connection handling, including authentication and event processing, must be implemented separately.
</Accordion>

<Accordion title="Retrieve channel details">
  Retrieves detailed information about a specific discord channel using its unique identifier. this endpoint allows developers to fetch various properties of a channel, such as its name, type (text, voice, or video), associated permissions, and other relevant metadata. it should be used when an application needs to display or work with up-to-date channel information. the endpoint is particularly useful for bots and applications that need to dynamically interact with or manage discord channels. note that this endpoint only provides channel details and does not return message content or member lists directly.
</Accordion>

<Accordion title="Delete channel message">
  Deletes a specific message from a discord channel. this endpoint should be used when you need to remove a particular message, either for moderation purposes or to clean up outdated information. it's important to note that this action is irreversible, and once a message is deleted, it cannot be recovered. the endpoint requires both the channel id and the message id to accurately target the specific message for deletion. use this endpoint with caution, as it permanently removes content from the conversation history.
</Accordion>

<Accordion title="List active threads in guild">
  Retrieves a list of currently active threads within a specified discord guild. this endpoint is useful for obtaining an up-to-date view of ongoing discussions and conversations in a server. it should be used when you need to display or manage active threads, such as for moderation purposes or to provide users with a list of current conversations they can join. the endpoint only returns threads that are currently active and visible to guild members; it does not include archived or hidden threads. this tool is particularly helpful for applications that need to monitor or interact with real-time guild activity.
</Accordion>

<Accordion title="Create stage instance">
  Creates a new stage instance in a discord server. this endpoint allows you to set up a stage for live audio conversations or presentations within a specified channel. use this when you want to initiate a structured audio event, such as a q\&a session, panel discussion, or live performance. the stage instance can be customized with a topic, privacy settings, and optional association with a scheduled event. it's particularly useful for managing large-scale audio events in discord communities. note that this endpoint requires appropriate permissions in the server where the stage instance is being created.
</Accordion>

<Accordion title="Post guild template by code">
  Creates a new discord guild (server) based on a pre-existing template. this endpoint allows you to quickly set up a new community with predefined channels, roles, and settings. it's particularly useful for creating standardized guild structures or for users who want to replicate successful community setups. the template is identified by its unique code, which must be included in the endpoint url. you must provide a name for the new guild, and you have the option to set a custom icon. this tool should be used when a user wants to create a new discord server with a specific structure in mind, rather than starting from scratch. it's important to note that while the template provides initial setup, further customization may be needed to fully tailor the guild to specific needs.
</Accordion>

<Accordion title="Delete channel by id">
  Deletes a specific channel from a discord server. this endpoint permanently removes the channel and all its associated content, including messages, pins, and any other data. it should be used with caution as the action is irreversible. this operation is typically performed for channel management, such as removing obsolete or unwanted channels from a server. the endpoint requires appropriate permissions to execute, and it's crucial to verify the correct channel id before deletion to avoid unintended data loss. note that this action may affect server organization and user access to information previously contained in the deleted channel.
</Accordion>

<Accordion title="Get oauth2 user information">
  Retrieves the authenticated user's profile information using discord's oauth2 system. this endpoint returns essential details about the user, such as their identity, associated guilds, and potentially other account-related information. it should be used when an application needs to access the current user's data after successful oauth2 authentication. the endpoint is particularly useful for personalization, user management, and integration of discord user data into third-party applications. note that the specific data returned may depend on the oauth2 scopes granted during the authentication process.\<\<DEPRECATED use get\_my\_oauth2\_authorization>>
</Accordion>

<Accordion title="Get guild onboarding by id">
  Retrieves the onboarding information for a specific discord guild (server). this endpoint provides details about the guild's onboarding process, including welcome screens, default channels, and other initial setup configurations. it's particularly useful for understanding how new members are introduced to the guild and what information or options they're presented with upon joining. this endpoint should be used when you need to review or analyze a guild's current onboarding settings, potentially for improving user experience or troubleshooting issues with new member integration. note that this endpoint only retrieves information and does not allow modifications to the onboarding process.
</Accordion>

<Accordion title="Create guild auto moderation rule">
  This endpoint creates a new auto moderation rule for a specific discord guild. it allows server administrators to set up automated content moderation based on various triggers and actions. the rule can be configured to respond to different types of events, such as message sending or member updates, and can perform actions like blocking messages, flagging content, or temporarily disabling user communication. this tool is essential for maintaining a safe and controlled environment within a discord server by automatically enforcing community guidelines and moderating user-generated content.
</Accordion>

<Accordion title="Create channel invite">
  Creates a new invite for a specific discord channel. this endpoint allows you to generate customizable invite links that can be used to add new members to a server through the specified channel. the invite can be configured with various parameters to control its behavior, such as expiration time, usage limits, and special targets like streams or embedded applications. use this endpoint when you need to programmatically create invites for automated user onboarding, event management, or integration with external systems. note that some parameters may require elevated permissions, and the effectiveness of certain options (like temporary membership) depends on the server's settings and the invitee's roles.
</Accordion>

<Accordion title="Create new thread in channel">
  Creates a new thread within a specified discord channel. this endpoint allows for the creation of various thread types (public, private, or announcement) with customizable settings such as auto-archive duration, rate limits, and initial messages. it's particularly useful for organizing discussions, creating focused conversation spaces, or starting new topics within a channel. the thread can be initialized with a rich message including embeds, components, and attachments. use this endpoint when you need to programmatically create new discussion threads or topic-specific conversations in a discord server.
</Accordion>

<Accordion title="Retrieve guild details">
  Retrieves detailed information about a specific discord guild (server) using its unique identifier. this endpoint allows developers to fetch comprehensive data about a guild, including its name, features, member count, channel list, roles, and other server-specific settings. it's particularly useful when you need to display guild information in a bot or third-party application, or when you need to verify certain guild properties. the endpoint should be used when detailed, up-to-date information about a particular guild is required. it does not modify any guild data and is read-only. note that the amount and type of information returned may depend on the permissions of the authenticated user making the request.
</Accordion>

<Accordion title="Initiate user channel with recipient">
  Creates a new direct message channel or retrieves an existing one between the authenticated user and specified recipient(s). this endpoint is used to initiate private conversations or group chats on discord. it supports creating one-on-one dms by providing a single recipient id, or group dms by using access tokens for multiple recipients. the endpoint also allows setting custom nicknames for users in the channel. use this when a user wants to start a new conversation or access an existing dm channel. note that this endpoint doesn't send a message; it only creates or retrieves the channel object.
</Accordion>

<Accordion title="Create new guild object">
  Creates a new guild (server) in discord with customizable settings. this endpoint allows you to set up a guild with specific roles, channels, moderation settings, and other configurations. use this when you need to programmatically create a new community or workspace within discord. the created guild will be owned by the authenticated user. note that while many parameters are optional, providing more details will result in a more complete and ready-to-use guild structure. be aware of rate limits and the maximum number of guilds a user can create, which may vary based on account type and status.\<\<DEPRECATED use create\_guild>>
</Accordion>

<Accordion title="Create guild channel">
  Creates a new channel within a specified discord guild (server). this endpoint allows for the creation of various channel types, including text channels, voice channels, categories, announcement channels, stage channels, directory channels, and forum channels. it provides extensive customization options for each channel type, such as setting permissions, configuring voice settings, and defining forum-specific parameters. use this endpoint when you need to programmatically add new channels to a guild, organize existing channels, or set up specialized channels like forums or announcement channels. note that the creation of channels is subject to the permissions of the authenticated user in the guild, and some options may only be applicable to specific channel types.
</Accordion>

<Accordion title="Create new guild object">
  Creates a new guild (server) in discord with customizable settings. this endpoint allows you to set up a guild with specific roles, channels, moderation settings, and other configurations. use this when you need to programmatically create a new community or workspace within discord. the created guild will be owned by the authenticated user. note that while many parameters are optional, providing more details will result in a more complete and ready-to-use guild structure. be aware of rate limits and the maximum number of guilds a user can create, which may vary based on account type and status.
</Accordion>

<Accordion title="Create application command objects">
  Creates a new global command for a discord application. this endpoint allows developers to define custom slash commands or context menu commands that users can interact with. the created command will be available in all guilds the application has the `applications.commands` scope authorized, as well as in dms. use this to expand your application's functionality by adding new ways for users to interact with your bot or app. be mindful of rate limits and the global command limit per application. after creation, it may take up to an hour for commands to be available to users.
</Accordion>

<Accordion title="Create guild application command">
  This endpoint creates a new application command for a specific guild (server) in discord. it allows developers to define custom slash commands, user commands, or message commands that can be used within the specified guild. the command can have various options, including subcommands and arguments, with support for different data types and localization. use this endpoint when you want to add new interactive functionality to your discord bot or application within a particular server. note that created commands will be available immediately, but may take up to an hour to be displayed to users due to caching. the endpoint is subject to rate limits, and there's a maximum of 100 application commands per guild.
</Accordion>

<Accordion title="Fetch application command by id">
  Retrieves detailed information about a specific command associated with a discord application. this endpoint allows developers to fetch the current configuration and properties of an existing command, such as its name, description, options, and permissions. it's particularly useful when you need to verify the current state of a command or gather information for updating or managing application commands. the endpoint should be used when you need to inspect or troubleshoot a specific command within your discord application. it does not create, modify, or delete commands; it only provides read-only access to command data.
</Accordion>

<Accordion title="Remove current user from thread">
  Removes the current authenticated user from a specified thread in discord. this endpoint allows a user to leave a thread they are currently a member of, effectively unsubscribing them from further notifications and removing their ability to view or participate in the thread if it's private. it should be used when a user no longer wishes to be part of a specific thread conversation. this action is irreversible, but the user can rejoin the thread later if it's public or if they're re-added by a thread member with appropriate permissions. the endpoint doesn't provide any information about the thread or other members; it simply performs the leave action.
</Accordion>

<Accordion title="Retrieve user connections">
  Retrieves a list of connected accounts for the authenticated user on discord. this endpoint allows developers to access information about external services or platforms that the user has linked to their discord account. it should be used when an application needs to gather data about a user's connected accounts, such as for displaying integrated services or syncing information across platforms. the endpoint returns details of various connections, which may include services like twitch, youtube, or other social media platforms. it's important to note that this endpoint only provides information about existing connections and does not allow for adding or modifying connections. the data returned is specific to the authenticated user and requires proper authentication to access.\<\<DEPRECATED use list\_my\_connections>>
</Accordion>

<Accordion title="Retrieve guild user ban details">
  Retrieves detailed information about a specific ban for a user in a discord guild. this endpoint allows developers to fetch the ban status and related details for a particular user within a specific guild (server). it's useful for moderators and administrators to review ban information, such as the reason for the ban and when it was implemented. the endpoint should be used when there's a need to verify or inspect an existing ban, but it cannot be used to create, modify, or remove bans. it's important to note that this endpoint only provides information if the specified user is actually banned from the guild; if the user is not banned, it may return an error or an empty response.
</Accordion>

<Accordion title="Retrieve current user guilds">
  Retrieves a list of guilds (servers) that the authenticated user is a member of on discord. this endpoint provides essential information about each guild, such as its id, name, and the user's role within it. it's particularly useful for applications that need to display or manage a user's server list, or to check a user's membership status across multiple servers. the endpoint returns only basic guild information and does not include detailed data like channel lists or member rosters. be aware that for users who are members of many guilds, the response may be paginated, and additional requests might be necessary to fetch the complete list.\<\<DEPRECATED use list\_my\_guilds>>
</Accordion>

<Accordion title="Retrieve guild welcome screen">
  Retrieves the welcome screen configuration for a specified discord guild (server). this endpoint is used to fetch the current settings and content of the welcome screen, which is displayed to new members when they join a community server. it's particularly useful for bot developers or server managers who need to programmatically access or display welcome screen information. the endpoint should be used when you need to view or verify the current welcome screen setup for a guild. note that this endpoint only works for guilds that have the community feature enabled and have set up a welcome screen. it will not provide welcome screen data for guilds that don't meet these criteria.
</Accordion>

<Accordion title="Retrieve guild widget information">
  Retrieves the widget information for a specified discord guild (server). this endpoint allows developers to fetch the current widget settings and data associated with a particular guild, which can be used to display guild information on external websites or applications. the widget typically includes details such as the guild's name, icon, member count, and available voice channels. use this endpoint when you need to access or display a guild's public information without requiring full access to the guild's data. it's particularly useful for creating embeddable widgets or for applications that need to showcase basic guild information. note that this endpoint only returns data if the guild has the widget feature enabled in its settings.
</Accordion>

<Accordion title="Preview guild by id">
  Retrieves a preview of a discord guild (server) based on its id. this endpoint allows users or bots to fetch basic information about a guild without being a member, such as the guild's name, description, approximate member count, and icon. it's particularly useful for discovering new guilds, making decisions about joining a guild, or for bots to gather information about guilds they're not part of. the preview only includes public information and is subject to the guild having enabled the preview feature. this endpoint should not be used to fetch detailed or sensitive guild information, as it only provides a limited subset of guild data.
</Accordion>

<Accordion title="Retrieve guild template with code">
  Retrieves detailed information about a specific discord guild template using its unique code. this endpoint allows developers to fetch the pre-configured settings, name, and description of a guild template, which can be used to quickly create new guilds with predefined structures. it's particularly useful when you need to review or validate a template's contents before creating a guild based on it. the endpoint returns comprehensive data about the template but does not create or modify any guilds. use this when you need to display template information to users or verify template details programmatically.
</Accordion>

<Accordion title="Retrieve guild widget json">
  Retrieves the json representation of a discord guild's widget. this endpoint allows developers to fetch publicly available information about a specific guild that can be embedded or displayed on external websites or applications. the widget typically includes details such as the guild's name, member count, and possibly a list of online members or voice channels. this tool is useful for creating promotional materials for discord servers or integrating discord community information into third-party applications. it should be used when you need to display up-to-date information about a discord guild without requiring users to be logged in or have direct access to the server. note that the guild must have the widget feature enabled for this endpoint to return data, and the information provided is limited to what the guild administrators have chosen to make public.
</Accordion>

<Accordion title="Retrieve sticker from guild">
  Retrieves detailed information about a specific sticker within a discord guild (server). this endpoint is used to fetch the properties and metadata of a single sticker, such as its name, description, format type, and associated emoji. it's particularly useful for applications that need to display or manage custom stickers within a guild. the endpoint should be used when you need comprehensive information about a specific sticker, rather than a list of all stickers in a guild. note that this endpoint likely requires appropriate permissions to access the guild and its sticker data.
</Accordion>

<Accordion title="Fetch emoji by guild and id">
  Retrieves detailed information about a specific emoji from a discord guild (server). this endpoint allows developers to fetch the properties and metadata of a custom emoji, such as its name, image url, and creation date. it should be used when you need to access or display information about a particular emoji within a guild's context. the endpoint is useful for applications that manage emojis, display emoji details, or need to verify an emoji's existence and properties. note that this endpoint only retrieves data for custom emojis created within the specified guild and does not provide information about standard unicode emojis.
</Accordion>

<Accordion title="Retrieve guild command permissions">
  Retrieves the permissions configured for a specific application command within a discord guild. this endpoint allows developers to check which roles or users have permission to use a particular command in a given server. it's useful for auditing command access, troubleshooting permission issues, or verifying that command restrictions are properly set up. the endpoint returns detailed permission information, which may include allowed and disallowed roles or users for the specified command. this tool should be used when you need to inspect or validate the current permission settings for a command in a specific guild context. it does not modify permissions; it only provides read access to the existing configuration.
</Accordion>

<Accordion title="Retrieve guild webhooks">
  Retrieves all webhooks associated with a specific discord guild (server). this endpoint allows developers to fetch a comprehensive list of webhooks that have been created within the specified guild. it's particularly useful for managing and auditing webhook integrations, such as those used for automated messaging or external service connections. the endpoint should be used when you need to review, manage, or gather information about existing webhooks in a guild. it does not create, modify, or delete webhooks; it only provides read access to the current webhook configuration. the response typically includes details such as the webhook's id, name, channel id, and other relevant metadata for each webhook in the guild.
</Accordion>

<Accordion title="Retrieve thread member by id">
  Retrieves information about a specific user's membership in a thread within a discord channel. this endpoint allows you to fetch details such as the user's thread permissions, join timestamp, and other relevant information. use this when you need to check a user's status or rights within a particular thread. it's particularly useful for moderation purposes or when implementing thread-specific features in your application. the endpoint does not modify any data and only provides read-only access to thread member information.
</Accordion>

<Accordion title="Retrieve sticker by id">
  Retrieves detailed information about a specific discord sticker using its unique identifier. this endpoint allows developers to fetch comprehensive data about a single sticker, including its name, description, format type, and associated pack details. it's particularly useful when building features that involve displaying or managing individual stickers within a discord-integrated application. the endpoint should be used when specific sticker information is needed, rather than for bulk retrieval of multiple stickers. note that this endpoint only provides data for existing, valid stickers; it will not create new stickers or modify existing ones.
</Accordion>

<Accordion title="Get guild scheduled event by id">
  Retrieves detailed information about a specific scheduled event within a discord guild. this endpoint allows developers to fetch comprehensive data about a particular event, including its name, description, start and end times, location (if applicable), and current status. it's useful for displaying event information in applications, tracking event details, or syncing event data with external calendars. the endpoint should be used when up-to-date information about a specific guild event is needed. it does not modify the event or provide information about event attendees. note that the response will only include publicly available information about the event, and access may be restricted based on the bot's permissions within the guild.
</Accordion>

<Accordion title="Retrieve guild auto moderation rules">
  Retrieves all auto moderation rules configured for a specific discord guild (server). this endpoint allows developers to fetch the current set of automated content moderation rules that have been set up to maintain community standards within the specified guild. it should be used when you need to review, audit, or display the existing auto moderation configuration for a server. the endpoint returns information about various rule types, such as keyword filters, spam detection, and mention limits, along with their associated actions and exemptions. it does not modify any existing rules or create new ones; it is purely for retrieving current rule configurations.
</Accordion>

<Accordion title="Fetch guild application command by id">
  Retrieves detailed information about a specific application command within a discord guild. this endpoint allows developers to fetch the properties and configuration of a command that has been registered for their application in a particular server. it's useful for inspecting command settings, verifying command existence, or retrieving command details for modification purposes. the endpoint requires the application id, guild id, and command id to be specified in the path, ensuring precise targeting of the desired command. this tool should be used when needing to review or validate the current state of a specific command in a guild, but it does not modify the command or return a list of all commands.
</Accordion>

<Accordion title="List guild regions">
  Retrieves a list of available voice regions for a specific discord guild (server). this endpoint should be used when setting up or managing voice channels within a guild to determine which voice server locations are available for optimizing voice quality and reducing latency. the returned information can help in choosing the most suitable region for the guild's voice channels based on the geographical distribution of its members. this endpoint does not modify any guild settings; it only provides information about available options. it's particularly useful for large or geographically diverse communities where voice quality is a priority.
</Accordion>

<Accordion title="Retrieve message from channel">
  Retrieves a specific message from a discord channel. this endpoint allows you to fetch detailed information about a single message, including its content, author, timestamp, and any attachments or embeds. it's particularly useful for bot development, message logging, or implementing features that require analysis or manipulation of specific messages. the endpoint should be used when you need to access or verify the contents of a particular message within a channel. it does not provide information about other messages in the channel or modify the message in any way. note that you must have the necessary permissions to view the message in the specified channel.
</Accordion>

<Accordion title="Retrieve guild new member welcome">
  Retrieves the new member welcome screen settings for a specified discord guild (server). this endpoint allows developers to fetch the current configuration of the welcome screen that new members see when joining the guild. it provides information about the customized welcome message, any specific instructions or guidelines for new members, and potentially the enabled/disabled status of the welcome screen feature. use this endpoint when you need to view or check the existing welcome screen setup, such as before making modifications or for informational purposes. it does not modify the welcome screen settings; for that, you would need to use a separate update endpoint. the response likely includes details about the welcome message content, any customizable elements like suggested channels or roles, and possibly information about membership screening if it's enabled for the guild.
</Accordion>

<Accordion title="List guild roles">
  Retrieves all roles defined within a specific discord guild (server). this endpoint is used to fetch comprehensive information about the role hierarchy and permissions structure of a given server. it provides details on each role, including their names, colors, positions in the hierarchy, and associated permissions. this tool is essential for applications that need to understand or manage the permission structure of a discord server, such as moderation bots or server management tools. it should be used when you need a complete overview of a guild's roles, but it won't provide information about which users have which roles.
</Accordion>

<Accordion title="Retrieve guild prune info">
  Retrieves the number of members that would be removed from a specified discord guild (server) in a prune operation. this endpoint is used to estimate the impact of a prune action before actually performing it. it calculates how many inactive members would be removed based on the specified inactivity period and role criteria. this tool is particularly useful for large guild management and cleanup operations, helping administrators make informed decisions about member pruning. it does not actually remove any members; it only provides a count. use this endpoint when planning guild maintenance or when you need to assess the potential impact of a prune operation on your guild's member count.
</Accordion>

<Accordion title="Retrieve guild vanity url">
  Retrieves the vanity url information for a specified discord guild (server). this endpoint allows you to fetch details about a guild's custom invite link, including the vanity url code and the number of times it has been used. it's particularly useful for server administrators or bots that need to monitor or manage the guild's invitation system. the endpoint should be used when you need to check the current status of a guild's vanity url or track its usage. note that not all guilds have vanity urls; this feature is typically available only for servers that meet certain criteria or have specific features enabled.
</Accordion>

<Accordion title="List thread members in channel">
  Retrieves a list of members participating in a thread within a specific discord channel. this endpoint is used to fetch information about users who have joined or been added to a thread, providing insights into thread participation and activity. it's particularly useful for moderators or bots that need to monitor thread engagement or perform actions based on thread membership. the endpoint returns details about thread members, which may include their user ids, join timestamps, and other relevant information. use this endpoint when you need to track thread participation or gather data about user involvement in specific discussions within a discord server.
</Accordion>

<Accordion title="Retrieve guild member for current user">
  Retrieves detailed information about the authenticated user's membership in a specific discord guild (server). this endpoint allows developers to fetch member-specific data such as roles, nickname, join date, and other relevant information for the current user within the specified guild. it should be used when an application needs to access or display the user's status and details within a particular discord server. this endpoint is particularly useful for applications that manage user interactions across multiple guilds or need to verify a user's membership status. note that this endpoint only provides information for the authenticated user and cannot be used to fetch member details for other users.
</Accordion>

<Accordion title="List sticker packs">
  Retrieves a list of available sticker packs on the discord platform. this endpoint provides information about collections of stickers that users can access and use in their discord messages. it's useful for applications that want to display or manage sticker packs within their interface. the endpoint returns details about official discord sticker packs, which may include pack names, descriptions, banner images, and the stickers contained within each pack. note that this endpoint likely does not include custom or user-created sticker packs, focusing instead on the standard packs available to all discord users.
</Accordion>

<Accordion title="Fetch messages from channel">
  Retrieves messages from a specified discord channel. this endpoint allows you to fetch the message history or recent messages for a given channel, which is useful for displaying chat logs, implementing search functionality, or syncing messages across different platforms. the endpoint returns a list of message objects, likely in reverse chronological order (newest first). it should be used when you need to access the content of messages in a specific channel, such as for moderation purposes, data analysis, or creating chat archives. note that this endpoint may have rate limits and pagination to manage large message volumes, so it's important to handle these aspects in your implementation. the endpoint does not provide real-time updates; for live message tracking, consider using discord's websocket api instead.
</Accordion>

<Accordion title="Get channel message reaction by emoji">
  Retrieves a list of users who have reacted to a specific message with a particular emoji in a discord channel. this endpoint allows you to fetch detailed information about reactions on a message, which is useful for analyzing user engagement, creating interactive features, or gathering metrics on content popularity. it should be used when you need to know who reacted to a message with a specific emoji, such as for implementing reaction-based features or moderating content based on reactions. the endpoint is limited to retrieving reactions for a single emoji at a time and does not provide information about other reactions on the message or the message content itself.
</Accordion>

<Accordion title="Get guild members">
  Retrieves a list of members for a specified discord guild (server). this endpoint allows developers to fetch detailed information about the users who are part of a particular guild. it's useful for various purposes such as member management, analytics, or displaying member information within a bot or application. the endpoint returns member data which typically includes user ids, usernames, roles, and join dates. it's important to note that this endpoint may not return all members for very large guilds due to discord's optimization practices. in such cases, pagination might be necessary, though the details are not provided in this schema. use this endpoint when you need to access member information for a specific guild, but be mindful of rate limits and the potential need for pagination in large guilds.
</Accordion>

<Accordion title="Get your applications">
  Retrieves detailed information about the current authenticated application. this endpoint allows developers to access various attributes and settings of their discord application or bot. it's particularly useful for self-inspection, verifying application details, or dynamically adjusting application behavior based on its current configuration. the endpoint returns comprehensive data about the application, which may include its name, description, icon, bot user information, and other relevant metadata. while specific return fields are not detailed in the schema, developers can expect a rich set of application-related information. this endpoint should be used when an application needs to introspect its own properties or verify its current state within the discord ecosystem.
</Accordion>

<Accordion title="List guild integrations">
  Retrieves a list of integration objects for a specified discord guild. this endpoint is used to fetch information about all third-party services, bots, or applications that have been integrated with the guild. it's particularly useful for guild administrators or bot developers who need to manage or audit the external services connected to a discord server. the endpoint requires the manage guild permission and should be used when you need a comprehensive overview of a guild's integrations. note that this endpoint only provides integration data and does not allow for modifying or adding new integrations.
</Accordion>

<Accordion title="Pin message in channel">
  This endpoint allows you to pin a specific message in a discord channel. pinning a message keeps it at the top of the channel, making it easily accessible to all users. this is useful for highlighting important information, announcements, or frequently referenced content within a channel. the endpoint requires the channel id and message id to identify the exact message to be pinned. it's important to note that there is a limit to the number of pinned messages per channel, typically set to 50. if this limit is reached, you may need to unpin an existing message before pinning a new one. this endpoint should be used when you want to emphasize a particular message for long-term visibility in a channel.
</Accordion>

<Accordion title="Fetch voice regions list">
  Retrieves a list of available voice regions for discord servers. this endpoint provides information about the geographic locations where voice channels can be hosted, allowing server administrators to optimize voice quality and reduce latency for their users. use this endpoint when setting up new voice channels, troubleshooting voice connection issues, or planning server infrastructure. the returned data typically includes region identifiers, names, and potentially other relevant details for each available voice region. note that while this endpoint lists all possible regions, the actual availability might depend on the server's location and discord's current infrastructure.
</Accordion>

<Accordion title="Update guild onboarding configuration">
  Updates the onboarding configuration for a specified discord guild (server). this endpoint allows server administrators to customize the onboarding experience for new members by defining prompts, setting default channels, and controlling the overall onboarding process. it can be used to create an interactive and guided introduction to the server, helping new members understand the community structure and rules. the endpoint supports advanced customization options, including multiple-choice questions, role assignments, and channel suggestions. however, it's important to note the limitations on the number of prompts, options, and default channels that can be configured.
</Accordion>

<Accordion title="Retrieve guild member by user id">
  Retrieves detailed information about a specific member within a discord guild. this endpoint allows developers to fetch comprehensive data about a user's membership in a particular server, including their roles, permissions, nickname, and join date. it's particularly useful for bot developers and applications that need to manage guild members or make decisions based on a member's status and attributes. the endpoint should be used when detailed, up-to-date information about a specific guild member is required. it will not provide information about the user's activities in other guilds or their global discord account details. keep in mind that the bot or application must have the necessary permissions within the guild to access this information.
</Accordion>

<Accordion title="Prune guild members by roles">
  Initiates a prune operation to remove inactive members from a discord guild. this endpoint allows server administrators to automatically remove members who have not been active for a specified number of days. the prune can be customized to target specific roles and can optionally calculate the number of affected members before execution. use this endpoint to maintain an active community by removing dormant accounts. exercise caution, as this action permanently removes members from the guild. it's recommended to use the compute prune count option first to assess the impact before performing the actual prune.
</Accordion>

<Accordion title="Trigger typing indicator">
  Triggers a typing indicator in a specified discord channel, indicating that the bot or application is currently typing a message. this endpoint is used to simulate the typing status typically shown when a user is composing a message. it's particularly useful for creating a more natural, human-like interaction in bot responses or when the bot is processing a lengthy operation before sending a message. the typing indicator typically lasts for 10 seconds or until a message is sent, whichever comes first. this endpoint should be used sparingly and in conjunction with actual message sending to avoid misleading users. note that repeatedly triggering this endpoint without sending a message may be considered api abuse.
</Accordion>

<Accordion title="Get oauth2 applications for current user">
  Retrieves detailed information about the current oauth2 application authenticated with discord. this endpoint allows developers to access metadata and settings for their application, such as the app's name, icon, description, and other relevant details. it's particularly useful for applications that need to verify their own identity or fetch up-to-date configuration information. the endpoint should be used when an application needs to self-inspect or update its own information dynamically. note that this endpoint only provides information about the authenticated application and cannot be used to query details of other discord applications.
</Accordion>

<Accordion title="Retrieve channel invites">
  Retrieves a list of all active invites for a specific discord channel. this endpoint allows developers to gather information about existing invites, including details such as the invite code, creator, expiration time, and usage statistics. it's particularly useful for managing channel access, tracking invite usage, or implementing invite-based features within a discord bot or application. the endpoint returns invite objects for the specified channel, providing a comprehensive view of how users can join the channel. note that this endpoint only returns information about existing invites and does not create new invites or modify existing ones.
</Accordion>

<Accordion title="Delete guild user ban">
  Removes a ban for a user from a specific guild (server) in discord. this endpoint is used to lift an existing ban, allowing the user to rejoin the guild if they choose. it's typically used by guild administrators or moderators as part of the moderation process, such as when a banned user's punishment period has ended or if the ban was placed in error. the endpoint requires only the guild id and the user id, making it a straightforward operation for unbanning. note that this action only removes the ban; it does not automatically add the user back to the guild or restore their previous roles and permissions.
</Accordion>

<Accordion title="Get archived public threads by channel id">
  Retrieves a list of archived public threads from a specified discord channel. this endpoint is used to access threads that are no longer active but remain viewable for reference purposes. it's particularly useful for reviewing past discussions or retrieving information from older, inactive threads. the endpoint only returns public threads, which are visible to all members with access to the parent channel. it does not provide access to archived private threads or active threads. use this endpoint when you need to browse or search through historical public discussions within a specific channel.
</Accordion>

<Accordion title="Search guild members by id">
  The search guild members endpoint allows you to search for members within a specific discord guild (server) based on their username or nickname. this get request is useful for finding particular users in a guild, especially in large communities where manual searching might be impractical. the endpoint returns a list of guild member objects whose username or nickname starts with the provided search string. it's particularly beneficial for bots and applications that need to manage or interact with specific guild members efficiently. note that this endpoint may have limitations on the number of results returned and could be subject to rate limiting. for more accurate and faster results, consider using the newer elasticsearch-based endpoint '/guilds/\{guild id}/members-search' if available.
</Accordion>

<Accordion title="Delete channel message pin">
  Removes a specific pinned message from a discord channel. this endpoint is used to unpin a previously pinned message, making it no longer appear in the channel's pinned messages list. it's particularly useful for managing important information in a channel by removing outdated or no longer relevant pinned content. the operation is irreversible, so use it cautiously. this tool should be used when you need to declutter pinned messages or remove sensitive information from the pinned section. it will not delete the message from the channel entirely, only remove its pinned status.
</Accordion>

<Accordion title="Patch channel properties by id">
  Modifies an existing discord channel by updating its properties. this endpoint allows you to change various aspects of a channel, such as its name, type, permissions, and settings. it can be used to customize channels for different purposes, manage channel organization, or adjust channel-specific features. the endpoint is flexible, allowing partial updates by only specifying the properties you want to change. it supports modifications for different channel types, including text channels, voice channels, categories, and forum channels. when using this endpoint, be cautious about changing critical properties like channel type or permissions, as it may affect user access and channel functionality. note that some properties are only applicable to specific channel types, and attempting to set incompatible properties may result in errors.
</Accordion>

<Accordion title="Modify guild auto moderation rule">
  This endpoint modifies an existing auto-moderation rule for a discord guild. it allows updating various aspects of the rule, including its name, event type, actions, and trigger settings. use it to fine-tune moderation strategies or adjust rule sensitivity. be cautious of potential impacts on user experience and ensure alignment with server policies. note that this endpoint requires the existing rule's id.
</Accordion>

<Accordion title="Retrieve guild invites by id">
  Retrieves all active invites for a specified discord guild (server). this endpoint allows developers to fetch a comprehensive list of current invitations to join the guild, including details such as the invite codes, creators, and expiration times. it's particularly useful for guild management, analytics, or creating invite management features within applications. the endpoint should be used when an overview of all active guild invites is needed, such as for moderation purposes or tracking invite usage. note that this endpoint only returns active invites; expired or revoked invites will not be included in the response. the user making the request must have sufficient permissions within the guild to view invites.
</Accordion>

<Accordion title="Modify guild member details">
  The modifyguildmember endpoint allows you to update various attributes of a specific member within a discord guild (server). this powerful tool enables fine-grained control over a member's settings, including their nickname, role assignments, voice channel status, and temporary communication restrictions. use this endpoint when you need to programmatically manage member properties, such as assigning roles, moving users between voice channels, or imposing time-outs. it's particularly useful for moderation bots or applications that need to automate member management tasks. the endpoint requires the guild id and user id as path parameters, and accepts a json body with the attributes to be modified. note that this endpoint can only modify attributes that the authorized bot or application has permission to change, and some modifications may require specific permissions within the guild.
</Accordion>

<Accordion title="Modify channel permissions">
  Updates or creates a permission overwrite for a specific role or member in a discord channel. this endpoint allows for fine-grained control over channel-specific permissions, enabling customization of access and actions within a discord server. it should be used when modifying existing permission overwrites or creating new ones for roles or members in a channel. the endpoint accepts bitwise permission values for allowing and denying specific actions, providing granular control over user capabilities. it's important to note that this operation will overwrite any existing permissions for the specified role or member in the channel, so care should be taken to include all desired permissions in the request.
</Accordion>

<Accordion title="Get oauth2 user information">
  Retrieves the authenticated user's profile information using discord's oauth2 system. this endpoint returns essential details about the user, such as their identity, associated guilds, and potentially other account-related information. it should be used when an application needs to access the current user's data after successful oauth2 authentication. the endpoint is particularly useful for personalization, user management, and integration of discord user data into third-party applications. note that the specific data returned may depend on the oauth2 scopes granted during the authentication process.
</Accordion>

<Accordion title="Update guild settings">
  This endpoint allows you to modify various settings of a discord guild (server). it provides extensive control over guild configuration, including name, description, moderation settings, channel assignments, and feature toggles. use this endpoint when you need to update one or more guild settings programmatically. the endpoint is particularly useful for bot developers and server management tools that need to automate guild configuration changes. note that some parameters may require specific guild features to be enabled, and certain modifications (like transferring ownership) may require additional permissions. be cautious when modifying critical settings like verification levels or system channels, as these changes can significantly impact the guild's functionality and user experience.
</Accordion>

<Accordion title="Modify guild role">
  This endpoint allows you to modify the attributes of an existing role within a discord guild (server). it is used to update various properties of a role, such as its name, permissions, color, and display settings. the endpoint is particularly useful for bot developers who need to programmatically manage roles in discord servers. to use this endpoint, you must specify both the guild id and role id in the url path. the request body can contain any combination of the modifiable attributes, allowing for partial updates. any attributes not included or set to null will remain unchanged. it's important to note that this endpoint can only modify existing roles; it cannot create new roles or delete existing ones. also, be cautious when modifying role permissions, as this can significantly impact user access within the guild.
</Accordion>

<Accordion title="Retrieve user connections">
  Retrieves a list of connected accounts for the authenticated user on discord. this endpoint allows developers to access information about external services or platforms that the user has linked to their discord account. it should be used when an application needs to gather data about a user's connected accounts, such as for displaying integrated services or syncing information across platforms. the endpoint returns details of various connections, which may include services like twitch, youtube, or other social media platforms. it's important to note that this endpoint only provides information about existing connections and does not allow for adding or modifying connections. the data returned is specific to the authenticated user and requires proper authentication to access.
</Accordion>

<Accordion title="Get current user data">
  Retrieves detailed information about the currently authenticated user on discord. this endpoint should be used when an application needs to access the profile data of the user who has authorized the application. it returns comprehensive user information, including username, discriminator, avatar, email (if authorized), and other relevant account details. this endpoint is essential for personalizing user experiences within discord applications and should be called when initializing a user session or when up-to-date user information is required. note that the endpoint does not provide information about the user's guilds or relationships; separate endpoints exist for those purposes.
</Accordion>

<Accordion title="Update guild scheduled event">
  Updates an existing scheduled event in a discord guild. this endpoint allows modifying various attributes of a scheduled event, such as its status, name, description, timing, and associated metadata. it's particularly useful for managing the lifecycle of events, changing event details, or adjusting schedules. the endpoint provides flexibility in updating different types of events (stage instances, voice events, or external events) with type-specific fields. use this endpoint when you need to make changes to an existing event rather than creating a new one or when transitioning an event through its lifecycle stages (e.g., from scheduled to active to completed).
</Accordion>

<Accordion title="Update guild sticker info">
  This endpoint allows you to modify an existing sticker within a specific discord guild. it enables partial updates to the sticker's properties, including its name, tags, and description. use this endpoint when you need to update sticker information without creating a new sticker or replacing it entirely. the changes are applied immediately, and only the provided fields will be updated, leaving others unchanged. note that this endpoint requires appropriate permissions within the guild to modify stickers.
</Accordion>

<Accordion title="Retrieve current user guilds">
  Retrieves a list of guilds (servers) that the authenticated user is a member of on discord. this endpoint provides essential information about each guild, such as its id, name, and the user's role within it. it's particularly useful for applications that need to display or manage a user's server list, or to check a user's membership status across multiple servers. the endpoint returns only basic guild information and does not include detailed data like channel lists or member rosters. be aware that for users who are members of many guilds, the response may be paginated, and additional requests might be necessary to fetch the complete list.
</Accordion>

<Accordion title="Retrieve user by id">
  Retrieves detailed information about a specific discord user based on their unique user id. this endpoint allows developers to access public user data, which may include the user's username, avatar, account creation date, and other relevant information. it's particularly useful for applications that need to display user profiles, manage user interactions, or integrate discord user data into their services. the endpoint should be used when specific user details are required, but it will not provide information about the user's activities, messages, or server memberships. note that some user information may be limited based on privacy settings or if the user has restricted access to their profile.
</Accordion>

<Accordion title="Update guild welcome screen">
  Updates the welcome screen configuration for a specified discord guild. this endpoint allows server administrators to customize the welcome experience for new members by modifying the welcome screen's description, enabling or disabling the feature, and configuring up to five welcome channels. each welcome channel can be customized with a description and an optional emoji. use this endpoint to create an engaging first impression for new guild members and guide them to important channels or information within the community.
</Accordion>

<Accordion title="Modify application by id">
  Updates the properties of an existing discord application. this endpoint allows you to modify various aspects of your application, including its description, visual elements, team affiliation, interaction endpoints, and installation parameters. use this when you need to change or update any details of your discord application after its initial creation. it's particularly useful for maintaining up-to-date application information, adjusting its appearance, or modifying its behavior. note that some fields, like the application type, have specific constraints, and others, like the icon and cover image, require base64-encoded strings.
</Accordion>

<Accordion title="Patch guild widget endpoint">
  Modifies the widget settings for a specific discord guild (server). this endpoint allows you to enable or disable the guild widget and set the channel where the widget invite will direct new users. the guild widget is a customizable interface that provides information about the guild and can be used to attract new members. use this endpoint when you need to update the widget configuration, such as changing its visibility or the designated invite channel. it's particularly useful for guild administrators who want to manage their server's public presence or control how new members join through the widget. note that this endpoint only modifies widget settings and does not create or delete the widget itself.
</Accordion>

<Accordion title="Retrieve channel webhooks">
  Retrieves a list of all webhooks associated with a specific discord channel. this endpoint allows developers to fetch detailed information about existing webhooks for a given channel, including their ids, names, avatars, and token (if available). it's useful for managing and auditing webhook configurations within a discord server. the endpoint should be used when you need to review or manage the webhooks set up for a particular channel, such as for debugging, updating, or removing webhooks. it does not create new webhooks or modify existing ones. note that this endpoint only returns webhooks for the specified channel and does not provide information about webhooks in other channels or server-wide webhooks.
</Accordion>

<Accordion title="Update guild template by code">
  Updates an existing guild template for a specified discord server (guild). this endpoint allows you to modify the pre-configured settings of a template, which may include roles, channels, and permissions. use this when you need to change the structure or settings of an existing template to better suit your guild's needs. it's particularly useful for server administrators who want to refine their guild templates over time based on community feedback or changing requirements. note that this endpoint only updates the template; it does not create a new guild from the template or apply the changes to existing guilds.
</Accordion>

<Accordion title="List commands for application">
  Retrieves all commands registered for a specific discord application. this endpoint allows developers to fetch a list of all slash commands associated with their bot or application. it's useful for managing, auditing, or displaying the available commands for an application. the endpoint returns an array of command objects, each containing details such as the command name, description, and options. use this when you need to review, update, or sync your application's command list with discord's servers. note that this endpoint only retrieves global commands and does not include guild-specific commands.
</Accordion>

<Accordion title="Modify guild member nickname">
  This endpoint allows you to modify the nickname of the currently authenticated user within a specific discord guild (server). it's used when a user wants to change their display name in a particular server without affecting their global username. the nickname is limited to 32 characters and can be set to null to remove it entirely. this operation is useful for personalizing a user's identity within different communities or for role-playing purposes. note that the ability to change nicknames may be restricted by server permissions, and some servers may have policies about nickname content.
</Accordion>

<Accordion title="Update channel message">
  Edits an existing message in a specific discord channel. this endpoint allows you to modify various aspects of a message, including its text content, embeds, components, and attachments. it's useful for updating bot-sent messages with new information, correcting errors, or adding interactive elements after the initial message was sent. you can selectively update specific parts of the message by including only the fields you want to change. omitted fields will remain unchanged. to remove content, embeds, or components, set their respective fields to null or an empty array. note that you can only edit messages sent by your bot or application. there are rate limits on editing messages, so avoid excessive edits. some message properties, like the author, cannot be changed using this endpoint.
</Accordion>

<Accordion title="Patch guild template information">
  Updates an existing guild template in discord. this endpoint allows you to modify the name and/or description of a specific template within a guild. use this when you need to refine or adjust the metadata of a guild template without creating a new one. the endpoint is particularly useful for maintaining up-to-date and accurate template information as your server evolves. note that this operation only affects the template itself and does not impact any guilds that may have been created from this template previously. be aware that you can only update templates for guilds where you have the necessary permissions.
</Accordion>

<Accordion title="Update current user profile">
  Updates the current user's discord profile, allowing modifications to the username and avatar. this endpoint should be used when a user wants to change their display name or profile picture within the discord platform. it's particularly useful for users who want to refresh their online identity or maintain consistency across different servers. the endpoint only updates the specified fields, leaving other profile information unchanged. note that changing the username too frequently may be subject to rate limiting, and inappropriate avatars may be removed by discord moderators. this endpoint does not handle other account settings such as email or password changes.
</Accordion>

<Accordion title="Patch webhook original message">
  The editwebhookmessage endpoint allows you to modify an existing message sent through a discord webhook. use this to update content, add embeds, change attachments, or include interactive components. it supports partial updates, letting you modify specific elements without affecting others. be aware of rate limits and maximum limits for content length, embeds, attachments, and components.
</Accordion>

<Accordion title="Retrieve original webhook message">
  Retrieves the original message sent through a specific discord webhook. this endpoint is used to fetch the initial content and metadata of a message that was posted to a discord channel via a webhook. it's particularly useful for verifying the content of automated messages or for auditing purposes. the endpoint only returns data for the original message and cannot be used to retrieve subsequent edits or responses. use this when you need to review or confirm the exact content of a webhook-sent message in its original form.
</Accordion>

<Accordion title="Patch guild voice state">
  Updates a user's voice state within a specific discord guild (server). this endpoint allows for modifying a user's suppression status and changing their voice channel. it can be used to programmatically mute/unmute users or move them between voice channels. the endpoint is particularly useful for bot applications that need to manage voice states, such as moderation bots or music bots. note that this endpoint only updates the specified properties; any unspecified properties will remain unchanged. also, be aware that using this endpoint may be subject to discord's rate limits and requires appropriate permissions within the guild.
</Accordion>

<Accordion title="Update webhook details patch">
  This endpoint allows you to update the properties of an existing discord webhook. it can be used to modify the webhook's name, avatar, or the channel it's associated with. this is particularly useful for maintaining and adjusting webhooks as your discord server evolves. the endpoint accepts partial updates, meaning you can provide only the fields you want to change. keep in mind that this operation directly modifies the webhook, so use it carefully to avoid unintended changes to your integrations.
</Accordion>

<Accordion title="Modify guild voice state for me">
  Updates the current user's voice state in a specific discord guild. this endpoint allows for modifying various aspects of a user's voice presence, including their speaking request status, audio suppression, and the voice channel they're connected to. it's particularly useful for managing user interactions in stage channels or for programmatically moving users between voice channels. the endpoint should be used when you need to programmatically adjust a user's voice settings or location within a guild's voice channels. it's important to note that this endpoint only affects the current user (the bot or application making the request) and cannot be used to modify other users' voice states. also, some parameters may have different effects depending on the type of voice channel (e.g., regular voice channel vs. stage channel).
</Accordion>

<Accordion title="Get oauth2 keys">
  Retrieves the oauth2 public keys used for verifying access tokens issued by discord. this endpoint is crucial for implementing secure token validation in applications that integrate with discord's oauth2 authentication system. it should be used when setting up or updating an application's authentication process to ensure proper verification of discord-issued tokens. the endpoint returns a set of public keys in json web key (jwk) format, which can be used to verify the signatures of discord's json web tokens (jwts). note that the keys may be rotated periodically, so applications should be prepared to handle multiple keys and update their key cache as needed.
</Accordion>

<Accordion title="Update thread membership">
  Adds the authenticated user to a thread within a specified discord channel. this endpoint should be used when a user wants to join a thread they are not currently a member of. it allows users to participate in thread discussions and receive notifications for that thread. the endpoint is particularly useful for joining archived threads or threads in channels where the user doesn't have automatic thread join permissions. note that this endpoint may fail if the thread is at maximum capacity or if the user doesn't have permission to join the thread. it's important to handle potential errors gracefully in your application.
</Accordion>

<Accordion title="Retrieve webhook by id">
  Retrieves detailed information about a specific discord webhook using its unique identifier. this endpoint allows developers to fetch the current configuration and status of a webhook, including its name, channel association, and other relevant details. it's particularly useful for verifying webhook settings, troubleshooting integration issues, or gathering data for webhook management tasks. the endpoint provides a snapshot of the webhook's properties at the time of the request, but does not include historical data or usage statistics. use this when you need to confirm a webhook's existence, check its current setup, or gather information for updating webhook configurations.
</Accordion>

<Accordion title="Retrieve webhook information">
  Retrieves detailed information about a specific discord webhook. this endpoint allows you to fetch the current state and configuration of a webhook, including its name, avatar, channel id, and guild id. use this when you need to verify a webhook's settings or before making changes to ensure you have the most up-to-date information. the endpoint requires both the webhook's unique id and its associated token for authentication. it's important to note that this endpoint only provides information about the webhook itself and does not return any message history or usage statistics.
</Accordion>

<Accordion title="Retrieve webhook message by id">
  Retrieves a specific message that was previously sent through a discord webhook. this endpoint allows developers to fetch the content and metadata of a single message using its unique identifier. it's particularly useful for verifying message delivery, auditing webhook activity, or retrieving specific information from past webhook interactions. the endpoint requires the webhook's id and token for authentication, ensuring that only authorized parties can access the message data. use this when you need to confirm the content of a sent message or when you want to review or process specific webhook messages programmatically.
</Accordion>

<Accordion title="Update guild emoji roles">
  This endpoint allows you to modify an existing custom emoji in a discord guild (server). it can be used to update the emoji's name or adjust which roles have permission to use it. the endpoint is particularly useful for managing emoji access control or rebranding existing emojis without creating new ones. it's important to note that this endpoint only modifies existing emojis and cannot be used to create new ones or delete existing emojis. the changes applied through this endpoint are immediate and affect all future uses of the emoji within the guild.
</Accordion>

<Accordion title="Update application description">
  Updates the settings of a discord application. this endpoint allows developers to modify various aspects of their application, including its description, visual elements, team association, interaction endpoints, and installation parameters. it's particularly useful for maintaining and evolving an application's presence and functionality within the discord ecosystem. the endpoint accepts partial updates, meaning you only need to include the fields you want to change. use this when you need to adjust your application's configuration, update its appearance, or modify its interaction and installation settings. note that some changes may affect how users interact with or perceive your application, so use this endpoint judiciously. keep in mind that certain fields have specific format requirements or limitations, such as character limits for descriptions and url formats for endpoints.
</Accordion>

<Accordion title="Delete user guild">
  Removes the authenticated user from a specified guild (server) on discord. this endpoint should be used when a user wants to voluntarily leave a guild they are currently a member of. it's important to note that this action is immediate and irreversible without a new invitation. the endpoint does not provide any additional functionality such as transferring ownership or managing other users. use this endpoint cautiously, as leaving a guild may result in loss of access to the guild's content, roles, and permissions. this action cannot be used to remove other users from a guild; it only affects the authenticated user.
</Accordion>

<Accordion title="Retrieve invite by code">
  Retrieves detailed information about a discord invite using its unique invite code. this endpoint allows developers to fetch data about an invite, including the associated guild (server), channel, and potentially additional details such as approximate member counts, online member counts, and expiration date. it's particularly useful when you need to validate an invite or display information about it before a user decides to join a server. the endpoint does not actually join the user to the server; it only provides information about the invite. keep in mind that some invite details may be limited based on the permissions of the requesting user or bot.
</Accordion>

<Accordion title="Delete invite via code">
  Deletes a specific invite from a discord server using its unique invite code. this endpoint should be used when you want to revoke access to a server through a particular invite link, effectively preventing new users from joining via that invite. it's particularly useful for managing server access, removing expired or unwanted invites, or controlling the number of active invites. the deletion is permanent and cannot be undone, so use this endpoint cautiously. it does not affect users who have already joined the server using this invite.
</Accordion>

<Accordion title="Retrieve stage instance by channel id">
  Retrieves detailed information about a specific stage instance in a discord server. this endpoint allows you to fetch the current state and configuration of a stage instance associated with a particular channel. use this when you need to access up-to-date information about an ongoing stage event, such as its topic, privacy level, or discovery status. the endpoint is particularly useful for applications that need to monitor or manage stage events programmatically. note that this endpoint only provides information about existing stage instances and cannot be used to create, modify, or delete them.
</Accordion>

<Accordion title="Retrieve pinned messages in channel">
  Retrieves all pinned messages from a specified discord channel. this endpoint is used to fetch important messages that have been pinned by users or moderators for easy reference. it's particularly useful for accessing key information, announcements, or rules that are prominently displayed in a channel. the endpoint returns an array of message objects representing the pinned content, allowing developers to display or process these highlighted messages within their applications. use this endpoint when you need to access or display the most crucial information from a discord channel. note that the number of pinned messages is limited per channel, and this endpoint will only return currently pinned messages, not a historical record of previously pinned content.
</Accordion>

<Accordion title="Get guild audit logs by guild id">
  Retrieves the audit logs for a specified discord guild (server). this endpoint allows you to fetch a list of recent actions performed within the guild, such as message deletions, member kicks, bans, or role changes. it's essential for server moderation, tracking administrative actions, and maintaining accountability within a discord community. the endpoint requires the 'view audit log' permission and should be used when detailed information about recent guild actions is needed. it does not provide real-time updates; for live monitoring, consider using the 'guildauditlogentrycreate' gateway event instead.
</Accordion>

<Accordion title="Update user application role connection">
  Updates the role connection metadata for a discord user's external platform integration with a specific application. this endpoint allows you to set or modify the platform name, username, and custom metadata associated with the integration. use this when you need to update the user's role connection information after changes in their external platform status or to sync data between the platforms. it's particularly useful for applications that manage user roles based on their activity or status on external platforms.
</Accordion>

<Accordion title="Get application guild command permissions">
  Retrieves the permissions for application commands in a specific guild (server). this endpoint allows developers to fetch the current permission settings for all application commands associated with their application in a particular guild. it's useful for auditing or verifying the current state of command permissions before making changes or troubleshooting access issues. the endpoint returns a list of permissions, likely including details such as which roles or users have access to each command. this tool should be used when you need to check the existing permissions for your application's commands in a guild, but it cannot be used to modify these permissions directly. note that the response will only include permissions for commands that have been explicitly set at the guild level, not global permissions or default settings.
</Accordion>

<Accordion title="Retrieve guild stickers">
  Retrieves a list of all custom stickers for a specific discord guild (server). this endpoint allows developers to fetch detailed information about the stickers available in a particular guild, including their names, descriptions, tags, and image data. it's useful for applications that need to display or manage guild-specific stickers, such as sticker browsers or management tools. the endpoint returns only the stickers created for the specified guild and does not include global discord stickers. use this when you need to list, display, or check the availability of custom stickers within a guild. note that this endpoint does not create, modify, or delete stickers; it's purely for retrieval purposes.
</Accordion>

<Accordion title="Get private archived threads for user">
  Retrieves a list of archived private threads in a specific channel that the current user has participated in. this endpoint is useful for accessing historical private conversations within a discord server. it should be used when a user needs to review or reference past private discussions that are no longer active. the endpoint only returns threads that the user was a part of and does not provide access to other users' private threads. note that this endpoint specifically targets archived threads, meaning it won't return active or unarchived private threads.
</Accordion>

<Accordion title="List guild bans">
  Retrieves a list of banned users for a specified discord guild (server). this endpoint allows server administrators or authorized bots to fetch information about all users who have been banned from the guild. it's useful for reviewing moderation actions, auditing ban lists, or implementing custom moderation tools. the endpoint returns details about each banned user, likely including their user id, username, and the reason for the ban if provided. use this endpoint when you need to review or manage the ban list for a guild, but note that it requires appropriate permissions to access this sensitive information.
</Accordion>

<Accordion title="Get guild templates by guild id">
  Retrieves a list of all guild templates associated with a specific discord guild (server). this endpoint allows developers to fetch pre-configured server setups that can be used to create new guilds quickly. it's particularly useful for retrieving templates created by guild administrators to standardize new server creation or to offer as starting points for community expansion. the endpoint returns all templates for the specified guild, providing details such as template code, name, description, and usage statistics. use this when you need to display available templates for a guild or before creating a new guild based on a template. note that this endpoint only retrieves templates; it does not create or modify them.
</Accordion>

<Accordion title="Retrieve users for scheduled event">
  Retrieves users interested in a specific scheduled event within a discord guild. useful for event organizers to track attendance and engagement. supports pagination and optional inclusion of guild member data. requires guild id and event id. may need permissions and be subject to rate limits.
</Accordion>

<Accordion title="Retrieve guild emojis">
  Retrieves a list of emoji objects for the specified guild (server) in discord. this endpoint allows developers to access all custom emojis that have been uploaded to a particular guild. it's useful for applications that need to display or manage guild-specific emojis, such as emoji pickers or moderation tools. the endpoint returns both static and animated emojis associated with the guild. note that this endpoint only provides information about custom emojis and does not include standard unicode emojis or those from discord nitro.
</Accordion>

<Accordion title="Get archived private threads by channel id">
  Retrieves a list of archived private threads within a specified discord channel. this endpoint is used to access private conversations that have been moved to an archived state, making them less prominent but still accessible. it's particularly useful for managing and reviewing past discussions in community servers or team collaborations. the endpoint returns archived private threads sorted by their archive timestamp in descending order, providing the most recently archived threads first. use this when you need to access historical private conversations or when implementing thread management features in your discord integration. note that this endpoint only retrieves private threads, not public ones, and access is restricted to users with appropriate permissions in the channel.
</Accordion>

<Accordion title="Retrieve guild scheduled events">
  Retrieves a list of scheduled events for a specific discord guild (server). this endpoint allows developers to fetch information about upcoming or ongoing events within a server, which can include activities like voice channel meetings, external events, or any other scheduled community gatherings. it's particularly useful for applications that need to display or manage server events, create event reminders, or analyze community engagement. the endpoint returns details such as event names, descriptions, start times, and other relevant information. it should be used when you need to present users with an overview of a guild's planned activities or integrate event management features into your discord-related application. note that this endpoint only provides information about events that have been scheduled through discord's event system and may not include informal or externally managed events.
</Accordion>

<Accordion title="Retrieve guild channels">
  Retrieves a list of all channels within a specified discord guild (server). this endpoint allows developers to fetch comprehensive information about the structure and organization of a guild's communication channels. it should be used when an application needs to display, analyze, or manage the channel layout of a particular guild. the endpoint returns details for all channel types, including text, voice, and category channels, providing a complete overview of the guild's communication setup. note that this endpoint does not return the content of the channels, only their structural information. the user must have the necessary permissions to view the channels in the specified guild.
</Accordion>

<Accordion title="Patch command for application">
  Modifies an existing application command for a discord bot. this endpoint allows you to update various properties of a command, including its name, description, options, and permissions. use this when you need to change the behavior or appearance of an existing command without creating a new one. the endpoint requires the application id and command id to identify the specific command to be edited. you can update the command's name, description, options (parameters), default member permissions, and dm availability. this is particularly useful for refining command functionality, fixing errors, or adapting to new features without disrupting the user experience. note that some properties, like the command type, cannot be changed after creation. always ensure that the updated command adheres to discord's guidelines and doesn't introduce breaking changes for existing users.
</Accordion>

<Accordion title="Fetch guild commands via application id">
  Retrieves a list of all commands registered for a specific application within a particular discord guild. this endpoint is used to fetch the available slash commands, context menu commands, or any other type of application command that has been set up for the application in the specified guild. it's particularly useful for developers who need to manage, update, or simply view the current set of commands their application offers in a guild. the endpoint should be used when you need to audit your application's commands, prepare for updates, or troubleshoot command-related issues. it does not provide information about command permissions or usage statistics; it only returns the command definitions themselves.
</Accordion>

<Accordion title="Update application guild command">
  This endpoint allows you to edit an existing discord application command within a specific guild. it provides the ability to modify various aspects of the command, including its name, description, options, and permissions. use this endpoint to update or refine a guild-specific command's functionality, localization, or access controls. be cautious about making drastic changes to existing commands, as it may confuse users familiar with the previous version.
</Accordion>

<Accordion title="Update discord message with webhook">
  Edits a previously sent webhook message. this endpoint allows you to update various aspects of an existing message, including its content, embeds, components, and attachments. it's particularly useful for updating dynamic content or interactive elements in a discord channel without sending a new message. the endpoint supports partial updates, meaning you only need to include the fields you want to modify. unchanged fields will retain their current values. note that this endpoint can only edit messages originally sent by the same webhook, and it cannot be used to edit messages sent by users or bots.
</Accordion>

<Accordion title="Update webhook name and avatar">
  Updates an existing discord webhook by modifying its name and/or avatar. this endpoint allows you to customize the appearance of a webhook without changing its functionality or destination. use this when you need to rebrand a webhook or update its visual representation within discord channels. the endpoint requires the webhook's unique id and token for authentication and targeting. you can update the name, the avatar, or both in a single request. note that this operation only modifies the specified fields and does not affect other properties or the webhook's configured destination.
</Accordion>


# Discordbot
Source: https://docs.push.ai/integrations/discordbot



Discordbot refers to automated programs on Discord servers, performing tasks like moderation, music playback, and user engagement to enhance community interactions

<Accordion title="Create guild auto moderation rule">
  This endpoint creates a new auto moderation rule for a specific discord guild. it allows server administrators to set up automated content moderation based on various triggers and actions. the rule can be configured to respond to different types of events, such as message sending or member updates, and can perform actions like blocking messages, flagging content, or temporarily disabling user communication. this tool is essential for maintaining a safe and controlled environment within a discord server by automatically enforcing community guidelines and moderating user-generated content.
</Accordion>

<Accordion title="Add reaction to message">
  Adds a reaction to a specific message in a discord channel. this endpoint allows users or bots to add an emoji reaction to a particular message, identified by its channel and message ids. it's commonly used to provide quick feedback, show agreement, or participate in polls within discord conversations. the reaction is added on behalf of the authenticated user or bot (indicated by '@me' in the endpoint). this tool should be used when you want to programmatically add reactions to messages, such as for automated responses or interactive bot features. it's important to note that this endpoint only adds the reaction and does not provide any information about existing reactions on the message.
</Accordion>

<Accordion title="Delete application command">
  Deletes a specific command from a discord application. this endpoint is used to permanently remove a command that is no longer needed or has become obsolete. it's particularly useful for maintaining a clean and relevant set of commands for your discord bot or application. the deletion is irreversible, so use this endpoint with caution. it should be called when you want to completely remove a command's functionality from your application, such as during updates or when phasing out features. this operation does not affect other commands or the application's overall functionality.
</Accordion>

<Accordion title="Delete channel message reaction by emoji">
  Removes a specific emoji reaction from a message in a discord channel. this endpoint allows for precise control over message reactions, enabling the deletion of a particular emoji reaction associated with a specific message. it should be used when you need to programmatically remove reactions, such as for moderation purposes or managing bot-added reactions. the endpoint is particularly useful for cleaning up reactions or removing inappropriate content. note that this operation is irreversible, and you must have the necessary permissions in the discord server to remove reactions.
</Accordion>

<Accordion title="Create channel invite">
  Creates a new invite for a specific discord channel. this endpoint allows you to generate customizable invite links that can be used to add new members to a server through the specified channel. the invite can be configured with various parameters to control its behavior, such as expiration time, usage limits, and special targets like streams or embedded applications. use this endpoint when you need to programmatically create invites for automated user onboarding, event management, or integration with external systems. note that some parameters may require elevated permissions, and the effectiveness of certain options (like temporary membership) depends on the server's settings and the invitee's roles.
</Accordion>

<Accordion title="Create guild sticker">
  Creates a new custom sticker for a specific discord guild. this endpoint allows guild administrators or users with appropriate permissions to upload and add new stickers to their guild's collection. the sticker can be used by members in chat messages to express emotions or add visual flair. use this endpoint when you want to programmatically add new stickers to a guild, such as for custom integrations or automated sticker management systems. note that there are limits on the number of stickers a guild can have based on various factors like boost level.
</Accordion>

<Accordion title="Create guild emoji">
  Creates a new custom emoji for a specific discord guild (server). this endpoint allows you to upload an image and set a name for the emoji, which can then be used within the guild's text channels and reactions. optionally, you can restrict the emoji's usage to specific roles. use this when you want to add new custom emojis to enrich communication within your discord community. the created emoji will be immediately available for use after successful creation. note that guilds have limits on the number of custom emojis they can have, which depends on the guild's boost level. ensure that your application handles potential rate limits or emoji limit errors gracefully.
</Accordion>

<Accordion title="Initiate user channel with recipient">
  Creates a new direct message channel or retrieves an existing one between the authenticated user and specified recipient(s). this endpoint is used to initiate private conversations or group chats on discord. it supports creating one-on-one dms by providing a single recipient id, or group dms by using access tokens for multiple recipients. the endpoint also allows setting custom nicknames for users in the channel. use this when a user wants to start a new conversation or access an existing dm channel. note that this endpoint doesn't send a message; it only creates or retrieves the channel object.
</Accordion>

<Accordion title="Create guild scheduled event">
  Creates a new scheduled event in a discord guild. this endpoint allows you to set up various types of events, including external events, stage instances, and voice events. the created event will be visible to guild members and can include details such as name, description, start and end times, and location (for external events). use this endpoint when you want to programmatically create and manage events for your discord community. the event's visibility is limited to guild members only, and the structure of the request varies based on the type of event being created.
</Accordion>

<Accordion title="Create role with guild id">
  Creates a new role within a specified discord guild (server). this endpoint allows for the customization of various role properties, including name, permissions, color, and display options. it's particularly useful for programmatically managing server structures, implementing role-based access control, or creating specialized roles for events or categories. the created role can be assigned to users to grant them specific permissions and visual distinctions within the guild. note that while all parameters are optional, providing values for key properties like name and permissions is recommended for immediate role utility. be mindful of permission settings to maintain server security.
</Accordion>

<Accordion title="Delete guild auto moderation rule">
  Deletes a specific auto-moderation rule from a discord guild (server). this endpoint should be used when you want to permanently remove an existing auto-moderation rule from a guild's settings. it's particularly useful for updating a guild's moderation strategy or removing outdated or unnecessary rules. the deletion is irreversible, so it should be used with caution. this endpoint only deletes the rule; it does not provide information about the rule before deletion or allow for retrieving deleted rules.
</Accordion>

<Accordion title="Post guild template by code">
  Creates a new discord guild (server) based on a pre-existing template. this endpoint allows you to quickly set up a new community with predefined channels, roles, and settings. it's particularly useful for creating standardized guild structures or for users who want to replicate successful community setups. the template is identified by its unique code, which must be included in the endpoint url. you must provide a name for the new guild, and you have the option to set a custom icon. this tool should be used when a user wants to create a new discord server with a specific structure in mind, rather than starting from scratch. it's important to note that while the template provides initial setup, further customization may be needed to fully tailor the guild to specific needs.
</Accordion>

<Accordion title="Delete channel permission override">
  Deletes a specific permission overwrite for a discord channel. this endpoint is used to remove custom permissions that have been set for a particular user or role within a channel. it's particularly useful when you want to reset a user's or role's permissions to the default channel or category permissions. the operation is irreversible, so it should be used with caution. this tool doesn't return the deleted overwrite data; it simply removes the specified overwrite. it's important to note that this action may immediately affect the target user's or role's ability to interact with the channel, depending on the overwrite that was removed.
</Accordion>

<Accordion title="Add or update thread member">
  Adds a user to a thread within a specified discord channel. this endpoint is used to include a user in an existing thread, allowing them to participate in the discussion. it should be used when you want to bring a user into a thread conversation, either to involve them in an ongoing discussion or to grant them access to a private thread. the endpoint is particularly useful for managing thread membership programmatically, such as when implementing custom thread management features or automating user inclusion in relevant discussions. note that this action may be subject to permission checks, and the user being added must have access to the parent channel.
</Accordion>

<Accordion title="Delete channel by id">
  Deletes a specific channel from a discord server. this endpoint permanently removes the channel and all its associated content, including messages, pins, and any other data. it should be used with caution as the action is irreversible. this operation is typically performed for channel management, such as removing obsolete or unwanted channels from a server. the endpoint requires appropriate permissions to execute, and it's crucial to verify the correct channel id before deletion to avoid unintended data loss. note that this action may affect server organization and user access to information previously contained in the deleted channel.
</Accordion>

<Accordion title="Delete channel recipient">
  Removes a user (recipient) from a specific discord channel. this endpoint is used to manage channel membership by removing individual users. it's particularly useful for administrative purposes, such as removing inactive members or managing private channel access. the operation is irreversible and will immediately revoke the user's access to the channel. this endpoint should be used cautiously, as it affects user access and channel composition. it does not provide any feedback on the success of the operation, so additional verification may be necessary after calling this endpoint.
</Accordion>

<Accordion title="Modify guild ban settings">
  This endpoint bans a specified user from a discord guild (server) and optionally deletes their recent messages. it allows moderators to remove problematic users and clean up their content in one action. the ban is permanent until manually lifted. use this endpoint when you need to immediately remove a user's access to a guild and optionally purge their recent message history. it's particularly useful for handling severe rule violations or spam incidents. note that this action requires appropriate permissions and should be used judiciously as it significantly impacts the targeted user's ability to interact with the guild.
</Accordion>

<Accordion title="Delete guild by id">
  Deletes a guild (server) from discord permanently. this endpoint should be used with extreme caution as it will remove all data associated with the guild, including channels, roles, and messages. it is an irreversible action that can only be performed by the guild owner. this operation is typically used when a community needs to be completely shut down or when cleaning up test servers. it should not be used for temporary removals or as a moderation tool. be aware that this action cannot be undone, and all guild data will be lost upon deletion.
</Accordion>

<Accordion title="Bulk ban users in guild with message deletion option">
  The bulkbanusers endpoint allows server administrators to ban multiple users from a discord guild (server) simultaneously. this powerful moderation tool is designed for efficiently managing large-scale infractions or cleaning up a server from unwanted users. it can ban up to 200 users in a single request and optionally delete their recent messages. this endpoint should be used when there's a need to remove multiple problematic users quickly, such as during a raid or when cleaning up after a spam attack. it's important to note that this action is irreversible and should be used with caution. the endpoint doesn't provide information about the success of individual bans within the bulk request.
</Accordion>

<Accordion title="Delete guild emoji by id">
  Deletes a custom emoji from a specified discord guild (server). this endpoint is used to permanently remove a custom emoji, freeing up space for new emojis if the guild has reached its emoji limit. it should be used when server administrators or users with the manage guild expressions permission want to remove outdated or unwanted custom emojis. the operation is irreversible, so caution should be exercised when using this endpoint. note that this endpoint cannot be used to delete default discord emojis or emojis from other servers.
</Accordion>

<Accordion title="Create guild template">
  Creates a new guild template for the specified discord guild. this endpoint allows users to create a snapshot of the current guild's settings, roles, and channels, which can be used as a blueprint for creating new guilds quickly. the template includes the guild's structure but not its content. use this when you want to save the current guild configuration for future use or to share with others for easy replication of your guild setup. the created template can be accessed and managed using other template-related endpoints.
</Accordion>

<Accordion title="Delete guild command">
  Deletes a specific application command from a discord guild (server). this endpoint is used to remove a previously registered slash command, user command, or message command associated with your application in a particular guild. it's particularly useful for managing your application's command list, especially when you want to remove outdated or unnecessary commands. the deletion is permanent and cannot be undone, so use this endpoint with caution. this operation helps in maintaining a clean and relevant set of commands for your discord bot or application within a specific server.
</Accordion>

<Accordion title="Delete guild integration">
  Deletes a specific integration from a discord guild. this endpoint is used to remove an external service or bot integration that has been previously added to the server. it should be used when an integration is no longer needed or causing issues within the guild. the deletion is permanent and cannot be undone, so it should be used with caution. this operation requires appropriate permissions within the guild to manage integrations.
</Accordion>

<Accordion title="Delete guild member role">
  Removes a specific role from a guild member in discord. this endpoint is used to modify a user's roles within a server, specifically by removing a designated role. it's particularly useful for managing permissions and access levels within a guild. the operation is performed by specifying the guild id, user id, and role id in the url path. this tool should be used when you need to revoke certain privileges or change a member's status within a guild. it's important to note that this action is immediate and irreversible through this call alone - to undo it, you would need to add the role back using a separate api call. the endpoint doesn't return the updated member object, so if you need to confirm the new role configuration, you'll need to fetch the member's details separately after this operation.
</Accordion>

<Accordion title="Delete channel message">
  Deletes a specific message from a discord channel. this endpoint should be used when you need to remove a particular message, either for moderation purposes or to clean up outdated information. it's important to note that this action is irreversible, and once a message is deleted, it cannot be recovered. the endpoint requires both the channel id and the message id to accurately target the specific message for deletion. use this endpoint with caution, as it permanently removes content from the conversation history.
</Accordion>

<Accordion title="Delete guild member by id">
  Removes a member from a specified discord guild (server). this endpoint allows you to programmatically kick a user from a server, effectively ending their membership. it should be used when you need to remove a user from a guild, either for moderation purposes or as part of automated server management. this action is permanent and will require the user to be re-invited if they wish to rejoin the guild. note that this endpoint requires appropriate permissions to execute, typically reserved for guild administrators or bots with member management capabilities. the operation is immediate and cannot be undone through the api.
</Accordion>

<Accordion title="Delete guild scheduled event">
  Deletes a specific scheduled event from a discord guild. this endpoint should be used when you want to permanently remove a scheduled event from a guild's calendar. it requires the guild id and the scheduled event id to precisely target the event for deletion. this action is irreversible, so it should be used with caution. the endpoint is particularly useful for cleaning up past events, canceling upcoming events, or managing the guild's event list. note that this operation likely requires appropriate permissions within the guild to execute successfully.
</Accordion>

<Accordion title="Delete role from guild">
  Deletes a specific role from a discord guild. this endpoint permanently removes the role identified by the role id from the guild specified by the guild id. it should be used when you need to completely remove a role from a guild's hierarchy, including all associated permissions and assignments. this action is irreversible, so it should be used with caution. the endpoint is particularly useful for cleaning up outdated roles or restructuring a guild's permission system. it does not provide any information about the deleted role or affect other roles in the guild.
</Accordion>

<Accordion title="Post interaction callback">
  This endpoint allows you to send a response to a discord interaction. it's used to reply to various types of interactions, such as slash commands, message components, or modals. the response can be immediate or deferred, and can include messages, embeds, components, or modals. use this endpoint when you need to acknowledge an interaction or provide a response to user input. it's particularly useful for creating interactive bot experiences, handling command inputs, or updating messages based on user actions. the endpoint is versatile, supporting different response types, but it's important to match the response type with the interaction context. for example, you can't respond with a modal to a message component interaction. also, note that some response types have time limits (e.g., initial responses must be sent within 3 seconds) and content restrictions (e.g., message length limits).
</Accordion>

<Accordion title="Bulk delete messages in channel">
  The bulkdeletemessages endpoint allows for the deletion of multiple messages simultaneously within a specified discord channel. this endpoint is particularly useful for cleaning up large amounts of messages efficiently, such as during moderation tasks or channel maintenance. it should be used when you need to remove multiple messages at once, saving time compared to deleting messages individually. the endpoint requires a minimum of 2 and a maximum of 100 unique message ids to be provided. it's important to note that this operation may not be immediate, and the api will return a successful response even if the deletion is still in progress. be cautious when using this endpoint, as deleted messages cannot be recovered. this bulk delete function is limited to messages that are less than two weeks old. for deleting older messages, you'll need to use individual delete requests for each message.
</Accordion>

<Accordion title="Create thread in message channel">
  Creates a new thread from an existing message in a discord channel. this endpoint allows you to start a focused discussion based on a specific message, organizing conversations within busy channels. the new thread will be associated with the original message and appear in the channel's thread list. use this when you want to branch off a conversation from the main channel into a more specific topic. the thread can have its own set of permissions, auto-archive duration, and rate limiting. note that you must have the necessary permissions in the channel to create a thread, and the original message must still be visible in the channel.
</Accordion>

<Accordion title="Delete guild sticker">
  Deletes a specific sticker from a discord guild (server). this endpoint allows guild administrators or users with the appropriate permissions to permanently remove a custom sticker from their server. use this when you want to delete outdated, inappropriate, or unused stickers from your guild. once deleted, the sticker cannot be recovered and will no longer be available for use in the guild. this operation is irreversible, so it should be used with caution. the endpoint requires both the guild id and the sticker id to ensure precise removal of the intended sticker.
</Accordion>

<Accordion title="Delete user reaction from message">
  Removes a specific user's reaction from a message in a discord channel. this endpoint is used to programmatically delete a single emoji reaction made by a particular user on a given message. it's useful for moderation purposes, cleaning up reactions, or managing user interactions within a discord bot or application. the operation is idempotent, meaning repeated calls with the same parameters will not cause errors or additional side effects if the reaction has already been removed.
</Accordion>

<Accordion title="Delete channel thread member">
  Removes a specified user from a thread within a discord channel. this endpoint is used to manage thread membership by forcibly removing a user from the thread conversation. it should be used when a user needs to be excluded from a thread, such as for moderation purposes or when their participation is no longer required. the endpoint does not provide any information about the removed user or the thread status after the operation. it's important to note that this action may have implications on the user's ability to view or participate in the thread, depending on the channel and thread settings.
</Accordion>

<Accordion title="Delete stage instance by channel id">
  Deletes an existing stage instance associated with a specific channel in a discord server. this endpoint is used to end and remove a live stage, effectively concluding the audio event or activity. it should be called when you want to terminate a stage instance, such as when an event has concluded or needs to be canceled. the deletion is permanent and cannot be undone, so use this endpoint with caution. this tool is particularly useful for automating the lifecycle management of stage events in discord servers.
</Accordion>

<Accordion title="Delete user reaction on message">
  Removes the authenticated user's reaction (emoji) from a specific message in a discord channel. this endpoint is used when a user wants to undo their reaction to a message. it's particularly useful in situations where a user wants to change their reaction or remove it entirely. the endpoint only affects the authenticated user's own reaction and cannot be used to remove other users' reactions. it's important to note that this action is irreversible, and once a reaction is removed, it cannot be automatically restored - the user would need to add the reaction again if desired.
</Accordion>

<Accordion title="Delete original webhook message">
  Deletes the original message sent by a specific webhook in a discord channel. this endpoint is used to remove the initial content posted by a webhook, which can be useful for cleaning up outdated information or correcting errors in automated messages. it specifically targets the first message sent by the webhook, not any subsequent edits or additional messages. this operation is permanent and cannot be undone, so it should be used with caution. the endpoint requires both the webhook id and token for authentication and to precisely identify the message to be deleted.
</Accordion>

<Accordion title="Post message to channel">
  This endpoint allows you to create and send a new message in a specified discord channel. it supports various content types including plain text, rich embeds, interactive components, stickers, and file attachments. the message can be customized with allowed mentions, flags, and text-to-speech options. it's primarily used for sending messages programmatically, such as bot responses or automated notifications. the endpoint is versatile, allowing for simple text messages or complex, interactive content with multiple embeds and components. however, it's important to note the various limitations on content length, number of embeds, and attachments to ensure the message adheres to discord's guidelines.
</Accordion>

<Accordion title="Create stage instance">
  Creates a new stage instance in a discord server. this endpoint allows you to set up a stage for live audio conversations or presentations within a specified channel. use this when you want to initiate a structured audio event, such as a q\&a session, panel discussion, or live performance. the stage instance can be customized with a topic, privacy settings, and optional association with a scheduled event. it's particularly useful for managing large-scale audio events in discord communities. note that this endpoint requires appropriate permissions in the server where the stage instance is being created.
</Accordion>

<Accordion title="Delete webhook using id and token">
  Deletes a specific discord webhook using its unique identifier and associated token. this endpoint permanently removes the webhook from the discord system, preventing any further messages from being sent through it. use this endpoint when you no longer need the webhook, such as when decommissioning integrations or cleaning up unused resources. once deleted, the webhook cannot be recovered, and any attempts to use the deleted webhook's url will fail. this operation is irreversible, so ensure you have the correct webhook id and token before proceeding with the deletion.
</Accordion>

<Accordion title="Delete webhook by id">
  Deletes a specific discord webhook using its unique identifier. this endpoint permanently removes the webhook, terminating any integrations or automated messages associated with it. use this when you want to discontinue a webhook's functionality or clean up unused webhooks. it's important to note that this action is irreversible, and once deleted, the webhook cannot be recovered. this endpoint should be used cautiously, ensuring that the webhook is no longer needed before deletion.
</Accordion>

<Accordion title="Delete webhook message">
  Deletes a specific message that was previously sent through a discord webhook. this endpoint allows for the removal of individual messages from a channel, providing control over content posted via webhooks. it should be used when you need to remove or retract a message sent by your application through a webhook, such as correcting mistakes or removing outdated information. the operation is permanent and cannot be undone, so use it cautiously. note that this endpoint can only delete messages sent by the webhook itself, not messages from other users or bots.
</Accordion>

<Accordion title="Create new thread in channel">
  Creates a new thread within a specified discord channel. this endpoint allows for the creation of various thread types (public, private, or announcement) with customizable settings such as auto-archive duration, rate limits, and initial messages. it's particularly useful for organizing discussions, creating focused conversation spaces, or starting new topics within a channel. the thread can be initialized with a rich message including embeds, components, and attachments. use this endpoint when you need to programmatically create new discussion threads or topic-specific conversations in a discord server.
</Accordion>

<Accordion title="Create guild channel">
  Creates a new channel within a specified discord guild (server). this endpoint allows for the creation of various channel types, including text channels, voice channels, categories, announcement channels, stage channels, directory channels, and forum channels. it provides extensive customization options for each channel type, such as setting permissions, configuring voice settings, and defining forum-specific parameters. use this endpoint when you need to programmatically add new channels to a guild, organize existing channels, or set up specialized channels like forums or announcement channels. note that the creation of channels is subject to the permissions of the authenticated user in the guild, and some options may only be applicable to specific channel types.
</Accordion>

<Accordion title="Create new guild object">
  Creates a new guild (server) in discord with customizable settings. this endpoint allows you to set up a guild with specific roles, channels, moderation settings, and other configurations. use this when you need to programmatically create a new community or workspace within discord. the created guild will be owned by the authenticated user. note that while many parameters are optional, providing more details will result in a more complete and ready-to-use guild structure. be aware of rate limits and the maximum number of guilds a user can create, which may vary based on account type and status.
</Accordion>

<Accordion title="Github action webhooks processing">
  This endpoint executes a github webhook, processing various github events and sending corresponding notifications to a discord channel. it serves as a bridge between github and discord, allowing real-time updates about repository activities to be relayed to discord users. the webhook can handle a wide range of github events, including but not limited to pushes, pull requests, issues, comments, and releases. the endpoint should be used when you want to set up automated notifications in discord for github repository events. it's particularly useful for development teams who want to stay informed about project updates, code reviews, and discussions without leaving their discord environment. while this webhook provides comprehensive event data, it's important to note that it doesn't allow for direct interaction with github from discord. it's a one-way communication channel from github to discord. additionally, the webhook payload has a maximum size limit, which might affect extremely large events or comments.
</Accordion>

<Accordion title="Delete guild template by code">
  Deletes a specific guild template from a discord server. this endpoint is used to permanently remove a template that is no longer needed or has become outdated. it's particularly useful for server administrators who want to manage their template inventory, ensuring only relevant and up-to-date templates are available. the deletion is irreversible, so it should be used with caution. this tool doesn't provide any confirmation or return the deleted template's details, it simply removes the specified template from the system.
</Accordion>

<Accordion title="Update guild member information">
  This endpoint allows you to add a new member to a discord guild (server) or update an existing member's information. it provides functionality to set or modify a member's nickname, role assignments, voice channel status (mute/deaf), and other flags within the guild. this tool should be used when you need to programmatically add users to a guild or update their guild-specific properties. it's particularly useful for automating member management tasks or integrating discord guild operations into external applications. note that this endpoint requires proper authorization and an oauth2 access token for the user being added or modified. be aware that some changes, like role assignments, may have significant impacts on the member's permissions within the guild.
</Accordion>

<Accordion title="Create channel webhook">
  Creates a new webhook for a specified discord channel. this endpoint allows you to set up an automated way to send messages to a discord channel from external applications or services. the webhook can be customized with a name and an optional avatar. use this endpoint when you need to integrate external services with discord or automate message posting to a specific channel. the created webhook will provide a unique url that can be used to send messages to the channel without requiring a bot token. note that webhook creation is subject to discord's rate limits and server permissions, so ensure you have the necessary rights to create webhooks in the specified channel.
</Accordion>

<Accordion title="Assign role to guild member">
  Adds a specific role to a member within a discord guild (server). this endpoint is used to assign additional permissions or status to a user by giving them a predefined role. it's particularly useful for automated role management, such as assigning roles based on user actions or time spent in the server. the operation requires the guild id, user id, and role id to be specified in the url path. this endpoint should be used when you need to programmatically update a user's roles without manual intervention. note that the user must already be a member of the guild, and the role must exist within the guild for the operation to succeed. the endpoint doesn't return the updated member object, so you may need to fetch the member's information separately to confirm the role addition.
</Accordion>

<Accordion title="Add recipient to group channel">
  Adds a recipient (user) to a discord channel, specifically designed for managing group direct messages (dms). this endpoint allows you to include a new user in an existing group dm or potentially add a user to other types of channels. it requires the channel id and user id to be specified in the path, with optional parameters for user authentication and nickname customization. use this endpoint when you need to programmatically add users to group conversations or channels in discord applications.
</Accordion>

<Accordion title="Crosspost channel message">
  Crossposts a message to all channels that have been set up to receive announcements from the source channel. this endpoint allows you to publish a message from an announcement channel to its followers, effectively distributing the content to multiple channels simultaneously. it should be used when you want to broadcast important information, updates, or announcements to a wider audience across different servers or channels. this operation is typically restricted to messages in announcement channels and requires appropriate permissions. note that a message can only be crossposted once, and attempting to crosspost an already crossposted message will result in an error.
</Accordion>

<Accordion title="Delete reaction from message">
  Deletes all reactions from a specific message in a discord channel. this endpoint removes every emoji reaction that has been added to the message, effectively clearing its reaction list. it should be used when you want to remove all user interactions in the form of emoji reactions from a particular message. this action is useful for moderation purposes or when refreshing the state of a message. the endpoint requires 'manage messages' permission and affects all users' reactions, not just the bot's. it does not delete the message itself, only the associated reactions.
</Accordion>

<Accordion title="Create new guild object">
  Creates a new guild (server) in discord with customizable settings. this endpoint allows you to set up a guild with specific roles, channels, moderation settings, and other configurations. use this when you need to programmatically create a new community or workspace within discord. the created guild will be owned by the authenticated user. note that while many parameters are optional, providing more details will result in a more complete and ready-to-use guild structure. be aware of rate limits and the maximum number of guilds a user can create, which may vary based on account type and status.\<\<DEPRECATED use create\_guild>>
</Accordion>

<Accordion title="Create guild application command">
  This endpoint creates a new application command for a specific guild (server) in discord. it allows developers to define custom slash commands, user commands, or message commands that can be used within the specified guild. the command can have various options, including subcommands and arguments, with support for different data types and localization. use this endpoint when you want to add new interactive functionality to your discord bot or application within a particular server. note that created commands will be available immediately, but may take up to an hour to be displayed to users due to caching. the endpoint is subject to rate limits, and there's a maximum of 100 application commands per guild.
</Accordion>

<Accordion title="Create application command objects">
  Creates a new global command for a discord application. this endpoint allows developers to define custom slash commands or context menu commands that users can interact with. the created command will be available in all guilds the application has the `applications.commands` scope authorized, as well as in dms. use this to expand your application's functionality by adding new ways for users to interact with your bot or app. be mindful of rate limits and the global command limit per application. after creation, it may take up to an hour for commands to be available to users.
</Accordion>

<Accordion title="Retrieve guild command permissions">
  Retrieves the permissions configured for a specific application command within a discord guild. this endpoint allows developers to check which roles or users have permission to use a particular command in a given server. it's useful for auditing command access, troubleshooting permission issues, or verifying that command restrictions are properly set up. the endpoint returns detailed permission information, which may include allowed and disallowed roles or users for the specified command. this tool should be used when you need to inspect or validate the current permission settings for a command in a specific guild context. it does not modify permissions; it only provides read access to the existing configuration.
</Accordion>

<Accordion title="Delete invite via code">
  Deletes a specific invite from a discord server using its unique invite code. this endpoint should be used when you want to revoke access to a server through a particular invite link, effectively preventing new users from joining via that invite. it's particularly useful for managing server access, removing expired or unwanted invites, or controlling the number of active invites. the deletion is permanent and cannot be undone, so use this endpoint cautiously. it does not affect users who have already joined the server using this invite.
</Accordion>

<Accordion title="Get current user data">
  Retrieves detailed information about the currently authenticated user on discord. this endpoint should be used when an application needs to access the profile data of the user who has authorized the application. it returns comprehensive user information, including username, discriminator, avatar, email (if authorized), and other relevant account details. this endpoint is essential for personalizing user experiences within discord applications and should be called when initializing a user session or when up-to-date user information is required. note that the endpoint does not provide information about the user's guilds or relationships; separate endpoints exist for those purposes.
</Accordion>

<Accordion title="Retrieve message from channel">
  Retrieves a specific message from a discord channel. this endpoint allows you to fetch detailed information about a single message, including its content, author, timestamp, and any attachments or embeds. it's particularly useful for bot development, message logging, or implementing features that require analysis or manipulation of specific messages. the endpoint should be used when you need to access or verify the contents of a particular message within a channel. it does not provide information about other messages in the channel or modify the message in any way. note that you must have the necessary permissions to view the message in the specified channel.\<\<DEPRECATED use get\_message>>
</Accordion>

<Accordion title="Retrieve webhook information">
  Retrieves detailed information about a specific discord webhook. this endpoint allows you to fetch the current state and configuration of a webhook, including its name, avatar, channel id, and guild id. use this when you need to verify a webhook's settings or before making changes to ensure you have the most up-to-date information. the endpoint requires both the webhook's unique id and its associated token for authentication. it's important to note that this endpoint only provides information about the webhook itself and does not return any message history or usage statistics.
</Accordion>

<Accordion title="Add follower to channel via webhook">
  Adds a follower to a specific discord channel. this endpoint allows you to create a follower relationship between two channels, enabling content from one channel to be automatically shared with another. it's particularly useful for content creators or community managers who want to distribute updates across multiple channels or servers. the follower relationship is established using webhooks, which allows for real-time notifications and content sharing. this endpoint should be used when you want to expand the reach of a channel's content or create a network of interconnected channels. it's important to note that both channels must be within servers where the authenticated user has appropriate permissions. the endpoint doesn't provide information about existing followers or allow for bulk following operations.
</Accordion>

<Accordion title="Get oauth2 keys">
  Retrieves the oauth2 public keys used for verifying access tokens issued by discord. this endpoint is crucial for implementing secure token validation in applications that integrate with discord's oauth2 authentication system. it should be used when setting up or updating an application's authentication process to ensure proper verification of discord-issued tokens. the endpoint returns a set of public keys in json web key (jwk) format, which can be used to verify the signatures of discord's json web tokens (jwts). note that the keys may be rotated periodically, so applications should be prepared to handle multiple keys and update their key cache as needed.\<\<DEPRECATED use get\_public\_keys>>
</Accordion>

<Accordion title="Post to slack webhook">
  This endpoint allows you to send messages to a discord channel using a slack-compatible webhook format. it supports simple text messages as well as rich content with attachments, custom usernames, and icons. use this endpoint when you want to integrate external services or applications with discord, leveraging the familiar slack webhook format. it's particularly useful for sending notifications, updates, or formatted reports to a discord channel. the endpoint accepts various content types, including json, form-urlencoded, and multipart form data, providing flexibility in how you structure your requests. keep in mind the character limits for text fields and the maximum number of attachments to ensure your messages are delivered successfully.
</Accordion>

<Accordion title="Retrieve user by id">
  Retrieves detailed information about a specific discord user based on their unique user id. this endpoint allows developers to access public user data, which may include the user's username, avatar, account creation date, and other relevant information. it's particularly useful for applications that need to display user profiles, manage user interactions, or integrate discord user data into their services. the endpoint should be used when specific user details are required, but it will not provide information about the user's activities, messages, or server memberships. note that some user information may be limited based on privacy settings or if the user has restricted access to their profile.\<\<DEPRECATED use get\_user>>
</Accordion>

<Accordion title="Retrieve webhook message by id">
  Retrieves a specific message that was previously sent through a discord webhook. this endpoint allows developers to fetch the content and metadata of a single message using its unique identifier. it's particularly useful for verifying message delivery, auditing webhook activity, or retrieving specific information from past webhook interactions. the endpoint requires the webhook's id and token for authentication, ensuring that only authorized parties can access the message data. use this when you need to confirm the content of a sent message or when you want to review or process specific webhook messages programmatically.
</Accordion>

<Accordion title="Post webhook with embeds and components">
  This endpoint allows you to execute a discord webhook, enabling you to send messages, embeds, and interactive components to a specific discord channel. it's useful for integrating external services with discord, sending automated notifications, or creating custom bot-like interactions without a full bot implementation. the webhook can be customized with a username and avatar, and supports thread interactions. use this when you need to push information to discord channels programmatically, especially for notifications, updates, or interactive messages. note that webhook usage is subject to discord's rate limits, and the webhook url should be kept secure as it bypasses normal authentication.
</Accordion>

<Accordion title="Update thread membership">
  Adds the authenticated user to a thread within a specified discord channel. this endpoint should be used when a user wants to join a thread they are not currently a member of. it allows users to participate in thread discussions and receive notifications for that thread. the endpoint is particularly useful for joining archived threads or threads in channels where the user doesn't have automatic thread join permissions. note that this endpoint may fail if the thread is at maximum capacity or if the user doesn't have permission to join the thread. it's important to handle potential errors gracefully in your application.
</Accordion>

<Accordion title="Retrieve original webhook message">
  Retrieves the original message sent through a specific discord webhook. this endpoint is used to fetch the initial content and metadata of a message that was posted to a discord channel via a webhook. it's particularly useful for verifying the content of automated messages or for auditing purposes. the endpoint only returns data for the original message and cannot be used to retrieve subsequent edits or responses. use this when you need to review or confirm the exact content of a webhook-sent message in its original form.
</Accordion>

<Accordion title="Get current user data">
  Retrieves detailed information about the currently authenticated user on discord. this endpoint should be used when an application needs to access the profile data of the user who has authorized the application. it returns comprehensive user information, including username, discriminator, avatar, email (if authorized), and other relevant account details. this endpoint is essential for personalizing user experiences within discord applications and should be called when initializing a user session or when up-to-date user information is required. note that the endpoint does not provide information about the user's guilds or relationships; separate endpoints exist for those purposes.\<\<DEPRECATED use get\_my\_user>>
</Accordion>

<Accordion title="Retrieve guild user ban details">
  Retrieves detailed information about a specific ban for a user in a discord guild. this endpoint allows developers to fetch the ban status and related details for a particular user within a specific guild (server). it's useful for moderators and administrators to review ban information, such as the reason for the ban and when it was implemented. the endpoint should be used when there's a need to verify or inspect an existing ban, but it cannot be used to create, modify, or remove bans. it's important to note that this endpoint only provides information if the specified user is actually banned from the guild; if the user is not banned, it may return an error or an empty response.
</Accordion>

<Accordion title="Get oauth2 user information">
  Retrieves the authenticated user's profile information using discord's oauth2 system. this endpoint returns essential details about the user, such as their identity, associated guilds, and potentially other account-related information. it should be used when an application needs to access the current user's data after successful oauth2 authentication. the endpoint is particularly useful for personalization, user management, and integration of discord user data into third-party applications. note that the specific data returned may depend on the oauth2 scopes granted during the authentication process.\<\<DEPRECATED use get\_my\_oauth2\_authorization>>
</Accordion>

<Accordion title="Retrieve invite by code">
  Retrieves detailed information about a discord invite using its unique invite code. this endpoint allows developers to fetch data about an invite, including the associated guild (server), channel, and potentially additional details such as approximate member counts, online member counts, and expiration date. it's particularly useful when you need to validate an invite or display information about it before a user decides to join a server. the endpoint does not actually join the user to the server; it only provides information about the invite. keep in mind that some invite details may be limited based on the permissions of the requesting user or bot.
</Accordion>

<Accordion title="Delete user guild">
  Removes the authenticated user from a specified guild (server) on discord. this endpoint should be used when a user wants to voluntarily leave a guild they are currently a member of. it's important to note that this action is immediate and irreversible without a new invitation. the endpoint does not provide any additional functionality such as transferring ownership or managing other users. use this endpoint cautiously, as leaving a guild may result in loss of access to the guild's content, roles, and permissions. this action cannot be used to remove other users from a guild; it only affects the authenticated user.
</Accordion>

<Accordion title="Get guild audit logs by guild id">
  Retrieves the audit logs for a specified discord guild (server). this endpoint allows you to fetch a list of recent actions performed within the guild, such as message deletions, member kicks, bans, or role changes. it's essential for server moderation, tracking administrative actions, and maintaining accountability within a discord community. the endpoint requires the 'view audit log' permission and should be used when detailed information about recent guild actions is needed. it does not provide real-time updates; for live monitoring, consider using the 'guildauditlogentrycreate' gateway event instead.
</Accordion>

<Accordion title="Get application guild command permissions">
  Retrieves the permissions for application commands in a specific guild (server). this endpoint allows developers to fetch the current permission settings for all application commands associated with their application in a particular guild. it's useful for auditing or verifying the current state of command permissions before making changes or troubleshooting access issues. the endpoint returns a list of permissions, likely including details such as which roles or users have access to each command. this tool should be used when you need to check the existing permissions for your application's commands in a guild, but it cannot be used to modify these permissions directly. note that the response will only include permissions for commands that have been explicitly set at the guild level, not global permissions or default settings.
</Accordion>

<Accordion title="Remove current user from thread">
  Removes the current authenticated user from a specified thread in discord. this endpoint allows a user to leave a thread they are currently a member of, effectively unsubscribing them from further notifications and removing their ability to view or participate in the thread if it's private. it should be used when a user no longer wishes to be part of a specific thread conversation. this action is irreversible, but the user can rejoin the thread later if it's public or if they're re-added by a thread member with appropriate permissions. the endpoint doesn't provide any information about the thread or other members; it simply performs the leave action.
</Accordion>

<Accordion title="Get your applications">
  Retrieves detailed information about the current authenticated application. this endpoint allows developers to access various attributes and settings of their discord application or bot. it's particularly useful for self-inspection, verifying application details, or dynamically adjusting application behavior based on its current configuration. the endpoint returns comprehensive data about the application, which may include its name, description, icon, bot user information, and other relevant metadata. while specific return fields are not detailed in the schema, developers can expect a rich set of application-related information. this endpoint should be used when an application needs to introspect its own properties or verify its current state within the discord ecosystem.\<\<DEPRECATED use get\_my\_application>>
</Accordion>

<Accordion title="Get oauth2 keys">
  Retrieves the oauth2 public keys used for verifying access tokens issued by discord. this endpoint is crucial for implementing secure token validation in applications that integrate with discord's oauth2 authentication system. it should be used when setting up or updating an application's authentication process to ensure proper verification of discord-issued tokens. the endpoint returns a set of public keys in json web key (jwk) format, which can be used to verify the signatures of discord's json web tokens (jwts). note that the keys may be rotated periodically, so applications should be prepared to handle multiple keys and update their key cache as needed.
</Accordion>

<Accordion title="Fetch emoji by guild and id">
  Retrieves detailed information about a specific emoji from a discord guild (server). this endpoint allows developers to fetch the properties and metadata of a custom emoji, such as its name, image url, and creation date. it should be used when you need to access or display information about a particular emoji within a guild's context. the endpoint is useful for applications that manage emojis, display emoji details, or need to verify an emoji's existence and properties. note that this endpoint only retrieves data for custom emojis created within the specified guild and does not provide information about standard unicode emojis.
</Accordion>

<Accordion title="Retrieve guild webhooks">
  Retrieves all webhooks associated with a specific discord guild (server). this endpoint allows developers to fetch a comprehensive list of webhooks that have been created within the specified guild. it's particularly useful for managing and auditing webhook integrations, such as those used for automated messaging or external service connections. the endpoint should be used when you need to review, manage, or gather information about existing webhooks in a guild. it does not create, modify, or delete webhooks; it only provides read access to the current webhook configuration. the response typically includes details such as the webhook's id, name, channel id, and other relevant metadata for each webhook in the guild.
</Accordion>

<Accordion title="Get oauth2 applications for current user">
  Retrieves detailed information about the current oauth2 application authenticated with discord. this endpoint allows developers to access metadata and settings for their application, such as the app's name, icon, description, and other relevant details. it's particularly useful for applications that need to verify their own identity or fetch up-to-date configuration information. the endpoint should be used when an application needs to self-inspect or update its own information dynamically. note that this endpoint only provides information about the authenticated application and cannot be used to query details of other discord applications.\<\<DEPRECATED use get\_my\_oauth2\_application>>
</Accordion>

<Accordion title="Retrieve channel webhooks">
  Retrieves a list of all webhooks associated with a specific discord channel. this endpoint allows developers to fetch detailed information about existing webhooks for a given channel, including their ids, names, avatars, and token (if available). it's useful for managing and auditing webhook configurations within a discord server. the endpoint should be used when you need to review or manage the webhooks set up for a particular channel, such as for debugging, updating, or removing webhooks. it does not create new webhooks or modify existing ones. note that this endpoint only returns webhooks for the specified channel and does not provide information about webhooks in other channels or server-wide webhooks.
</Accordion>

<Accordion title="List guild regions">
  Retrieves a list of available voice regions for a specific discord guild (server). this endpoint should be used when setting up or managing voice channels within a guild to determine which voice server locations are available for optimizing voice quality and reducing latency. the returned information can help in choosing the most suitable region for the guild's voice channels based on the geographical distribution of its members. this endpoint does not modify any guild settings; it only provides information about available options. it's particularly useful for large or geographically diverse communities where voice quality is a priority.
</Accordion>

<Accordion title="List guild roles">
  Retrieves all roles defined within a specific discord guild (server). this endpoint is used to fetch comprehensive information about the role hierarchy and permissions structure of a given server. it provides details on each role, including their names, colors, positions in the hierarchy, and associated permissions. this tool is essential for applications that need to understand or manage the permission structure of a discord server, such as moderation bots or server management tools. it should be used when you need a complete overview of a guild's roles, but it won't provide information about which users have which roles.
</Accordion>

<Accordion title="Retrieve user connections">
  Retrieves a list of connected accounts for the authenticated user on discord. this endpoint allows developers to access information about external services or platforms that the user has linked to their discord account. it should be used when an application needs to gather data about a user's connected accounts, such as for displaying integrated services or syncing information across platforms. the endpoint returns details of various connections, which may include services like twitch, youtube, or other social media platforms. it's important to note that this endpoint only provides information about existing connections and does not allow for adding or modifying connections. the data returned is specific to the authenticated user and requires proper authentication to access.
</Accordion>

<Accordion title="Retrieve current user guilds">
  Retrieves a list of guilds (servers) that the authenticated user is a member of on discord. this endpoint provides essential information about each guild, such as its id, name, and the user's role within it. it's particularly useful for applications that need to display or manage a user's server list, or to check a user's membership status across multiple servers. the endpoint returns only basic guild information and does not include detailed data like channel lists or member rosters. be aware that for users who are members of many guilds, the response may be paginated, and additional requests might be necessary to fetch the complete list.
</Accordion>

<Accordion title="Retrieve user connections">
  Retrieves a list of connected accounts for the authenticated user on discord. this endpoint allows developers to access information about external services or platforms that the user has linked to their discord account. it should be used when an application needs to gather data about a user's connected accounts, such as for displaying integrated services or syncing information across platforms. the endpoint returns details of various connections, which may include services like twitch, youtube, or other social media platforms. it's important to note that this endpoint only provides information about existing connections and does not allow for adding or modifying connections. the data returned is specific to the authenticated user and requires proper authentication to access.\<\<DEPRECATED use list\_my\_connections>>
</Accordion>

<Accordion title="Get guild members">
  Retrieves a list of members for a specified discord guild (server). this endpoint allows developers to fetch detailed information about the users who are part of a particular guild. it's useful for various purposes such as member management, analytics, or displaying member information within a bot or application. the endpoint returns member data which typically includes user ids, usernames, roles, and join dates. it's important to note that this endpoint may not return all members for very large guilds due to discord's optimization practices. in such cases, pagination might be necessary, though the details are not provided in this schema. use this endpoint when you need to access member information for a specific guild, but be mindful of rate limits and the potential need for pagination in large guilds.
</Accordion>

<Accordion title="Retrieve pinned messages in channel">
  Retrieves all pinned messages from a specified discord channel. this endpoint is used to fetch important messages that have been pinned by users or moderators for easy reference. it's particularly useful for accessing key information, announcements, or rules that are prominently displayed in a channel. the endpoint returns an array of message objects representing the pinned content, allowing developers to display or process these highlighted messages within their applications. use this endpoint when you need to access or display the most crucial information from a discord channel. note that the number of pinned messages is limited per channel, and this endpoint will only return currently pinned messages, not a historical record of previously pinned content.
</Accordion>

<Accordion title="Fetch messages from channel">
  Retrieves messages from a specified discord channel. this endpoint allows you to fetch the message history or recent messages for a given channel, which is useful for displaying chat logs, implementing search functionality, or syncing messages across different platforms. the endpoint returns a list of message objects, likely in reverse chronological order (newest first). it should be used when you need to access the content of messages in a specific channel, such as for moderation purposes, data analysis, or creating chat archives. note that this endpoint may have rate limits and pagination to manage large message volumes, so it's important to handle these aspects in your implementation. the endpoint does not provide real-time updates; for live message tracking, consider using discord's websocket api instead.
</Accordion>

<Accordion title="Retrieve sticker by id">
  Retrieves detailed information about a specific discord sticker using its unique identifier. this endpoint allows developers to fetch comprehensive data about a single sticker, including its name, description, format type, and associated pack details. it's particularly useful when building features that involve displaying or managing individual stickers within a discord-integrated application. the endpoint should be used when specific sticker information is needed, rather than for bulk retrieval of multiple stickers. note that this endpoint only provides data for existing, valid stickers; it will not create new stickers or modify existing ones.
</Accordion>

<Accordion title="Retrieve stage instance by channel id">
  Retrieves detailed information about a specific stage instance in a discord server. this endpoint allows you to fetch the current state and configuration of a stage instance associated with a particular channel. use this when you need to access up-to-date information about an ongoing stage event, such as its topic, privacy level, or discovery status. the endpoint is particularly useful for applications that need to monitor or manage stage events programmatically. note that this endpoint only provides information about existing stage instances and cannot be used to create, modify, or delete them.
</Accordion>

<Accordion title="List sticker packs">
  Retrieves a list of available sticker packs on the discord platform. this endpoint provides information about collections of stickers that users can access and use in their discord messages. it's useful for applications that want to display or manage sticker packs within their interface. the endpoint returns details about official discord sticker packs, which may include pack names, descriptions, banner images, and the stickers contained within each pack. note that this endpoint likely does not include custom or user-created sticker packs, focusing instead on the standard packs available to all discord users.
</Accordion>

<Accordion title="Retrieve guild welcome screen">
  Retrieves the welcome screen configuration for a specified discord guild (server). this endpoint is used to fetch the current settings and content of the welcome screen, which is displayed to new members when they join a community server. it's particularly useful for bot developers or server managers who need to programmatically access or display welcome screen information. the endpoint should be used when you need to view or verify the current welcome screen setup for a guild. note that this endpoint only works for guilds that have the community feature enabled and have set up a welcome screen. it will not provide welcome screen data for guilds that don't meet these criteria.
</Accordion>

<Accordion title="Retrieve current user guilds">
  Retrieves a list of guilds (servers) that the authenticated user is a member of on discord. this endpoint provides essential information about each guild, such as its id, name, and the user's role within it. it's particularly useful for applications that need to display or manage a user's server list, or to check a user's membership status across multiple servers. the endpoint returns only basic guild information and does not include detailed data like channel lists or member rosters. be aware that for users who are members of many guilds, the response may be paginated, and additional requests might be necessary to fetch the complete list.\<\<DEPRECATED use list\_my\_guilds>>
</Accordion>

<Accordion title="Get guild templates by guild id">
  Retrieves a list of all guild templates associated with a specific discord guild (server). this endpoint allows developers to fetch pre-configured server setups that can be used to create new guilds quickly. it's particularly useful for retrieving templates created by guild administrators to standardize new server creation or to offer as starting points for community expansion. the endpoint returns all templates for the specified guild, providing details such as template code, name, description, and usage statistics. use this when you need to display available templates for a guild or before creating a new guild based on a template. note that this endpoint only retrieves templates; it does not create or modify them.
</Accordion>

<Accordion title="Get private archived threads for user">
  Retrieves a list of archived private threads in a specific channel that the current user has participated in. this endpoint is useful for accessing historical private conversations within a discord server. it should be used when a user needs to review or reference past private discussions that are no longer active. the endpoint only returns threads that the user was a part of and does not provide access to other users' private threads. note that this endpoint specifically targets archived threads, meaning it won't return active or unarchived private threads.
</Accordion>

<Accordion title="List thread members in channel">
  Retrieves a list of members participating in a thread within a specific discord channel. this endpoint is used to fetch information about users who have joined or been added to a thread, providing insights into thread participation and activity. it's particularly useful for moderators or bots that need to monitor thread engagement or perform actions based on thread membership. the endpoint returns details about thread members, which may include their user ids, join timestamps, and other relevant information. use this endpoint when you need to track thread participation or gather data about user involvement in specific discussions within a discord server.
</Accordion>

<Accordion title="Get channel message reaction by emoji">
  Retrieves a list of users who have reacted to a specific message with a particular emoji in a discord channel. this endpoint allows you to fetch detailed information about reactions on a message, which is useful for analyzing user engagement, creating interactive features, or gathering metrics on content popularity. it should be used when you need to know who reacted to a message with a specific emoji, such as for implementing reaction-based features or moderating content based on reactions. the endpoint is limited to retrieving reactions for a single emoji at a time and does not provide information about other reactions on the message or the message content itself.
</Accordion>

<Accordion title="Retrieve user by id">
  Retrieves detailed information about a specific discord user based on their unique user id. this endpoint allows developers to access public user data, which may include the user's username, avatar, account creation date, and other relevant information. it's particularly useful for applications that need to display user profiles, manage user interactions, or integrate discord user data into their services. the endpoint should be used when specific user details are required, but it will not provide information about the user's activities, messages, or server memberships. note that some user information may be limited based on privacy settings or if the user has restricted access to their profile.
</Accordion>

<Accordion title="Retrieve guild prune info">
  Retrieves the number of members that would be removed from a specified discord guild (server) in a prune operation. this endpoint is used to estimate the impact of a prune action before actually performing it. it calculates how many inactive members would be removed based on the specified inactivity period and role criteria. this tool is particularly useful for large guild management and cleanup operations, helping administrators make informed decisions about member pruning. it does not actually remove any members; it only provides a count. use this endpoint when planning guild maintenance or when you need to assess the potential impact of a prune operation on your guild's member count.
</Accordion>

<Accordion title="Pin message in channel">
  This endpoint allows you to pin a specific message in a discord channel. pinning a message keeps it at the top of the channel, making it easily accessible to all users. this is useful for highlighting important information, announcements, or frequently referenced content within a channel. the endpoint requires the channel id and message id to identify the exact message to be pinned. it's important to note that there is a limit to the number of pinned messages per channel, typically set to 50. if this limit is reached, you may need to unpin an existing message before pinning a new one. this endpoint should be used when you want to emphasize a particular message for long-term visibility in a channel.
</Accordion>

<Accordion title="Retrieve thread member by id">
  Retrieves information about a specific user's membership in a thread within a discord channel. this endpoint allows you to fetch details such as the user's thread permissions, join timestamp, and other relevant information. use this when you need to check a user's status or rights within a particular thread. it's particularly useful for moderation purposes or when implementing thread-specific features in your application. the endpoint does not modify any data and only provides read-only access to thread member information.
</Accordion>

<Accordion title="Get archived public threads by channel id">
  Retrieves a list of archived public threads from a specified discord channel. this endpoint is used to access threads that are no longer active but remain viewable for reference purposes. it's particularly useful for reviewing past discussions or retrieving information from older, inactive threads. the endpoint only returns public threads, which are visible to all members with access to the parent channel. it does not provide access to archived private threads or active threads. use this endpoint when you need to browse or search through historical public discussions within a specific channel.
</Accordion>

<Accordion title="Fetch voice regions list">
  Retrieves a list of available voice regions for discord servers. this endpoint provides information about the geographic locations where voice channels can be hosted, allowing server administrators to optimize voice quality and reduce latency for their users. use this endpoint when setting up new voice channels, troubleshooting voice connection issues, or planning server infrastructure. the returned data typically includes region identifiers, names, and potentially other relevant details for each available voice region. note that while this endpoint lists all possible regions, the actual availability might depend on the server's location and discord's current infrastructure.
</Accordion>

<Accordion title="Retrieve channel invites">
  Retrieves a list of all active invites for a specific discord channel. this endpoint allows developers to gather information about existing invites, including details such as the invite code, creator, expiration time, and usage statistics. it's particularly useful for managing channel access, tracking invite usage, or implementing invite-based features within a discord bot or application. the endpoint returns invite objects for the specified channel, providing a comprehensive view of how users can join the channel. note that this endpoint only returns information about existing invites and does not create new invites or modify existing ones.
</Accordion>

<Accordion title="Retrieve webhook by id">
  Retrieves detailed information about a specific discord webhook using its unique identifier. this endpoint allows developers to fetch the current configuration and status of a webhook, including its name, channel association, and other relevant details. it's particularly useful for verifying webhook settings, troubleshooting integration issues, or gathering data for webhook management tasks. the endpoint provides a snapshot of the webhook's properties at the time of the request, but does not include historical data or usage statistics. use this when you need to confirm a webhook's existence, check its current setup, or gather information for updating webhook configurations.
</Accordion>

<Accordion title="Prune guild members by roles">
  Initiates a prune operation to remove inactive members from a discord guild. this endpoint allows server administrators to automatically remove members who have not been active for a specified number of days. the prune can be customized to target specific roles and can optionally calculate the number of affected members before execution. use this endpoint to maintain an active community by removing dormant accounts. exercise caution, as this action permanently removes members from the guild. it's recommended to use the compute prune count option first to assess the impact before performing the actual prune.
</Accordion>

<Accordion title="Update guild onboarding configuration">
  Updates the onboarding configuration for a specified discord guild (server). this endpoint allows server administrators to customize the onboarding experience for new members by defining prompts, setting default channels, and controlling the overall onboarding process. it can be used to create an interactive and guided introduction to the server, helping new members understand the community structure and rules. the endpoint supports advanced customization options, including multiple-choice questions, role assignments, and channel suggestions. however, it's important to note the limitations on the number of prompts, options, and default channels that can be configured.
</Accordion>

<Accordion title="Retrieve guild widget json">
  Retrieves the json representation of a discord guild's widget. this endpoint allows developers to fetch publicly available information about a specific guild that can be embedded or displayed on external websites or applications. the widget typically includes details such as the guild's name, member count, and possibly a list of online members or voice channels. this tool is useful for creating promotional materials for discord servers or integrating discord community information into third-party applications. it should be used when you need to display up-to-date information about a discord guild without requiring users to be logged in or have direct access to the server. note that the guild must have the widget feature enabled for this endpoint to return data, and the information provided is limited to what the guild administrators have chosen to make public.
</Accordion>

<Accordion title="Modify channel permissions">
  Updates or creates a permission overwrite for a specific role or member in a discord channel. this endpoint allows for fine-grained control over channel-specific permissions, enabling customization of access and actions within a discord server. it should be used when modifying existing permission overwrites or creating new ones for roles or members in a channel. the endpoint accepts bitwise permission values for allowing and denying specific actions, providing granular control over user capabilities. it's important to note that this operation will overwrite any existing permissions for the specified role or member in the channel, so care should be taken to include all desired permissions in the request.
</Accordion>

<Accordion title="Delete channel message pin">
  Removes a specific pinned message from a discord channel. this endpoint is used to unpin a previously pinned message, making it no longer appear in the channel's pinned messages list. it's particularly useful for managing important information in a channel by removing outdated or no longer relevant pinned content. the operation is irreversible, so use it cautiously. this tool should be used when you need to declutter pinned messages or remove sensitive information from the pinned section. it will not delete the message from the channel entirely, only remove its pinned status.
</Accordion>

<Accordion title="Search guild members by id">
  The search guild members endpoint allows you to search for members within a specific discord guild (server) based on their username or nickname. this get request is useful for finding particular users in a guild, especially in large communities where manual searching might be impractical. the endpoint returns a list of guild member objects whose username or nickname starts with the provided search string. it's particularly beneficial for bots and applications that need to manage or interact with specific guild members efficiently. note that this endpoint may have limitations on the number of results returned and could be subject to rate limiting. for more accurate and faster results, consider using the newer elasticsearch-based endpoint '/guilds/\{guild id}/members-search' if available.
</Accordion>

<Accordion title="Get archived private threads by channel id">
  Retrieves a list of archived private threads within a specified discord channel. this endpoint is used to access private conversations that have been moved to an archived state, making them less prominent but still accessible. it's particularly useful for managing and reviewing past discussions in community servers or team collaborations. the endpoint returns archived private threads sorted by their archive timestamp in descending order, providing the most recently archived threads first. use this when you need to access historical private conversations or when implementing thread management features in your discord integration. note that this endpoint only retrieves private threads, not public ones, and access is restricted to users with appropriate permissions in the channel.
</Accordion>

<Accordion title="Retrieve guild member by user id">
  Retrieves detailed information about a specific member within a discord guild. this endpoint allows developers to fetch comprehensive data about a user's membership in a particular server, including their roles, permissions, nickname, and join date. it's particularly useful for bot developers and applications that need to manage guild members or make decisions based on a member's status and attributes. the endpoint should be used when detailed, up-to-date information about a specific guild member is required. it will not provide information about the user's activities in other guilds or their global discord account details. keep in mind that the bot or application must have the necessary permissions within the guild to access this information.
</Accordion>

<Accordion title="List guild bans">
  Retrieves a list of banned users for a specified discord guild (server). this endpoint allows server administrators or authorized bots to fetch information about all users who have been banned from the guild. it's useful for reviewing moderation actions, auditing ban lists, or implementing custom moderation tools. the endpoint returns details about each banned user, likely including their user id, username, and the reason for the ban if provided. use this endpoint when you need to review or manage the ban list for a guild, but note that it requires appropriate permissions to access this sensitive information.
</Accordion>

<Accordion title="Delete guild user ban">
  Removes a ban for a user from a specific guild (server) in discord. this endpoint is used to lift an existing ban, allowing the user to rejoin the guild if they choose. it's typically used by guild administrators or moderators as part of the moderation process, such as when a banned user's punishment period has ended or if the ban was placed in error. the endpoint requires only the guild id and the user id, making it a straightforward operation for unbanning. note that this action only removes the ban; it does not automatically add the user back to the guild or restore their previous roles and permissions.
</Accordion>

<Accordion title="Retrieve message from channel">
  Retrieves a specific message from a discord channel. this endpoint allows you to fetch detailed information about a single message, including its content, author, timestamp, and any attachments or embeds. it's particularly useful for bot development, message logging, or implementing features that require analysis or manipulation of specific messages. the endpoint should be used when you need to access or verify the contents of a particular message within a channel. it does not provide information about other messages in the channel or modify the message in any way. note that you must have the necessary permissions to view the message in the specified channel.
</Accordion>

<Accordion title="Update guild template by code">
  Updates an existing guild template for a specified discord server (guild). this endpoint allows you to modify the pre-configured settings of a template, which may include roles, channels, and permissions. use this when you need to change the structure or settings of an existing template to better suit your guild's needs. it's particularly useful for server administrators who want to refine their guild templates over time based on community feedback or changing requirements. note that this endpoint only updates the template; it does not create a new guild from the template or apply the changes to existing guilds.
</Accordion>

<Accordion title="Retrieve guild widget information">
  Retrieves the widget information for a specified discord guild (server). this endpoint allows developers to fetch the current widget settings and data associated with a particular guild, which can be used to display guild information on external websites or applications. the widget typically includes details such as the guild's name, icon, member count, and available voice channels. use this endpoint when you need to access or display a guild's public information without requiring full access to the guild's data. it's particularly useful for creating embeddable widgets or for applications that need to showcase basic guild information. note that this endpoint only returns data if the guild has the widget feature enabled in its settings.
</Accordion>

<Accordion title="Trigger typing indicator">
  Triggers a typing indicator in a specified discord channel, indicating that the bot or application is currently typing a message. this endpoint is used to simulate the typing status typically shown when a user is composing a message. it's particularly useful for creating a more natural, human-like interaction in bot responses or when the bot is processing a lengthy operation before sending a message. the typing indicator typically lasts for 10 seconds or until a message is sent, whichever comes first. this endpoint should be used sparingly and in conjunction with actual message sending to avoid misleading users. note that repeatedly triggering this endpoint without sending a message may be considered api abuse.
</Accordion>

<Accordion title="Retrieve guild invites by id">
  Retrieves all active invites for a specified discord guild (server). this endpoint allows developers to fetch a comprehensive list of current invitations to join the guild, including details such as the invite codes, creators, and expiration times. it's particularly useful for guild management, analytics, or creating invite management features within applications. the endpoint should be used when an overview of all active guild invites is needed, such as for moderation purposes or tracking invite usage. note that this endpoint only returns active invites; expired or revoked invites will not be included in the response. the user making the request must have sufficient permissions within the guild to view invites.
</Accordion>

<Accordion title="Fetch guild commands via application id">
  Retrieves a list of all commands registered for a specific application within a particular discord guild. this endpoint is used to fetch the available slash commands, context menu commands, or any other type of application command that has been set up for the application in the specified guild. it's particularly useful for developers who need to manage, update, or simply view the current set of commands their application offers in a guild. the endpoint should be used when you need to audit your application's commands, prepare for updates, or troubleshoot command-related issues. it does not provide information about command permissions or usage statistics; it only returns the command definitions themselves.
</Accordion>

<Accordion title="Retrieve guild new member welcome">
  Retrieves the new member welcome screen settings for a specified discord guild (server). this endpoint allows developers to fetch the current configuration of the welcome screen that new members see when joining the guild. it provides information about the customized welcome message, any specific instructions or guidelines for new members, and potentially the enabled/disabled status of the welcome screen feature. use this endpoint when you need to view or check the existing welcome screen setup, such as before making modifications or for informational purposes. it does not modify the welcome screen settings; for that, you would need to use a separate update endpoint. the response likely includes details about the welcome message content, any customizable elements like suggested channels or roles, and possibly information about membership screening if it's enabled for the guild.
</Accordion>

<Accordion title="Modify application by id">
  Updates the properties of an existing discord application. this endpoint allows you to modify various aspects of your application, including its description, visual elements, team affiliation, interaction endpoints, and installation parameters. use this when you need to change or update any details of your discord application after its initial creation. it's particularly useful for maintaining up-to-date application information, adjusting its appearance, or modifying its behavior. note that some fields, like the application type, have specific constraints, and others, like the icon and cover image, require base64-encoded strings.
</Accordion>

<Accordion title="Preview guild by id">
  Retrieves a preview of a discord guild (server) based on its id. this endpoint allows users or bots to fetch basic information about a guild without being a member, such as the guild's name, description, approximate member count, and icon. it's particularly useful for discovering new guilds, making decisions about joining a guild, or for bots to gather information about guilds they're not part of. the preview only includes public information and is subject to the guild having enabled the preview feature. this endpoint should not be used to fetch detailed or sensitive guild information, as it only provides a limited subset of guild data.
</Accordion>

<Accordion title="Get your applications">
  Retrieves detailed information about the current authenticated application. this endpoint allows developers to access various attributes and settings of their discord application or bot. it's particularly useful for self-inspection, verifying application details, or dynamically adjusting application behavior based on its current configuration. the endpoint returns comprehensive data about the application, which may include its name, description, icon, bot user information, and other relevant metadata. while specific return fields are not detailed in the schema, developers can expect a rich set of application-related information. this endpoint should be used when an application needs to introspect its own properties or verify its current state within the discord ecosystem.
</Accordion>

<Accordion title="Fetch guild application command by id">
  Retrieves detailed information about a specific application command within a discord guild. this endpoint allows developers to fetch the properties and configuration of a command that has been registered for their application in a particular server. it's useful for inspecting command settings, verifying command existence, or retrieving command details for modification purposes. the endpoint requires the application id, guild id, and command id to be specified in the path, ensuring precise targeting of the desired command. this tool should be used when needing to review or validate the current state of a specific command in a guild, but it does not modify the command or return a list of all commands.
</Accordion>

<Accordion title="Get guild scheduled event by id">
  Retrieves detailed information about a specific scheduled event within a discord guild. this endpoint allows developers to fetch comprehensive data about a particular event, including its name, description, start and end times, location (if applicable), and current status. it's useful for displaying event information in applications, tracking event details, or syncing event data with external calendars. the endpoint should be used when up-to-date information about a specific guild event is needed. it does not modify the event or provide information about event attendees. note that the response will only include publicly available information about the event, and access may be restricted based on the bot's permissions within the guild.
</Accordion>

<Accordion title="Retrieve guild vanity url">
  Retrieves the vanity url information for a specified discord guild (server). this endpoint allows you to fetch details about a guild's custom invite link, including the vanity url code and the number of times it has been used. it's particularly useful for server administrators or bots that need to monitor or manage the guild's invitation system. the endpoint should be used when you need to check the current status of a guild's vanity url or track its usage. note that not all guilds have vanity urls; this feature is typically available only for servers that meet certain criteria or have specific features enabled.
</Accordion>

<Accordion title="Retrieve sticker from guild">
  Retrieves detailed information about a specific sticker within a discord guild (server). this endpoint is used to fetch the properties and metadata of a single sticker, such as its name, description, format type, and associated emoji. it's particularly useful for applications that need to display or manage custom stickers within a guild. the endpoint should be used when you need comprehensive information about a specific sticker, rather than a list of all stickers in a guild. note that this endpoint likely requires appropriate permissions to access the guild and its sticker data.
</Accordion>

<Accordion title="Retrieve guild member for current user">
  Retrieves detailed information about the authenticated user's membership in a specific discord guild (server). this endpoint allows developers to fetch member-specific data such as roles, nickname, join date, and other relevant information for the current user within the specified guild. it should be used when an application needs to access or display the user's status and details within a particular discord server. this endpoint is particularly useful for applications that manage user interactions across multiple guilds or need to verify a user's membership status. note that this endpoint only provides information for the authenticated user and cannot be used to fetch member details for other users.
</Accordion>

<Accordion title="Retrieve guild scheduled events">
  Retrieves a list of scheduled events for a specific discord guild (server). this endpoint allows developers to fetch information about upcoming or ongoing events within a server, which can include activities like voice channel meetings, external events, or any other scheduled community gatherings. it's particularly useful for applications that need to display or manage server events, create event reminders, or analyze community engagement. the endpoint returns details such as event names, descriptions, start times, and other relevant information. it should be used when you need to present users with an overview of a guild's planned activities or integrate event management features into your discord-related application. note that this endpoint only provides information about events that have been scheduled through discord's event system and may not include informal or externally managed events.
</Accordion>

<Accordion title="Retrieve application role metadata">
  Retrieves the role connection metadata for a specific discord application. this endpoint is used to fetch information about how the application integrates with discord's role system, including any custom requirements or verifications set up for role assignments. it's particularly useful for developers managing applications that utilize discord's linked roles feature. the retrieved metadata can include details about the conditions users must meet to be granted certain roles within discord servers where the application is integrated. this endpoint should be used when setting up or managing role connections for a discord application, or when needing to verify the current role connection configuration. it does not modify any data and is intended for read-only operations.
</Accordion>

<Accordion title="Retrieve guild auto moderation rules">
  Retrieves all auto moderation rules configured for a specific discord guild (server). this endpoint allows developers to fetch the current set of automated content moderation rules that have been set up to maintain community standards within the specified guild. it should be used when you need to review, audit, or display the existing auto moderation configuration for a server. the endpoint returns information about various rule types, such as keyword filters, spam detection, and mention limits, along with their associated actions and exemptions. it does not modify any existing rules or create new ones; it is purely for retrieving current rule configurations.
</Accordion>

<Accordion title="Retrieve guild stickers">
  Retrieves a list of all custom stickers for a specific discord guild (server). this endpoint allows developers to fetch detailed information about the stickers available in a particular guild, including their names, descriptions, tags, and image data. it's useful for applications that need to display or manage guild-specific stickers, such as sticker browsers or management tools. the endpoint returns only the stickers created for the specified guild and does not include global discord stickers. use this when you need to list, display, or check the availability of custom stickers within a guild. note that this endpoint does not create, modify, or delete stickers; it's purely for retrieval purposes.
</Accordion>

<Accordion title="Retrieve guild template with code">
  Retrieves detailed information about a specific discord guild template using its unique code. this endpoint allows developers to fetch the pre-configured settings, name, and description of a guild template, which can be used to quickly create new guilds with predefined structures. it's particularly useful when you need to review or validate a template's contents before creating a guild based on it. the endpoint returns comprehensive data about the template but does not create or modify any guilds. use this when you need to display template information to users or verify template details programmatically.
</Accordion>

<Accordion title="Get oauth2 applications for current user">
  Retrieves detailed information about the current oauth2 application authenticated with discord. this endpoint allows developers to access metadata and settings for their application, such as the app's name, icon, description, and other relevant details. it's particularly useful for applications that need to verify their own identity or fetch up-to-date configuration information. the endpoint should be used when an application needs to self-inspect or update its own information dynamically. note that this endpoint only provides information about the authenticated application and cannot be used to query details of other discord applications.
</Accordion>

<Accordion title="Get gateway details">
  Retrieves the websocket url required to connect to discord's gateway. this endpoint is essential for applications that need real-time communication with discord, such as bots or interactive clients. the gateway allows clients to receive events and updates from discord without the need for constant polling. use this endpoint to obtain the websocket url before establishing a connection to receive real-time events like messages, presence updates, and other discord state changes. note that while this endpoint provides the connection url, actual websocket connection handling, including authentication and event processing, must be implemented separately.
</Accordion>

<Accordion title="Get oauth2 user information">
  Retrieves the authenticated user's profile information using discord's oauth2 system. this endpoint returns essential details about the user, such as their identity, associated guilds, and potentially other account-related information. it should be used when an application needs to access the current user's data after successful oauth2 authentication. the endpoint is particularly useful for personalization, user management, and integration of discord user data into third-party applications. note that the specific data returned may depend on the oauth2 scopes granted during the authentication process.
</Accordion>

<Accordion title="Retrieve bot gateway">
  Retrieves the websocket url and additional metadata required for a bot to connect to discord's gateway. this endpoint is essential for bot developers who need to establish a real-time connection to receive events and updates from discord. it provides the necessary information to initiate a websocket connection, including the gateway url and recommendations for sharding. use this endpoint before connecting your bot to the gateway to ensure you have the most up-to-date connection information. note that this endpoint is specifically for bots and should not be used for user accounts or other types of integrations.
</Accordion>

<Accordion title="Retrieve channel details">
  Retrieves detailed information about a specific discord channel using its unique identifier. this endpoint allows developers to fetch various properties of a channel, such as its name, type (text, voice, or video), associated permissions, and other relevant metadata. it should be used when an application needs to display or work with up-to-date channel information. the endpoint is particularly useful for bots and applications that need to dynamically interact with or manage discord channels. note that this endpoint only provides channel details and does not return message content or member lists directly.
</Accordion>

<Accordion title="Get user role connection">
  Retrieves the role connection information for the authenticated user in relation to a specific discord application. this endpoint allows developers to fetch details about how a user's discord account is linked to roles within the application, which is crucial for managing permissions and access control. it should be used when an application needs to verify or update a user's role connections, such as during authentication processes or when syncing external service permissions with discord roles. the endpoint provides only the role connection data for the specified application and does not return general user information or role connections for other applications.
</Accordion>

<Accordion title="Retrieve users for scheduled event">
  Retrieves users interested in a specific scheduled event within a discord guild. useful for event organizers to track attendance and engagement. supports pagination and optional inclusion of guild member data. requires guild id and event id. may need permissions and be subject to rate limits.
</Accordion>

<Accordion title="Retrieve auto moderation rule">
  Retrieves detailed information about a specific auto-moderation rule within a discord guild. this endpoint allows developers to fetch the configuration and settings of an individual rule, including its trigger type, actions, exempt roles and channels, and enabled status. it should be used when you need to review or audit the settings of a particular auto-moderation rule. the endpoint is particularly useful for debugging rule behavior, verifying rule settings, or displaying rule details in a management interface. note that this endpoint only retrieves information and does not modify the rule in any way.
</Accordion>

<Accordion title="List active threads in guild">
  Retrieves a list of currently active threads within a specified discord guild. this endpoint is useful for obtaining an up-to-date view of ongoing discussions and conversations in a server. it should be used when you need to display or manage active threads, such as for moderation purposes or to provide users with a list of current conversations they can join. the endpoint only returns threads that are currently active and visible to guild members; it does not include archived or hidden threads. this tool is particularly helpful for applications that need to monitor or interact with real-time guild activity.
</Accordion>

<Accordion title="Get guild onboarding by id">
  Retrieves the onboarding information for a specific discord guild (server). this endpoint provides details about the guild's onboarding process, including welcome screens, default channels, and other initial setup configurations. it's particularly useful for understanding how new members are introduced to the guild and what information or options they're presented with upon joining. this endpoint should be used when you need to review or analyze a guild's current onboarding settings, potentially for improving user experience or troubleshooting issues with new member integration. note that this endpoint only retrieves information and does not allow modifications to the onboarding process.
</Accordion>

<Accordion title="Retrieve guild emojis">
  Retrieves a list of emoji objects for the specified guild (server) in discord. this endpoint allows developers to access all custom emojis that have been uploaded to a particular guild. it's useful for applications that need to display or manage guild-specific emojis, such as emoji pickers or moderation tools. the endpoint returns both static and animated emojis associated with the guild. note that this endpoint only provides information about custom emojis and does not include standard unicode emojis or those from discord nitro.
</Accordion>

<Accordion title="Retrieve application details">
  Retrieves detailed information about a specific discord application. this endpoint allows developers to fetch comprehensive data about their application, including its name, description, icon, bot user details (if applicable), and other relevant settings. use this endpoint when you need to access or verify your application's current configuration on the discord platform. it's particularly useful for applications that need to dynamically adjust their behavior based on their current settings or for debugging purposes. note that this endpoint only provides read access to the application details and cannot be used to modify the application.
</Accordion>

<Accordion title="Retrieve guild details">
  Retrieves detailed information about a specific discord guild (server) using its unique identifier. this endpoint allows developers to fetch comprehensive data about a guild, including its name, features, member count, channel list, roles, and other server-specific settings. it's particularly useful when you need to display guild information in a bot or third-party application, or when you need to verify certain guild properties. the endpoint should be used when detailed, up-to-date information about a particular guild is required. it does not modify any guild data and is read-only. note that the amount and type of information returned may depend on the permissions of the authenticated user making the request.
</Accordion>

<Accordion title="List guild integrations">
  Retrieves a list of integration objects for a specified discord guild. this endpoint is used to fetch information about all third-party services, bots, or applications that have been integrated with the guild. it's particularly useful for guild administrators or bot developers who need to manage or audit the external services connected to a discord server. the endpoint requires the manage guild permission and should be used when you need a comprehensive overview of a guild's integrations. note that this endpoint only provides integration data and does not allow for modifying or adding new integrations.
</Accordion>

<Accordion title="Retrieve guild channels">
  Retrieves a list of all channels within a specified discord guild (server). this endpoint allows developers to fetch comprehensive information about the structure and organization of a guild's communication channels. it should be used when an application needs to display, analyze, or manage the channel layout of a particular guild. the endpoint returns details for all channel types, including text, voice, and category channels, providing a complete overview of the guild's communication setup. note that this endpoint does not return the content of the channels, only their structural information. the user must have the necessary permissions to view the channels in the specified guild.
</Accordion>

<Accordion title="List commands for application">
  Retrieves all commands registered for a specific discord application. this endpoint allows developers to fetch a list of all slash commands associated with their bot or application. it's useful for managing, auditing, or displaying the available commands for an application. the endpoint returns an array of command objects, each containing details such as the command name, description, and options. use this when you need to review, update, or sync your application's command list with discord's servers. note that this endpoint only retrieves global commands and does not include guild-specific commands.
</Accordion>

<Accordion title="Fetch application command by id">
  Retrieves detailed information about a specific command associated with a discord application. this endpoint allows developers to fetch the current configuration and properties of an existing command, such as its name, description, options, and permissions. it's particularly useful when you need to verify the current state of a command or gather information for updating or managing application commands. the endpoint should be used when you need to inspect or troubleshoot a specific command within your discord application. it does not create, modify, or delete commands; it only provides read-only access to command data.
</Accordion>

<Accordion title="Patch command for application">
  Modifies an existing application command for a discord bot. this endpoint allows you to update various properties of a command, including its name, description, options, and permissions. use this when you need to change the behavior or appearance of an existing command without creating a new one. the endpoint requires the application id and command id to identify the specific command to be edited. you can update the command's name, description, options (parameters), default member permissions, and dm availability. this is particularly useful for refining command functionality, fixing errors, or adapting to new features without disrupting the user experience. note that some properties, like the command type, cannot be changed after creation. always ensure that the updated command adheres to discord's guidelines and doesn't introduce breaking changes for existing users.
</Accordion>

<Accordion title="Patch guild voice state">
  Updates a user's voice state within a specific discord guild (server). this endpoint allows for modifying a user's suppression status and changing their voice channel. it can be used to programmatically mute/unmute users or move them between voice channels. the endpoint is particularly useful for bot applications that need to manage voice states, such as moderation bots or music bots. note that this endpoint only updates the specified properties; any unspecified properties will remain unchanged. also, be aware that using this endpoint may be subject to discord's rate limits and requires appropriate permissions within the guild.
</Accordion>

<Accordion title="Modify guild auto moderation rule">
  This endpoint modifies an existing auto-moderation rule for a discord guild. it allows updating various aspects of the rule, including its name, event type, actions, and trigger settings. use it to fine-tune moderation strategies or adjust rule sensitivity. be cautious of potential impacts on user experience and ensure alignment with server policies. note that this endpoint requires the existing rule's id.
</Accordion>

<Accordion title="Patch channel properties by id">
  Modifies an existing discord channel by updating its properties. this endpoint allows you to change various aspects of a channel, such as its name, type, permissions, and settings. it can be used to customize channels for different purposes, manage channel organization, or adjust channel-specific features. the endpoint is flexible, allowing partial updates by only specifying the properties you want to change. it supports modifications for different channel types, including text channels, voice channels, categories, and forum channels. when using this endpoint, be cautious about changing critical properties like channel type or permissions, as it may affect user access and channel functionality. note that some properties are only applicable to specific channel types, and attempting to set incompatible properties may result in errors.
</Accordion>

<Accordion title="Update guild sticker info">
  This endpoint allows you to modify an existing sticker within a specific discord guild. it enables partial updates to the sticker's properties, including its name, tags, and description. use this endpoint when you need to update sticker information without creating a new sticker or replacing it entirely. the changes are applied immediately, and only the provided fields will be updated, leaving others unchanged. note that this endpoint requires appropriate permissions within the guild to modify stickers.
</Accordion>

<Accordion title="Update guild scheduled event">
  Updates an existing scheduled event in a discord guild. this endpoint allows modifying various attributes of a scheduled event, such as its status, name, description, timing, and associated metadata. it's particularly useful for managing the lifecycle of events, changing event details, or adjusting schedules. the endpoint provides flexibility in updating different types of events (stage instances, voice events, or external events) with type-specific fields. use this endpoint when you need to make changes to an existing event rather than creating a new one or when transitioning an event through its lifecycle stages (e.g., from scheduled to active to completed).
</Accordion>

<Accordion title="Modify guild voice state for me">
  Updates the current user's voice state in a specific discord guild. this endpoint allows for modifying various aspects of a user's voice presence, including their speaking request status, audio suppression, and the voice channel they're connected to. it's particularly useful for managing user interactions in stage channels or for programmatically moving users between voice channels. the endpoint should be used when you need to programmatically adjust a user's voice settings or location within a guild's voice channels. it's important to note that this endpoint only affects the current user (the bot or application making the request) and cannot be used to modify other users' voice states. also, some parameters may have different effects depending on the type of voice channel (e.g., regular voice channel vs. stage channel).
</Accordion>

<Accordion title="Update user application role connection">
  Updates the role connection metadata for a discord user's external platform integration with a specific application. this endpoint allows you to set or modify the platform name, username, and custom metadata associated with the integration. use this when you need to update the user's role connection information after changes in their external platform status or to sync data between the platforms. it's particularly useful for applications that manage user roles based on their activity or status on external platforms.
</Accordion>

<Accordion title="Update guild emoji roles">
  This endpoint allows you to modify an existing custom emoji in a discord guild (server). it can be used to update the emoji's name or adjust which roles have permission to use it. the endpoint is particularly useful for managing emoji access control or rebranding existing emojis without creating new ones. it's important to note that this endpoint only modifies existing emojis and cannot be used to create new ones or delete existing emojis. the changes applied through this endpoint are immediate and affect all future uses of the emoji within the guild.
</Accordion>

<Accordion title="Modify guild role">
  This endpoint allows you to modify the attributes of an existing role within a discord guild (server). it is used to update various properties of a role, such as its name, permissions, color, and display settings. the endpoint is particularly useful for bot developers who need to programmatically manage roles in discord servers. to use this endpoint, you must specify both the guild id and role id in the url path. the request body can contain any combination of the modifiable attributes, allowing for partial updates. any attributes not included or set to null will remain unchanged. it's important to note that this endpoint can only modify existing roles; it cannot create new roles or delete existing ones. also, be cautious when modifying role permissions, as this can significantly impact user access within the guild.
</Accordion>

<Accordion title="Patch guild template information">
  Updates an existing guild template in discord. this endpoint allows you to modify the name and/or description of a specific template within a guild. use this when you need to refine or adjust the metadata of a guild template without creating a new one. the endpoint is particularly useful for maintaining up-to-date and accurate template information as your server evolves. note that this operation only affects the template itself and does not impact any guilds that may have been created from this template previously. be aware that you can only update templates for guilds where you have the necessary permissions.
</Accordion>

<Accordion title="Update webhook details patch">
  This endpoint allows you to update the properties of an existing discord webhook. it can be used to modify the webhook's name, avatar, or the channel it's associated with. this is particularly useful for maintaining and adjusting webhooks as your discord server evolves. the endpoint accepts partial updates, meaning you can provide only the fields you want to change. keep in mind that this operation directly modifies the webhook, so use it carefully to avoid unintended changes to your integrations.
</Accordion>

<Accordion title="Update webhook name and avatar">
  Updates an existing discord webhook by modifying its name and/or avatar. this endpoint allows you to customize the appearance of a webhook without changing its functionality or destination. use this when you need to rebrand a webhook or update its visual representation within discord channels. the endpoint requires the webhook's unique id and token for authentication and targeting. you can update the name, the avatar, or both in a single request. note that this operation only modifies the specified fields and does not affect other properties or the webhook's configured destination.
</Accordion>

<Accordion title="Update discord message with webhook">
  Edits a previously sent webhook message. this endpoint allows you to update various aspects of an existing message, including its content, embeds, components, and attachments. it's particularly useful for updating dynamic content or interactive elements in a discord channel without sending a new message. the endpoint supports partial updates, meaning you only need to include the fields you want to modify. unchanged fields will retain their current values. note that this endpoint can only edit messages originally sent by the same webhook, and it cannot be used to edit messages sent by users or bots.
</Accordion>

<Accordion title="Update guild settings">
  This endpoint allows you to modify various settings of a discord guild (server). it provides extensive control over guild configuration, including name, description, moderation settings, channel assignments, and feature toggles. use this endpoint when you need to update one or more guild settings programmatically. the endpoint is particularly useful for bot developers and server management tools that need to automate guild configuration changes. note that some parameters may require specific guild features to be enabled, and certain modifications (like transferring ownership) may require additional permissions. be cautious when modifying critical settings like verification levels or system channels, as these changes can significantly impact the guild's functionality and user experience.
</Accordion>

<Accordion title="Update guild welcome screen">
  Updates the welcome screen configuration for a specified discord guild. this endpoint allows server administrators to customize the welcome experience for new members by modifying the welcome screen's description, enabling or disabling the feature, and configuring up to five welcome channels. each welcome channel can be customized with a description and an optional emoji. use this endpoint to create an engaging first impression for new guild members and guide them to important channels or information within the community.
</Accordion>

<Accordion title="Patch guild widget endpoint">
  Modifies the widget settings for a specific discord guild (server). this endpoint allows you to enable or disable the guild widget and set the channel where the widget invite will direct new users. the guild widget is a customizable interface that provides information about the guild and can be used to attract new members. use this endpoint when you need to update the widget configuration, such as changing its visibility or the designated invite channel. it's particularly useful for guild administrators who want to manage their server's public presence or control how new members join through the widget. note that this endpoint only modifies widget settings and does not create or delete the widget itself.
</Accordion>

<Accordion title="Update channel message">
  Edits an existing message in a specific discord channel. this endpoint allows you to modify various aspects of a message, including its text content, embeds, components, and attachments. it's useful for updating bot-sent messages with new information, correcting errors, or adding interactive elements after the initial message was sent. you can selectively update specific parts of the message by including only the fields you want to change. omitted fields will remain unchanged. to remove content, embeds, or components, set their respective fields to null or an empty array. note that you can only edit messages sent by your bot or application. there are rate limits on editing messages, so avoid excessive edits. some message properties, like the author, cannot be changed using this endpoint.
</Accordion>

<Accordion title="Update application description">
  Updates the settings of a discord application. this endpoint allows developers to modify various aspects of their application, including its description, visual elements, team association, interaction endpoints, and installation parameters. it's particularly useful for maintaining and evolving an application's presence and functionality within the discord ecosystem. the endpoint accepts partial updates, meaning you only need to include the fields you want to change. use this when you need to adjust your application's configuration, update its appearance, or modify its interaction and installation settings. note that some changes may affect how users interact with or perceive your application, so use this endpoint judiciously. keep in mind that certain fields have specific format requirements or limitations, such as character limits for descriptions and url formats for endpoints.
</Accordion>

<Accordion title="Modify guild member details">
  The modifyguildmember endpoint allows you to update various attributes of a specific member within a discord guild (server). this powerful tool enables fine-grained control over a member's settings, including their nickname, role assignments, voice channel status, and temporary communication restrictions. use this endpoint when you need to programmatically manage member properties, such as assigning roles, moving users between voice channels, or imposing time-outs. it's particularly useful for moderation bots or applications that need to automate member management tasks. the endpoint requires the guild id and user id as path parameters, and accepts a json body with the attributes to be modified. note that this endpoint can only modify attributes that the authorized bot or application has permission to change, and some modifications may require specific permissions within the guild.
</Accordion>

<Accordion title="Modify guild member nickname">
  This endpoint allows you to modify the nickname of the currently authenticated user within a specific discord guild (server). it's used when a user wants to change their display name in a particular server without affecting their global username. the nickname is limited to 32 characters and can be set to null to remove it entirely. this operation is useful for personalizing a user's identity within different communities or for role-playing purposes. note that the ability to change nicknames may be restricted by server permissions, and some servers may have policies about nickname content.
</Accordion>

<Accordion title="Patch webhook original message">
  The editwebhookmessage endpoint allows you to modify an existing message sent through a discord webhook. use this to update content, add embeds, change attachments, or include interactive components. it supports partial updates, letting you modify specific elements without affecting others. be aware of rate limits and maximum limits for content length, embeds, attachments, and components.
</Accordion>

<Accordion title="Update current user profile">
  Updates the current user's discord profile, allowing modifications to the username and avatar. this endpoint should be used when a user wants to change their display name or profile picture within the discord platform. it's particularly useful for users who want to refresh their online identity or maintain consistency across different servers. the endpoint only updates the specified fields, leaving other profile information unchanged. note that changing the username too frequently may be subject to rate limiting, and inappropriate avatars may be removed by discord moderators. this endpoint does not handle other account settings such as email or password changes.
</Accordion>

<Accordion title="Update application guild command">
  This endpoint allows you to edit an existing discord application command within a specific guild. it provides the ability to modify various aspects of the command, including its name, description, options, and permissions. use this endpoint to update or refine a guild-specific command's functionality, localization, or access controls. be cautious about making drastic changes to existing commands, as it may confuse users familiar with the previous version.
</Accordion>


# Docusign
Source: https://docs.push.ai/integrations/docusign



DocuSign provides eSignature and digital agreement solutions, enabling businesses to send, sign, track, and manage documents electronically

<Accordion title="Docusign Add File To Workspace">
  This endpoint adds a file to a specific folder within a docusign workspace. it allows users to upload and organize files in their docusign account, enabling better document management and collaboration. the method should be used when integrating file upload functionality with docusign workspaces, such as when adding new documents to a project or sharing files with team members. it's important to note that this endpoint only handles the file addition process and does not provide functions for file modification or deletion.
</Accordion>

<Accordion title="Configure cloud storage redirect url">
  This endpoint configures the redirect url information for one or more cloud storage providers associated with a specific user in docusign. it allows setting up the authentication flow between docusign and various cloud storage services, enabling secure access to documents stored in these cloud providers. the endpoint should be used when integrating cloud storage services with docusign for a user, ensuring proper authentication and redirection after the cloud storage provider authenticates the user. it's important to note that the redirect url must be within the docusign.com or docusign.net domains for security reasons. the endpoint returns the configured storage providers with their respective authentication urls, which are crucial for completing the authentication process.
</Accordion>

<Accordion title="Commit chunked upload for envelopes">
  This endpoint commits a chunked upload in docusign, finalizing the upload process and preparing the uploaded content for use in other api calls. it should be used after all parts of a large document have been uploaded using the chunked upload method. the endpoint performs integrity checks on the uploaded content and, if successful, marks the chunked upload as ready for use. it's crucial to note that once committed, no additional parts can be added to the upload. this method is particularly useful when dealing with large documents that exceed standard upload size limits, allowing for more efficient handling of sizeable files in the docusign workflow.
</Accordion>

<Accordion title="Docusign Create Or Update User Authorizations">
  Creates or updates multiple user authorizations in docusign, allowing an agent user to perform specific actions on behalf of a principal user. this endpoint enables bulk management of user permissions, including sending, managing, signing, or editing documents. it's particularly useful for setting up or modifying access rights across multiple users efficiently. the endpoint requires account administrator privileges or must be called by the principal user themselves. note that for signing permissions, the account must have the 'allowdelegationsigning' setting enabled, and each principal user can only share signing permission with one agent user.
</Accordion>

<Accordion title="Docusign Create Preview Of Responsive Html In Envelope">
  Creates a preview of the responsive html versions of all documents in an envelope, allowing users to review how pdf documents will appear as responsive html across different device types before sending. this endpoint is particularly useful for ensuring document compatibility and readability on various screen sizes and devices, enhancing the signing experience for recipients. it leverages smart sections and display anchors to customize document appearance and behavior, including collapsible sections and responsive tables.
</Accordion>

<Accordion title="Create custom fields for envelope">
  This endpoint allows you to create or update custom fields for a specific docusign envelope. it is used to add or modify additional metadata to envelopes, which can be utilized for sorting, organizing, searching, and other downstream processes. the endpoint supports both list-type custom fields (with predefined options) and text-type custom fields (for free-form entry). this operation is applicable to draft and in-process envelopes only and should not be used for completed envelopes. custom fields added through this endpoint will be visible in the envelope settings section of the docusign console but will not be visible to envelope recipients.
</Accordion>

<Accordion title="Add contacts to contacts list">
  Adds multiple contacts to a user's contacts list in docusign. this endpoint allows for bulk addition of contacts with detailed information, including cloud provider details, phone numbers, email addresses, and notary-specific information. it's particularly useful for populating a user's address book efficiently or synchronizing contacts from external sources. the endpoint supports various contact types, including regular contacts, shared contacts, and signing groups. use this when you need to add or update multiple contacts simultaneously in a docusign account. note that while it can handle a variety of contact information, it does not provide functionality for removing or deactivating contacts.
</Accordion>

<Accordion title="Delete bcc email archive configuration">
  This endpoint deletes a bcc (blind carbon copy) email archive configuration from a specified docusign account. when invoked, it changes the status of the targeted configuration to 'closed' and immediately stops the archiving of docusign-generated email messages to the associated bcc email address. this operation is useful for managing email archiving settings, particularly when an archiving configuration is no longer needed or needs to be replaced. it's important to note that this action is irreversible, and once deleted, the specific configuration cannot be reactivated – a new one would need to be created if archiving is required again in the future. this endpoint should be used cautiously, as it will impact the email archiving process for the account.
</Accordion>

<Accordion title="Add existing brand to group">
  This endpoint adds one or more existing brands to a specified group in docusign. it allows users to associate multiple brands with a group, enabling customized branding for different groups within an account. the endpoint should be used when there's a need to update the brands associated with a particular group, such as when reorganizing branding strategies or expanding brand options for specific user groups. it's important to note that this endpoint only adds existing brands to a group and does not create new brands or modify brand details.
</Accordion>

<Accordion title="Add part to chunked upload">
  Adds a chunk or part to an existing chunked upload in docusign. this endpoint is used for uploading large files in smaller pieces, allowing for documents that exceed standard file size limits. it should be used after initiating a new chunked upload and uploading the first part. the method is particularly useful for handling large pdfs and other documents. it's important to note that parts should ideally be uploaded in sequential order, and the entire chunked upload must be completed and used within 20 minutes of initialization. this endpoint cannot replace already received parts or add to committed uploads.
</Accordion>

<Accordion title="Create template recipient preview url">
  This endpoint generates a url that allows senders to preview the experience of a specific recipient for a docusign template. it's useful for checking how the template will appear to the recipient before actually sending it. the preview url can be embedded in your application, enabling a seamless workflow for template creation and verification. this tool should be used when you need to validate the recipient's view of a template or when you want to provide a preview feature in your template management interface. note that this is specifically for templates and not for regular documents or envelopes.
</Accordion>

<Accordion title="Add envelope attachments">
  Adds one or more envelope attachments to a draft or in-process envelope in docusign. this endpoint allows developers to include additional files with an envelope that are not converted to pdf and are only accessible through the api. it's useful for attaching supporting documents or metadata files that should not be part of the main signing process. the endpoint supports up to 12 attachments per envelope, with a maximum file size of 50 mb each. note that these attachments are not visible in the docusign web application and are intended for programmatic use only.
</Accordion>

<Accordion title="Docusign Add Email Overrides To Envelope">
  Adds or modifies email override settings for a specific docusign envelope, allowing customization of the reply-to email address and name, as well as bcc email addresses for archiving purposes. this endpoint should be used when you need to change email settings for an individual envelope, overriding the account-level configurations. it's particularly useful for setting up specialized archiving or customizing the reply-to information for specific envelopes. note that these changes only affect email communications that occur after the addition is made, and the bcc feature is limited to users with appropriate permissions. for security reasons, additional signer authentication is recommended when using the bcc for email archive feature.
</Accordion>

<Accordion title="Add members to signing group">
  This endpoint adds one or more new members to a specified signing group within a docusign account. signing groups allow multiple users to act as potential signers for a document, where any member of the group can sign on behalf of the group. this tool should be used when you need to expand or update the membership of an existing signing group. the endpoint allows you to add up to 50 members to a signing group, which is the maximum limit. when adding members, you must provide their email addresses and usernames. it's important to note that docusign recommends separating signer recipients and non-signer recipients (such as carbon copy recipients) into different signing groups to maintain clarity in the signing process.
</Accordion>

<Accordion title="Docusign Create Template Responsive Html Preview">
  Creates a preview of the responsive html versions of all documents associated with a docusign template. this endpoint enables users to generate and customize the html preview of pdf documents across various device types before sending them for signing. it is particularly useful for ensuring that documents are easily readable and signable on different screen sizes and devices. the preview allows for fine-tuning of display settings, anchors, and other responsive elements to optimize the signing experience.
</Accordion>

<Accordion title="Add step to envelope workflow">
  This endpoint adds a new step to an existing envelope's workflow in docusign. it allows for the configuration of complex workflow rules, including delayed routing, conditional recipients, and specific actions based on envelope status or recipient actions. use this endpoint when you need to modify an envelope's workflow by adding additional steps or rules after the envelope has been created. this is particularly useful for implementing advanced routing logic or adding pauses in the signing process. the endpoint does not modify existing steps in the workflow; it only adds new ones.
</Accordion>

<Accordion title="Docusign Delete Connect Log Entries">
  Deletes a specified list of connect log entries for a docusign account. this endpoint is designed for account administrators to manage and clean up connect event logs. it should be used when you need to remove specific log entries, potentially for data management, privacy, or housekeeping purposes. the operation requires that connect be enabled on the account and that the user has account administrator privileges. it's important to note that this action is irreversible and will permanently remove the selected log entries, so it should be used with caution. the endpoint does not provide a way to retrieve or view the log entries before deletion, so ensure you have identified the correct entries to be deleted before using this function.
</Accordion>

<Accordion title="Delete connect failure log entry">
  Deletes one or all connect failure log entries for a specified docusign account. this endpoint is used for maintenance and cleanup of connect integration logs, allowing account administrators to remove specific failure records or clear all failure logs. it should be used when troubleshooting connect integration issues or performing routine log management. the endpoint requires account administrator privileges and connect must be enabled on the account. it's important to note that this operation is irreversible, so care should be taken when deleting log entries, especially when using the 'all' option.
</Accordion>

<Accordion title="Delete contact from account">
  Deletes a specific contact from a docusign account. this endpoint should be used when you need to remove a contact's information from an account's address book. it requires both the account id and the specific contact id to be provided. upon successful deletion, it returns an updated list of contacts for the account. this operation is irreversible, so it should be used with caution. the endpoint does not provide any confirmation or undo functionality, so ensure the correct contact id is specified before making the call.
</Accordion>

<Accordion title="Docusign Create Recipient Preview For Envelope">
  Creates a url for previewing the recipient's view of a draft envelope or template. this endpoint allows senders to simulate the recipient's experience by generating an embeddable preview url. it's useful for verifying the appearance and functionality of an envelope before sending it to recipients. the preview can help identify any issues with document layout, field placements, or signing order, ensuring a smooth signing experience for the recipients.
</Accordion>

<Accordion title="Delete custom document fields">
  Deletes custom document fields from an existing envelope document in docusign. this endpoint allows you to remove specific metadata or custom data strings associated with a document within an envelope. it's useful for updating or cleaning up custom information that is no longer relevant or needed. the operation is performed on a specific document within a specific envelope, identified by their respective ids. use this endpoint when you need to manage or update the custom fields of a document, ensuring that only necessary and current information is retained.
</Accordion>

<Accordion title="Delete connect oauth configuration">
  Deletes the connect oauth configuration for a specified docusign account. this endpoint is used to remove the oauth settings that allow docusign connect to securely integrate with other applications and send webhook notifications. it should be used when you need to disable or reconfigure the connect oauth integration for an account. this operation is irreversible and will immediately stop any active connect oauth-based integrations for the specified account. only account administrators can perform this action, and connect must be enabled on the account for this endpoint to work. it's important to note that this deletion only affects the oauth configuration for connect and does not impact other docusign integrations or the account itself.
</Accordion>

<Accordion title="Docusign Delete Enote Configuration">
  Deletes an existing enote configuration associated with a specific docusign account. this endpoint is part of the enoteconfigurations api and is currently in beta status. it should be used when you need to remove an enote configuration that is no longer needed or is incorrect. the operation is irreversible, so caution should be exercised before deletion. this endpoint only deletes the configuration; it does not affect any existing enotes or other account settings. be aware that as this is a beta api, it may be subject to changes or instability. always test thoroughly in a non-production environment before using in critical systems.
</Accordion>

<Accordion title="Create template workflow step">
  This endpoint adds a new workflow step to an existing docusign template. it allows users to define complex routing and conditional recipient rules within the template's workflow. the endpoint is used to create automated processes for document routing, including actions like pausing the workflow, implementing delayed sending, and setting up conditional recipient routing based on specific criteria. it's particularly useful for templates that require sophisticated, multi-stage approval or review processes. the created workflow step can control the timing and conditions under which documents are sent to different recipients, enhancing the flexibility and automation of the document signing process. however, users should be aware that the complexity of the workflow increases with each added step, and careful planning is required to ensure the desired document flow is achieved.
</Accordion>

<Accordion title="Add templates to document in envelope">
  This endpoint adds pre-configured templates to a specific document within an existing envelope in docusign. it allows you to apply standardized content, such as tabs and anchor text, from templates to documents, streamlining the process of preparing documents for signature. use this when you need to modify an existing envelope by incorporating template content into its documents. the endpoint is particularly useful for maintaining consistency across documents and automating the addition of necessary fields. note that applying templates may affect envelope recipients, depending on the template content and the 'preserve template recipient' parameter setting. this endpoint does not create new envelopes or documents; it only modifies existing ones.
</Accordion>

<Accordion title="Docusign Create Recipient Manual Review Link">
  Creates a url for manually reviewing a recipient's identity in docusign. this endpoint is used when automatic identity verification has failed and manual review is required. it returns a url that allows the sender to access a page for manually verifying the recipient's id. this method should only be used for recipients in workflows that support manual review and whose automatic verification has failed with a specific status code. the returned url is essential for completing the identity verification process in cases where automatic methods were insufficient.
</Accordion>

<Accordion title="Create account custom field">
  Creates a new custom field at the account level in docusign, making it available for all new envelopes associated with the account. this endpoint enables account administrators to define custom fields for enhanced envelope management and grouping. the created custom field can be of type 'text' or 'list', and can be set as required or optional. it's particularly useful for standardizing data collection across all envelopes within an account and can optionally be applied to existing templates.
</Accordion>

<Accordion title="Docusign Create Preview Of Responsive Html">
  Creates a preview of the responsive html version of a specific template document in docusign. this endpoint allows users to visualize how a pdf document will be converted to responsive html across various device types before sending it for signing. it's particularly useful for ensuring that template documents are properly formatted for responsive signing, enhancing the signing experience across different devices. the preview can be customized using various display settings and anchors, enabling users to create collapsible sections, responsive tables, and other interactive elements in the signing document.
</Accordion>

<Accordion title="Add users to existing group">
  Adds one or more existing docusign users to an existing group within a specified account. this endpoint is used to manage group memberships by adding users to a predefined group. it requires the account id and group id as path parameters, and accepts a list of user information in the request body. the operation returns detailed information about the added users and the result set. use this endpoint when you need to update group memberships or organize users into specific groups for access control or administrative purposes. note that this endpoint only adds existing users to a group; it does not create new users or groups.
</Accordion>

<Accordion title="Docusign Delete Custom Document Fields From Template">
  Deletes specified custom document fields from an existing template document in docusign. this endpoint is useful for maintaining and updating templates by removing unnecessary or outdated custom fields. it should be used when you need to clean up or modify the structure of a template document. the operation is irreversible, so caution should be exercised when using it. this endpoint only removes custom fields and does not affect other aspects of the template or document.
</Accordion>

<Accordion title="Delete custom tab information">
  Deletes a specified custom tab from a docusign account. this endpoint should be used when you need to remove a custom tab that is no longer needed or is obsolete. it permanently removes the custom tab from the account, so it should be used with caution. the operation requires both the account id and the specific custom tab id to ensure precise deletion. this endpoint is particularly useful for maintaining a clean and relevant set of custom tabs in your docusign account, especially when managing large numbers of custom fields. note that this operation cannot be undone, so it's advisable to confirm the deletion with the user before proceeding.
</Accordion>

<Accordion title="Add templates to envelope">
  This endpoint adds templates to an existing docusign envelope. it's used to apply pre-defined document templates, including content and settings, to standardize workflows. the operation can affect existing recipients based on the 'preserve template recipient' parameter. it's suitable for adding comprehensive template changes to an envelope, not for creating new envelopes or minor modifications.
</Accordion>

<Accordion title="Delete existing workspace logically">
  Logically deletes an existing workspace in docusign. this endpoint should be used when you need to remove a workspace from active use without permanently erasing its data. the deletion is logical, meaning the workspace is marked as deleted but can potentially be recovered if needed. this operation requires specific identification of the account and workspace, and returns detailed information about the deleted workspace upon success. use this endpoint with caution, as it will make the workspace inaccessible to users.
</Accordion>

<Accordion title="Create sender view url for envelope">
  Creates a url for the sender view of a docusign envelope, enabling the embedding of docusign ui within an external application. this endpoint is crucial for integrating envelope sending functionality, allowing users to prepare and send envelopes directly from your application. the returned url provides a customizable sender view for an envelope in the 'created' state, with options to tailor the user interface and behavior. it's important to note that the url must be used immediately after generation and is valid for only one use. the endpoint offers extensive customization options through the 'settings' object, allowing control over ui elements, button behaviors, and access levels. for mobile integrations, especially ios devices, it's recommended to use a webview instead of an iframe due to screen space limitations.
</Accordion>

<Accordion title="Delete custom user settings">
  Deletes specified custom user settings for a single docusign user. this endpoint allows for the removal of both grouped and ungrouped custom settings, providing flexibility in managing user preferences. it's particularly useful for cleaning up or resetting user-specific configurations within a docusign account. the operation requires careful use of parameters to ensure only intended settings are deleted, and it's important to note that users can only modify their own settings.
</Accordion>

<Accordion title="Docusign Delete Delayed Routing Rule For Envelope Step">
  This endpoint deletes the delayed routing object for a specific envelope's workflow step in docusign. it allows users to remove scheduled delays in the routing process of an envelope. the endpoint should be used when you need to cancel a planned delay in the envelope's workflow, but it cannot be called once the delay is already in progress. after deletion, the workflow step will still contain a 'pause before' action, requiring manual unpausing of the envelope when the step is reached. for complete removal of the step, use the deleteenvelopeworkflowstepdefinition endpoint instead. this tool is crucial for managing and adjusting envelope workflows in docusign, particularly when dealing with time-sensitive documents or when workflow changes are necessary.
</Accordion>

<Accordion title="Docusign Delete Envelope Email Settings">
  Deletes all existing email override settings for a specific envelope in docusign. this endpoint reverts the envelope's email configuration back to the account's default settings, affecting only future email communications. it's useful when you need to remove customized email settings for an envelope, such as reply-to address overrides or bcc recipients. the deletion is permanent and cannot be undone, so use with caution. this operation requires appropriate account permissions and should be used when standardizing email communications for an envelope or removing outdated customizations.
</Accordion>

<Accordion title="Docusign Delete Envelope Lock">
  The deleteenvelopelock endpoint removes the lock from a specified envelope in docusign, allowing it to be modified again. this operation is crucial for managing document workflows where temporary locks are used to prevent concurrent edits. the endpoint requires the x-docusign-edit header for authentication and can optionally save or discard changes made during the lock period. it's important to note that only the user who initially locked the envelope can delete the lock, ensuring security and consistency in the document management process.
</Accordion>

<Accordion title="Delete custom fields in template">
  This endpoint deletes specified custom fields from a docusign template. it allows users to remove both list and text custom fields that are no longer needed or relevant for the template. the operation is performed on a specific template identified by the templateid within a given docusign account specified by the accountid. users can selectively delete custom fields by providing arrays of listcustomfields and/or textcustomfields in the request body. if successful, the response will contain information about the remaining custom fields in the template. this endpoint is useful for maintaining and updating templates by removing outdated or unnecessary custom fields, thereby streamlining the document creation process.
</Accordion>

<Accordion title="Docusign Create Recipient View Url">
  Creates a url for embedding the docusign recipient view ui within an application, allowing users to sign documents directly in the app. this endpoint is specifically used for envelopes in the 'sent' status and generates a temporary url that expires after 5 minutes. it provides a seamless way to integrate electronic signature capabilities into your workflow, ensuring a secure and legally binding signing process. the method requires proper authentication of the recipient's identity and offers various customization options for the embedded experience.
</Accordion>

<Accordion title="Docusign Delete Envelope Custom Fields">
  This endpoint deletes envelope custom fields for draft and in-process envelopes in docusign. it allows users to remove both list custom fields (predefined options) and text custom fields (free-form text) associated with a specific envelope. the operation requires the account id and envelope id to identify the target envelope. after deletion, the endpoint returns the updated custom fields structure, reflecting the changes made. this functionality is useful for managing and updating envelope metadata, particularly for sorting, organizing, and searching envelopes or integrating with external systems like salesforce.
</Accordion>

<Accordion title="Delete delayed routing rules for template">
  Deletes the delayed routing rules for a specific template workflow step in docusign. this endpoint should be used when you need to remove timing or conditional routing logic from a template, allowing for immediate progression to the next step in the workflow. it's particularly useful when updating or simplifying complex template workflows. use with caution as this operation is irreversible and may impact the behavior of documents generated from this template in the future. this endpoint does not affect already sent envelopes or documents.
</Accordion>

<Accordion title="Add user signature and initials images">
  This endpoint allows you to add or update a user's signature and/or initials images in the docusign system. it supports both creating default signatures based on the user's name and uploading custom signature images. the endpoint can be used with either json or multipart form data, depending on whether you're creating a default signature or uploading custom images. it's particularly useful when setting up new users or updating existing user signatures. note that each update may generate a new signatureid, so applications should rely on the signature name for consistent identification.
</Accordion>

<Accordion title="Delete envelope transfer rule">
  Deletes a specific envelope transfer rule from a docusign account. this endpoint allows account administrators to remove previously created rules that automatically transfer ownership of envelopes between users. it should be used when a transfer rule is no longer needed or requires updating. the operation is permanent and cannot be undone, so caution should be exercised. this endpoint requires administrator privileges and the "transfer custody" feature to be enabled for the account. it will not provide information about the deleted rule or affect existing transferred envelopes.
</Accordion>

<Accordion title="Docusign Create Urlfor Template Edit View">
  Creates a url for embedding the docusign template edit view within an application. this endpoint enables developers to integrate docusign's template creation and editing functionality directly into their applications, allowing users to manage templates without leaving the app environment. the generated url provides access to the docusign template ui, where users can create, modify, and save templates. this method is particularly useful for applications that need to offer template management capabilities while maintaining a seamless user experience. it's important to note that this endpoint focuses solely on generating the url for template editing and does not handle the actual template modifications.
</Accordion>

<Accordion title="Delete envelope scheduled sending rules">
  Deletes the scheduled sending rules for a specific envelope's workflow in docusign. this endpoint should be used when you need to cancel or remove previously set rules for scheduled sending of an envelope. it's particularly useful for managing automated document workflows where timing adjustments are necessary. the operation is irreversible and should be used with caution. importantly, this endpoint cannot be called once the scheduled sending countdown has begun, limiting its use to the period before the scheduled send time approaches. this tool helps in maintaining flexibility in document scheduling within the docusign system.
</Accordion>

<Accordion title="Delete envelope workflow definition">
  This endpoint deletes the workflow definition for a specified envelope in docusign. it's used to remove any scheduled or automated processes associated with the envelope, such as delayed sending or routing. when called, it cancels any scheduled send and resets the envelope status to 'created'. this is useful for modifying envelopes that were set up with automated workflows but now require changes. after deletion, to send the envelope, you must update its status to 'sent' using a separate envelopes::update method. use this endpoint cautiously, as it will remove all workflow settings for the envelope and cannot be undone.
</Accordion>

<Accordion title="Create signing group">
  Creates one or more signing groups in a docusign account. this endpoint allows account administrators to set up predefined groups of recipients for document signing. multiple signing groups can be created in a single api call, enhancing efficiency in setting up complex signing workflows. use this when you need to establish teams or departments that can collectively receive and sign documents, with any member able to sign on behalf of the group.
</Accordion>

<Accordion title="Docusign Apply Action To Bulk Send Envelopes">
  This endpoint allows users to apply specific actions (resend, correct, or void) to all envelopes within a specified docusign bulk send batch. it's designed for managing large-scale document signing processes efficiently, enabling users to update the status or take action on multiple envelopes simultaneously. this tool is particularly useful when you need to resend failed envelopes, correct errors in a batch of envelopes, or void an entire batch of envelopes. it should be used carefully, as the actions applied will affect all envelopes in the specified batch.
</Accordion>

<Accordion title="Docusign Delete Brand From Group">
  This endpoint allows users to delete one or more brands from a specified group within a docusign account. it is used to manage brand associations with groups, enabling customization of branding for different envelopes and signing experiences. the operation removes the specified brands from the group, updating the group's brand configurations. use this endpoint when you need to disassociate brands from a particular group, such as during reorganization or brand consolidation processes. note that this action does not delete the brands from the account entirely, but only removes their association with the specified group.
</Accordion>

<Accordion title="Docusign Create User Authorization For Agent User">
  Creates a user authorization in docusign, enabling an agent user to perform specific actions on behalf of a principal user within the same account. this endpoint is essential for setting up delegated access, allowing users to share envelope management, signing, or sending capabilities. it's particularly useful for streamlining workflow processes in scenarios where one user needs to act on behalf of another, such as an assistant managing documents for an executive. the authorization can be time-bound and is subject to account-level permissions. note that only account administrators or the principal user can create these authorizations, and each principal can only share signing permission with one agent user at a time.
</Accordion>

<Accordion title="Delete page from template document">
  Deletes a specific page from a document within a docusign template. this endpoint allows you to remove a single page from a template document, which can be useful for updating or refining existing templates. use this when you need to modify the structure of a template by removing unnecessary or outdated pages. note that this operation is irreversible, so ensure you have a backup or are certain about deleting the page. this tool only deletes a single page at a time and does not provide options for bulk page deletion or document replacement.
</Accordion>

<Accordion title="Delete notary jurisdiction">
  Deletes a specified notary jurisdiction from the docusign system. this endpoint should be used when you need to remove a notary jurisdiction from your docusign account, typically when a notary is no longer active in a particular jurisdiction or when correcting erroneously added jurisdictions. the operation is irreversible, so it should be used with caution. it's important to note that this endpoint only deletes the jurisdiction and does not affect the notary's overall status or their ability to operate in other jurisdictions. the endpoint supports a limited set of jurisdictions, primarily u.s. states, and will return an error if an unsupported jurisdiction id is provided. after successful deletion, any attempts to use the deleted jurisdiction for notary activities will fail.
</Accordion>

<Accordion title="Delete page from document in envelope">
  Deletes a specific page from a document within an envelope in docusign. this endpoint allows you to remove a single page from a document based on its page number. it's useful for modifying documents after they've been added to an envelope but before the envelope has been sent for signing. this operation is permanent and cannot be undone, so it should be used with caution. the endpoint requires specific identification of the account, envelope, document, and page number to ensure precise targeting of the deletion operation.
</Accordion>

<Accordion title="Delete one or more signing groups">
  Deletes one or more signing groups from a specified docusign account. this endpoint allows for bulk deletion of signing groups, which are collections of users authorized to sign documents on behalf of the group. it should be used when you need to remove outdated or unnecessary signing groups from your account. the operation is irreversible, so caution should be exercised when using this endpoint. it's important to note that this action does not delete the individual users within the groups, only the group associations.
</Accordion>

<Accordion title="Delete draft envelope attachments">
  Deletes one or more envelope attachments from a draft envelope in docusign. this endpoint allows users to remove attachments that are no longer needed or were added in error before the envelope is sent. it's important to note that this operation only works on draft envelopes and is distinct from managing signer attachments. the endpoint supports deleting multiple attachments in a single request, making it efficient for bulk operations. as this is a beta api, it may be subject to changes in future versions.
</Accordion>

<Accordion title="Delete account brand">
  This endpoint deletes a specific brand from a docusign account. it should be used when you need to permanently remove a brand configuration from an account, such as when a brand is no longer needed or has been replaced. the operation requires that branding for either signing or sending (or both) is enabled for the account. this is indicated by the account settings 'canselfbrandsend' or 'canselfbrandsign' being set to true. the deletion is irreversible, so it should be used with caution. if successful, the brand will be completely removed from the account and can no longer be applied to documents or emails. this endpoint does not return the deleted brand details; it only confirms the successful deletion or returns an error if the operation fails.
</Accordion>

<Accordion title="Docusign Delete Multiple Contacts From Account">
  Deletes multiple contacts associated with a specific docusign account. this endpoint allows for bulk removal of contacts from an account's address book, streamlining contact management operations. it's particularly useful for cleaning up outdated or unnecessary contacts, or when reorganizing large contact lists. the endpoint accepts a list of contact ids and returns details of the deleted contacts or error information if the deletion was unsuccessful for any contact. note that this operation is irreversible, so it should be used with caution. it's recommended to verify the contacts to be deleted before making the api call.
</Accordion>

<Accordion title="Delete members from signing group">
  Removes one or more members from a specified docusign signing group. this endpoint allows you to manage the composition of your signing groups by deleting users who no longer need access. it should be used when you want to remove specific individuals from a signing group, such as when an employee leaves the organization or changes roles. the endpoint requires the account id and signing group id to identify the correct group, and accepts a list of users to be removed. it's important to note that this operation is irreversible, so care should be taken to ensure the correct users are being removed. this endpoint does not provide the ability to add new members or modify existing member information.
</Accordion>

<Accordion title="Delete signature for captive recipients">
  This endpoint deletes the signature for one or more captive (embedded) recipient records in docusign. it is primarily designed for testing purposes, allowing developers to reset the signature associated with a client user id. this enables the creation of a new signature the next time the client user id is used. the endpoint should be used when testing signature workflows or when it's necessary to clear existing signatures for embedded recipients. it's important to note that this operation is not intended for regular production use and should be employed cautiously, as it permanently removes signature data. the endpoint requires specifying the account id and confirming that the operation is for the 'signature' part of the recipient information. the request body should include details of the captive recipients whose signatures are to be deleted, primarily identified by their clientuserid.
</Accordion>

<Accordion title="Delete request log files">
  Deletes all request log files associated with the docusign api. this endpoint is part of the diagnostics service and is used for maintenance and troubleshooting purposes. it should be used when you need to clean up or remove accumulated request logs, which can help in managing storage and maintaining system performance. the operation does not require any parameters and will delete all available request logs. use this endpoint with caution, as deleted logs cannot be recovered. it's recommended to backup any critical log data before performing this operation.
</Accordion>

<Accordion title="Docusign Create Template Document Custom Fields">
  This endpoint creates custom document fields in an existing docusign template. it allows users to add both list-type and text-type custom fields to enhance template functionality and capture additional data during the envelope creation and sending process. the endpoint is useful for customizing templates with specific metadata requirements or for integrating with external systems like salesforce. it should be used when templates need to be enhanced with custom data entry options or when preparing templates for specific workflows that require additional information.
</Accordion>

<Accordion title="Delete powerform by id">
  This endpoint deletes a specific powerform identified by its unique id within a docusign account. powerforms are pre-configured document templates that can be accessed via a custom url, allowing for easy collection of signatures and form data. use this endpoint when you need to permanently remove a powerform from your account, such as when it's no longer needed or has been replaced by a new version. be cautious when using this endpoint, as the deletion is irreversible and will remove all associated data and access to the powerform. ensure you have the correct powerform id and account context before proceeding with the deletion to avoid unintended data loss. this operation is typically used for maintenance, compliance, or organizational purposes within your docusign account management workflow.
</Accordion>

<Accordion title="Delete specific connect log entry">
  Deletes a specified entry or all entries from the docusign connect log for a given account. this endpoint is crucial for managing and cleaning up connect logs, which contain records of events and updates in esignature workflows. it should be used when you need to remove specific log entries, perhaps for data management or privacy reasons, or when you want to clear all logs for an account. the operation requires account administrator privileges and the connect feature must be enabled on the account. it's important to note that this action is irreversible, so use it with caution, especially when deleting all logs.
</Accordion>

<Accordion title="Delete stamp image for account">
  This endpoint deletes a specific stamp image associated with an account signature in docusign. it is used to remove the visual representation of a stamp from a user's account, which can be useful for updating or removing outdated stamps. the endpoint requires the account id, the type of image being deleted (stamp, signature, or initials), and the specific signature id. it's important to note that this action is irreversible, so it should be used with caution. the endpoint will return detailed information about the signature after deletion, including any remaining associated images and properties. this tool should be used when a user needs to remove a stamp image from their account, but not when they want to modify or update an existing stamp image.
</Accordion>

<Accordion title="Delete specified account">
  Deletes (closes) a specified docusign account. this operation permanently closes the account and can only be performed by an account admin. once an account is closed, it cannot be reopened by users and must be reactivated by docusign support. use this endpoint with caution as it has significant implications for access to documents and user data associated with the account. the optional redact user data parameter allows for additional data privacy measures during deletion. this endpoint should be used when an organization needs to completely shut down their docusign account, such as when ceasing operations or consolidating multiple accounts.
</Accordion>

<Accordion title="Docusign Delete Template From Envelope Document">
  This endpoint deletes a specified template from a document within an existing envelope in docusign. it allows users to remove a template that has been previously applied to a document, providing flexibility in managing document content and structure. this operation is useful when you need to update or modify the document by removing a specific template, perhaps to replace it with a different one or to revert the document to its original state. it's important to note that this action is permanent and cannot be undone, so it should be used with caution. this endpoint is particularly valuable in workflows where document templates need to be dynamically managed or updated based on changing requirements or corrections.
</Accordion>

<Accordion title="Delete account custom field">
  Deletes an existing account custom field from a docusign account. this endpoint should be used when you need to remove a custom field that is no longer required or relevant for your account. it permanently removes the custom field, so use with caution. the deletion can optionally be applied to templates as well. this operation is part of the account management functionality and affects how custom metadata can be used in future envelope creations.
</Accordion>

<Accordion title="Docusign Delete Brand Logo By Type">
  This endpoint deletes a specific logo from an account brand in docusign. it allows users to remove primary, secondary, or email logos associated with their brand, helping maintain brand consistency across docusign documents. the endpoint should be used when updating or removing branding elements from a docusign account. note that branding for either signing or sending must be enabled for the account (canselfbrandsend, canselfbrandsign, or both must be true) for this endpoint to function properly. this operation is irreversible, so caution should be exercised when using it.
</Accordion>

<Accordion title="Delete scheduled sending rules">
  Deletes all scheduled sending rules associated with a specific docusign template's workflow. this endpoint should be used when you need to remove automated sending schedules for a template, reverting it to manual sending only. it's particularly useful for updating or removing outdated scheduling configurations. be cautious when using this endpoint, as it permanently removes all scheduled sending rules for the specified template, and this action cannot be undone. ensure that you have the correct template id and that removing the scheduled sending is indeed the intended action, as it may impact automated document workflows within your organization.
</Accordion>

<Accordion title="Delete connect configuration">
  Deletes a specified docusign connect configuration from the given account. this endpoint should be used when you need to remove an existing connect integration setup. it requires account administrator privileges and that connect is enabled on the account. the operation is irreversible, so use with caution. this endpoint doesn't return the deleted configuration details; it only confirms successful deletion or returns an error.
</Accordion>

<Accordion title="Delete template lock">
  Deletes the lock from a specified template in docusign. this endpoint allows users to remove a lock they previously placed on a template, with the option to save or discard changes made during the lock period. it should be used when a user wants to release their lock on a template, either after making changes or deciding to abandon modifications. the endpoint requires the user deleting the lock to be the same user who initially locked the template, ensuring security and preventing unauthorized lock removals. it's important to note that this operation requires the x-docusign-edit header for authentication.
</Accordion>

<Accordion title="Delete chunked upload">
  Deletes a chunked upload that has been committed but not yet consumed in the docusign system. this endpoint is useful for managing large file uploads and maintaining quota efficiency. it should be used when a chunked upload is no longer needed and hasn't been used in other api calls. the endpoint cannot delete chunked uploads that have already been consumed or those that have expired. it's recommended to explicitly delete unused chunked uploads rather than waiting for automatic expiration to manage your quota effectively. note that this api is currently in beta status and may be subject to changes.
</Accordion>

<Accordion title="Delete brand profiles">
  This endpoint allows you to delete one or more brand profiles from a docusign account. it is used to remove custom branding configurations that are no longer needed. the method requires either the 'canselfbrandsign' or 'canselfbrandsend' setting to be enabled for the account. it's important to note that this operation is irreversible, so care should be taken when using this endpoint. the response provides detailed information about the deleted brands, including their ids, names, and associated resources.
</Accordion>

<Accordion title="Delete account permission profile">
  This endpoint deletes a specific permission profile from a docusign account. it is used to remove outdated or unnecessary permission profiles, helping to streamline account management. the endpoint requires that the profile being deleted has no associated users, unless they are being reassigned to a new profile. it's particularly useful when restructuring account permissions or during account cleanup processes. the method will fail if there are associated users and no reassignment is specified. it's important to note that this action is irreversible, so caution should be exercised when using this endpoint. this endpoint should not be used for temporary permission changes; instead, it's meant for permanent removal of a permission profile.
</Accordion>

<Accordion title="Create custom fields in template document">
  Creates custom document fields in an existing template document within docusign. this endpoint allows users to add metadata to specific documents in a template, enhancing document management and workflow customization. it is particularly useful for prepopulating custom data fields that will be applied to all new envelopes created using this template. the endpoint requires the account id, document id, and template id to identify the exact document within a specific template. custom fields are added as name-value pairs, allowing for flexible metadata structuring within the constraints of docusign's field limitations.
</Accordion>

<Accordion title="Add or update user custom settings">
  Adds or updates custom user settings for a specified docusign user. this endpoint allows for flexible storage and retrieval of user-specific information that can be used in your own system, separate from standard docusign account settings. it supports grouping of settings using the x-docusign-user-settings-key header for more organized management. the endpoint has a 4,000 character limit for all custom settings per user, including xml and json structure.
</Accordion>

<Accordion title="Create Envelope From Template">
  Creates and sends an envelope using a template. allows multiple recipients with different roles and routing orders.
</Accordion>

<Accordion title="Delete account stamp">
  Deletes a specific account stamp (signature) from a docusign account. this endpoint should be used when you need to permanently remove a stamp from an account, such as when it's no longer needed or has been replaced. the operation is irreversible, so use it with caution. it's particularly useful for maintaining account hygiene by removing outdated or unused stamps. note that this endpoint only deletes the stamp; it does not affect any documents that may have already been signed using this stamp.
</Accordion>

<Accordion title="Docusign Create Groups For Account">
  Creates one or more groups for a specified docusign account. this endpoint is used for managing user access and permissions by organizing users into groups. groups can be associated with permission profiles to streamline user management for large numbers of users. the endpoint accepts an array of group objects, each containing a group name and optionally a permission profile id. it's particularly useful for setting up new organizational structures, managing template access, or preparing for bulk user management. note that only the 'groupname' and 'permissionprofileid' properties are used in the request; all other properties in the group objects are ignored. to associate permission profiles with groups, you need to first obtain the permission profile ids using the accountpermissionprofiles: list endpoint.
</Accordion>

<Accordion title="Docusign Create Idproof Resource Token For Recipient">
  Creates a resource token that allows a sender to retrieve identification data for a specific recipient using docusign's id evidence api. this endpoint is part of the envelope recipient management process and is specifically designed for identity verification purposes. it should be used when a sender needs to access and verify a recipient's identification information securely. the generated token provides a controlled and time-limited access to the recipient's id data, enhancing security in the document signing process. this api is currently in beta, which means it may undergo changes and its usage might be subject to limitations or additional scrutiny. the endpoint does not directly provide the identification data but instead returns the necessary credentials (resource token and base uri) to access it through the id evidence api.
</Accordion>

<Accordion title="Docusign Create Bcc Email Archive Configuration">
  Creates a bcc email archive configuration for a docusign account, enabling automatic archiving of docusign-generated emails. this endpoint allows you to set up a bcc email address that will receive copies of all docusign notifications for the specified account. it's particularly useful for organizations that need to maintain comprehensive email records for compliance or auditing purposes. the method supports adding one bcc email address at a time, with a limit of up to five active and pending email archive addresses per account.
</Accordion>

<Accordion title="Create bulk send request">
  This endpoint initiates a bulk send process for docusign, allowing users to send a single envelope or template to multiple recipients efficiently. it uses an existing bulk send list and a specified envelope or template to create a batch of envelopes for distribution. the endpoint is ideal for scenarios requiring large-scale document distribution, such as sending contracts to numerous clients or distributing company-wide notices. it's recommended to test the compatibility of the bulk send list with the envelope using the createbulksendtestrequest method before actual sending. upon successful queuing, a batchid is provided for tracking the status of the bulk send operation. note that this process is asynchronous, and the entire batch is queued for processing rather than individual envelopes.
</Accordion>

<Accordion title="Delete envelope workflow step">
  Deletes a specific workflow step from an envelope in docusign. this endpoint allows you to remove a single step from an envelope's workflow definition, potentially altering the envelope's processing lifecycle. use this when you need to modify an envelope's workflow by removing unnecessary or outdated steps. it's particularly useful for simplifying complex workflows or correcting mistakenly added steps. be cautious when using this endpoint, as deleting a workflow step is irreversible and may impact the envelope's processing sequence. ensure you have the correct workflowstepid before proceeding with the deletion to avoid unintended consequences.
</Accordion>

<Accordion title="Create brand profiles for account">
  This endpoint creates brand profile files for a docusign account, customizing visual and textual elements. it allows setting company name, languages, colors, and landing pages. use it for new branding or major changes. requires 'canselfbrandsign' or 'canselfbrandsend' enabled. logos must be added separately. supports multiple brands and locales.
</Accordion>

<Accordion title="Create bulk send test request">
  This endpoint creates a bulk send test request to validate the compatibility between a bulk send list and an envelope or template for docusign's bulk sending feature. it performs comprehensive checks on envelope state, recipients, tabs, and custom fields to ensure a successful bulk send operation. use this endpoint before initiating an actual bulk send to identify and resolve any potential issues. the test returns a boolean indicating whether the send can proceed, along with detailed validation error information if applicable. this endpoint is essential for maintaining the integrity and efficiency of bulk sending processes in docusign.
</Accordion>

<Accordion title="Docusign Create Document Responsive Html Preview">
  Creates a preview of the responsive html version of a specific document within a docusign envelope. this endpoint allows users to visualize how a pdf document will appear as responsive html across various device types before sending it for signature. it's particularly useful for ensuring optimal document presentation and user experience across different screen sizes and devices. the preview can help identify any formatting issues or display problems that may occur during the conversion process, allowing for adjustments before the document is finalized and sent to recipients.
</Accordion>

<Accordion title="Docusign Create Custom Tab With Properties">
  Creates a custom tab with pre-defined properties for use in docusign envelopes. this endpoint allows users to define reusable tab types with specific configurations such as font styles, validation patterns, and positioning rules. custom tabs can be created for various field types including text, checkboxes, radio buttons, and signature fields. this tool is particularly useful for standardizing frequently used tab configurations across multiple documents and improving efficiency in envelope creation.
</Accordion>

<Accordion title="Docusign Add Or Update User Signature">
  This endpoint allows you to add or update a user's signature in docusign. it provides comprehensive management of signature properties, including the signature image, font, initials, and stamp details. use this endpoint when you need to create a new signature for a user or modify an existing one. the endpoint supports various signature types (standard signatures, initials, and stamps) and allows for detailed customization of signature appearance and behavior. it's particularly useful for maintaining up-to-date and personalized signature information for docusign users. note that users can only manage their own signatures; even users with admin rights cannot modify another user's signature settings.
</Accordion>

<Accordion title="Docusign Create Notary Jurisdiction Object">
  Creates a new notary jurisdiction object in the docusign system. this endpoint is used to register or update information about a notary's commission, including their jurisdiction, seal type, and specific details required by different states. it supports multiple us jurisdictions and allows for detailed configuration of notary seals and commission information. the created object serves as a record of the notary's authority and defines how they can operate within the docusign platform for electronic notarization. this endpoint should be used when onboarding new notaries or updating existing notary information in the system. it's important to note that the jurisdiction object is read-only once created, so accurate information should be provided during the initial creation.
</Accordion>

<Accordion title="Docusign Close Users In Account">
  Closes one or more users in a docusign account, preventing them from accessing account features without permanently deleting them. this endpoint is useful for temporarily disabling user access, such as when an employee is on leave or has changed roles. it allows for easy re-activation of users through the users:update method. the operation affects multiple users in a single request, streamlining bulk user management tasks.
</Accordion>

<Accordion title="Create custom document fields in envelope">
  Creates custom document fields in an existing envelope document within docusign. this endpoint allows you to add metadata to specific documents in an envelope, which can be used for tracking, sorting, and reporting purposes. it's particularly useful when you need to associate additional information with a document that isn't captured by standard docusign fields. the custom fields are not used by docusign for processing but are returned in the envelope status. this endpoint should be used after an envelope has been created and when you need to add or update custom metadata for a specific document within that envelope.
</Accordion>

<Accordion title="Create a collaborative workspace">
  This endpoint creates a new collaborative workspace in docusign, providing a shared area for document management and workflow collaboration. it should be used when setting up a new project or team that requires a centralized space for file sharing and collaborative work. the workspace creation process includes specifying workspace details, settings, and initial user information. note that this endpoint only creates the workspace; adding members and files are separate operations.
</Accordion>

<Accordion title="Docusign Add Or Update Account Stamps">
  This endpoint allows you to add or update one or more account stamps in a docusign account. it provides a comprehensive way to manage signature and stamp settings, including image properties, user associations, and stamp-specific details. use this endpoint when you need to create new stamps or modify existing ones for an account. it's particularly useful for bulk operations on multiple stamps. note that this endpoint doesn't handle the actual process of signing documents, but rather manages the stamps available for use in the signing process.
</Accordion>

<Accordion title="Create connect configuration for account">
  This endpoint creates a custom connect configuration for a specified docusign account, enabling webhook notifications for envelope and recipient events. it allows users to set up real-time updates for esignature workflows without the need for polling. the configuration can be customized for different delivery modes, data formats, and event triggers, providing flexibility in how and when notifications are received.
</Accordion>

<Accordion title="Add new users to a specified account">
  This endpoint adds new users to a specified docusign account, allowing bulk creation of up to 500 users in a single call. it's ideal for quickly setting up multiple users with customized permissions and settings. the endpoint requires at least a username and email for each user, but supports additional configuration options. it returns detailed information about created users, including ids and status.
</Accordion>

<Accordion title="Docusign Change Users In Account">
  This endpoint allows you to update information for one or more users within a docusign account. it is used to modify various user attributes such as personal information, settings, permissions, and notification preferences. the endpoint is particularly useful for account administrators who need to manage multiple users or update specific user settings en masse. it can handle updates for a single user or batch updates for multiple users in one request. the endpoint provides granular control over user settings, allowing for detailed customization of user profiles and permissions within the docusign environment. however, it's important to note that some settings may be limited by the account's plan or the user's role within the organization.
</Accordion>

<Accordion title="Docusign Create New Account Permission Profile">
  This endpoint creates a new permission profile for a docusign account, defining specific sets of permissions for user groups. it allows administrators to establish role-based access control within their docusign environment. the profile controls a wide range of user capabilities, from basic envelope sending to advanced account management functions. use this endpoint when setting up new roles or modifying existing permission structures. note that creating a profile doesn't automatically assign users to it; separate actions are required for user assignment.
</Accordion>

<Accordion title="Delete user profile image">
  Deletes the profile image of a specified user within a docusign account. this endpoint should be used when a user wants to remove their current profile picture from their docusign account. it's important to note that this operation can only be performed by the user on their own profile; even users with admin rights cannot delete another user's profile image. the endpoint requires both the account id and the user id to be specified, ensuring that the operation is performed on the correct user within the correct account. after successful deletion, the user's profile will no longer have an associated image. this endpoint does not provide the ability to upload a new image; it only removes the existing one.
</Accordion>

<Accordion title="Docusign Delete User Authorizations">
  The deleteuserauthorizations endpoint is used to remove one or more user authorizations for a specified principal user within a docusign account. this tool allows account administrators or the principal user themselves to revoke specific permissions or access rights previously granted to the user. it's particularly useful for managing user access control, updating user roles, or removing outdated permissions. the endpoint requires the account id and user id to be specified, along with a list of authorization ids to be deleted. it returns a detailed response indicating the success or failure of each deletion attempt, including any error messages. this endpoint should be used cautiously as it directly impacts user access within the docusign system.
</Accordion>

<Accordion title="Delete user cloud storage authentication">
  This endpoint deletes the user authentication information for a specified cloud storage provider in docusign. it's used to remove the stored credentials that allow a user to access their cloud storage within the docusign platform. after deletion, the next time the user attempts to access this cloud storage provider through docusign, they will need to go through the full authentication process again. this endpoint is particularly useful for security purposes, such as when you need to revoke access or troubleshoot authentication issues. it's important to note that this operation only affects the specified user and cloud storage provider combination, and does not impact other users or other cloud storage integrations for the same user.
</Accordion>

<Accordion title="Delete users from group">
  Deletes one or more users from a specified group within a docusign account. this endpoint allows for bulk removal of users from a group, streamlining group management operations. it requires the account id, group id, and a list of users to be deleted. the endpoint is useful for maintaining group memberships, such as when employees leave a company or change roles. it returns detailed information about the deleted users and the operation's success. note that this operation permanently removes users from the specified group and should be used cautiously.
</Accordion>

<Accordion title="Delete template workflow step">
  Deletes a specific workflow step from a template's workflow definition in docusign. this endpoint allows users to customize and refine their document workflows by removing individual steps from existing templates. it should be used when modifying the structure of a template's workflow, such as removing an unnecessary approval step or simplifying the signing process. the operation is permanent and cannot be undone, so users should exercise caution when deleting workflow steps. this endpoint is particularly useful for maintaining and optimizing document workflows in response to changing business processes or requirements.
</Accordion>

<Accordion title="Delete user initials or signature image">
  This endpoint deletes a specified initials image or signature image for a user in docusign. it allows users to remove either their initials image or signature image from their docusign account. the endpoint should be used when a user wants to update or remove their existing signature or initials image. it's important to note that this endpoint can only delete one type of image per call - to delete both initials and signature images, the endpoint must be called twice. the endpoint requires user authentication and can only be used to delete the authenticated user's own images. the response includes detailed information about the user's signature, including creation date, image uris, and signature properties.
</Accordion>

<Accordion title="Delete user authorization">
  Deletes a specific user authorization within the docusign system. this endpoint is used to revoke or remove permissions previously granted to a user. it requires either account administrator privileges or being the principal user of the specified authorization. the operation is irreversible, so it should be used cautiously. this tool is particularly useful for managing access control and maintaining security by removing outdated or unnecessary user permissions. it does not provide information about existing authorizations or create new ones; it solely focuses on deletion.
</Accordion>

<Accordion title="Docusign Get Envelope Workflow Delayed Routing Definition">
  Retrieves the delayed routing rules for a specific workflow step within a docusign envelope. this endpoint allows users to access information about when and how an envelope is scheduled to be sent to recipients associated with a particular workflow step. it's useful for checking the current delay settings, scheduled send time, and status of a delayed routing step. the endpoint returns detailed information about the resume date, delay rules, and current status of the delayed routing. it should be used when you need to verify or inspect the delayed routing configuration for a specific envelope and workflow step. note that this endpoint will return a 404 error if the specified workflow step does not have a delayed routing object associated with it.
</Accordion>

<Accordion title="Get api request log settings">
  Retrieves the current api request logging settings for the authenticated user in docusign. this endpoint provides information about whether api request logging is enabled, the maximum number of log entries allowed, and the remaining number of entries that can be logged. it is useful for developers and administrators who need to monitor or troubleshoot api usage, manage log storage, or ensure compliance with logging policies. the endpoint should be used when you need to check the current state of api request logging or verify remaining log capacity. it does not modify any settings or create new log entries.
</Accordion>

<Accordion title="Docusign Get Page Image From Envelope">
  Retrieves an image of a specific page from a document within a docusign envelope. this endpoint is used to fetch a visual representation of a document page, which can be useful for previewing or displaying document contents without accessing the full document. the returned image is in png format and can be customized in terms of resolution and dimensions. this tool is ideal for applications that need to show document previews or allow users to view specific pages of a document without downloading the entire file. it should not be used for document modification or to extract text content from the document.
</Accordion>

<Accordion title="Get signing group information">
  Retrieves comprehensive information about a specific signing group, including details about its members. this endpoint is essential for managing and auditing signing groups within a docusign account. it provides valuable data such as the group's creation date, email, name, type, and a list of all members with their respective email addresses and usernames. use this endpoint when you need to inspect the composition and properties of a particular signing group, which is crucial for maintaining accurate records and ensuring proper configuration of e-signature workflows involving group-based signers. the endpoint is particularly useful for administrative tasks, troubleshooting, or when integrating signing group functionality into custom applications. note that this endpoint only returns information for 'sharedsigninggroup' types and does not modify any existing data.
</Accordion>

<Accordion title="Docusign Get Electronic Disclosure For Recipient">
  Retrieves the html-formatted electronic record and signature disclosure (ersd) for a specific envelope recipient in docusign. this endpoint allows you to obtain the customized disclosure that may differ from the account-level disclosure based on the signing brand applied to the envelope and the recipient's language settings. it is particularly useful when you need to present the exact disclosure that a recipient will see before they sign a document, ensuring compliance with electronic signature regulations and providing transparency in the signing process.
</Accordion>

<Accordion title="Delete workflow definition for template">
  Deletes the workflow definition associated with a specific template in docusign. this endpoint is used to remove any existing workflow settings from a template, such as scheduled sending or delayed routing. it's particularly useful when you need to reset a template's workflow or prepare it for new workflow configurations. the operation is idempotent, meaning it will return a successful response even if the template doesn't have a workflow definition. this feature allows for safe, repeated calls without causing errors.
</Accordion>

<Accordion title="Docusign Delete User Group">
  Deletes one or more existing user groups from a specified docusign account. this endpoint should be used when you need to remove user groups that are no longer needed or have become obsolete. it requires the account id and the group id(s) of the group(s) to be deleted. the operation is irreversible, so use it with caution. this endpoint only deletes the group itself and does not affect the individual users who were members of the group. after deletion, any permissions or settings associated with the group will no longer apply to its former members.
</Accordion>

<Accordion title="Docusign Get Specific Brand Resource File">
  Retrieves a specific branding resource file for customizing docusign experiences. this endpoint allows users to access and manage brand resource files that control sending, signing, email, and captive (embedded) signing experiences. it's particularly useful when you need to retrieve customized branding elements or the master resource file for a specific brand within an account. the endpoint supports localization and can return either the full master resource file or only the modified elements, depending on the parameters used. note that this endpoint requires branding to be enabled for the account (either for sending, signing, or both).
</Accordion>

<Accordion title="Docusign Get Agent User Authorizations">
  Retrieves user authorizations for a specified agent user within a docusign account. this endpoint allows you to fetch detailed information about the permissions granted to an agent user to act on behalf of other users in the account. it's particularly useful for managing and auditing user access levels, especially in larger organizations with complex permission structures. the endpoint supports various filtering options and pagination, enabling efficient retrieval of specific authorization data.
</Accordion>

<Accordion title="Docusign Delete User Auth For Cloud Storage Providers">
  This endpoint deletes the user authentication information for one or more cloud storage providers associated with a specific docusign user account. it's used to revoke access to connected cloud storage services, requiring the user to re-authenticate the next time they attempt to access these providers through docusign. this operation is particularly useful for managing security, updating integrations, or removing unused cloud storage connections. the endpoint requires specific account and user identifiers and accepts a list of storage providers to be affected. it's important to note that this action only removes the authentication link within docusign and does not affect the user's actual account with the cloud storage provider.
</Accordion>

<Accordion title="Docusign Get Pdftranscript Of Envelope Comments">
  Retrieves a pdf transcript containing all comments added by senders and recipients to documents within a specific envelope in a docusign account. this endpoint is useful for obtaining a comprehensive record of all discussions and annotations related to the documents in an envelope. it should be used when a consolidated view of all comments is needed, such as for review, auditing, or record-keeping purposes. the response is a pdf file returned as a byte stream, which can be saved or processed as needed. note that the comments feature must be enabled in the account settings (set 'enablesigningextensioncomments' to true in accountsettingsinformation) for this endpoint to function. this tool does not provide individual comments or allow for adding or modifying comments.
</Accordion>

<Accordion title="Docusign Get Specified Account Stamp Info">
  Retrieves detailed information about a specific account stamp (signature) in docusign. this endpoint allows users to fetch comprehensive data about a signature, including its creation and modification dates, image uris, associated users, and formatting details. it's particularly useful when you need to access or verify the properties of a specific signature within an account. the endpoint provides a wealth of information but requires both the account id and the specific signature id to function.
</Accordion>

<Accordion title="Docusign Get Electronic Record And Signature Disclosure">
  Retrieves the html-formatted electronic record and signature disclosure (ersd) associated with a specific docusign account. this endpoint allows you to fetch the current version of the ersd, which is crucial for obtaining a consumer's consent to receive notices and disclosures electronically. it supports multiple languages through the 'langcode' parameter, enabling you to retrieve the disclosure in various supported languages or automatically detect the user's browser language. this tool is particularly useful when setting up new accounts, updating disclosures, or ensuring compliance with multi-language requirements. note that while it retrieves the default english disclosure by default, custom disclosures in different languages can be accessed if they have been created for the account. the response includes comprehensive details about the disclosure, including withdrawal options, company information, and the full html-formatted ersd text.
</Accordion>

<Accordion title="Docusign Get Recipient Document Visibility">
  Retrieves document visibility settings for a specific recipient within a docusign envelope. this endpoint allows you to check which documents are visible to a particular recipient and their access rights (editable or read-only). use this method when you need to verify or audit the document access configuration for a recipient in an envelope. it's particularly useful in workflows where different recipients may have varying levels of access to documents within the same envelope. the method returns detailed visibility information but does not modify any settings.
</Accordion>

<Accordion title="Get unsupported file types list">
  Retrieves a comprehensive list of file types (both mime-types and file extensions) that are not supported for upload through the docusign system. this endpoint is crucial for developers and users who need to understand which file formats cannot be processed by docusign, helping to prevent errors and improve the efficiency of document uploads. use this endpoint when you need to validate file types before attempting to upload documents to docusign, or when creating user interfaces that guide users on acceptable file formats. the returned list can be used to implement client-side validation or to provide informative messages to users about unsupported file types. note that this list may change over time as docusign updates its supported file types, so it's recommended to check periodically for any updates.
</Accordion>

<Accordion title="Docusign Get List Of Account Permission Profiles">
  This endpoint retrieves a comprehensive list of permission profiles associated with a specified docusign account. it provides detailed information about each profile, including its unique identifier, name, last modification timestamp, and an extensive set of permission settings. this tool is essential for account administrators who need to review, audit, or manage user access levels and capabilities within their docusign environment. it can be used to understand the current permission structure, identify profiles that may need updates, or verify that the appropriate access levels are set for different user groups.
</Accordion>

<Accordion title="Docusign Get Permission Profile For Account">
  This endpoint retrieves detailed information about a specific permission profile in a docusign account. it provides a comprehensive view of permissions, settings, and capabilities assigned to a profile. useful for auditing or reviewing permissions granted to user groups, it returns data on account role settings, user settings, api access levels, and other configuration options. note that this endpoint is read-only and cannot modify profile settings.
</Accordion>

<Accordion title="Get Template">
  Gets a template definition from the specified account. you can include additional template attributes in the response by using the include parameter: - powerforms: includes information about powerforms - tabs: includes information about tabs - documents: includes information about documents - favorite template status: includes the template favoritedbyme property
</Accordion>

<Accordion title="Docusign Get Tab Settings For Account">
  Retrieves the current tab settings and functionality enabled for a specific docusign account. this endpoint provides detailed information about various tab types (such as checkbox, radio, text) and related features (like tab order, data labels, text formatting) that are currently active or inactive for the account. it's particularly useful for administrators or developers who need to understand the available tab options before creating or modifying documents within the account. the response includes both the enabled/disabled status of each setting and associated metadata, offering insights into compliance requirements and editability of these settings. this tool should be used when there's a need to audit or verify the account's tab configuration, especially before implementing new document workflows or integrations that rely on specific tab functionalities.
</Accordion>

<Accordion title="Docusign Get Groups Information For Account">
  Retrieves detailed information about groups associated with a specific docusign account. this endpoint allows users to fetch a list of groups, including their ids, names, types, and user counts. it's particularly useful for account administrators who need to manage user access, set permissions, or organize users within their docusign environment. the endpoint supports pagination, filtering by group type, and text-based searching, making it versatile for various group management tasks. note that while it provides group information, it does not directly return the list of users within each group; a separate api call is required for that purpose.
</Accordion>

<Accordion title="Get template recipient document visibility">
  This endpoint retrieves document visibility information for a specific recipient of a docusign template. it allows users to check which documents within the template are visible to the recipient and what access rights (read-only or editable) they have for each document. this tool is essential for managing document access and permissions in complex signing workflows, ensuring that sensitive information is only shared with the appropriate recipients. the endpoint returns a list of documentvisibility objects, providing detailed information about each document's visibility and access rights for the specified recipient.
</Accordion>

<Accordion title="Get templates used in envelope">
  This endpoint retrieves a list of server-side templates used in a specific docusign envelope. it provides detailed information about each template, including its name, id, and other relevant attributes. the endpoint is particularly useful for understanding which templates have been applied to an envelope or finding matching templates for an existing envelope. it can be used to audit envelope contents, analyze template usage, or prepare for envelope modifications. the response includes an array of template summaries, offering a comprehensive view of how templates are utilized within the specified envelope.
</Accordion>

<Accordion title="Docusign Get Supported Languages For Recipients">
  Retrieves a comprehensive list of supported languages that can be set for individual recipients when creating a docusign envelope. this endpoint allows developers to access the available language options for customizing the standard email format and signing view for each recipient. it's particularly useful when implementing localization features or providing language choices to users in multi-lingual environments. the endpoint returns both the human-readable language names and their corresponding language codes, which can be used in subsequent api calls to set recipient languages. note that this only affects docusign's standard text elements and does not translate custom email content.
</Accordion>

<Accordion title="Get powerform senders">
  Retrieves a list of users who have sent powerforms within a specified docusign account. this endpoint is useful for monitoring powerform usage, tracking sender activity, and gathering insights on user engagement with powerforms. it returns detailed information about each sender, including their account details, email, and login status. the response is paginated, allowing for efficient retrieval of large datasets. this tool should be used when you need to audit powerform sender activity or generate reports on powerform usage within an account.
</Accordion>

<Accordion title="Get templates for envelope document">
  Retrieves the templates associated with a specific document within a docusign envelope. this endpoint is useful for identifying and managing templates linked to individual documents in an envelope, which can be beneficial for template management and document processing workflows. it should be used when you need to retrieve template information for a particular document in an existing envelope, such as for template auditing or document-specific template applications. the endpoint returns detailed information about each associated template, including its id, name, and matching details, but does not provide the actual template content or allow for template modifications.
</Accordion>

<Accordion title="Get template scheduled sending settings">
  Retrieves the scheduled sending settings for a specified docusign template. this endpoint allows developers to access and review the configuration that determines when and how envelopes based on the template will be sent. it's particularly useful for automating document workflows and managing the timing of envelope distribution. the endpoint returns detailed information about the scheduled sending rules, including any delays or specific send dates, as well as the current status of the scheduled sending job. it should be used when you need to inspect or verify the scheduled sending configuration of a template, especially in scenarios involving automated or timed document processing. note that this endpoint will return a 404 error if the template's workflow does not have a scheduled sending object, indicating that no scheduled sending has been configured for the template.
</Accordion>

<Accordion title="Docusign Get Tabs Blob For Envelope">
  This deprecated endpoint retrieves the tabs blob associated with a specific envelope in docusign. it allows developers to access detailed information about the tabs (such as signature fields, text fields, etc.) within a document envelope. however, as this endpoint is no longer recommended for use, developers should seek alternative methods for accessing tab information in new implementations. the endpoint requires both an account id and an envelope id to identify the specific envelope and account for which to retrieve the tabs blob. use this endpoint cautiously and only if absolutely necessary for legacy systems, as it may be removed in future api versions.
</Accordion>

<Accordion title="Docusign Get Enote Integration Settings">
  Retrieves the enote integration settings for a specified docusign account. this endpoint provides crucial information about the enote configuration status, connect configuration status, and necessary credentials for enote functionality. it should be used when setting up or verifying the enote integration for an account. the endpoint returns details such as api key, organization name, and user credentials, which are essential for configuring the enote feature. note that this endpoint is in beta, so its behavior or response structure may change in future updates. it's important to ensure that the account has the "allow enote for eoriginal" plan item enabled for full functionality.
</Accordion>

<Accordion title="Docusign Get Watermark Details For Account">
  Retrieves and previews the watermark details for a specific docusign account. this endpoint allows users to view the current watermark configuration, including its visual properties and enabled status. it's useful for verifying existing watermark settings or preparing to update them. the endpoint returns comprehensive information about the watermark but does not modify any settings. use this when you need to inspect or audit the current watermark configuration for an account.
</Accordion>

<Accordion title="Docusign Get Urlfor Embedding Docusign Ui">
  This endpoint returns a url that enables embedding the docusign ui in your applications, providing seamless integration of electronic signing capabilities. it's primarily used to generate console views or sender views based on the provided parameters. the endpoint requires an accountid and optionally accepts an envelopeid and returnurl in the request body. when an envelopeid is provided, the behavior varies: 1. for sent envelopes, it returns a url for viewing envelope documents. 2. for draft envelopes, it returns a url for the sender view, with an optional returnurl for redirection. 3. if no envelopeid is specified, it returns a url for the front page of the demo ui. this endpoint provides full access to the sending account, so it should be used cautiously and securely. it's ideal for scenarios where you need to embed docusign functionality directly within your application's interface, enhancing user experience and workflow efficiency.
</Accordion>

<Accordion title="Get users in group">
  Retrieves a paginated list of users belonging to a specific group within a docusign account. this endpoint is useful for managing and auditing group memberships, allowing administrators to view detailed information about users associated with a particular group. it supports pagination to handle large groups efficiently, making it suitable for applications that need to display or process user data in manageable chunks. the endpoint returns comprehensive user information, including account details, email, user status, and membership specifics.
</Accordion>

<Accordion title="Docusign Get Workflow Step For Envelope">
  Retrieves detailed information about a specific workflow step for a docusign template. this endpoint allows users to fetch comprehensive data about a single step in a template's workflow, including its action, status, delayed routing settings, and recipient routing rules. it's particularly useful when you need to examine or troubleshoot the configuration of a specific workflow step within a template. the endpoint provides insights into how the step is triggered, its current status, and any conditional routing or delay rules applied to it. use this when you need to understand the exact behavior and settings of a particular workflow step in your docusign template.
</Accordion>

<Accordion title="Get user information by id">
  Retrieves detailed information about a specific user within a docusign account. this endpoint provides comprehensive data about the user, including personal details, account settings, and permissions. it's useful for account administrators and system integrations needing to verify or sync user configurations. note that users can only access their own information, even with admin rights.
</Accordion>

<Accordion title="Get template delayed routing rules">
  Retrieves the delayed routing rules for a specific workflow step within a docusign template. this endpoint allows users to fetch the scheduled sending and routing information for a particular step in a template's workflow. it's useful for understanding when and how an envelope will be sent to recipients associated with the workflow step. the endpoint should be used when you need to review or verify the delayed routing settings for a template, particularly in automated document workflows. note that if the specified workflow step does not have a delayed routing object, this method will return a 404 error.
</Accordion>

<Accordion title="Get request logging log file">
  Retrieves detailed information for a single api request log entry from docusign's diagnostics service. this endpoint is crucial for debugging and troubleshooting api interactions. it returns the complete request and response data for a specific api call. the log entry can be retrieved as a base64 encoded string or binary data, controlled by the content-transfer-encoding header. use this endpoint to investigate specific api calls, understand errors, or verify exchanged data during docusign api interactions.
</Accordion>

<Accordion title="Get workspace file">
  Retrieves a binary version of a file from a docusign workspace. this endpoint allows you to access and download files stored within a specific workspace, folder, and account. it's particularly useful for retrieving document content for further processing or viewing outside the docusign platform. the endpoint offers options to download the file as an attachment or convert it to pdf format. use this when you need to extract file content from a docusign workspace, either for backup purposes, local editing, or integration with other systems. note that this endpoint retrieves the raw file content and does not provide metadata about the file or its signing status.
</Accordion>

<Accordion title="Docusign Get Bccemail Archive History">
  Retrieves the history of changes made to a specific bcc email archive configuration for a docusign account. this endpoint allows users to track modifications, including creation, updates, and closure of email addresses used for archiving docusign-generated emails. it provides detailed information about each change, including who made the change, when it was made, and the nature of the change. the endpoint supports pagination for efficient retrieval of large result sets.
</Accordion>

<Accordion title="Get members of a signing group">
  Retrieves the list of members in a specified docusign signing group. this endpoint provides detailed information about users in a particular signing group, including their email addresses and usernames. use this tool to audit or manage signing group composition, which is crucial for maintaining proper document routing and signing workflows. note that this endpoint only provides information and does not allow group modification.
</Accordion>

<Accordion title="Initiate new chunked upload">
  Initiates a new chunked upload in docusign by sending the first part of the content. this endpoint is designed to handle large file uploads by breaking them into smaller, manageable pieces. it's particularly useful for adding documents to envelopes in docusign's electronic signature workflow. the method returns a response with the chunked upload id, uri, and other metadata, which can be used to add more parts to the upload. note that this api is currently in beta status and subject to change.
</Accordion>

<Accordion title="Docusign Get Template Document Html Definition">
  Retrieves the html definition for a specific document within a docusign template. this endpoint is used to obtain the properties that define how to generate responsive-formatted html for the document, including display anchors, collapsible sections, and other formatting settings. it's particularly useful when implementing responsive signing features or when you need to understand the structure and display properties of a template document. the response includes detailed information about html definitions, such as display settings, anchors, and formatting options, which can be used to render the document in a responsive manner across different devices and screen sizes.
</Accordion>

<Accordion title="Get Envelope">
  Gets the status and basic information about an envelope from docusign. this action retrieves detailed information about a specific envelope, including: - envelope status (created, sent, delivered, completed, declined, voided) - creation and sent timestamps - subject and message - recipient information and their status - document details - envelope metadata
</Accordion>

<Accordion title="Get notary jurisdictions for user">
  Retrieves a list of notary journals for a user in the docusign system. this endpoint allows users to fetch detailed information about notary sessions, including creation dates, document names, jurisdiction details, and signer information. it's particularly useful for notaries who need to review their past notarizations or for administrators managing notary activities. the endpoint supports pagination and filtering, making it efficient for handling large sets of journal entries.
</Accordion>

<Accordion title="Get Account Templates">
  Gets the definition of a template or templates in the specified account. note: if the count parameter is not used, listtemplates has a default limit of 2,000 templates. if the account has more than 2,000 templates, listtemplates will return the first 2,000 templates. to retrieve more than 2,000 templates, repeat the api call, specifying start position and count to control the number of templates retrieved.
</Accordion>

<Accordion title="Get workspace folder contents">
  Retrieves the contents of a specific workspace folder in docusign, including sub-folders and files. this endpoint provides detailed information about the items within the folder, such as metadata, user permissions, and hierarchical structure. it can be used to navigate and explore the contents of a workspace, allowing for efficient management of documents and folders. the endpoint offers various optional parameters to customize the response, enabling users to include or exclude specific types of information based on their needs.
</Accordion>

<Accordion title="List brands for account">
  Retrieves a comprehensive list of brands associated with a docusign account, including default brand profiles. this endpoint provides detailed information about each brand, such as visual elements, language settings, and resource urls for customizing various docusign experiences. it's particularly useful for managing and reviewing account-level branding options. the endpoint requires either the 'canselfbrandsign' or 'canselfbrandsend' setting to be enabled for the account. use this when you need to audit, manage, or implement brand customizations across your docusign account.
</Accordion>

<Accordion title="Get signature information for recipient">
  Retrieves detailed signature information for a specific signer or sign-in-person recipient within a docusign envelope. this endpoint provides comprehensive data about the recipient's signature, including the signature image, adoption date, various properties, and associated metadata. it's particularly useful when you need to access or verify a recipient's signature details after they have signed a document or when you want to retrieve the current state of a recipient's signature within an ongoing envelope process. the endpoint returns a rich set of information, including the base64-encoded signature image, signature type, stamp properties, and related timestamps. this tool should be used when detailed signature information is required for auditing, verification, or display purposes within your application. note that this endpoint focuses solely on signature information and does not provide other envelope or recipient status details.
</Accordion>

<Accordion title="Docusign List Bulk Send Batch Summaries">
  Retrieves a summary of bulk send batches for a docusign account. this endpoint allows users to query and filter bulk send batch information, providing details such as batch status, size, and processing information. it's particularly useful for monitoring the progress of large-scale document sending operations and managing bulk send workflows. the endpoint supports pagination and various filtering options to customize the result set according to specific needs.
</Accordion>

<Accordion title="List billing invoices">
  Retrieves a list of billing invoices for a specified docusign account. this endpoint allows account administrators to fetch detailed invoice information, including total amounts, due dates, and itemized charges. it supports optional date range filtering and provides a paginated response for efficient handling of large datasets. use this endpoint to review billing history, verify charges, or gather financial data for accounting purposes. the response includes comprehensive invoice details, making it valuable for financial reconciliation and reporting.
</Accordion>

<Accordion title="Get Envelope Document Fields">
  Retrieves the custom document field information from an existing envelope document. the documentid must be a positive 32-bit signed integer (1 through 2147483647). typically the first document has id 1, the second document id 2, and so on, but you can use any numbering scheme within the valid range.
</Accordion>

<Accordion title="Docusign Get User Authorizations For Principal">
  Retrieves user authorizations for a specified principal user within a docusign account. this endpoint allows account administrators or the principal user themselves to view and manage user access and permissions. it provides detailed information about each authorization, including the agent user, permission levels, and validity periods. use this endpoint when you need to audit user access, manage permissions, or review the authorization history for a specific user. the response includes pagination support for handling large sets of authorizations.
</Accordion>

<Accordion title="Docusign List Cloud Storage Items">
  Retrieves a list of the user's items (files and folders) from a specified cloud storage provider integrated with docusign. this endpoint allows for filtered and paginated access to cloud storage contents, enabling efficient navigation and search of large storage structures. it's particularly useful for applications that need to display or process cloud-stored documents within the docusign ecosystem. the endpoint supports various query parameters for customizing the retrieval process, including sorting, limiting results, and searching by text. note that users can only access their own cloud storage items, ensuring data privacy and security.
</Accordion>

<Accordion title="Docusign List Envelope Attachments By Envelope Id">
  Retrieves a list of envelope attachments associated with a specified envelope in docusign. this endpoint is used to fetch developer-only files attached to an envelope, providing details such as attachment ids, types, and access controls. it's important to note that this operation returns envelope attachments, which are different from signer attachments (user-visible documents). use this endpoint when you need to manage or review administrative files linked to an envelope. the api is currently in beta status, so it may be subject to changes in future versions. the response includes an array of attachment objects, each containing information like accesscontrol, attachmentid, and attachmenttype. error details are provided for both successful and failed requests.
</Accordion>

<Accordion title="Docusign List Envelope And Document Custom Fields">
  Retrieves a comprehensive list of envelope and document custom fields associated with a specific docusign account. this endpoint is useful for account administrators who need to review, manage, or analyze the custom fields set up for their organization's docusign workflows. the returned data includes both list custom fields (with predefined options) and text custom fields (for free-form input), providing a complete overview of all custom data points used in the account's envelope processes. this tool should be used when you need to audit existing custom fields, prepare for updates to custom field configurations, or gather information for reporting purposes. it does not allow for the creation, modification, or deletion of custom fields; it is strictly for retrieval of existing field data.
</Accordion>

<Accordion title="List past due invoices">
  Retrieves a list of past due invoices for a specified docusign account and indicates if payment can be made through the rest api. this endpoint is designed for account administrators to manage outstanding financial obligations. it provides comprehensive invoice details including total amounts, balances, due dates, and itemized charges. use this when you need to review overdue payments, assess the account's financial status, or determine if immediate action is required for outstanding invoices. the endpoint does not process payments directly but informs if payment through the api is possible. note that this tool requires account administrator privileges to access sensitive billing information.
</Accordion>

<Accordion title="Get bcc email archive configurations">
  Retrieves a list of bcc (blind carbon copy) email archive configurations associated with a specified docusign account. this endpoint allows users to fetch details about email addresses used for archiving docusign-generated emails. it supports pagination for large result sets and provides comprehensive information about each bcc email archive configuration, including its status, creation date, and associated user details. this tool is useful for auditing or managing bcc email archiving settings within a docusign account.
</Accordion>

<Accordion title="Docusign List Payment Gateway Accounts Info">
  Retrieves a list of all payment gateway accounts associated with a specific docusign account, along with detailed information about each account. this endpoint is useful for obtaining an overview of the payment gateways configured for an account, including their status, supported currencies, and payment methods. it should be used when you need to manage or review payment gateway configurations within a docusign account. as this is a beta endpoint, be aware that its structure or behavior may change in future updates.
</Accordion>

<Accordion title="Docusign Get Notary Jurisdiction Object">
  Retrieves detailed information about a specific notary jurisdiction for the authenticated user. this endpoint should be used when a notary needs to access information about their registered jurisdiction, including commission details, seal requirements, and jurisdiction-specific rules. it provides crucial data for notaries to understand their authority and limitations within a particular area. the endpoint can only be accessed by authenticated users who are registered notaries, and the requested jurisdiction must be one that the notary is authorized for. it does not provide information about jurisdictions the notary is not registered for or allow modifications to the jurisdiction data.
</Accordion>

<Accordion title="Get template lock information">
  Retrieves general information about a template lock in docusign. this endpoint allows users to obtain details about an existing lock on a specific template, including the lock duration, the user who applied the lock, the expiration date, and the unique lock token. it is particularly useful for recovering lock information when a user needs to manage or update a locked template. the endpoint should be used when a user needs to verify the status of a template lock or retrieve the lock token for subsequent operations. it's important to note that only the user who initially locked the template can request this information, ensuring security and preventing unauthorized access to lock details. the response includes the x-docusign-edit header, which provides additional context about the lock.
</Accordion>

<Accordion title="Docusign List Resources For Restversion Specified">
  Retrieves the base resources available for the docusign esignature rest api. this endpoint provides developers with a comprehensive list of available api resources and their current configurations without requiring authentication or an integrator key. it's particularly useful for api discovery, allowing developers to understand the capabilities and structure of the esignature api before implementation. the endpoint returns detailed information about each resource, including names, values, and any associated error details, which can be crucial for diagnosing issues or planning api integrations. while it doesn't provide access to user-specific data, it serves as an essential tool for api exploration and troubleshooting.
</Accordion>

<Accordion title="Docusign List Signature Providers For Account">
  Retrieves a list of signature providers available for a specified docusign account. this endpoint allows users to obtain detailed information about electronic and digital signature providers, including standards-based signatures, that can be used within the account. it's particularly useful when setting up or managing signature workflows, especially those involving identity verification. the endpoint returns provider names, display names, ids, and any required options, enabling developers to integrate various signature providers into their docusign-based applications or workflows.
</Accordion>

<Accordion title="List workspaces">
  Retrieves a list of docusign workspaces and their associated information for a specified account. this endpoint allows users to get a comprehensive view of all workspaces they have access to, including details such as workspace ids, names, descriptions, creation dates, and user information. it's particularly useful for applications that need to display or manage multiple workspaces, or for auditing purposes to review workspace configurations and user access. the endpoint provides paginated results, allowing for efficient retrieval of large numbers of workspaces.
</Accordion>

<Accordion title="List registered notary jurisdictions">
  Retrieves a paginated list of registered notary jurisdictions for the current user, who must be a notary. this endpoint provides detailed information about each jurisdiction where the notary is registered, including commission details, seal settings, and supported features. it is useful for managing and reviewing a notary's registrations across multiple states. the response includes navigation uris for handling pagination, allowing for efficient retrieval of large result sets. this endpoint should be used when a notary needs to review their registered jurisdictions or when an application needs to display or process a notary's registration information across multiple states.
</Accordion>

<Accordion title="Get Envelope DocGen Form Fields">
  Given an envelopeid, this method returns the sender fields found in that envelope's documents. after you retrieve the sender fields, you can use the documentgeneration::updateenvelopedocgenformfields method to populate the fields.
</Accordion>

<Accordion title="Get user authorization details">
  Retrieves detailed information about a specific user authorization in docusign. this endpoint allows account administrators or the principal user to fetch comprehensive data about an authorization, including the agent user, principal user, permission levels, and relevant timestamps. it's particularly useful for auditing purposes, reviewing access grants, and managing user permissions within the docusign system. the endpoint requires specific identifiers to ensure the correct authorization is accessed and that the requester has the necessary permissions to view the data.
</Accordion>

<Accordion title="Docusign List Workspace File Pages">
  Retrieves a workspace file as rasterized pages from a docusign workspace. this endpoint allows users to fetch file pages as images with customizable resolution and dimensions. it supports pagination for handling large files efficiently. use this method when you need to view or process workspace files as images, such as for preview generation or image-based analysis. the endpoint is particularly useful for viewing documents without downloading the entire file, enabling faster loading and reduced bandwidth usage. note that this method does not provide text extraction or document editing capabilities; it's purely for image-based representation of file pages.
</Accordion>

<Accordion title="Docusign Lock Template For Editing">
  This endpoint locks a specified docusign template for editing, preventing other users or recipients from modifying it during the lock period. it returns a locktoken that must be used in subsequent put requests to update the locked template. the method is crucial for maintaining data integrity in collaborative environments where multiple users might attempt to edit the same template simultaneously. use this endpoint before making any changes to a template to ensure exclusive access. note that the lock has an expiration time, and you must provide the locktoken in the x-docusign-edit header for all update operations while the template is locked.
</Accordion>

<Accordion title="Get brands information for group">
  Retrieves detailed brand information associated with a specific group within a docusign account. this endpoint provides a comprehensive view of the brand settings, including default brands for recipients and senders, as well as a list of all available brands with their properties. it's particularly useful for administrators managing multiple brands across different groups within an organization. the endpoint should be used when there's a need to review or audit brand assignments, customize group-specific branding, or prepare for brand updates within a group context. it does not modify any brand settings but offers a read-only view of the current brand configuration for the specified group.
</Accordion>

<Accordion title="Lock an envelope for editing">
  This endpoint locks an envelope for editing, preventing other users or recipients from changing it. it's used to ensure exclusive access to an envelope during updates. the method returns a lock token that must be included in subsequent put requests to modify the locked envelope. use this endpoint when you need to make changes to an envelope and want to prevent concurrent edits. the lock has a limited duration and can be extended if needed. it's particularly useful for complex envelope modifications or when coordinating changes among multiple users. note that template passwords may be required for certain locked envelopes, and there's a maximum lock duration of 30 minutes.
</Accordion>

<Accordion title="Docusign Get Notary User Settings">
  Retrieves the settings and information for the currently authenticated notary user in the docusign system. this endpoint provides comprehensive details about the notary's account configuration, including personal information, user settings, and optionally, information about supported jurisdictions. it should be used when detailed information about a notary user's account and capabilities is required, such as during account management or when verifying a notary's jurisdictional authority. the endpoint is specifically designed for notary users and will not work for regular docusign users. it's important to note that the response contains sensitive information, so proper authorization and security measures should be in place when using this endpoint.
</Accordion>

<Accordion title="Get user cloud storage provider configuration">
  Retrieves the cloud storage provider configuration for a specific user within a docusign account. this endpoint returns a list of enabled cloud storage providers and their configuration details for the specified user. it's useful for integrating cloud storage options into docusign workflows or managing user-specific cloud storage settings. the endpoint is designed for individual user access, meaning users can only retrieve their own configuration information, even if they have admin rights. the response includes authentication urls for providers that require user authentication, making it valuable for setting up or updating cloud storage integrations.
</Accordion>

<Accordion title="Docusign Get Envelope Notification Defaults">
  Retrieves the default email notification settings for envelopes in a docusign account. this endpoint provides a comprehensive overview of the notification preferences for both senders and signers, covering various events in the envelope lifecycle such as envelope completion, delivery failures, and signer changes. it's particularly useful when setting up a new account or reviewing existing notification configurations to ensure optimal communication with all parties involved in the signing process. the returned settings serve as a template for envelope-specific notifications but can be overridden on a per-envelope basis if needed.
</Accordion>

<Accordion title="Docusign Get Envelope Workflow Definition">
  Retrieves the workflow definition for a specified envelope in docusign. this endpoint provides detailed information about the envelope's workflow steps, scheduled sending settings, and delayed routing configurations. it is useful for developers who need to understand or analyze the current state and progression of an envelope's workflow. the endpoint returns a comprehensive workflow object, including the current step, scheduled resume date, and an array of all workflow steps with their respective statuses and configurations.
</Accordion>

<Accordion title="Get brand logo by type">
  Retrieves a specific logo used in a brand for a docusign account. this endpoint allows you to fetch the image file for a primary, secondary, or email logo associated with a particular brand in your docusign account. it's useful for maintaining consistent branding across docusign documents and communications. the endpoint requires branding to be enabled for the account (either for signing, sending, or both). use this when you need to display or verify the current logo for a specific brand and logo type within your docusign integration.
</Accordion>

<Accordion title="Get envelope lock information">
  Retrieves general information about an envelope lock in docusign. this endpoint is used to obtain details about the lock on a specific envelope, including the lock token, duration, owner, and expiration time. it's particularly useful for recovering lock information when managing concurrent access to envelopes. the caller must be the same user who initially locked the envelope. use this endpoint when you need to verify the lock status of an envelope or retrieve the lock token for subsequent operations. it does not modify the lock itself but provides essential information for lock management.
</Accordion>

<Accordion title="Docusign Get Original Html Definition For Template">
  Retrieves the original html definition for a specified docusign template. this endpoint is used to obtain the properties that define how to generate the responsive-formatted html for the template's documents. it provides detailed information about display settings, anchors, and collapsible sections that control the appearance and behavior of the template during signing. this tool is essential for developers who need to understand or modify the responsive signing experience for a specific template.
</Accordion>

<Accordion title="Get bulk send batch status">
  Retrieves the general status of a specific bulk send batch in docusign. this endpoint provides detailed information about the progress and outcomes of a bulk send operation, including the number of successfully sent envelopes, pending envelopes, and any errors encountered. it's useful for monitoring large-scale document sending operations and identifying issues that may require attention. use this endpoint to track batch progress, verify success rates, or investigate failures in high-volume document workflows.
</Accordion>

<Accordion title="Docusign Get Downgrade Plan Info For Account">
  Retrieves detailed billing information related to a downgrade request for a specific docusign account. this endpoint provides essential data about the requested downgrade plan, including the new plan details, payment method, effective date, and current status of the downgrade request. it should be used when managing account billing changes, specifically when an account holder has initiated or is considering a plan downgrade. the tool is particularly useful for account administrators or billing departments to review and process downgrade requests. note that this endpoint only provides information about existing downgrade requests and does not initiate new downgrades or make changes to the account's current plan.
</Accordion>

<Accordion title="Get docusign account contacts">
  Retrieves contact information associated with a docusign account. this endpoint allows users to fetch either a specific contact using the contactid or all contacts if the contactid is omitted. it supports retrieving contacts from both the default docusign address book and connected cloud storage providers. the endpoint is particularly useful for accessing detailed contact information, including personal details, phone numbers, email addresses, notary certifications, and signing group associations. it should be used when needing to access or update contact information within a docusign workflow. note that phone numbers for shared contacts may have limited visibility to users other than the contact creator.
</Accordion>

<Accordion title="Get bulk send lists information">
  Retrieves a list of bulk send lists belonging to the current user in a specified docusign account. this endpoint provides basic information about each bulk send list, including its unique identifier, creator, creation date, and name. it is particularly useful for managing and tracking bulk send operations, allowing users to get an overview of their available bulk send lists. this tool should be used when you need to inventory or manage bulk send lists for high-volume document distribution. it does not provide detailed information about the contents of each list or allow for modification of the lists. the response is limited to basic summary information and does not include the actual recipients or documents associated with each list.
</Accordion>

<Accordion title="Get template notification information">
  Retrieves the envelope notification, reminders, and expiration information for an existing template in docusign. this endpoint allows users to get detailed settings about how notifications are configured for envelopes created from the specified template. it provides information on expiration settings, reminder configurations, and whether account default settings are being used. this tool is useful for reviewing and auditing template notification settings before creating envelopes or when troubleshooting notification-related issues with template-based envelopes. the response includes complex objects for expirations and reminders, giving a comprehensive view of the template's notification setup.
</Accordion>

<Accordion title="Docusign Modify Account Notification Settings">
  This endpoint updates the default email notification settings for envelope senders and signers in a docusign account. it allows for extensive customization of when and what type of notifications users receive regarding envelope status changes, comments, and other events. the endpoint is useful for tailoring the docusign experience to an organization's specific needs and communication preferences. it should be used when an account administrator wants to modify the default notification behavior for all users in the account. note that these settings can be overridden at the individual envelope level if needed.
</Accordion>

<Accordion title="Deprecated endpoint for tab blob">
  This deprecated endpoint is used to update tab-related data (tab blobs) within a specific envelope in a docusign account. it is important to note that this endpoint should not be used in new integrations or applications due to its deprecated status. the endpoint requires both an account identifier and an envelope identifier to target the correct set of tabs for updating. while it can modify tab data, the exact nature of the modifications and the format of the tab blob are not specified in the provided schema. the endpoint returns a simple success response or an error response with details if the operation fails. developers should seek alternative, supported methods for managing tabs in docusign envelopes.
</Accordion>

<Accordion title="Docusign Export Brand To Xmlfile">
  This endpoint exports information about a docusign brand to an xml file. it allows users to retrieve structured brand data for an account, which can be useful for backup, analysis, or integration purposes. the endpoint should be used when there's a need to extract comprehensive brand information in a standardized format. note that this operation is only available if branding for either signing or sending is enabled for the account (canselfbrandsend or canselfbrandsign must be set to true). the exported xml file contains all relevant brand settings and configurations associated with the specified brand id.
</Accordion>

<Accordion title="Docusign Get Default Consumer Disclosure">
  Retrieves the default html-formatted electronic record and signature disclosure (ersd) associated with a docusign account. this endpoint is used to obtain the standard disclosure provided by docusign for u.s.-based customers, which is valid only for transactions between u.s.-based parties. it allows retrieval of the disclosure in multiple languages and provides comprehensive details about the ersd, including company information, withdrawal methods, and the full text of the esign agreement.
</Accordion>

<Accordion title="Docusign Generate Edit View Urlfor Envelope">
  Generates a url for accessing and editing an existing envelope within the docusign ui, allowing for embedded editing functionality in external applications. this endpoint is identical to the createsender endpoint and is recommended to be replaced by it. the generated url provides a customizable view for editing envelope details, recipients, and documents.
</Accordion>

<Accordion title="Docusign Fetch Recipient Names For Email">
  Retrieves a list of all names associated with a specified email address in docusign. this endpoint is useful for identifying multiple recipients or name variants linked to a single email. it can be used to verify recipient information before sending documents for signature or to manage recipient data in your docusign integration. the endpoint returns not only the names but also indicates if the email is used by multiple users and if new names can be added to it. this information is valuable for maintaining accurate recipient records and ensuring proper document routing in complex signing scenarios.
</Accordion>

<Accordion title="Docusign Generate Envelope Correction Url">
  Generates a url that allows embedding the envelope correction view of the docusign ui within an application. this endpoint enables customization of the correction view appearance and functionality through query parameters. the returned url provides temporary, one-time access to the envelope correction interface, allowing users to modify and update envelope details securely within your application.
</Accordion>

<Accordion title="Docusign Generate Recipient Shared View Url">
  Generates a url that enables embedding the docusign ui recipient view of a shared envelope in your application. this endpoint is specifically used for shared envelopes, allowing recipients on the same account to view and interact with the shared envelope directly within your application. it's particularly useful for collaborative document signing and management scenarios. the generated url should not be used in iframes on mobile devices due to screen space limitations; for ios devices, a webview is recommended instead.
</Accordion>

<Accordion title="Get account billing charges list">
  Retrieves a detailed list of recurring and usage charges for a specified docusign account. this endpoint provides comprehensive information about the account's billing structure, including charge names, types, pricing, and usage quantities for various docusign services. it's particularly useful for account administrators to analyze current usage, understand the pricing structure, and make informed decisions about service utilization. the response includes data on charges such as envelope usage, seat allocations, and additional services like id checks or in-person signings. note that this endpoint requires account administrator privileges and does not provide historical billing data or future projections.
</Accordion>

<Accordion title="Get account stamp image">
  Retrieves the image file for a specific account stamp, signature, or initials in docusign. this endpoint allows users to obtain the visual representation of stamps or signatures associated with their docusign account. it's particularly useful when you need to display or embed these images in other documents or applications. the endpoint returns the actual image file in gif format, not just metadata. it supports retrieving different types of images (stamp, signature, or initials) and offers an option to include or exclude the chrome (frame) around the image.
</Accordion>

<Accordion title="List users for account">
  Retrieves a list of users for a specified docusign account. this endpoint allows for detailed querying of user information, including their account status, email addresses, and various account settings. it's particularly useful for account administrators who need to manage users or gather information about the account's user base. the endpoint supports pagination and filtering, enabling efficient retrieval of specific subsets of users. when called with the 'additional info' parameter set to true, it provides comprehensive user data, including granular permissions and custom settings. this makes it valuable for auditing user access levels or preparing for bulk updates to user configurations. keep in mind that the response can be quite large, especially for accounts with many users or when requesting additional info. it's recommended to use pagination parameters (count and start position) for large accounts to manage response sizes and api performance.
</Accordion>

<Accordion title="Get account password rules">
  Retrieves the current password rules and security settings for a specified docusign account. this endpoint provides detailed information about password expiration policies, lockout durations, password strength requirements, and security question configurations. it is useful for account administrators to review and understand the current security posture of their docusign account. the retrieved information can be used to ensure compliance with organizational security policies or to plan password policy updates. this endpoint does not modify any settings; it is for informational purposes only.
</Accordion>

<Accordion title="Delete workspace files or folders">
  This endpoint allows for the deletion of one or more files or sub-folders from a docusign workspace folder or root. it's used to remove unwanted or obsolete items from a workspace, helping to maintain organization and manage storage. the operation can handle bulk deletions, making it efficient for cleaning up multiple items at once. it's important to note that this action is irreversible, so users should exercise caution when selecting items for deletion. the workspace must have an 'active' status for this operation to succeed. this endpoint should not be used for temporary file management or as a means of archiving, as deleted items cannot be recovered through the api.
</Accordion>

<Accordion title="Docusign Retrieve Credit Card Info">
  This endpoint retrieves detailed credit card information associated with a specific docusign account. it provides comprehensive details about the credit card on file, including the card number (partially masked), type, expiration date, cardholder name, and associated billing address. this tool should be used when there's a need to access or verify the current credit card information for billing purposes within the docusign system. it's particularly useful for account management, billing inquiries, or updating payment information. however, due to the sensitive nature of the data returned, this endpoint should be used judiciously and with appropriate security measures in place. the tool does not allow for updating or modifying the credit card information; it is read-only. be aware that accessing this information may be subject to strict access controls and compliance requirements due to the sensitive financial data involved.
</Accordion>

<Accordion title="Queue downgrade billing plan request">
  Queues a downgrade request for a docusign account's billing plan. this endpoint allows you to initiate the process of changing an account to a lower-tier or less expensive plan. it's used when an account holder wants to reduce their subscription level or change to a more cost-effective plan. the endpoint processes the request and returns information about the downgrade status, including the effective date and new plan details. note that this action queues the request for processing and does not immediately apply the downgrade.
</Accordion>

<Accordion title="Purchase additional envelopes">
  This endpoint completes the purchase of additional envelopes for a docusign account through an internal workflow interaction with an envelope vendor. it is designed to handle the financial transaction and update the account's envelope quota. this tool should be used when there's a need to increase the number of available envelopes for document signing within a docusign account. however, it's important to note that this endpoint is currently limited to docusign internal use only and is not available for public api consumers. the endpoint requires detailed information about the purchase, including the amount, currency, quantity, and app store-related data for tracking and processing the transaction.
</Accordion>

<Accordion title="Docusign Remove Templates From Favorites">
  Removes one or more templates from an account's list of favorite templates in docusign. this endpoint allows users to manage their favorite templates by specifying which templates should no longer be marked as favorites. it accepts an account identifier and a list of template ids to be removed from favorites. the api returns information about the templates that were successfully removed and any errors encountered during the process. this endpoint is particularly useful for maintaining an organized and relevant list of favorite templates, especially when templates are no longer frequently used or needed. note that this api is currently in beta status, which means it may not be fully stable and could be subject to changes in the future.
</Accordion>

<Accordion title="Retrieve connect log entry">
  Retrieves a specific connect log entry for a docusign account. this endpoint provides detailed information about a connect event, including account details, configuration information, envelope data, and potential error details. it is particularly useful for troubleshooting connect integrations, auditing connect events, and monitoring the overall health of your connect service. the endpoint requires connect to be enabled on the account and logging to be activated in the connect configuration. only account administrators can access this information.
</Accordion>

<Accordion title="Docusign Retrieve Connect Oauth Configuration">
  Retrieves the connect oauth configuration for a specified docusign account. this endpoint allows account administrators to access the oauth settings used for docusign connect, which is crucial for webhook integrations and automated notifications. the retrieved configuration includes essential details such as the authorization server url, client id, client secret, and scope settings. this tool should be used when setting up or troubleshooting connect integrations, or when verifying the current oauth configuration for an account. it's important to note that this endpoint requires account administrator privileges and connect must be enabled on the account to access this information. the tool does not modify any settings; it only retrieves the existing configuration.
</Accordion>

<Accordion title="Retrieve billing invoice">
  Retrieves a specific billing invoice for a docusign account, providing detailed information about charges and payment details. this endpoint allows account administrators to access invoice data in both json format and, when available, as a downloadable pdf. it's particularly useful for financial reconciliation, audit purposes, or when detailed billing information is required. the endpoint returns comprehensive invoice data, including total amount, balance, due date, and itemized charges, with amounts shown in the account's set currency.
</Accordion>

<Accordion title="Remove bulk send list">
  This endpoint deletes a specific bulk send list from a docusign account. it is used to permanently remove a bulk send list that is no longer needed or was created in error. the operation requires both the account identifier and the specific bulk send list id to ensure precise targeting of the list to be deleted. upon successful deletion, it returns a summary of the remaining bulk send lists associated with the account. this endpoint should be used with caution as the deletion is irreversible. it's particularly useful for maintaining a clean and organized set of bulk send lists, especially in environments where list management is crucial for compliance or efficiency reasons. note that this operation does not affect any envelopes that may have already been sent using the deleted list.
</Accordion>

<Accordion title="Remove user signature information">
  Removes the signature information for a specific user in docusign. this endpoint should be used when a user wants to delete their existing signature from their docusign account. it's particularly useful for updating or refreshing signature information. the operation is restricted to the authenticated user's own signatures and cannot be used to modify other users' data, even with admin rights. it's important to note that this action is irreversible, so it should be used with caution. the endpoint accepts either a signature id or a signature name, but using the signature id is recommended to avoid url encoding issues.
</Accordion>

<Accordion title="Docusign Retrieve Account Provisioning Info">
  Retrieves the account provisioning information for a docusign account. this endpoint is used to obtain crucial setup details necessary for account management and integration with docusign's services. it provides information such as default connection and plan ids, distributor codes, password rules, and billing-related details. this tool should be used when setting up a new docusign account or when needing to verify or update existing account provisioning information. the endpoint does not require any input parameters and returns a comprehensive set of account configuration data. note that this endpoint does not modify any account settings; it only retrieves existing information.
</Accordion>

<Accordion title="Docusign Retrieve Billing Payment Info">
  Retrieves detailed information for a specified billing payment within a docusign account. this endpoint is used to fetch comprehensive data about a single payment, including the amount, description, payment date, and payment number. it is designed for account administrators who need to access or review specific payment details, such as for auditing or reconciliation purposes. the endpoint does not modify any payment information and is read-only. it should be used when precise payment data is required, but not for real-time payment processing or for retrieving bulk payment information.
</Accordion>

<Accordion title="Retrieve custom fields for envelope">
  Retrieves custom field information for a specified envelope in docusign. this endpoint allows users to access both list and text custom fields associated with an envelope, providing valuable metadata for tracking, searching, and managing documents. it's particularly useful for retrieving envelope-specific custom data that isn't visible to recipients but is crucial for internal processes and integrations. the endpoint supports salesforce merge fields, enhancing its utility in crm-integrated workflows.
</Accordion>

<Accordion title="Docusign Retrieve Account Seal Providers">
  Retrieves a list of electronic seal providers available for a specific docusign account. this endpoint allows developers to fetch all the seals that can be applied to documents within the specified account. it's particularly useful when implementing functionality to add electronic seals to documents or when displaying available seal options to users. the endpoint returns both the internal seal name and a user-friendly display name for each available seal. it should be used when an application needs to present seal choices to users or automatically apply seals based on predefined rules. note that this endpoint only retrieves the list of available seals and does not apply seals to documents; separate api calls would be required for seal application.
</Accordion>

<Accordion title="Docusign Retrieve Envelope Document Fields">
  Retrieves custom document field information from an existing envelope document in docusign. this endpoint allows users to access name-value pairs of custom data strings associated with a specific document within an envelope. it's particularly useful for retrieving metadata or additional information attached to documents that are not used in docusign's standard processing. the function returns both current and original values of these custom fields, enabling tracking of any changes made to the fields over time.
</Accordion>

<Accordion title="Docusign Post Payment To Invoice">
  Posts a payment to a past due invoice in the docusign system. this endpoint is used to process payments for overdue invoices, but only when the 'paymentallowed' value for the invoice is true. it requires account administrator privileges and returns detailed payment information. the endpoint is crucial for managing billing and payments within docusign, ensuring timely settlement of past due accounts. it should be used in conjunction with the 'list invoices past due' endpoint to retrieve eligible invoices and their balances before posting payments.
</Accordion>

<Accordion title="Docusign Remove Group Sharing Permissions For Template">
  Removes sharing permissions for specified member groups from a docusign template. this endpoint is used to revoke access to a template for one or more groups, enhancing template security and access control. it's particularly useful when reorganizing team structures, updating project access, or when certain groups no longer require access to a specific template. the operation affects only the specified template and groups, allowing for granular permission management within the docusign environment.
</Accordion>

<Accordion title="Modify tab settings for account">
  This endpoint modifies the tab types and tab functionality that are enabled for a docusign account. it allows administrators to configure various tab-related settings, such as enabling or disabling specific tab types, controlling tab order, and managing compliance with fda regulations. the endpoint is primarily used to customize the tab experience for users within an account, affecting how they interact with documents during the signing process.
</Accordion>

<Accordion title="Republish connect data for envelope">
  Republishes connect information for a specified envelope in docusign. this endpoint is used to retry sending connect event data that may have failed to deliver previously. it's particularly useful for ensuring that all relevant updates about an envelope are successfully communicated to integrated systems. the function requires account administrator privileges and connect must be enabled on the account. use this when you need to manually trigger a resend of connect data for a specific envelope, typically in response to failed deliveries or system synchronization issues.
</Accordion>

<Accordion title="Retrieve payment information list">
  Retrieves a list of payment information for a specific docusign account. this endpoint allows you to fetch detailed payment data, including amounts, descriptions, payment dates, and ids. it's particularly useful for accounting purposes, reconciliation, or generating financial reports. by default, it returns payment information for the last 365 days, but you can specify a custom date range using query parameters. the response is paginated, allowing you to handle large datasets efficiently. note that this endpoint requires account administrator privileges and should be used cautiously to protect sensitive financial information.
</Accordion>

<Accordion title="Docusign Retrieve Power Form Data Entries">
  This endpoint retrieves data entries for a specific powerform within a docusign account. it allows powerform administrators or the powerform sender to download the information entered by recipients into a powerform. the data can be retrieved in various formats (json, xml, or csv) and can be filtered by date range. this endpoint is essential for collecting and analyzing form submissions, enabling businesses to efficiently process and manage data gathered through powerforms. it should be used when there's a need to extract and analyze powerform submission data, but not for real-time form submission tracking. the endpoint provides comprehensive form data, including envelope and recipient details, but does not offer real-time updates or notifications for new submissions.
</Accordion>

<Accordion title="Retrieve pdf from specified template">
  Retrieves one or more pdf documents from a specified docusign template. this endpoint allows you to fetch individual documents or combine all documents in the template into a single pdf file. it's particularly useful when you need to access template documents for review, processing, or to create new envelopes based on existing templates. the retrieved pdfs can be customized to show recipient changes and can be encrypted for enhanced security. use this endpoint when you need to work with template documents outside of the docusign system or when you want to verify the content of a template before using it.
</Accordion>

<Accordion title="Republish connect info for envelopes">
  Republishes connect information for a specified set of envelopes in docusign. this endpoint is primarily used to retry failed connect post attempts by providing the envelope ids that previously failed to post correctly. it's designed for account administrators to handle and resolve connect post failures, ensuring that important envelope information is successfully transmitted to integrated systems. the endpoint requires connect to be enabled on the account and returns detailed results of the retry attempts for each envelope.
</Accordion>

<Accordion title="Docusign Retrieve Envelope Email Overrides">
  Retrieves the email override settings for a specified envelope in docusign. this endpoint allows users to fetch custom email configurations, including reply-to email address and name overrides, as well as bcc email addresses for archiving purposes. it's particularly useful when you need to verify or audit the email settings for a specific envelope that may differ from the account-level defaults. the retrieved information is not included in the standard envelope status get request and requires this specific api call.
</Accordion>

<Accordion title="Docusign Retrieve Properties About Workspace">
  Retrieves detailed properties and information about a specific docusign workspace. this endpoint allows you to fetch comprehensive data about a workspace, including its settings, user details, and various metadata. it's particularly useful when you need to access or verify workspace information, such as its current status, description, or associated users. the endpoint requires both an account identifier and the specific workspace id to retrieve the correct information. note that some details, like caller information, are only returned for user-specific get calls. this endpoint should be used when detailed workspace information is needed, but it does not provide document contents or allow modifications to the workspace.
</Accordion>

<Accordion title="Retrieve signer signature image information">
  Retrieves the specified user's signature image from a docusign envelope. this endpoint allows developers to access the electronic signature image of a specific recipient within an envelope, which can be useful for verification, display, or record-keeping purposes. the image is returned in its original uploaded format, with an option to include or exclude the chrome (added line and identifier around the initial image). this tool is particularly useful when you need to extract or display a user's signature from a completed or in-progress docusign transaction. it should be used cautiously, respecting privacy concerns and ensuring proper authorization. note that older envelopes may only have chromed images available, so a fallback strategy might be necessary in some cases.
</Accordion>

<Accordion title="Retrieve billing plan details">
  Retrieves comprehensive details of a specific docusign billing plan using its unique identifier. this endpoint provides extensive information about the plan, including its name, payment cycle, pricing structure, included features, and potential upgrade options. it's particularly useful for account administrators and billing managers who need to review or manage subscription details. the response includes the current plan's specifics such as per-seat pricing, included seats, and support fees, as well as a list of successor plans for potential upgrades. this endpoint should be used when detailed billing plan information is required, such as during account reviews, upgrade considerations, or for generating detailed billing reports. it does not modify any billing information and is intended for read-only operations.
</Accordion>

<Accordion title="Docusign Retrieve Account Billing Plan">
  Retrieves detailed billing plan information for a specified docusign account. this endpoint provides comprehensive data about the current billing plan, successor plans, billing address, and credit card information associated with the account. it is particularly useful for obtaining an overview of an account's billing status, available plan options, and payment details. the endpoint allows customization of the response through optional query parameters, enabling users to include or exclude specific information such as credit card details, downgrade options, metadata, and successor plans. this tool should be used when a detailed view of an account's billing configuration is required, especially for account management, billing inquiries, or planning potential plan changes.
</Accordion>

<Accordion title="Docusign Retrieve Envelope Html Definition">
  Retrieves the original html definition used to generate the responsive html for a specific envelope in a docusign account. this endpoint is crucial for developers working with docusign's responsive signing feature, as it provides detailed information about how the envelope's documents are formatted and displayed in a responsive manner. the tool returns properties that define the responsive html generation, including display anchors, collapsible sections, and responsive table settings. it should be used when you need to inspect or troubleshoot the html definition of an envelope, particularly for envelopes using smart sections or responsive signing features. this endpoint does not modify any data and is purely for retrieval purposes.
</Accordion>

<Accordion title="Retrieve rest api versions">
  Retrieves the available rest api versions for docusign's service. this endpoint provides crucial information about the current state of the api, including available versions, their corresponding urls, and some internal build details. it's useful for developers who need to check api compatibility, plan for version upgrades, or diagnose potential issues. the endpoint can be accessed on both production and demo systems without requiring authentication or an integration key, making it ideal for quick service checks or initial api exploration. while it offers valuable version and build information, it does not provide details about specific api functionalities or user-related data.
</Accordion>

<Accordion title="Docusign Retrieve Custom Fields For Template">
  This endpoint retrieves the custom document fields for an existing template document in docusign. it allows users to access name-value pairs of custom data strings associated with a specific document within a template. this tool is useful for retrieving metadata or custom information that has been added to template documents, which can be used for populating or customizing new envelopes based on the template. it should be used when you need to view or work with the custom fields of a particular document in a docusign template. note that this endpoint only retrieves existing custom fields and does not allow for creation or modification of these fields.
</Accordion>

<Accordion title="Retrieve user account settings">
  Retrieves a comprehensive list of account settings and email notification preferences for a specified user within a docusign account. this endpoint provides detailed information about the user's configuration, including locale settings, email notification preferences, account management capabilities, and various other user-specific settings. it's particularly useful for understanding a user's current configuration or for troubleshooting user-specific issues. the endpoint is limited to retrieving settings for the authenticated user only, even for admin users, ensuring privacy and security of individual user settings. the response includes a wide range of settings, from basic preferences to advanced features like vaulting and template management, offering a complete view of the user's docusign environment configuration.
</Accordion>

<Accordion title="Docusign Retrieve Shared Item Status For Users">
  Retrieves shared item status for one or more users and types of items within a docusign account. this endpoint provides detailed information about how envelopes, templates, and folders are shared among users and groups. it can be used to audit sharing permissions, track shared resources, or gather information for access management. the endpoint offers various filtering options to customize the response based on item types, user statuses, and sharing directions. note that this endpoint returns information for the legacy shared envelopes feature; for the new shared access feature, use the authorizations resource instead.
</Accordion>

<Accordion title="Docusign Retrieve Account Settings Information">
  Retrieves the comprehensive account settings information for a specified docusign account. this endpoint provides a detailed view of the account's configuration, including access code formats, account-wide preferences, feature toggles, security settings, ui customization options, and compliance-related configurations. it is particularly useful for administrators or integration developers who need to audit, review, or programmatically access the full range of account settings. the retrieved information can be used to understand the current state of the account, verify specific configurations, or as a basis for updating settings through other api calls. note that this endpoint returns a large amount of data and should be used judiciously to avoid unnecessary load on the system. it does not modify any settings; it only retrieves the current configuration.
</Accordion>

<Accordion title="Docusign Retrieve Template Document Page Images">
  Retrieves and returns images of pages from a specified template document in docusign. this endpoint allows users to fetch visual representations of template pages with customizable image properties such as resolution and dimensions. it's particularly useful for previewing or displaying template content within applications, enabling users to view document layouts and content without needing to download the entire document. the endpoint supports pagination for efficient handling of multi-page documents and offers options for showing changes and bypassing cache for up-to-date results.
</Accordion>

<Accordion title="Docusign Retrieve Envelope Notification Details">
  Retrieves the notification, reminder, and expiration settings for an existing envelope in docusign. this endpoint allows developers to access and review the current notification configuration for a specific envelope, including expiration timelines and reminder schedules. it's particularly useful when you need to verify or audit the notification settings for an envelope, especially in workflows where timely responses are critical. the endpoint does not modify any settings; it only provides read-only access to the current configuration.
</Accordion>

<Accordion title="Docusign Retrieve Template Custom Fields">
  Retrieves the custom document field information from an existing template in docusign. this endpoint allows users to fetch both list and text custom fields associated with a specific template. it's particularly useful when you need to view or work with the custom fields that have been set up for a template, enabling you to understand the additional data that can be collected or pre-filled when using this template to create envelopes. the retrieved information includes details such as field ids, names, required status, and possible values for list fields. this endpoint should be used when you need to inspect or validate the custom fields of a template before using it to create an envelope or when you want to display the available custom fields to users in your application.
</Accordion>

<Accordion title="Docusign Retrieve Custom Tab Information">
  Retrieves detailed information about a specific custom tab associated with a docusign account. this endpoint allows users to access the properties and settings of a custom tab, including its anchor information, formatting options, merge field details, and locale settings. it is particularly useful when you need to review or verify the configuration of a custom tab within an account. the endpoint requires both the account id and the specific custom tab id to fetch the relevant information. note that this endpoint only retrieves information and does not modify any existing custom tab settings.
</Accordion>

<Accordion title="Docusign Retrieve Custom User Settings">
  Retrieves a list of custom user settings for a single user in docusign. this endpoint allows flexible storage and retrieval of user-specific information that can be used in your own system, separate from standard user account settings. it supports both grouped and ungrouped custom settings, with the ability to filter by group using an optional header. use this endpoint when you need to access user-specific configurations, preferences, or any custom data stored for a particular user in your docusign integration. note that users can only access their own custom settings, and this endpoint does not provide access to standard docusign account settings.
</Accordion>

<Accordion title="Docusign Retrieve Account Signing Groups">
  Retrieves a comprehensive list of all signing groups within a specified docusign account. this endpoint allows you to obtain detailed information about each signing group, including group names, types, ids, and optionally, member details. it's particularly useful for managing and auditing signing groups across an organization. the endpoint supports filtering by group type and can include or exclude user information based on your needs. use this when you need to review, manage, or audit the signing groups in your docusign account. note that while it provides extensive group information, it does not modify any group settings or memberships.
</Accordion>

<Accordion title="Docusign Retrieve Htmldefinition For Responsive Document">
  This endpoint retrieves the html definition used to generate a dynamically sized responsive document within a docusign envelope. it is specifically designed for documents created as signable html and provides detailed information about responsive signing and smart sections. the endpoint returns properties that define how to generate the responsive-formatted html for the document, including display settings, anchors, and styling options. it's particularly useful when implementing responsive signing across different devices or customizing the appearance of html documents in the signing process. note that for non-html documents or invalid document ids, the endpoint will return a 200 ok response with an empty json body, rather than an error.
</Accordion>

<Accordion title="Retrieve user initials image for envelopes">
  Retrieves the initials image for a specified user within a docusign envelope. this endpoint allows you to fetch the user's initials image in its original upload format, with an option to include or exclude the chrome (added line and identifier around the image). it's particularly useful when you need to display or process a recipient's initials within the context of an envelope. note that for older envelopes, only chromed images might be available, so you may need to implement fallback logic if retrieving a non-chromed image fails. the endpoint requires specific authentication and authorization, ensuring that the requested user id matches the authenticated user and that the user is a member of the account.
</Accordion>

<Accordion title="Docusign Retrieve User Profile Image">
  Retrieves the user profile picture for a specified user within a docusign account. this endpoint allows users to fetch their own profile image, which is returned in the same format as it was originally uploaded. it's particularly useful for applications that need to display user avatars or profile pictures within the docusign ecosystem. the endpoint ensures that users can only access their own profile image, maintaining privacy and security. if no profile image exists for the user, the endpoint will indicate this with a 404 not found response.
</Accordion>

<Accordion title="Retrieve user profile information">
  This endpoint retrieves comprehensive user profile information for a specified user within a docusign account. it provides detailed data about the user's personal information, settings, preferences, and permissions. the endpoint is particularly useful for obtaining an in-depth view of a user's configuration within the docusign system, including their authentication methods, email notification settings, and locale preferences. it should be used when detailed user information is required for account management, user customization, or auditing purposes. note that users can only access their own information, and the userid parameter must match the authenticated user's id. the endpoint does not allow for modification of user settings; it is strictly for retrieval of existing information.
</Accordion>

<Accordion title="Retrieve template page image">
  Retrieves a specific page image from a template document for display purposes. this endpoint is part of the docusign templates api and allows developers to fetch and display individual pages from template documents. it's particularly useful when you need to preview or display a specific page of a template without retrieving the entire document. the endpoint supports customization of the returned image through resolution (dpi) and dimension parameters, enabling optimized image delivery for various display requirements. it should be used when building interfaces that require visual representation of template pages, such as template preview features or document review systems. note that this endpoint retrieves static images and does not provide interactive elements or real-time template modifications.
</Accordion>

<Accordion title="Docusign Retrieve User Signature Image">
  Retrieves a specified user's signature or initials image from docusign. this endpoint allows you to fetch the image in its original upload format, with an option to include or exclude the chrome (frame) around the image. it's useful for applications that need to display or process user signatures. the endpoint requires specific user authentication and is limited to retrieving the authenticated user's own signature images. it supports various image types including stamps, signatures, and initials, making it versatile for different signature requirements in document workflows.
</Accordion>

<Accordion title="Retrieve user signature definitions">
  This endpoint retrieves the signature definitions for a specified user within a docusign account. it allows users to access their own signature information, including details about signature images, stamps, and associated metadata. the endpoint is useful for applications that need to display or manage user signatures within the docusign ecosystem. it supports retrieving different types of signatures based on the optional stamp type parameter. the response includes comprehensive information about each signature, such as creation date, image data, and various properties related to the signature's appearance and usage.
</Accordion>

<Accordion title="Docusign Retrieve Account Brand Information">
  Retrieves detailed information about a specific brand associated with a docusign account. this endpoint allows users to access comprehensive brand settings, including company name, languages, colors, logos, and resource urls for customizing various docusign experiences such as email, sending, and signing. it should be used when detailed brand information is needed for display, management, or customization purposes. the endpoint requires account branding to be enabled (either for signing, sending, or both) to function properly.
</Accordion>

<Accordion title="Docusign Retrieve User Signature Information">
  This endpoint retrieves the detailed structure and information of a single user signature within a docusign account. it provides comprehensive details about the signature, including its creation date, image uris, stamp properties, and associated rights. the endpoint is designed for users to access and review their own signature information, ensuring data privacy and security. it's particularly useful when users need to verify their signature settings or retrieve signature images for use in other contexts.
</Accordion>

<Accordion title="Docusign Return Brand Resource Metadata For Account">
  Retrieves metadata about the branding resources associated with a specific docusign account and brand. this endpoint returns detailed information about various brand resource types, including those used for sending, signing, email, and captive (embedded) signing experiences. it's particularly useful for developers who need to inspect or manage custom branding elements within a docusign integration. the endpoint should be used when you need to audit brand resources, prepare for updates, or gather information about the current branding configuration. note that this endpoint only returns metadata and uris for the resources, not the actual resource content. also, branding must be enabled for the account (either for signing, sending, or both) for this endpoint to return meaningful data.
</Accordion>

<Accordion title="Retrieve chunked upload metadata">
  Retrieves metadata for a specific chunked upload in docusign. this endpoint allows users to check the status, parts, and other details of a large file upload that has been split into chunks. it's particularly useful for verifying the integrity and completeness of an upload before committing it for use in other docusign operations, such as adding documents to envelopes. the endpoint does not return the actual content of the upload, only its metadata. it cannot retrieve information about expired, deleted, or already consumed chunked uploads. this tool is essential for managing and troubleshooting large file uploads in docusign, ensuring that all parts are present and the upload is ready for use.
</Accordion>

<Accordion title="Docusign Retrieve Account Verification Workflows">
  Retrieves a list of identity verification workflows available for a docusign account. this endpoint allows account administrators or senders to fetch details about the verification methods that can be applied to signers during the document signing process. it provides information about active, deactivated, or all workflows, depending on the query parameter. use this endpoint to understand the available identity verification options for your account, which can help in implementing secure signing processes.
</Accordion>

<Accordion title="Docusign Return Template Workflow Definition">
  Retrieves the workflow definition for a specified docusign template. this endpoint returns detailed information about the template's workflow, including scheduled sending settings, workflow status, and individual workflow steps. it's useful for understanding and managing the automated process flow of a template. the endpoint should be used when you need to examine or troubleshoot a template's workflow configuration. note that if the specified template does not have a workflow object, this method will return a 404 error. the response includes comprehensive data about the workflow, but does not modify the template or its workflow in any way.
</Accordion>

<Accordion title="Rotate page image for envelope">
  This endpoint rotates a page image within a specific document of an envelope in docusign. it allows users to change the orientation of a page to either left or right for improved display and readability. this function is particularly useful when dealing with documents that may have been scanned or uploaded in an incorrect orientation. the rotation is applied only to the display of the image and does not permanently alter the original document. use this endpoint when you need to adjust the viewing angle of a specific page within an envelope, especially before sending it for signatures or during the review process.
</Accordion>

<Accordion title="Retrieve default disclosure for envelope">
  Retrieves the default html-formatted electronic record and signature disclosure (ersd) for a specified envelope in docusign. this endpoint is used to obtain the standard disclosure text that recipients must agree to before signing documents electronically. it is particularly useful for retrieving language-specific versions of the disclosure and for ensuring compliance with electronic signature regulations.
</Accordion>

<Accordion title="Docusign Return Scheduled Sending Rules For Envelope">
  Retrieves the scheduled sending rules for a specific envelope in docusign. this endpoint is used to get information about when and how an envelope is scheduled to be sent, including any delay rules or specific send dates. it's particularly useful for managing automated or timed document workflows. the endpoint returns details such as the bulk list id (if applicable), the resume date, specific rules for sending, and the current status of the scheduled sending job. note that if the specified envelope or workflow step does not have a scheduled sending object, this method will return a 404 error. this tool should be used when you need to check or verify the scheduled sending settings for a particular envelope in your docusign account.
</Accordion>

<Accordion title="Docusign Retrieve Workflow Step For Template">
  Retrieves detailed information about a specific workflow step for a docusign envelope. this endpoint allows users to access the configuration and status of a single step within an envelope's workflow, including delayed routing settings and conditional recipient rules. it's particularly useful for monitoring the progress of complex, multi-step envelope processes or for troubleshooting issues with specific workflow steps. the endpoint provides read-only access to step details and should be used when you need to inspect or verify the current state and rules of a particular workflow step within an envelope. note that this endpoint does not allow modification of the workflow step; it is for retrieval purposes only.
</Accordion>

<Accordion title="Docusign Rotate Template Page Image">
  Rotates a page image within a docusign template for display purposes. this endpoint allows users to adjust the orientation of a specific page image to either the left or right within a template. it is particularly useful when preparing templates for use in electronic signature processes, ensuring that page images are correctly oriented for optimal viewing and signing. this operation only affects the display of the page image and does not alter the actual content of the document. use this endpoint when you need to correct or adjust the orientation of page images in your docusign templates before sending them out for signatures.
</Accordion>

<Accordion title="Returns document page images based on input">
  Retrieves images of document pages from a specific envelope in a docusign account. this endpoint allows users to fetch page images with customizable parameters such as resolution (dpi), image dimensions, and pagination options. it's particularly useful when you need to display or process document pages without downloading the entire document. the endpoint supports showing changes made to the document and can bypass caching for the most up-to-date images. it's ideal for applications that need to render document previews, perform image analysis, or create custom document viewers.
</Accordion>

<Accordion title="Retrieve cloud storage provider configuration">
  Retrieves the list of cloud storage providers enabled for a specific user in a docusign account, along with their configuration information. this endpoint is essential for integrating external cloud storage services with docusign, allowing users to access and manage documents from various providers. it provides details such as authentication urls and service ids for each enabled provider. use this endpoint when you need to display available cloud storage options to a user or initiate the authentication process for a specific provider. note that users can only access their own cloud storage information, and the endpoint does not modify any existing configurations.
</Accordion>

<Accordion title="Docusign Revoke Envelope Correction Url">
  This endpoint revokes the correction view url for a specific envelope in docusign, effectively disabling the ability to make further corrections to the envelope. it should be used when you want to prevent any additional modifications to an envelope that was previously available for correction. this is particularly useful in scenarios where the correction period has ended or when you need to lock an envelope's content for compliance or business process reasons. the endpoint requires the account id and envelope id to identify the specific envelope for which the correction view should be revoked. it's important to note that once revoked, the correction view cannot be reinstated without creating a new correction view url. this operation does not affect the envelope's content or status; it only restricts access to the correction interface.
</Accordion>

<Accordion title="Return users from connect service">
  Retrieves users associated with a specific docusign connect configuration for a given account. this endpoint allows account administrators to list and filter users linked to a custom connect setup, providing detailed user information such as email, account details, and user status. it's particularly useful for managing integrations and monitoring user access within a connect configuration. the endpoint supports pagination and various filtering options to handle large user lists efficiently.
</Accordion>

<Accordion title="Docusign Retrieve All Account Tabs">
  Retrieves a comprehensive list of all tabs associated with a specified docusign account. it returns detailed information about each tab, including type, label, validation rules, and formatting settings. use this endpoint for auditing tab configurations, managing account-wide tab settings, or integrating tab information into external systems. can be filtered to return only custom tabs if needed.
</Accordion>

<Accordion title="Docusign Retrieve Account Envelope Purge Config">
  Retrieves the current envelope purge configuration for a specified docusign account. this endpoint allows account administrators to view the settings that control how and when documents are permanently removed from completed and voided envelopes after a specified retention period. it provides crucial information for managing document lifecycle, data privacy, and storage optimization within the docusign platform. the configuration includes settings for enabling purging, redacting personally identifiable information (pii), removing associated tabs and attachments, and specifying the retention period in days. this method should be used when auditing or reviewing an account's document retention policies, or before making changes to the purge configuration. note that this endpoint is in beta status and requires account administrator privileges to access.
</Accordion>

<Accordion title="Send Envelope">
  Sends a draft envelope by updating its status to 'sent'. example envelope id format: '93be49ab-xxxx-xxxx-xxxx-f752070d71ec'
</Accordion>

<Accordion title="Set envelope purge config for account">
  Sets the envelope purge configuration for a specified docusign account, allowing account administrators to define automatic document removal policies for completed and voided envelopes. this endpoint enables configuration of purge settings, including retention period, pii redaction, and removal of associated tabs and attachments. it should be used when setting up or updating document retention and purging policies for an account. the method requires account administrator privileges and is currently in beta status. note that enabling pii redaction requires also enabling the removal of tabs and envelope attachments.
</Accordion>

<Accordion title="Docusign Retrieve Account Favorite Templates">
  Retrieves the list of favorite templates associated with a specified docusign account. this endpoint allows users to access their saved favorite templates, which can streamline document creation and signing processes. it's particularly useful for users who frequently work with the same set of templates and want quick access to them. the endpoint is currently in beta, so users should be aware that it may undergo changes or have limitations. it provides template ids, favorited dates, and a count of updated templates, but does not return the full template content.
</Accordion>

<Accordion title="Docusign Retrieve Envelope Attachment">
  Retrieves a developer-only envelope attachment from a specific envelope in docusign. this endpoint allows you to access files associated with an envelope that are not visible to signers. it should be used when you need to retrieve attachment files that were programmatically added to an envelope. the function returns the attachment as a binary file, which can then be processed or stored as needed. note that this operation is currently in beta status, which means it may undergo changes in the future. it's important to distinguish this from retrieving signer attachments, which is a separate process.
</Accordion>

<Accordion title="Set initials image for accountless signer">
  This endpoint allows you to update the initials image for a signer who does not have a docusign account within a specific envelope. it's used to customize the appearance of a signer's initials on documents, enhancing the personalization of the signing process. the endpoint supports various image formats (gif, png, jpeg, and bmp) with a file size limit of 200k. it's particularly useful for maintaining brand consistency or adding a personal touch to documents for signers without docusign accounts. note that this operation can only be performed by the envelope sender and is subject to specific account permissions.
</Accordion>

<Accordion title="Docusign Retrieve Connect Configurations">
  Retrieves all docusign custom connect definitions for a specified account. this endpoint allows account administrators to fetch detailed information about existing connect configurations, including webhook settings, event triggers, and delivery modes. it provides a comprehensive view of how the account is set up to send notifications for various docusign events. this tool is essential for managing and auditing connect integrations, but should only be used by authorized account administrators with connect enabled on their account.
</Accordion>

<Accordion title="Docusign Retrieve Connect Configuration Details">
  Retrieves detailed information for a specific docusign connect configuration. this endpoint allows account administrators to access and review the settings of a custom connect configuration, including event triggers, delivery modes, and integration details. it's particularly useful for auditing existing configurations or gathering information before making updates. the endpoint requires connect to be enabled on the account and is limited to account administrators only.
</Accordion>

<Accordion title="Set signature image for no account signer">
  This endpoint updates the signature image for an accountless signer in a docusign envelope. it allows you to set a custom signature image for recipients who don't have a docusign account, enhancing the flexibility of the signing process. the endpoint supports gif, png, jpeg, and bmp image formats, with a file size limit of less than 200k. it's specifically designed for use with accountless signers or in-person signers, providing a way to personalize their signature appearance. this function is useful when you need to customize the signature image for recipients who are not docusign account holders, such as one-time signers or in-person signing scenarios.
</Accordion>

<Accordion title="Toggle api request logging">
  This endpoint enables or disables api request logging for troubleshooting purposes in docusign. it allows users to toggle the logging of rest api requests and responses, set the maximum number of log entries, and view the remaining log capacity. the tool is crucial for debugging api integrations by providing detailed request/response information while ensuring sensitive data is omitted from the logs. it should be used when investigating api-related issues or monitoring api usage patterns. the endpoint has a limit of 50 log entries and automatically disables logging when this limit is reached. only requests from authenticated users are captured, and the logs can be retrieved or cleared using separate api calls.
</Accordion>

<Accordion title="Docusign Retrieve Apirequest Log Files">
  Retrieves a list of api request log entries from docusign, providing diagnostic information for developers. offers flexible response formats (json, xml, or zip file). returns key data about each api request, including timestamps, endpoints called, and request status. useful for troubleshooting, monitoring, and auditing api usage. note: may not provide real-time logs and time range of returned logs is unspecified.
</Accordion>

<Accordion title="Docusign Set User Signature Image">
  Sets or updates a user's signature image, initials, or stamp in their docusign account. this endpoint allows for customization of various signature elements used in electronic document signing. it supports different image types including full signatures, initials, and stamps, with options for specifying placement and format of date stamps. use this when a user needs to add or modify their signature assets within their docusign account. the endpoint doesn't handle the actual document signing process but focuses on managing the signature assets used in signing.
</Accordion>

<Accordion title="Docusign Retrieve Envelope Audit Events">
  Retrieves the audit events for a specified envelope in docusign. this endpoint allows users to access a detailed history of all actions and changes made to a particular envelope, providing a comprehensive audit trail. it is particularly useful for compliance, security, and tracking purposes, allowing users to monitor the lifecycle of important documents. the endpoint should be used when detailed information about an envelope's history is required, such as verifying signatures, tracking changes, or investigating discrepancies. note that this endpoint only provides audit events for a single envelope at a time and does not offer filtering or sorting options for the returned events.
</Accordion>

<Accordion title="Docusign Retrieve Available Account Stamps">
  Retrieves a list of stamps available in a docusign account. this endpoint allows users to fetch detailed information about various types of stamps, signatures, and related properties associated with the specified account. it's particularly useful for applications that need to display or manage available stamps for document signing processes. the endpoint returns comprehensive data including adoption dates, creation dates, image uris, and specific properties of each stamp or signature. use this when you need to present users with stamp options or when managing stamp resources within a docusign integration.
</Accordion>

<Accordion title="Docusign Return Envelope Tab Data For Existing Envelope">
  Retrieves detailed form data from a docusign envelope, including the current values of form fields, recipient information, and envelope status. this endpoint is used to download envelope and tab data from in-process, completed, or canceled envelopes that the user has sent or that are shared with them. it's particularly useful for analyzing form submissions, tracking recipient interactions, and integrating docusign data with external systems. the method requires the "allow sender to download form data" setting to be enabled for the account.
</Accordion>

<Accordion title="Docusign Retrieve Account Information For Specified Account">
  Retrieves comprehensive information for a specified docusign account, including account details, billing information, plan specifics, and optionally detailed account settings. this endpoint is used to gather extensive data about an account's configuration, status, and capabilities within the docusign platform. it's particularly useful for account management, auditing, or when needing to review or update account settings. the response includes critical information such as the account's guid, name, creation date, current plan details, and various feature enablements. when account settings are included, it provides a deep dive into the account's configuration, covering aspects like authentication requirements, branding options, envelope settings, and compliance-related configurations.
</Accordion>

<Accordion title="Set templates as account favorites">
  This endpoint allows users to set one or more templates as account favorites in docusign. it's used to mark specific templates for quick access within a user's account. the endpoint can handle multiple templates in a single request, making it efficient for bulk operations. it's particularly useful for users who frequently work with the same set of templates and want to streamline their workflow. note that this is a beta api and may be subject to changes in future versions.
</Accordion>

<Accordion title="Set up connect oauth configuration">
  Sets up connect oauth configuration for a specified docusign account using a custom authorization server. this endpoint enables secure, oauth-based communication for docusign connect, allowing real-time notifications about envelope status changes. it should be used when integrating docusign connect with your own authorization server for enhanced security and control over webhook notifications. this tool is essential for account administrators setting up or updating connect oauth configurations, but requires connect to be enabled on the account.
</Accordion>

<Accordion title="Docusign Retrieve List Of Billing Plans">
  Retrieves a comprehensive list of billing plans associated with a distributor in the docusign system. this endpoint provides detailed information about each billing plan, including plan names, ids, payment cycles, methods, and pricing details in various currencies. it is particularly useful for administrators or financial teams who need to review or manage billing options for their organization. the endpoint returns all available plans without requiring any input parameters, making it ideal for generating a complete overview of billing options. note that some fields in the response are reserved for docusign internal use and may not be relevant for all users.
</Accordion>

<Accordion title="Docusign Update Account Custom Field">
  This endpoint updates an existing account custom field in docusign. it allows you to modify the properties of a custom field, such as its name, type, required status, visibility, and value. the endpoint supports both list and text custom fields, enabling account administrators to refine and adjust custom metadata used for grouping and managing envelopes. use this endpoint when you need to change the configuration or content of an existing account-level custom field. note that this operation affects the custom field at the account level, potentially impacting all envelopes and templates that use this custom field.
</Accordion>

<Accordion title="Docusign Retrieve Items In Cloud Storage Folder">
  Retrieves a list of items (files and folders) from a specified folder in an integrated cloud storage provider. this endpoint allows users to browse and search their cloud storage contents directly within the docusign application, facilitating document selection for e-signature workflows. it supports pagination, sorting, and filtering options to efficiently manage large folders. use this endpoint when you need to list, locate, or select files from a user's cloud storage for docusign operations. note that this endpoint only provides metadata about the items and does not download the actual file contents.
</Accordion>

<Accordion title="Share template with group">
  This endpoint allows you to share a docusign template with a specified members group. it's used to grant access to templates for collaboration and reuse within an organization. note that this endpoint is deprecated, and for newer functionality, it's recommended to use the 'accounts: update shared access' endpoint instead. the operation updates the sharing settings for a specific template, enabling administrators to control template access across different groups efficiently.
</Accordion>

<Accordion title="Docusign Retrieve Account Password Rules">
  Retrieves the current password rules and security settings for a user's docusign account. this endpoint provides detailed information about password requirements, including expiration policies, complexity rules, lockout settings, and security question configurations. it's useful for applications that need to display or enforce docusign's password policies, or for users who want to understand the security requirements for their account. the tool returns a comprehensive set of rules that govern password management, helping to ensure compliance with the account's security standards. it should be used when detailed password policy information is needed, but not for actually changing or resetting passwords.
</Accordion>

<Accordion title="Retrieve connect failure logs">
  Retrieves the connect failure log information for a specified docusign account. this endpoint is specifically designed for account administrators to identify which envelopes failed to post during connect events. it provides detailed information about each failure, including error messages, retry counts, and uris for potential republishing attempts. the endpoint supports optional date range filtering to narrow down the search results. use this method when troubleshooting connect integration issues or when you need to analyze and potentially retry failed envelope postings. note that connect must be enabled on the account for this endpoint to function properly.
</Accordion>

<Accordion title="Docusign Update Account Brand Settings">
  The updateaccountbrandsettings endpoint modifies or replaces an existing brand configuration for a docusign account. it customizes various brand aspects like company name, languages, colors, and landing pages. use this tool to update branding elements for consistency across docusign interactions. it can update specific fields or replace the entire brand configuration. note that branding must be enabled for the account, and resource file modifications require separate api calls.
</Accordion>

<Accordion title="Docusign Update Account Watermark Preview">
  Updates and previews watermark settings for a docusign account. it customizes watermark appearance, including text, font, color, size, angle, and transparency. use when changing account-wide watermark configurations or previewing new settings. note: many fields require specific values; invalid inputs may default silently. this endpoint sets account watermark configuration, not document-specific application.
</Accordion>

<Accordion title="Update account watermark information">
  This endpoint updates the watermark settings for a specified docusign account. it allows customization of various watermark properties such as display angle, font, color, size, and transparency. the endpoint can be used to enable or disable the watermark feature, change the watermark text, or modify its appearance on documents. it's particularly useful for maintaining brand consistency, indicating document status, or adding security features to in-progress documents. the endpoint returns the updated watermark information, allowing immediate confirmation of changes. note that while most properties can be modified, the imagebase64 property is read-only and cannot be set through this call.
</Accordion>

<Accordion title="Update account password rules">
  This endpoint updates the password rules for a docusign account. it allows account administrators to modify various password policy settings, including expiration, complexity requirements, lockout durations, and security question requirements. use this endpoint to enhance account security, comply with organizational policies, or adapt to changing security needs. the endpoint provides extensive customization options, from basic password requirements to complex, multi-factor authentication setups. note that changes made through this endpoint will affect all users within the specified account, so it should be used carefully and in accordance with your organization's security policies.
</Accordion>

<Accordion title="Docusign Retrieve Envelope Documents">
  Retrieves one or more documents from a docusign envelope. this endpoint allows users to fetch a single document, all documents combined, or specific document sets in various formats (pdf, zip, pdf portfolio). it's particularly useful for accessing signed documents, certificates of completion, or entire envelope contents. the endpoint offers flexibility in document retrieval, supporting features like language customization, watermarking, and data change highlighting. use this when you need to download or access documents after they've been processed through docusign's electronic signature workflow.
</Accordion>

<Accordion title="Update account stamp by id">
  This endpoint allows you to update an existing account stamp (signature) in docusign. it provides extensive customization options for the stamp's appearance, associated users, and properties. use this when you need to modify an existing stamp's details, such as its image, font, size, or user permissions. the endpoint is particularly useful for maintaining up-to-date and personalized stamps for document signing. note that this operation will overwrite the existing stamp properties, so ensure all desired properties are included in the request, even if they haven't changed.
</Accordion>

<Accordion title="Submit batch historical envelopes to webhook">
  This endpoint submits a batch of existing envelopes to a specified webhook for historical publishing. it allows you to retroactively send envelope data to your systems for completed transactions, which is useful for data synchronization, auditing, or recovering missed notifications. the endpoint uses an ad hoc configuration provided in the request, rather than relying on existing connect configurations. unlike regular connect listeners that monitor new activity, this endpoint is specifically designed for publishing historical data on demand. it only supports json format for data transmission and allows fine-grained control over which envelope data and events are included in the webhook payload. the endpoint is particularly useful when you need to backfill data, synchronize systems after downtime, or perform bulk operations on historical envelopes.
</Accordion>

<Accordion title="Retrieve connect logs">
  Retrieves the 100 most recent connect log entries for a specified docusign account. this endpoint is essential for monitoring and troubleshooting docusign connect integrations, providing detailed information about both successful and failed connect events. it allows administrators to review recent activities, identify issues, and ensure proper functioning of their connect configurations. the endpoint supports date-based filtering to narrow down the log entries within a specific time range. note that this endpoint requires administrator access and connect must be enabled on the account with logging turned on. log entries are only retained for 15 days.
</Accordion>

<Accordion title="Return all connect service users">
  Retrieves all users from the configured connect service for a specific docusign account and connect configuration. this endpoint allows account administrators to fetch user information, including email addresses, user ids, and inclusion status in the connect service. it supports filtering by email, username, and status, as well as pagination for large result sets. this tool should be used when you need to obtain a comprehensive list of users associated with a particular connect configuration, which is useful for auditing, user management, or integration purposes. note that this endpoint requires connect to be enabled on the account and can only be accessed by account administrators.
</Accordion>

<Accordion title="Docusign Update Account Stamps">
  This endpoint allows you to add or update one or more account stamps (signatures) for a docusign account. it provides extensive flexibility in modifying various attributes of signatures, including images, fonts, rights, and stamp details. use this endpoint when you need to create new signatures or modify existing ones for an account, such as updating signature images, changing default settings, or adjusting stamp properties. the endpoint supports batch updates, allowing multiple signatures to be modified in a single request. note that this operation may include handling of image data in multi-part format.
</Accordion>

<Accordion title="Update billing plan for account">
  Updates billing plan information, address, and payment details for a docusign account. allows comprehensive modifications to billing setup, including payment methods, plan features, and promotional offers. offers a preview mode for reviewing changes before applying. use for significant billing configuration changes or plan transitions. exercise caution as it may trigger immediate billing changes.
</Accordion>

<Accordion title="Set shared access for users and templates">
  This endpoint sets shared access for users and templates in docusign. it manages collaboration and access control within an organization for envelopes, templates, and folders. only users with admin privileges can set envelope access, while template access requires ownership or admin rights. changes replace current status, not add to it. use 'item type=templates' for template access. it's an improved version of update group share, offering more granular control.
</Accordion>

<Accordion title="Docusign Register Current User As Notary">
  This endpoint registers the current user as a notary in docusign, enabling remote online notarization capabilities. it configures the user's notary profile, settings, and permissions. use this when setting up a new notary within the docusign system. note that this does not replace legal notary certification requirements.
</Accordion>

<Accordion title="Docusign Update Account Settings">
  Updates various settings for a specified docusign account. this endpoint allows administrators to configure a wide range of account-level options, including security settings, compliance features, and user interface preferences. use this when you need to modify your docusign account configuration to align with organizational needs and policies. note that many settings require administrative privileges, and some may have interdependencies with other features.
</Accordion>

<Accordion title="Update connect oauth configuration">
  This endpoint updates an existing connect oauth configuration for a docusign account. use it to modify oauth settings for docusign connect integrations, such as updating authorization urls, client credentials, or scopes. it's crucial for maintaining secure data exchange between docusign and integrated systems. exercise caution when using this endpoint, as incorrect changes may disrupt existing integrations.
</Accordion>

<Accordion title="Update envelope custom fields">
  This endpoint allows users to update custom fields for draft and in-process envelopes in docusign. it enables the modification of both list-based and text-based custom fields, which can be used for sorting, organizing, searching, and other downstream processes. this tool is particularly useful when you need to add or modify envelope-specific data that is not captured by standard docusign fields. it should be used when customizing envelopes with additional metadata or when implementing specialized workflows, such as evaulting for eoriginal customers. note that these custom fields are visible to envelope creators and senders in the envelope settings section but are not visible to envelope recipients.
</Accordion>

<Accordion title="Update custom fields in envelope document">
  This endpoint allows you to update existing custom document fields in a specific document within an envelope in docusign. custom document fields are name-value pairs that can be used to store additional metadata or information about the document. this function is useful when you need to modify or add custom data to a document that is already part of an envelope. it's important to note that while docusign returns this custom field information in the status, it does not use this data for any internal processes. this endpoint should be used when you need to update or add custom metadata to a document in an existing envelope, but not for modifying the actual content of the document or the envelope's core properties.
</Accordion>

<Accordion title="Update Envelope DocGen Form Fields">
  This method dynamically generates an envelope's documents by populating its sender fields. the envelope must be in a draft state. use the documentgeneration::getenvelopedocgenformfields response to retrieve the list of sender fields for your envelope. use that list to build the request for this method. for each field, specify the field name and the value to populate. important notes: - if update docgen formfields only is false (the default), the documentid changes after the update. - this endpoint does not validate number, date, or select data field values. the request can succeed even if a number or date field value is not a valid number or date, or if a select field value is not one of the allowed values.
</Accordion>

<Accordion title="Docusign Update Bulk Send Batch Name">
  Updates the name of an existing bulk send batch in docusign. this endpoint allows users to rename a specific batch identified by its batch id within a given docusign account. it's useful for organizing and managing multiple bulk send batches, especially when dealing with large-scale document processing. the operation returns detailed information about the updated batch, including its current status, envelope information, and any potential errors. this endpoint should be used when you need to modify the name of a bulk send batch for better identification or organization purposes. it doesn't modify any other properties of the batch or its associated envelopes. note that while the operation itself is straightforward, it's important to ensure the provided batch id is valid and the new name adheres to the 500-character limit.
</Accordion>

<Accordion title="Docusign Update Lock For Envelope">
  Updates the lock information for a locked envelope in docusign. this endpoint allows you to modify the duration of the lock and the name of the application that locked the envelope. it's particularly useful when you need to extend the lock time or update the locking application's identifier. the endpoint requires the x-docusign-edit header for authentication and returns comprehensive information about the updated lock, including its new duration, expiration time, and a unique lock token for future operations. use this when managing long-running operations on envelopes to prevent conflicts from simultaneous edits.
</Accordion>

<Accordion title="Update envelope notification settings">
  Updates the notification settings for a specific docusign envelope, including reminders and expirations. this endpoint allows you to customize when and how often recipients receive reminder emails, as well as set the expiration period for the envelope. it can either apply custom settings or use the account's default notification settings. the method only updates the settings and does not trigger the sending of any notifications. use this when you need to modify the reminder or expiration behavior for an existing envelope, such as extending the expiration date or adjusting the frequency of reminders.
</Accordion>

<Accordion title="Update custom tab information for account">
  This endpoint updates the information for a custom tab associated with a specific docusign account. it allows for extensive customization of tab properties, including appearance, behavior, and positioning within documents. the endpoint is used when modifying existing custom tabs to change their characteristics or functionality. it provides granular control over tab settings but requires careful consideration of the numerous optional parameters to avoid unintended changes.
</Accordion>

<Accordion title="Docusign Update Document Visibility Recipients">
  This endpoint updates document visibility settings for one or more recipients within a specific docusign envelope. it allows you to control which documents each recipient can see and whether they have read-only or edit rights. the method is particularly useful for managing complex envelopes with multiple documents and recipients, ensuring that sensitive information is only accessible to intended parties. note that certain recipient types (carbon copy, certified delivery, editor, and agent) always have visibility to all documents, and documents with assigned tabs cannot be hidden from their respective recipients.
</Accordion>

<Accordion title="Update envelope scheduled sending rules">
  Updates the scheduled sending rules for an envelope's workflow in docusign. this endpoint allows users to set or modify when an envelope will be sent, providing precise control over document delivery timing. it can be used to delay sending, schedule future sends, or manage bulk send operations with specific timing. the endpoint is particularly useful for automating complex document workflows or coordinating large-scale document distributions.
</Accordion>

<Accordion title="Docusign Update Document Visibility For Template Recipients">
  This endpoint updates document visibility settings for one or more recipients in a docusign template. it allows fine-grained control over which documents are visible to specific recipients, enhancing document security and workflow customization. the method is particularly useful when you need to restrict access to certain documents for some recipients while maintaining full visibility for others. however, it's important to note that some recipient types (carbon copy, certified delivery, editor, and agent) will always have full document visibility, and documents with assigned tabs cannot be hidden from their respective recipients.
</Accordion>

<Accordion title="Docusign Update Enote Integration Config">
  Updates the enote integration configuration for a specific docusign account. this endpoint allows users to modify settings related to enote functionality, including api key, connect configuration, enote configuration, organization details, and user credentials. it should be used when setting up or modifying the enote and eoriginal integration for secure electronic document management. the endpoint requires the account to have the 'allow enote for eoriginal' plan item enabled. note that this is a beta api and may be subject to changes. ensure that both connect and eoriginal are properly configured for the integration to work correctly.
</Accordion>

<Accordion title="Update electronic record disclosure">
  This endpoint updates the electronic record and signature disclosure (ersd) for a docusign account. it allows administrators to customize the default disclosure, switch to a custom one, or update existing custom disclosures in multiple languages. the endpoint is essential for compliance and tailoring the signer experience. only account administrators can use this method, and changes may require unsigned recipients to accept a new disclosure version.
</Accordion>

<Accordion title="Docusign Update Envelope Email Settings">
  Updates the existing email override settings for a specified envelope in docusign. this endpoint allows customization of the reply to email address and name, as well as bcc email addresses for a specific envelope. it's particularly useful when you need to modify email settings for an individual envelope without affecting account-level settings. note that changes only apply to future email communications related to the envelope. this endpoint can also be used to remove individual email override settings by providing an empty string for the value to be deleted.
</Accordion>

<Accordion title="Update envelope workflow step">
  Updates a specific workflow step for a docusign envelope, allowing for customization of envelope processing, including delayed routing and conditional recipients. this endpoint can be used to modify workflow steps for both draft envelopes and sent envelopes (as long as the previous step hasn't been completed). it enables features like scheduled sending and complex routing rules based on recipient actions or document content. the endpoint is particularly useful for implementing advanced document workflows, such as time-based routing or conditional approval processes.
</Accordion>

<Accordion title="Docusign Update Envelope Delayed Routing Rules">
  Updates the delayed routing rules for a specific workflow step in a docusign envelope. this endpoint allows you to add or modify delayed routing settings for both draft and sent envelopes, as long as the previous workflow step has not been completed. it enables you to control when the envelope will be sent to the recipients associated with the workflow step, either by specifying a relative delay or an exact future date and time. the endpoint can be used to implement timed workflows, schedule future sendings, or adjust existing delay rules. note that updating an in-progress delay will reset the countdown.
</Accordion>

<Accordion title="Update contacts information">
  This endpoint updates one or more contacts associated with a docusign account. it allows for comprehensive modifications to contact information, including personal details, communication methods, and notary-specific data. the endpoint supports bulk updates, enabling efficient management of multiple contacts in a single api call. it's particularly useful for maintaining up-to-date contact records, especially in scenarios involving shared contacts or notary services. the endpoint returns the updated contact details upon successful execution, providing immediate confirmation of the changes made.
</Accordion>

<Accordion title="Docusign Update Recipient Document Visibility">
  This endpoint updates the document visibility settings for a specific recipient within a docusign envelope. it allows fine-grained control over which documents a recipient can see and whether they have read-only or edit access. use this when you need to modify document access for a particular recipient after an envelope has been created. this is particularly useful for managing complex workflows where different recipients need access to different sets of documents. note that you cannot hide documents from recipients who have tabs assigned to them, and certain recipient types always have full document visibility.
</Accordion>

<Accordion title="Update envelope workflow definition">
  Updates the workflow definition for a specified envelope in docusign. it allows modification of scheduled sending, delayed routing, and conditional recipient rules. use this endpoint to add or update scheduling for draft or in-progress envelopes, or to add delayed routing to envelopes not yet in workflow processing. the tool supports complex document workflows with timed actions, conditional processing, and staged approvals.
</Accordion>

<Accordion title="Update envelope attachment">
  Updates an existing attachment for a draft or in-process envelope in docusign. this endpoint allows you to modify attachment properties such as access control, type, content, label, and name. it supports file attachments up to 50 mb and provides options for chunked uploads of large files. use this endpoint when you need to update or replace an attachment that has already been added to an envelope, before it has been sent for signing. note that this endpoint is specifically for envelope attachments (developer-only files) and should not be confused with signer attachments.
</Accordion>

<Accordion title="Update group information">
  Updates group information and modifies or sets permission profiles for specified groups within a docusign account. this endpoint allows administrators to manage user groups, their names, and associated permissions efficiently. it should be used when there's a need to change group details or update permission settings for multiple users simultaneously. the endpoint provides a way to streamline user management and access control in docusign, particularly useful for large organizations with complex permission structures.
</Accordion>

<Accordion title="Update notary jurisdiction info">
  Updates the jurisdiction information for a notary in the docusign system. this endpoint allows for modification of various details related to a notary's commission and jurisdiction settings. it should be used when there are changes to a notary's information, such as their registered name, commission expiration date, or seal type. the endpoint requires a full jurisdiction object in the request body, even when updating only specific fields. it's important to note that this endpoint can only be used by authenticated users who are registered notaries and for jurisdictions they are authorized for.
</Accordion>

<Accordion title="Update template lock information">
  This endpoint allows you to update the lock information for an already locked template in docusign. it is used to modify the duration of an existing lock or change the name of the application that has locked the template. this operation is crucial for managing access to templates that are currently being edited, ensuring that multiple users don't make conflicting changes simultaneously. the endpoint requires the x-docusign-edit header for authorization and can update specific lock properties without affecting others. it should be used when you need to extend a lock duration or update the locking application's identifier, but not for creating new locks or unlocking templates.
</Accordion>

<Accordion title="Update template document custom fields">
  This endpoint updates existing custom document fields in a specific document within a docusign template. it allows you to modify metadata associated with a template document without changing the document's content or structure. use this when you need to update or add custom information to a template document, such as internal reference numbers, project codes, or any other metadata relevant to your document workflow. the endpoint is particularly useful for maintaining up-to-date metadata in frequently used templates without recreating them. note that while docusign stores and returns these custom fields, it does not process or use them for any internal operations. the update is specific to a single document within a template, identified by the documentid parameter.
</Accordion>

<Accordion title="Docusign Update Signing Group Names">
  Updates the names of one or more existing signing groups in docusign. this endpoint allows you to modify the names of signing groups, which are collections of users grouped together for document signing purposes. it's useful when you need to rename signing groups to reflect organizational changes or improve clarity. the endpoint updates only the group names and doesn't modify other group properties or memberships. use this when you need to maintain accurate and up-to-date naming conventions for your signing groups.
</Accordion>

<Accordion title="Update docusign connect configuration">
  This endpoint updates an existing docusign connect configuration for a specified account. it allows you to modify various settings such as the events that trigger notifications, the endpoint url for receiving webhooks, data format preferences, and integration details with salesforce. use this endpoint when you need to change the behavior of your connect configuration, such as enabling or disabling it, updating the notification url, or modifying the events that trigger updates. it's particularly useful for adjusting your integration as your application's needs evolve or when troubleshooting issues with your webhook setup. note that this endpoint requires account administrator privileges and connect must be enabled on the account. be cautious when updating critical settings like 'requiresacknowledgement' or 'usesoapinterface', as they can significantly impact how your application receives and processes docusign notifications.
</Accordion>

<Accordion title="Update template notification settings">
  This endpoint updates the notification structure for an existing docusign template. it allows users to customize reminder and expiration notifications for a specific template, which can then be used to create envelopes with these predefined settings. the endpoint is particularly useful when you need to modify the notification behavior for a frequently used template without changing the template's core content. it provides granular control over when and how often recipients are reminded about pending signatures, as well as when the envelope will expire. this functionality helps in managing document workflows more efficiently by reducing the need for manual follow-ups and ensuring timely completion of signing processes.
</Accordion>

<Accordion title="Docusign Update Template Recipient Document Visibility">
  This endpoint updates the document visibility settings for a specific recipient in a docusign template. it allows you to control which documents are visible to particular recipients, enhancing document security and customizing the signing experience. use this when you need to modify document access for a recipient after a template has been created. note that you cannot hide documents from recipients who have tabs assigned to them, and certain recipient types (carbon copy, certified delivery, editor, and agent) will always have visibility to all documents.
</Accordion>

<Accordion title="Docusign Update Template Scheduled Sending Rules">
  Updates the scheduled sending rules for a docusign template, allowing users to configure delayed sending for envelopes. this endpoint enables setting up either a relative delay or a specific future date for sending envelopes based on the template. it can be used to automate timed document delivery or coordinate with bulk send operations. the tool is particularly useful for managing complex document workflows that require precise timing or coordination with other business processes. note that the maximum delay allowed is 30 days from the time of the request.
</Accordion>

<Accordion title="Update user signature by id">
  Updates or creates a user's signature and initials for a specified docusign account. this endpoint allows for customization of signature appearance, including font, stamp format, and date stamp properties. it can be used to modify an existing signature or create a default signature if one doesn't exist. the endpoint requires the user to be authenticated and a member of the specified account, with the userid matching the authenticated user's id. it's particularly useful for personalizing signature appearance or creating new signatures for users within an organization's docusign account.
</Accordion>

<Accordion title="Docusign Update User Authorization Dates">
  Updates the start and/or end dates for a specified user authorization in docusign. this endpoint allows account administrators or the principal user to modify the duration of an existing authorization, enabling precise control over when an agent can act on behalf of the principal user. it's particularly useful for extending or shortening authorization periods, ensuring that access rights are aligned with business needs and security policies. the endpoint returns detailed information about the updated authorization, including user details and permission levels. use this when you need to adjust the timeframe of an existing user authorization without changing other authorization parameters.
</Accordion>

<Accordion title="Update signing group details">
  Updates the details of a specified signing group within a docusign account, including the group name, email, and member information. this endpoint allows for modifying existing group data and adding new members to the signing group, with a maximum limit of 50 members per group. it's particularly useful for managing and maintaining up-to-date signing group information, ensuring efficient document routing and signing processes. the endpoint requires the account id and signing group id for identification, and returns comprehensive details about the updated signing group, including creation and modification timestamps. use this when you need to modify signing group properties or adjust its membership, but be aware of the 50-member limit per group.
</Accordion>

<Accordion title="Docusign Update Template Workflow Definition">
  Updates the workflow definition for a specified template in docusign, allowing for customization of the document signing process. this endpoint enables users to modify the sequence of steps, set up conditional routing, schedule envelope sending, and define recipient rules for a template. it's particularly useful for complex signing workflows that require precise control over the timing and conditions of each step in the process. the updated workflow can include features such as delayed sending, conditional recipients, and paused steps, providing flexibility in managing the document lifecycle. this tool should be used when there's a need to modify or refine the existing workflow of a template to accommodate specific business processes or compliance requirements. it's important to note that this update affects only the workflow definition and does not modify other aspects of the template such as document content or basic recipient information.
</Accordion>

<Accordion title="Update template custom fields">
  Updates the custom fields in a docusign template. this endpoint allows you to modify both list and text custom fields associated with a specific template, ensuring each field has a unique name. it's used to customize templates for specific use cases, enabling prepopulation of metadata for envelopes created from the template. the endpoint supports updating multiple custom fields in a single request, making it efficient for batch updates. however, it does not create new custom fields; it only modifies existing ones.
</Accordion>

<Accordion title="Update workflow step for template">
  This endpoint updates a specified workflow step for a docusign template. it allows users to modify various aspects of the workflow step, including delayed routing settings, recipient routing rules, and conditional recipient configurations. the endpoint is used to fine-tune the automation and customization of document workflows within docusign templates. it's particularly useful for implementing complex routing scenarios, adding delays in document processing, or setting up conditional recipient rules based on form field values or other criteria. this tool should be used when there's a need to modify existing workflow steps in a template to adjust the document routing process or recipient handling.
</Accordion>

<Accordion title="Docusign Update Template Delayed Routing Rules">
  This endpoint updates the scheduled sending rules for a specific workflow step in a docusign template. it allows users to set up delayed routing for envelopes, controlling when documents are sent to recipients associated with the workflow step. the function can be used to implement time-based workflows, such as sending documents after a specified delay or at a future date. it's particularly useful for managing complex document processes that require timed releases or staged approvals. the endpoint supports setting either a relative delay or an exact send date, but not both simultaneously. note that the maximum allowed delay is 30 days from the time of the request.
</Accordion>

<Accordion title="Docusign Update Workspace Information">
  Updates information about a specific docusign workspace. this endpoint allows you to modify various aspects of a workspace, including its name, description, settings, and status. it's used when you need to change workspace details or adjust collaboration settings. the endpoint requires both the account id and workspace id to identify the specific workspace to update. you can update multiple properties of the workspace in a single request by including them in the request body. note that this operation may affect all users with access to the workspace, so use it carefully. the endpoint returns the full updated workspace object, allowing you to confirm the changes made.
</Accordion>

<Accordion title="Docusign Update Workspace Item Metadata">
  This endpoint updates the metadata for one or more specific files or folders in a docusign workspace. it allows users to modify information associated with workspace items without changing the actual content of the files. this method is useful for updating properties such as names, permissions, or other metadata attributes of workspace items. it should be used when changes to item details are needed, but not for modifying the file contents themselves. the endpoint requires specific identification of the account, workspace, and item (file or folder) being updated.
</Accordion>

<Accordion title="Update user profile image">
  Updates a user's profile image in docusign by uploading a new image file. this endpoint allows users to personalize their docusign account by changing their profile picture. the tool supports various image formats (gif, png, jpeg, and bmp) and has specific size and dimension recommendations for optimal display. it's important to note that users can only update their own profile image, and the actual method of sending the image file is not specified in the schema.
</Accordion>

<Accordion title="Update user account settings">
  This endpoint updates the account settings and email notification types for a specified user in docusign. it allows for comprehensive customization of a user's experience within the docusign platform, including locale preferences, timezone settings, email notifications, account management capabilities, and template management options. the endpoint is particularly useful when administrators need to modify user settings en masse or when users require specific configuration changes to align with their workflow or organizational requirements. it's important to note that while this endpoint offers extensive customization, some settings may be restricted based on the user's permissions or account type. additionally, changes made through this endpoint may have immediate effects on the user's docusign experience and should be used judiciously.
</Accordion>

<Accordion title="Docusign Update User Profile Information">
  Updates a user's profile in docusign, including personal details, privacy settings, and user id card information. it allows modifications to name, address, locale preferences, and various account settings. users can only update their own information. some settings may require admin rights to modify. use for keeping user profiles current and adjusting preferences.
</Accordion>

<Accordion title="Update user information for specified user">
  The user putuser endpoint allows updating user information for a specified user within a docusign account. it provides comprehensive control over user settings, including personal information, permissions, notification preferences, and locale settings. this endpoint should be used when modifying user profiles, adjusting user permissions, or updating user-specific configurations within a docusign account. the operation requires the account id and user id as path parameters, and accepts a complex json object in the request body containing the updated user information. note that users can only access and modify their own information, even if they have administrative privileges. the endpoint returns the updated user information upon successful modification.
</Accordion>

<Accordion title="Docusign Update User Notary Information">
  The updateusernotaryinformation endpoint modifies a notary's profile and settings in docusign. it manages account details, preferences, and operational parameters. use this to update a notary's visibility, capabilities, or personal settings. it's crucial for maintaining accurate records and ensuring compliance with regulations. note that all required fields must be provided, even for partial updates.
</Accordion>

<Accordion title="Docusign Update Permission Profile Settings">
  This endpoint updates an existing account permission profile in docusign. it allows administrators to modify various settings and permissions for users associated with the profile, providing granular control over user capabilities within the docusign platform. the endpoint is used to customize user access rights, configure notification preferences, and set other account-specific options. it's particularly useful for maintaining security and tailoring user experiences based on roles or departments within an organization. note that this endpoint requires administrative access and should be used cautiously, as changes can significantly impact user abilities and workflow processes.
</Accordion>


# Dropbox
Source: https://docs.push.ai/integrations/dropbox



Dropbox is a file hosting service that offers cloud storage, file
synchronization, personal cloud, and client software.

<Accordion title="Move File or Folder">
  Moves a file or folder to a different location in dropbox. requires the files.write scope.
</Accordion>

<Accordion title="Read a File">
  Reads a file in dropbox. requires the files.content.read scope.
</Accordion>

<Accordion title="Search File or Folder">
  Searches for a file or folder in dropbox. requires the files.read scope.
</Accordion>

<Accordion title="Upload File">
  Uploads a file to dropbox (supports various file types through filetype). requires the files.content.write scope.
</Accordion>

<Accordion title="Create Folder">
  Creates a folder in dropbox. requires the files.write scope.
</Accordion>

<Accordion title="Create File Request">
  Creates a new file request in dropbox. requires the file requests.write scope.
</Accordion>

<Accordion title="Create Paper Document">
  Creates a new paper document in dropbox with direct content. requires the files.content.write scope.
</Accordion>

<Accordion title="Delete File or Folder">
  Deletes a file or folder in dropbox. requires the files.write scope.
</Accordion>

<Accordion title="Get About Me">
  Get information about the owner account in dropbox.
</Accordion>


# Dynamics365
Source: https://docs.push.ai/integrations/dynamics365



Dynamics 365 from Microsoft combines CRM, ERP, and productivity apps to streamline sales, marketing, customer service, and operations in one integrated platform

<Accordion title="Create Contact">
  Creates a new contact entity record in dynamics crm using the web api.
</Accordion>

<Accordion title="Update Opportunity">
  Updates an existing opportunity entity record in dynamics crm using the web api.
</Accordion>

<Accordion title="Update Lead">
  Updates an existing lead entity record in dynamics crm using the web api.
</Accordion>

<Accordion title="Create Account">
  Creates a new account entity record in dynamics crm using the web api.
</Accordion>

<Accordion title="Update Sales Order">
  Updates an existing sales order entity record in dynamics crm using the web api.
</Accordion>

<Accordion title="Create Invoice">
  Creates a new invoice entity record in dynamics crm using the web api.
</Accordion>

<Accordion title="Get all invoices action">
  Get all invoices action
</Accordion>

<Accordion title="Create Case">
  Creates a new case (incident) entity record in dynamics crm using the web api.
</Accordion>

<Accordion title="Create Lead">
  Creates a new lead entity record in dynamics crm using the web api.
</Accordion>

<Accordion title="Create Opportunity">
  Creates a new opportunity entity record in dynamics crm using the web api.
</Accordion>

<Accordion title="Create Sales Order">
  Creates a new sales order entity record in dynamics crm using the web api.
</Accordion>

<Accordion title="Get all leads action">
  Get all leads action
</Accordion>

<Accordion title="Update Invoice">
  Updates an existing invoice entity record in dynamics crm using the web api.
</Accordion>

<Accordion title="Update Case">
  Updates an existing case (incident) entity record in dynamics crm using the web api.
</Accordion>

<Accordion title="Get lead action">
  Get lead action
</Accordion>

<Accordion title="Get invoice action">
  Get invoice action
</Accordion>


# Echtpost
Source: https://docs.push.ai/integrations/echtpost



EchtPost facilitates secure digital communication, encryption, and data privacy, providing a reliable channel for sending confidential documents and messages

<Accordion title="List templates">
  This tool retrieves a list of all available templates in the echtpost account. templates serve as the base design for postcards and are essential for creating cards. the action operates independently using only an authentication token and returns detailed template information including id, name, description, preview url, type, and creation time. this action is crucial for viewing templates before creating cards and obtaining the necessary template ids for subsequent actions.
</Accordion>


# Elevenlabs
Source: https://docs.push.ai/integrations/elevenlabs



Create natural AI voices instantly in any language - perfect for video creators, developers, and businesses.

<Accordion title="Add voice for public user">
  Adds a shared voice to a user's account in the elevenlabs text-to-speech platform. this endpoint allows users to incorporate voices shared by other users into their own voice library. it requires specifying the public user id of the account adding the voice, the unique identifier of the voice being added, and a new name for the voice in the user's account. this endpoint is useful for expanding a user's voice options and collaborating with other users on the platform. note that this endpoint only adds an existing shared voice and does not create a new voice or modify the original shared voice.
</Accordion>

<Accordion title="Add voice with file for cloning">
  The 'add voice' endpoint allows users to add a new voice to the elevenlabs platform for voice cloning and synthesis. it initiates the voice cloning process by uploading audio samples and providing necessary metadata. this endpoint should be used when creating a new custom voice for text-to-speech applications. it's particularly useful for developers looking to expand their voice options or create personalized voice experiences. the endpoint requires at least one audio file for voice cloning, but multiple files can be provided for better results. note that the actual voice cloning process may take some time after the successful api call, and the voice may not be immediately available for use.
</Accordion>

<Accordion title="Add pronunciation dictionary via file">
  This endpoint allows users to add a new pronunciation dictionary to the elevenlabs text-to-speech system by uploading a lexicon file. it is primarily used to improve pronunciation accuracy for specific words, technical terms, or domain-specific vocabulary in speech synthesis. the endpoint accepts a .pls file containing pronunciation rules, along with metadata such as name, description, and access control settings. this function is essential for customizing and fine-tuning the text-to-speech output for specialized use cases or languages.
</Accordion>

<Accordion title="Add rules to pronunciationdictionary">
  This endpoint adds pronunciation rules to a specific pronunciation dictionary in the elevenlabs text-to-speech platform. it allows users to define custom pronunciations for words or phrases, enhancing the accuracy and naturalness of speech synthesis. the endpoint supports two types of rules: alias rules for simple string replacements, and phoneme rules for specifying exact pronunciations using phonetic alphabets like ipa or cmu. this functionality is particularly useful for handling proper nouns, acronyms, or words with non-standard pronunciations. use this endpoint when you need to fine-tune the pronunciation of specific words in your text-to-speech applications.
</Accordion>

<Accordion title="Add new project with attributes">
  Creates a new text-to-speech project in the elevenlabs platform with customizable voice and content settings. this endpoint allows for initializing a project from a url or uploaded document, setting default voices for titles and paragraphs, specifying audio quality, and applying pronunciation dictionaries. it's particularly useful for creating audiobooks, podcasts, or other long-form audio content with consistent voice and pronunciation settings. the project can be initialized with content or left blank for later population.
</Accordion>

<Accordion title="Delete history item by id">
  Deletes a specific history item from the user's elevenlabs account. this endpoint permanently removes the selected item from the history, including its associated metadata and audio file. it should be used when a user wants to clean up their history or remove sensitive or unnecessary items. the deletion is irreversible, so caution should be exercised when using this endpoint. it's important to note that this operation only affects the user's history and does not impact any other data or settings in their account.
</Accordion>

<Accordion title="Delete dubbing by id">
  Deletes a specific dubbing asset from the elevenlabs platform. this endpoint should be used when you need to permanently remove a dubbing project or its associated audio files from your account. it's important to note that this action is irreversible, and once a dubbing asset is deleted, it cannot be recovered. use this endpoint with caution, ensuring that the dubbing asset is no longer needed before deletion. this operation helps manage storage and organize your dubbing projects by removing unnecessary or outdated content.
</Accordion>

<Accordion title="Convert chapter to another format">
  Converts a specific chapter within a project to audio format using elevenlabs' text-to-speech technology. this endpoint is used to transform the textual content of a chapter into high-quality, natural-sounding speech. it's particularly useful for creating audiobooks, podcast episodes, or any other audio content from written material. the conversion process applies the advanced text-to-speech algorithms of elevenlabs, potentially allowing for customization of voice characteristics and speech patterns. users should ensure that the project and chapter ids are correct before making the request, as incorrect ids will result in failed conversions.
</Accordion>

<Accordion title="Delete chapter from project">
  Deletes a specific chapter from a project within the elevenlabs platform. this endpoint is used to remove unwanted or obsolete chapters from a project, helping to manage and organize text-to-speech content. it should be used when a user needs to permanently remove a chapter and its associated data from a project. note that this action is irreversible, and once a chapter is deleted, it cannot be recovered. ensure that the correct project id and chapter id are provided to avoid unintended deletions.
</Accordion>

<Accordion title="Delete voice sample">
  Deletes a specific voice sample associated with a particular voice in the elevenlabs text-to-speech system. this endpoint should be used when you need to remove a previously added custom voice sample from a voice. it's particularly useful for managing voice libraries, cleaning up unused samples, or complying with data retention policies. note that this operation is irreversible, and once a sample is deleted, it cannot be recovered. use this endpoint with caution as it permanently removes data from the system.
</Accordion>

<Accordion title="Convert project data by id">
  Converts text to speech within a specified project using elevenlabs' advanced text-to-speech synthesis. this endpoint allows developers to generate high-quality, natural-sounding voice audio from provided text, leveraging project-specific settings and voices. it's ideal for creating dynamic audio content, voice-overs, or integrating speech capabilities into applications. the conversion process takes into account project-specific configurations, ensuring consistency and customization options for the generated speech.
</Accordion>

<Accordion title="Delete project by id">
  Deletes a specific project from the user's account in the elevenlabs platform. this endpoint should be used when a user wants to permanently remove a project and all its associated data. it's important to note that this action is irreversible, and once a project is deleted, it cannot be recovered. use this endpoint with caution, ensuring that the project is no longer needed before deletion. the endpoint requires the project's unique identifier and will not provide any information about the deleted project upon successful execution.
</Accordion>

<Accordion title="Delete voice by id">
  Deletes a specific voice from the elevenlabs platform using its unique identifier. this endpoint permanently removes the voice associated with the provided voice id from the user's account and the elevenlabs system. it should be used when a custom voice is no longer needed or to manage the user's voice inventory. this operation is irreversible, so users should be certain they want to delete the voice before making the api call. the endpoint does not return the deleted voice data and cannot be used to temporarily disable or archive a voice.
</Accordion>

<Accordion title="Download history items">
  Allows users to download multiple previously synthesized audio clips from their elevenlabs history. this endpoint is useful for retrieving a batch of audio files at once, saving time compared to downloading them individually. it should be used when you need to access multiple historical audio items, such as for backup purposes or offline processing. the endpoint requires a list of history item ids and optionally allows specifying the output format. note that this endpoint does not provide any additional metadata about the audio files; it's purely for downloading the audio content.
</Accordion>

<Accordion title="Post dubbing audio video file">
  This endpoint allows you to dub a video or audio file into a target language using elevenlabs' advanced text-to-speech synthesis. it supports both automatic and manual dubbing modes, with options for voice cloning, speaker detection, and studio editing. the tool is ideal for content creators, filmmakers, and developers looking to localize audio content or create multilingual versions of their media. it offers flexibility in input methods, including direct file upload or url-based source retrieval, and provides control over dubbing parameters such as language selection, speaker count, and output quality. the endpoint can handle complex dubbing scenarios, including separate foreground and background audio processing when used with csv metadata input.\<\<DEPRECATED use dub\_a\_video\_or\_an\_audio\_file>>
</Accordion>

<Accordion title="Edit voice attributes">
  The editvoice endpoint allows you to modify an existing voice model in the elevenlabs text-to-speech platform. this tool is used to update various properties of a specific voice, identified by its voice id. it supports changing the voice's name, adding new audio files to refine the voice model, updating the voice's description, and modifying associated labels. this endpoint is particularly useful for fine-tuning and maintaining voice models over time, ensuring they remain up-to-date and accurately described within the elevenlabs ecosystem.
</Accordion>

<Accordion title="Edit voice settings by id">
  Edits the voice settings for a specific voice id in the elevenlabs text-to-speech platform. this endpoint allows fine-tuning of various aspects of voice generation, including stability, similarity to the original voice, style emphasis, and speaker boost. use this endpoint when you need to customize the voice output for specific use cases or to achieve desired voice characteristics. the changes made through this endpoint will affect future voice generations using the specified voice id. note that adjusting these settings may impact the quality, consistency, and performance of the generated voice, so careful tuning and testing are recommended.
</Accordion>

<Accordion title="Create audio project through audionative">
  Creates a new audio-native project in the elevenlabs platform, allowing for the generation of an embedded audio player that automatically voices web page content using elevenlabs' text-to-speech service. this endpoint is used to set up a customizable audio player with various appearance and behavior options, including voice selection, text-to-speech model, and player styling. it's particularly useful for content creators, publishers, or developers looking to add audio versions of their text content to web pages. the endpoint requires a project name and content file, with numerous optional parameters for fine-tuning the player's appearance and functionality. it's important to note that while the project is created immediately, the audio conversion may not occur automatically unless specified.
</Accordion>

<Accordion title="Create generated voice">
  This endpoint finalizes the creation of a previously generated voice in the elevenlabs text-to-speech platform. it allows you to assign a name, description, and optional metadata to a voice that has already been generated using the voice generation process. use this endpoint when you have successfully generated a voice using the post /v1/voice-generation/generate-voice endpoint and want to complete its setup for use in text-to-speech operations. this step is crucial for organizing and managing your custom voices within the elevenlabs ecosystem. note that you must have a valid generated voice id from a previous generation process to use this endpoint successfully.
</Accordion>

<Accordion title="Retrieve dubbing audio by language">
  Retrieves the audio file for a specific dubbing project in a particular language. this endpoint is used to fetch the dubbed audio content that has been generated or processed by elevenlabs for a given dubbing task. it should be used when you need to access the audio output of a dubbing project, such as for playback, download, or further processing. the endpoint requires both the dubbing project identifier and the desired language code to locate and return the correct audio file. it's important to note that this endpoint only provides access to existing dubbed audio and does not initiate new dubbing tasks or modify existing ones.
</Accordion>

<Accordion title="Get voice sample audio">
  Retrieves the audio content of a specific sample associated with a particular voice in the elevenlabs text-to-speech platform. this endpoint allows developers to access and play back individual voice samples, which can be useful for voice quality assessment, demonstration purposes, or further processing. the endpoint requires both a voice id and a sample id to precisely locate and return the desired audio content. it should be used when there's a need to listen to or analyze a specific voice sample without generating new audio from text.
</Accordion>

<Accordion title="Get default voice settings">
  Retrieves the default voice settings for the elevenlabs text-to-speech service. this endpoint provides the baseline configuration used for voice generation when no custom settings are specified. it's useful for understanding the starting point of voice parameters and can be called before making adjustments for specific use cases. the returned settings likely include defaults for voice stability, similarity boost, and other relevant voice generation parameters. this endpoint doesn't modify any settings and is safe to call at any time to reference the default configuration.
</Accordion>

<Accordion title="Post dubbing audio video file">
  This endpoint allows you to dub a video or audio file into a target language using elevenlabs' advanced text-to-speech synthesis. it supports both automatic and manual dubbing modes, with options for voice cloning, speaker detection, and studio editing. the tool is ideal for content creators, filmmakers, and developers looking to localize audio content or create multilingual versions of their media. it offers flexibility in input methods, including direct file upload or url-based source retrieval, and provides control over dubbing parameters such as language selection, speaker count, and output quality. the endpoint can handle complex dubbing scenarios, including separate foreground and background audio processing when used with csv metadata input.
</Accordion>

<Accordion title="Get project chapter snapshots">
  Retrieves snapshots for a specific chapter within a project in the elevenlabs platform. this endpoint allows users to access different versions or states of a chapter, which can be useful for tracking changes, reverting to previous versions, or comparing different iterations of voice synthesis work. it should be used when there's a need to review or manage the history of a particular chapter in a text-to-speech project. the endpoint requires both a project id and a chapter id to pinpoint the exact resource for which snapshots are requested. it's important to note that the availability and number of snapshots may depend on the project's settings and the user's subscription tier.
</Accordion>

<Accordion title="Fetch chapters by project id">
  Retrieves a list of chapters associated with a specific project in the elevenlabs platform. this endpoint is useful for developers who need to fetch the structure or content organization of a text-to-speech project. it can be used to get an overview of the chapters within a project, which may represent different sections or segments of the audio content. the endpoint is particularly helpful when managing large-scale audio projects or when implementing features that require chapter-based navigation or playback. note that this endpoint only provides chapter information and does not include the actual audio content.
</Accordion>

<Accordion title="Get user profile by handle">
  Retrieves the public profile information for a specific elevenlabs user based on their unique handle. this endpoint allows developers to access publicly available data about a user, which may include their username, bio, voice samples, or other shareable information. it's particularly useful for applications that need to display user profiles or verify a user's existence on the platform. the endpoint should be used when you need to fetch up-to-date profile data for a known user handle. however, it will not provide access to private user information or data that the user has chosen not to make public.
</Accordion>

<Accordion title="Get project chapter">
  Retrieves detailed information about a specific chapter within a project in the elevenlabs platform. this endpoint is used to fetch metadata, content, or settings associated with a particular chapter, which could include text content for text-to-speech conversion, audio settings, or other chapter-specific data. it's particularly useful for applications that need to manage or display information about individual chapters within larger text-to-speech or audio content projects. the endpoint requires both the project and chapter identifiers, ensuring precise retrieval of the desired chapter information.
</Accordion>

<Accordion title="Fetch dubbing by id">
  Retrieves the current status of a specific dubbing job in the elevenlabs platform. this endpoint should be used to check the progress or completion of a previously initiated dubbing task. it provides information about whether the dubbing is in progress, completed, or encountered any errors. the endpoint is particularly useful for monitoring long-running dubbing jobs or implementing status checks in applications that use elevenlabs' dubbing features. note that this endpoint does not initiate new dubbing jobs or modify existing ones; it's purely for status retrieval.
</Accordion>

<Accordion title="Fetch audio for history item">
  Retrieves the audio file associated with a specific history item in the elevenlabs text-to-speech platform. this endpoint allows users to access previously generated audio content by providing the unique identifier of the history item. it returns the audio data in mpeg format, which can be played or further processed as needed. use this endpoint when you need to fetch the audio output of a past text-to-speech conversion or when you want to replay or download a specific audio item from your history.
</Accordion>

<Accordion title="Generate voice with specific characteristics">
  Generates a random voice with specified characteristics using elevenlabs' advanced text-to-speech synthesis platform. this endpoint allows users to create custom voice outputs by defining gender, accent, age, and accent strength, along with the text to be spoken. it's ideal for creating diverse voice samples, prototyping voice-based applications, or generating unique audio content. the endpoint provides flexibility in voice customization while ensuring high-quality, natural-sounding speech output.
</Accordion>

<Accordion title="Retrieve history data">
  The gethistoryendpoint retrieves historical data related to your elevenlabs api usage. this endpoint allows you to access logs of past text-to-speech conversions, including details such as the text input, voice used, and generation timestamps. it's particularly useful for tracking your api usage, auditing past requests, or recovering previously generated audio content. the endpoint doesn't modify any data and is intended for read-only operations. while it provides valuable insights into your account's activity, it may not include the actual audio files and might have limitations on how far back the history goes.
</Accordion>

<Accordion title="Retrieve history item by id">
  Retrieves a specific history item from the elevenlabs text-to-speech platform. this endpoint allows users to fetch detailed information about a previously generated audio item using its unique identifier. it is particularly useful for accessing metadata, such as the original text, voice settings used, and generation date of a specific audio generation request. this tool should be used when you need to retrieve information about a particular text-to-speech conversion from the user's history, but it will not provide the actual audio file. for downloading the audio file, a separate endpoint would likely be required.
</Accordion>

<Accordion title="Get pronunciation dictionary by id">
  Retrieves a specific pronunciation dictionary by its unique identifier from the elevenlabs text-to-speech platform. this endpoint allows developers to access the details and content of a particular pronunciation dictionary, which can be used to improve the accuracy and naturalness of speech synthesis for specific words or phrases. it's particularly useful when you need to review or apply custom pronunciation rules in your text-to-speech applications. the endpoint returns the complete information about the requested dictionary, including its name, language, and pronunciation entries. use this when you need to inspect or verify the contents of a pronunciation dictionary before applying it to your text-to-speech requests.
</Accordion>

<Accordion title="Get project snapshots">
  Retrieves a list of snapshots for a specific project in elevenlabs. this endpoint allows you to access saved states or versions of a project, including information about the current state and associated audio files. use this endpoint when you need to track project history, compare different versions, or retrieve specific states of a project for further processing or playback. it's particularly useful for managing and accessing multiple iterations of text-to-speech projects.
</Accordion>

<Accordion title="Archive project snapshot">
  Archives a specific snapshot of a project in the elevenlabs platform. this endpoint is used when you want to create a permanent, immutable copy of a project's state at a particular point in time. archiving a snapshot can be useful for version control, backup purposes, or to preserve a specific configuration of your text-to-speech project. once archived, the snapshot is likely read-only and cannot be modified, ensuring the integrity of the archived state. this operation is typically irreversible, so it should be used with caution and only when you're certain you want to create a permanent archive of the project snapshot.
</Accordion>

<Accordion title="Retrieve dubbing transcript by language">
  Retrieves the transcript for a specific dubbing project in the requested language. this endpoint is used to fetch the textual content that has been prepared for dubbing in a particular language. it's essential for reviewing or processing the transcript before or after the actual voice generation process. the endpoint should be used when working with multilingual dubbing projects or when needing to access the textual content of a dubbing job in a specific language. it does not provide the audio file of the dubbed content, only the transcript. the availability and content of the transcript may depend on the current state of the dubbing project and the supported languages.
</Accordion>

<Accordion title="Retrieve project details by id">
  Retrieves detailed information about a specific project within the elevenlabs platform. this endpoint allows developers to fetch project metadata, associated voices, and other relevant details using the project's unique identifier. it should be used when you need to access or display information about a particular project, such as its name, creation date, or associated resources. the endpoint does not modify any project data and is primarily for read-only operations. keep in mind that the specific details returned may depend on the user's access level and the project's visibility settings.
</Accordion>

<Accordion title="Retrieve user details">
  Retrieves detailed information about the currently authenticated user's account. this endpoint provides access to the user's profile data, which may include account settings, subscription details, usage statistics, and other relevant information. it should be used when you need to fetch up-to-date user-specific data, such as remaining character quota or subscription status. the endpoint does not accept any parameters, as it operates based on the authenticated user's context. note that this endpoint likely requires a valid api key for authentication, and usage may be subject to rate limiting based on the user's subscription tier.
</Accordion>

<Accordion title="List models endpoint">
  Retrieves a list of available text-to-speech models from the elevenlabs platform. this endpoint provides developers with information about the current models that can be used for voice synthesis. it should be used when initializing an application or when a user needs to choose a specific model for their text-to-speech tasks. the endpoint does not require any parameters, making it straightforward to query for up-to-date model information. however, it's important to note that this endpoint only provides model details and does not perform any actual text-to-speech conversion.
</Accordion>

<Accordion title="List models endpoint">
  Retrieves a list of available text-to-speech models from the elevenlabs platform. this endpoint provides developers with information about the current models that can be used for voice synthesis. it should be used when initializing an application or when a user needs to choose a specific model for their text-to-speech tasks. the endpoint does not require any parameters, making it straightforward to query for up-to-date model information. however, it's important to note that this endpoint only provides model details and does not perform any actual text-to-speech conversion.\<\<DEPRECATED use get\_models>>
</Accordion>

<Accordion title="Get pronunciation dictionaries list">
  Retrieves a list of all available pronunciation dictionaries in the user's account. this endpoint is useful for developers who want to customize the pronunciation of specific words or phrases in their text-to-speech applications. pronunciation dictionaries can be applied to improve the accuracy and naturalness of speech synthesis, especially for domain-specific terms, acronyms, or proper nouns. the endpoint returns information about each dictionary, which can be used in subsequent api calls for text-to-speech conversion. it's particularly valuable when working with multilingual content or specialized vocabularies.
</Accordion>

<Accordion title="Retrieve user details">
  Retrieves detailed information about the currently authenticated user's account. this endpoint provides access to the user's profile data, which may include account settings, subscription details, usage statistics, and other relevant information. it should be used when you need to fetch up-to-date user-specific data, such as remaining character quota or subscription status. the endpoint does not accept any parameters, as it operates based on the authenticated user's context. note that this endpoint likely requires a valid api key for authentication, and usage may be subject to rate limiting based on the user's subscription tier.\<\<DEPRECATED use get\_user\_info>>
</Accordion>

<Accordion title="Stream chapter audio with mpeg conversion">
  Streams the audio content of a specific chapter snapshot from a project. this endpoint allows you to retrieve and play the audio associated with a particular version (snapshot) of a chapter within your elevenlabs project. it's particularly useful for applications that need to access and stream chapter audio, such as audiobook players, language learning apps, or any system that manages audio content in a project-based structure. the endpoint supports optional mpeg conversion, making it versatile for various audio playback scenarios. use this when you need to retrieve and stream the latest version of a chapter's audio or when you want to access a specific historical version of the audio content.
</Accordion>

<Accordion title="Stream project audio with mpeg option">
  This endpoint streams audio from a specific project snapshot in the elevenlabs text-to-speech platform. it allows developers to retrieve and play audio content generated from a particular state of their project. the endpoint is particularly useful for applications that require real-time audio playback or need to access previously generated audio content. it supports optional conversion to mpeg format, which can be beneficial for broader compatibility across different audio players and systems. use this endpoint when you need to integrate dynamic audio streaming from your elevenlabs projects into your applications.
</Accordion>

<Accordion title="Retrieve shared voices">
  Retrieves a list of shared voices available on the elevenlabs platform. this endpoint allows users to access a collection of voice models that have been made available for collaborative use. it's particularly useful for developers and teams working on projects that require access to a variety of high-quality voice models. the endpoint does not require any parameters, simplifying the retrieval process. however, it's important to note that the specific details of each shared voice, such as voice characteristics or usage limitations, are not provided in this initial request and may require additional api calls to obtain.
</Accordion>

<Accordion title="Text to speech">
  Converts text into speech using a voice of your choice and returns audio.
</Accordion>

<Accordion title="Download pronunciation dictionary version">
  This endpoint allows you to download a specific version of a pronunciation dictionary from the elevenlabs platform. pronunciation dictionaries are essential for controlling how words are pronounced in text-to-speech applications, using either phonemes (ipa or cmu arpabet) or aliases. use this endpoint when you need to retrieve the actual dictionary file for offline use, backup, or to inspect its contents. the downloaded file will likely be in the .pls format, which is the standard format for pronunciation dictionaries in elevenlabs. this endpoint is particularly useful for developers who need programmatic access to their pronunciation dictionaries for integration into their own systems or for maintaining consistent pronunciations across different projects.
</Accordion>

<Accordion title="Retrieve user subscription details">
  Retrieves the current user's subscription information from the elevenlabs platform. this endpoint provides details about the user's subscription status, tier, and associated limits or features. it should be used when an application needs to check the capabilities and restrictions of the authenticated user's account. the endpoint does not require any additional parameters, as it uses the authenticated user's context to fetch the relevant subscription data. note that this endpoint will not provide information about other users' subscriptions or historical subscription data.
</Accordion>

<Accordion title="List all projects">
  Retrieves a list of all projects associated with the user's elevenlabs account. this endpoint allows developers to access and manage their text-to-speech and voice synthesis projects. it should be used when you need to view, organize, or select specific projects for further operations. the response likely includes project details such as id, name, creation date, and associated voices. note that this endpoint does not create, modify, or delete projects; it only provides a read-only view of existing projects.
</Accordion>

<Accordion title="Get admin sso provider">
  Retrieves the current single sign-on (sso) provider configuration for the elevenlabs admin panel. this endpoint is designed for administrative use to fetch details about the configured sso provider, which may include information such as the provider type, authentication endpoints, and other relevant settings. it should be used when administrators need to review or verify the current sso setup. the endpoint does not modify any settings and is read-only. note that this endpoint is likely restricted to users with administrative privileges and may require special authentication.
</Accordion>

<Accordion title="Fetch voice details by id">
  Retrieves detailed information about a specific voice model from the elevenlabs text-to-speech platform. this endpoint is used to fetch comprehensive data about a particular voice, including its characteristics, settings, and any associated metadata. it's essential for developers who need to inspect or verify the properties of a voice before using it in text-to-speech conversions. the endpoint requires a valid voice id and returns a detailed profile of the requested voice, which can be useful for voice selection, customization, or troubleshooting in tts applications.
</Accordion>

<Accordion title="Update project pronunciation dictionaries">
  Updates the pronunciation dictionaries associated with a specific project in the elevenlabs text-to-speech platform. this endpoint allows you to apply one or more pronunciation dictionaries to ensure accurate pronunciation of words and phrases in your text-to-speech conversions. it's particularly useful when you need to customize pronunciation for specific terms, names, or industry jargon within a project. the endpoint supports adding multiple dictionaries, which can be specified using either json body or form-data. however, be aware that the current ui only displays the first dictionary in the list. use this endpoint when you need to modify or enhance the pronunciation accuracy for a project, especially for specialized content or multilingual applications.
</Accordion>

<Accordion title="Text to speech stream">
  Converts text into speech using a voice of your choice and returns audio as an audio stream.
</Accordion>

<Accordion title="Voice generation parameters retrieval">
  Retrieves the available parameters and settings for voice generation using the elevenlabs api. this endpoint provides developers with information about the configurable options when generating voices, such as available voice ids, model ids, and customizable voice settings. it should be used when planning voice generation tasks or when needing to understand the range of options available for voice customization. this endpoint does not actually generate any audio; it only provides metadata about the voice generation process.
</Accordion>

<Accordion title="Retrieve documentation page">
  Retrieves the comprehensive api documentation for the elevenlabs text-to-speech platform. this endpoint provides developers with detailed information about all available endpoints, their parameters, expected responses, and usage guidelines. it is essential for understanding the capabilities of the elevenlabs api and how to integrate it into applications. the documentation likely covers various aspects such as voice generation, streaming audio, voice settings, and model support. use this endpoint when you need to explore the api's features or require specific implementation details for any elevenlabs service.
</Accordion>

<Accordion title="Convert speech with specified voice">
  Converts an input audio file to speech using a specified voice and ai model, allowing for customized voice settings and optional deterministic sampling. this endpoint enables the transformation of audio content while preserving emotional nuances, making it ideal for voice cloning, accent modification, or creating personalized voiceovers. it should be used when you need to generate speech that mimics the style and emotion of a given audio input. the endpoint requires multipart/form-data content type and supports various ai models for different languages and use cases.
</Accordion>

<Accordion title="Get voice settings by voice id">
  Retrieves the current settings for a specific voice in the elevenlabs text-to-speech system. this endpoint allows developers to fetch the customizable parameters that affect the voice's output, such as stability, similarity to the original voice, style exaggeration, and speaker boost. it should be used when you need to check or verify the current configuration of a voice before generating speech or when planning to modify these settings. the endpoint provides a snapshot of the voice's current behavior-influencing factors but does not return audio samples or voice characteristics.
</Accordion>

<Accordion title="Initiate speech to speech streaming">
  The speech to speech streaming endpoint converts input audio to synthesized speech using a specified voice and model, with real-time streaming capabilities. it allows for the transformation of speech content and emotion from the input audio into a new voice, enabling applications like voice cloning, accent modification, or expressive speech synthesis. this endpoint should be used when you need to perform speech-to-speech conversion with immediate audio output, ideal for real-time applications or processing large audio files without waiting for the entire conversion to complete. note that the quality and accuracy of the conversion depend on the clarity of the input audio and the chosen model's capabilities.
</Accordion>

<Accordion title="Get voices list">
  Retrieves a comprehensive list of all available voices on the elevenlabs text-to-speech platform. this endpoint should be used when you need to explore the full range of voice options for text-to-speech synthesis, including both premium and cloned voices. it provides essential information about each voice, such as unique identifiers, names, and potentially additional metadata like language and gender. this tool is particularly useful for applications that need to offer voice selection to users or for developers who want to programmatically access the entire voice catalog. note that while this endpoint returns all voices, it does not provide audio samples or detailed voice characteristics; those may need to be accessed through separate endpoints.
</Accordion>

<Accordion title="Remove rules from pronunciation dictionary">
  Removes specified pronunciation rules from an existing pronunciation dictionary in the elevenlabs text-to-speech platform. this endpoint allows users to fine-tune the pronunciation of words by deleting unwanted rules without affecting the entire dictionary. it should be used when specific pronunciation rules are no longer needed or when correcting errors in the dictionary. this operation is permanent and cannot be undone, so care should be taken when removing rules. the endpoint does not provide a way to add new rules or modify existing ones; it is specifically for rule removal.
</Accordion>

<Accordion title="Get voices list">
  Retrieves a comprehensive list of all available voices on the elevenlabs text-to-speech platform. this endpoint should be used when you need to explore the full range of voice options for text-to-speech synthesis, including both premium and cloned voices. it provides essential information about each voice, such as unique identifiers, names, and potentially additional metadata like language and gender. this tool is particularly useful for applications that need to offer voice selection to users or for developers who want to programmatically access the entire voice catalog. note that while this endpoint returns all voices, it does not provide audio samples or detailed voice characteristics; those may need to be accessed through separate endpoints.\<\<DEPRECATED use get\_voices>>
</Accordion>


# Entelligence
Source: https://docs.push.ai/integrations/entelligence



Entelligence leverages artificial intelligence to provide insights, recommendations, and predictive analytics for businesses seeking data-driven decision-making capabilities

<Accordion title="Add a new repository">
  Add a new repository to the system with specified details
</Accordion>

<Accordion title="Interact with the repository agent">
  Send a question and related information to the repository agent and receive a streaming response
</Accordion>


# Exa
Source: https://docs.push.ai/integrations/exa



The Exa class extends the base Tool class to interact with the Exa Search service, offering actions like Search, Similarlink, and Answer.
These actions enable querying, finding similar links, and generating answers from search results. Currently, no triggers are defined, but they can be added as needed to enhance functionality.

<Accordion title="Get contents action">
  An action to retrieve the text contents and highlights from specific urls or document ids in the exa database. this action allows fetching detailed content from documents, including full text, highlights, and metadata.
</Accordion>

<Accordion title="Find similar">
  A tool that finds and returns web pages that are similar in meaning to a given url. this tool uses exa's embeddings-based similarity search to find content that is semantically related to the input url.
</Accordion>

<Accordion title="Exa Search">
  A tool to perform a search with exa's prompt-engineered query and retrieve a list of relevant results. it supports parameters such as query, type, category, number of results, and domain filters. this action provides the core search functionality independently across the internet.
</Accordion>

<Accordion title="Exa Answer">
  Generate answers from search results using exa's answer endpoint. this action performs a search based on the query and generates either: 1. a direct answer for specific queries 2. a detailed summary with citations for open-ended queries the response includes both the generated answer and the sources used to create it.
</Accordion>


# Excel
Source: https://docs.push.ai/integrations/excel



Connect to Excel to create and manage spreadsheets.

<Accordion title="Convert Table To Range">
  Convert a table to a range using microsoft graph api.
</Accordion>

<Accordion title="List Tables">
  List tables in a worksheet using microsoft graph api.
</Accordion>

<Accordion title="Clear Table Filter">
  Clear a filter from a table column using microsoft graph api.
</Accordion>

<Accordion title="List Named Items">
  List named items in a workbook using microsoft graph api.
</Accordion>

<Accordion title="List Worksheets">
  List worksheets in an excel workbook using microsoft graph api.
</Accordion>

<Accordion title="Delete Table Column">
  Delete a column from a table using microsoft graph api.
</Accordion>

<Accordion title="Add Chart">
  Add a chart to a worksheet using microsoft graph api.
</Accordion>

<Accordion title="Update Table">
  Update a table in a workbook using microsoft graph api.
</Accordion>

<Accordion title="Delete Table Row">
  Delete a row from a table using microsoft graph api.
</Accordion>

<Accordion title="Get Range">
  Get a range from a worksheet using microsoft graph api.
</Accordion>

<Accordion title="List Table Rows">
  List rows in a table using microsoft graph api.
</Accordion>

<Accordion title="Add Table">
  Create a table in a workbook using microsoft graph api.
</Accordion>

<Accordion title="Update Worksheet">
  Update worksheet properties (name, position) in an excel workbook using microsoft graph api.
</Accordion>

<Accordion title="Update Chart">
  Update a chart in a worksheet using microsoft graph api.
</Accordion>

<Accordion title="Add Table Column">
  Add a column to a table using microsoft graph api.
</Accordion>

<Accordion title="Sort Range">
  Sort a range in a worksheet using microsoft graph api.
</Accordion>

<Accordion title="Update Range">
  Update a range in a worksheet using microsoft graph api.
</Accordion>

<Accordion title="List Table Columns">
  List columns in a table using microsoft graph api.
</Accordion>

<Accordion title="Add Table Row">
  Add a row to a table using microsoft graph api.
</Accordion>

<Accordion title="Add Worksheet">
  Add a new worksheet to an excel workbook using microsoft graph api.
</Accordion>

<Accordion title="Get Worksheet">
  Get a worksheet by name or id from an excel workbook using microsoft graph api.
</Accordion>

<Accordion title="Create Excel Session">
  Create a session for an excel workbook using microsoft graph api.
</Accordion>

<Accordion title="Apply Table Filter">
  Apply a filter to a table column using microsoft graph api.
</Accordion>

<Accordion title="List Charts">
  List charts in a worksheet using microsoft graph api.
</Accordion>

<Accordion title="Apply Table Sort">
  Apply a sort to a table using microsoft graph api.
</Accordion>


# Figma
Source: https://docs.push.ai/integrations/figma



A collaborative interface design tool.

<Accordion title="Add a reaction to a comment">
  Posts a new comment reaction on a file comment.
</Accordion>

<Accordion title="Create a webhook">
  Create a new webhook which will call the specified endpoint when the event triggers. by default, this webhook will automatically send a ping event to the endpoint when it is created. if this behavior is not desired, you can create the webhook and set the status to paused and reactivate it later.
</Accordion>

<Accordion title="Create modify delete variables">
  This endpoint allows you to manage variables, variable collections, modes, and their values within a figma file. it provides comprehensive control over your design system's variable structure, enabling you to create, update, and delete variable collections, modes, and individual variables. you can also set specific values for variables across different modes. use this endpoint when you need to programmatically update your design system's variable structure or values, such as during bulk updates or when synchronizing with external systems. the endpoint supports various variable types (boolean, float, string, color) and allows for platform-specific code syntax definitions. keep in mind that this endpoint performs multiple actions in a single call, so careful structuring of your request is essential to avoid unintended changes.
</Accordion>

<Accordion title="Delete a comment">
  Deletes a specific comment. only the person who made the comment is allowed to delete it.
</Accordion>

<Accordion title="Get current user">
  Returns the user information for the currently authenticated user.
</Accordion>

<Accordion title="Delete a reaction">
  Deletes a specific comment reaction. only the person who made the reaction is allowed to delete it.
</Accordion>

<Accordion title="Create dev resources">
  Bulk create dev resources across multiple files. dev resources that are successfully created will show up in the links created array in the response. if there are any dev resources that cannot be created, you may still get a 200 response. these resources will show up in the errors array. some reasons a dev resource cannot be created include: - resource points to a `file key` that cannot be found. - the node already has the maximum of 10 dev resources. - another dev resource for the node has the same url.
</Accordion>

<Accordion title="Add a comment to a file">
  Posts a new comment on the file.
</Accordion>

<Accordion title="Get component">
  Get metadata on a component by key.
</Accordion>

<Accordion title="Get dev resources">
  Get dev resources in a file
</Accordion>

<Accordion title="Get files in a project">
  Get a list of all the files within the specified project.
</Accordion>

<Accordion title="Get comments in a file">
  Gets a list of comments left on the file.
</Accordion>

<Accordion title="Delete a webhook">
  Deletes the specified webhook. this operation cannot be reversed.
</Accordion>

<Accordion title="Get file component sets">
  Get a list of published component sets within a file library.
</Accordion>

<Accordion title="Get component set">
  Get metadata on a published component set by key.
</Accordion>

<Accordion title="Get file styles">
  Get a list of published styles within a file library.
</Accordion>

<Accordion title="Get current user">
  Returns the user information for the currently authenticated user.\<\<DEPRECATED use get\_current\_user>>
</Accordion>

<Accordion title="Get file components">
  Get a list of published components within a file library.
</Accordion>

<Accordion title="Get library analytics component usage data">
  Returns a list of library analytics component usage data broken down by the requested dimension.
</Accordion>

<Accordion title="Get file json">
  Returns the document identified by `file key` as a json object. the file key can be parsed from any figma file url: `https://www.figma.com/file/\{file key\}/\{title\}`. the `document` property contains a node of type `document`. the `components` property contains a mapping from node ids to component metadata. this is to help you determine which components each instance comes from.
</Accordion>

<Accordion title="Get library analytics variable usage data">
  Returns a list of library analytics variable usage data broken down by the requested dimension.
</Accordion>

<Accordion title="Delete dev resource">
  Delete a dev resource from a file
</Accordion>

<Accordion title="Get payments">
  There are two methods to query for a user's payment information on a plugin, widget, or community file. the first method, using plugin payment tokens, is typically used when making queries from a plugin's or widget's code. the second method, providing a user id and resource id, is typically used when making queries from anywhere else. note that you can only query for resources that you own. in most cases, this means that you can only query resources that you originally created.
</Accordion>

<Accordion title="Get library analytics variable action data">
  Returns a list of library analytics variable actions data broken down by the requested dimension.
</Accordion>

<Accordion title="Get image fills">
  Returns download links for all images present in image fills in a document. image fills are how figma represents any user supplied images. when you drag an image into figma, we create a rectangle with a single fill that represents the image, and the user is able to transform the rectangle (and properties on the fill) as they wish. this endpoint returns a mapping from image references to the urls at which the images may be download. image urls will expire after no more than 14 days. image references are located in the output of the get files endpoint under the `imageref` attribute in a `paint`.
</Accordion>

<Accordion title="Get projects in a team">
  You can use this endpoint to get a list of all the projects within the specified team. this will only return projects visible to the authenticated user or owner of the developer token. note: it is not currently possible to programmatically obtain the team id of a user just from a token. to obtain a team id, navigate to a team page of a team you are a part of. the team id will be present in the url after the word team and before your team name.
</Accordion>

<Accordion title="Get library analytics style usage data">
  Returns a list of library analytics style usage data broken down by the requested dimension.
</Accordion>

<Accordion title="Get style">
  Get metadata on a style by key.
</Accordion>

<Accordion title="Get library analytics style action data">
  Returns a list of library analytics style actions data broken down by the requested dimension.
</Accordion>

<Accordion title="Get reactions for a comment">
  Gets a paginated list of reactions left on the comment.
</Accordion>

<Accordion title="Get file json for specific nodes">
  Retrieves nodes (design elements) from a specified figma file. this endpoint allows developers to access and extract various design components, such as shapes, text layers, frames, components, and groups, from a particular figma document. it's particularly useful for applications that need to analyze, render, or manipulate figma designs programmatically. the endpoint should be used when you need to fetch the structure and content of a figma file, but it won't provide real-time collaborative features or make changes to the file. keep in mind that the response may be large for complex files with many nodes, so consider performance implications when making frequent calls.
</Accordion>

<Accordion title="Get activity logs">
  Returns a list of activity log events
</Accordion>

<Accordion title="Get local variables">
  **this api is available to full members of enterprise orgs.** the `get /v1/files/:file key/variables/local` endpoint lets you enumerate local variables created in the file and remote variables used in the file. remote variables are referenced by their `subscribed id`. as a part of the variables related api additions, the `get /v1/files/:file key` endpoint now returns a `boundvariables` property, containing the `variableid` of the bound variable. the `get /v1/files/:file key/variables/local` endpoint can be used to get the full variable or variable collection object. note that `get /v1/files/:file key/variables/published` does not return modes. instead, you will need to use the `get /v1/files/:file key/variables/local` endpoint, in the same file, to examine the mode values.
</Accordion>

<Accordion title="Get published variables">
  **this api is available to full members of enterprise orgs.** the `get /v1/files/:file key/variables/published` endpoint returns the variables that are published from the given file. the response for this endpoint contains some key differences compared to the `get /v1/files/:file key/variables/local` endpoint: - each variable and variable collection contains a `subscribed id`. - modes are omitted for published variable collections published variables have two ids: an id that is assigned in the file where it is created (`id`), and an id that is used by subscribing files (`subscribed id`). the `id` and `key` are stable over the lifetime of the variable. the `subscribed id` changes every time the variable is modified and published. the same is true for variable collections. the `updatedat` fields are iso 8601 timestamps that indicate the last time that a change to a variable was published. for variable collections, this timestamp will change any time a variable in the collection is changed.
</Accordion>

<Accordion title="Get team component sets">
  Get a paginated list of published component sets within a team library.
</Accordion>

<Accordion title="Get a webhook">
  Get a webhook by id.
</Accordion>

<Accordion title="Get library analytics component action data">
  Returns a list of library analytics component actions data broken down by the requested dimension.
</Accordion>

<Accordion title="Get team components">
  Get a paginated list of published components within a team library.
</Accordion>

<Accordion title="Get webhook requests">
  Returns all webhook requests sent within the last week. useful for debugging.
</Accordion>

<Accordion title="Get team webhooks">
  Returns all webhooks registered under the specified team.
</Accordion>

<Accordion title="Render images of file nodes">
  Renders images from a file. if no error occurs, `"images"` will be populated with a map from node ids to urls of the rendered images, and `"status"` will be omitted. the image assets will expire after 30 days. images up to 32 megapixels can be exported. any images that are larger will be scaled down. important: the image map may contain values that are `null`. this indicates that rendering of that specific node has failed. this may be due to the node id not existing, or other reasons such has the node having no renderable components. it is guaranteed that any node that was requested for rendering will be represented in this map whether or not the render succeeded. to render multiple images from the same file, use the `ids` query parameter to specify multiple node ids. `get /v1/images/:key?ids=1:2,1:3,1:4`
</Accordion>

<Accordion title="Update dev resources">
  Bulk update dev resources across multiple files. ids for dev resources that are successfully updated will show up in the `links updated` array in the response. if there are any dev resources that cannot be updated, you may still get a 200 response. these resources will show up in the `errors` array.
</Accordion>

<Accordion title="Get versions of a file">
  This endpoint fetches the version history of a file, allowing you to see the progression of a file over time. you can then use this information to render a specific version of the file, via another endpoint.
</Accordion>

<Accordion title="Get team styles">
  Get a paginated list of published styles within a team library.
</Accordion>

<Accordion title="Update a webhook">
  Update a webhook by id.
</Accordion>


# Firecrawl
Source: https://docs.push.ai/integrations/firecrawl



Firecrawl automates web crawling and data extraction, enabling organizations to gather content, index sites, and gain insights from online sources at scale

<Accordion title="Cancel a crawl job">
  Cancel a crawl job by its uuid.
</Accordion>

<Accordion title="Get the status of a crawl job">
  Get the status of a crawl job by its uuid.
</Accordion>

<Accordion title="Crawl Multiple URLs">
  Crawl websites recursively using firecrawl's api, then poll until the job completes or fails.
</Accordion>

<Accordion title="Firecrawl Extract">
  Extract structured data from web pages using firecrawl's api, then poll until the job completes or fails.
</Accordion>

<Accordion title="Firecrawl Search">
  This tool combines web search (serp) with firecrawl's scraping capabilities to return full page content for any query. it allows users to search the web and get complete content of the search results in various formats.
</Accordion>

<Accordion title="Map multiple urls">
  Map multiple url's based on user options.
</Accordion>

<Accordion title="Scrape URL">
  Scrape content from a url and optionally extract structured data using firecrawl's api.
</Accordion>


# Fireflies
Source: https://docs.push.ai/integrations/fireflies



Fireflies.ai helps your team transcribe, summarize, search, and analyze voice conversations.

<Accordion title="Get Bite by ID">
  The getbite action is designed to fetch details associated with a specific bite id.
</Accordion>

<Accordion title="Get Transcripts">
  The gettranscripts action is designed to fetch a list of transcripts against input arguments.
</Accordion>

<Accordion title="Delete Transcript by ID">
  The deletetranscriptbyid action is designed to delete a specific transcript by its id.
</Accordion>

<Accordion title="Fetch AI App Outputs">
  Fetch outputs for a specific ai app or meeting/transcript.
</Accordion>

<Accordion title="Get Transcripts">
  The getbites action is designed to fetch a list of bites against input arguments.
</Accordion>

<Accordion title="Get Transcript by ID">
  The gettranscriptbyid action is designed to fetch details associated with a specific transcript id.
</Accordion>

<Accordion title="Get User by ID">
  The getuser action is designed to fetch details associated with a specific user id.
</Accordion>

<Accordion title="Add to Live Meeting">
  The addtolive action allows you to add the fireflies.ai bot to an ongoing meeting.
</Accordion>

<Accordion title="Upload Audio">
  The uploadaudio action allows you to upload audio files to fireflies.ai for transcription.
</Accordion>

<Accordion title="Get Users">
  The getusers action is designed to fetch a list of all users within the team.
</Accordion>


# Flutterwave
Source: https://docs.push.ai/integrations/flutterwave



Flutterwave provides APIs for making and receiving payments in various
currencies and countries.

<Accordion title="Get transactions">
  Get a list of transactions within a specified date range. this action fetches transaction history and monitors payment activities. the date range is optional and can be specified using from date and to date parameters.
</Accordion>

<Accordion title="Flutterwave verify transaction">
  Verifies the status of a flutterwave transaction using the transaction id or reference. returns detailed information about the transaction including status, amount, currency, customer details, and payment information.
</Accordion>


# Formsite
Source: https://docs.push.ai/integrations/formsite



Formsite helps users create online forms and surveys with drag-and-drop tools, secure data capture, and integrations to simplify workflows

<Accordion title="List All Forms">
  This tool retrieves a list of all forms in the user's formsite account. it provides essential information such as form id, form name, form directory, creation date, last modified date, status, access level, and other metadata. it serves as a foundational tool for further operations.
</Accordion>

<Accordion title="Get Form Webhooks">
  This tool retrieves all webhooks configured for a specific form in formsite. it uses the get https\://\{server}.formsite.com/api/v2/\{user dir}/forms/\{form dir}/webhooks endpoint to fetch webhook configurations, including url, status, settings, and triggers.
</Accordion>

<Accordion title="Get Form Details">
  This tool retrieves detailed information about a specific form in formsite. it provides comprehensive details including the form's internal description, directory identifier, name, publishing information (embed code and form link), current state (e.g., "open"), and statistics (file size and number of results).
</Accordion>

<Accordion title="Get Form Items">
  This tool retrieves all items (questions) for a specific form using the get https\://\{server}.formsite.com/api/v2/\{user dir}/forms/\{form dir}/items endpoint. it is an independent action that only requires the form directory (obtainable via formsite list all forms) to retrieve the structure and details such as item ids, question types, text, answer choices, required status, and other properties.
</Accordion>

<Accordion title="Get Form Results">
  This tool retrieves the latest form results from a specified formsite form. it uses the get https\://\{server}.formsite.com/api/v2/results/latest endpoint to fetch results independently, handling required parameters such as form id, limit, page, and sort direction without referring to external resource ids.
</Accordion>


# Foursquare
Source: https://docs.push.ai/integrations/foursquare



Search for places and place recommendations from the Foursquare Places database

<Accordion title="Retrieve nearby places v3">
  The getnearbyplaces endpoint retrieves a list of places near a specified location, primarily supporting check-in use cases and local discovery. it returns points of interest (pois) including lower quality results not found in the standard place search, enhancing location-based experiences with additional data like photos, reviews, and tips. this endpoint is ideal for applications seeking to provide users with a comprehensive view of their surroundings, including less prominent or newer locations. while it offers a broader range of results, it may sacrifice some precision compared to more focused search endpoints. use this when you want to offer users a diverse array of nearby options, particularly for social check-in features or exploratory local recommendations.
</Accordion>

<Accordion title="Retrieve place photos by id">
  Retrieves photos associated with a specific place in foursquare's database. this endpoint allows you to access user-generated images for a particular point of interest (poi) using its unique foursquare id (fsq id). it's useful for enhancing your application with visual content related to locations, such as restaurants, landmarks, or businesses. the endpoint returns photo data that can be used to construct image urls for display. keep in mind that the number and quality of photos may vary depending on the popularity and user engagement of the place. this tool should be used when you need to display or analyze visual information about a specific location in your application.
</Accordion>

<Accordion title="Retrieve places by id">
  Retrieves detailed information about a specific place using its unique foursquare id (fsq id). this endpoint provides comprehensive data about a venue, including its name, address, category, ratings, tips, photos, and other relevant information. it's particularly useful when you need in-depth details about a known location, such as for displaying venue profiles or gathering specific place attributes. the endpoint should be used when you have a valid fsq id and require the most up-to-date and complete information about that place. note that this endpoint focuses on individual place details and does not provide search functionality or lists of multiple venues.
</Accordion>

<Accordion title="Retrieve place tips using fsq id">
  Retrieves user-generated tips for a specific place in the foursquare database. this endpoint allows you to fetch valuable insights and experiences shared by foursquare users about a particular venue. it's useful for enhancing location-based applications with real user feedback, helping users make informed decisions about places they might visit. the endpoint returns a list of tips, which may include information such as the tip text, the user who created it, and potentially a timestamp or rating.
</Accordion>

<Accordion title="Search places api request">
  The getplacessearch endpoint allows you to search for places in the foursquare database based on various criteria such as location, keywords, and categories. this tool is ideal for discovering nearby points of interest or finding specific venues. it returns a list of places matching the specified parameters, providing essential information about each location. use this endpoint for location-based features or gathering venue information in a specific area.
</Accordion>


# Freshdesk
Source: https://docs.push.ai/integrations/freshdesk



A customer support platform that provides helpdesk support with all
smart automations to get things done faster.

<Accordion title="List All Tickets">
  Lists all tickets in freshdesk.
</Accordion>

<Accordion title="Reply to Ticket">
  Replies to an existing ticket in freshdesk.
</Accordion>

<Accordion title="Update Ticket">
  Updates an existing ticket in freshdesk.
</Accordion>

<Accordion title="View Ticket">
  Views an existing ticket in freshdesk.
</Accordion>

<Accordion title="Delete Ticket">
  Deletes an existing ticket in freshdesk.
</Accordion>

<Accordion title="Get Tickets">
  Retrieves a list of tickets from freshdesk.
</Accordion>

<Accordion title="Create Ticket">
  Creates a new ticket in freshdesk.
</Accordion>


# Github
Source: https://docs.push.ai/integrations/github



GitHub API Tool

<Accordion title="Add or update team project permissions">
  Use this action to add or update a team's permissions for a project in an organization.
</Accordion>

<Accordion title="Add assignees to an issue">
  Use this action to add up to 10 assignees to a github issue.
</Accordion>

<Accordion title="Add a repository collaborator">
  Use this action to add a collaborator to a repository with specified permission level (pull, triage, push, maintain, or admin).
</Accordion>

<Accordion title="Add or update team membership for a user">
  Use this action to add a user to a team or update their role within the team. the user will receive an email invite if they are not already a member.
</Accordion>

<Accordion title="Add or update team membership for a user legacy">
  Use this action to add a user to a team or update their role in the team using the legacy api endpoint.
</Accordion>

<Accordion title="Add app access restrictions">
  Use this action to add github app access restrictions to a protected branch.
</Accordion>

<Accordion title="Add selected repository to an organization secret">
  Use this action to add a repository to an organization's secret that has 'selected' access type.
</Accordion>

<Accordion title="Add a repository to an app installation">
  Use this action to add a repository to a github app installation. requires admin access to the repository.
</Accordion>

<Accordion title="Add repo to org secret with selected visibility">
  Use this action to add a repository to an organization's dependabot secret with selected visibility. requires oauth or personal access token with 'admin:org' scope.
</Accordion>

<Accordion title="Add selected repository to an organization variable">
  Use this action to add a repository to an organization variable that has selected repository visibility.
</Accordion>

<Accordion title="Add teams to the copilot subscription for an organization">
  Use this action to add teams to an organization's github copilot subscription.
</Accordion>

<Accordion title="Add social accounts for the authenticated user">
  Use this action to add social media accounts to the authenticated user's github profile.
</Accordion>

<Accordion title="Add status check contexts">
  Use this action to add status check contexts to a protected branch in a repository.
</Accordion>

<Accordion title="Add a security manager team">
  Use this action to add a team as a security manager in an organization.
</Accordion>

<Accordion title="Add or update team project permissions legacy">
  Use this action to add or update a team's permissions on a project using the legacy api endpoint. note: this is a deprecated endpoint.
</Accordion>

<Accordion title="Add users to codespaces access for an organization">
  Use this action to add specified users to an organization's codespaces access, allowing their codespaces usage to be billed to the organization.
</Accordion>

<Accordion title="Add a selected repository to a user secret">
  Use this action to add a repository to a user's development environment secret.
</Accordion>

<Accordion title="Add team member legacy">
  Use this action to add a user to a team using the legacy github enterprise cloud api endpoint. note: this endpoint is deprecated in favor of 'add or update team membership for a user'.
</Accordion>

<Accordion title="Add or update team repository permissions">
  Use this action to add or update a team's permission level for a repository in an organization.
</Accordion>

<Accordion title="Add users to the copilot subscription for an organization">
  Use this action to add users to an organization's github copilot subscription.
</Accordion>

<Accordion title="Add user access restrictions">
  Use this action to add user access restrictions to a protected branch in a repository.
</Accordion>

<Accordion title="Assign an organization role to a user">
  Use this action to assign a specific organization role to a user in a github organization.
</Accordion>

<Accordion title="Github Auth User Docker Conflict Packages List">
  Use this action to list all docker packages owned by the authenticated user that had conflicts during docker migration. requires 'read:packages' scope for oauth app tokens and personal access tokens.
</Accordion>

<Accordion title="Add custom labels to a self hosted runner for an organization">
  Use this action to add custom labels to a self-hosted runner in an organization.
</Accordion>

<Accordion title="Assign an organization role to a team">
  Use this action to assign an organization role to a team.
</Accordion>

<Accordion title="Add or update team repository permissions legacy">
  Use this action to add or update a team's repository permissions using the legacy teams api. note: this is a deprecated api endpoint.
</Accordion>

<Accordion title="Add custom labels to a self hosted runner for a repository">
  Use this action to add custom labels to a self-hosted runner in a repository.
</Accordion>

<Accordion title="Approve a workflow run for a fork pull request">
  Use this action to approve a workflow run that was triggered by a pull request from a forked repository. this is typically required for security purposes when the pull request comes from a new contributor.
</Accordion>

<Accordion title="Block a user">
  Use this action to block a github user from interacting with your account.
</Accordion>

<Accordion title="Add project collaborator">
  Use this action to add a collaborator to an organization project with specified permission level.
</Accordion>

<Accordion title="Block a user from an organization">
  Use this action to block a user from accessing an organization.
</Accordion>

<Accordion title="Cancel an import">
  Use this action to cancel an ongoing repository import. note: this feature will be deprecated on april 12, 2024.
</Accordion>

<Accordion title="Accept a repository invitation">
  Use this action to accept a repository invitation for the authenticated user.
</Accordion>

<Accordion title="Cancel an organization invitation">
  Use this action to cancel a pending invitation to join an organization.
</Accordion>

<Accordion title="Add labels to an issue">
  Use this action to add labels to an issue.
</Accordion>

<Accordion title="Check if a gist is starred">
  Use this action to check if a specific gist is starred by the authenticated user.
</Accordion>

<Accordion title="Github Add Repo To Org Secret With Selected Access">
  Use this action to add a repository to an organization secret that has 'selected' access type.
</Accordion>

<Accordion title="Cancel a github pages deployment">
  Use this action to cancel a github pages deployment for a repository.
</Accordion>

<Accordion title="Check if a pull request has been merged">
  Use this action to check if a pull request has been merged into its base branch.
</Accordion>

<Accordion title="Check a token">
  Use this action to verify if an oauth or github app access token is valid.
</Accordion>

<Accordion title="Check if automated security fixes are enabled for a repository">
  Use this action to check if automated security fixes are enabled for a repository.
</Accordion>

<Accordion title="Check if a repository is starred by the authenticated user">
  Use this action to check if the authenticated user has starred a specific repository.
</Accordion>

<Accordion title="Check if a person is followed by the authenticated user">
  Use this action to check if the authenticated user follows a specific github user.
</Accordion>

<Accordion title="Check if a user is a repository collaborator">
  Use this action to check if a user is a collaborator on a repository.
</Accordion>

<Accordion title="Check if a user is blocked by the authenticated user">
  Use this action to check if a specific github user is blocked by the currently authenticated user.
</Accordion>

<Accordion title="Check if a user follows another user">
  Use this action to check if one github user follows another user.
</Accordion>

<Accordion title="List repositories starred by the authenticated user">
  This endpoint lists starred repositories of the authenticated user and supports media type `application/vnd.github.star+json` to include star creation timestamps. more on media types at github docs.\<\<DEPRECATED use list\_repositories\_starred\_by\_the\_authenticated\_user>>
</Accordion>

<Accordion title="Check if a user can be assigned">
  Use this action to check if a user can be assigned to issues in a repository.
</Accordion>

<Accordion title="Cancel a workflow run">
  Use this action to cancel a running workflow in a repository.
</Accordion>

<Accordion title="Check if a user can be assigned to a issue">
  Use this action to verify if a user has permission to be assigned to a specific issue.
</Accordion>

<Accordion title="Check organization membership for a user">
  Use this action to verify if a user is a member of a github organization (either publicly or privately).
</Accordion>

<Accordion title="Check if vulnerability alerts are enabled for a repository">
  Use this action to check if vulnerability alerts are enabled for a repository. requires admin read access to the repository.
</Accordion>

<Accordion title="List stargazers">
  Use this action to list users who have starred a repository. (deprecated: use list stargazers)
</Accordion>

<Accordion title="Check if a user is blocked by an organization">
  Use this action to check if a specific user is blocked by an organization.
</Accordion>

<Accordion title="Star a repository for the authenticated user">
  Use this action to star a repository as the authenticated user (deprecated: use star a repository for the authenticated user)
</Accordion>

<Accordion title="Add an email address for the authenticated user">
  Use this action to add a new email address to the authenticated user's github account.
</Accordion>

<Accordion title="Add team access restrictions">
  Use this action to add team access restrictions to a protected branch in a repository.
</Accordion>

<Accordion title="Check team permissions for a project">
  Use this action to check a team's permission level (read, write, or admin) for a specific project in an organization.
</Accordion>

<Accordion title="Check public organization membership for a user">
  Use this action to verify if a user is publicly listed as a member of a specific organization.
</Accordion>

<Accordion title="Create a codespace from a pull request">
  Use this action to create a codespace for a specific pull request.
</Accordion>

<Accordion title="Create a repository dispatch event">
  Use this action to create a repository dispatch event that triggers workflows or webhooks. you can include custom event type and payload data for the workflows to use.
</Accordion>

<Accordion title="Compare two commits">
  Use this action to compare two commits and get the differences between them. you can compare commits across branches, repositories, or forks.
</Accordion>

<Accordion title="Create a discussion">
  Use this action to create a new discussion post on a team's page.
</Accordion>

<Accordion title="Create a codespace in a repository">
  Use this action to create a new codespace in a specified repository for the authenticated user.
</Accordion>

<Accordion title="Github Check Private Vulnerability Reporting Status">
  Use this action to check if private vulnerability reporting is enabled for a repository.
</Accordion>

<Accordion title="Create a github pages deployment">
  Use this action to create a github pages deployment for a repository.
</Accordion>

<Accordion title="Check team permissions for a repository legacy">
  Use this action to check a team's permissions for a repository using the legacy teams api endpoint. note: this endpoint is deprecated.
</Accordion>

<Accordion title="Check team permissions for a project legacy">
  Use this action to check a team's permissions (read, write, admin) on a project using the legacy teams api endpoint.
</Accordion>

<Accordion title="Create a github pages site">
  Use this action to create and configure a github pages site for a repository.
</Accordion>

<Accordion title="Github Clear Repository Cache By Key">
  Use this action to delete a specific github actions cache from a repository using a cache key. optionally, you can specify a git reference to narrow down which cache to delete.
</Accordion>

<Accordion title="Create a reply for a review comment">
  Use this action to create a reply to a pull request review comment.
</Accordion>

<Accordion title="Create a remove token for a repository">
  Use this action to generate a token for removing a self-hosted runner from a repository. the token expires in 1 hour.
</Accordion>

<Accordion title="Create an organization invitation">
  Use this action to invite a user to join an organization by their github id or email address.
</Accordion>

<Accordion title="Check team permissions for a repository">
  Use this action to check a team's permissions for a repository, including inherited permissions.
</Accordion>

<Accordion title="Create a gpg key for the authenticated user">
  Use this action to add a gpg key to the authenticated user's github account.
</Accordion>

<Accordion title="Github Configure Jitrunner For Org">
  Use this action to generate a configuration for a just-in-time runner in an organization.
</Accordion>

<Accordion title="Create a repository security advisory">
  Use this action to create a draft security advisory for a repository. only repository security managers or admins can create security advisories.
</Accordion>

<Accordion title="Create a repository variable">
  To create, update, or read variables in a github actions workflow, authenticated collaborators need `repo` scope on oauth/personal access tokens.
</Accordion>

<Accordion title="Create a pull request">
  Use this action to create a new pull request in a repository.
</Accordion>

<Accordion title="Create a review for a pull request">
  Use this action to create a review for a pull request. you can approve, request changes, or comment on a pull request.
</Accordion>

<Accordion title="Create a discussion comment">
  Use this action to create a comment on a team discussion.
</Accordion>

<Accordion title="Create a ssh signing key for the authenticated user">
  Use this action to create an ssh signing key for the authenticated user.
</Accordion>

<Accordion title="Create a discussion comment legacy">
  Use this action to create a comment on a team discussion using the legacy api endpoint. note: this is a deprecated endpoint and will be removed in the future.
</Accordion>

<Accordion title="Create a review comment for a pull request">
  Use this action to create a comment on a specific line or range of lines in a pull request's diff.
</Accordion>

<Accordion title="Create a tag protection state for a repository">
  Use this action to create a tag protection rule for a repository. only repository administrators can use this action.
</Accordion>

<Accordion title="Github Configure Oidcsubject Claim Template">
  Use this action to create or update the openid connect (oidc) subject claim customization template for an organization.
</Accordion>

<Accordion title="Create a label">
  Use this action to create a new label in a repository with a specified name, color, and optional description.
</Accordion>

<Accordion title="Create a milestone">
  Use this action to create a milestone in a repository.
</Accordion>

<Accordion title="Create a repository webhook">
  Use this action to create a new webhook for a repository. a webhook allows you to receive http post payloads whenever specific events happen in the repository.
</Accordion>

<Accordion title="Create a snapshot of dependencies for a repository">
  Use this action to create a new snapshot of a repository's dependencies.
</Accordion>

<Accordion title="Create a repository using a template">
  Use this action to create a new repository using an existing repository as a template.
</Accordion>

<Accordion title="Create a tag object">
  Use this action to create an annotated git tag in a repository. the tag can be created for a commit, tree, or blob object.
</Accordion>

<Accordion title="Create a scoped access token">
  Use this action to create a repository-scoped or permission-scoped access token from a non-scoped token.
</Accordion>

<Accordion title="Create a commit">
  Use this action to create a new commit in a repository.
</Accordion>

<Accordion title="Create a reference">
  Use this action to create a git reference (like a branch or tag) in a repository. note: cannot be used with empty repositories.
</Accordion>

<Accordion title="Create a tree">
  Use this action to create a git tree object in a repository. you can use this to add, modify, or delete files in the repository.
</Accordion>

<Accordion title="Create a registration token for a repository">
  Use this action to create a registration token for configuring a self-hosted runner in a repository.
</Accordion>

<Accordion title="Create a commit comment">
  Use this action to add a comment to a specific commit in a repository.
</Accordion>

<Accordion title="Create a team">
  Use this action to create a new team in a github organization.
</Accordion>

<Accordion title="Create a workflow dispatch event">
  Use this action to manually trigger a github actions workflow run by specifying the workflow file name and input parameters.
</Accordion>

<Accordion title="Create a discussion legacy">
  Use this action to create a team discussion post (legacy endpoint). this is a deprecated endpoint.
</Accordion>

<Accordion title="Create a registration token for an organization">
  Use this action to create a registration token for configuring self-hosted runners in an organization. the token expires in one hour.
</Accordion>

<Accordion title="Create commit signature protection">
  Use this action to enable commit signature protection on a branch, requiring all commits to be signed.
</Accordion>

<Accordion title="Create configuration for a just in time runner for a repository">
  Use this action to create a configuration for a just-in-time github actions runner in a repository. the configuration can be used to set up a new runner with specified name, group, labels, and work folder.
</Accordion>

<Accordion title="Create a project card">
  Use this action to create a new project card in a specified project column.
</Accordion>

<Accordion title="Create a user project">
  Use this action to create a project board for the authenticated user.
</Accordion>

<Accordion title="Create a temporary private fork">
  Use this action to create a temporary private fork of a repository to fix a security vulnerability. note: fork creation is asynchronous and may take up to 5 minutes to become accessible.
</Accordion>

<Accordion title="Create a repository for the authenticated user">
  Use this action to create a new repository for the authenticated user. the repository can be configured with various settings like visibility, features, and merge options.
</Accordion>

<Accordion title="Create a fork">
  Use this action to create a fork of a repository.
</Accordion>

<Accordion title="Create or update an environment">
  Use this action to create or update an environment in a repository with specified protection rules, review requirements, and deployment branch policies.
</Accordion>

<Accordion title="Create a project column">
  Use this action to create a new column in a github project.
</Accordion>

<Accordion title="Github Clear Self Hosted Runner Org Labels">
  Use this action to remove all custom labels from a self-hosted runner in an organization.
</Accordion>

<Accordion title="Create or update an environment secret">
  Use this action to create or update an encrypted secret for a repository environment.
</Accordion>

<Accordion title="Create a commit status">
  Use this action to create a commit status for a specific sha in a repository. limited to 1000 statuses per sha and context.
</Accordion>

<Accordion title="Create or update a custom property for an organization">
  Use this action to create or update a custom property for a github organization.
</Accordion>

<Accordion title="Create a repository from an unpublished codespace">
  Use this action to create a new repository from an unpublished codespace.
</Accordion>

<Accordion title="Create or update custom property values for a repository">
  Use this action to create or update custom property values for a repository. setting a value to null removes that property.
</Accordion>

<Accordion title="Create or update an organization secret">
  Use this action to create or update an encrypted secret for an organization.
</Accordion>

<Accordion title="Create a public ssh key for the authenticated user">
  Use this action to add a new public ssh key to the authenticated user's github account.
</Accordion>

<Accordion title="Create a gist">
  Use this action to create a new gist (a shareable code snippet) with specified files and optional description.
</Accordion>

<Accordion title="Create or update a secret for the authenticated user">
  Use this action to create or update a secret for the authenticated user's codespaces.
</Accordion>

<Accordion title="Create or update a repository secret">
  Use this action to create or update a repository secret with an encrypted value.
</Accordion>

<Accordion title="Create a custom deployment protection rule on an environment">
  Use this action to enable a custom deployment protection rule for a specific environment in a repository.
</Accordion>

<Accordion title="Create a release">
  Use this action to create a new release for a repository.
</Accordion>

<Accordion title="Create reaction for an issue">
  Use this action to add a reaction emoji to a github issue.
</Accordion>

<Accordion title="Create or update file contents">
  Use this action to create a new file or update an existing file in a github repository.
</Accordion>

<Accordion title="Create or update repo secret with encrypted value">
  Use this action to create or update a repository secret with an encrypted value. the value must be encrypted using libsodium with the repository's public key.
</Accordion>

<Accordion title="Create reaction for a commit comment">
  Use this action to add a reaction emoji to a commit comment. returns http 200 if the reaction already exists.
</Accordion>

<Accordion title="Create reaction for an issue comment">
  Use this action to add a reaction emoji to an issue comment. available reactions are +1, -1, laugh, confused, heart, hooray, rocket, and eyes.
</Accordion>

<Accordion title="Create a repository project">
  This text outlines the process of creating a repository project board. it notes that a `410 gone` status appears if projects are disabled or if there are no classic projects. a lack of privileges results in a `401 unauthorized` or `410 gone` status.
</Accordion>

<Accordion title="Create reaction for a release">
  Use this action to add a reaction to a release. available reactions are: +1, laugh, heart, hooray, rocket, eyes.
</Accordion>

<Accordion title="Create a remove token for an organization">
  Use this action to generate a token that can be used to remove a self-hosted runner from an organization.
</Accordion>

<Accordion title="Create reaction for a pull request review comment">
  Use this action to add a reaction to a pull request review comment.
</Accordion>

<Accordion title="Create reaction for a team discussion">
  Use this action to add a reaction to a team discussion. the reaction can be +1, -1, laugh, confused, heart, hooray, rocket, or eyes.
</Accordion>

<Accordion title="Create an organization project">
  Use this action to create a new project board for an organization.
</Accordion>

<Accordion title="Create or update custom properties for an organization">
  Use this action to create or update custom properties for an organization in bulk.
</Accordion>

<Accordion title="Create a custom organization role">
  Use this action to create a custom role in a github organization with specified permissions.
</Accordion>

<Accordion title="Create an organization variable">
  This text describes how to create an organization variable in github actions, specifying that users need collaborator access, and oauth/personal access tokens require `admin:org` and `repo` scopes for public and private repositories, respectively.
</Accordion>

<Accordion title="Create a deployment">
  Use this action to create a new deployment for a repository. a deployment represents a specific version of a repository that is deployed to an environment like production or staging.
</Accordion>

<Accordion title="Create a repository ruleset">
  Use this action to create a new ruleset for a repository. a ruleset defines rules and conditions for repository operations.
</Accordion>

<Accordion title="Create a gist comment">
  Use this action to create a comment on a gist.
</Accordion>

<Accordion title="Create an organization repository ruleset">
  Use this action to create a new repository ruleset for an organization.
</Accordion>

<Accordion title="Create a github app from a manifest">
  Use this action to create a github app from a manifest by exchanging a temporary code for the app configuration details including id, private key (pem), and webhook secret.
</Accordion>

<Accordion title="Create a blob">
  Use this action to create a new git blob object (file content) in a repository.
</Accordion>

<Accordion title="Create a deployment branch policy">
  Use this action to create a deployment branch or tag policy for an environment.
</Accordion>

<Accordion title="Create an environment variable">
  Use this action to create an environment variable in a repository. requires collaborator access or oauth/pat with 'repo' scope.
</Accordion>

<Accordion title="Create a codespace for the authenticated user">
  Use this action to create a new codespace for the authenticated user. requires either repository id or pull request parameter.
</Accordion>

<Accordion title="Create a check suite">
  Use this action to create a check suite for a repository. note that check suites can only be created in the original repository, not in forks, and require appropriate authentication (not available for oauth apps and personal tokens).
</Accordion>

<Accordion title="Create an issue comment">
  Use this action to add a comment to a github issue or pull request.
</Accordion>

<Accordion title="Create an organization repository">
  Use this action to create a new repository in a github organization. requires oauth or personal access token with 'public repo' scope for public repositories or 'repo' scope for private repositories.
</Accordion>

<Accordion title="Create an issue">
  Use this action to create a new issue in a repository. you can specify the title, body, assignees, milestone, and labels for the issue.
</Accordion>

<Accordion title="Create an autolink reference for a repository">
  Use this action to create an autolink reference in a repository. an autolink reference automatically creates links in issues, pull requests, and commits when a specified prefix is found.
</Accordion>

<Accordion title="Create a deployment status">
  Use this action to create a new deployment status for a specific deployment.
</Accordion>

<Accordion title="Create a deploy key">
  Use this action to create a deploy key for a repository. a deploy key is an ssh key that grants access to a single repository. you can specify if the key is read-only or has write access.
</Accordion>

<Accordion title="Convert an organization member to outside collaborator">
  Use this action to convert an organization member to an outside collaborator, which will restrict their access to only repositories allowed by their team membership.
</Accordion>

<Accordion title="Create an organization webhook">
  Use this action to create a webhook for a github organization. requires organization owner permissions with admin:org hook scope.
</Accordion>

<Accordion title="Create a check run">
  Use this action to create a new check run for a specific commit in a repository.
</Accordion>

<Accordion title="Delete an autolink reference from a repository">
  Use this action to delete an autolink reference from a repository. only repository administrators can access autolink information.
</Accordion>

<Accordion title="Create reaction for a team discussion comment legacy">
  Use this action to create a reaction to a team discussion comment using the legacy api endpoint.
</Accordion>

<Accordion title="Decline a repository invitation">
  Use this action to decline a repository invitation for the authenticated user.
</Accordion>

<Accordion title="Github Custom Oidcsubject Claim Template Setter">
  Use this action to set a custom openid connect (oidc) subject claim template for a repository.
</Accordion>

<Accordion title="Delete an organization secret">
  Use this action to delete a secret from an organization.
</Accordion>

<Accordion title="Delete an app token">
  Use this action to revoke a specific oauth or github app token using the app's client id and client secret.
</Accordion>

<Accordion title="Delete an app authorization">
  Use this action to revoke a user's authorization for a github app. this will delete all oauth tokens and remove the app from the user's github settings.
</Accordion>

<Accordion title="Customize oidc subject claim template">
  Use this action to get the customization template for openid connect (oidc) subject claim in a repository.
</Accordion>

<Accordion title="Delete a gpg key for the authenticated user">
  Use this action to delete a gpg key from the authenticated user's github account.
</Accordion>

<Accordion title="Github Create Update Org Secret With Lib Sodium">
  Use this action to create or update an organization secret using libsodium encryption. the secret will be available for dependabot to use in the organization's repositories.
</Accordion>

<Accordion title="Delete access restrictions">
  Use this action to remove access restrictions from a protected branch.
</Accordion>

<Accordion title="Create reaction for a team discussion comment">
  Use this action to add a reaction to a team discussion comment. the reaction can be +1, -1, laugh, confused, heart, hooray, rocket, or eyes.
</Accordion>

<Accordion title="Delete a deploy key">
  Use this action to delete a deploy key from a repository. note that deploy keys cannot be updated - you need to delete and create a new one instead.
</Accordion>

<Accordion title="Delete an organization variable">
  Use this action to delete a variable from an organization.
</Accordion>

<Accordion title="Create reaction for a team discussion legacy">
  Use this action to add a reaction to a team discussion (legacy endpoint).
</Accordion>

<Accordion title="Delete a discussion">
  Use this action to delete a team discussion from an organization.
</Accordion>

<Accordion title="Delete a deployment branch policy">
  Use this action to delete a deployment branch or tag policy from an environment.
</Accordion>

<Accordion title="Delete a project">
  Deletes a project board. returns a `404 not found` status if projects are disabled.
</Accordion>

<Accordion title="Delete a label">
  Use this action to delete a label from a repository using its name.
</Accordion>

<Accordion title="Delete a project column">
  Use this action to delete a specific project column from a github project.
</Accordion>

<Accordion title="Delete a pull request comment reaction">
  Use this action to delete a reaction from a pull request review comment.
</Accordion>

<Accordion title="Delete a project card">
  Use this action to delete a project card from a project column.
</Accordion>

<Accordion title="Delete a repository ruleset">
  Use this action to delete a ruleset from a repository.
</Accordion>

<Accordion title="Delete admin branch protection">
  Use this action to remove admin enforcement from a protected branch in a repository.
</Accordion>

<Accordion title="Delete a reference">
  Use this action to delete a git reference (branch, tag, etc.) from a repository.
</Accordion>

<Accordion title="Delete a secret for the authenticated user">
  Use this action to delete a codespaces secret for the authenticated user.
</Accordion>

<Accordion title="Delete an artifact">
  Use this action to delete a specific artifact from a workflow run.
</Accordion>

<Accordion title="Delete a public ssh key for the authenticated user">
  Use this action to delete a public ssh key from the authenticated user's github account.
</Accordion>

<Accordion title="Delete a release">
  Use this action to delete a release from a repository.
</Accordion>

<Accordion title="Delete a pending review for a pull request">
  Use this action to delete an unsubmitted (pending) review from a pull request.
</Accordion>

<Accordion title="Delete a milestone">
  Use this action to delete a milestone from a repository using its milestone number.
</Accordion>

<Accordion title="Delete a repository secret">
  Use this action to delete a secret from a repository. requires collaborator access to the repository.
</Accordion>

<Accordion title="Delete a review comment for a pull request">
  Use this action to delete a specific review comment from a pull request.
</Accordion>

<Accordion title="Delete an organization webhook">
  Use this action to delete a webhook from an organization. requires organization owner permissions and tokens with `admin:org hook` scope.
</Accordion>

<Accordion title="Delete an email address for the authenticated user">
  Use this action to delete an email address from the authenticated user's account.
</Accordion>

<Accordion title="Delete a tag protection state for a repository">
  Use this action to delete a tag protection state from a repository. only repository administrators can use this action.
</Accordion>

<Accordion title="Delete a self hosted runner from an organization">
  Use this action to delete a self-hosted runner from an organization.
</Accordion>

<Accordion title="Delete an ssh signing key for the authenticated user">
  Use this action to delete an ssh signing key from the authenticated user's github account.
</Accordion>

<Accordion title="Delete a team legacy">
  Use this action to delete a team using the legacy endpoint. note: this endpoint is deprecated, use 'delete a team' instead.
</Accordion>

<Accordion title="Delete a thread subscription">
  Use this action to unsubscribe from a notification thread. this will stop notifications until you comment or are @mentioned.
</Accordion>

<Accordion title="Delete a self hosted runner from a repository">
  Use this action to remove a self-hosted runner from a repository.
</Accordion>

<Accordion title="Delete a release asset">
  Use this action to delete a specific release asset from a github repository.
</Accordion>

<Accordion title="Delete a team">
  Use this action to delete a team from an organization. only organization owners or team maintainers can delete teams. note that deleting a parent team will also delete all its child teams.
</Accordion>

<Accordion title="Delete an environment">
  Use this action to delete an environment from a repository.
</Accordion>

<Accordion title="Delete a package for an organization">
  Use this action to delete a package from an organization's packages. note: admin access required and cannot delete public packages with over 5,000 downloads.
</Accordion>

<Accordion title="Delete a repository subscription">
  Use this action to unsubscribe from a repository's notifications and stop watching it.
</Accordion>

<Accordion title="Delete github actions cache by id">
  Use this action to delete a specific github actions cache from a repository using its cache id.
</Accordion>

<Accordion title="Delete commit signature protection">
  Use this action to remove commit signature protection from a protected branch.
</Accordion>

<Accordion title="Github Delete Dependebot Secret By Name">
  Use this action to delete a dependabot secret from a repository using its name.
</Accordion>

<Accordion title="Delete a codespace for the authenticated user">
  Use this action to delete a codespace belonging to the authenticated user.
</Accordion>

<Accordion title="Delete package version for an organization">
  Use this action to delete a specific version of a package from an organization's packages. note: deleting packages with more than 5,000 downloads requires admin permissions and github support assistance.
</Accordion>

<Accordion title="Github Custom Oidcsubject Claim Template">
  Use this action to get the openid connect (oidc) subject claim customization template for an organization.
</Accordion>

<Accordion title="Delete a repository variable">
  Use this action to delete a variable from a repository. requires collaborator access to the repository.
</Accordion>

<Accordion title="Delete a release reaction">
  Use this action to delete a specific reaction from a github release.
</Accordion>

<Accordion title="Delete package version for a user">
  Use this action to delete a specific version of a package owned by a user.
</Accordion>

<Accordion title="Delete an environment secret">
  Use this action to delete a secret from a repository environment.
</Accordion>

<Accordion title="Delete social accounts for the authenticated user">
  Use this action to delete one or more social media accounts from the authenticated user's github profile.
</Accordion>

<Accordion title="Delete team discussion comment reaction">
  Use this action to delete a reaction from a team discussion comment.
</Accordion>

<Accordion title="Delete a user migration archive">
  Use this action to delete a user migration archive. note that migration archives are automatically deleted after 7 days, but the migration metadata remains accessible through the api.
</Accordion>

<Accordion title="Delete pull request review protection">
  Use this action to remove pull request review protection from a branch in a repository.
</Accordion>

<Accordion title="Github Delete Repo Codespace Secret By Name">
  Use this action to delete a codespace secret from a repository by its name.
</Accordion>

<Accordion title="Delete team discussion reaction">
  Use this action to delete a specific reaction from a team discussion.
</Accordion>

<Accordion title="Delete a package for a user">
  Use this action to delete a package owned by a user. note: requires admin permissions and github support for public packages with over 5,000 downloads.
</Accordion>

<Accordion title="Delete a repository">
  Deleting a repository needs admin rights. if prevented by an organization owner, a `403 forbidden` response occurs. oauth app tokens and classic personal access tokens require the `delete repo` scope for this action.
</Accordion>

<Accordion title="Delete a repository webhook">
  Use this action to delete a webhook from a repository.
</Accordion>

<Accordion title="Delete a workflow run">
  Use this action to delete a specific workflow run from a repository.
</Accordion>

<Accordion title="Delete workflow run logs">
  Use this action to delete all logs for a specific workflow run.
</Accordion>

<Accordion title="Disable automated security fixes">
  Use this action to disable automated security fixes for a repository.
</Accordion>

<Accordion title="Github Disable Repository Actions In Org">
  Use this action to disable github actions for a specific repository within an organization.
</Accordion>

<Accordion title="Disable private vulnerability reporting for a repository">
  Use this action to disable private vulnerability reporting for a repository. requires admin access to the repository.
</Accordion>

<Accordion title="Delete a codespace from the organization">
  Use this action to delete a specific user's codespace from an organization.
</Accordion>

<Accordion title="Delete an environment variable">
  Use this action to delete an environment variable from a repository environment.
</Accordion>

<Accordion title="Disable a workflow">
  Use this action to disable a workflow in a repository.
</Accordion>

<Accordion title="Download an organization migration archive">
  Use this action to download the migration archive for an organization.
</Accordion>

<Accordion title="Disable vulnerability alerts">
  Use this action to disable vulnerability alerts for a repository. requires admin access.
</Accordion>

<Accordion title="Download an artifact">
  Use this action to download an artifact from a github repository. returns a temporary download url that expires in 1 minute.
</Accordion>

<Accordion title="Delete a repository invitation">
  Use this action to delete a repository invitation.
</Accordion>

<Accordion title="Delete an issue comment">
  Use this action to delete a comment on an issue or pull request.
</Accordion>

<Accordion title="Delete an organization">
  Use this action to delete an organization and all its repositories. note: the organization name will be unavailable for reuse for 90 days.
</Accordion>

<Accordion title="Delete an organization migration archive">
  Use this action to delete an organization's migration archive. note that migration archives are automatically deleted after seven days.
</Accordion>

<Accordion title="Delete a package for the authenticated user">
  Use this action to delete a package owned by the authenticated user. note that public packages with over 5,000 downloads can only be deleted through github support.
</Accordion>

<Accordion title="Delete an issue comment reaction">
  Use this action to delete a reaction from an issue comment.
</Accordion>

<Accordion title="Delete an organization repository ruleset">
  Use this action to delete a repository ruleset from an organization.
</Accordion>

<Accordion title="Disable a custom protection rule for an environment">
  Use this action to disable a custom deployment protection rule for a specific environment in a repository.
</Accordion>

<Accordion title="Delete branch protection">
  Use this action to remove branch protection rules from a repository branch.
</Accordion>

<Accordion title="Delete a code scanning analysis from a repository">
  Use this action to delete a specific code scanning analysis from a repository.
</Accordion>

<Accordion title="Delete an issue reaction">
  Use this action to delete a reaction from an issue in a github repository.
</Accordion>

<Accordion title="Delete a discussion comment legacy">
  Use this action to delete a comment from a team discussion using the legacy api endpoint.
</Accordion>

<Accordion title="Delete a package version for the authenticated user">
  Use this action to delete a specific package version owned by the authenticated user.
</Accordion>

<Accordion title="Dismiss a review for a pull request">
  Use this action to dismiss a review on a pull request. requires admin or authorized access on protected branches.
</Accordion>

<Accordion title="Delete a discussion legacy">
  Use this action to delete a team discussion using the legacy api endpoint. note: this is a deprecated endpoint, consider using the new 'delete a discussion' endpoint instead.
</Accordion>

<Accordion title="Delete a custom organization role">
  Use this action to delete a custom organization role.
</Accordion>

<Accordion title="Delete a file">
  Use this action to delete a file in a repository. you can optionally specify committer and author information for the commit that deletes the file.
</Accordion>

<Accordion title="Delete a deployment">
  Use this action to delete an inactive deployment from a repository.
</Accordion>

<Accordion title="Delete a commit comment">
  Use this action to delete a specific commit comment from a repository.
</Accordion>

<Accordion title="Delete a discussion comment">
  Use this action to delete a specific comment from a team discussion in an organization.
</Accordion>

<Accordion title="Delete a gist">
  Use this action to delete a specific gist by its id.
</Accordion>

<Accordion title="Delete a github pages site">
  Use this action to delete a github pages site from a repository.
</Accordion>

<Accordion title="Delete a commit comment reaction">
  Use this action to delete a reaction from a commit comment.
</Accordion>

<Accordion title="Delete a gist comment">
  Use this action to delete a specific comment from a gist.
</Accordion>

<Accordion title="Download workflow run attempt logs">
  Use this action to download logs for a specific workflow run attempt.
</Accordion>

<Accordion title="Enable private vulnerability reporting for a repository">
  Use this action to enable private vulnerability reporting for a repository.
</Accordion>

<Accordion title="Download a user migration archive">
  Use this action to download a user's migration archive containing repository data, issues, pull requests, comments, and attachments in tar.gz format.
</Accordion>

<Accordion title="Enable a workflow">
  Use this action to enable a workflow in a repository.
</Accordion>

<Accordion title="Enable or disable a security feature for an organization">
  Use this action to enable or disable a security feature (like dependency graph, dependabot alerts, secret scanning, etc.) for all eligible repositories in an organization.
</Accordion>

<Accordion title="Download a repository archive zip">
  Use this action to download a repository as a zip archive.
</Accordion>

<Accordion title="Enable github actions in selected repositories">
  Use this action to enable github actions for specific repositories within an organization.
</Accordion>

<Accordion title="Download workflow run logs">
  Use this action to download the logs of a specific workflow run.
</Accordion>

<Accordion title="Export a codespace for the authenticated user">
  Use this action to export a codespace and get a url to track its export status.
</Accordion>

<Accordion title="Download job logs for a workflow run">
  Use this action to download the logs for a specific job in a workflow run.
</Accordion>

<Accordion title="Github Encrypt Org Secrets Using Public Key">
  Use this action to get the public key for encrypting organization secrets. requires oauth or personal access token with `admin:org` scope.
</Accordion>

<Accordion title="Github Encrypt And Update Dev Secret">
  Use this action to create or update a repository's development environment secret with an encrypted value.
</Accordion>

<Accordion title="Download a repository archive tar">
  Use this action to download a repository as a tar archive. you can download either the default branch or a specific branch/tag/commit using the ref parameter.
</Accordion>

<Accordion title="Get emojis">
  Use this action to get a list of all emojis available to use on github. (deprecated: use get emojis instead)
</Accordion>

<Accordion title="Enable automated security fixes">
  Use this action to enable automated security fixes for a repository.
</Accordion>

<Accordion title="Force cancel a workflow run">
  Use this action to forcefully cancel a workflow run, bypassing any conditions that would normally keep it running.
</Accordion>

<Accordion title="Github Enable Repo Forgithub Actions">
  Use this action to enable github actions for a specific repository within an organization.
</Accordion>

<Accordion title="Fork a gist">
  Use this action to create a fork of a github gist.
</Accordion>

<Accordion title="Enable vulnerability alerts">
  Use this action to enable vulnerability alerts and dependency graph for a repository.
</Accordion>

<Accordion title="Get an environment public key">
  Use this action to get the public key of a repository environment, which is required for encrypting environment secrets.
</Accordion>

<Accordion title="Get allowed actions and reusable workflows for an organization">
  Use this action to get a list of actions and reusable workflows that are allowed in an organization.
</Accordion>

<Accordion title="Get all organization roles for an organization">
  Use this action to list all custom roles defined in an organization. requires admin access or appropriate permissions.
</Accordion>

<Accordion title="Get an environment">
  Use this action to get details about a specific deployment environment in a repository. requires read access to the repository. for private repositories, requires oauth token or personal access token with 'repo' scope.
</Accordion>

<Accordion title="Get all organization repository rulesets">
  Use this action to retrieve all repository rulesets configured for a github organization.
</Accordion>

<Accordion title="Get allowed actions and reusable workflows for a repository">
  Use this action to get the list of allowed actions and reusable workflows in a repository.
</Accordion>

<Accordion title="Get an organization membership for the authenticated user">
  Use this action to get the authenticated user's membership status in a specific organization.
</Accordion>

<Accordion title="Get an organization">
  Use this action to get information about a github organization.
</Accordion>

<Accordion title="Get all api versions">
  Use this action to retrieve a list of all supported github api versions.
</Accordion>

<Accordion title="Get an organization migration status">
  Use this action to check the status of an organization's migration. the status will be one of: 'pending' (not started), 'exporting' (in progress), 'exported' (completed), or 'failed'.
</Accordion>

<Accordion title="Get an organization rule suite">
  The text provides details on obtaining data about various rule evaluations in an organization, guiding users to manage rulesets for repositories. for further info, visit github's documentation on managing rulesets.
</Accordion>

<Accordion title="Get an organization public key">
  Use this action to get the public key of an organization, which is used for encrypting secrets.
</Accordion>

<Accordion title="Get all autolinks of a repository">
  Use this action to retrieve all configured autolinks for a repository. only accessible by repository administrators.
</Accordion>

<Accordion title="Get an organization repository ruleset">
  Use this action to retrieve a specific repository ruleset for an organization using the organization name and ruleset id.
</Accordion>

<Accordion title="Get an environment secret">
  Use this action to retrieve a specific environment secret from a repository without decrypting it.
</Accordion>

<Accordion title="Get a commit">
  Use this action to get details of a specific commit in a repository.
</Accordion>

<Accordion title="Get an organization role">
  Use this action to retrieve details of a specific organization role by its id.
</Accordion>

<Accordion title="Github Encrypt Org Dev Env Secret">
  Use this action to create or update an organization's development environment secret with encryption.
</Accordion>

<Accordion title="Get an environment variable">
  Use this action to retrieve a specific environment variable from a repository environment.
</Accordion>

<Accordion title="Get an organization secret">
  Use this action to retrieve an organization secret without its encrypted value. requires admin:org scope for authentication.
</Accordion>

<Accordion title="Get a code scanning analysis for a repository">
  Use this action to retrieve a specific code scanning analysis for a repository using the analysis id.
</Accordion>

<Accordion title="Get all repository rulesets">
  Use this action to retrieve all rulesets configured for a repository, including inherited rulesets from higher levels.
</Accordion>

<Accordion title="Get all codes of conduct">
  Use this action to get a list of all available codes of conduct on github.
</Accordion>

<Accordion title="Get a blob">
  Use this action to get a file's content from a repository using its sha hash.
</Accordion>

<Accordion title="Get a code scanning default setup configuration">
  Use this action to retrieve the default setup configuration for code scanning in a repository.
</Accordion>

<Accordion title="Get a code of conduct">
  Use this action to retrieve details about a specific github code of conduct by its key.
</Accordion>

<Accordion title="Get a custom deployment protection rule">
  Use this action to retrieve a custom deployment protection rule for an environment in a repository.
</Accordion>

<Accordion title="Get a branch">
  Use this action to retrieve information about a specific branch in a repository.
</Accordion>

<Accordion title="Generate release notes content for a release">
  Use this action to generate release notes content in markdown format for a new release. the notes will include changes and contributors since the last release.
</Accordion>

<Accordion title="Get an import status">
  Use this action to get the status of a repository import. note: this action will be deprecated on april 12, 2024.
</Accordion>

<Accordion title="Get a commit object">
  Use this action to get a commit object from a repository, including its verification status and signature details.
</Accordion>

<Accordion title="Get all repository topics">
  Use this action to get all topics associated with a repository.
</Accordion>

<Accordion title="Get an organization variable">
  Use this action to retrieve a specific organization variable. requires collaborator access and appropriate oauth scopes.
</Accordion>

<Accordion title="Export a software bill of materials sbom for a repository">
  Use this action to export the software bill of materials (sbom) for a repository in spdx json format.
</Accordion>

<Accordion title="Get a deployment">
  Use this action to get details of a specific deployment in a repository.
</Accordion>

<Accordion title="Get an issue">
  Use this action to get a specific issue from a repository.
</Accordion>

<Accordion title="Get a dependabot alert">
  Use this action to get details of a specific dependabot alert in a repository.
</Accordion>

<Accordion title="Get a commit comment">
  Use this action to retrieve a specific commit comment from a repository.
</Accordion>

<Accordion title="Get a custom property for an organization">
  Use this action to retrieve a specific custom property defined for an organization.
</Accordion>

<Accordion title="Get a delivery for a repository webhook">
  Use this action to retrieve a specific webhook delivery for a repository.
</Accordion>

<Accordion title="Get access restrictions">
  Use this action to get the access restrictions for a protected branch in a repository.
</Accordion>

<Accordion title="Get an organization webhook">
  Use this action to retrieve the configuration details of a specific webhook for an organization.
</Accordion>

<Accordion title="Get all requested reviewers for a pull request">
  Use this action to get a list of all reviewers who have been requested to review a specific pull request.
</Accordion>

<Accordion title="Github Fetch Public Key For Secret Encryption">
  Use this action to retrieve the public key required for encrypting dependabot secrets in an organization.
</Accordion>

<Accordion title="Get a deployment branch policy">
  Use this action to get a deployment branch or tag policy for an environment.
</Accordion>

<Accordion title="Get a deployment status">
  Use this action to get the status of a specific deployment in a repository.
</Accordion>

<Accordion title="Get assignment grades">
  Use this action to retrieve grades for a github classroom assignment. only accessible to classroom administrators.
</Accordion>

<Accordion title="Get a codeql database for a repository">
  Use this action to retrieve a codeql database for a specific programming language in a repository.
</Accordion>

<Accordion title="Get an issue comment">
  Use this action to retrieve a specific comment from an issue or pull request.
</Accordion>

<Accordion title="Get a discussion">
  Use this action to get a specific team discussion by its number.
</Accordion>

<Accordion title="Get a diff of the dependencies between commits">
  Use this action to get the differences in dependencies between two commits of a repository.
</Accordion>

<Accordion title="Get all status check contexts">
  Use this action to get all status check contexts for a protected branch in a repository.
</Accordion>

<Accordion title="Get admin branch protection">
  Use this action to get the admin branch protection status for a repository branch.
</Accordion>

<Accordion title="Get an issue event">
  Use this action to retrieve a specific issue event using its event id.
</Accordion>

<Accordion title="Get a check run">
  Use this action to get details of a specific check run in a repository.
</Accordion>

<Accordion title="Get a github pages site">
  Use this action to get information about a github pages site for a repository.
</Accordion>

<Accordion title="Get a gist comment">
  Use this action to retrieve a specific comment from a gist.
</Accordion>

<Accordion title="Get a dns health check for github pages">
  Use this action to verify the dns cname record for a github pages site.
</Accordion>

<Accordion title="Get a gist">
  Use this action to retrieve a specific github gist by its id.
</Accordion>

<Accordion title="Github Find Conflicting Packages For Docker Migration">
  Use this action to list packages that have conflicts during docker migration for a specific user.
</Accordion>

<Accordion title="Get a code scanning alert">
  Use this action to retrieve a specific code scanning alert from a repository.
</Accordion>

<Accordion title="Get all commonly used licenses">
  Use this action to get a list of the most commonly used licenses available on github.
</Accordion>

<Accordion title="Get a deploy key">
  Use this action to retrieve details of a specific deploy key from a github repository.
</Accordion>

<Accordion title="Get a discussion comment legacy">
  Use this action to get a specific comment from a team discussion using the legacy api endpoint (deprecated).
</Accordion>

<Accordion title="Get a discussion comment">
  Use this action to retrieve a specific comment from a team discussion.
</Accordion>

<Accordion title="Get an ssh signing key for the authenticated user">
  Use this action to retrieve details of a specific ssh signing key for the authenticated user.
</Accordion>

<Accordion title="Get a gitignore template">
  Use this action to get the content of a specific .gitignore template.
</Accordion>

<Accordion title="Get a discussion legacy">
  Use this action to get a team discussion using the legacy endpoint. note: this endpoint is deprecated.
</Accordion>

<Accordion title="Get all contributor commit activity">
  Use this action to get commit activity statistics for all repository contributors.
</Accordion>

<Accordion title="Get an assignment">
  Use this action to retrieve a github classroom assignment. only accessible to classroom administrators.
</Accordion>

<Accordion title="Follow a user">
  Use this action to follow a github user. requires user:follow oauth scope.
</Accordion>

<Accordion title="Get a classroom">
  Use this action to get details of a specific github classroom. only accessible to classroom administrators.
</Accordion>

<Accordion title="Get a gist revision">
  Use this action to retrieve a specific revision of a gist using its id and sha.
</Accordion>

<Accordion title="Get apps with access to the protected branch">
  Use this action to get a list of github apps that have write access to a protected branch in a repository.
</Accordion>

<Accordion title="Get all custom properties for an organization">
  Use this action to retrieve all custom properties defined for a github organization.
</Accordion>

<Accordion title="Get an autolink reference of a repository">
  Use this action to retrieve a specific autolink reference from a repository by its id. only available to repository administrators.
</Accordion>

<Accordion title="Get all custom property values for a repository">
  Use this action to retrieve all custom property values set for a repository.
</Accordion>

<Accordion title="Get all deployment protection rules for an environment">
  Use this action to retrieve all enabled custom deployment protection rules for a specific environment in a repository.
</Accordion>

<Accordion title="Get a check suite">
  Use this action to retrieve a specific check suite by its id from a repository.
</Accordion>

<Accordion title="Get all gitignore templates">
  Use this action to get a list of all available gitignore templates that can be used when creating a repository.
</Accordion>

<Accordion title="Get a codespace for the authenticated user">
  Use this action to get information about a specific codespace owned by the authenticated user.
</Accordion>

<Accordion title="Get a label">
  Use this action to retrieve a specific label from a repository using its name.
</Accordion>

<Accordion title="Get a review comment for a pull request">
  Use this action to retrieve a specific review comment from a pull request using its comment id.
</Accordion>

<Accordion title="Get a repository">
  Use this action to get information about a repository.
</Accordion>

<Accordion title="Get a tree">
  Use this action to get a git tree object by its sha1 or reference name. a tree object contains information about the files in a repository.
</Accordion>

<Accordion title="Get a job for a workflow run">
  Use this action to get details of a specific job within a workflow run.
</Accordion>

<Accordion title="Get a package for the authenticated user">
  Use this action to retrieve information about a specific package owned by the authenticated user.
</Accordion>

<Accordion title="Get a package version for an organization">
  Use this action to retrieve a specific package version from an organization's packages.
</Accordion>

<Accordion title="Get copilot seat information and settings for an organization">
  Use this action to get information about an organization's github copilot subscription, including seat allocation and code policies.
</Accordion>

<Accordion title="Get a repository webhook">
  Use this action to get details of a specific webhook configured in a repository.
</Accordion>

<Accordion title="Get a user">
  Use this action to get information about a github user by their username.
</Accordion>

<Accordion title="Get a global security advisory">
  Use this action to retrieve a global security advisory by its ghsa (github security advisory) id.
</Accordion>

<Accordion title="Get a thread subscription for the authenticated user">
  Use this action to check if the authenticated user is subscribed to a notification thread.
</Accordion>

<Accordion title="Get a release by tag name">
  Use this action to retrieve a specific release from a repository using its tag name.
</Accordion>

<Accordion title="Get a thread">
  Use this action to retrieve information about a specific notification thread.
</Accordion>

<Accordion title="Get a gpg key for the authenticated user">
  Use this action to retrieve details of a specific gpg key for the authenticated user.
</Accordion>

<Accordion title="Get default attributes for a codespace">
  Use this action to get the default configuration attributes for creating a codespace in a repository.
</Accordion>

<Accordion title="Get a milestone">
  Use this action to retrieve a specific milestone from a repository using its milestone number.
</Accordion>

<Accordion title="Get a package version for a user">
  Use this action to retrieve a specific public package version for a user.
</Accordion>

<Accordion title="Get github actions billing for an organization">
  Use this action to get github actions billing information for an organization, including usage minutes and spending details.
</Accordion>

<Accordion title="Get emojis">
  Use this action to get a list of all emojis available to use on github.
</Accordion>

<Accordion title="Get a repository public key">
  Use this action to get a repository's public key for encrypting secrets.
</Accordion>

<Accordion title="Get default workflow permissions for an organization">
  Use this action to get the default workflow permissions for github token and the default workflow settings for an organization.
</Accordion>

<Accordion title="Get feeds">
  Use this action to get github timeline feeds including public/private activity and security advisories.
</Accordion>

<Accordion title="Get github packages billing for a user">
  Use this action to get the github packages billing information for a specified user. returns storage usage for both free and paid storage in gb, where paid storage applies to private repositories. requires oauth token with 'user' scope.
</Accordion>

<Accordion title="Get commit authors">
  Use this action to get a list of commit authors for a repository import. this helps in mapping commit authors from different source control systems to github users.
</Accordion>

<Accordion title="Get a webhook configuration for an organization">
  Use this action to retrieve the configuration of a specific webhook for an organization.
</Accordion>

<Accordion title="Get details about a codespace export">
  Use this action to retrieve details about an exported codespace.
</Accordion>

<Accordion title="Get branch protection">
  Protected branches are available in public repositories with github free, across all repos for organizations, github pro, team, enterprise cloud, and server. details are in github's product documentation.
</Accordion>

<Accordion title="Get a review for a pull request">
  Use this action to get a specific review for a pull request by its id.
</Accordion>

<Accordion title="Get a repository readme">
  Use this action to get the readme file content of a repository. returns raw content by default, or html-rendered content if specified.
</Accordion>

<Accordion title="Get default workflow permissions for a repository">
  Use this action to get the default workflow permissions for the github token in a repository.
</Accordion>

<Accordion title="Get github actions billing for a user">
  Use this action to get github actions billing information for a specific user, including used minutes in private repositories.
</Accordion>

<Accordion title="Get a user migration status">
  Use this action to get the current status of a user's migration. the status can be 'pending', 'exporting', 'exported', or 'failed'. when the status is 'exported', you can download the migration archive.
</Accordion>

<Accordion title="Get github actions cache usage for an organization">
  Use this action to get the total github actions cache usage statistics for an organization.
</Accordion>

<Accordion title="Get github packages billing for an organization">
  Use this action to get github packages billing information for an organization.
</Accordion>

<Accordion title="Get a package version for the authenticated user">
  Use this action to get details of a specific package version owned by the authenticated user.
</Accordion>

<Accordion title="Get commit signature protection">
  Use this action to check if a branch requires signed commits.
</Accordion>

<Accordion title="Get github pages build">
  Use this action to get information about a specific github pages build.
</Accordion>

<Accordion title="Get a repository readme for a directory">
  Use this action to get the readme file from a specific directory in a repository.
</Accordion>

<Accordion title="Get interaction restrictions for an organization">
  Use this action to get the interaction restrictions (who can interact and expiration time) for an organization. returns empty response if no restrictions are set.
</Accordion>

<Accordion title="Get interaction restrictions for a repository">
  Use this action to get the interaction restrictions (who can interact and when the restriction expires) for a repository.
</Accordion>

<Accordion title="Get information about a sarif upload">
  Use this action to get information about a sarif upload, including its processing status and analysis url.
</Accordion>

<Accordion title="Get github actions cache usage for a repository">
  Use this action to get the github actions cache usage statistics for a repository.
</Accordion>

<Accordion title="Get large files">
  Use this action to list files larger than 100mb in a repository's import. note: this action is deprecated and will be discontinued on april 12, 2024.
</Accordion>

<Accordion title="Get a repository ruleset">
  Use this action to retrieve a specific ruleset configuration for a repository.
</Accordion>

<Accordion title="Get community profile metrics">
  Use this action to get community health metrics for a repository, including health score, documentation status, and compliance with recommended community standards.
</Accordion>

<Accordion title="Get a secret for the authenticated user">
  Use this action to retrieve a development environment secret for the authenticated user's codespaces.
</Accordion>

<Accordion title="Get interaction restrictions for your public repositories">
  Use this action to retrieve interaction restrictions (limits on who can interact and for how long) set on your public repositories.
</Accordion>

<Accordion title="Get a project">
  Use this action to get details of a github project by its id.
</Accordion>

<Accordion title="Get latest pages build">
  Use this action to get the most recent build information of a github pages site.
</Accordion>

<Accordion title="Get a webhook configuration for a repository">
  Use this action to get the configuration details of a specific webhook in a repository.
</Accordion>

<Accordion title="Get octocat">
  Use this action to get github's mascot (octocat) in ascii art format, optionally with a custom message in its speech bubble
</Accordion>

<Accordion title="Get organization membership for a user">
  Use this action to get a user's membership status in an organization. the authenticated user must be an organization member to use this action.
</Accordion>

<Accordion title="Get a project card">
  Use this action to retrieve details of a specific project card by its id.
</Accordion>

<Accordion title="Get a license">
  Use this action to get detailed information about a specific github repository license.
</Accordion>

<Accordion title="Get org dev environment secret safely">
  Use this action to retrieve an organization's development environment secret without exposing its encrypted value.
</Accordion>

<Accordion title="Get project permission for a user">
  Use this action to get a user's permission level for an organization project. permission can be admin, write, read, or none.
</Accordion>

<Accordion title="Get page views">
  Use this action to get repository traffic data, including total page views and daily/weekly breakdown for the last 14 days.
</Accordion>

<Accordion title="Get contextual information for a user">
  Use this action to get contextual information about a github user, such as their hovercard data.
</Accordion>

<Accordion title="Get a webhook delivery for an organization webhook">
  Use this action to retrieve a specific webhook delivery for an organization webhook.
</Accordion>

<Accordion title="Get a project column">
  Use this action to retrieve details about a specific project column.
</Accordion>

<Accordion title="Get pull request review protection">
  Use this action to get the pull request review protection settings for a protected branch in a repository.
</Accordion>

<Accordion title="Get a repository rule suite">
  Use this action to retrieve the evaluation results of a repository's rule suite by its id.
</Accordion>

<Accordion title="Get public key for secret encryption">
  This endpoint allows users with read access to a repository to get a public key for encrypting secrets. for private repositories, oauth and classic personal access tokens require the `repo` scope.
</Accordion>

<Accordion title="Get pending deployments for a workflow run">
  Use this action to get a list of deployment environments that are waiting for protection rule approval in a workflow run.
</Accordion>

<Accordion title="Get rate limit status for the authenticated user">
  Use this action to get the current rate limit status for the authenticated user.
</Accordion>

<Accordion title="Get copilot seat assignment details for a user">
  Use this action to get github copilot seat assignment details for a specific user in an organization.
</Accordion>

<Accordion title="Get a workflow">
  Use this action to get details of a specific workflow in a repository.
</Accordion>

<Accordion title="Get repository clones">
  Use this action to get the number of clones and their daily/weekly breakdown for a repository over the last 14 days.
</Accordion>

<Accordion title="Get repository permissions for a user">
  Use this action to get a user's permission level for a repository. the permission level can be admin, write, read, or none. note that 'maintain' role maps to 'write' permission and 'triage' role maps to 'read' permission.
</Accordion>

<Accordion title="Github Get Repo Dev Env Secret">
  Use this action to retrieve a repository development environment secret without exposing its encrypted value.
</Accordion>

<Accordion title="Get repository content">
  Use this action to get the contents of a file or directory in a repository.
</Accordion>

<Accordion title="Get a secret scanning alert">
  Use this action to retrieve a specific secret scanning alert from a repository.
</Accordion>

<Accordion title="Get a public ssh key for the authenticated user">
  Use this action to retrieve details of a specific public ssh key for the authenticated user.
</Accordion>

<Accordion title="Get a workflow run">
  Use this action to get details of a specific workflow run in a repository.
</Accordion>

<Accordion title="Get a repository secret">
  Use this action to retrieve a repository secret's metadata (without its encrypted value).
</Accordion>

<Accordion title="Get public key for the authenticated user">
  Use this action to get a public key for encrypting codespaces secrets for the authenticated user.
</Accordion>

<Accordion title="Github Get Repository Secret Securely">
  Gets a single repository secret without revealing its encrypted value. oauth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
</Accordion>

<Accordion title="Get shared storage billing for an organization">
  Use this action to get billing information for shared storage (github actions and github packages) for an organization. returns estimated paid storage usage for private repositories.
</Accordion>

<Accordion title="Get a pull request">
  Use this action to retrieve details of a specific pull request in a repository.
</Accordion>

<Accordion title="Get rules for a branch">
  Use this action to get all active rules that apply to a branch in a repository. this excludes rules in 'evaluate' or 'disabled' status.
</Accordion>

<Accordion title="Get shared storage billing for a user">
  Use this action to get the shared storage billing information for a specified github user.
</Accordion>

<Accordion title="Get single org secret without decryption">
  Use this action to retrieve an organization's dependabot secret without its encrypted value.
</Accordion>

<Accordion title="Get a repository subscription">
  Use this action to check if the authenticated user is subscribed to a repository.
</Accordion>

<Accordion title="Get a repository security advisory">
  Use this action to retrieve a specific security advisory from a repository.
</Accordion>

<Accordion title="Get a release">
  Use this action to get details of a specific release from a repository using its release id.
</Accordion>

<Accordion title="Get a self hosted runner for an organization">
  Use this action to get details of a specific self-hosted runner in an organization.
</Accordion>

<Accordion title="Get a repository variable">
  Use this action to retrieve a specific github actions variable from a repository.
</Accordion>

<Accordion title="Get a workflow run attempt">
  Use this action to retrieve details of a specific workflow run attempt in a repository.
</Accordion>

<Accordion title="Get github actions permissions for an organization">
  Use this action to get the github actions permissions policy and allowed actions/workflows for an organization.
</Accordion>

<Accordion title="Get a reference">
  Use this action to get a git reference (branch or tag) from a repository.
</Accordion>

<Accordion title="Get a release asset">
  Use this action to get a specific release asset from a repository. the asset can be downloaded by setting the accept header to application/octet-stream.
</Accordion>

<Accordion title="Get github actions permissions for a repository">
  Use this action to get the permissions policy for github actions in a repository, including whether actions are enabled and which actions/workflows are allowed to run.
</Accordion>

<Accordion title="Get a package for an organization">
  Use this action to retrieve a package from an organization's packages. requires 'read:packages' scope for access.
</Accordion>

<Accordion title="Get a package for a user">
  Use this action to retrieve metadata for a specific package owned by a user.
</Accordion>

<Accordion title="Get a team legacy">
  Use this action to get information about a team using the legacy api endpoint. note: this endpoint is deprecated, use 'get a team by name' instead.
</Accordion>

<Accordion title="Get a team by name">
  Use this action to get a github team's information using the team's slug (url-friendly team name).
</Accordion>

<Accordion title="Get a self hosted runner for a repository">
  Use this action to get details of a specific self-hosted runner in a repository.
</Accordion>

<Accordion title="Get a tag">
  Use this action to get details of a specific git tag in a repository using its sha.
</Accordion>

<Accordion title="Get github meta information">
  Use this action to get github's metadata including ip addresses (both ipv4 and ipv6) and domain names.
</Accordion>

<Accordion title="Get team membership for a user">
  Use this action to get the team membership status for a specific user in an organization's team.
</Accordion>

<Accordion title="List issue events for a repository">
  Lists events for a repository.\<\<DEPRECATED use list\_issue\_events\_for\_a\_repository>>
</Accordion>

<Accordion title="Get the weekly commit count">
  Use this action to get the total number of commits made by the repository owner and all contributors in the last 52 weeks.
</Accordion>

<Accordion title="Get the level of access for workflows outside of the repository">
  Use this action to get the access level for workflows outside of a private repository.
</Accordion>

<Accordion title="Get the zen of github">
  Use this action to get a random inspirational message from github's zen collection
</Accordion>

<Accordion title="Get the last year of commit activity">
  Use this action to get the commit activity statistics for the last year, organized by week.
</Accordion>

<Accordion title="Get teams with access to the protected branch">
  Use this action to get a list of teams that have push access to a protected branch in a repository.
</Accordion>

<Accordion title="Get team membership for a user legacy">
  Use this action to get a user's membership status in a team using the legacy api endpoint. note: this is a deprecated endpoint. use 'get team membership for a user' instead.
</Accordion>

<Accordion title="List classrooms">
  Use this action to list all github classroom classrooms where the authenticated user is an administrator.
</Accordion>

<Accordion title="Get the combined status for a specific reference">
  Use this action to get the combined commit status (failure, pending, or success) for a specific sha, branch, or tag in a repository.
</Accordion>

<Accordion title="Get the authenticated user">
  Use this action to get information about the authenticated user.
</Accordion>

<Accordion title="List child teams legacy">
  Use this action to list all child teams of a team. note: this is a legacy endpoint that will be removed. use 'list child teams' endpoint instead.
</Accordion>

<Accordion title="List assignees">
  List all users that can be assigned to issues in a repository. (deprecated: use list assignees)
</Accordion>

<Accordion title="Get status checks protection">
  Use this action to get the status checks protection settings for a protected branch in a repository.
</Accordion>

<Accordion title="Get users with access to the protected branch">
  Use this action to get a list of users who have push access to a protected branch in a repository.
</Accordion>

<Accordion title="List available machine types for a repository">
  Use this action to get a list of machine types that are available for codespaces in a repository.
</Accordion>

<Accordion title="Get top referral paths">
  Use this action to get the top 10 most viewed content paths in a repository over the last 14 days.
</Accordion>

<Accordion title="Get the license for a repository">
  Use this action to get the license information for a specific repository.
</Accordion>

<Accordion title="List branches">
  Use this action to list the branches of a repository.
</Accordion>

<Accordion title="List code scanning analyses for a repository">
  Use this action to list code scanning analyses for a repository. returns up to 30 analyses per page.
</Accordion>

<Accordion title="List comments for a pull request review">
  Use this action to retrieve all comments associated with a specific pull request review.
</Accordion>

<Accordion title="List deliveries for an organization webhook">
  Use this action to list webhook delivery history for a specific organization webhook.
</Accordion>

<Accordion title="Get the latest release">
  Use this action to get the most recent non-prerelease, non-draft release of a repository.
</Accordion>

<Accordion title="List code scanning alerts for a repository">
  Use this action to list code scanning alerts for a repository. you can filter alerts by tool name, reference, state, and severity.
</Accordion>

<Accordion title="Get the review history for a workflow run">
  Use this action to retrieve the review history and approval status for a specific workflow run in a repository.
</Accordion>

<Accordion title="Get workflow usage">
  Use this action to get the billing usage details for a specific workflow in a repository.
</Accordion>

<Accordion title="Get the hourly commit count for each day">
  Use this action to get the commit count for each hour of each day of the week for a repository.
</Accordion>

<Accordion title="List codespaces for a user in organization">
  Use this action to list all codespaces owned by an organization member.
</Accordion>

<Accordion title="Get top referral sources">
  Use this action to get a list of the top 10 referral sources for a repository's traffic over the last 14 days.
</Accordion>

<Accordion title="Get workflow run usage">
  Use this action to get the usage metrics (billable time) for a specific workflow run.
</Accordion>

<Accordion title="List branches for head commit">
  Use this action to list all branches that contain a specific commit sha as their latest commit.
</Accordion>

<Accordion title="Get team member legacy">
  Use this action to get a team member's information using the legacy api endpoint. note: this action is deprecated, use 'get team membership for a user' instead.
</Accordion>

<Accordion title="List codeowners errors">
  Use this action to list any syntax errors found in a repository's codeowners file.
</Accordion>

<Accordion title="List dependabot alerts for an enterprise">
  Use this action to list all dependabot alerts for repositories owned by an enterprise.
</Accordion>

<Accordion title="List deployments">
  Use this action to list all deployments for a repository. you can filter deployments by environment, ref, task, or sha.
</Accordion>

<Accordion title="List dependabot alerts for an organization">
  Use this action to list all dependabot alerts for an organization.
</Accordion>

<Accordion title="Create a gist">
  Use this action to create a gist (a shareable code snippet) on github. (deprecated: use create a gist)
</Accordion>

<Accordion title="List commits">
  Use this action to list commits in a repository.
</Accordion>

<Accordion title="List deliveries for a repository webhook">
  Use this action to get a list of webhook delivery records for a specific repository webhook.
</Accordion>

<Accordion title="List codespaces for the authenticated user">
  Use this action to get a list of codespaces owned by the authenticated user.
</Accordion>

<Accordion title="Get the status of a github pages deployment">
  Use this action to get the current deployment status of a github pages site.
</Accordion>

<Accordion title="List dependabot alerts for a repository">
  Use this action to list all dependabot alerts for a repository.
</Accordion>

<Accordion title="List deployment branch policies">
  Use this action to get a list of deployment branch policies for a specific environment in a repository.
</Accordion>

<Accordion title="List check runs for a git reference">
  Use this action to list check runs for a specific git reference (sha, branch, or tag) in a repository.
</Accordion>

<Accordion title="List environments">
  Use this action to list all environments in a repository.
</Accordion>

<Accordion title="List environment variables">
  Use this action to list all environment variables for a repository environment.
</Accordion>

<Accordion title="Github List Environment Custom Deployment Rules">
  Use this action to list custom deployment protection rules configured for a repository environment.
</Accordion>

<Accordion title="Get the weekly commit activity">
  Use this action to get weekly statistics about additions and deletions in a repository. note: only works for repositories with fewer than 10,000 commits.
</Accordion>

<Accordion title="List discussions legacy">
  Use this action to list team discussions using the legacy api endpoint. note: this is a deprecated endpoint, consider using the 'list discussions' endpoint instead.
</Accordion>

<Accordion title="List events for the authenticated user">
  Use this action to list events for a specific user. if you are authenticated as the given user, you will see private events. otherwise, only public events are shown.
</Accordion>

<Accordion title="List email addresses for the authenticated user">
  Use this action to list all email addresses associated with the authenticated user.
</Accordion>

<Accordion title="List public gists">
  Use this action to list all public gists on github. (deprecated: use list public gists)
</Accordion>

<Accordion title="List failed organization invitations">
  Use this action to get a list of failed organization invitations, including when they failed and the reason for failure.
</Accordion>

<Accordion title="List environment secrets">
  Use this action to list all secrets in a repository environment. note: requires collaborator access with repo scope.
</Accordion>

<Accordion title="List followers of a user">
  Use this action to get a list of users who follow a specific github user.
</Accordion>

<Accordion title="List commits on a pull request">
  Use this action to list all commits in a pull request.
</Accordion>

<Accordion title="Github api root">
  Use this action to get the root endpoint information of github's rest api
</Accordion>

<Accordion title="List followers of the authenticated user">
  Use this action to get a list of users who are following you.
</Accordion>

<Accordion title="List deployment statuses">
  Use this action to list all deployment statuses for a specific deployment.
</Accordion>

<Accordion title="List check runs in a check suite">
  Use this action to list all check runs within a specific check suite in a repository.
</Accordion>

<Accordion title="List gists for the authenticated user">
  Use this action to list all gists for the authenticated user, or all public gists if called anonymously.
</Accordion>

<Accordion title="List gists for a user">
  Use this action to list all public gists for a specified github user.
</Accordion>

<Accordion title="List gist comments">
  Use this action to list all comments on a specified gist.
</Accordion>

<Accordion title="List events received by the authenticated user">
  Use this action to list events received by watching repositories and following users. for authenticated users, both private and public events are shown; otherwise, only public events are visible.
</Accordion>

<Accordion title="List codespaces for the organization">
  Use this action to list all codespaces associated with a specified organization.
</Accordion>

<Accordion title="List check run annotations">
  Use this action to get a list of annotations for a specific check run in a repository.
</Accordion>

<Accordion title="List forks">
  Use this action to list all forks of a repository.
</Accordion>

<Accordion title="List gist commits">
  Use this action to list all commits for a specified gist.
</Accordion>

<Accordion title="List commit comments">
  Use this action to list all comments for a specific commit in a repository.
</Accordion>

<Accordion title="List repository issues">
  List all issues (including pull requests) in a github repository. \[deprecated: use list repository issues]
</Accordion>

<Accordion title="List discussion comments">
  Use this action to list all comments from a team discussion.
</Accordion>

<Accordion title="List gist forks">
  Use this action to list all forks of a specified gist.
</Accordion>

<Accordion title="Create an issue">
  Pull access users can create issues unless disabled. api may return `410 gone` if issues off. excessive endpoint use can trigger rate limiting. it supports raw, text, html formats for return data.\<\<DEPRECATED use create\_an\_issue>>
</Accordion>

<Accordion title="List gpg keys for the authenticated user">
  Use this action to list all gpg keys associated with the authenticated user.
</Accordion>

<Accordion title="List gpg keys for a user">
  Use this action to get a list of gpg keys associated with a github user.
</Accordion>

<Accordion title="List github pages builds">
  Use this action to list all builds of a github pages site for a repository.
</Accordion>

<Accordion title="List github actions caches for a repository">
  Use this action to list all github actions caches for a repository.
</Accordion>

<Accordion title="List deploy keys">
  Use this action to list all deploy keys for a repository.
</Accordion>

<Accordion title="Create an issue comment">
  Use this action to create a comment on a github issue or pull request. (deprecated: use create an issue comment)
</Accordion>

<Accordion title="List codespaces in a repository for the authenticated user">
  Use this action to list all codespaces in a repository that are accessible to the authenticated user.
</Accordion>

<Accordion title="List app installations for an organization">
  Use this action to list all github apps installed in repositories within an organization.
</Accordion>

<Accordion title="Get an issue">
  Deprecated: use get an issue action instead to retrieve issue details.
</Accordion>

<Accordion title="List check suites for a git reference">
  Use this action to list check suites for a specific git reference (commit sha, branch, or tag) in a repository.
</Accordion>

<Accordion title="List artifacts for a repository">
  Use this action to list all workflow artifacts in a repository.
</Accordion>

<Accordion title="List discussion comments legacy">
  Use this action to list comments on a team discussion using the legacy api endpoint.
</Accordion>

<Accordion title="Github List Docker Migration Conflicts">
  Use this action to list packages in an organization that had conflicts during docker migration. requires 'read:packages' scope.
</Accordion>

<Accordion title="List global security advisories">
  Use this action to list github's global security advisories, which includes vulnerability information and advisories.
</Accordion>

<Accordion title="List codeql databases for a repository">
  Use this action to list all codeql databases available in a repository.
</Accordion>

<Accordion title="List accepted assignments for an assignment">
  Use this action to list all student repositories that have been created by accepting a github classroom assignment. only accessible to classroom administrators.
</Accordion>

<Accordion title="List child teams">
  Use this action to get a list of all child teams under a specified parent team in an organization.
</Accordion>

<Accordion title="List app installations accessible to the user access token">
  Use this action to list all github app installations that the authenticated user has access to, including their permissions.
</Accordion>

<Accordion title="List issues assigned to the authenticated user">
  Fetches issues assigned to the user across all repos, using filters to customize the fetch. issues and pull requests are included, discernible by the `pull request` key. supports various media types for responses. visit github docs for more info.\<\<DEPRECATED use list\_issues\_assigned\_to\_the\_authenticated\_user>>
</Accordion>

<Accordion title="List assignees">
  List all users that can be assigned to issues in a repository.
</Accordion>

<Accordion title="List all copilot seat assignments for an organization">
  Use this action to list all copilot seat assignments and their status in an organization.
</Accordion>

<Accordion title="List discussions">
  Use this action to list all discussions on a team's page.
</Accordion>

<Accordion title="List assignments for a classroom">
  Use this action to get a list of assignments for a github classroom. only accessible to classroom administrators.
</Accordion>

<Accordion title="List commit comments for a repository">
  Use this action to list all commit comments in a repository.
</Accordion>

<Accordion title="List commit statuses for a reference">
  Use this action to get a list of commit statuses for a specific commit reference (sha, branch, or tag).
</Accordion>

<Accordion title="List custom property values for organization repositories">
  Use this action to get a list of repositories in an organization along with their custom property values.
</Accordion>

<Accordion title="List code scanning alerts for an organization">
  Use this action to list code scanning alerts for all eligible repositories in an organization.
</Accordion>

<Accordion title="List issue comments">
  Use this action to list all comments on a specific issue in a repository.
</Accordion>

<Accordion title="List instances of a code scanning alert">
  Use this action to list all instances of a specific code scanning alert in a repository.
</Accordion>

<Accordion title="List issues assigned to the authenticated user">
  Use this action to list all issues assigned to the authenticated user across all repositories.
</Accordion>

<Accordion title="List jobs for a workflow run attempt">
  Use this action to list all jobs for a specific workflow run attempt.
</Accordion>

<Accordion title="List labels for a repository">
  Use this action to get a list of all labels in a repository.
</Accordion>

<Accordion title="List labels for issues in a milestone">
  Use this action to get a list of all labels associated with issues in a specific milestone.
</Accordion>

<Accordion title="List labels for a self hosted runner for a repository">
  Use this action to get all labels associated with a self-hosted runner in a repository.
</Accordion>

<Accordion title="List labels for an issue">
  Use this action to get all labels that are assigned to a specific issue in a repository.
</Accordion>

<Accordion title="List labels for a self hosted runner for an organization">
  Use this action to list the labels associated with a self-hosted runner in an organization.
</Accordion>

<Accordion title="List issue comments for a repository">
  Use this action to list all comments on issues and pull requests in a repository.
</Accordion>

<Accordion title="List notifications for the authenticated user">
  Use this action to get a list of notifications for the authenticated user, sorted by most recent updates.
</Accordion>

<Accordion title="List organizations">
  Use this action to list all github organizations, sorted by their creation date.
</Accordion>

<Accordion title="List jobs for a workflow run">
  Use this action to list all jobs for a specific workflow run in a repository.
</Accordion>

<Accordion title="List installation requests for the authenticated app">
  Use this action to get a list of all pending installation requests for your github app.
</Accordion>

<Accordion title="List organization fine grained permissions for an organization">
  Use this action to retrieve a list of fine-grained permissions available for custom organization and repository roles.
</Accordion>

<Accordion title="List issue events for a repository">
  Use this action to get a list of events associated with issues in a repository.
</Accordion>

<Accordion title="List issue events">
  Use this action to get a list of all events associated with a specific issue in a repository.
</Accordion>

<Accordion title="List organization migrations">
  Use this action to list the most recent migrations for an organization, including both export and import migrations.
</Accordion>

<Accordion title="List organization memberships for the authenticated user">
  Use this action to get a list of organizations that the authenticated user is a member of.
</Accordion>

<Accordion title="List org level codespaces secrets">
  Use this action to list all codespaces secrets available at the organization level.
</Accordion>

<Accordion title="List organization webhooks">
  Use this action to list all webhooks configured for a github organization.
</Accordion>

<Accordion title="List organization rule suites">
  Use this action to list rule evaluation summaries for repositories within an organization.
</Accordion>

<Accordion title="List locations for a secret scanning alert">
  Use this action to get a list of locations where a secret scanning alert was found in a repository.
</Accordion>

<Accordion title="Github List Org Secrets Without Values">
  Use this action to list all secrets available in an organization without their encrypted values.
</Accordion>

<Accordion title="List organizations for a user">
  Use this action to list public organizations that a specified user is a member of.
</Accordion>

<Accordion title="List project columns">
  Use this action to get a list of columns in a github project.
</Accordion>

<Accordion title="List pending team invitations">
  Use this action to list all pending invitations for a team in an organization.
</Accordion>

<Accordion title="List public email addresses for the authenticated user">
  Use this action to get the list of public email addresses for the authenticated user.
</Accordion>

<Accordion title="List organizations for the authenticated user">
  Use this action to list all organizations that the authenticated user is a member of.
</Accordion>

<Accordion title="List packages for the authenticated user s namespace">
  Use this action to list all packages owned by the authenticated user.
</Accordion>

<Accordion title="List pending organization invitations">
  Use this action to list all pending invitations to an organization.
</Accordion>

<Accordion title="List package versions for a package owned by a user">
  Use this action to list all versions of a public package owned by a specific user.
</Accordion>

<Accordion title="Github List Org Repos Withgithub Actions Enabled">
  Use this action to list repositories in an organization that have github actions enabled.
</Accordion>

<Accordion title="List organization projects">
  Use this action to list all projects in a github organization.
</Accordion>

<Accordion title="List package versions for a package owned by an organization">
  Use this action to list all versions of a package owned by an organization.
</Accordion>

<Accordion title="List public events for a user">
  Use this action to list all public events performed by a github user.
</Accordion>

<Accordion title="List public events">
  Use this action to list all public events on github. note that events are delayed by 5 minutes.
</Accordion>

<Accordion title="List public events for a network of repositories">
  Use this action to list public events for a network of repositories associated with a specific owner and repository.
</Accordion>

<Accordion title="List organization secrets">
  Use this action to list all secrets configured in an organization. note: this action requires authentication with admin:org and repo scopes.
</Accordion>

<Accordion title="List public events received by a user">
  Use this action to list all public events that a user has received.
</Accordion>

<Accordion title="Github List Org Resource Access Tokens">
  Use this action to list all approved fine-grained personal access tokens that can access organization resources.
</Accordion>

<Accordion title="List organization invitation teams">
  Use this action to list all teams that are associated with a specific organization invitation. note: requires organization owner permissions.
</Accordion>

<Accordion title="List organization repositories">
  Use this action to list all repositories that belong to a specified organization.
</Accordion>

<Accordion title="Github List Org Resources With Personal Tokens">
  Use this action to list all requests from organization members to access organization resources using fine-grained personal access tokens.
</Accordion>

<Accordion title="List organization variables">
  Use this action to list all github actions variables for an organization.
</Accordion>

<Accordion title="List pending team invitations legacy">
  Use this action to list all pending invitations for a team using the legacy endpoint.
</Accordion>

<Accordion title="List outside collaborators for an organization">
  Use this action to get a list of all users who are outside collaborators of an organization.
</Accordion>

<Accordion title="List machine types for a codespace">
  Use this action to get a list of available machine types that a codespace can be transitioned to.
</Accordion>

<Accordion title="List organization events for the authenticated user">
  Use this action to list events for the authenticated user in a specific organization.
</Accordion>

<Accordion title="List public gists">
  Use this action to list all public gists on github.
</Accordion>

<Accordion title="List pull requests files">
  Use this action to list the files that were modified, added, or deleted in a pull request.
</Accordion>

<Accordion title="List reactions for an issue">
  Use this action to get a list of all reactions on a specific issue.
</Accordion>

<Accordion title="List public keys for a user">
  Use this action to get a list of verified public ssh keys for a specified github user.
</Accordion>

<Accordion title="List reactions for a team discussion comment">
  Use this action to get a list of reactions to a team discussion comment.
</Accordion>

<Accordion title="List public organization events">
  Use this action to list public events (like watch and push events) for a specified organization.
</Accordion>

<Accordion title="List reactions for a team discussion comment legacy">
  Use this action to list reactions for a team discussion comment using the legacy api endpoint. note: this is a deprecated endpoint.
</Accordion>

<Accordion title="List repositories for a user migration">
  Use this action to get a list of repositories included in a user's migration.
</Accordion>

<Accordion title="List project cards">
  Use this action to get a list of all project cards in a specified project column.
</Accordion>

<Accordion title="List reactions for an issue comment">
  Use this action to get a list of reactions on a specific issue comment.
</Accordion>

<Accordion title="List repositories for the authenticated user">
  Use this action to list all repositories owned by or accessible to the authenticated user.
</Accordion>

<Accordion title="List repositories accessible to the app installation">
  Use this action to get a list of repositories that a github app installation has access to.
</Accordion>

<Accordion title="List matching references">
  Use this action to list git references (branches or tags) that match a specified pattern in a repository.
</Accordion>

<Accordion title="List repositories starred by the authenticated user">
  Use this action to list all repositories that the authenticated user has starred.
</Accordion>

<Accordion title="Github List Owned Package Versions">
  Use this action to list all versions of a package owned by the authenticated user.
</Accordion>

<Accordion title="List repository contributors">
  Use this action to list all contributors to a repository, sorted by number of contributions.
</Accordion>

<Accordion title="List organization issues assigned to the authenticated user">
  Use this action to list all issues assigned to the authenticated user in a specified organization.
</Accordion>

<Accordion title="List reactions for a commit comment">
  Use this action to get a list of reactions on a specific commit comment.
</Accordion>

<Accordion title="List repositories watched by a user">
  Use this action to get a list of repositories that a specific user is watching.
</Accordion>

<Accordion title="List repositories in an organization migration">
  Use this action to list all repositories included in a specific organization migration.
</Accordion>

<Accordion title="List repository activities">
  Use this action to list activities in a repository, including pushes, merges, and branch changes.
</Accordion>

<Accordion title="List repositories watched by the authenticated user">
  Use this action to get a list of repositories that the authenticated user is watching.
</Accordion>

<Accordion title="List repository events">
  Use this action to retrieve a list of events that occurred in a repository.
</Accordion>

<Accordion title="List repository collaborators">
  Use this action to list all collaborators in a repository.
</Accordion>

<Accordion title="List reactions for a pull request review comment">
  Use this action to list all reactions to a specific pull request review comment.
</Accordion>

<Accordion title="List repository invitations for the authenticated user">
  Use this action to list all open repository invitations for the authenticated user.
</Accordion>

<Accordion title="List repository invitations">
  Use this action to list all currently open repository invitations. requires admin access to the repository.
</Accordion>

<Accordion title="List repositories for a user">
  Use this action to list all repositories owned by or accessible to a specific github user.
</Accordion>

<Accordion title="List reactions for a release">
  Use this action to get a list of reactions for a specific release in a repository.
</Accordion>

<Accordion title="List repository languages">
  Use this action to get a list of programming languages used in a repository and their byte count.
</Accordion>

<Accordion title="List repositories starred by a user">
  Use this action to get a list of repositories that a specific user has starred.
</Accordion>

<Accordion title="List reactions for a team discussion legacy">
  Use this action to list reactions for a team discussion using the legacy api endpoint. note: this endpoint is deprecated.
</Accordion>

<Accordion title="List organization members">
  Use this action to list all members of a github organization. the list includes both public and concealed members if the authenticated user is also a member of the organization.
</Accordion>

<Accordion title="List repository organization secrets">
  Use this action to list organization secrets available to a repository. note: collaborator access is required, and only secret names (not values) are returned.
</Accordion>

<Accordion title="List reactions for a team discussion">
  Use this action to list all reactions to a team discussion in an organization.
</Accordion>

<Accordion title="List repositories accessible to the user access token">
  Use this action to list all repositories that are accessible to a user through their access token for a specific github app installation.
</Accordion>

<Accordion title="List public organization members">
  Use this action to list all users who have publicly declared their membership in a github organization.
</Accordion>

<Accordion title="List repository issues">
  Use this action to list all issues and pull requests in a github repository.
</Accordion>

<Accordion title="List repository projects">
  Use this action to list all projects in a repository.
</Accordion>

<Accordion title="List public repositories">
  Use this action to list all public repositories on github.
</Accordion>

<Accordion title="List public ssh keys for the authenticated user">
  Use this action to list all public ssh keys associated with the authenticated user's github account.
</Accordion>

<Accordion title="List repository organization variables">
  Use this action to list organization variables that are available to a repository. requires collaborator access and oauth/pat with 'repo' scope.
</Accordion>

<Accordion title="List pull requests associated with a commit">
  Use this action to list pull requests associated with a specific commit. for commits in the default branch, it returns merged prs, otherwise it returns open prs.
</Accordion>

<Accordion title="List packages for an organization">
  Use this action to list all packages in an organization.
</Accordion>

<Accordion title="List releases">
  Use this action to list all releases of a repository.
</Accordion>

<Accordion title="List project collaborators">
  Use this action to list all collaborators of a github project. this includes outside collaborators, direct collaborators, team members, and organization owners.
</Accordion>

<Accordion title="List milestones">
  Use this action to get a list of all milestones in a repository.
</Accordion>

<Accordion title="List packages for a user">
  Use this action to list all packages in a user's namespace that you have access to view.
</Accordion>

<Accordion title="List pull requests">
  Use this action to list pull requests for a repository.
</Accordion>

<Accordion title="List release assets">
  Use this action to list all assets associated with a release in a repository.
</Accordion>

<Accordion title="List repository notifications for the authenticated user">
  Use this action to get a list of notifications for the authenticated user in a specific repository.
</Accordion>

<Accordion title="List repository secrets">
  Use this action to list all secrets configured in a repository. note that this action only lists the secrets without showing their encrypted values.
</Accordion>

<Accordion title="List repository secrets without decrypting">
  Use this action to list all secrets in a repository without revealing their encrypted values.
</Accordion>

<Accordion title="List repository rule suites">
  Use this action to list rule evaluation suites for a repository, including their results and insights.
</Accordion>

<Accordion title="List repository workflows">
  Use this action to list all workflows in a repository.
</Accordion>

<Accordion title="List repository security advisories">
  Use this action to list security advisories for a repository.
</Accordion>

<Accordion title="List repository variables">
  Use this action to list all variables defined in a repository.
</Accordion>

<Accordion title="List ssh signing keys for the authenticated user">
  Use this action to get a list of ssh signing keys associated with the authenticated user's github account.
</Accordion>

<Accordion title="List starred gists">
  Use this action to get a list of gists that the authenticated user has starred.
</Accordion>

<Accordion title="List secret scanning alerts for a repository">
  Use this action to list all secret scanning alerts for a repository.
</Accordion>

<Accordion title="List security manager teams">
  Use this action to list all teams that have been granted security manager permissions in an organization. requires oauth token or personal access token with 'read:org' scope.
</Accordion>

<Accordion title="List stargazers">
  Use this action to list users who have starred a repository.
</Accordion>

<Accordion title="List subscriptions for the authenticated user">
  Use this action to get a list of active marketplace subscriptions for the authenticated user.
</Accordion>

<Accordion title="List repository teams">
  Use this action to list all teams that have access to a repository.
</Accordion>

<Accordion title="Github List Repos With Ghactions Cache Usage">
  Use this action to list github actions cache usage statistics for repositories in an organization.
</Accordion>

<Accordion title="List team repositories">
  Use this action to list all repositories that a team has access to.
</Accordion>

<Accordion title="List team repositories legacy">
  Use this action to list repositories that belong to a team using the legacy endpoint. note: this endpoint is deprecated, use 'list team repositories' instead.
</Accordion>

<Accordion title="List team projects legacy">
  Use this action to list all projects for a team using the legacy endpoint. note: this action is deprecated.
</Accordion>

<Accordion title="List user migrations">
  Use this action to list all migrations initiated by the authenticated user.
</Accordion>

<Accordion title="List repository webhooks">
  Use this action to list all webhooks configured for a repository.
</Accordion>

<Accordion title="List users that are assigned to an organization role">
  Use this action to get a list of users who are assigned to a specific role in an organization. requires administrator access and the `admin:org` scope for oauth or classic tokens.
</Accordion>

<Accordion title="List selected repositories for an organization secret">
  Use this action to get a list of repositories that have access to an organization secret when the visibility is set to 'selected'.
</Accordion>

<Accordion title="List repository security advisories for an organization">
  Use this action to list all security advisories for an organization. only organization owners and security managers can access this information.
</Accordion>

<Accordion title="List users blocked by the authenticated user">
  Use this action to get a list of users that are blocked by the authenticated user.
</Accordion>

<Accordion title="List selected repositories for an organization variable">
  Use this action to get a list of repositories that have been selected to use an organization variable.
</Accordion>

<Accordion title="Mark a thread as read">
  Use this action to mark a notification thread as read.
</Accordion>

<Accordion title="List user account issues assigned to the authenticated user">
  Use this action to list all issues assigned to the authenticated user across all repositories.
</Accordion>

<Accordion title="List subscriptions for the authenticated user stubbed">
  Use this action to get a list of active marketplace subscriptions for the authenticated user (stubbed version).
</Accordion>

<Accordion title="Mark a thread as done">
  Use this action to mark a notification thread as done in your github notification inbox.
</Accordion>

<Accordion title="Move a project column">
  Use this action to move a project column to a different position (first, last, or after another column).
</Accordion>

<Accordion title="Lock an issue">
  Use this action to lock conversations in an issue or pull request. only users with push access can perform this action.
</Accordion>

<Accordion title="Mark notifications as read">
  Use this action to mark all notifications as read for the authenticated user.
</Accordion>

<Accordion title="List user projects">
  Use this action to get a list of projects for a specified github user.
</Accordion>

<Accordion title="Mark repository notifications as read">
  Use this action to mark all notifications in a repository as read for the authenticated user.
</Accordion>

<Accordion title="Manage access control for organization codespaces">
  Use this action to manage user access to codespaces in an organization by setting visibility and selecting which members can access codespaces.
</Accordion>

<Accordion title="List tag protection states for a repository">
  Use this action to get the list of tag protection states for a repository. only available to repository administrators.
</Accordion>

<Accordion title="Merge a branch">
  Use this action to merge one branch into another in a repository.
</Accordion>

<Accordion title="Check if a pull request has been merged">
  Use this action to check if a pull request has been merged into its base branch (deprecated: use check if a pull request has been merged).
</Accordion>

<Accordion title="Ping a repository webhook">
  Use this action to send a ping event to a repository webhook to verify its configuration.
</Accordion>

<Accordion title="Github List Repo Access By Token">
  Use this action to list repositories that a fine-grained personal access token is requesting access to. only github apps can use this action.
</Accordion>

<Accordion title="List selected repositories for a user secret">
  Use this action to get a list of repositories that have access to a specific user's development environment secret.
</Accordion>

<Accordion title="Ping an organization webhook">
  Use this action to send a ping event to an organization webhook. requires organization owner permissions and admin:org hook scope.
</Accordion>

<Accordion title="List watchers">
  Use this action to get a list of users who are watching (subscribing to) a specific repository.
</Accordion>

<Accordion title="Github Manage Custom Properties For Org Repos">
  Use this action to update or create custom properties for organization repositories. you can manage properties for up to 30 repositories in a single request.
</Accordion>

<Accordion title="Privately report a security vulnerability">
  Use this action to privately report a security vulnerability in a repository.
</Accordion>

<Accordion title="Create a review for a pull request">
  This api endpoint enables creation of pull request reviews and notifications. rapid usage may cause rate limiting. use `pending` for draft reviews. calculate diff position for comments. supports various response content types.\<\<DEPRECATED use create\_a\_review\_for\_a\_pull\_request>>
</Accordion>

<Accordion title="Get a pull request">
  Deprecated: use get a pull request action instead.
</Accordion>

<Accordion title="Github List Selected Repos For Secret Access">
  Use this action to list all repositories that have been selected for access to a specific organization secret in dependabot.
</Accordion>

<Accordion title="Manage secrets in selected repositories with proper access">
  Use this action to list repositories that have access to an organization secret. only repositories that were specifically selected to have access will be returned.
</Accordion>

<Accordion title="Github List Repo Dev Container Configs For User">
  Use this action to list devcontainer.json configurations for a repository. requires 'codespace' scope for oauth app and personal tokens.
</Accordion>

<Accordion title="Create a review comment for a pull request">
  Use this action to create a comment on a specific line or range of lines in a pull request's diff. this is a deprecated version, use create a review comment for a pull request instead.
</Accordion>

<Accordion title="Create a pull request">
  Use this action to create a new pull request in a repository. (deprecated: use create a pull request)
</Accordion>

<Accordion title="Redeliver a delivery for an organization webhook">
  Use this action to reattempt delivery of a webhook to an organization. requires organization owner permissions.
</Accordion>

<Accordion title="Merge a pull request">
  Use this action to merge a pull request into its base branch.
</Accordion>

<Accordion title="Redeliver a delivery for a repository webhook">
  Use this action to resend a specific webhook delivery for a repository.
</Accordion>

<Accordion title="List self hosted runners for an organization">
  Use this action to list all self-hosted runners in an organization.
</Accordion>

<Accordion title="Remove an organization member">
  Use this action to remove a user from an organization. the user will be removed from all teams and lose access to all organization repositories.
</Accordion>

<Accordion title="List workflow runs for a repository">
  Use this action to list all workflow runs for a repository. you can filter the runs by actor, branch, event type, and status.
</Accordion>

<Accordion title="Remove all organization roles for a team">
  Use this action to remove all organization roles assigned to a team.
</Accordion>

<Accordion title="Map a commit author">
  Use this action to update a commit author's name and email in a repository before pushing new commits.
</Accordion>

<Accordion title="Github api root">
  Use this action to get the root endpoint information of github's rest api (deprecated - use github api root instead)
</Accordion>

<Accordion title="Remove all labels from an issue">
  Use this action to remove all labels from a specified issue in a repository.
</Accordion>

<Accordion title="List pull requests">
  Use this action to list pull requests for a repository. (deprecated: use list pull requests)
</Accordion>

<Accordion title="List repository tags">
  Use this action to list all tags in a github repository.
</Accordion>

<Accordion title="Remove all organization roles for a user">
  Use this action to remove all assigned organization roles from a user.
</Accordion>

<Accordion title="Github List Repo Secrets Without Values">
  Use this action to list all development environment secrets in a repository (without their encrypted values).
</Accordion>

<Accordion title="Remove an organization role from a user">
  Use this action to remove a custom organization role from a user.
</Accordion>

<Accordion title="Remove an organization role from a team">
  Use this action to remove an organization role from a team.
</Accordion>

<Accordion title="List self hosted runners for a repository">
  Use this action to list all self-hosted runners configured in a repository.
</Accordion>

<Accordion title="Remove assignees from an issue">
  Use this action to remove one or more assignees from a github issue.
</Accordion>

<Accordion title="List the people a user follows">
  Use this action to get a list of github users that a specific user follows.
</Accordion>

<Accordion title="List workflow runs for a workflow">
  Use this action to list all workflow runs for a specific workflow in a repository. you can filter the runs by actor, branch, event type, and status.
</Accordion>

<Accordion title="Remove a custom property for an organization">
  Use this action to delete a custom property from an organization. requires organization admin access or custom properties org definitions manager permission.
</Accordion>

<Accordion title="Remove a project from a team">
  Use this action to remove a project from a team in an organization.
</Accordion>

<Accordion title="Remove a label from an issue">
  Use this action to remove a specific label from an issue in a repository.
</Accordion>

<Accordion title="Remove a project from a team legacy">
  Use this action to remove a project from a team using the legacy api endpoint. note: this api is deprecated.
</Accordion>

<Accordion title="List teams">
  Use this action to list all teams in an organization.
</Accordion>

<Accordion title="List social accounts for a user">
  Use this action to list social media accounts linked to a github user.
</Accordion>

<Accordion title="Move a project card">
  Use this action to move a project card to a different position within a column or to a different column.
</Accordion>

<Accordion title="Github List Token Access Repositories">
  Use this action to get a list of repositories that a fine-grained personal access token can access. note: only github apps can use this action.
</Accordion>

<Accordion title="List the people the authenticated user follows">
  Use this action to get a list of users that the authenticated user follows.
</Accordion>

<Accordion title="List users blocked by an organization">
  Use this action to get a list of all users that are blocked by an organization.
</Accordion>

<Accordion title="List reviews for a pull request">
  Use this action to get a chronological list of reviews for a specific pull request.
</Accordion>

<Accordion title="List workflow run artifacts">
  Use this action to list all artifacts from a specific workflow run.
</Accordion>

<Accordion title="List teams for the authenticated user">
  Use this action to list all teams across organizations that the authenticated user belongs to.
</Accordion>

<Accordion title="List social accounts for the authenticated user">
  Use this action to list all social accounts linked to the authenticated user.
</Accordion>

<Accordion title="List teams that are assigned to an organization role">
  Use this action to get a list of teams that are assigned to a specific organization role.
</Accordion>

<Accordion title="List users">
  Use this action to list all github users (both individuals and organizations) in the order they signed up.
</Accordion>

<Accordion title="List ssh signing keys for a user">
  Use this action to get a list of ssh signing keys for a specified github user.
</Accordion>

<Accordion title="List secrets for the authenticated user">
  Use this action to list all codespaces development environment secrets for the authenticated user.
</Accordion>

<Accordion title="List review comments in a repository">
  Use this action to list all pull request review comments in a repository.
</Accordion>

<Accordion title="List review comments on a pull request">
  Use this action to list all review comments on a pull request.
</Accordion>

<Accordion title="List secret scanning alerts for an enterprise">
  Use this action to list all secret scanning alerts for an enterprise.
</Accordion>

<Accordion title="List runner applications for a repository">
  Use this action to list available runner application binaries that can be downloaded and run for a repository.
</Accordion>

<Accordion title="List secret scanning alerts for an organization">
  Use this action to list all secret scanning alerts for an organization's repositories.
</Accordion>

<Accordion title="List runner applications for an organization">
  Use this action to list available runner application binaries that can be downloaded and used for an organization. requires admin access and appropriate oauth tokens with 'admin:org' or 'repo' scopes.
</Accordion>

<Accordion title="Remove app access restrictions">
  Use this action to remove app access restrictions from a protected branch in a repository.
</Accordion>

<Accordion title="List team projects">
  Use this action to list all projects that a team has access to in an organization.
</Accordion>

<Accordion title="List team members legacy">
  Use this action to list members of a team using the legacy api endpoint. note: this endpoint is deprecated, use 'list team members' instead.
</Accordion>

<Accordion title="List team members">
  Use this action to list all members of a team in an organization, including members of child teams.
</Accordion>

<Accordion title="List timeline events for an issue">
  Use this action to retrieve a chronological list of events associated with a specific issue.
</Accordion>

<Accordion title="Remove a repository collaborator">
  Use this action to remove a collaborator from a repository.
</Accordion>

<Accordion title="Remove status check contexts">
  Use this action to remove status check contexts from a protected branch in a repository.
</Accordion>

<Accordion title="Remove a repository from a team">
  Use this action to remove a repository from a team in an organization. organization owners, team maintainers, or members with admin access can perform this action.
</Accordion>

<Accordion title="Remove a repository from an app installation">
  Use this action to remove a repository from a github app installation. requires admin access to the repository.
</Accordion>

<Accordion title="Render a markdown document">
  Use this action to convert markdown text to html. supports both standard markdown and github flavored markdown (gfm) rendering modes.
</Accordion>

<Accordion title="Get repository content">
  Use this action to get the contents of a file or directory in a repository. (deprecated: use get repository content)
</Accordion>

<Accordion title="Github Remove Org Secret By Name">
  Use this action to delete a dependabot secret from an organization using the secret name.
</Accordion>

<Accordion title="Github Remove Custom Label From Self Hosted Runner">
  Use this action to remove a custom label from an organization's self-hosted runner.
</Accordion>

<Accordion title="Remove interaction restrictions for an organization">
  Use this action to remove all interaction restrictions from public repositories in an organization. only organization owners can use this action.
</Accordion>

<Accordion title="Remove a repository from a team legacy">
  Use this action to remove a repository from a team using the legacy teams api endpoint.
</Accordion>

<Accordion title="List branches">
  Use this action to list the branches of a repository. (deprecated: use list branches)
</Accordion>

<Accordion title="Remove status check protection">
  Use this action to remove status check protection from a branch in a repository.
</Accordion>

<Accordion title="Remove org dev env secret by name">
  Use this action to delete a development environment secret from an organization using the secret name.
</Accordion>

<Accordion title="Remove teams from the copilot subscription for an organization">
  Use this action to remove github copilot access from specified teams in an organization.
</Accordion>

<Accordion title="Github Remove Repo From Org Secret With Selected Visibility">
  Use this action to remove a repository's access to an organization's dependabot secret that has 'selected' visibility.
</Accordion>

<Accordion title="Get all contributor commit activity">
  Use this action to get commit activity statistics for all repository contributors (deprecated).
</Accordion>

<Accordion title="Replace all repository topics">
  Use this action to replace or clear all topics of a repository by providing a new list of topic names.
</Accordion>

<Accordion title="Repo s list collaborators">
  The endpoint lists all collaborators in organization-owned repositories, including various organization members, and requires users with push access, and tokens with `read:org` and `repo` scopes to access. team member lists extend to child teams.\<\<DEPRECATED use list\_repository\_collaborators>>
</Accordion>

<Accordion title="Reset a token">
  Use this action to reset an oauth token for a github app or oauth application. the action requires basic authentication with app credentials.
</Accordion>

<Accordion title="Restore a package for the authenticated user">
  Use this action to restore a previously deleted package for the authenticated user. the package can be restored within 30 days of deletion if the namespace and version are still available.
</Accordion>

<Accordion title="Github Review Access With Personal Token">
  Use this action to approve or deny a pending request for accessing organization resources through a fine-grained personal access token. only github apps can use this action.
</Accordion>

<Accordion title="Remove team membership for a user">
  Use this action to remove a user from a team in an organization.
</Accordion>

<Accordion title="Remove interaction restrictions from your public repositories">
  Use this action to remove all interaction restrictions from your public repositories.
</Accordion>

<Accordion title="Replace repo access on org dev env secret set">
  Use this action to replace all repository access for an organization's development environment secret when setting it to 'selected' visibility.
</Accordion>

<Accordion title="Rerequest a check suite">
  Use this action to trigger a new check suite run for a specific check suite id without requiring new code pushes.
</Accordion>

<Accordion title="Request reviewers for a pull request">
  Use this action to request reviews from specific users or teams for a pull request.
</Accordion>

<Accordion title="Remove interaction restrictions for a repository">
  Use this action to remove interaction restrictions from a repository. requires owner or admin access.
</Accordion>

<Accordion title="Restore a package for a user">
  Use this action to restore a deleted package for a github user within 30 days of deletion.
</Accordion>

<Accordion title="Restore a package for an organization">
  Use this action to restore a deleted package in an organization within 30 days of deletion.
</Accordion>

<Accordion title="List commits">
  The `verification` object in a commit includes the `verified` status, `reason`, `signature`, and `payload`. failure can result from key issues, service errors, unsigned commits, unrecognized signatures, email issues, or invalid signatures. \<\<DEPRECATED use list\_commits>>
</Accordion>

<Accordion title="Replace org secret visibility to selected">
  Use this action to set an organization secret's visibility to 'selected' and specify which repositories can access it.
</Accordion>

<Accordion title="Remove team access restrictions">
  Use this action to remove team access restrictions from a protected branch.
</Accordion>

<Accordion title="Remove requested reviewers from a pull request">
  Use this action to remove specified users and/or teams from the list of requested reviewers on a pull request.
</Accordion>

<Accordion title="Rerequest a check run">
  Use this action to rerequest an existing check run in a repository. this will reset the check run's status to 'queued' and clear its conclusion.
</Accordion>

<Accordion title="Remove selected repository from an organization secret">
  Use this action to remove a repository's access to an organization secret.
</Accordion>

<Accordion title="Remove organization membership for a user">
  Use this action to remove a user's membership from an organization.
</Accordion>

<Accordion title="Review custom deployment protection rules for a workflow run">
  Use this action to approve or reject custom deployment protection rules for a workflow run.
</Accordion>

<Accordion title="Remove team membership for a user legacy">
  Use this action to remove a user's membership from a team using the legacy teams api. note: this is a deprecated endpoint.
</Accordion>

<Accordion title="List repository contributors">
  Use this action to list all contributors to a repository, sorted by number of contributions. (deprecated: use list repository contributors)
</Accordion>

<Accordion title="Remove a security manager team">
  Use this action to remove the security manager role from a team in an organization.
</Accordion>

<Accordion title="Github Review Resource Requests With Fine Grained Tokens">
  Use this action to approve or deny pending requests for accessing organization resources through fine-grained personal access tokens.
</Accordion>

<Accordion title="Create a fork">
  Use this action to create a fork of a repository for the authenticated user. (deprecated: use create a fork)
</Accordion>

<Accordion title="Re run a job from a workflow run">
  Use this action to re-run a specific job and its dependent jobs from a workflow run.
</Accordion>

<Accordion title="Re run a workflow">
  Use this action to re-run a specific workflow run using its id.
</Accordion>

<Accordion title="Review pending deployments for a workflow run">
  Use this action to approve or reject pending deployments that require reviewer approval for a workflow run.
</Accordion>

<Accordion title="Search commits">
  Use this action to search for commits across github repositories using search criteria.
</Accordion>

<Accordion title="Revoke an installation access token">
  Use this action to revoke an installation access token, making it invalid for authentication.
</Accordion>

<Accordion title="Re run failed jobs from a workflow run">
  Use this action to re-run failed jobs and their dependent jobs from a specific workflow run.
</Accordion>

<Accordion title="Remove selected repository from an organization variable">
  Use this action to remove a repository's access to an organization variable that has visibility set to 'selected'.
</Accordion>

<Accordion title="Remove team member legacy">
  Use this action to remove a user from a team using the legacy api endpoint. note: this is a deprecated endpoint.
</Accordion>

<Accordion title="Search code">
  Use this action to search for code across github repositories. the search can be performed on file contents and paths, with results limited to the default branch and files under 384kb.
</Accordion>

<Accordion title="Search issues and pull requests">
  Use this action to search for issues and pull requests on github using keywords and filters.
</Accordion>

<Accordion title="Search topics">
  Use this action to search for github topics based on specified criteria.
</Accordion>

<Accordion title="Remove users from codespaces access for an organization">
  Use this action to remove specified users from having their codespaces billed to the organization.
</Accordion>

<Accordion title="Search users">
  Use this action to search for github users based on various criteria like username, email, location, or number of repositories.
</Accordion>

<Accordion title="List repositories for the authenticated user">
  Use this action to list all repositories owned by or accessible to the authenticated user (deprecated - use list repositories for the authenticated user instead).
</Accordion>

<Accordion title="Remove a selected repository from a user secret">
  Use this action to remove a repository's access to a user's codespace secret.
</Accordion>

<Accordion title="Set allowed actions and reusable workflows for a repository">
  Use this action to configure which github actions and reusable workflows are allowed to run in a repository.
</Accordion>

<Accordion title="Set custom labels for a self hosted runner for a repository">
  Use this action to set new custom labels for a self-hosted runner in a repository.
</Accordion>

<Accordion title="Remove users from the copilot subscription for an organization">
  Use this action to remove specified users from an organization's github copilot subscription.
</Accordion>

<Accordion title="Set a repository subscription">
  Use this action to manage repository notifications by enabling, ignoring, or stopping watch status.
</Accordion>

<Accordion title="Create a repository for the authenticated user">
  Creates a new repository for the authenticated user. oauth app tokens and personal access tokens (classic) need the `public repo` or `repo` scope to create a public repository, and `repo` scope to create a private repository.\<\<DEPRECATED use create\_a\_repository\_for\_the\_authenticated\_user>>
</Accordion>

<Accordion title="Set default workflow permissions for an organization">
  Use this action to set the default workflow permissions for the github token and configure pull request review approval settings for an organization.
</Accordion>

<Accordion title="Set allowed actions and reusable workflows for an organization">
  Use this action to configure which github actions and reusable workflows are allowed to run in an organization.
</Accordion>

<Accordion title="Search labels">
  Use this action to search for labels in a repository by keywords in their names or descriptions.
</Accordion>

<Accordion title="List global security advisories">
  The text describes how to find global security advisories with specific parameters. by default, it excludes malware advisories, which can be included by setting the `type` parameter to `malware`. more on advisory types at github docs.\<\<DEPRECATED use list\_global\_security\_advisories>>
</Accordion>

<Accordion title="Set custom labels for a self hosted runner for an organization">
  Use this action to set or update custom labels for a specific self-hosted runner in an organization.
</Accordion>

<Accordion title="Remove outside collaborator from an organization">
  Use this action to remove an outside collaborator from an organization. this will remove their access from all organization repositories.
</Accordion>

<Accordion title="Set github actions permissions for an organization">
  Use this action to set github actions permissions policy for an organization, including which repositories can run actions and which actions are allowed.
</Accordion>

<Accordion title="Github Remove Public Org Membership">
  Use this action to remove the authenticated user's public membership from an organization.
</Accordion>

<Accordion title="Remove user access restrictions">
  Use this action to remove user access restrictions from a protected branch.
</Accordion>

<Accordion title="Set default workflow permissions for a repository">
  Use this action to set default permissions for the github token and control whether github actions can approve pull requests in a repository.
</Accordion>

<Accordion title="List organization repositories">
  Lists repositories for an organization. viewing `security and analysis` requires admin permissions for the repository or being an organization owner or security manager. more info on managing security managers available.\<\<DEPRECATED use list\_organization\_repositories>>
</Accordion>

<Accordion title="Set interaction restrictions for an organization">
  Use this action to set temporary interaction restrictions for public repositories in an organization, limiting who can interact with the repositories.
</Accordion>

<Accordion title="Set github actions permissions for a repository">
  Sets the github actions permissions policy for enabling github actions and allowed actions and reusable workflows in the repository. oauth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
</Accordion>

<Accordion title="Github Remove Custom Labels From Self Hosted Repository Runner">
  Use this action to remove all custom labels from a self-hosted runner in a repository.
</Accordion>

<Accordion title="Set labels for an issue">
  Use this action to replace all existing labels on an issue with a new set of labels.
</Accordion>

<Accordion title="Set interaction restrictions for your public repositories">
  Temporarily restricts which type of github user can interact with your public repositories. setting the interaction limit at the user level will overwrite any interaction limits that are set for individual repositories owned by the user.
</Accordion>

<Accordion title="Search repositories">
  Use this action to search for repositories on github using keywords and qualifiers.
</Accordion>

<Accordion title="Set organization membership for a user">
  Use this action to add a user to an organization or update their role within it. the role can be either 'admin' (organization owner) or 'member'.
</Accordion>

<Accordion title="Set interaction restrictions for a repository">
  Use this action to set interaction restrictions for a repository, limiting who can comment, open issues, or create pull requests.
</Accordion>

<Accordion title="Remove user as a collaborator">
  Use this action to remove a user as a collaborator from an organization project.
</Accordion>

<Accordion title="Github Remove Repo From Org Dev Env Secret">
  Use this action to remove a repository from an organization's development environment secret.
</Accordion>

<Accordion title="Set a thread subscription">
  Use this action to set notification preferences for a repository thread. you can ignore (mute notifications), subscribe (receive notifications), or unsubscribe (stop notifications) from a thread.
</Accordion>

<Accordion title="Github Remove Custom Label From Repo Runner">
  Use this action to remove a custom label from a self-hosted runner in a repository.
</Accordion>

<Accordion title="Set public organization membership for the authenticated user">
  Use this action to make an organization membership public for the authenticated user.
</Accordion>

<Accordion title="List repositories for a user">
  Lists public repositories for the specified user.\<\<DEPRECATED use list\_repositories\_for\_a\_user>>
</Accordion>

<Accordion title="Rename a branch">
  Use this action to rename a branch in a repository.
</Accordion>

<Accordion title="Set primary email visibility for the authenticated user">
  Use this action to set whether your primary email address is public or private.
</Accordion>

<Accordion title="Get the weekly commit activity">
  Use this action to get weekly statistics about additions and deletions in a repository. note: only works for repositories with fewer than 10,000 commits. deprecated: use get the weekly commit activity instead.
</Accordion>

<Accordion title="Search repositories">
  Search for github repositories by criteria, returning up to 100 results per page. search includes text match metadata for names and descriptions. example: find popular tetris repositories in assembly, sorted by stars.\<\<DEPRECATED use search\_repositories>>
</Accordion>

<Accordion title="Create an organization repository">
  A new repository can be created in a specific organization by a member. oauth and personal access tokens require `public repo` or `repo` scope for public, and `repo` scope for private repositories.\<\<DEPRECATED use create\_an\_organization\_repository>>
</Accordion>

<Accordion title="Restore package version for a user">
  Use this action to restore a previously deleted package version for a user. the package can be restored within 30 days of deletion if the namespace and version are still available.
</Accordion>

<Accordion title="Restore a package version for the authenticated user">
  Use this action to restore a previously deleted package version for the authenticated user. the package version can be restored within 30 days of deletion.
</Accordion>

<Accordion title="Restore package version for an organization">
  Use this action to restore a deleted package version for an organization within 30 days of deletion.
</Accordion>

<Accordion title="Github Retrieve Repo Public Key For Encryption">
  Use this action to get the public key needed for encrypting secrets in a repository.
</Accordion>

<Accordion title="Request a github pages build">
  Use this action to request a new github pages build for a repository.
</Accordion>

<Accordion title="Get a commit">
  Use this action to get details of a specific commit in a repository. (deprecated: use get a commit)
</Accordion>

<Accordion title="Request a cve for a repository security advisory">
  Use this action to request a cve (common vulnerabilities and exposures) number for a repository security advisory.
</Accordion>

<Accordion title="Create or update file contents">
  This endpoint creates or replaces a file in a repository but cannot be used concurrently with the "delete a file" endpoint to avoid errors. it requires `repo` and, for modifying `.github/workflows`, `workflow` scopes in oauth or personal access tokens.\<\<DEPRECATED use create\_or\_update\_file\_contents>>
</Accordion>

<Accordion title="Set selected repositories for an organization secret">
  Use this action to specify which repositories have access to an organization secret.
</Accordion>

<Accordion title="Set selected repositories for an organization variable">
  Use this action to specify which repositories can access an organization variable. note that the variable's visibility must be set to 'selected'.
</Accordion>

<Accordion title="Set selected repositories for a user secret">
  Use this action to specify which repositories can access a user's development environment secret.
</Accordion>

<Accordion title="Update a project">
  Updates a project board's information. returns a `404 not found` status if projects are disabled. if you do not have sufficient privileges to perform this action, a `401 unauthorized` or `410 gone` status is returned.
</Accordion>

<Accordion title="Update a milestone">
  Use this action to update a milestone in a repository by its number.
</Accordion>

<Accordion title="Unlock a user repository">
  Use this action to unlock a repository after a user migration is complete. this allows the repository to be used or deleted. note: if the repository is not locked, this action will return a 404 error.
</Accordion>

<Accordion title="Stop a codespace for an organization user">
  Use this action to stop a codespace belonging to a user in an organization.
</Accordion>

<Accordion title="Update a label">
  Use this action to update the name, color, or description of a label in a repository.
</Accordion>

<Accordion title="Set the level of access for workflows outside of the repository">
  Use this action to set the access level for external workflows to access actions and reusable workflows in a repository.
</Accordion>

<Accordion title="Update a dependabot alert">
  Use this action to update the state of a dependabot alert in a repository.
</Accordion>

<Accordion title="Update an organization membership for the authenticated user">
  Use this action to accept a pending invitation to join an organization.
</Accordion>

<Accordion title="Set team access restrictions">
  Use this action to set which teams have push access to a protected branch. this will replace all existing team access permissions.
</Accordion>

<Accordion title="Set status check contexts">
  Use this action to set the required status check contexts for a protected branch in a repository.
</Accordion>

<Accordion title="Stop a codespace for the authenticated user">
  Use this action to stop a codespace for the authenticated user.
</Accordion>

<Accordion title="Update a pull request">
  Use this action to update a pull request's title, body, state, target branch, or maintainer modification permission.
</Accordion>

<Accordion title="Star a repository for the authenticated user">
  Use this action to star a repository as the authenticated user
</Accordion>

<Accordion title="Unstar a gist">
  Use this action to remove a star from a gist.
</Accordion>

<Accordion title="Update a repository invitation">
  Use this action to update the permissions of a repository invitation for a user.
</Accordion>

<Accordion title="Submit a review for a pull request">
  Use this action to submit a review for a pull request. the review can be an approval, request for changes, or a comment.
</Accordion>

<Accordion title="Update a deployment branch policy">
  Use this action to update the branch or tag policy for a deployment environment.
</Accordion>

<Accordion title="Update a repository ruleset">
  Use this action to modify an existing ruleset's configuration for a repository, including its name, target, enforcement level, and rules.
</Accordion>

<Accordion title="Sync a fork branch with the upstream repository">
  Use this action to synchronize a branch in a forked repository with its upstream repository.
</Accordion>

<Accordion title="Unstar a repository for the authenticated user">
  Use this action to remove a star from a repository for the authenticated user.
</Accordion>

<Accordion title="Update a pull request branch">
  Use this action to update a pull request branch by merging the latest changes from the base branch.
</Accordion>

<Accordion title="Update a repository security advisory">
  Use this action to update a repository security advisory using its ghsa id.
</Accordion>

<Accordion title="Update a repository variable">
  Use this action to update a github actions variable in a repository. requires collaborator access or oauth/pat with 'repo' scope.
</Accordion>

<Accordion title="Update a review comment for a pull request">
  Use this action to update a review comment on a pull request.
</Accordion>

<Accordion title="Test the push repository webhook">
  Use this action to test a repository webhook by triggering a push event. the webhook must be subscribed to push events. if not subscribed, returns 204 without sending a test post.
</Accordion>

<Accordion title="Update an environment variable">
  To create, update, or read environment variables in a github actions workflow, authenticated collaborators need `repo` scope on oauth or classic tokens.
</Accordion>

<Accordion title="Update a review for a pull request">
  Use this action to update the body text of an existing pull request review.
</Accordion>

<Accordion title="Update a repository webhook">
  Use this action to modify an existing webhook in a repository. you can update the webhook's url, events it listens to, and its active status.
</Accordion>

<Accordion title="Update a team">
  Use this action to update a team's settings in an organization. you can modify the team's name, description, privacy settings, notification settings, and parent team.
</Accordion>

<Accordion title="Update a discussion">
  Use this action to edit the title and body of a team discussion in an organization.
</Accordion>

<Accordion title="Update a secret scanning alert">
  Use this action to update the status of a secret scanning alert in a repository.
</Accordion>

<Accordion title="Transfer a repository">
  Use this action to transfer a repository to another user or organization.
</Accordion>

<Accordion title="Set user access restrictions">
  Use this action to set a list of users who can push to a protected branch. this will replace any existing user push access permissions.
</Accordion>

<Accordion title="Update an existing project card">
  Use this action to update a project card's note content or archive status.
</Accordion>

<Accordion title="Update a team legacy">
  Use this action to update a team using the legacy teams api endpoint. this is a deprecated endpoint.
</Accordion>

<Accordion title="Update a discussion comment">
  This text outlines how to edit discussion comments, specifying teams with `org id` and `team id`. it requires `write:discussion` scope for oauth and classic personal access tokens.
</Accordion>

<Accordion title="Update a reference">
  Use this action to update a git reference (branch, tag, etc.) to point to a new commit sha.
</Accordion>

<Accordion title="Update an existing project column">
  Use this action to update the name of an existing project column in a github repository.
</Accordion>

<Accordion title="Update branch protection">
  Use this action to update branch protection rules for a repository branch.
</Accordion>

<Accordion title="Github Update Resource Access With Tokens">
  Use this action to revoke access to organization resources for specified fine-grained personal access tokens. only github apps can use this action.
</Accordion>

<Accordion title="Update a webhook configuration for an organization">
  Use this action to update the configuration of an organization's webhook, including url, content type, secret, and ssl settings.
</Accordion>

<Accordion title="Update status check protection">
  Use this action to update the status check protection rules for a branch in a repository.
</Accordion>

<Accordion title="Update information about a github pages site">
  Use this action to update the configuration of a github pages site for a repository, including custom domain, https settings, and build settings.
</Accordion>

<Accordion title="Update the authenticated user">
  Use this action to update the profile information of the authenticated github user. note that private email addresses remain private even if included in the update.
</Accordion>

<Accordion title="Update git lfs preference">
  Use this action to update git lfs (large file storage) preferences for importing repositories.
</Accordion>

<Accordion title="Update a webhook configuration for a repository">
  Use this action to update the configuration of a webhook for a repository, including url, content type, and ssl settings.
</Accordion>

<Accordion title="Start an import">
  Use this action to start importing a repository from another version control system (like svn or mercurial) to github. note: this feature will be deprecated on april 12, 2024.
</Accordion>

<Accordion title="Github Update Token Org Access">
  Use this action to revoke a fine-grained personal access token's access to organization resources. only github apps can use this action.
</Accordion>

<Accordion title="Update a discussion comment legacy">
  Use this action to update a comment in a team discussion using the legacy api endpoint. note: this is a deprecated endpoint.
</Accordion>

<Accordion title="Update an import">
  Use this action to update an import with credentials or restart an import. for multi-project servers, you can specify the project to import.
</Accordion>

<Accordion title="Update a release">
  Use this action to update an existing release in a repository.
</Accordion>

<Accordion title="Get the authenticated user">
  \[deprecated] use get the authenticated user action instead.
</Accordion>

<Accordion title="Get a user">
  Use this action to get information about a github user by their username. (deprecated: use get a user)
</Accordion>

<Accordion title="Upload an analysis as sarif data">
  Use this action to upload sarif data for code scanning analysis to a repository.
</Accordion>

<Accordion title="Get contextual information for a user">
  Use this action to get contextual information about a github user (deprecated - use get contextual information for a user instead).
</Accordion>

<Accordion title="List email addresses for the authenticated user">
  Lists all of your email addresses, and specifies which one is visible to the public. oauth app tokens and personal access tokens (classic) need the `user:email` scope to use this endpoint.\<\<DEPRECATED use list\_email\_addresses\_for\_the\_authenticated\_user>>
</Accordion>

<Accordion title="Update a release asset">
  Use this action to modify the properties of a release asset in a repository.
</Accordion>

<Accordion title="Update a discussion legacy">
  Use this action to update the title and body of a team discussion (legacy api).
</Accordion>

<Accordion title="Users list public emails for authenticated user">
  Deprecated: use list public email addresses for the authenticated user instead. use this action to retrieve the list of public email addresses for the authenticated user. note: requires oauth app tokens or personal access tokens with 'user:email' scope.
</Accordion>

<Accordion title="List followers of the authenticated user">
  Lists the people following the authenticated user.\<\<DEPRECATED use list\_followers\_of\_the\_authenticated\_user>>
</Accordion>

<Accordion title="Update pull request review protection">
  Use this action to update the pull request review protection settings for a branch in a repository. this includes settings like required reviewers, code owner reviews, and dismissal restrictions.
</Accordion>

<Accordion title="Start an organization migration">
  Initiates the generation of a migration archive.
</Accordion>

<Accordion title="Update a gist">
  Use this action to edit a gist by updating its description or files.
</Accordion>

<Accordion title="Update an issue">
  Issue owners and users with push access can edit issues. the endpoint supports different media types for markdown formatting, including raw, text, html representations, and a combination of all.
</Accordion>

<Accordion title="List social accounts for a user">
  Use this action to list social media accounts linked to a github user. (deprecated: use list social accounts for a user)
</Accordion>

<Accordion title="Github Verify Dev Container Permissions Accepted">
  Use this action to verify if the authenticated user has accepted the permissions required by a devcontainer configuration.
</Accordion>

<Accordion title="Update repository preferences for check suites">
  Use this action to enable or disable automatic creation of check suites when code is pushed to a repository.
</Accordion>

<Accordion title="Update an issue comment">
  Use this action to update the content of a comment on an issue or pull request.
</Accordion>

<Accordion title="Update a gist comment">
  Use this action to update a comment on a gist.
</Accordion>

<Accordion title="Update a repository">
  **note**: to edit a repository's topics, use the [replace all repository topics](https://docs.github.com/rest/repos/repos#replace-all-repository-topics) endpoint.
</Accordion>

<Accordion title="Unfollow a user">
  Use this action to unfollow a github user.
</Accordion>

<Accordion title="Update an organization">
  Use this action to update the settings and properties of an organization. this includes updating organization permissions, repository creation settings, security features, and other organization-wide configurations.
</Accordion>

<Accordion title="Start a codespace for the authenticated user">
  Use this action to start a codespace for the authenticated user.
</Accordion>

<Accordion title="Unblock a user from an organization">
  Use this action to unblock a user from an organization.
</Accordion>

<Accordion title="Unblock a user">
  Use this action to unblock a user that you had previously blocked.
</Accordion>

<Accordion title="Update an organization repository ruleset">
  Use this action to update the configuration of an organization's repository ruleset.
</Accordion>

<Accordion title="Star a gist">
  Use this action to star a github gist.
</Accordion>

<Accordion title="Update a commit comment">
  Use this action to update the content of an existing commit comment in a repository.
</Accordion>

<Accordion title="Update a code scanning default setup configuration">
  Use this action to update the code scanning default setup configuration for a repository.
</Accordion>

<Accordion title="Unlock an organization repository">
  Use this action to unlock a repository that was previously locked for migration in an organization.
</Accordion>

<Accordion title="Unlock an issue">
  Use this action to unlock a locked issue in a repository.
</Accordion>

<Accordion title="Update an organization variable">
  Use this action to update an organization-level variable for github actions workflows.
</Accordion>

<Accordion title="Update an organization webhook">
  Use this action to update an organization's webhook configuration, including its url, events, and secret.
</Accordion>

<Accordion title="Start a user migration">
  Use this action to start a migration of a user's repositories.
</Accordion>

<Accordion title="Update a codespace for the authenticated user">
  Use this action to update a codespace's machine type, display name, and recent folders for the authenticated user. note: changes take effect on next start.
</Accordion>

<Accordion title="Update a custom organization role">
  Use this action to update an existing custom organization role, including its name, description, and permissions.
</Accordion>

<Accordion title="Update a check run">
  Use this action to update an existing check run for a specific commit in a repository.
</Accordion>

<Accordion title="Update a code scanning alert">
  Use this action to update the status of a code scanning alert in a repository.
</Accordion>


# Gmail
Source: https://docs.push.ai/integrations/gmail



Connect to Gmail to send and manage emails.

<Accordion title="Modify Label to Email">
  Modify a label to an email in gmail.
</Accordion>

<Accordion title="Delete Draft">
  Delete an email draft using gmail's api.
</Accordion>

<Accordion title="Create Email Draft">
  Create a draft email using gmail's api.
</Accordion>

<Accordion title="Create Label">
  Action to create a new label in gmail.
</Accordion>

<Accordion title="Delete Message">
  Delete an email message using gmail's api. note: this action requires the integration to have the `https://mail.google.com/` scope.
</Accordion>

<Accordion title="Get Gmail Attachment">
  Get an attachment from a mail.
</Accordion>

<Accordion title="Fetch Message by Thread ID">
  Fetch messages by thread id from gmail with pagination support. to use pagination, you can set the 'pagetoken' in the request to the value of the 'nextpagetoken' in the response of the previous action. the 'nextpagetoken' is returned in the response of this action (i.e 'fetchmessagebythreadid') if there are more results to be fetched. if not provided, the first page of results is returned.
</Accordion>

<Accordion title="Fetch Message by Message ID">
  Fetch messages by message id from gmail.
</Accordion>

<Accordion title="Fetch Emails">
  Action to fetch all emails from gmail.
</Accordion>

<Accordion title="List Threads">
  Action to list threads in gmail. this action returns a list of threads and a page token to retrieve the next page of results. the next page token is returned in the response of this action (i.e 'listthreads') if there are more results to be fetched, which you can use in the 'pagetoken' field of the request to fetch the next page of results. if not available, the last page of results is returned.
</Accordion>

<Accordion title="Modify Thread Labels">
  Action to modify labels of a thread in gmail.
</Accordion>

<Accordion title="Get Contacts">
  Action to get info of contacts saved in google for an authorized account. a custom integration with `https://www.googleapis.com/auth/contacts.readonly` scope is required to use this action.
</Accordion>

<Accordion title="Remove Label">
  Action to remove a label in gmail.
</Accordion>

<Accordion title="Get People">
  Action to get contacts info of people.
</Accordion>

<Accordion title="List Drafts">
  List all email drafts using gmail's api.
</Accordion>

<Accordion title="Reply to Email Thread">
  Action to reply to an email thread in gmail.
</Accordion>

<Accordion title="Get Profile">
  Get the profile of the authenticated user.
</Accordion>

<Accordion title="Search People">
  Provides a list of contacts in the authenticated user's grouped contacts that matches the search query. the query matches on a contact's names, nicknames, emailaddresses, phonenumbers, and organizations fields that are from the contact source. a custom integration with `https://www.googleapis.com/auth/contacts.readonly` scope is required to use this action.
</Accordion>

<Accordion title="List Gmail Labels">
  List all labels in the user's gmail account.
</Accordion>

<Accordion title="Send Email">
  Send an email using gmail's api.
</Accordion>

<Accordion title="Move to Trash">
  Move an email message to trash using gmail's api.
</Accordion>


# Gong
Source: https://docs.push.ai/integrations/gong



Gong is a platform for video meetings, call recording, and team collaboration.

<Accordion title="Add call media  v2 calls id media">
  Adds a call media, recorded by a telephony system (pbx) or other media recording facility. gong accepts call recordings in various audio and video file formats, including wav, mp3, mp4, mkv and flac. if uploading a dual-channel (stereo) file separated by speaker, make sure to specify which channel correspondsto the company team member (rep) in the parties/mediachannelid parameter of the add new call operation. when accessed through a bearer token authorization method, this endpoint requires the scope 'api:calls:create'.
</Accordion>

<Accordion title="List of calls in a specific folder  v2 library folder content">
  Given a folder id, this endpoint retrieves a list of calls in it. when accessed through a bearer token authorization method, this endpoint requires the scope 'api:library:read'.
</Accordion>

<Accordion title="Get generic crm integration details  v2 crm integrations">
  \<style>.public-api-info \{ background: rgb(222, 235, 255);}.public-api-tip \{ background: rgb(227, 252, 239);}.public-api-parameter \{ background: rgba(9,30,66,0.08);}.public-api-note \{ background: rgb(234, 230, 255);}.public-api-important \{ background: rgb(255, 250, 230);}.public-api-critical \{ background: rgb(255, 235, 230);}table, th, td \{ border: 1px solid gray; border-collapse: collapse;}th, td \{ padding: 5px;}th \{ text-align: left;}img \{ border: 2px solid #d3d5d9;}\</style>\<p>returns the crm integration you set up using the \<code>put /v2/crm/integrations\</code> endpoint. you can only have one integration at a time. \</p>\<p>when accessed using a bearer token, this endpoint requires the 'api:crm:integrations:read' scope.\</p>
</Accordion>

<Accordion title="Add new call  v2 calls">
  When using this endpoint, either provide a downloadmediaurl or use the returned callid in a follow-up request to /v2/calls/\{id}/media to upload the media file. when accessed through a bearer token authorization method, this endpoint requires the scope 'api:calls:create'.
</Accordion>

<Accordion title="Delete a gong meeting  v2 meetings">
  When accessed through a bearer token authorization method, this endpoint requires the scope 'api:meetings:user:delete'.
</Accordion>

<Accordion title="Assign prospects to flow">
  Use this endpoint to assign a number of prospects to a flow. prospects can be contacts or leads in your crm. generate a list of comma separated crm ids of the prospects you want to add to a flow. the flowinstanceowneremail parameter is the email address of the gong user who set up the flow instance and owns the flow to-dos. you can assign up to 200 prospects to a flow in a single request. when accessed through a bearer token authorization method, this endpoint requires the scope 'api:flows:write'.
</Accordion>

<Accordion title="Aggregate user activity statistics">
  Lists the activity of multiple users within the gong system during a defined period. given the period, this endpoint returns multiple records, one for each user, with an applicable activity during the period. each record includes statistics about the user's activity. when accessed through a bearer token authorization method, this endpoint requires the scope 'api:stats:user-actions'.
</Accordion>

<Accordion title="Aggregate activity by period via api">
  Lists the aggregated activity of multiple users within the gong system for each time period within the defined date range. this endpoint returns multiple records, one for each user. for each user there are items for every time period in the date range, including statistics about the user's activity. records are returned only for users with activity in the range. when accessed through a bearer token authorization method, this endpoint requires the scope 'api:stats:user-actions'.
</Accordion>

<Accordion title="Delete users from call access list">
  Remove individual user access from calls. the request can only remove access previously given by the /v2/calls/users-access api. if a given user does not have access to the call, they will be unaffected. if a given user does have access to the call, but not through the pubic api (for example if the call was shared with the user), the user's access will remain unchanged. when accessed through a bearer token authorization method, this endpoint requires the scope 'api:call-user-access:write'.
</Accordion>

<Accordion title="List schema fields  v2 crm entity schema">
  Retrieves the comprehensive schema of crm entities in the gong platform. this endpoint provides detailed metadata about the structure, attributes, and relationships of entities within the customer relationship management (crm) system. it is particularly useful for developers integrating with gong's api who need to understand the data model of the crm entities. the endpoint returns a complete view of all crm entity schemas, which can be used for data mapping, validation, or building dynamic forms. note that this endpoint does not accept any parameters, meaning it returns the full schema without filtering options. while powerful, be mindful of potential performance implications when dealing with large, complex crm structures.
</Accordion>

<Accordion title="Erase data for email address">
  Given an email address, this endpoint deletes from the gong system any calls or email messages that reference this address. email messages sent to or from the address are deleted. calls where the email address appears (as a lead, contact, attendee or speaker) are deleted. leads or contacts with the email address are deleted. the deletion is not immediate, and may take several hours to complete. this endpoint contains a data integrity protection mechanism to prevent the deletion of an abnormal number of objects. if the deletion fails please contact support at [help@gong.io](mailto:help@gong.io) delete the data from your crm and email system before performing this operation so that private data is not re-imported into gong. when accessed through a bearer token authorization method, this endpoint requires the scope 'api:data-privacy:delete'.
</Accordion>

<Accordion title="Manage user call access">
  Returns a list of users who have received individual access to calls through the api. this endpoint doesn't cover user that have access for other reasons (such as sharing recipients, or access through permission profiles). when accessed through a bearer token authorization method, this endpoint requires the scope 'api:call-user-access:read'.
</Accordion>

<Accordion title="Retrieve data privacy info for email address">
  Shows the elements in the gong system that reference the given email address. given an emails address, this endpoint returns details of all calls and email messages that reference this address, and any leads or contacts with this email address. when accessed through a bearer token authorization method, this endpoint requires the scope 'api:data-privacy:read'.
</Accordion>

<Accordion title="Retrieve user settings history  v2 users id settings history">
  Retrieve a specific user's settings history. when accessed through a bearer token authorization method, this endpoint requires the scope 'api:users:read'.
</Accordion>

<Accordion title="Post a digital interaction  v2 digital interaction">
  When accessed through a bearer token authorization method, this endpoint requires the scope 'api:digital-interactions:write'.
</Accordion>

<Accordion title="Update a gong meeting  v2 meetings meetingid">
  When accessed through a bearer token authorization method, this endpoint requires the scope 'api:meetings:user:update'.
</Accordion>

<Accordion title="Retrieve users from permission profile">
  Returns a list of all users whose access is controlled by the given permission profile. when accessed through a bearer token authorization method, this endpoint requires the scope 'api:users:read'.
</Accordion>

<Accordion title="Retrieve library folders  v2 library folders">
  Use this endpoint to retrieve a list of public library folders. we do not allow retrieval of either private or archived folders. when accessed through a bearer token authorization method, this endpoint requires the scope 'api:library:read'.
</Accordion>

<Accordion title="Create activity scorecards report">
  Retrieve all the answers for the scorecards that were reviewed during a specified date range, for calls that took place during a specified date range, for specific scorecards or for specific reviewed users. when accessed through a bearer token authorization method, this endpoint requires the scope 'api:stats:scorecards'.
</Accordion>

<Accordion title="Erase data for phone number">
  Given a phone number, this endpoint deletes from the gong system any leads or contacts with a matching phone number or mobile phone number. email messages sent to or from these leads/contacts are deleted. calls where the leads/contacts appear are deleted. the deletion is not immediate, and may take several hours to complete. this endpoint contains a data integrity protection mechanism to prevent the deletion of an abnormal number of objects. if the deletion fails please contact support at [help@gong.io](mailto:help@gong.io) delete the data from your crm and email system before performing this operation so that private data is not re-imported into gong. when accessed through a bearer token authorization method, this endpoint requires the scope 'api:data-privacy:delete'.
</Accordion>

<Accordion title="Create a new gong meeting  v2 meetings">
  When accessed through a bearer token authorization method, this endpoint requires the scope 'api:meetings:user:create'.
</Accordion>

<Accordion title="Retrieve data for a specific call  v2 calls id">
  Retrieve data for a specific call. when accessed through a bearer token authorization method, this endpoint requires the scope 'api:calls:read:basic'.
</Accordion>

<Accordion title="Retrieve user  v2 users id">
  Retrieve a specific user. when accessed through a bearer token authorization method, this endpoint requires the scope 'api:users:read'.
</Accordion>

<Accordion title="Retrieve logs data by type and time range  v2 logs">
  List log entries that took place during a specified time range. when accessed through a bearer token authorization method, this endpoint requires the scope 'api:logs:read'.
</Accordion>

<Accordion title="Retrieve manual crm call associations">
  Returns a list of all calls that were manually associated or re-associated with crm account and deal/opportunity since a given time. actions will be listed in the ascending order of their timing. notice if a call was associated and later re-associated the api will return both events. when accessed through a bearer token authorization method, this endpoint requires the scope 'api:crm-calls:manual-association:read'.
</Accordion>

<Accordion title="Upload crm objects  v2 crm entities">
  Uploads crm data files to the gong platform for integration and analysis. this endpoint allows users to send large crm data files (up to 200mb) using a multipart/form-data request. it should be used when integrating crm systems with gong's revenue intelligence platform to provide up-to-date customer interaction data. the endpoint is specifically designed for file uploads and does not support other operations like querying or modifying existing data. ensure that the uploaded file contains properly structured crm data compatible with gong's system for successful integration and subsequent analysis.
</Accordion>

<Accordion title="Get permission profile">
  Returns a permission profile.
</Accordion>

<Accordion title="List users by filter  v2 users extensive">
  List multiple users. when accessed through a bearer token authorization method, this endpoint requires the scope 'api:users:read'.
</Accordion>

<Accordion title="Update shared content event">
  Push engagement events into gong and display them as events in gong’s activity timeline, when a gong user shares content with external participants (for example, a contract was “shared” by the account executive with his prospects) when accessed through a bearer token authorization method, this endpoint requires the scope 'api:engagement-data:write'.
</Accordion>

<Accordion title="Get request status  v2 crm request status">
  The getcrmrequeststatus endpoint retrieves the current status of crm integration requests in the gong platform. it allows users to check the progress and outcome of operations related to crm data uploads, synchronization, or other crm-related processes. this endpoint is particularly useful for monitoring the health and progress of crm integrations, troubleshooting issues, and ensuring data consistency between gong and connected crm systems. it should be used when you need to verify if a crm integration request has been completed, is still in progress, or has encountered any errors. the endpoint does not modify any data and is intended for status checking only. note that the specific details returned may vary depending on the type and complexity of the crm integration request being queried.
</Accordion>

<Accordion title="Retrieve filtered call details">
  Lists detailed call data for calls that took place during a specified date range, have specified call ids or hosted by specified users. when accessed through a bearer token authorization method, this endpoint requires the scope 'api:calls:read:extensive'. moreover, clients requesting media download urls by the contentselector.exposedfields.media field should also have the scope 'api:calls:read:media-url'.
</Accordion>

<Accordion title="Give individual users access to calls  v2 calls users access">
  Give individual users access to calls. if a user already has access (perhaps the call was shared with them, or they have access through their permission profiles) the request will have no effect. when accessed through a bearer token authorization method, this endpoint requires the scope 'api:call-user-access:write'.
</Accordion>

<Accordion title="Fetch all permission profiles">
  Returns a list of all permission profiles. the listing is in the alphabetical order of the profile names.
</Accordion>

<Accordion title="Retrieve scorecards details  v2 settings scorecards">
  Retrieve all the scorecards within the gong system. when accessed through a bearer token authorization method, this endpoint requires the scope 'api:settings:scorecards:read'.
</Accordion>

<Accordion title="Get crm objects  v2 crm entities">
  Retrieves crm entities from the gong platform. this endpoint allows users to fetch various crm objects such as accounts, deals, and contacts that have been integrated with gong's revenue intelligence system. it provides a way to access and utilize crm data within the context of gong's conversation analysis and insights. use this endpoint when you need to synchronize crm data with gong or when you want to retrieve the latest crm entity information for analysis or reporting purposes. the endpoint does not modify any data and is intended for read-only operations. note that the specific fields and structure of the returned entities may vary based on the crm system integrated with gong.
</Accordion>

<Accordion title="List all coaching metrics  v2 coaching">
  List all of the coaching metrics of a manager. when accessed through a bearer token authorization method, this endpoint requires the scope 'api:coaching:read'.
</Accordion>

<Accordion title="Register a generic crm integration  v2 crm integrations">
  Updates an existing crm integration in the gong platform. this endpoint allows you to modify the details of a previously set up integration between gong and your customer relationship management (crm) system. it's primarily used for changing the integration's name or reassigning the ownership to a different team member. this operation is crucial for maintaining accurate and up-to-date integration configurations, especially when there are changes in your organization's structure or integration strategies. note that this endpoint only updates the integration metadata and does not affect the actual data synchronization between gong and your crm.
</Accordion>

<Accordion title="List flows for crm prospects">
  Get the gong engage flows assigned to the given prospects. when accessed through a bearer token authorization method, this endpoint requires the scope 'api:flows:read'.
</Accordion>

<Accordion title="Integration settings  v2 integration settings">
  When accessed through a bearer token authorization method, this endpoint requires the scope 'api:integration-settings:write'.
</Accordion>

<Accordion title="List all company workspaces  v2 workspaces">
  Returns a list of all workspaces including their details. when accessed through a bearer token authorization method, this endpoint requires the scope 'api:workspaces:read'.
</Accordion>

<Accordion title="Delete a generic crm integration  v2 crm integrations">
  Deletes an existing crm integration from the gong platform. this endpoint should be used when you want to disconnect or remove a previously established integration between gong and a crm system, such as hubspot. it's particularly useful when you need to change crm providers, stop syncing data between gong and a specific crm, or troubleshoot integration issues by removing and re-adding the connection. the deletion is likely permanent, so use this endpoint with caution. it's important to note that this operation may affect data synchronization and potentially impact existing analytics or reports that rely on the integrated crm data.
</Accordion>

<Accordion title="Retrieve tracker details  v2 settings trackers">
  Retrieves details of all keyword trackers in the system or in a given workspace. when accessed through a bearer token authorization method, this endpoint requires the 'api:settings:trackers:read' scope.
</Accordion>

<Accordion title="Report event of a custom action  v2 customer engagement action">
  Push engagement events into gong and display them as events in gong’s activity timeline, when a content is engaged by an external participant (for example, a contract was “signed” by the prospect) when accessed through a bearer token authorization method, this endpoint requires the scope 'api:engagement-data:write'.
</Accordion>

<Accordion title="List gong engage flows  v2 flows">
  Engage flows have the following visibility types: \* company: visible to everyone in the company, can only be edited by users with edit permissions. \* personal: reps can set up their own flows which are only available to them. \* shared: reps can share a flow with other reps. those reps can then add leads to the flow. this endpoint returns all company flows, together with personal flows and flows shared with the user specified in the flowemailowner parameter. when accessed through a bearer token authorization method, use the 'api:flows:read' scope.
</Accordion>

<Accordion title="List all users  v2 users">
  List all of the company's users. when accessed through a bearer token authorization method, this endpoint requires the scope 'api:users:read'.
</Accordion>

<Accordion title="Create permission profile  v2 permission profile">
  Create a permission profile in a given workspace.
</Accordion>

<Accordion title="Post interaction filter stats">
  Returns interaction stats for users based on calls that have whisper turned on. when accessed through a bearer token authorization method, this endpoint requires the scope 'api:stats:interaction'.
</Accordion>

<Accordion title="Data privacy for phone number">
  Shows the elements in the gong system that reference the given phone number. given a phone number, this endpoint returns details of any leads or contacts with this phone number and their associated calls and email messages. when accessed through a bearer token authorization method, this endpoint requires the scope 'api:data-privacy:read'.
</Accordion>

<Accordion title="Report content viewed event">
  Push engagement events into gong and display them as events in gong’s activity timeline, when a content is viewed by an external participant (for example, a contract was “viewed” by the prospect) when accessed through a bearer token authorization method, this endpoint requires the scope 'api:engagement-data:write'.
</Accordion>

<Accordion title="Update permission profile  v2 permission profile">
  Update a permission profile.
</Accordion>

<Accordion title="Post meeting integration status">
  When accessed through a bearer token authorization method, this endpoint requires the scope 'api:meetings:integration:status'.
</Accordion>

<Accordion title="Retrieve transcripts of calls  v2 calls transcript">
  Returns transcripts for calls that took place during the specified date period. if call ids are specified, only transcripts for calls with those ids that took place during the time period are returned. when accessed through a bearer token authorization method, this endpoint requires the scope 'api:calls:read:transcript'.
</Accordion>

<Accordion title="Retrieve call data by date range  v2 calls">
  List calls that took place during a specified date range. when accessed through a bearer token authorization method, this endpoint requires the scope 'api:calls:read:basic'.
</Accordion>

<Accordion title="Post day by day activity stats">
  Retrieve the daily activity of multiple users within the gong system for a range of dates. this endpoint returns records including statistics about each user's activity, on the daily level. records are returned only for users with activity in the range. when accessed through a bearer token authorization method, this endpoint requires the scope 'api:stats:user-actions:detailed'.
</Accordion>


# Google maps
Source: https://docs.push.ai/integrations/google_maps



Google Maps is a web mapping platform and consumer application offering satellite imagery,
aerial photography, street maps, 360° interactive panoramic views of streets, real-time
traffic conditions, and route planning for traveling by foot, car, bike, air and public
transportation.

<Accordion title="Get Directions">
  Requires: valid google maps api key gets directions between locations using google maps directions api. this action provides detailed directions between two points, including: - turn-by-turn navigation steps - distance and duration for each step - alternative routes when available - support for waypoints - different travel modes examples: `python # basic direction request request = getdirectionrequest( origin="disneyland", destination="universal studios hollywood" ) # complex route with waypoints and preferences request = getdirectionrequest( origin="los angeles airport", destination="santa monica pier", waypoints="venice beach,getty center", mode="driving", avoid="highways", units="metric" ) `
</Accordion>

<Accordion title="Nearby Search">
  Searches for places near a specified location using google maps places api.
</Accordion>

<Accordion title="Get Route">
  Computes routes between two points using google maps routes api. this action calculates routes between two locations, taking into account: - real-time traffic conditions (when routingpreference is traffic aware) - route preferences (avoiding tolls, highways, ferries) - alternative routes (when computealternativeroutes is true) - different travel modes (driving, walking, cycling, etc.) the response includes details like: - total distance in meters - estimated duration - encoded polyline for route visualization
</Accordion>

<Accordion title="Text Search">
  Searches for places using a text query in google maps places api.
</Accordion>


# Googleads
Source: https://docs.push.ai/integrations/googleads



Connect to Google Ads to manage and create campaigns.

<Accordion title="Get customer lists">
  Getcustomerlists tool will list all customer lists in google ads.
</Accordion>

<Accordion title="Create customer list">
  Createcustomerlist tool will create a customer list in google ads.
</Accordion>

<Accordion title="Add or remove to customer list">
  Addorremovetocustomerlist tool will add a contact to a customer list in google ads. note: it takes 6 to 12 hours for changes to be reflected in the customer list.
</Accordion>

<Accordion title="Get Campaign By Id">
  Getcampaignbyid tool will return details of a campaign in google ads.
</Accordion>


# Googlebigquery
Source: https://docs.push.ai/integrations/googlebigquery



Connect to BigQuery to query BigData.

<Accordion title="Googlebigquery Query">
  Query tool will run a sql query in bigquery. note: make sure the query being input in a single line format. for example, select \* from sample dataset.sample table where column name = 'value'
</Accordion>


# Googlecalendar
Source: https://docs.push.ai/integrations/googlecalendar



Google Calendar is a time-management and scheduling calendar service developed by Google.

<Accordion title="Delete Event">
  Delete an event from a google calendar.
</Accordion>

<Accordion title="Duplicate Calendar">
  Action to duplicate a google calendar based on the provided summary. the duplicated calendar can be used similarly to manage other goals.
</Accordion>

<Accordion title="Quick Add Event">
  Create a new event in a google calendar based on a simple text string like 'appointment at somewhere on june 3rd 10am-10:25am' you can only give title and timeslot here. no recurring meetings and no attendee can be added here. this is not a preferred endpoint. only use this if no other endpoint is possible.
</Accordion>

<Accordion title="Patch Calendar">
  Action to update a google calendar based on the provided calendar id and other required and optional parameters. note that 'summary' is a mandatory parameter. use googlecalendar list calendars action to get the list of calendars and their ids.
</Accordion>

<Accordion title="Find Free Slots">
  Find free slots in a google calendar based on for a specific time period.
</Accordion>

<Accordion title="Find Event">
  Find events in a google calendar based on a search query.
</Accordion>

<Accordion title="Fetch Google Calendar">
  Action to fetch a calendar based on the provided calendar id.
</Accordion>

<Accordion title="Remove Attendee from Event">
  Remove an attendee from an existing event in a google calendar.
</Accordion>

<Accordion title="Create Event">
  Create a new event in a google calendar.
</Accordion>

<Accordion title="Update Google Event">
  Update an existing event in a google calendar.
</Accordion>

<Accordion title="Get Current Date and Time">
  Action to get the current date and time of a specified timezone, given its utc offset value.
</Accordion>

<Accordion title="List Google Calendars">
  Action to list all google calendars from the user's calendar list with pagination.
</Accordion>


# Googledocs
Source: https://docs.push.ai/integrations/googledocs



Connect to Google Docs to perform various document-related actions.

<Accordion title="Create Document">
  Creates a new google docs document with an optional title and text.
</Accordion>

<Accordion title="Create Document Markdown">
  Creates a new google docs document with an optional title and text.
</Accordion>

<Accordion title="Update Existing Document">
  Updates an existing google docs document with the provided edits.
</Accordion>

<Accordion title="Get Or Create Document By Id">
  Finds or creates a specific document.
</Accordion>

<Accordion title="Update Document Markdown">
  Updates an existing google docs document created using markdown with the new markdown text.
</Accordion>


# Googledrive
Source: https://docs.push.ai/integrations/googledrive



Connect to Google Drive!

<Accordion title="Create Folder">
  Create a new folder in google drive. if parent id is provided, it must be a valid google drive folder id. the folder will be created in the root directory if no parent id is specified.
</Accordion>

<Accordion title="Add File Sharing Preference">
  Add file sharing preferences, including domain-level permissions requiring a domain field.
</Accordion>

<Accordion title="Copy File">
  Copy a file
</Accordion>

<Accordion title="Create a File from Text">
  Create a file from text. max 10mb in size.
</Accordion>

<Accordion title="Download a File from Google Drive">
  Download a file.
</Accordion>

<Accordion title="Find Folder">
  Find folder
</Accordion>

<Accordion title="Delete Folder or File">
  Delete folder or file
</Accordion>

<Accordion title="Edit File">
  Edit a file. max 10mb in size.
</Accordion>

<Accordion title="Parse a File from Google Drive">
  Parse a file. max 10mb in size. \<\<DEPRECATED use DOWNLOAD\_FILE>>
</Accordion>

<Accordion title="Upload File">
  Upload a file to google drive. max file size is 5mb.
</Accordion>

<Accordion title="Find Files">
  Find files present in google drive. can be used to search for files by name and content.
</Accordion>


# Googlemeet
Source: https://docs.push.ai/integrations/googlemeet



Google Meet is a video conferencing tool developed by Google.

<Accordion title="Create Meet">
  Create a google meet space!
</Accordion>

<Accordion title="Get Recordings by Conference Record ID">
  Retrieve recordings by conference record id.
</Accordion>

<Accordion title="Get Conference Record by Space Name, Meeting Code, Start Time, End Time">
  Get conference record by space name, meeting code, start time, end time
</Accordion>

<Accordion title="Get Transcripts by Conference Record ID">
  Retrieve transcripts by conference record id.
</Accordion>

<Accordion title="Get Meet Details">
  Retrieve details of a google meet space.
</Accordion>


# Googlephotos
Source: https://docs.push.ai/integrations/googlephotos



Google Photos is a photo and video storage service that is part of the
Google Drive office suite.

<Accordion title="Batch Get Media Items">
  Returns the list of media items for the specified media item identifiers.
</Accordion>

<Accordion title="Add Enrichment">
  Adds an enrichment at a specified position in a defined album.
</Accordion>

<Accordion title="List Albums">
  Lists all albums shown to a user in the albums tab of google photos.
</Accordion>

<Accordion title="Batch Add Media Items">
  Adds one or more media items to an album in google photos.
</Accordion>

<Accordion title="Batch Create Media Items">
  Unified action to upload media files and create them as items in google photos.
</Accordion>

<Accordion title="Create Album">
  Creates a new album in google photos.
</Accordion>

<Accordion title="List Media Items">
  Lists all media items from a user's google photos library.
</Accordion>

<Accordion title="Get Album">
  Returns the album based on the specified albumid.
</Accordion>

<Accordion title="Search Media Items">
  Searches for media items in a user's google photos library.
</Accordion>

<Accordion title="Update Media Item">
  Updates a media item's description in google photos.
</Accordion>

<Accordion title="Upload Media">
  Upload a media file to google photos. supports images (up to 200mb) and videos (up to 20gb).
</Accordion>

<Accordion title="Download Photos Media Item">
  Downloads a media item from google photos and returns it as a file.
</Accordion>


# Googlesheets
Source: https://docs.push.ai/integrations/googlesheets



Google Sheets is a web-based spreadsheet program that is part of the
Google Drive office suite.

<Accordion title="Lookup Spreadsheet Row">
  Lookup a row in a specific spreadsheet by a column and value.
</Accordion>

<Accordion title="Sheet From Json">
  Create a new google sheet from a json object. this action takes a json structure and converts it into a google sheet where: - the first row contains the keys as headers - subsequent rows contain the corresponding values - all rows must have the same structure (keys) args: title (str): the title of the new google sheet sheet name (str): name of the worksheet within the spreadsheet sheet json (list\[dict]): list of dictionaries with consistent keys
</Accordion>

<Accordion title="Batch Get Spreadsheet">
  Perform a batch get on a specific spreadsheet. note: if ranges aren't provided, data from the first sheet will be returned.
</Accordion>

<Accordion title="Batch Update Spreadsheet">
  Perform a batch update operation on a specified google sheets spreadsheet. note: if no first cell location is provided, the values will be appended to the first empty row of the sheet from the top.
</Accordion>

<Accordion title="Clear Spreadsheet Values">
  Clear values from a specified range in a spreadsheet.
</Accordion>

<Accordion title="Get Sheet Names">
  Get all the worksheet names in a spreadsheet. note: use this action to get valid sheet names before using any other action.
</Accordion>

<Accordion title="Create Google Sheet">
  Create a new google sheet.
</Accordion>

<Accordion title="Get Spreadsheet Info">
  Retrieve information about an existing google sheet.
</Accordion>

<Accordion title="Format Cell">
  Apply formatting to a specified range of cells in a google sheets spreadsheet. note: the current implementation incorrectly uses logic for updating cell values. this needs to be refactored.
</Accordion>


# Googlesuper
Source: https://docs.push.ai/integrations/googlesuper



Google Super App combines all Google services including Drive, Calendar, Gmail, Sheets, Analytics, Ads, and more, providing a unified platform for seamless integration and management of your digital life.

<Accordion title="Create Google Sheet">
  Create a new google sheet.
</Accordion>

<Accordion title="Create Meet">
  Create a google meet space!
</Accordion>

<Accordion title="Create Event">
  Create a new event in a google calendar.
</Accordion>

<Accordion title="Create Task List">
  Create a new task list in google tasks.
</Accordion>

<Accordion title="Batch Update Spreadsheet">
  Perform a batch update operation on a specified google sheets spreadsheet. note: if no first cell location is provided, the values will be appended to the first empty row of the sheet from the top.
</Accordion>

<Accordion title="Create Folder">
  Create a new folder in google drive. if parent id is provided, it must be a valid google drive folder id. the folder will be created in the root directory if no parent id is specified.
</Accordion>

<Accordion title="Create Label">
  Action to create a new label in gmail.
</Accordion>

<Accordion title="Create a File from Text">
  Create a file from text. max 10mb in size.
</Accordion>

<Accordion title="Duplicate Calendar">
  Action to duplicate a google calendar based on the provided summary. the duplicated calendar can be used similarly to manage other goals.
</Accordion>

<Accordion title="Format Cell">
  Apply formatting to a specified range of cells in a google sheets spreadsheet. note: the current implementation incorrectly uses logic for updating cell values. this needs to be refactored.
</Accordion>

<Accordion title="Clear Spreadsheet Values">
  Clear values from a specified range in a spreadsheet.
</Accordion>

<Accordion title="Clear Tasks">
  Clear all completed tasks from the specified task list in google tasks.
</Accordion>

<Accordion title="Add Enrichment">
  Adds an enrichment at a specified position in a defined album.
</Accordion>

<Accordion title="Get Contacts">
  Action to get info of contacts saved in google for an authorized account. a custom integration with `https://www.googleapis.com/auth/contacts.readonly` scope is required to use this action.
</Accordion>

<Accordion title="Delete Draft">
  Delete an email draft using gmail's api.
</Accordion>

<Accordion title="Download a File from Google Drive">
  Download a file.
</Accordion>

<Accordion title="Get customer lists">
  Getcustomerlists tool will list all customer lists in google ads.
</Accordion>

<Accordion title="Edit File">
  Edit a file. max 10mb in size.
</Accordion>

<Accordion title="Find Free Slots">
  Find free slots in a google calendar based on for a specific time period.
</Accordion>

<Accordion title="Get Album">
  Returns the album based on the specified albumid.
</Accordion>

<Accordion title="Get Current Date and Time">
  Action to get the current date and time of a specified timezone, given its utc offset value.
</Accordion>

<Accordion title="Get Or Create Document By Id">
  Finds or creates a specific document.
</Accordion>

<Accordion title="Get Gmail Attachment">
  Get an attachment from a mail.
</Accordion>

<Accordion title="Get Directions">
  Requires: valid google maps api key gets directions between locations using google maps directions api. this action provides detailed directions between two points, including: - turn-by-turn navigation steps - distance and duration for each step - alternative routes when available - support for waypoints - different travel modes examples: `python # basic direction request request = getdirectionrequest( origin="disneyland", destination="universal studios hollywood" ) # complex route with waypoints and preferences request = getdirectionrequest( origin="los angeles airport", destination="santa monica pier", waypoints="venice beach,getty center", mode="driving", avoid="highways", units="metric" ) `
</Accordion>

<Accordion title="Download Photos Media Item">
  Downloads a media item from google photos and returns it as a file.
</Accordion>

<Accordion title="Add File Sharing Preference">
  Add file sharing preferences, including domain-level permissions requiring a domain field.
</Accordion>

<Accordion title="Copy File">
  Copy a file
</Accordion>

<Accordion title="Fetch Message by Message ID">
  Fetch messages by message id from gmail.
</Accordion>

<Accordion title="Get Spreadsheet Info">
  Retrieve information about an existing google sheet.
</Accordion>

<Accordion title="Get Meet Details">
  Retrieve details of a google meet space.
</Accordion>

<Accordion title="Fetch Emails">
  Action to fetch all emails from gmail.
</Accordion>

<Accordion title="Get Sheet Names">
  Get all the worksheet names in a spreadsheet. note: use this action to get valid sheet names before using any other action.
</Accordion>

<Accordion title="Get Route">
  Computes routes between two points using google maps routes api. this action calculates routes between two locations, taking into account: - real-time traffic conditions (when routingpreference is traffic aware) - route preferences (avoiding tolls, highways, ferries) - alternative routes (when computealternativeroutes is true) - different travel modes (driving, walking, cycling, etc.) the response includes details like: - total distance in meters - estimated duration - encoded polyline for route visualization
</Accordion>

<Accordion title="Get Task">
  Retrieve the specified task from the task list in google tasks.
</Accordion>

<Accordion title="Fetch Google Calendar">
  Action to fetch a calendar based on the provided calendar id.
</Accordion>

<Accordion title="Create Album">
  Creates a new album in google photos.
</Accordion>

<Accordion title="Get People">
  Action to get contacts info of people.
</Accordion>

<Accordion title="Get Task List">
  Get a task list in google tasks.
</Accordion>

<Accordion title="Get Transcripts by Conference Record ID">
  Retrieve transcripts by conference record id.
</Accordion>

<Accordion title="Get Campaign By Id">
  Getcampaignbyid tool will return details of a campaign in google ads.
</Accordion>

<Accordion title="Create customer list">
  Createcustomerlist tool will create a customer list in google ads.
</Accordion>

<Accordion title="Modify Label to Email">
  Modify a label to an email in gmail.
</Accordion>

<Accordion title="List Gmail Labels">
  List all labels in the user's gmail account.
</Accordion>

<Accordion title="List Media Items">
  Lists all media items from a user's google photos library.
</Accordion>

<Accordion title="List Google Calendars">
  Action to list all google calendars from the user's calendar list with pagination.
</Accordion>

<Accordion title="Insert Task">
  Create a new task on the specified task list in google tasks.
</Accordion>

<Accordion title="List Albums">
  Lists all albums shown to a user in the albums tab of google photos.
</Accordion>

<Accordion title="Add or remove to customer list">
  Addorremovetocustomerlist tool will add a contact to a customer list in google ads. note: it takes 6 to 12 hours for changes to be reflected in the customer list.
</Accordion>

<Accordion title="Get Profile">
  Get the profile of the authenticated user.
</Accordion>

<Accordion title="List Task Lists">
  List all task lists of an authenticated user in google tasks.
</Accordion>

<Accordion title="Lookup Spreadsheet Row">
  Lookup a row in a specific spreadsheet by a column and value.
</Accordion>

<Accordion title="List Threads">
  Action to list threads in gmail. this action returns a list of threads and a page token to retrieve the next page of results. the next page token is returned in the response of this action (i.e 'listthreads') if there are more results to be fetched, which you can use in the 'pagetoken' field of the request to fetch the next page of results. if not available, the last page of results is returned.
</Accordion>

<Accordion title="Get Conference Record by Space Name, Meeting Code, Start Time, End Time">
  Get conference record by space name, meeting code, start time, end time
</Accordion>

<Accordion title="Move to Trash">
  Move an email message to trash using gmail's api.
</Accordion>

<Accordion title="Fetch Message by Thread ID">
  Fetch messages by thread id from gmail with pagination support. to use pagination, you can set the 'pagetoken' in the request to the value of the 'nextpagetoken' in the response of the previous action. the 'nextpagetoken' is returned in the response of this action (i.e 'fetchmessagebythreadid') if there are more results to be fetched. if not provided, the first page of results is returned.
</Accordion>

<Accordion title="Modify Thread Labels">
  Action to modify labels of a thread in gmail.
</Accordion>

<Accordion title="Batch Add Media Items">
  Adds one or more media items to an album in google photos.
</Accordion>

<Accordion title="Nearby Search">
  Searches for places near a specified location using google maps places api.
</Accordion>

<Accordion title="Get Recordings by Conference Record ID">
  Retrieve recordings by conference record id.
</Accordion>

<Accordion title="List Drafts">
  List all email drafts using gmail's api.
</Accordion>

<Accordion title="List Tasks">
  Retrieve all tasks in the specified task list from google tasks.
</Accordion>

<Accordion title="Find Event">
  Find events in a google calendar based on a search query.
</Accordion>

<Accordion title="Batch Create Media Items">
  Unified action to upload media files and create them as items in google photos.
</Accordion>

<Accordion title="Batch Get Spreadsheet">
  Perform a batch get on a specific spreadsheet. note: if ranges aren't provided, data from the first sheet will be returned.
</Accordion>

<Accordion title="Create Document">
  Creates a new google docs document with an optional title and text.
</Accordion>

<Accordion title="Create Document Markdown">
  Creates a new google docs document with an optional title and text.
</Accordion>

<Accordion title="Batch Get Media Items">
  Returns the list of media items for the specified media item identifiers.
</Accordion>

<Accordion title="Delete Event">
  Delete an event from a google calendar.
</Accordion>

<Accordion title="Delete Task">
  Delete the specified task from the task list in google tasks.
</Accordion>

<Accordion title="Find Folder">
  Find folder
</Accordion>

<Accordion title="Delete Folder or File">
  Delete folder or file
</Accordion>

<Accordion title="Create Email Draft">
  Create a draft email using gmail's api.
</Accordion>

<Accordion title="Delete Task List">
  Delete a task list in google tasks.
</Accordion>

<Accordion title="Delete Message">
  Delete an email message using gmail's api. note: this action requires the integration to have the `https://mail.google.com/` scope.
</Accordion>

<Accordion title="Find Files">
  Find files present in google drive. can be used to search for files by name and content.
</Accordion>

<Accordion title="Patch Calendar">
  Action to update a google calendar based on the provided calendar id and other required and optional parameters. note that 'summary' is a mandatory parameter. use googlecalendar list calendars action to get the list of calendars and their ids.
</Accordion>

<Accordion title="Parse a File from Google Drive">
  Parse a file. max 10mb in size. \<\<DEPRECATED use DOWNLOAD\_FILE>>
</Accordion>

<Accordion title="Remove Attendee from Event">
  Remove an attendee from an existing event in a google calendar.
</Accordion>

<Accordion title="Remove Label">
  Action to remove a label in gmail.
</Accordion>

<Accordion title="Update Google Event">
  Update an existing event in a google calendar.
</Accordion>

<Accordion title="Reply to Email Thread">
  Action to reply to an email thread in gmail.
</Accordion>

<Accordion title="Update Existing Document">
  Updates an existing google docs document with the provided edits.
</Accordion>

<Accordion title="Patch Task List">
  Update the authenticated user's specified task list in google tasks.
</Accordion>

<Accordion title="Patch Task">
  Update the specified task in the task list in google tasks.
</Accordion>

<Accordion title="Quick Add Event">
  Create a new event in a google calendar based on a simple text string like 'appointment at somewhere on june 3rd 10am-10:25am' you can only give title and timeslot here. no recurring meetings and no attendee can be added here. this is not a preferred endpoint. only use this if no other endpoint is possible.
</Accordion>

<Accordion title="Upload File">
  Upload a file to google drive. max file size is 5mb.
</Accordion>

<Accordion title="Update Media Item">
  Updates a media item's description in google photos.
</Accordion>

<Accordion title="Upload Media">
  Upload a media file to google photos. supports images (up to 200mb) and videos (up to 20gb).
</Accordion>

<Accordion title="Text Search">
  Searches for places using a text query in google maps places api.
</Accordion>

<Accordion title="Sheet From Json">
  Create a new google sheet from a json object. this action takes a json structure and converts it into a google sheet where: - the first row contains the keys as headers - subsequent rows contain the corresponding values - all rows must have the same structure (keys) args: title (str): the title of the new google sheet sheet name (str): name of the worksheet within the spreadsheet sheet json (list\[dict]): list of dictionaries with consistent keys
</Accordion>

<Accordion title="Send Email">
  Send an email using gmail's api.
</Accordion>

<Accordion title="Search Media Items">
  Searches for media items in a user's google photos library.
</Accordion>

<Accordion title="Search People">
  Provides a list of contacts in the authenticated user's grouped contacts that matches the search query. the query matches on a contact's names, nicknames, emailaddresses, phonenumbers, and organizations fields that are from the contact source. a custom integration with `https://www.googleapis.com/auth/contacts.readonly` scope is required to use this action.
</Accordion>

<Accordion title="Update Document Markdown">
  Updates an existing google docs document created using markdown with the new markdown text.
</Accordion>


# Googletasks
Source: https://docs.push.ai/integrations/googletasks



Google Tasks provides a simple to-do list and task management system integrated into Gmail and Google Calendar for quick and easy tracking

<Accordion title="List Task Lists">
  List all task lists of an authenticated user in google tasks.
</Accordion>

<Accordion title="List Tasks">
  Retrieve all tasks in the specified task list from google tasks.
</Accordion>

<Accordion title="Patch Task">
  Update the specified task in the task list in google tasks.
</Accordion>

<Accordion title="Patch Task List">
  Update the authenticated user's specified task list in google tasks.
</Accordion>

<Accordion title="Clear Tasks">
  Clear all completed tasks from the specified task list in google tasks.
</Accordion>

<Accordion title="Create Task List">
  Create a new task list in google tasks.
</Accordion>

<Accordion title="Delete Task">
  Delete the specified task from the task list in google tasks.
</Accordion>

<Accordion title="Delete Task List">
  Delete a task list in google tasks.
</Accordion>

<Accordion title="Get Task">
  Retrieve the specified task from the task list in google tasks.
</Accordion>

<Accordion title="Insert Task">
  Create a new task on the specified task list in google tasks.
</Accordion>

<Accordion title="Get Task List">
  Get a task list in google tasks.
</Accordion>


# Gorgias
Source: https://docs.push.ai/integrations/gorgias



Integration for Gorgias, focusing on e-commerce enhancements.

<Accordion title="Create Ticket">
  Creates a new ticket in gorgias.
</Accordion>

<Accordion title="Delete Customer">
  Deletes a specific customer from gorgias.
</Accordion>

<Accordion title="Get Event">
  Retrieves a specific event from gorgias.
</Accordion>

<Accordion title="Delete Customer Field Value">
  Deletes a specific field value for a customer in gorgias.
</Accordion>

<Accordion title="Delete Customers">
  Deletes multiple customers from gorgias.
</Accordion>

<Accordion title="List Account Settings">
  Lists all account settings in gorgias.
</Accordion>

<Accordion title="List Tickets">
  Lists tickets in gorgias with various filtering options.
</Accordion>

<Accordion title="Set Customer Data">
  Sets the complete data object for a customer in gorgias.
</Accordion>

<Accordion title="Remove Ticket Tags">
  Removes tags from a ticket in gorgias.
</Accordion>

<Accordion title="Update Ticket">
  Updates an existing ticket in gorgias.
</Accordion>

<Accordion title="Get Ticket">
  Retrieves a specific ticket from gorgias.
</Accordion>

<Accordion title="Get Team">
  Retrieves a specific team from gorgias.
</Accordion>

<Accordion title="List Ticket Tags">
  Lists all tags for a ticket in gorgias.
</Accordion>

<Accordion title="List Ticket Field Values">
  Lists all field values for a ticket in gorgias.
</Accordion>

<Accordion title="Merge Customers">
  Merges two customers in gorgias, combining their data and history.
</Accordion>

<Accordion title="Delete Team">
  Deletes a specific team from gorgias.
</Accordion>

<Accordion title="Set Ticket Tags">
  Sets the complete list of tags for a ticket in gorgias.
</Accordion>

<Accordion title="List Customers">
  Lists customers in gorgias with various filtering options.
</Accordion>

<Accordion title="Delete Ticket">
  Deletes a specific ticket from gorgias.
</Accordion>

<Accordion title="List Customer Field Values">
  Lists all field values for a customer in gorgias.
</Accordion>

<Accordion title="Update Account Setting">
  Updates an existing account setting in gorgias.
</Accordion>

<Accordion title="Delete Ticket Field Value">
  Deletes a specific field value for a ticket in gorgias.
</Accordion>

<Accordion title="Get Account">
  Retrieves your gorgias account information.
</Accordion>

<Accordion title="Update Customer">
  Updates an existing customer in gorgias.
</Accordion>

<Accordion title="List Events">
  Lists events in gorgias with various filtering options.
</Accordion>

<Accordion title="List Teams">
  Lists teams in gorgias.
</Accordion>

<Accordion title="Get Customer">
  Retrieves a specific customer from gorgias.
</Accordion>

<Accordion title="Update Team">
  Updates an existing team in gorgias.
</Accordion>

<Accordion title="Create Account Setting">
  Creates a new account setting in gorgias.
</Accordion>

<Accordion title="Add Ticket Tags">
  Adds tags to a ticket in gorgias.
</Accordion>

<Accordion title="Create Customer">
  Creates a new customer in gorgias.
</Accordion>

<Accordion title="Create Team">
  Creates a new team in gorgias.
</Accordion>


# Hackernews
Source: https://docs.push.ai/integrations/hackernews



Hacker News is a tech-focused news aggregator by Y Combinator, featuring user-submitted stories and discussions on startups, programming, and emerging trends

<Accordion title="Get Hackernews Item">
  Get a specific item from hacker news using its id. limits response size to prevent context overflow.
</Accordion>

<Accordion title="Get Hackernews Frontpage">
  Get the frontpage posts of hacker news.
</Accordion>

<Accordion title="Get Latest Hackernews Posts">
  Get the latest posts from hacker news based on optional filters. results can be limited using the size parameter.
</Accordion>

<Accordion title="Get Hackernews Today Posts">
  Get today's posts from hacker news.
</Accordion>

<Accordion title="Get Hackernews User">
  Get a specific user from hacker news using their username.
</Accordion>

<Accordion title="Search Hackernews Posts">
  Get relevant posts from hacker news based on a full-text query and optional filters. results can be limited using the size parameter.
</Accordion>


# Heygen
Source: https://docs.push.ai/integrations/heygen



HeyGen is an innovative video platform that harnesses the power of generative AI to streamline your video creation process

<Accordion title="Add new asset">
  Creates a new asset in the heygen platform. this endpoint allows users to add various types of assets that can be used in video generation, such as avatars, backgrounds, or other content elements. the asset is created by sending plain text data, which likely includes necessary metadata or configuration information. this tool should be used when integrating new assets into the heygen ecosystem for use in content creation workflows. it's important to note that this endpoint may not support direct file uploads; instead, it might expect references to pre-uploaded files or configuration data for asset creation.
</Accordion>

<Accordion title="Retrieve audience video details">
  Retrieves detailed information about the audience for personalized videos. this endpoint provides insights into the target audience characteristics, preferences, and engagement metrics for heygen's ai-generated personalized video content. it can be used to gain a deeper understanding of the audience demographics, behavior patterns, and content preferences to optimize video creation and targeting strategies. the tool is particularly useful for content creators, marketers, and businesses looking to tailor their video content to specific audience segments using heygen's ai capabilities.
</Accordion>

<Accordion title="Add contact to personalized video project">
  This endpoint allows you to add one or more contacts to a specific personalized video project in the heygen platform. it is used when you need to associate individual contact information with a project, likely for the purpose of creating tailored video content for each contact. the endpoint accepts a project identifier and a list of contacts, each with a first name and email address. this tool is essential for populating your project with recipient data, enabling the creation of personalized videos at scale. note that this endpoint only adds contacts to a project; it does not initiate video creation or sending. ensure that your project id is valid and that all contact information is accurate to avoid errors in video personalization or delivery.
</Accordion>

<Accordion title="Post streaming ice candidates">
  This endpoint is used to submit ice (interactive connectivity establishment) candidate information for a specific streaming session in the heygen platform. it plays a crucial role in establishing and managing peer-to-peer connections for real-time communication and streaming of avatar content. the endpoint should be called when new ice candidates are discovered during the connection setup process, typically as part of the webrtc negotiation. it's essential for ensuring optimal connectivity between clients, especially in scenarios involving nat traversal or complex network environments. this endpoint does not return the status of the connection or initiate the streaming itself; it only submits candidate information to be used in the connection process.
</Accordion>

<Accordion title="Retrieve streaming list">
  Retrieves a list of active or available streaming sessions or content within the heygen platform. this endpoint allows users to get an overview of ongoing streams, which may include live avatar interactions, real-time video generations, or other streaming content created using heygen's ai-driven tools. it's particularly useful for monitoring current streaming activities or checking the availability of streams for integration into applications. the endpoint returns basic information about each stream, such as stream ids, status, and possibly metadata, but does not provide the actual stream content. use this when you need to track or display a list of active streams in your application's interface or for administrative purposes.
</Accordion>

<Accordion title="Interrupt streaming session">
  Interrupts an ongoing streaming session with an interactive avatar. this endpoint allows immediate termination of the avatar's current action or speech, providing control over the flow of interaction. use this when you need to abruptly stop the avatar's current behavior, such as when changing topics or responding to user input that requires a different response. the interruption is immediate and irreversible, so use it judiciously to maintain a smooth user experience. this endpoint is particularly useful in scenarios where real-time responsiveness is crucial, like in customer service applications or interactive presentations.
</Accordion>

<Accordion title="Start streaming session">
  Initiates a new streaming session for real-time communication in the heygen platform. this endpoint is used to set up a webrtc connection for video, audio, and data streaming, likely for interactions with ai avatars. it requires a unique session id and a session description protocol (sdp) offer to establish the connection. this endpoint should be called when starting a new interactive session with a heygen ai avatar or when initiating a live streaming event. it's crucial for setting up the initial parameters of the real-time communication channel.
</Accordion>

<Accordion title="Set streaming quality endpoint">
  Initiates a new streaming session with heygen, allowing users to start an avatar-based stream with specified quality settings. this endpoint should be used when starting a new interactive content session or when creating a personalized digital avatar stream. it sets up the initial configuration for the streaming quality, which affects the overall user experience and bandwidth usage. the endpoint does not handle the actual streaming content or avatar creation; it only establishes the session parameters.
</Accordion>

<Accordion title="List talking photo entries">
  Retrieves a list of talking photos created using the heygen platform. this endpoint allows users to fetch information about their existing talking photo projects, which are interactive images capable of speaking and engaging users. it's useful for managing and reviewing your talking photo content, or for integrating talking photo information into your application. the endpoint returns details about each talking photo, potentially including identifiers, creation dates, and associated metadata. note that this endpoint likely returns all talking photos by default, so for users with a large number of projects, implementing client-side filtering or pagination may be necessary.
</Accordion>

<Accordion title="Post streaming task session">
  The streamingtask endpoint initiates a real-time speaking task for an ai-driven avatar within an active streaming session. it enables developers to make avatars vocalize specified text, creating interactive and dynamic user experiences. this endpoint should be used when you want to generate speech from an avatar in response to user input or as part of a scripted interaction. it's particularly useful for applications requiring real-time avatar interactions, such as virtual assistants, interactive presentations, or educational content. note that this endpoint requires an active streaming session, and the avatar's voice and appearance are determined by the session configuration.
</Accordion>

<Accordion title="Stop streaming session">
  The streaming.stop endpoint is used to terminate an active streaming session in the heygen api. this endpoint should be called when you want to end a real-time data transfer session, such as when closing an interactive avatar conversation or stopping a live content stream. it's particularly useful for freeing up server resources and ensuring proper closure of streaming connections. the endpoint requires the unique session id to identify which specific session to stop, allowing for precise control over multiple concurrent sessions. note that once a session is stopped, it cannot be resumed; a new session must be started if streaming is needed again.
</Accordion>

<Accordion title="List avatars endpoint">
  Retrieves a list of available avatars from the heygen platform. this endpoint allows users to fetch both public and private avatars, depending on their access rights and the specified parameters. it's particularly useful for applications that need to display available avatars to users for selection or customization. the endpoint supports pagination to handle large numbers of avatars efficiently. use this when you need to present avatar options to users, manage avatar inventories, or sync local avatar data with the heygen platform. note that the response will likely include basic information about each avatar, such as id, name, and type, but may not include full avatar details or assets.
</Accordion>

<Accordion title="Delete video">
  The video.delete endpoint allows users to remove a specific video from their heygen account. this operation moves the video to the trash, from where it can be restored if needed. use this endpoint when you want to delete a video that is no longer required or to manage your account's storage. it's important to note that this action doesn't permanently delete the video immediately, as it can be restored from the trash. exercise caution when using this endpoint, as deleted videos may not be recoverable after a certain period.
</Accordion>

<Accordion title="Retrieve video status">
  Retrieves the current status of a video in the heygen platform. this endpoint is used to check the progress of video processing, particularly useful for avatar videos that may require time to generate. it provides real-time information on whether the video is still being processed or has been completed. use this endpoint to monitor the state of your video creation requests and determine when a video is ready for further actions or viewing. the status returned can help in managing user expectations and workflow sequencing in applications integrating heygen's video generation capabilities.
</Accordion>

<Accordion title="List voice endpoints">
  Retrieves a comprehensive list of all available voices in the heygen platform. this endpoint should be used when you need to obtain information about the voice options that can be utilized for avatar creation or text-to-speech functionalities. the returned list likely includes details such as voice ids, names, languages, and potentially other characteristics like gender or accent. it's particularly useful for applications that need to present voice choices to users or for initializing voice-related features. note that this endpoint does not provide audio samples of the voices; it only lists their metadata.
</Accordion>

<Accordion title="Retrieve avatars collection">
  Retrieves a list of available avatars from the heygen platform. this endpoint allows users to access the vast library of realistic avatars that can be used for video creation. it should be used when you need to browse or select avatars for your projects, such as creating marketing videos, educational content, or social media posts. the endpoint returns basic information about each avatar, which may include identifiers, names, and preview images. it does not provide detailed customization options or allow for avatar creation; it's purely for listing existing avatars. keep in mind that the returned list may be paginated, and additional calls might be needed to retrieve the full set of avatars.
</Accordion>

<Accordion title="List webhooks">
  Retrieves a list of all webhooks configured for your heygen account. this endpoint allows you to view and manage the webhook integrations set up to receive real-time notifications about events in your heygen workspace, such as video generation status updates or avatar creation completions. use this endpoint when you need to audit your existing webhook configurations, verify webhook urls, or prepare for updating or deleting specific webhooks. the response typically includes details such as webhook ids, target urls, and the types of events each webhook is subscribed to. note that this endpoint does not create, modify, or delete webhooks; it only provides a read-only view of your current webhook configurations.
</Accordion>

<Accordion title="List webhook endpoints">
  Retrieves a list of all webhook endpoints configured for your heygen account. this endpoint allows you to view and manage the webhook configurations that receive notifications about various events in your heygen integration. use this endpoint to monitor your existing webhook setups, verify their status, or gather information for updating or removing webhooks. the response will likely include details such as the endpoint urls, associated event types, and current status of each webhook. this tool is particularly useful for developers managing multiple webhook integrations or troubleshooting notification issues within their heygen-powered applications.
</Accordion>

<Accordion title="Delete talking photo by id">
  Deletes a specific talking photo from the heygen platform using its unique identifier. this endpoint should be used when you need to permanently remove a talking photo resource, such as when it's no longer needed or to manage storage. once deleted, the talking photo cannot be recovered, so use this endpoint with caution. it's important to note that this operation does not affect any videos or content that may have already been generated using this talking photo.
</Accordion>

<Accordion title="Delete webhook endpoint">
  Deletes a specific webhook endpoint from the heygen system. this operation permanently removes the configured webhook, stopping any future notifications or data transmissions to the previously specified url. use this endpoint when you no longer need to receive real-time updates for certain events or when you want to change your webhook configuration. once deleted, you will need to create a new webhook endpoint if you wish to resume notifications. this action cannot be undone, so use it with caution. the deletion is typically immediate, but allow for a short processing time to ensure all systems are updated.
</Accordion>

<Accordion title="Retrieve all templates">
  Retrieves a list of available avatar templates from the heygen platform. this endpoint allows users to access pre-designed avatars that can be used for creating professional-looking videos. it's particularly useful when you need to browse or select from heygen's library of realistic avatars for your video projects. the endpoint returns template information, which likely includes details such as template ids, names, preview images, and customization options. use this endpoint when you want to display available avatar options to users or when you need to select a template for video generation.
</Accordion>

<Accordion title="Generate video template with variables">
  This endpoint generates a customized video based on a pre-existing template using heygen's ai-driven platform. it allows for dynamic content creation by accepting a video title and a set of variables that can be used to personalize the video content. the endpoint is ideal for creating tailored videos at scale, such as personalized marketing content, educational materials, or customized presentations. it supports optional features like test mode for preliminary checks, caption enablement for accessibility, and custom video dimensions for various output formats. this tool should be used when you need to produce videos with consistent structure but varying content, leveraging heygen's ai avatars and text-to-speech capabilities to create engaging, personalized video experiences.
</Accordion>

<Accordion title="Post talking photo binary image">
  Creates a talking photo by processing an uploaded image file. this endpoint enables users to transform static images into interactive, speaking visual content using heygen's advanced ai technology. it accepts jpeg or png image files and likely combines them with audio narration (though audio input is not specified in this schema). use this endpoint when you want to generate engaging, personalized content from still images, such as creating speaking avatars or animated photographs. the endpoint is particularly useful for marketing materials, educational content, or personalized messages. note that while image upload is specified, the method for providing or generating the associated audio is not detailed in this schema.
</Accordion>

<Accordion title="List videos">
  Retrieves a list of videos associated with the user's account on the heygen platform. this endpoint is crucial for content management, allowing users to view and organize their video library efficiently. it provides an overview of all videos created or managed through the heygen service, including ai-generated videos with custom avatars. use this endpoint when you need to display a comprehensive list of videos, manage content, or track video creation progress. the response likely includes metadata for each video such as title, creation date, duration, and status. note that this endpoint does not provide the actual video content or detailed analytics; it's primarily for listing and basic information retrieval.
</Accordion>

<Accordion title="Add webhook endpoint">
  Adds a new webhook endpoint to receive real-time notifications for specified heygen events. this endpoint allows you to configure where and for which events you want to receive updates, enabling seamless integration of heygen's capabilities into your application. use this when you need to set up automated responses to specific events in the heygen platform, such as avatar creation or video completion. the webhook will send post requests to the specified url whenever the subscribed events occur. note that you may need to implement proper security measures on your receiving endpoint to validate incoming webhook requests.
</Accordion>

<Accordion title="Fetch personalized video project detail">
  Retrieves detailed information about a specific personalized video project in the heygen platform. this endpoint allows you to fetch comprehensive data about a project, including its current status, configuration settings, and any other relevant metadata. use this when you need to get an up-to-date overview of a particular video project, such as checking its progress, reviewing its settings, or gathering information for reporting purposes. the endpoint is read-only and does not modify any project data. note that it may not include the actual video content itself, but rather focuses on the project's attributes and status.
</Accordion>

<Accordion title="List streaming avatars">
  Retrieves a list of available avatars for streaming purposes in the heygen platform. this endpoint allows developers to access the collection of realistic avatars that can be used for creating professional-looking videos with ai-generated content. it's designed to support applications requiring dynamic or live video content, enabling real-time access to the avatar library. the endpoint should be used when you need to fetch the current set of available avatars for integration into streaming or video generation workflows. it may not provide detailed information about each avatar's capabilities or customization options, focusing instead on delivering a quick, up-to-date list for immediate use in streaming contexts.
</Accordion>

<Accordion title="Create streaming token with expiry">
  Creates a new streaming token for use with heygen's real-time avatar and voice chat services. this endpoint generates a unique, time-limited token that authenticates and authorizes access to heygen's streaming capabilities. use this endpoint when initiating a new streaming session or when the previous token has expired. the generated token is typically for one-time use and should be obtained shortly before starting a streaming interaction. note that this endpoint does not initiate the streaming itself; it only provides the necessary credentials for subsequent streaming api calls.
</Accordion>

<Accordion title="Post video translate request">
  The translatevideo endpoint enables the translation of video content from one language to another. it offers flexible options for translating either the entire video or just the audio track, accommodating various use cases. this tool is ideal for creating multilingual versions of video content, making it accessible to a global audience. the endpoint requires specifying the source video url and the desired output language, with additional options to customize the translation process, such as handling multiple speakers and setting a title for the translated video. use this endpoint when you need to quickly and efficiently translate video content while maintaining the integrity of the original presentation.
</Accordion>

<Accordion title="Retrieve video translation target languages">
  Retrieves a list of all available target languages supported by heygen's video translation feature. this endpoint should be used when you need to know which languages are available for translating your video content. it provides an up-to-date array of supported languages, including various dialects and locales, allowing you to make informed decisions about your video translation projects. the endpoint does not require any parameters and will return the complete list of supported languages, which currently includes over 77 options. this tool is particularly useful for planning multilingual content strategies or when preparing to use heygen's video translation services.
</Accordion>

<Accordion title="Generate video with inputs">
  Generates a customized video using heygen's ai-driven platform. this endpoint allows you to create videos featuring digital avatars with specified voices, enabling dynamic content creation. it's ideal for producing personalized video content, such as explainer videos, product demonstrations, or interactive presentations. the endpoint supports multiple input configurations, allowing for complex video scenarios with different characters and voices. use this when you need to programmatically create ai-generated videos with specific avatar and voice combinations. note that while the endpoint offers extensive customization, real-time video generation is not supported, and processing times may vary based on complexity and system load.
</Accordion>

<Accordion title="Retrieve video translation by id">
  Retrieves the current status of a video translation job in the heygen platform. this endpoint allows users to check the progress of their requested video translations, providing information such as whether the translation is in progress, completed, or if any errors have occurred. it should be used when tracking the state of an ongoing translation task or to confirm if a translation has finished processing. the endpoint does not modify the translation job or initiate new translations; it's purely for status checking purposes.
</Accordion>

<Accordion title="Get template by id">
  Retrieves a specific template from the heygen platform using its unique identifier. this endpoint allows users to access detailed information about a particular template, including its structure, elements, and customization options. it's particularly useful when you need to review or use an existing template for video creation or modification. the endpoint returns comprehensive template data, which may include settings for avatars, content placeholders, and customization parameters. use this when you want to fetch the complete details of a known template before applying it to create or edit a video. note that this endpoint retrieves template information only and does not create or modify any content.
</Accordion>

<Accordion title="List available voices">
  Retrieves a list of available voice models and options that can be used with heygen's ai-driven video creation platform. this endpoint provides information about the various voice options, including different languages and voice characteristics, which can be applied to avatars in generated videos. use this endpoint when you need to present users with voice choices for their video projects or when implementing voice customization features in your application. the returned data likely includes details such as voice id, language, gender, and other relevant attributes for each available voice model. this endpoint is essential for applications that want to offer a range of voice options to enhance the personalization of ai-generated video content.
</Accordion>

<Accordion title="Retrieve user remaining quota">
  Retrieves the current remaining quota for the authenticated user on the heygen platform. this endpoint allows users to check their available resources or actions within their account limits. it should be used to monitor usage and plan resource allocation effectively. the returned information helps users understand how much of their quota is left before reaching account limits. note that this endpoint does not provide details on total quota or usage history, focusing solely on the remaining available quota.
</Accordion>


# Hubspot
Source: https://docs.push.ai/integrations/hubspot



HubSpot is an inbound marketing, sales, and customer service platform integrating CRM, email automation, and analytics to facilitate lead nurturing and seamless customer experiences

<Accordion title="Archive contact by id">
  Archives a contact in the hubspot crm by moving it to the recycling bin. this endpoint should be used when you need to remove a contact from active use in your crm. the operation is irreversible through the api, so use it with caution. once archived, the contact will no longer appear in standard contact lists or searches. this endpoint is useful for data cleanup or when a contact is no longer relevant to your business operations.
</Accordion>

<Accordion title="Archive property by object type and name">
  This endpoint moves a specified crm property to the recycling bin in hubspot. it allows users to archive properties that are no longer needed or relevant, without permanently deleting them. the endpoint should be used when you want to remove a property from active use in your crm objects, such as contacts, companies, or deals. it's important to note that this action doesn't permanently delete the property, but rather moves it to a recyclable state. use this endpoint with caution, as archiving a property may affect existing records and integrations that rely on that property.
</Accordion>

<Accordion title="Hubspot Archive">
  Move an object identified by `\{emailid\}` to the recycling bin.
</Accordion>

<Accordion title="Archive product by productid">
  Archives a product in the hubspot crm by moving it to the recycling bin. this endpoint is used to remove a product from active use without permanently deleting it. it's ideal for managing product catalogs in e-commerce applications integrated with hubspot. the operation is irreversible through the api, but archived products can be restored manually through the hubspot interface if needed. use this endpoint when a product is no longer available or relevant, but you want to retain its historical data.
</Accordion>

<Accordion title="Archive batch of properties">
  Archives a batch of properties for a specified crm object type in hubspot. this endpoint allows for efficient bulk archiving of multiple properties simultaneously, regardless of their initial state. it's ideal for cleaning up or reorganizing large sets of custom properties in your hubspot crm. the operation is idempotent, ensuring consistent results even if properties are already archived or don't exist.
</Accordion>

<Accordion title="Archive batch of deals by id">
  Archives a batch of deals in the hubspot crm by their ids. this endpoint allows for bulk archiving of multiple deals simultaneously, which is useful for removing outdated or irrelevant deals from active view. it should be used when you need to archive numerous deals at once, improving crm organization and performance. note that archiving is a significant action that removes deals from standard views and reports, so use this endpoint cautiously and ensure you have backups or a way to unarchive if needed.
</Accordion>

<Accordion title="Add asset association">
  Associate a specified asset with a campaign. important: currently, only the following asset types can be associated and disassociated via the api: forms, static lists, external website pages
</Accordion>

<Accordion title="Archive ticket by id">
  Archives a specific ticket in the hubspot crm system by moving it to the recycling bin. this endpoint should be used when you need to remove a ticket from active status, such as when a support issue has been resolved or is no longer relevant. the operation is permanent and cannot be undone through the api, so use it cautiously. this tool is ideal for cleaning up your ticket management system or implementing automated ticket archiving processes based on certain criteria.
</Accordion>

<Accordion title="Archive line item by id">
  Archives a specific line item in hubspot's crm system by moving it to the recycling bin. this endpoint should be used when you need to remove a line item from active use without permanently deleting it. it's particularly useful for data cleanup or when you want to hide outdated or irrelevant line items while retaining the ability to restore them later if needed. note that this action doesn't permanently delete the line item, but rather moves it to a recoverable state in the recycling bin.
</Accordion>

<Accordion title="Add token to event template">
  This endpoint allows you to add a new token to an existing event template in hubspot's crm timeline. tokens are used to attach custom data to events, enabling enhanced timeline displays and list segmentation. you can also associate crm object properties using the 'objectpropertyname' field. this endpoint is useful for customizing event templates with additional data points or for building out complete crm objects. ensure that the token name is unique within the template to avoid conflicts.
</Accordion>

<Accordion title="Batch update quotes">
  This endpoint allows for batch updating of multiple quotes in the hubspot crm system. it enables efficient modification of quote data by processing multiple updates in a single api call. this endpoint is particularly useful when you need to update a large number of quotes simultaneously, such as adjusting prices, updating expiration dates, or modifying custom fields across multiple quotes. the batch update functionality can significantly reduce the number of api calls required for bulk quote modifications, potentially improving performance and reducing api usage. however, be cautious when using this endpoint, as it can make widespread changes to your crm data in a single operation.
</Accordion>

<Accordion title="Archive batch of feedback submissions by id">
  This endpoint allows you to archive multiple feedback submissions in bulk within your hubspot crm. it's designed for efficient management of large volumes of feedback data, enabling you to move older or processed submissions out of active view. the operation is performed asynchronously, meaning it will be queued for processing after the request is received. use this endpoint when you need to clean up your active feedback submissions or organize your data for long-term storage. note that archived submissions are not deleted and can be retrieved if needed, but they won't appear in standard searches or reports.
</Accordion>

<Accordion title="Create a campaign">
  Create a campaign with the given properties and return the campaign object, including the campaignguid and created properties.
</Accordion>

<Accordion title="Audit pipeline changes by id">
  Retrieves a reverse chronological list of all mutations (changes) that have occurred on a specific pipeline in hubspot's crm. this endpoint is used to audit and track modifications made to a pipeline, providing transparency and accountability in pipeline management. it's particularly useful for monitoring changes in sales processes, workflow modifications, or any other pipeline-related activities. the function returns detailed information about each change, allowing users to review the pipeline's evolution over time.
</Accordion>

<Accordion title="Archive property group">
  Archives a specific property group in hubspot's crm by moving it to the recycling bin. this operation allows users to remove obsolete or unnecessary property groups from active use without permanently deleting them. it should be used when reorganizing crm properties or during cleanup processes. once archived, the property group will no longer be available for use in crm operations, but can potentially be restored if needed. exercise caution when using this endpoint, as it immediately impacts the availability of the property group across the crm system.
</Accordion>

<Accordion title="Clone marketing email">
  This endpoint creates a duplicate of an existing marketing email in hubspot. it allows users to quickly replicate the content, design, and settings of a previously created email, saving time in the email creation process. the cloned email can be given a new name, making it easy to identify and manage multiple versions or variations of an email campaign. this tool is particularly useful when creating similar email campaigns or when testing different versions of an email while maintaining the original intact. note that while the email is cloned, it does not automatically send the new email or add it to any existing workflows or campaigns.
</Accordion>

<Accordion title="Cancel active import">
  Cancels an active import process in the hubspot crm system. this endpoint allows you to immediately stop an ongoing data import, which is useful for preventing unwanted data from being added to your crm or halting an import that was started by mistake. it should be used when you need to urgently stop a data import that is currently in progress. note that this action is irreversible, and any data that has already been imported will remain in the system. the endpoint returns an actionresponse indicating the success or failure of the cancellation request.
</Accordion>

<Accordion title="Campaign search">
  This endpoint allows users to search for and return a page of campaigns based on various query parameters. users can filter by name, sort, and paginate through the campaigns, as well as control which properties are returned in the response.
</Accordion>

<Accordion title="Create a batch of companies">
  Creates multiple company records in hubspot's crm system in a single api call. this endpoint is designed for efficiently adding a large number of companies to your hubspot account, which is particularly useful for bulk imports or when syncing data from another system. it allows for the creation of up to 100 companies per request, significantly reducing the number of api calls needed for large-scale operations. the endpoint returns detailed information about the success or failure of each company creation attempt, enabling easy tracking and error handling for batch operations.
</Accordion>

<Accordion title="Archive batch of tickets by id">
  Archives a batch of tickets in the hubspot crm by their ids. this endpoint allows for efficient bulk archiving of multiple tickets in a single api call. it should be used when you need to remove tickets from active status, making them inaccessible for further updates or interactions. this operation is particularly useful for data cleanup, removing old or resolved tickets, or managing large volumes of ticket data. the endpoint processes the provided ticket ids in bulk, improving performance for large-scale archiving operations.
</Accordion>

<Accordion title="Archive batch products by id">
  Archives multiple products in hubspot's crm system by their ids in a single batch operation. this endpoint is used to remove products from active use without permanently deleting them, making them inaccessible in standard views and searches. it's particularly useful for bulk cleanup of outdated or discontinued products in e-commerce integrations. the operation is irreversible through the api, so use it cautiously. note that this endpoint does not return the archived products; it only confirms the action with a 204 no content response upon success.
</Accordion>

<Accordion title="Configure calling extension settings">
  Configures the settings for a calling extension in hubspot's crm. this endpoint allows you to customize the appearance and behavior of your calling extension by setting the menu label, target iframe url, and dimensions. use this when you need to create or update the configuration for your calling extension to integrate it seamlessly into the hubspot interface. it's essential for tailoring the user experience of your calling extension within the hubspot crm environment.
</Accordion>

<Accordion title="Archive a batch of emails by id">
  The batcharchiveemails endpoint allows you to archive multiple emails in hubspot's crm system with a single api call. this endpoint is particularly useful for bulk email management, enabling efficient organization of email records within the crm. it should be used when you need to archive a large number of emails simultaneously, which can help in maintaining a clean and organized email database. the endpoint accepts a list of email ids and processes them in batch, which is more efficient than making individual archive requests for each email. however, be aware that this operation is irreversible, so ensure that you truly want to archive the specified emails before making the call.
</Accordion>

<Accordion title="Create ab test variation">
  Creates a new variation of an existing email for a/b testing in hubspot's email marketing tools. this endpoint allows marketers to generate alternative versions of an email to compare performance and optimize engagement. use this when you want to set up an a/b test for an email campaign, testing elements such as subject lines, content, or calls-to-action. the new variation is based on an existing email content and is assigned a unique name for easy identification. this tool is specifically for creating test variations and does not initiate the actual a/b test or send emails.
</Accordion>

<Accordion title="Create a batch of emails">
  Creates multiple email objects in hubspot's crm system in a single api call. this endpoint is ideal for bulk email creation, allowing you to efficiently add numerous emails with custom properties and crm object associations. use this when you need to create multiple emails simultaneously, such as importing a batch of email records or setting up a series of automated emails. the endpoint provides flexibility in defining email properties and associations, enabling integration with various aspects of your hubspot crm data. note that this endpoint creates email objects in the crm, but does not send the emails; it's primarily for record-keeping and crm management purposes.
</Accordion>

<Accordion title="Create and return a new property group">
  Creates a new property group for a specified crm object type in hubspot. this endpoint allows you to organize related properties into logical groups, improving the structure and management of custom properties within your crm. use this when you need to create a new category or section for properties in your hubspot crm, such as grouping all properties related to a specific business process or customer attribute. the newly created property group can then be used to organize existing or new properties for the specified object type (e.g., contacts, companies, deals). note that this endpoint creates an empty group; you'll need to use separate api calls to add properties to this group after creation.
</Accordion>

<Accordion title="Archive quote object by id">
  Archives a specific quote object in hubspot's crm by moving it to the recycling bin. this endpoint is used to remove a quote from active use while preserving its data for potential future reference. it's particularly useful for managing outdated or rejected quotes, helping to keep the active quote list clean and organized. the operation is irreversible through this api, so it should be used with caution when permanent removal of a quote from active status is desired.
</Accordion>

<Accordion title="Batch read companies by properties">
  This endpoint enables batch retrieval of multiple company records from the hubspot crm by their properties. it's designed for efficiently fetching data for multiple companies in a single api call, reducing the number of requests needed when working with large datasets. the endpoint allows filtering for archived companies and specifies which properties to retrieve for each company. it's ideal for bulk data synchronization, reporting, or any scenario where information on multiple companies is needed simultaneously. the response provides detailed company data or error information if any companies couldn't be retrieved.
</Accordion>

<Accordion title="Create batch of properties">
  This endpoint allows you to create multiple crm properties in a single api call for a specified object type in hubspot. it's particularly useful when setting up or updating your crm schema in bulk, saving time and reducing the number of api calls needed. the endpoint follows the same rules and constraints as creating individual properties, ensuring consistency in your crm structure. use this when you need to add several new fields to your crm objects efficiently, such as during initial setup or when expanding your data model. note that while this operation is atomic, it may result in partial success, so always check the response for any errors on specific properties.
</Accordion>

<Accordion title="Create batch of line items">
  Creates multiple line items in a single api call within the hubspot crm. this endpoint is designed for bulk operations, allowing efficient creation of numerous line items simultaneously. it's particularly useful for scenarios such as importing large datasets, setting up initial inventory, or updating multiple products at once. the endpoint accepts a batch of line item data and returns the created objects or error information for any failed creations.
</Accordion>

<Accordion title="Create association for object type">
  This endpoint creates a new association between object types in hubspot's crm system. it allows you to define relationships between different entities, such as linking contacts to companies or deals to products. the association is created for the primary object type specified in the path parameter and can be linked to one or more other object types. this tool is essential for structuring and organizing data within the crm, enabling more complex data relationships and improved data management. use it when you need to establish new connections between different types of data in your hubspot crm. note that this endpoint requires specific permissions and should be used carefully as it affects the overall structure of your crm data.
</Accordion>

<Accordion title="Create batch of quotes">
  This endpoint allows you to create multiple quotes simultaneously in the hubspot crm system. it's designed for efficiency when you need to add a large number of quotes at once, such as during data migration or when processing bulk quote requests. the endpoint accepts a batch of quote objects and attempts to create all of them, returning detailed results for each quote in the batch. use this when you have multiple quotes to create and want to optimize api usage by reducing the number of individual calls. note that partial success is possible, so it's important to check the response for any errors on specific quotes within the batch.
</Accordion>

<Accordion title="Archive a batch of quotes by id">
  This endpoint archives a batch of quotes in the hubspot crm by their ids. it allows for efficient bulk archiving of multiple quotes in a single api call, which is useful for removing outdated or irrelevant quotes from active use. the operation is irreversible, so use it cautiously. this endpoint should be used when you need to archive multiple quotes simultaneously, such as during a cleanup process or when closing multiple deals. it will not delete the quotes but move them to an archived state, making them inaccessible through normal quote retrieval methods.
</Accordion>

<Accordion title="Create pipeline stage">
  Creates a new stage within an existing pipeline in hubspot's crm. this endpoint allows you to add a new stage to a specific pipeline, which can be used to represent different steps in your sales, marketing, or customer service processes. the created stage will be associated with the pipeline identified by the provided pipelineid. use this when you need to expand or modify the structure of your crm pipelines by adding new stages. the endpoint returns the complete details of the newly created stage, including its unique identifier.
</Accordion>

<Accordion title="Archive company">
  Archives a company in the hubspot crm by moving it to the recycling bin. this endpoint should be used when you need to remove a company from active use without permanently deleting it. archiving a company may affect its visibility and associations within the crm. once archived, the company can be restored if needed, but it won't appear in most standard company lists or searches. use this endpoint with caution, as it can impact reporting and user access to company data.
</Accordion>

<Accordion title="Archive crm object by id">
  Archives a specific crm object in hubspot by moving it to the recycling bin. this endpoint allows you to remove an object from active use without permanently deleting it, providing a safety net for accidental deletions. it can be used for various crm object types such as contacts, companies, deals, or quotes. the operation is irreversible through the api, but the object can be restored from the recycling bin in the hubspot interface if needed.
</Accordion>

<Accordion title="Create feedback submission">
  Creates a new feedback submission in the hubspot crm system with the provided properties. this endpoint allows you to programmatically add customer feedback to your hubspot account, enabling better tracking and analysis of customer sentiments and experiences. use this when you need to submit feedback collected from various channels (e.g., surveys, support interactions, or product reviews) into hubspot. the endpoint returns a copy of the created feedback submission object, including its unique id, which can be used for future reference or updates. note that the specific properties available for feedback submissions may depend on your hubspot account configuration and custom properties.
</Accordion>

<Accordion title="Archive feedback submission">
  Archives a specific feedback submission in hubspot's crm by moving it to the recycling bin. this endpoint is used when you need to remove a feedback submission from active use without permanently deleting it. it's particularly useful for maintaining data integrity while clearing out outdated or irrelevant feedback. note that this action is reversible, as the submission can be restored from the recycling bin if needed. however, archived submissions will not appear in standard feedback reports or searches.
</Accordion>

<Accordion title="Create event template for app">
  Creates a new event template for a hubspot app, defining the structure for custom timeline events in the crm. this endpoint allows developers to set up templates for events like video views, webinar registrations, or survey completions. the created template can be used for contacts, companies, tickets, or deals, and includes formatted content and custom property definitions. use this endpoint when setting up new types of timeline events for your hubspot integration. note that you must create an event template before you can create actual events in the crm timeline.
</Accordion>

<Accordion title="Create batch of objects">
  This endpoint allows you to create multiple crm objects of a specified type in a single api call. it's designed for bulk creation of objects like contacts, companies, deals, or tickets in the hubspot crm system. the endpoint is particularly useful when you need to import a large number of records or synchronize data from another system. it supports creating various object types, determined by the 'objecttype' path parameter. the request body should contain an array of objects to be created, following the batchinputsimplepublicobjectinputforcreate schema. the response will either indicate successful creation of all objects or provide details on any errors encountered during the batch creation process. this endpoint is ideal for operations requiring the creation of multiple crm records simultaneously, improving efficiency and reducing the number of api calls needed for bulk data operations.
</Accordion>

<Accordion title="Create batch of ticket">
  This endpoint allows you to create multiple tickets in the hubspot crm simultaneously. it's designed for bulk ticket creation, which is particularly useful for importing support requests from external systems or creating multiple related tickets efficiently. the endpoint accepts a batch of ticket data and processes them in a single api call, reducing the number of individual requests needed. use this when you need to create multiple support tickets at once, such as during data migration or when integrating with other customer support platforms. note that while this endpoint can handle multiple tickets, there may be limits on the number of tickets that can be created in a single batch, so check hubspot's documentation for current limitations.
</Accordion>

<Accordion title="Create a batch of campaigns">
  This endpoint creates a batch of campaigns. the maximum number of items in a batch request is 50. the campaigns in the response are not guaranteed to be in the same order as they were provided in the request.
</Accordion>

<Accordion title="Create product object">
  Creates a new product object in the hubspot crm system with the specified properties. this endpoint is used to add new products to your e-commerce catalog within hubspot. it allows you to define various attributes of the product such as name, price, description, and any custom properties configured in your hubspot account. upon successful creation, the endpoint returns a copy of the created product object, including its unique id assigned by hubspot. this tool is particularly useful for integrating external e-commerce systems with hubspot or for programmatically managing your product catalog. note that this endpoint creates basic product entries and may not support complex product configurations or variants.\<\<DEPRECATED use create\_product\_object>>
</Accordion>

<Accordion title="Create contact object with properties">
  Creates a new contact in the hubspot crm system with the provided properties. this endpoint allows you to add a new contact to your hubspot database, populating it with the specified information. it's ideal for scenarios where you need to programmatically create contacts, such as when integrating with other systems or automating lead capture processes. the endpoint returns a copy of the created contact object, including its unique id, which can be used for further operations or reference. note that while the endpoint offers flexibility in terms of properties you can set, it's important to provide at least one property to create a meaningful contact entry.
</Accordion>

<Accordion title="Create batch of contacts">
  Creates multiple contact records in hubspot's crm system in a single api call. this endpoint is designed for efficient bulk creation of contacts, making it ideal for data imports, migrations, or synchronization between systems. it allows you to create up to 100 contacts simultaneously, significantly reducing the number of api calls required for large-scale contact creation. the endpoint returns detailed information about the success or failure of each contact creation attempt, enabling easy tracking and error handling for batch operations.\<\<DEPRECATED use create\_batch\_of\_contacts>>
</Accordion>

<Accordion title="Create line item object">
  Creates a new line item object in the hubspot crm with the provided properties. this endpoint is used to add individual products or services to deals, quotes, or orders. it returns a copy of the created object, including its unique id. use this when you need to add new items to a customer's order or deal in the hubspot system.
</Accordion>

<Accordion title="Create pipeline for objecttype">
  Creates a new pipeline for a specified object type in hubspot's crm. this endpoint allows you to define custom stages and workflows for different crm objects such as deals, tickets, or custom objects. use this when you need to establish a new process flow or sales methodology within your hubspot crm. the created pipeline will be immediately available for use and will return the complete pipeline object, including its unique identifier, in the response. note that this operation requires appropriate authentication and permissions based on the object type you're working with.
</Accordion>

<Accordion title="Create timeline event based on template">
  Creates a new timeline event in hubspot's crm based on a predefined event template. this endpoint allows you to add custom, immutable events to object timelines, providing a detailed record of interactions or activities. once created, the event cannot be modified. if the event template is configured with object property updates, this call will also attempt to update or add those properties to the associated object. use this endpoint to enrich your crm data with specific, structured events tied to contacts, companies, or deals.
</Accordion>

<Accordion title="Delete schema by objecttype">
  Deletes a custom schema in hubspot's crm by its object type. this endpoint should be used when you need to remove a custom object schema from your hubspot account. it's crucial to note that all existing records of this schema must be deleted before calling this endpoint; otherwise, the operation will fail. this is a permanent action and cannot be undone, so use it with caution. the endpoint is particularly useful when restructuring your crm or removing obsolete custom object types.
</Accordion>

<Accordion title="Delete campaign">
  Delete a specified campaign from the system. this call will return a 204 no content response regardless of whether the campaignguid provided corresponds to an existing campaign or not.
</Accordion>

<Accordion title="List contacts page">
  This endpoint retrieves a paginated list of contacts from the hubspot crm. it allows for flexible querying with options to specify the number of results per page, filter properties, include historical property values, and fetch associated object ids. the endpoint is ideal for tasks such as synchronizing contact data with external systems, generating reports, or displaying contact information in a user interface. it supports pagination for handling large datasets efficiently and provides fine-grained control over the data returned for each contact.\<\<DEPRECATED use list\_contacts\_page>>
</Accordion>

<Accordion title="Create company object">
  Creates a new company object in the hubspot crm with the provided properties. this endpoint allows you to add a new company to your crm database, including custom fields and properties specific to your hubspot account configuration. upon successful creation, it returns a copy of the newly created company object, including its unique id assigned by hubspot. use this endpoint when you need to programmatically add new companies to your crm, such as when integrating with other systems or automating company record creation. note that the specific properties available for a company may vary based on your hubspot account setup and any custom properties you've defined.
</Accordion>

<Accordion title="Delete timeline event template">
  This endpoint deletes a specific timeline event template from hubspot's crm system. it permanently removes the template and all associated events from search results and the timeline ui. use this endpoint when you need to completely remove an event template and its data from your hubspot application. this operation is irreversible, so it should be used with caution. before deletion, ensure that the template and its associated events are no longer needed, as they cannot be recovered after deletion. the endpoint requires both the event template id and the app id for precise identification and execution of the deletion process.
</Accordion>

<Accordion title="Archive batch of companies by id">
  Archives a batch of companies in the hubspot crm system using their unique ids. this endpoint allows for efficient bulk archiving of multiple companies simultaneously, which is particularly useful for data cleanup, removing outdated records, or managing large datasets. it should be used when you need to archive numerous companies at once, saving time compared to individual archiving operations. the endpoint does not delete the companies but moves them to an archived state, making them less prominent in the active crm view while still retaining the data. note that this operation cannot be undone through the api, so use it cautiously and ensure you have the correct company ids before proceeding.
</Accordion>

<Accordion title="Create a new marketing email">
  Use this endpoint to create a new marketing email.
</Accordion>

<Accordion title="Archive batch of line items by id">
  This endpoint allows you to archive multiple line items in the hubspot crm system by their ids in a single batch operation. it's designed for efficient bulk management of line items, particularly useful when you need to archive a large number of items simultaneously. the endpoint should be used when you want to remove multiple line items from active use without permanently deleting them. it's important to note that this operation is not reversible through the api, so use it carefully. the endpoint doesn't return the archived items; it only confirms the successful processing of the request with a 204 no content response.
</Accordion>

<Accordion title="Delete video conferencing app settings">
  Deletes the settings for a specific video conferencing application integrated with hubspot. this endpoint should be used when you need to remove the configuration of a video conferencing app from your hubspot account, such as when discontinuing the use of a particular integration or preparing to set up a new configuration. it's important to note that this action is irreversible and will remove all associated settings for the specified application id. this endpoint does not affect any scheduled meetings or historical data, but it will prevent the app from functioning within hubspot until reconfigured.
</Accordion>

<Accordion title="Create crm object with properties">
  Creates a new crm object in hubspot with specified properties and returns a copy of the created object, including its unique id. this endpoint is versatile and can be used to create various standard crm objects (such as contacts, companies, deals) as well as custom objects. it's ideal for adding new records to your hubspot crm programmatically, allowing for seamless integration with external systems or automated workflows. the endpoint requires specifying the object type and providing the necessary properties for the object being created.
</Accordion>

<Accordion title="Delete Workflow">
  Fully delete a workflow by id. warning: deleted workflows cannot be restored via the api. if you need to restore an accidentally deleted flow, you'll need to contact support.
</Accordion>

<Accordion title="Delete a batch of campaigns">
  This endpoint deletes a batch of campaigns. the maximum number of items in a batch request is 50. the response will always be 204 no content, regardless of whether the campaigns exist or not, whether they were successfully deleted or not, or if only some of the campaigns in the batch were deleted.
</Accordion>

<Accordion title="Create ticket object">
  This endpoint creates a new ticket object in the hubspot crm system. it allows you to programmatically generate support tickets with specified properties. use this endpoint when you need to create tickets automatically, such as from user submissions on your website or from internal systems. the endpoint accepts a json payload with ticket details and returns the created ticket object, including its newly assigned id. this is particularly useful for integrating external systems with hubspot's customer service workflows. note that the specific fields available for ticket creation may depend on your hubspot account configuration.
</Accordion>

<Accordion title="Create Workflow">
  Creates a new workflow in hubspot using the v4 api. workflows automate your marketing, sales, and service processes based on specific enrollment triggers. the v4 api supports various action types including: - static branch actions - list branch actions - ab test branch actions - custom code actions - webhook actions - single connection actions requirements: - scopes: automation - standard api rate limits apply
</Accordion>

<Accordion title="Delete contact for gdpr compliance">
  Permanently deletes a contact and all associated content from hubspot's crm system to comply with gdpr regulations. this endpoint should be used when a data subject exercises their right to erasure under gdpr. it provides the option to identify a contact by email address using the 'idproperty' set to 'email'. if the email address is not found, it will be added to a blocklist to prevent future use. this operation is irreversible and should be used with caution, as it will remove all data associated with the contact.
</Accordion>

<Accordion title="Delete pipeline stage by id">
  This endpoint allows you to permanently delete a specific pipeline stage within a hubspot crm pipeline. it removes the stage identified by the provided stageid from the pipeline specified by pipelineid for the given objecttype. use this endpoint when you need to remove an obsolete or unnecessary stage from your crm workflow. be cautious when using this operation, as it permanently removes the stage and cannot be undone. ensure that no active deals or records are associated with the stage before deletion to prevent data inconsistencies.
</Accordion>

<Accordion title="Fetch contact ids">
  Fetch the list of contact ids for the specified campaign and contact type
</Accordion>

<Accordion title="Retrieve line item by id">
  Retrieves detailed information about a specific line item in hubspot's crm using its unique identifier. this endpoint allows for flexible querying of line item data, including custom properties, historical values, and associated objects. it's particularly useful for accessing up-to-date information about individual products or services within a deal, supporting various use cases such as order management, inventory tracking, or sales analysis. the endpoint offers granular control over the returned data, enabling efficient and tailored data retrieval based on specific business needs.\<\<DEPRECATED use retrieve\_line\_item\_by\_id>>
</Accordion>

<Accordion title="Fetch import error details">
  Retrieves detailed error information for a specific import operation in hubspot's crm. this endpoint allows users to fetch a paginated list of errors that occurred during the import process, helping to identify and troubleshoot issues with data imports. it should be used after an import operation to check for any problems that may have arisen during the import. the tool provides specific error details, enabling users to correct their data or import process for future attempts. it does not provide information about successful imports or allow for error correction directly through the api.
</Accordion>

<Accordion title="Fetch recording settings by appid">
  Retrieves the recording settings for a specific calling extension app in the hubspot crm system. this endpoint allows developers to fetch the current configuration for call recording associated with a particular app integration. it's useful for auditing, troubleshooting, or displaying the current recording settings to users. the endpoint should be used when you need to review or verify the recording configuration for a specific app, such as before making changes or when setting up a new integration. note that this endpoint only provides read access to the settings and does not allow modifications.
</Accordion>

<Accordion title="Create product batch">
  This endpoint allows you to create multiple products in the hubspot crm simultaneously using a single api call. it's designed for efficient bulk product creation, particularly useful for e-commerce applications that need to add or update large numbers of products. the endpoint accepts a batch of product data and processes them together, returning individual results for each product in the batch. use this when you need to create multiple products at once to optimize api usage and streamline your product management workflow.
</Accordion>

<Accordion title="Fetch revenue">
  Fetch revenue attribution report data for a specified campaign
</Accordion>

<Accordion title="Delete a marketing email">
  Deletes a specific marketing email from the hubspot system. this endpoint should be used when you need to permanently remove a marketing email from your hubspot account. it's particularly useful for cleaning up outdated or unnecessary email content, or when you need to comply with data management policies. be cautious when using this endpoint, as the deletion is irreversible - once an email is deleted, it cannot be recovered. this endpoint only handles the deletion process and does not provide any information about the email being deleted or return the deleted content.
</Accordion>

<Accordion title="Get active imports list">
  Retrieves a paginated list of active imports for the hubspot account. this endpoint allows users to monitor ongoing import processes, track their status, and manage bulk data operations efficiently. it's particularly useful for checking the progress of large-scale data imports, identifying any issues, and ensuring data integrity during the import process. the endpoint returns a collection of import responses, providing detailed information about each active import job.
</Accordion>

<Accordion title="Archive batch of objects by id">
  This endpoint allows you to archive multiple crm objects of a specified type in bulk. it's designed for efficiently removing a large number of objects from active use in your hubspot crm. the archived objects are not deleted but are no longer accessible through standard crm operations. this is particularly useful for maintaining a clean and relevant database by archiving old or irrelevant records. use this endpoint when you need to archive many objects at once, such as during data cleanup operations or when removing outdated records. be cautious when using this endpoint, as archiving is a significant action that affects data accessibility and may impact related records or integrations.
</Accordion>

<Accordion title="Get All Workflows">
  Get a list of workflows for a hubspot portal. returns metadata for each workflow, useful for looking up workflows by id or displaying available workflows.
</Accordion>

<Accordion title="Archive batch of contacts by id">
  This endpoint allows you to archive multiple contacts in the hubspot crm simultaneously by providing their ids. it's particularly useful for bulk operations when you need to remove several contacts from active use in your crm. the endpoint accepts a json object containing an array of contact ids and performs the archive operation on all specified contacts. upon successful execution, the contacts will be marked as archived in the hubspot system, making them inactive and no longer visible in the main contact lists. this operation is irreversible through this api, so use it cautiously. if you need to restore archived contacts, you would need to use a separate unarchive endpoint or do it manually through the hubspot interface.
</Accordion>

<Accordion title="Create batch of contacts">
  Creates multiple contact records in hubspot's crm system in a single api call. this endpoint is designed for efficient bulk creation of contacts, making it ideal for data imports, migrations, or synchronization between systems. it allows you to create up to 100 contacts simultaneously, significantly reducing the number of api calls required for large-scale contact creation. the endpoint returns detailed information about the success or failure of each contact creation attempt, enabling easy tracking and error handling for batch operations.
</Accordion>

<Accordion title="Delete pipeline by id">
  This endpoint allows you to delete a specific pipeline in the hubspot crm system. it removes the entire pipeline structure, including all its stages, from the specified object type (e.g., deals, contacts, companies). use this endpoint when you need to remove an outdated or unnecessary pipeline from your crm workflow. be cautious when using this operation, as it permanently deletes the pipeline and cannot be undone. the endpoint provides optional validation parameters to help prevent unintended data loss or disruptions to active records.
</Accordion>

<Accordion title="Gdpr delete">
  Permanently delete a contact and all associated content to follow gdpr. use optional property 'idproperty' set to 'email' to identify contact by email address. if email address is not found, the email address will be added to a blocklist and prevent it from being used in the future.
</Accordion>

<Accordion title="Create multiple timeline events batch">
  Creates multiple timeline events in batch for hubspot's crm based on an event template. this endpoint allows for efficient creation of multiple immutable events on object timelines, with the ability to update object properties if configured in the template. use this when you need to add multiple historical or real-time events to contact, company, or deal records in hubspot. it's particularly useful for bulk imports or synchronizing events from external systems. note that once created, these events cannot be modified, so ensure accuracy before submission.
</Accordion>

<Accordion title="Delete calling extension settings">
  Deletes a specific calling extension from the hubspot crm system. this operation permanently removes the calling extension service as an option for all connected hubspot accounts. use this endpoint when you want to completely deactivate and remove a calling extension from the hubspot ecosystem. it's important to note that this action is irreversible and will affect all users who have been utilizing this calling extension. exercise caution when invoking this endpoint, as it will impact the functionality available to your hubspot users.
</Accordion>

<Accordion title="Get aggregated statistic intervals">
  Get aggregated statistics in intervals for a specified time span. each interval contains aggregated statistics of the emails that were sent in that time.
</Accordion>

<Accordion title="Create product object">
  Creates a new product object in the hubspot crm system with the specified properties. this endpoint is used to add new products to your e-commerce catalog within hubspot. it allows you to define various attributes of the product such as name, price, description, and any custom properties configured in your hubspot account. upon successful creation, the endpoint returns a copy of the created product object, including its unique id assigned by hubspot. this tool is particularly useful for integrating external e-commerce systems with hubspot or for programmatically managing your product catalog. note that this endpoint creates basic product entries and may not support complex product configurations or variants.
</Accordion>

<Accordion title="Get all marketing emails for a hubspot account">
  The results can be filtered, allowing you to find a specific set of emails. see the table below for a full list of filtering options.
</Accordion>

<Accordion title="Retrieve page of crm owners">
  This endpoint retrieves a paginated list of crm owners in hubspot. it allows you to fetch owner information with optional filtering by email address and archived status. the endpoint supports pagination for efficient data retrieval, making it ideal for applications that need to display or process owner data in manageable chunks. use this when you need to access owner information across your hubspot crm, such as for user management, reporting, or integration with other systems.\<\<DEPRECATED use retrieve\_page\_of\_crm\_owners>>
</Accordion>

<Accordion title="Get aggregated statistics">
  Use this endpoint to get aggregated statistics of emails sent in a specified time span. it also returns the list of emails that were sent during the time span.
</Accordion>

<Accordion title="Read crm contact by id">
  Retrieves detailed information about a specific hubspot crm contact using their internal object id. this endpoint allows for customized data retrieval, enabling developers to specify which properties to return, include property history, fetch associated object ids, and filter for archived contacts. it's ideal for situations where you need to access comprehensive contact information or integrate contact data into external systems. the endpoint is particularly useful for building custom crm dashboards, generating detailed contact reports, or syncing contact data with other applications.\<\<DEPRECATED use read\_crm\_contact\_by\_id>>
</Accordion>

<Accordion title="Create quote object">
  Creates a new quote object in hubspot's crm system with the provided properties. this endpoint allows you to programmatically generate quotes, which can be associated with deals, contacts, or companies in your hubspot account. it's useful for automating quote creation in sales processes or integrating quote generation with external systems. the endpoint returns a copy of the created quote object, including its newly assigned id, which can be used for further operations or reference. while this endpoint creates standard quotes, be aware that complex or highly customized quote structures may require additional setup in your hubspot account.
</Accordion>

<Accordion title="Create new object schema with custom properties">
  Creates a new custom object schema in hubspot's crm, allowing you to define tailored data structures with custom properties and associations. this endpoint is essential for businesses that need to store and manage unique data types not covered by hubspot's standard objects. use this when you need to extend your crm's capabilities to handle industry-specific or company-specific data. the response includes the complete object schema, including the newly assigned object type id, all defined properties, and associations, providing immediate confirmation and details of the created schema.
</Accordion>

<Accordion title="Create batch of deals">
  This endpoint allows for the creation of multiple deals simultaneously in hubspot's crm. it's designed for efficient bulk operations, enabling users to create a large number of deals in a single api call. this is particularly useful for integrating data from external systems, migrating deal information, or setting up initial deal pipelines in bulk. the endpoint accepts a batch of deal objects and attempts to create them all, returning detailed results for each deal creation attempt. it's important to note that this is an all-or-nothing operation for each individual deal, but not for the entire batch - some deals may be created successfully while others fail.
</Accordion>

<Accordion title="Create batch of feedback submissions">
  This endpoint allows you to create multiple feedback submissions in a single api call within hubspot's crm system. it's designed for bulk creation of feedback data, which is useful for importing large datasets or synchronizing feedback information from external systems. the endpoint accepts a batch of feedback submission objects and processes them together, returning either a successful batch response or a response with potential errors for each submission. use this endpoint when you need to efficiently create multiple feedback entries simultaneously, reducing the number of individual api calls and improving performance for large-scale data operations.
</Accordion>

<Accordion title="Create property for specified object type">
  Creates a new custom property for a specified crm object type in hubspot. this endpoint allows you to extend the data model of your crm objects by adding new fields to store additional information. use this when you need to capture custom data that isn't covered by hubspot's default properties. the new property will be available for use immediately after creation, allowing you to store and retrieve custom data for the specified object type. this operation is essential for tailoring your crm to your specific business needs and workflows.
</Accordion>

<Accordion title="Create or update draft version">
  Create or update the draft version of a marketing email. if no draft exists, the system creates a draft from the current “live” email then applies the request body to that draft. the draft version only lives on the buffer—the email is not cloned.
</Accordion>

<Accordion title="Create new deal object">
  Creates a new deal object in the hubspot crm with the provided properties. this endpoint allows you to add a new potential or closed sale to your crm, tracking important information such as deal value, stage, and associated contacts or companies. use this when you need to programmatically create deals based on user actions, integrations with other systems, or bulk imports. the endpoint returns a copy of the created deal object, including its unique id assigned by hubspot. note that while you can create a basic deal with minimal information, it's often beneficial to include as much relevant data as possible for accurate reporting and sales forecasting.
</Accordion>

<Accordion title="Get import record information">
  Retrieves a complete summary of a specific import record in the hubspot crm system, including any updates made to the record. this endpoint is useful for tracking the status and details of data imports, allowing users to monitor the progress and results of their import operations. it should be used when you need to check the current state of an import, verify its completion, or troubleshoot any issues that may have occurred during the import process. the endpoint provides comprehensive information about the import record but does not allow modifications to the import itself.
</Accordion>

<Accordion title="Merge two contacts of same type">
  This endpoint allows you to merge two contact records of the same type in hubspot's crm system. it combines the information from two separate contact entries into a single, consolidated record. this is useful for eliminating duplicate contacts and maintaining a clean, accurate database. the merge operation is irreversible, so it should be used with caution. the endpoint requires specifying which contact should be considered the primary record, and the resulting merged contact will retain this primary contact's id.
</Accordion>

<Accordion title="Permanently delete contact for gdpr compliance">
  This endpoint permanently deletes a contact and all associated content to comply with gdpr regulations. it's specifically designed for data erasure requests under gdpr. the endpoint allows for contact identification by email address using an optional 'idproperty' set to 'email'. if the email is not found, it's added to a blocklist to prevent future use. this action is irreversible and should be used with caution, only when a valid gdpr erasure request is received. it ensures complete removal of contact data, helping businesses maintain gdpr compliance.
</Accordion>

<Accordion title="Hubspot Modify Calling Extension Settings">
  Updates existing calling extension settings for a specific app in hubspot's crm system. this endpoint allows developers to modify various properties of a calling extension, such as its name, url, dimensions, and feature support flags. it should be used when changes to an existing calling extension configuration are needed, for example, to update the iframe url or adjust the display size. the endpoint requires the app id and a json object with the updated settings. it returns the modified settings upon successful update.
</Accordion>

<Accordion title="Read product by id">
  Retrieves detailed information about a specific product in the hubspot crm system. this endpoint allows you to fetch a product by its unique identifier, which can be either the internal object id or a custom unique property value. it provides flexibility in specifying which properties to return, including historical values, and can fetch associated object ids. use this endpoint when you need to access comprehensive product data, including custom properties and associations with other crm objects. it's particularly useful for e-commerce applications that need to sync product information with hubspot or display detailed product data within an integrated system.\<\<DEPRECATED use read\_product\_by\_id>>
</Accordion>

<Accordion title="Get pipeline stage audit">
  Retrieves a reverse chronological list of all mutations (changes) that have occurred on a specific pipeline stage in hubspot's crm. this endpoint is used to track the historical changes made to a pipeline stage, providing valuable insights into how the stage has evolved over time. it's particularly useful for auditing purposes, troubleshooting unexpected changes, and maintaining a comprehensive record of pipeline modifications. the endpoint requires specifying both the object type (e.g., deals, tickets) and the unique identifier of the stage, allowing for precise querying of audit information across different crm objects and pipeline stages.
</Accordion>

<Accordion title="Merge two companies of same type">
  This endpoint allows you to merge two company records of the same type in hubspot's crm system. it combines the data from two separate company entries into a single, consolidated record. this operation is useful for eliminating duplicate company entries, consolidating information from multiple sources, or cleaning up your crm database. the merge process is irreversible, so it should be used with caution and only when you are certain that the two companies are indeed duplicates or need to be combined. after the merge, the primary company record will contain the consolidated information, while the secondary company record will be removed from the crm.
</Accordion>

<Accordion title="Get draft version of a marketing email">
  Get the draft version of an email (if it exists). if no draft version exists, the published email is returned.
</Accordion>

<Accordion title="Merge two emails with same type">
  The mergecrmemails endpoint allows you to combine two email objects in the hubspot crm into a single record. this operation is useful for de-duplicating email records, consolidating information, and maintaining a clean crm database. when called, the endpoint will merge the specified secondary email object into the primary email object, retaining the primary object's id and updating it with any non-conflicting information from the secondary object. the secondary object will be deleted after the merge. this endpoint should be used cautiously, as the merge operation is irreversible. it's recommended to back up your data before performing merge operations, especially when dealing with large numbers of records or critical customer information.
</Accordion>

<Accordion title="Get a revision of a marketing email">
  Get a specific revision of a marketing email.
</Accordion>

<Accordion title="Permanently delete contact gdpr compliance">
  This endpoint permanently deletes a contact and all associated content from hubspot's crm system to comply with gdpr regulations. it's designed for use when a data subject exercises their right to be forgotten under gdpr. the endpoint can identify contacts by their email address if the optional 'idproperty' is set to 'email'. if the specified email address is not found, it will be added to a blocklist to prevent future use, enhancing data protection. this tool should be used with caution as the deletion is permanent and irreversible. it's crucial to verify the necessity and legality of the deletion before using this endpoint, as it will remove all traces of the contact from the crm.
</Accordion>

<Accordion title="Get campaign metrics">
  This endpoint retrieves key attribution metrics for a specified campaign, such as sessions, new contacts, and influenced contacts.
</Accordion>

<Accordion title="Get Marketing Emails">
  Gets all marketing emails from a hubspot account. results can be filtered using various parameters.
</Accordion>

<Accordion title="Merge two deals of same type">
  Merges two deals of the same type in hubspot's crm system. this endpoint allows you to combine information from two separate deal records into a single, consolidated deal. use this when you need to eliminate duplicate deals or combine related opportunities. the merge operation is permanent and can't be undone, so ensure you have the correct deal ids before proceeding. after merging, one deal will be designated as the primary record, retaining the most up-to-date information from both deals.
</Accordion>

<Accordion title="Partially update contact using contact id">
  This endpoint allows for partial updates to a contact in the hubspot crm using the contact's internal object id. it enables you to modify specific properties of a contact without affecting other properties not included in the update. the endpoint accepts a json object with the properties to be updated and their new values. it's particularly useful for updating individual fields of a contact record without having to send a complete contact object. note that read-only properties will be ignored, and you can clear property values by sending an empty string. this endpoint should be used when you need to make targeted updates to a contact's information without overwriting the entire record.
</Accordion>

<Accordion title="Get quote by id">
  Retrieves a specific quote from the hubspot crm by its unique identifier. this endpoint allows for detailed customization of the returned data, including specific properties, property history, and associated objects. it's particularly useful when you need to fetch comprehensive information about a single quote, including its current state, historical changes, and relationships with other crm objects. use this endpoint when you need to access or display detailed quote information in your application, or when you need to verify the current state of a quote before taking further actions.
</Accordion>

<Accordion title="Permanently delete contact for gdpr">
  This endpoint permanently deletes a contact and all associated content from the hubspot crm system to comply with gdpr regulations. it allows for the identification of contacts by email address and includes a feature to blocklist email addresses that are not found to prevent future use. this tool should be used when a data subject exercises their 'right to be forgotten' under gdpr. it's important to note that this action is irreversible and should be used with caution. the endpoint requires proper authentication and the 'crm.objects.contacts.write' scope for access.
</Accordion>

<Accordion title="Read a batch of campaigns">
  This endpoint reads a batch of campaigns based on the provided input data and returns the campaigns along with their associated assets. the maximum number of items in a batch request is 50. the campaigns in the response are not guaranteed to be in the same order as they were provided in the request. if duplicate campaign ids are provided in the request, duplicates will be ignored. the response will include only unique ids and will be returned without duplicates.
</Accordion>

<Accordion title="Read all properties for object type">
  Retrieves all existing properties for a specified object type in the hubspot crm. this endpoint is crucial for understanding the structure and available fields for different crm objects such as contacts, companies, deals, or custom objects. use this tool when you need to get a comprehensive list of properties, including both default and custom properties, for a particular object type. it's especially useful when setting up integrations, creating custom views, or preparing data imports. note that this endpoint does not return the actual values of these properties for specific records, only their definitions and metadata.\<\<DEPRECATED use read\_all\_properties\_for\_object\_type>>
</Accordion>

<Accordion title="Read budget">
  Retrieve detailed information about the budget and spend items for a specified campaign, including the total budget, total spend, and remaining budget. budget and spend items may be returned in any order, but the order field specifies their sequence based on the creation date. the item with order 0 is the oldest, and items with higher order values are newer
</Accordion>

<Accordion title="Hubspot List">
  Read a page of emails. control what is returned via the `properties` query param.
</Accordion>

<Accordion title="Read batch feedback submissions by id or property">
  This endpoint allows you to retrieve multiple feedback submissions in a single request, enabling efficient data retrieval for large datasets. it supports fetching up to 100 feedback submissions by their ids or specific properties. use this endpoint when you need to bulk retrieve feedback data, such as survey responses, ratings, or comments, along with associated contact information. the endpoint is particularly useful for analyzing feedback trends or updating your crm with the latest customer insights.
</Accordion>

<Accordion title="Read batch of crm objects by id or property values">
  This endpoint enables batch reading of crm objects in hubspot by their ids or property values. it supports retrieving multiple objects of a specified type (e.g., contacts, companies, deals) in a single api call, improving efficiency for bulk data retrieval operations. the endpoint allows filtering for archived objects and requires a request body specifying the objects to be fetched. it's particularly useful for synchronizing large datasets or performing bulk operations on crm data.
</Accordion>

<Accordion title="Permanently delete contact via gdpr">
  This endpoint permanently deletes a contact and all associated content to comply with gdpr regulations. it allows for the complete removal of a contact's data from the hubspot crm, ensuring privacy and data protection compliance. the tool provides an option to identify contacts by email address and includes a blocklist feature to prevent future use of deleted email addresses. use this endpoint when a user requests the deletion of their personal data or when you need to remove contact information to maintain gdpr compliance.
</Accordion>

<Accordion title="Permanently delete deal for gdpr compliance">
  This endpoint permanently deletes a deal and all associated content from hubspot's crm for gdpr compliance purposes. it's designed to help businesses adhere to the general data protection regulation (gdpr) by allowing the complete removal of deal data upon request. the endpoint can identify deals by email address if the optional 'idproperty' is set to 'email'. if the specified email address is not found, it will be added to a blocklist to prevent future use. this operation is irreversible and should be used with caution, only when gdpr compliance requires the permanent removal of deal data.
</Accordion>

<Accordion title="Read a property group">
  Retrieves detailed information about a specific property group for a given crm object type in hubspot. this endpoint allows developers to access the structure and attributes of property groups, which are collections of related properties within the crm system. use this tool when you need to understand the organization of properties for a particular object type or when working with custom property groups. it provides essential metadata about the group but does not return the actual property values for crm objects.
</Accordion>

<Accordion title="Read a batch of crm object properties">
  Retrieves a batch of crm object properties for a specified object type in hubspot. this endpoint allows you to efficiently read multiple properties in a single api call, reducing the number of requests needed for bulk data retrieval. it's particularly useful when you need to fetch various attributes for multiple objects of the same type, such as contacts, companies, or deals. the endpoint supports partial success, returning data for successfully processed properties while providing error information for any failed requests within the batch.
</Accordion>

<Accordion title="Read all properties for object type">
  Retrieves all existing properties for a specified object type in the hubspot crm. this endpoint is crucial for understanding the structure and available fields for different crm objects such as contacts, companies, deals, or custom objects. use this tool when you need to get a comprehensive list of properties, including both default and custom properties, for a particular object type. it's especially useful when setting up integrations, creating custom views, or preparing data imports. note that this endpoint does not return the actual values of these properties for specific records, only their definitions and metadata.
</Accordion>

<Accordion title="Read batch of products by id or property">
  This endpoint allows you to read a batch of products by their ids or properties from the hubspot crm. it's particularly useful for retrieving information about multiple products simultaneously, improving efficiency when dealing with large datasets. the endpoint supports optional filtering for archived products and provides detailed responses, including potential errors for each product in the batch.
</Accordion>

<Accordion title="Read a crm property by name">
  This endpoint retrieves detailed information about a specific crm property for a given object type in hubspot. it allows users to access custom fields and data associated with various crm objects such as deals, contacts, or companies. the endpoint is particularly useful when you need to verify the configuration, datatype, or other metadata of a specific property. it should be used when detailed property information is required, but not for bulk property retrieval or creating/updating properties.\<\<DEPRECATED use read\_a\_crm\_property\_by\_name>>
</Accordion>

<Accordion title="Read batch of line items by id or property values">
  This endpoint allows you to retrieve multiple line items from hubspot's crm in a single api call. it accepts a batch of line item identifiers or property values and returns the corresponding line item details. this is particularly useful for efficiently fetching data for multiple line items simultaneously, reducing the number of api calls needed. the endpoint can optionally filter results to include only archived items. it's important to note that partial success is possible, where some line items may be successfully retrieved while others fail. error handling is provided for failed operations within the batch.
</Accordion>

<Accordion title="Read batch of tickets by id or unique values">
  This endpoint allows you to retrieve multiple tickets from hubspot's crm system in a single api call. it's designed for efficient bulk retrieval of ticket data, which is particularly useful for synchronization tasks, reporting, or updating local databases. the endpoint accepts a list of ticket identifiers (either ids or unique property values) and returns the corresponding ticket objects with their properties. it can handle both fully successful operations and partial successes, providing detailed error information for any tickets that couldn't be retrieved. use this endpoint when you need to fetch data for multiple tickets simultaneously, reducing the number of api calls and improving performance for bulk operations.
</Accordion>

<Accordion title="Read batch of contacts by id or properties">
  This endpoint allows for batch reading of contact records in the hubspot crm by their ids or specific properties. it's designed for efficiently retrieving data for multiple contacts in a single api call, which is particularly useful when dealing with large datasets or when you need to update your local database with the latest contact information from hubspot. the endpoint supports filtering for archived contacts and allows you to specify which properties you want to retrieve for each contact, providing flexibility and optimizing data transfer. it's important to note that this endpoint may return partial results if some contacts can't be processed, so be prepared to handle both fully successful responses and responses with errors for individual contacts.
</Accordion>

<Accordion title="Merge two feedback submissions">
  This endpoint allows you to merge two existing feedback submissions in hubspot's crm system. it combines the data from two separate feedback submissions into a single record, which can be useful for consolidating duplicate entries or combining related feedback from the same customer. the merged result will contain information from both original submissions, with one submission typically taking precedence for overlapping fields. use this endpoint when you need to clean up your feedback data or combine information from multiple submissions. note that this operation is irreversible, so it's important to ensure you want to permanently combine the selected feedback submissions before making the api call. the endpoint returns the merged feedback submission object upon successful completion.
</Accordion>

<Accordion title="Read property groups for object type">
  Retrieves all existing property groups for a specified crm object type in your hubspot account. this endpoint is useful for understanding how properties are organized within your crm, which can aid in data management and reporting. it should be used when you need an overview of the property structure for a particular object type, such as contacts or companies. the endpoint returns a collection of property groups without pagination, providing a complete list in a single request. note that this endpoint only returns the groups themselves, not the individual properties within each group.\<\<DEPRECATED use read\_property\_groups\_for\_object\_type>>
</Accordion>

<Accordion title="List all event templates for app">
  This endpoint retrieves a comprehensive list of all event templates associated with a specific app in hubspot's crm timeline. it allows developers to access detailed information about each template, including their structure, associated object types, and custom tokens. use this endpoint when you need to review, audit, or manage the event templates created for your hubspot app. it's particularly useful for understanding the current configuration of your app's timeline events or preparing for updates to existing templates. the endpoint returns a collection of template objects, providing a complete overview of how timeline events are structured for the specified app.
</Accordion>

<Accordion title="Read crm object by id">
  This endpoint retrieves detailed information about a specific crm object in hubspot by its unique identifier. it allows for flexible querying of various object types (such as contacts, companies, or deals) and provides granular control over the returned data. use this endpoint when you need to fetch comprehensive details about a single crm object, including its properties, historical changes, and associated entities. it's particularly useful for displaying detailed views of crm records, tracking changes over time, or gathering related data across different object types in a single api call. the endpoint supports customization of the response through optional parameters, enabling efficient data retrieval tailored to specific needs.
</Accordion>

<Accordion title="Read crm contact by id">
  Retrieves detailed information about a specific hubspot crm contact using their internal object id. this endpoint allows for customized data retrieval, enabling developers to specify which properties to return, include property history, fetch associated object ids, and filter for archived contacts. it's ideal for situations where you need to access comprehensive contact information or integrate contact data into external systems. the endpoint is particularly useful for building custom crm dashboards, generating detailed contact reports, or syncing contact data with other applications.
</Accordion>

<Accordion title="Permanently delete line items for gdpr">
  This endpoint permanently deletes line items and all associated content to comply with gdpr regulations. it's designed for situations where a complete erasure of customer data is required, such as when a customer exercises their "right to be forgotten". the deletion is irreversible, ensuring that all traces of the specified line items are removed from the system. additionally, it offers the option to identify contacts by email address, adding unmatched emails to a blocklist to prevent future use. use this endpoint with caution, as it permanently removes data and cannot be undone.
</Accordion>

<Accordion title="Read feedback submission by id">
  Retrieves a specific feedback submission object from hubspot's crm system using its unique identifier. this endpoint allows for customized data retrieval, including specific properties, property history, and associated object ids. it's particularly useful when you need detailed information about a single feedback submission, such as its content, sentiment, or related data. the tool provides flexibility in how the object is identified and what data is returned, making it valuable for various use cases from basic retrieval to complex data analysis.
</Accordion>

<Accordion title="List assets">
  This endpoint lists all assets of the campaign by asset type. the assettype parameter is required, and each request can only fetch assets of a single type. asset metrics can also be fetched along with the assets; they are available only if start and end dates are provided.
</Accordion>

<Accordion title="Archive contact by id">
  Archives a contact in the hubspot crm by moving it to the recycling bin. this endpoint should be used when you need to remove a contact from active use in your crm. the operation is irreversible through the api, so use it with caution. once archived, the contact will no longer appear in standard contact lists or searches. this endpoint is useful for data cleanup or when a contact is no longer relevant to your business operations.\<\<DEPRECATED use archive\_contact\_by\_id>>
</Accordion>

<Accordion title="Partially update crm object by id">
  Partially updates a crm object in hubspot by its object type and id. this endpoint allows you to modify specific properties of various crm object types (such as contacts, deals, companies, or quotes) without affecting unspecified fields. it's ideal for updating only necessary information, improving efficiency in data management. the endpoint supports using either the internal object id or a unique property value for object identification, offering flexibility in how you reference your crm data.
</Accordion>

<Accordion title="Partially update deal by id">
  This endpoint allows you to perform a partial update on a specific deal in hubspot's crm system. it's useful when you need to modify only certain properties of a deal without affecting the entire object. the endpoint accepts the deal's unique identifier and a set of properties to update, making it efficient for targeted changes. it's particularly valuable for integrations that need to sync specific deal information from external systems or update deal progress without overwriting unrelated data.
</Accordion>

<Accordion title="Read property groups for object type">
  Retrieves all existing property groups for a specified crm object type in your hubspot account. this endpoint is useful for understanding how properties are organized within your crm, which can aid in data management and reporting. it should be used when you need an overview of the property structure for a particular object type, such as contacts or companies. the endpoint returns a collection of property groups without pagination, providing a complete list in a single request. note that this endpoint only returns the groups themselves, not the individual properties within each group.
</Accordion>

<Accordion title="Remove token from event template">
  This endpoint removes a specified token from an existing event template in hubspot's crm system. it's used to update event templates by removing outdated or unnecessary tokens, ensuring that new events created from the template no longer include the removed token. while this action doesn't affect existing events or crm objects, it impacts the creation of new events and the display of information in the timeline for newer crm objects. use this endpoint when you need to modify an event template's structure by removing a specific token, but be aware that it may affect related lists, reports, and timeline displays for newer data.
</Accordion>

<Accordion title="Read product by id">
  Retrieves detailed information about a specific product in the hubspot crm system. this endpoint allows you to fetch a product by its unique identifier, which can be either the internal object id or a custom unique property value. it provides flexibility in specifying which properties to return, including historical values, and can fetch associated object ids. use this endpoint when you need to access comprehensive product data, including custom properties and associations with other crm objects. it's particularly useful for e-commerce applications that need to sync product information with hubspot or display detailed product data within an integrated system.
</Accordion>

<Accordion title="Permanently delete gdpr contact and content">
  Permanently deletes a contact and all associated content from hubspot to comply with gdpr regulations. this endpoint should be used when a user requests complete removal of their data under gdpr. it offers the option to identify contacts by email address and includes a feature to blocklist email addresses for future use. this operation is irreversible and should be used with caution, as it permanently removes all data associated with the contact.
</Accordion>

<Accordion title="List association types">
  List all the valid association types available between two object types
</Accordion>

<Accordion title="Remove asset association">
  Disassociate a specified asset from a campaign. important: currently, only the following asset types can be associated and disassociated via the api: forms, static lists, external website pages
</Accordion>

<Accordion title="Remove association from schema">
  Removes an existing association from a schema in hubspot's crm. this endpoint allows you to modify the structure of your custom objects by deleting specific relationships between objects. use this when you need to update your crm's data model by removing outdated or unnecessary associations. it's particularly useful when restructuring your crm to reflect changes in your business processes or data requirements. the operation is irreversible, so use it with caution to avoid unintended data relationship loss.
</Accordion>

<Accordion title="Remove deal object by id">
  This endpoint allows you to remove a specific deal object from the hubspot crm by moving it to the recycling bin. it's used when you need to delete a deal that is no longer relevant or was created in error. the operation is permanent and should be used with caution. once a deal is moved to the recycling bin, it will no longer appear in active deal lists or reports. this endpoint is particularly useful for maintaining a clean and accurate sales pipeline in your crm.
</Accordion>

<Accordion title="Partially update pipeline by id">
  This endpoint allows you to partially update an existing pipeline in hubspot's crm system. it's used to modify specific attributes of a pipeline without replacing the entire object. you can update various aspects of the pipeline, such as its stages, display order, or active status. this operation is useful when you need to make incremental changes to a pipeline without affecting its entire structure or unspecified fields. the endpoint returns the fully updated pipeline object, reflecting all changes made.
</Accordion>

<Accordion title="Publish or Send Marketing Email">
  Publishes or sends a marketing email in hubspot. requires marketing hub enterprise account or transactional email add-on.
</Accordion>

<Accordion title="Partially update property group">
  This endpoint allows for partial updates to a specific property group within hubspot's crm. it enables you to modify existing property groups for various crm object types like contacts, companies, deals, or tickets. the endpoint is particularly useful when you need to make targeted changes to a property group without affecting its entire configuration. it accepts a json payload with the fields to be updated and returns the modified property group. this tool should be used when reorganizing or refining your crm's data structure, but care should be taken as changes may affect how data is displayed and organized in the hubspot interface.
</Accordion>

<Accordion title="Render event header or detail as html">
  This endpoint renders either the headertemplate or detailtemplate from a specified event template as html for a given event in hubspot's crm timeline. it processes the template using handlebars and markdown, incorporating event data to generate the final html output. the endpoint is useful for displaying event information in a formatted and visually appealing manner within your application or integration. it's particularly valuable when you need to present event details in a consistent, templated format across different events. note that if the template references extradata that isn't found in the event, those references will be ignored during rendering.
</Accordion>

<Accordion title="Hubspot Render Event Detail Template">
  Retrieves and renders the detailed information for a specific event using its associated event template. this endpoint takes an event template id and an event id to generate a formatted representation of the event details. it's particularly useful when you need to display comprehensive, structured information about a single event in the hubspot crm timeline. the endpoint ignores any extradata references in the template that are not present in the actual event data, ensuring a consistent output even with incomplete data. use this when you need to present event details in a user-friendly, formatted manner, especially in interfaces or reports that require a standardized event detail view.
</Accordion>

<Accordion title="Reset draft">
  Resets the draft back to a copy of the live object.
</Accordion>

<Accordion title="Replace pipeline stage properties">
  This endpoint allows you to completely replace all properties of an existing pipeline stage in hubspot's crm. it's used to update stage details such as the label, display order, or any custom properties within a specific pipeline for various crm object types (deals, tickets, contacts, or companies). the operation requires the object type, pipeline id, and stage id to target the correct stage, along with a request body containing the new stage properties. use this endpoint when you need to make comprehensive changes to a stage's configuration. it returns the updated stage object, reflecting all changes made.
</Accordion>

<Accordion title="List contacts page">
  This endpoint retrieves a paginated list of contacts from the hubspot crm. it allows for flexible querying with options to specify the number of results per page, filter properties, include historical property values, and fetch associated object ids. the endpoint is ideal for tasks such as synchronizing contact data with external systems, generating reports, or displaying contact information in a user interface. it supports pagination for handling large datasets efficiently and provides fine-grained control over the data returned for each contact.
</Accordion>

<Accordion title="Purge schema by object type">
  Purges (permanently deletes) a schema associated with a specific object type in hubspot's crm. this endpoint should be used when you need to completely remove a custom schema definition for an object type, such as when cleaning up unused or outdated schemas. it's important to note that this action is irreversible and may have significant implications on data integrity and related operations. use this endpoint with extreme caution, as it will permanently delete the schema and potentially affect any data or processes relying on it. this endpoint is deprecated, which means it may be removed in future versions of the api, and alternative methods should be considered for managing schemas.
</Accordion>

<Accordion title="List feedback submissions page">
  Retrieves a paginated list of feedback submissions from hubspot surveys. this endpoint allows you to fetch feedback data with customizable property selection, association retrieval, and filtering options. use this when you need to analyze customer feedback, track survey responses, or integrate feedback data into your applications. the endpoint supports pagination for handling large datasets and provides options to retrieve both current and historical property values.
</Accordion>

<Accordion title="Restore a revision of a marketing email to draft state">
  Restores a previous revision of a marketing email to draft state. if there is currently something in the draft for that object, it is overwritten.
</Accordion>

<Accordion title="Retrieve all pipelines for specified object type">
  Retrieves all pipelines for a specified object type in hubspot's crm system. this endpoint allows users to fetch the complete set of pipelines associated with a particular crm object, such as deals or tickets. it's essential for understanding the workflow stages and organization of different object types within a hubspot account. use this endpoint when you need a comprehensive view of how a specific object type is managed through various stages in the crm.
</Accordion>

<Accordion title="Restore a revision of a marketing email">
  Restores a previous revision of a marketing email. the current revision becomes old, and the restored revision is given a new version number.
</Accordion>

<Accordion title="Retrieve all pipelines for specified object type">
  Retrieves all pipelines for a specified object type in hubspot's crm system. this endpoint allows users to fetch the complete set of pipelines associated with a particular crm object, such as deals or tickets. it's essential for understanding the workflow stages and organization of different object types within a hubspot account. use this endpoint when you need a comprehensive view of how a specific object type is managed through various stages in the crm.\<\<DEPRECATED use retrieve\_all\_pipelines\_for\_specified\_object\_type>>
</Accordion>

<Accordion title="Hubspot Retrieve Batch Of Deals By Ids Or Property Values">
  This endpoint allows for batch retrieval of multiple deals from hubspot's crm by their ids or specific property values. it's designed for efficient querying of deal data when you need to fetch information about multiple deals simultaneously. the endpoint can return both active and archived deals, depending on the 'archived' parameter. it's particularly useful for synchronizing deal data with external systems, generating reports, or updating dashboards with current deal information. note that this endpoint requires appropriate authentication and is subject to hubspot's api rate limits.
</Accordion>

<Accordion title="Retrieve all object schemas">
  Retrieves all object schemas that have been defined for your hubspot account. this endpoint is essential for developers working with custom objects and integrating with hubspot's crm. it returns a comprehensive list of schema definitions, including both standard and custom objects, providing crucial information about the structure and properties of each object type in your account. use this endpoint when you need to understand the data model of your hubspot instance, plan integrations, or work with custom objects. it's particularly useful for applications that need to dynamically adapt to changes in your hubspot data structure. note that this endpoint does not provide the actual data of the objects, only their schema definitions.
</Accordion>

<Accordion title="Retrieve calling settings for app">
  Retrieves the calling extension settings configured for a specific app in hubspot's crm system. this endpoint allows developers to access important configuration details such as the app's name, iframe url, dimensions, readiness status, and support for custom objects. use this endpoint when you need to verify or display the current calling settings for your app within hubspot. it's particularly useful for troubleshooting, auditing configurations, or retrieving settings before making updates. the endpoint returns a comprehensive set of settings but does not allow for modifying these settings directly.
</Accordion>

<Accordion title="Retrieve deal by id">
  This endpoint retrieves detailed information about a specific deal in hubspot's crm system using its unique identifier. it allows for customizable data retrieval, including specific properties, historical values, and associated objects. use this endpoint when you need comprehensive information about a particular deal, such as its current status, property values, or related entities. the tool is particularly useful for getting up-to-date deal information for sales analysis, customer relationship management, or integration with other systems. note that while it offers extensive customization options, it only returns data for a single deal at a time.
</Accordion>

<Accordion title="Retrieve existing object schema">
  Retrieves the schema definition for an existing object in hubspot's crm. this endpoint allows developers to fetch detailed information about the structure, properties, and associations of a specific crm object type. it's particularly useful when working with custom objects or when you need to understand the data model of standard hubspot objects. use this endpoint when you need to inspect the fields, data types, and relationships of a crm object before performing operations on it. note that this endpoint only retrieves existing schemas and cannot be used to create or modify object schemas.
</Accordion>

<Accordion title="Retrieve company object by id">
  Retrieves a specific company object from hubspot's crm by its internal id or a unique property value. this endpoint allows you to fetch detailed information about a company, including selected properties, property history, and associated object ids. use this when you need to access comprehensive data about a particular company in your hubspot crm. the tool provides flexibility in specifying which properties to return and can include archived companies if needed. it's particularly useful for gathering up-to-date company information for crm synchronization, reporting, or displaying detailed company profiles in your application.
</Accordion>

<Accordion title="List page of tickets">
  This endpoint retrieves a paginated list of tickets from the hubspot crm, allowing for customized data retrieval and filtering. it's designed for querying ticket data with flexible property selection, historical data retrieval, and association mapping. the endpoint supports pagination for handling large datasets efficiently and provides options for including archived tickets. use this when you need to fetch ticket data for reporting, analysis, or synchronization with other systems. it's particularly useful for building custom dashboards, generating reports, or integrating hubspot ticket data with external customer support tools. note that the amount of data returned can be significant, especially when using the propertieswithhistory parameter, which may impact the maximum number of tickets retrievable in a single request.
</Accordion>

<Accordion title="Replace all properties of pipeline">
  Replaces all properties of an existing pipeline in hubspot's crm system with the provided values. this operation overwrites any existing pipeline stages and returns the updated pipeline in the response. it allows for complete customization of pipeline properties and stages for different crm object types such as deals, tickets, or contacts. use this endpoint when you need to perform a full update of a pipeline's structure and properties, rather than making incremental changes.
</Accordion>

<Accordion title="Partially update ticket by id">
  This endpoint allows for partial updates to a hubspot ticket identified by its unique id. it enables you to modify specific properties of a ticket object without affecting the entire record, making it ideal for targeted updates to customer support issues. the endpoint accepts a json object containing only the properties you wish to update, ignoring read-only and non-existent fields. use this when you need to make selective changes to a ticket, such as updating its status, priority, or any custom fields. note that you can clear property values by passing an empty string, and the endpoint provides flexibility in identifying tickets through either their internal id or a custom unique property.
</Accordion>

<Accordion title="Read a campaign">
  Get a campaign identified by a specific campaignguid with the given properties. along with the campaign information, it also returns information about assets. depending on the query parameters used, this can also be used to return information about the corresponding assets' metrics. metrics are available only if startdate and enddate are provided.
</Accordion>

<Accordion title="Read a crm property by name">
  This endpoint retrieves detailed information about a specific crm property for a given object type in hubspot. it allows users to access custom fields and data associated with various crm objects such as deals, contacts, or companies. the endpoint is particularly useful when you need to verify the configuration, datatype, or other metadata of a specific property. it should be used when detailed property information is required, but not for bulk property retrieval or creating/updating properties.
</Accordion>

<Accordion title="List products with paging">
  Retrieves a paginated list of products from the hubspot crm, allowing for customizable property selection and association retrieval. this endpoint is ideal for applications that need to display or process product information in batches, such as inventory management systems or e-commerce integrations. it supports filtering for archived products and can return the history of property values, making it useful for tracking changes over time. the endpoint's paging mechanism enables efficient handling of large product catalogs, ensuring optimal performance for applications dealing with extensive product data.
</Accordion>

<Accordion title="Partial update company object by id">
  This endpoint allows for partial updates to a company object in hubspot's crm. it enables you to modify specific properties of a company without affecting other properties. the endpoint is particularly useful when you need to update one or more fields of a company record without having to provide all the company data. it supports identifying the company by its internal id or any unique property, and allows clearing of property values by passing empty strings. read-only and non-existent properties in the request will be ignored, ensuring safe updates.
</Accordion>

<Accordion title="Read a batch of emails by internal id or unique property values">
  The batchreademails endpoint allows for efficient retrieval of multiple email objects and their properties from hubspot's crm in a single api call. this endpoint is particularly useful when you need to fetch data for numerous emails simultaneously, reducing the number of individual api requests and improving performance. it provides flexibility in selecting which properties to retrieve, including the option to fetch historical data for specific properties. use this endpoint when you need to bulk retrieve email data, such as for reporting, data synchronization, or populating a custom interface with email information from hubspot. note that this endpoint is designed for reading data only and cannot be used for updating or creating email objects.
</Accordion>

<Accordion title="Partial update quote by quote id">
  Performs a partial update on a specific quote object in the hubspot crm. this endpoint allows you to modify individual properties of an existing quote without affecting other properties not included in the update. it's particularly useful for making targeted changes to quote information, such as updating the status, amount, or any custom properties associated with the quote. the endpoint supports identification of quotes either by their internal hubspot id or by a unique custom property, providing flexibility in how you reference and update quote objects in your integration.
</Accordion>

<Accordion title="Merge two quotes of same type">
  Merges two quotes of the same type in hubspot's crm system. this endpoint allows you to consolidate multiple quotes into a single quote, streamlining the sales process and simplifying quote management. use this when you need to combine information from two separate quotes, such as when updating a customer's quote with new line items or terms. the operation is irreversible, so it should be used with caution. the merged quote will contain combined information from both source quotes, with the primary quote's properties taking precedence in case of conflicts.
</Accordion>

<Accordion title="List quotes page">
  Retrieves a paginated list of quotes from the hubspot crm. this endpoint allows you to fetch quote data with customizable property selection, making it ideal for applications that need to display or process quote information. use this when you need to list multiple quotes, such as in a dashboard or report. the endpoint supports pagination, property filtering, and association retrieval, enabling efficient data fetching for large datasets. it's particularly useful for integrations that need to sync quote data or for building custom quote management interfaces.
</Accordion>

<Accordion title="Merge two products of the same type">
  This endpoint allows you to merge two products of the same type in the hubspot crm system. it combines the information from two separate product entries into a single, unified product entry. this is useful for consolidating duplicate product records, combining variants of a product, or updating product information across your e-commerce catalog. the merge operation is performed by sending a post request with the necessary merge details in the request body. upon successful execution, the api returns the merged product object. it's important to note that this operation is irreversible, so care should be taken to ensure the correct products are being merged. this endpoint should only be used when you are certain that two products need to be combined and you have the necessary permissions to modify product data in your hubspot account.
</Accordion>

<Accordion title="Read batch of quotes by property values">
  Retrieves a batch of quotes from hubspot's crm based on specified property values or ids. this endpoint allows for efficient bulk retrieval of quote data, making it ideal for synchronizing large datasets or performing mass updates. it supports filtering by various quote properties and can optionally include archived quotes. the response provides detailed information about each retrieved quote, including all associated properties and values. use this endpoint when you need to fetch multiple quotes simultaneously, reducing the number of api calls required for large-scale operations.
</Accordion>

<Accordion title="Merge two tickets of same type">
  Merges two tickets of the same type in hubspot's crm system. this endpoint allows you to combine duplicate or related support issues into a single ticket, streamlining your customer support workflow. use this when you need to consolidate information from two separate tickets into one comprehensive record. the merged ticket will contain data from both original tickets, but only one will remain active in the system.
</Accordion>

<Accordion title="Get the details of a specified marketing email">
  Get the details for a marketing email.
</Accordion>

<Accordion title="Get Workflow by ID">
  Returns metadata for a specific workflow, including the starting conditions and workflow steps. workflow ids can be found by using the get all workflows endpoint. note: when using this api, only certain actions are supported. if unsupported actions are included, the action type returned will be unsupported action.
</Accordion>

<Accordion title="Read a page of deals">
  Retrieves a paginated list of deals from the hubspot crm system. this endpoint allows for customizable data retrieval by specifying which properties and associations to include in the response. it supports efficient handling of large datasets through cursor-based pagination. use this endpoint when you need to fetch deal information in bulk, such as for reporting, data synchronization, or displaying deal lists in your application. the endpoint provides flexibility in filtering archived deals and retrieving historical property values, making it suitable for various crm data management tasks.
</Accordion>

<Accordion title="Permanently delete company for gdpr compliance">
  Permanently deletes a company record and all associated content from hubspot's crm system to comply with gdpr regulations. this endpoint should be used when a company exercises their right to be forgotten under gdpr. it permanently removes all data related to the specified company, including associated contacts, deals, and other records. use with caution as this action is irreversible and will result in complete data loss for the specified company.
</Accordion>

<Accordion title="Hubspot Read Apage Of Objects By Type">
  This endpoint retrieves a paginated list of crm objects of a specified type from hubspot, with customizable property and association data. it allows for efficient querying of large datasets by supporting pagination, property filtering, and inclusion of associated object information. the endpoint is versatile, supporting various object types and enabling the retrieval of both current and historical property values. it's particularly useful for bulk data retrieval, data synchronization, and building comprehensive views of crm data including related entities.
</Accordion>

<Accordion title="Get specific event template for app">
  Retrieves detailed information about a specific event template for a given app in hubspot's crm timeline feature. this endpoint allows developers to view the current state of an event template, including its configuration and associated tokens. it's particularly useful when you need to inspect or verify the structure of an existing template before creating or updating timeline events. the endpoint returns comprehensive data about the template, including its name, header and detail templates, and any custom tokens defined for the template.
</Accordion>

<Accordion title="Get Workflow Email Campaigns">
  Retrieve emails sent by a workflow by id. returns information about email campaigns associated with the specified workflow.
</Accordion>

<Accordion title="Get revisions of a marketing email">
  Get a list of all versions of a marketing email, with each entry including the full state of that particular version. the current revision has the id -1.
</Accordion>

<Accordion title="Create company object">
  Creates a new company object in the hubspot crm with the provided properties. this endpoint allows you to add a new company to your crm database, including custom fields and properties specific to your hubspot account configuration. upon successful creation, it returns a copy of the newly created company object, including its unique id assigned by hubspot. use this endpoint when you need to programmatically add new companies to your crm, such as when integrating with other systems or automating company record creation. note that the specific properties available for a company may vary based on your hubspot account setup and any custom properties you've defined.\<\<DEPRECATED use create\_company\_object>>
</Accordion>

<Accordion title="Get the variation of a an a b marketing email">
  This endpoint lets you obtain the variation of an a/b marketing email. if the email is variation a (master) it will return variation b (variant) and vice versa.
</Accordion>

<Accordion title="Hubspot Read An Owner By Given Id Or User Id">
  Retrieves detailed information about a specific owner in the hubspot crm system. this endpoint allows you to fetch owner data using either their unique owner id or user id. it's particularly useful when you need to access an owner's profile, such as their name, email, or other associated details. the endpoint can retrieve both active and archived owners, making it versatile for various use cases including user management, audit trails, or data synchronization between systems. note that this endpoint focuses on individual owner retrieval and does not support bulk operations or modifications to owner data.\<\<DEPRECATED use retrieve\_owner\_by\_id\_or\_user\_id>>
</Accordion>

<Accordion title="Merge two line items of same type">
  Merges two line items of the same type in hubspot's crm. this endpoint allows you to combine duplicate or related line items, consolidating their information into a single record. use this when you need to clean up redundant data, combine similar items, or streamline your sales records. the merged result will contain the combined data from both original line items, with one item designated as the primary record. note that this operation is irreversible, so it should be used with caution and proper validation to ensure the correct items are being merged.
</Accordion>

<Accordion title="Merge two objects of same type">
  Merges two objects of the same type within the hubspot crm. this endpoint allows you to combine data from two separate objects into a single, unified object. use this when you need to consolidate duplicate records or combine information from multiple sources. the merge operation is permanent and cannot be undone, so ensure you have backups or are certain about the merge before proceeding. this tool is particularly useful for data cleansing and maintaining a single source of truth in your crm.
</Accordion>

<Accordion title="Initiate data import process">
  Initiates a data import process in hubspot's crm system. this endpoint allows you to upload one or more files containing data and start the import process to create or update crm objects such as contacts, companies, or deals. it converts rows in the uploaded files to objects in the crm based on the mapping specified in the import request. use this endpoint when you need to bulk import or update data in your hubspot crm. the import process is asynchronous, so this call starts the process but doesn't wait for it to complete. you'll need to use separate endpoints to check the status of the import job. be cautious when using this endpoint, as it can potentially create or modify large amounts of data in your crm.
</Accordion>

<Accordion title="Retrieve line item by id">
  Retrieves detailed information about a specific line item in hubspot's crm using its unique identifier. this endpoint allows for flexible querying of line item data, including custom properties, historical values, and associated objects. it's particularly useful for accessing up-to-date information about individual products or services within a deal, supporting various use cases such as order management, inventory tracking, or sales analysis. the endpoint offers granular control over the returned data, enabling efficient and tailored data retrieval based on specific business needs.
</Accordion>

<Accordion title="Return pipeline by id">
  Retrieves a specific pipeline object from the hubspot crm system using its unique identifier. this endpoint allows you to fetch detailed information about a single pipeline, including its stages and properties, for a particular crm object type such as deals or tickets. use this when you need to access or review the configuration of a specific pipeline within your hubspot account. the endpoint is particularly useful for understanding the structure of your sales or support processes as defined in hubspot.
</Accordion>

<Accordion title="Retrieve page of crm owners">
  This endpoint retrieves a paginated list of crm owners in hubspot. it allows you to fetch owner information with optional filtering by email address and archived status. the endpoint supports pagination for efficient data retrieval, making it ideal for applications that need to display or process owner data in manageable chunks. use this when you need to access owner information across your hubspot crm, such as for user management, reporting, or integration with other systems.
</Accordion>

<Accordion title="Update token on event template">
  Updates an existing token on a hubspot crm event template. this endpoint allows you to modify token properties such as label and options, but does not permit changes to the token's name or type. use this when you need to refine or adjust the details of a token within an event template, such as updating labels or modifying enumeration options. this operation is crucial for maintaining and evolving your custom event templates in the hubspot crm timeline without creating new tokens or altering the fundamental structure of existing ones.
</Accordion>

<Accordion title="Search quotes by criteria">
  This endpoint allows you to search for quotes in the hubspot crm based on specified criteria. it provides a flexible way to filter and retrieve quote data, enabling you to find specific quotes or groups of quotes that match your requirements. the search functionality supports complex queries with multiple filter groups and sorting options. use this endpoint when you need to locate quotes based on custom criteria, such as date ranges, amounts, or associated deals. the search results include a collection of quote objects along with pagination information for handling large result sets. note that while this endpoint is powerful, it requires a well-structured request body to function effectively, and the search is limited to the quotes scope within the crm.
</Accordion>

<Accordion title="Search tickets by criteria">
  This endpoint allows you to search for tickets in hubspot's crm system based on specific criteria. it's designed for retrieving targeted sets of ticket records that match your search parameters. the search is performed using a post request with a json body containing your search criteria, filters, and sorting preferences. this endpoint is particularly useful when you need to find tickets matching complex conditions or when you want to implement custom ticket views or reports in your application. note that while this endpoint has a rate limit exemption, it's still important to use it judiciously to avoid overwhelming the system with frequent, large-scale searches.
</Accordion>

<Accordion title="Update calling app recording settings">
  This endpoint allows you to update the recording settings for a specific calling app integrated with hubspot's crm. it enables you to modify how call recordings are handled and stored for the specified app. use this endpoint when you need to change recording configurations, such as enabling/disabling recording, setting storage options, or updating compliance settings. this operation directly affects how calls are recorded and managed within the hubspot ecosystem for the given app, so use it cautiously and ensure you understand the implications of the changes.
</Accordion>

<Accordion title="Retrieve pipeline stages">
  Retrieves all stages associated with a specific pipeline in hubspot's crm. this endpoint allows users to fetch the complete structure of a pipeline, including all its stages, for a given object type (such as deals, contacts, or companies). it's essential for understanding the progression of items through a sales or business process. use this endpoint when you need to analyze or display the full pipeline structure, or when implementing logic that depends on stage progression.
</Accordion>

<Accordion title="Retrieve Owner by ID or user ID">
  Retrieves detailed information about a specific owner in the hubspot crm system. this endpoint allows you to fetch owner data using either their unique owner id or user id. it's particularly useful when you need to access an owner's profile, such as their name, email, or other associated details. the endpoint can retrieve both active and archived owners, making it versatile for various use cases including user management, audit trails, or data synchronization between systems. note that this endpoint focuses on individual owner retrieval and does not support bulk operations or modifications to owner data.
</Accordion>

<Accordion title="Search products by criteria">
  Searches for products in the hubspot crm based on specified criteria. this endpoint allows you to find products that match certain conditions, enabling efficient product management and retrieval. use this when you need to locate specific products or groups of products within your hubspot crm. the search is performed using a flexible criteria system, allowing for complex queries. the results are paginated, making it suitable for handling large product catalogs. note that this endpoint has a rate limit exemption, allowing for more frequent use compared to other endpoints.
</Accordion>

<Accordion title="Update a batch of emails">
  The batchupdateemails endpoint allows for updating multiple email records simultaneously in the hubspot crm. this powerful feature enables efficient bulk modifications of email properties, such as updating statuses, changing pipeline stages, or modifying custom fields for multiple emails in a single api call. it's particularly useful for synchronizing data from external systems or performing mass updates based on certain criteria. the endpoint accepts an array of email objects, each identified by either their hubspot id or a custom unique property, along with the properties to be updated. while it streamlines bulk operations, users should be cautious when updating large numbers of records to avoid hitting api rate limits.
</Accordion>

<Accordion title="Retrieve timeline event by ids">
  Retrieves a specific timeline event from hubspot's crm using the event template id and event id. this endpoint allows you to access all existing information for a previously created event, providing detailed insights into customer interactions and activities recorded in the crm timeline. it's particularly useful when you need to review or analyze a specific event's details within your crm workflows or integrations. note that while this endpoint returns comprehensive event information, it may not include the entire associated crm object data.
</Accordion>

<Accordion title="Retrieve Owners">
  Retrieves detailed information about all owners in the hubspot crm system. this endpoint allows you to fetch owner data using either their unique owner id or user id. it's particularly useful when you need to access an multiple owners' profile, such as their name, email etc. and use it in filtergroups.
</Accordion>

<Accordion title="Update product">
  This endpoint allows for partial updates to a product in hubspot's crm system. it's designed to modify existing product information by overwriting specified property values while preserving unmentioned properties. the endpoint is particularly useful for e-commerce integrations, enabling seamless product data management. it supports both internal object ids and custom unique properties for product identification, offering flexibility in how products are referenced and updated.
</Accordion>

<Accordion title="Retrieve line items list">
  Retrieves a paginated list of line items from the hubspot crm. this endpoint allows you to fetch detailed information about line items, which represent individual products or services within deals or orders. it offers flexible querying options, including customizable property selection, association retrieval, and filtering for archived items. use this endpoint when you need to access or analyze line item data in bulk, such as for reporting, data synchronization, or building custom integrations with hubspot's crm. the endpoint supports pagination for handling large datasets efficiently.
</Accordion>

<Accordion title="Update batch of products">
  This endpoint allows you to update multiple product records in hubspot's crm system in a single api call. it's designed for bulk updates, improving efficiency when modifying numerous products simultaneously. use this endpoint when you need to update multiple products' information, such as prices, descriptions, or any other product properties. the endpoint processes the updates in batch, returning either a successful operation result or detailed error information for any products that couldn't be updated. keep in mind that there may be limitations on the number of products that can be updated in a single batch, so refer to hubspot's documentation for specific constraints.
</Accordion>

<Accordion title="Search crm email objects">
  The searchemails endpoint allows you to search for and retrieve emails within the hubspot crm using various filtering and sorting options. this powerful tool enables you to find specific emails based on content, properties, and metadata. use it when you need to locate emails matching certain criteria, analyze email trends, or gather data for reporting purposes. the endpoint supports pagination for handling large result sets and allows you to specify which email properties to include in the response. it's particularly useful for integrations that need to sync email data or for building custom email analytics solutions. note that this endpoint focuses on searching and retrieving email data; it does not provide functionality for sending or modifying emails.
</Accordion>

<Accordion title="Update video conference app settings">
  Updates the configuration settings for a specific video conferencing application integrated with hubspot. this endpoint allows developers to modify various settings such as webhook urls, application credentials, or custom parameters that control how the video conferencing app interacts with hubspot's crm. it's used when changes to the application's behavior or integration setup are needed, such as updating oauth tokens or changing notification preferences. the endpoint requires the application's unique identifier and accepts a json payload with the new settings. it returns the updated settings object, allowing verification of the changes made.
</Accordion>

<Accordion title="Update a batch of line items">
  Updates a batch of line items in the hubspot crm simultaneously. this endpoint allows for efficient bulk updates of multiple line items in a single api call, reducing the number of individual requests needed for large-scale changes. it's particularly useful for synchronizing data from external systems or performing mass updates to line items. the endpoint accepts a batch of line item data and attempts to update each item, returning a comprehensive response that includes the status of each update operation. while this method is powerful for bulk operations, it should be used judiciously to avoid overwhelming the api or hitting rate limits.
</Accordion>

<Accordion title="Update campaign">
  Perform a partial update of a campaign identified by the specified campaignguid. provided property values will be overwritten. read-only and non-existent properties will cause 400 error. if an empty string is passed for any property in the batch update, it will reset that property's value.
</Accordion>

<Accordion title="Retrieve video conference settings by id">
  Retrieves the configuration settings for a specific video conference application integrated with hubspot. this endpoint allows developers to access the current settings of their video conferencing extension, such as webhook urls and application-specific configurations. it's particularly useful when you need to verify or audit the current setup of your video conferencing integration. the endpoint returns an externalsettings object containing the application's configuration details. use this endpoint when you need to review or troubleshoot your video conferencing application settings within hubspot's crm system.
</Accordion>

<Accordion title="Search crm objects by criteria">
  This endpoint allows you to search for crm objects in hubspot based on specific criteria. it provides a flexible way to retrieve records across different object types such as contacts, companies, deals, and tickets. the search functionality enables you to filter and find exact matches or apply more complex search logic to locate the desired crm objects. this endpoint is particularly useful when you need to find specific records that meet certain conditions or when you want to perform advanced queries on your crm data. it should be used when you need to retrieve a collection of objects that match your search criteria, rather than fetching all objects or looking up a single object by id.
</Accordion>

<Accordion title="Update specific crm property">
  Partially updates a specific crm property in hubspot, identified by the object type and property name. this endpoint allows you to modify existing properties for various crm objects like contacts, companies, deals, or custom objects. use this when you need to change certain attributes of a property without affecting the entire property configuration. the update is performed by overwriting only the provided fields, leaving others unchanged.
</Accordion>

<Accordion title="Retrieve page of companies">
  Retrieves a paginated list of companies from the hubspot crm. this endpoint allows you to fetch company data with fine-grained control over the returned properties and associations. it's ideal for scenarios where you need to list multiple companies, such as populating a company directory or performing bulk operations. the endpoint supports cursor-based pagination for efficiently handling large datasets and allows filtering for archived companies. use this when you need to fetch multiple company records at once, rather than retrieving a single company by id.
</Accordion>

<Accordion title="Search contacts by criteria">
  Searches for contacts in the hubspot crm based on specified criteria. this endpoint allows for complex queries to filter and retrieve contact data, supporting various search parameters such as property filters, sorting options, and pagination. it's ideal for finding specific contacts or groups of contacts that match certain conditions. the endpoint returns a collection of matching contacts along with total count and paging information, enabling efficient data retrieval and navigation through large result sets. use this when you need to perform advanced searches on your contact database or when integrating contact search functionality into your applications.
</Accordion>

<Accordion title="Update existing event template">
  Updates an existing event template and its associated tokens in hubspot's crm timeline. this endpoint allows you to modify the headertemplate and detailtemplate of an existing template, with changes taking effect for existing events. it also provides the ability to update or replace all tokens in the template in a single api call, streamlining the process of managing dynamic content. use this endpoint when you need to revise the structure or content of an existing event template, rather than creating a new one. it's particularly useful for maintaining consistency across events while allowing for necessary updates to template designs or token configurations.
</Accordion>

<Accordion title="Search products by criteria">
  Searches for products in the hubspot crm based on specified criteria. this endpoint allows you to find products that match certain conditions, enabling efficient product management and retrieval. use this when you need to locate specific products or groups of products within your hubspot crm. the search is performed using a flexible criteria system, allowing for complex queries. the results are paginated, making it suitable for handling large product catalogs. note that this endpoint has a rate limit exemption, allowing for more frequent use compared to other endpoints.\<\<DEPRECATED use search\_products\_by\_criteria>>
</Accordion>

<Accordion title="Set call recording settings">
  Configures call recording settings for a specific app within hubspot's crm system. this endpoint allows you to set up or modify how calls are recorded, which is crucial for compliance, quality assurance, and customer service improvement. use this when you need to enable, disable, or adjust call recording features for a particular app integration. the settings applied here will affect how calls are handled and stored within the hubspot crm for the specified app.
</Accordion>

<Accordion title="Update product">
  This endpoint allows for partial updates to a product in hubspot's crm system. it's designed to modify existing product information by overwriting specified property values while preserving unmentioned properties. the endpoint is particularly useful for e-commerce integrations, enabling seamless product data management. it supports both internal object ids and custom unique properties for product identification, offering flexibility in how products are referenced and updated.\<\<DEPRECATED use update\_product>>
</Accordion>

<Accordion title="Update a batch of campaigns">
  This endpoint updates a batch of campaigns based on the provided input data. the maximum number of items in a batch request is 50. if an empty string ("") is passed for any property in the batch update, it will reset that property's value.
</Accordion>

<Accordion title="Update line item object partially">
  This endpoint allows you to perform a partial update on a line item object in hubspot's crm system. it's used to modify specific properties of an existing line item without affecting other properties. the endpoint is ideal for making targeted changes to line items, such as updating prices, quantities, or other attributes. it supports flexible object identification through either the internal object id or a custom unique property. the update operation will overwrite provided property values, ignore read-only and non-existent properties, and allows clearing of property values by passing an empty string. this tool is essential for maintaining accurate and up-to-date line item information in the crm, especially when dealing with changes in orders or deals.
</Accordion>

<Accordion title="Retrieve pipeline stage by id">
  Retrieves detailed information about a specific pipeline stage within a hubspot crm pipeline. this endpoint allows you to fetch the properties and metadata of a single stage by providing its unique identifier, the pipeline it belongs to, and the object type it's associated with. use this when you need to access or verify the details of a particular stage in your crm workflow, such as its label, display order, or any custom properties. this endpoint is particularly useful for applications that need to dynamically update or display pipeline stage information.
</Accordion>

<Accordion title="Batch update crm contacts">
  Update a batch of tickets.
</Accordion>

<Accordion title="Update feedback submission by id">
  Updates specific properties of a feedback submission object in hubspot's crm system. this endpoint allows for partial updates, meaning only the properties provided in the request body will be modified. it's useful for making targeted changes to feedback data without affecting the entire object. the endpoint can identify the feedback submission using either its internal id or a unique property value. use this when you need to update survey responses, modify feedback details, or adjust any custom properties associated with a feedback submission. note that read-only properties cannot be modified, and attempting to update non-existent properties will have no effect.
</Accordion>

<Accordion title="Search deals by criteria">
  Searches for deals in the hubspot crm based on specified criteria. this endpoint allows for complex filtering, sorting, and property selection of deal objects. it's ideal for finding deals that match specific conditions, such as those in a particular pipeline stage or with certain property values. the endpoint supports pagination for handling large result sets and can be used to power custom deal reports or dashboards. it should be used when you need to retrieve a subset of deals matching particular criteria rather than fetching all deals or a single deal by id.
</Accordion>

<Accordion title="Update existing object schema">
  Updates an existing object schema in hubspot's crm, allowing you to modify the structure and attributes of custom objects. this endpoint is essential for evolving your crm data model as your business needs change. use it to add, modify, or remove properties from your custom object schemas, ensuring that your crm data structure remains aligned with your organizational requirements. this operation is particularly useful when you need to accommodate new data points or refine existing ones within your custom objects.
</Accordion>

<Accordion title="Search feedback submissions">
  This endpoint allows you to search for feedback submissions in hubspot's crm using specified criteria. it's designed for retrieving and filtering feedback data efficiently, supporting complex queries to find relevant submissions. the search functionality can be used to analyze customer feedback, track specific types of submissions, or gather data for reporting purposes. the endpoint returns a collection of matching feedback submissions along with pagination information for handling large result sets. note that this endpoint has a rate limit exemption, allowing for more frequent requests compared to standard endpoints.
</Accordion>

<Accordion title="Update a marketing email">
  Change properties of a marketing email.
</Accordion>

<Accordion title="Update pipeline stage by ids">
  Updates a specific stage within a hubspot crm pipeline. this endpoint allows for partial modifications to an existing pipeline stage, preserving any unspecified properties. it's useful for adjusting stage details without overwriting the entire stage configuration. the updated stage information is returned in the response, providing immediate confirmation of the changes. use this when you need to modify stage properties such as its name, display order, or probability within a specific pipeline.
</Accordion>

<Accordion title="Retrieve ticket by id">
  This endpoint retrieves a specific ticket from the hubspot crm system based on its id or a unique property value. it allows for customized responses by specifying which properties to include, fetching property history, and retrieving associated object ids. the endpoint is useful for getting detailed information about a single ticket, including its current state, historical changes, and related crm objects. it supports both active and archived tickets and can use custom id properties for ticket lookup.
</Accordion>

<Accordion title="Search company objects">
  This endpoint allows you to search for company objects in the hubspot crm using custom criteria. it provides a powerful way to filter and retrieve company data based on specific properties or conditions. use this endpoint when you need to find companies matching certain criteria, such as industry, size, or custom properties. the search is performed using a post request with a json body containing the search parameters. the endpoint returns a paginated collection of matching company objects, making it efficient for handling large datasets.
</Accordion>

<Accordion title="Update batch feedback submissions">
  Updates multiple feedback submissions in the hubspot crm system simultaneously. this endpoint allows for efficient bulk modifications of feedback data, streamlining the process of managing customer feedback at scale. it's particularly useful for updating large sets of feedback submissions or synchronizing data from external systems. the endpoint accepts a batch of feedback submission updates and processes them in a single request, reducing api calls and improving performance for large-scale operations.
</Accordion>

<Accordion title="Update a batch of objects by id or property values">
  This endpoint allows for batch updating of multiple crm objects of a specified type in hubspot. it enables efficient bulk modifications of records such as contacts, companies, or deals. the endpoint can update objects either by their internal ids or by matching property values. use this when you need to update multiple records simultaneously, which is more efficient than making individual api calls for each object. note that the success of updates can be partial, with some objects updated successfully while others may fail.
</Accordion>

<Accordion title="Update batch of companies">
  This endpoint allows you to update multiple company records in the hubspot crm simultaneously. it's designed for bulk operations when you need to modify information for several companies at once, improving efficiency and reducing api calls. the endpoint accepts a batch of company updates in the request body and processes them together. it's particularly useful for synchronizing company data from external systems or performing mass updates based on certain criteria. the endpoint returns detailed results for each company update, including success status and any errors encountered during the process. use this endpoint when you need to update multiple companies efficiently, but be mindful of potential rate limits and the complexity of handling partial successes in large batches.
</Accordion>

<Accordion title="Search line items by criteria">
  This endpoint allows you to search for line items in hubspot's crm based on specific criteria. it's particularly useful for retrieving detailed information about individual items within larger transactions or orders. you can use this endpoint to filter, sort, and paginate through line items, enabling efficient data analysis and reporting. the search is performed using a post request with a json body containing your search criteria, allowing for complex queries. the response includes a collection of matching line items along with pagination information for handling large result sets. this endpoint is ideal for scenarios where you need to analyze sales data, track specific products or services, or integrate line item information with other systems.
</Accordion>

<Accordion title="Batch update crm tickets">
  Update a batch of tickets.
</Accordion>

<Accordion title="Batch update crm deal properties">
  Update a batch of deals.
</Accordion>


# Humanloop
Source: https://docs.push.ai/integrations/humanloop



Humanloop helps developers build and refine AI applications, offering user feedback loops, model training, and data annotation to iterate on language model performance

<Accordion title="List Experiments">
  This tool retrieves an array of experiments associated with a specific project in humanloop. it requires a project id (starting with 'pr ') and returns details including experiment id, name, description, creation timestamp, status, configuration details, and metrics/results. it is useful for monitoring experiments, analyzing results, tracking model configurations, and comparing experimental setups.
</Accordion>

<Accordion title="Delete Project">
  This tool allows you to delete a specific project from your humanloop organization. the deletion is permanent and cannot be undone. all associated data, including sessions, datapoints, and evaluations linked to the project, will be permanently removed.
</Accordion>

<Accordion title="List Sessions">
  This tool retrieves a paginated list of sessions for a specific project in humanloop. it requires a project id (and optionally, page and size for pagination) and returns session details such as id, reference id, project information, datapoints count, first inputs, last output, created at, and updated at. this enables users to monitor and analyze historical project interactions.
</Accordion>

<Accordion title="Create Project">
  This tool creates a new project in humanloop. it is an independent action that generates a project by accepting a project's name (required), an optional description, and an optional organization id. upon execution, it returns details of the created project, including the project's id, name, description, created at timestamp, and organization id.
</Accordion>


# Intercom
Source: https://docs.push.ai/integrations/intercom



A messaging platform that allows businesses to communicate with
prospective and existing customers within their app, on their website,
through social media, or via email.

<Accordion title="Delete a company">
  You can delete a single company.
</Accordion>

<Accordion title="Add subscription to a contact">
  You can add a specific subscription to a contact. in intercom, we have two different subscription types based on user consent - opt-out and opt-in: 1.attaching a contact to an opt-out subscription type will opt that user out from receiving messages related to that subscription type. 2.attaching a contact to an opt-in subscription type will opt that user in to receiving messages related to that subscription type. this will return a subscription type model for the subscription type that was added to the contact.
</Accordion>

<Accordion title="Delete a collection">
  You can delete a single collection by making a delete request to `https://api.intercom.io/collections/&lt;id&gt;`.
</Accordion>

<Accordion title="Add tag to a contact">
  You can tag a specific contact. this will return a tag object for the tag that was added to the contact.
</Accordion>

<Accordion title="Attach a contact to a company">
  You can attach a company to a single contact.
</Accordion>

<Accordion title="List all admins">
  You can fetch a list of admins for a given workspace.
</Accordion>

<Accordion title="List all articles">
  You can fetch a list of all articles by making a get request to `https://api.intercom.io/articles`. > 📘 how are the articles sorted and ordered? > > articles will be returned in descending order on the `updated at` attribute. this means if you need to iterate through results then we'll show the most recently updated articles first.
</Accordion>

<Accordion title="List all collections">
  You can fetch a list of all collections by making a get request to `https://api.intercom.io/help center/collections`. collections will be returned in descending order on the `updated at` attribute. this means if you need to iterate through results then we'll show the most recently updated collections first.
</Accordion>

<Accordion title="Delete a contact">
  You can delete a single contact.
</Accordion>

<Accordion title="List all help centers">
  You can list all help centers by making a get request to `https://api.intercom.io/help center/help centers`.
</Accordion>

<Accordion title="Detach a contact from a company">
  You can detach a company from a single contact.
</Accordion>

<Accordion title="List attached contacts">
  You can fetch a list of all contacts that belong to a company.
</Accordion>

<Accordion title="List attached companies for contact">
  You can fetch a list of companies that are associated to a contact.
</Accordion>

<Accordion title="Get a contact">
  You can fetch the details of a single contact.
</Accordion>

<Accordion title="List attached segments for companies">
  You can fetch a list of all segments that belong to a company.
</Accordion>

<Accordion title="List all companies">
  You can list companies. the company list is sorted by the `last request at` field and by default is ordered descending, most recently requested first. note that the api does not include companies who have no associated users in list responses. when using the companies endpoint and the pages object to iterate through the returned companies, there is a limit of 10,000 companies that can be returned. if you need to list or iterate on more than 10,000 companies, please use the [scroll api](https://developers.intercom.com/reference#iterating-over-all-companies). \{% admonition type="warning" name="pagination" %} you can use pagination to limit the number of results returned. the default is `20` results per page. see the [pagination section](https://developers.intercom.com/docs/build-an-integration/learn-more/rest-apis/pagination/#pagination-for-list-apis) for more details on how to use the `starting after` param. \{% /admonition %}
</Accordion>

<Accordion title="List all notes">
  You can fetch a list of notes that are associated to a contact.
</Accordion>

<Accordion title="Identify an admin">
  You can view the currently authorised admin along with the embedded app object (a "workspace" in legacy terminology). > 🚧 single sign on > > if you are building a custom "log in with intercom" flow for your site, and you call the `/me` endpoint to identify the logged-in user, you should not accept any sign-ins from users with unverified email addresses as it poses a potential impersonation security risk.
</Accordion>

<Accordion title="List all activity logs">
  You can get a log of activities by all admins in an app.
</Accordion>

<Accordion title="Remove tag from a contact">
  You can remove tag from a specific contact. this will return a tag object for the tag that was removed from the contact.
</Accordion>

<Accordion title="List subscriptions for a contact">
  You can fetch a list of subscription types that are attached to a contact. these can be subscriptions that a user has 'opted-in' to or has 'opted-out' from, depending on the subscription type. this will return a list of subscription type objects that the contact is associated with. the data property will show a combined list of: 1.opt-out subscription types that the user has opted-out from. 2.opt-in subscription types that the user has opted-in to receiving.
</Accordion>

<Accordion title="List attached segments for contact">
  You can fetch a list of segments that are associated to a contact.
</Accordion>

<Accordion title="List tags attached to a contact">
  You can fetch a list of all tags that are attached to a specific contact.
</Accordion>

<Accordion title="Retrieve a collection">
  You can fetch the details of a single collection by making a get request to `https://api.intercom.io/help center/collections/&lt;id&gt;`.
</Accordion>

<Accordion title="Retrieve a help center">
  You can fetch the details of a single help center by making a get request to `https://api.intercom.io/help center/help center/&lt;id&gt;`.
</Accordion>

<Accordion title="Merge a lead and a user">
  You can merge a contact with a `role` of `lead` into a contact with a `role` of `user`.
</Accordion>

<Accordion title="Retrieve an article">
  You can fetch the details of a single article by making a get request to `https://api.intercom.io/articles/&lt;id&gt;`.
</Accordion>

<Accordion title="Retrieve an admin">
  You can retrieve the details of a single admin.
</Accordion>

<Accordion title="Retrieve companies">
  You can fetch a single company by passing in `company id` or `name`. `https://api.intercom.io/companies?name=\{name\}` `https://api.intercom.io/companies?company id=\{company id\}` you can fetch all companies and filter by `segment id` or `tag id` as a query parameter. `https://api.intercom.io/companies?tag id=\{tag id\}` `https://api.intercom.io/companies?segment id=\{segment id\}`
</Accordion>

<Accordion title="Set an admin to away">
  You can set an admin as away for the inbox.
</Accordion>

<Accordion title="Retrieve a company by id">
  You can fetch a single company.
</Accordion>

<Accordion title="Scroll over all companies">
  The `list all companies` functionality does not work well for huge datasets, and can result in errors and performance problems when paging deeply. the scroll api provides an efficient mechanism for iterating over all companies in a dataset. - each app can only have 1 scroll open at a time. you'll get an error message if you try to have more than one open per app. you can get the first page of companies by simply sending a get request to the scroll endpoint. for subsequent requests you will need to use the scroll parameter from the response type="danger" name="scroll network timeouts". since scroll is often used on large datasets network errors such as timeouts can be encountered. when this occurs you will see a http 500 error with the following message: "request failed due to an internal network error. please restart the scroll operation." if this happens, you will need to restart your scroll query.
</Accordion>

<Accordion title="Remove subscription from a contact">
  You can remove a specific subscription from a contact. this will return a subscription type model for the subscription type that was removed from the contact.
</Accordion>

<Accordion title="Update a contact">
  You can update an existing contact (ie. user or lead).
</Accordion>

<Accordion title="Update a company">
  You can update a single company using the intercom provisioned `id`. \{% admonition type="attention" name="using `company id`" %} when updating a company it is not possible to update `company id`. this can only be set once upon creation of the company. \{% /admonition %}
</Accordion>

<Accordion title="Search for articles">
  You can search for articles by making a get request to `https://api.intercom.io/articles/search`.
</Accordion>

<Accordion title="Create a note">
  You can add a note to a single contact.
</Accordion>

<Accordion title="Update a collection">
  You can update the details of a single collection by making a put request to `https://api.intercom.io/collections/&lt;id&gt;`.
</Accordion>

<Accordion title="Create or update a company">
  You can create or update a company. companies will be only visible in intercom when there is at least one associated user. companies are looked up via `company id` in a `post` request, if not found via `company id`, the new company will be created, if found, that company will be updated. \{% admonition type="attention" name="using `company id`" %} you can set a unique `company id` value when creating a company. however, it is not possible to update `company id`. be sure to set a unique value once upon creation of the company. \{% /admonition %}
</Accordion>

<Accordion title="Create a collection">
  You can create a new collection by making a post request to `https://api.intercom.io/help center/collections.`
</Accordion>

<Accordion title="Delete an article">
  You can delete a single article by making a delete request to `https://api.intercom.io/articles/&lt;id&gt;`.
</Accordion>

<Accordion title="Create an article">
  You can create a new article by making a post request to `https://api.intercom.io/articles`.
</Accordion>

<Accordion title="Update an article">
  You can update the details of a single article by making a put request to `https://api.intercom.io/articles/&lt;id&gt;`.
</Accordion>


# Introduction
Source: https://docs.push.ai/integrations/introduction



## Providers

Providers are third party applications that support various tools. Users and organizations access tools by authenticating with these providers, typically through OAuth or API keys.

User authentication allows individuals to connect their personal accounts, enabling access to user-specific resources and actions. Organization-level authentication, on the other hand, grants access to shared resources and enables broader context gathering across the entire organization.

## Using Tools

After a provider is integrated, the Query Agent will have access to a list of "tools." Tools serve a variety of purposes:

* Used within Push.ai managed tools (e.g., search API's are often abstracted into our "Search Knowledge" tool)
* Gather context when answering queries
* Perform actions, both entirely agent-driven and human-in-the-loop

## Security and Access controls

* Providers often have both user-level and organization level authentication methods and tools
* User-level tools are often tied to action-driven tools like creating and updating provider specific resources (e.g., send a Slack message)
* Organization-level tools support context gathering across the entire organization (e.g., list all Github issues)

## Custom Tools and API Integrations

Custom tools can be built around API integrations not listed.


# Jira
Source: https://docs.push.ai/integrations/jira



Jira API tool

<Accordion title="Add attachment">
  Attach files to a jira issue using multipart/form-data and 'x-atlassian-token: no-check' header. include 'file' parameter; examples in various languages. requires 'browse projects' and 'create attachments' permissions, anonymous allowed. \<\<DEPRECATED use JIRA\_ADD\_ATTACHMENT\_TO\_ISSUE>>
</Accordion>

<Accordion title="Add actors to project role">
  Add actors to a project role; replace using the provided link. anonymous access allowed. requires 'administer projects' or 'administer jira' permissions.
</Accordion>

<Accordion title="Add default actors to project role">
  Add either groups or users, not both, as default actors to a jira role. existing projects' roles remain unchanged. admin rights required.
</Accordion>

<Accordion title="Add field to default screen">
  Adds a field to the default tab of the default screen. **[permissions](https://dac-static.atlassian.com) required:** *administer jira* [global permission](https://confluence.atlassian.com/x/x4dklg).
</Accordion>

<Accordion title="Add attachment to issue">
  This tool allows users to add attachments to a jira issue. it enables users to attach files such as screenshots, documents, or other files to a specific issue.
</Accordion>

<Accordion title="Add comment">
  This tool adds a new comment to a specified jira issue. the comment can include formatted text using the atlassian document format (adf). it uses the api endpoint post /rest/api/3/issue/\{issueidorkey}/comment to create a comment.
</Accordion>

<Accordion title="Add screen tab field">
  Adds a field to a screen tab. **[permissions](https://dac-static.atlassian.com) required:** *administer jira* [global permission](https://confluence.atlassian.com/x/x4dklg).
</Accordion>

<Accordion title="Add user to group">
  Adds a user to a group. **[permissions](https://dac-static.atlassian.com) required:** site administration (that is, member of the *site-admin* [group](https://confluence.atlassian.com/x/24xjl)).
</Accordion>

<Accordion title="Add issue security levels">
  Adds levels and levels' members to the issue security scheme. you can add up to 100 levels per request. **[permissions](https://dac-static.atlassian.com) required:** *administer jira* [global permission](https://confluence.atlassian.com/x/x4dklg).
</Accordion>

<Accordion title="Add watcher">
  To add a user to an issue's watcher list, use the account id or default to the caller. ensure "allow users to watch issues" is on, and appropriate permissions, including "manage watcher list" for adding others, are granted.
</Accordion>

<Accordion title="Assign field configuration scheme to project">
  Assigns a field config scheme to a project or defaults if null. only for classic projects. requires 'administer jira' global permission.
</Accordion>

<Accordion title="Add filter as favorite">
  Users can mark filters as favorites in jira if they own it, are in a group it's shared with, or if it's shared with a project or the public they have access to. permissions needed.
</Accordion>

<Accordion title="Assign issue types to field configurations">
  This operation assigns issue types to field configs in a scheme, limited to company-managed projects, and requires *administer jira* global permission.
</Accordion>

<Accordion title="Add issue types to context">
  Issue types can be added to a jira custom field context, limiting its application to those types only. if types are already present, the add fails. admin permissions needed.
</Accordion>

<Accordion title="Append mappings to issue type screen scheme">
  Appends issue type to screen scheme mappings to an issue type screen scheme. **[permissions](https://dac-static.atlassian.com) required:** *administer jira* [global permission](https://confluence.atlassian.com/x/x4dklg).
</Accordion>

<Accordion title="Assign issue">
  Assigns an issue to a user. use this operation when the calling user does not have the edit issues permission but has the assign issue permission for the project that the issue is in. if account id is set to: - "-1", the issue is assigned to the default assignee for the project. - null, the issue is set to unassigned. permissions required: - browse projects and assign issues project permission for the project that the issue is in. - if issue-level security is configured, issue-level security permission to view the issue.
</Accordion>

<Accordion title="Associate security scheme to project">
  Assigns an issue security scheme to a project, optionally remapping issue security levels. the task is asynchronous; track status via the 'location' link. admin rights required.
</Accordion>

<Accordion title="Add issue security level members">
  Adds members to the issue security level. you can add up to 100 members per request. **[permissions](https://dac-static.atlassian.com) required:** *administer jira* [global permission](https://confluence.atlassian.com/x/x4dklg).
</Accordion>

<Accordion title="Analyse jira expression">
  This operation analyzes and confirms the validity of jira expressions and can optionally type-check them. it's experimental, with no permissions needed. learn more in the documentation.
</Accordion>

<Accordion title="Add gadget to dashboard">
  Adds a gadget to a dashboard. **[permissions](https://dac-static.atlassian.com) required:** none.
</Accordion>

<Accordion title="Bulk delete statuses">
  Deletes statuses by id; requires 'administer projects' and 'administer jira' project permissions.
</Accordion>

<Accordion title="Assign workflow scheme to project">
  Workflow schemes are designated to classic projects without issues by users with the 'administer jira' global permission.
</Accordion>

<Accordion title="Add watcher to issue">
  This tool adds a user as a watcher to a specified jira issue. watchers will receive notifications about updates to the issue. this operation requires the "allow users to watch issues" option to be on. this option is set in general configuration for jira. permissions required: - browse projects permission for the project containing the issue - if issue-level security is configured, issue-level security permission to view the issue - to add users other than themselves to the watchlist, manage watcher list project permission
</Accordion>

<Accordion title="Bulk delete issue property">
  The tool asynchronously removes a property from filtered issues transactionally. results are clickable links. without filters, all issues are affected. edit and browse permissions, plus issue security compliance, are needed.
</Accordion>

<Accordion title="Bulk get statuses">
  Fetches a list of statuses for given status ids. requires 'administer projects' and 'administer jira' permissions.
</Accordion>

<Accordion title="Add issue types to issue type scheme">
  This operation appends new issue types to a scheme in jira. if any issue types already exist within the scheme, the process fails. administer jira global permission is required.
</Accordion>

<Accordion title="Bulk get workflow schemes">
  Get a list of workflow schemes with scheme/project ids. requires 'administer jira' for all schemes, 'administer projects' for project-specific ones.
</Accordion>

<Accordion title="Bulk set issue properties by issue">
  Updates issue entity properties for up to 100 issues asynchronously; limited to 10 properties per issue with valid json in the request body. the operation is non-transactional, and permissions like 'browse projects' and 'edit issues' are required.
</Accordion>

<Accordion title="Bulk update custom field value">
  Updates the value of a custom field added by connect apps on one or more issues. the values of up to 200 custom fields can be updated. **[permissions](https://dac-static.atlassian.com) required:** only connect apps can make this request
</Accordion>

<Accordion title="Bulk set issues properties by list">
  Updates up to 10k issues with ≤10 properties per issue in json format. single property capped at 32,768 chars. allows anonymous use, transactional and async. needs 'browse projects,' 'edit issues,' and issue security view permissions.
</Accordion>

<Accordion title="Assign issue type scheme to project">
  The text outlines the process to assign an issue type scheme to a classic jira project, noting that it fails if there are issues with types not in the new scheme. admin rights are required.
</Accordion>

<Accordion title="Bulk update statuses">
  Updates statuses by id, requiring "administer projects" and "administer jira" permissions. more info at provided atlassian links.
</Accordion>

<Accordion title="Change filter owner">
  Changes the owner of the filter. **[permissions](https://dac-static.atlassian.com) required:** permission to access jira. however, the user must own the filter or have the *administer jira* [global permission](https://confluence.atlassian.com/x/x4dklg).
</Accordion>

<Accordion title="Bulk set issue property">
  Jira allows setting property values on multiple issues with constants or expressions, filtering by various criteria. updates to properties are transactional, asynchronous, and require proper permissions.
</Accordion>

<Accordion title="Bulk get users">
  Returns a [paginated](https://dac-static.atlassian.com) list of the users specified by one or more account ids. **[permissions](https://dac-static.atlassian.com) required:** permission to access jira.
</Accordion>

<Accordion title="Bulk edit dashboards">
  Bulk edit dashboards. maximum number of dashboards to be edited at the same time is 100. **[permissions](https://dac-static.atlassian.com) required:** none the dashboards to be updated must be owned by the user, or the user must be an administrator.
</Accordion>

<Accordion title="Cancel task">
  Cancels a task. **[permissions](https://dac-static.atlassian.com) required:** either of: \* *administer jira* [global permission](https://confluence.atlassian.com/x/x4dklg). \* creator of the task.
</Accordion>

<Accordion title="Add notifications to notification scheme">
  Add up to 1000 notifications to a scheme, note that `emailaddress` type is deprecated in cloud. administer jira global permission is required. see changelog and permissions docs for details.
</Accordion>

<Accordion title="Bulk update workflows">
  Permissions needed to update workflows: "administer jira" for all/global workflows, and "administer projects" for project-specific workflows.
</Accordion>

<Accordion title="Change order of issue types">
  Reorders issue types in a scheme; requires all types in scheme & either 'after' or 'position' specified—excluding 'after' type from the list. admin jira rights needed.
</Accordion>

<Accordion title="Bulk create issue">
  Creates multiple issues or sub-tasks in bulk. this action allows for the creation of up to 50 issues in a single request. each issue can be a standard issue or a subtask, depending on the issue type specified.
</Accordion>

<Accordion title="Check issues against jql">
  The text describes a process to check if jql queries will return any issues. no specific permissions are needed, but the user must have 'browse projects' permission and, if applicable, issue-level security permission to view the issues.
</Accordion>

<Accordion title="Convert user identifiers to account ids in jql queries">
  This tool transforms jql queries with usernames or user keys to ones using account ids for gdpr compliance. important for systems storing jqls. access to jira is necessary. see the migration guide for gdpr changes.
</Accordion>

<Accordion title="Copy dashboard">
  Copies a dashboard. any values provided in the `dashboard` parameter replace those in the copied dashboard. **[permissions](https://dac-static.atlassian.com) required:** none the dashboard to be copied must be owned by or shared with the user.
</Accordion>

<Accordion title="Bulk get groups">
  Returns a [paginated](https://dac-static.atlassian.com) list of groups. **[permissions](https://dac-static.atlassian.com) required:** *browse users and groups* [global permission](https://confluence.atlassian.com/x/x4dklg).
</Accordion>

<Accordion title="Bulk create statuses">
  Summary: the text outlines that to create statuses applicable across global or project levels, one must have "administer projects" and "administer jira" permissions.
</Accordion>

<Accordion title="Bulk get workflows">
  Get a list of workflows and statuses using names, ids, or by project/issue type. requires 'administer jira' for all or 'administer projects'/'view workflow' for project-level access.
</Accordion>

<Accordion title="Assign issue type screen scheme to project">
  The text explains that only users with "administer jira" permissions can assign issue type screen schemes to classic projects.
</Accordion>

<Accordion title="Archive project">
  Archive a project to prevent deletion. restore it via the jira ui to delete it afterward. administer jira global permission is necessary.
</Accordion>

<Accordion title="Add share permission">
  Adding a global share permission to a filter will replace existing permissions. requires "share dashboards and filters" global permission and filter ownership. note different objects for updates than in update filter link documentation.
</Accordion>

<Accordion title="Archive issue s by issue id key">
  Admins can archive 1000 issues per request, with archive status and errors reported. subtasks archived via parents. limited to certain project types. jira or site admin rights, premium or enterprise license, and signed-in users required.
</Accordion>

<Accordion title="Classic update workflow scheme">
  Updates a company-managed project workflow scheme and its components. if active, updates/creates a draft scheme if `updatedraftifneeded` is true. admin jira permissions needed.
</Accordion>

<Accordion title="Archive issue s by jql">
  Admins can archive 100k jira issues per request with jql; includes status url, task management apis, and project type limits. requires jira admin rights, premium/enterprise license, and non-anonymous access; only one active request allowed per instance.
</Accordion>

<Accordion title="Add vote">
  User can vote on an issue in jira if the voting option is enabled in general configuration. necessary permissions include browsing projects and viewing the issue if issue-level security is set. see provided links for details.
</Accordion>

<Accordion title="Assign permission scheme">
  Assigned a permission scheme to a project. for details, visit the provided links. requires "administer jira" global permission.
</Accordion>

<Accordion title="Bulk create workflows">
  To create workflows and their statuses in jira, users need 'administer jira' permission for global workflows and 'administer projects' for project-specific ones.
</Accordion>

<Accordion title="Assign custom field context to projects">
  The text describes an operation that assigns custom field contexts to projects, which fails if a project is already assigned a context. administer jira global permission is needed.
</Accordion>

<Accordion title="Add worklog">
  Adds a worklog to a jira issue. requires time tracking enabled and "browse projects" & "work on issues" permissions. allows anonymous access but may need issue-level security permission.
</Accordion>

<Accordion title="Create custom field context">
  A custom field context is created; if no projectids, it's global (for all projects); if no issuetypeids, it affects all issue types. admin jira rights required.
</Accordion>

<Accordion title="Create draft workflow scheme">
  Draft a workflow scheme by cloning an active one; an active scheme allows only one draft. admin rights in jira are needed.
</Accordion>

<Accordion title="Create dashboard">
  Creates a dashboard. **[permissions](https://dac-static.atlassian.com) required:** none.
</Accordion>

<Accordion title="Create custom field">
  Creates a custom field. **[permissions](https://dac-static.atlassian.com) required:** *administer jira* [global permission](https://confluence.atlassian.com/x/x4dklg).
</Accordion>

<Accordion title="Create field configuration">
  New field configuration with optional fields is created, mirroring default settings, for company-managed projects. administer jira global permission is needed.
</Accordion>

<Accordion title="Create issue security scheme">
  The text describes a system that allows creation of a security scheme with up to 100 levels and members per level, requiring "administer jira" global permissions.
</Accordion>

<Accordion title="Create notification scheme">
  Creates a notification scheme with notifications. you can create up to 1000 notifications per request. **[permissions](https://dac-static.atlassian.com) required:** *administer jira* [global permission](https://confluence.atlassian.com/x/x4dklg).
</Accordion>

<Accordion title="Create field configuration scheme">
  Creates field configuration schemes for company-managed projects. requires 'administer jira' global permission.
</Accordion>

<Accordion title="Create custom field options context">
  Allows creation of up to 1000 select and cascading field options per request for a jira custom field (max 10,000 options). use the issue custom field options for connect apps. admin rights needed.
</Accordion>

<Accordion title="Create issue type scheme">
  Creates an issue type scheme. **[permissions](https://dac-static.atlassian.com) required:** *administer jira* [global permission](https://confluence.atlassian.com/x/x4dklg).
</Accordion>

<Accordion title="Create or update remote issue link">
  This operation creates/updates a remote issue link for an issue, using a `globalid`. it requires "browse projects" & "link issues" permissions and, if applicable, issue-level security permission. accessible anonymously if issue linking is enabled.
</Accordion>

<Accordion title="Create project role">
  A new project role without default actors can be created and later assigned actors. note: existing projects won't get new actors automatically. admin rights required.
</Accordion>

<Accordion title="Create new issue in project">
  Creates a new issue in jira with specified fields, updates, and properties. this endpoint allows for comprehensive issue creation, supporting standard jira fields as well as custom fields and issue properties. it can be used to initiate new tasks, bugs, stories, or any other issue type defined in your jira project. the endpoint is particularly useful for automating issue creation from external systems or for bulk issue creation. it provides flexibility in setting initial issue state, including the ability to specify transitions, add history metadata, and set custom properties. however, it's important to note that the fields available and required may vary depending on the specific jira configuration and issue type being created. proper permissions are necessary to create issues in the specified project. \<\<DEPRECATED use JIRA\_CREATE\_ISSUE\_TICKET>>
</Accordion>

<Accordion title="Create project category">
  Creates a project category. **[permissions](https://dac-static.atlassian.com) required:** *administer jira* [global permission](https://confluence.atlassian.com/x/x4dklg).
</Accordion>

<Accordion title="Create permission grant">
  Creates a permission grant in a permission scheme. **[permissions](https://dac-static.atlassian.com) required:** *administer jira* [global permission](https://confluence.atlassian.com/x/x4dklg).
</Accordion>

<Accordion title="Create screen scheme">
  Creates a screen scheme. **[permissions](https://dac-static.atlassian.com) required:** *administer jira* [global permission](https://confluence.atlassian.com/x/x4dklg).
</Accordion>

<Accordion title="Create related work">
  The api allows anonymous creation of related work with a generic link type for a given version. a unique relatedworkid is auto-generated. permissions required are 'resolve issues' and 'edit issues.'
</Accordion>

<Accordion title="Create ui modification">
  Forge apps can make ui changes with or without explicit permissions, supporting 3000 modifications, each with 1000 contexts. however, there's a cap of 100 modifications for each context.
</Accordion>

<Accordion title="Create user">
  This legacy api creates a jira user; if the user exists with jira access, it returns a 201 status; without access, a 400 status. admin jira permissions are required. it will be deprecated for a better option.
</Accordion>

<Accordion title="Create workflow transition property">
  Property added to workflow transition alters behavior. details at atlassian docs. requires 'administer jira' global permission. more info: transition & workflow properties links.
</Accordion>

<Accordion title="Create issue ticket">
  Creates a new issue in jira. this action allows users to create various types of issues (bugs, tasks, stories, etc.) in a specified jira project. it requires parameters such as project key, summary, and issue type, and supports optional parameters like description, assignee, priority, labels, components, and custom fields.
</Accordion>

<Accordion title="Create workflow">
  The text explains how to create jira workflow rules, covering conditions, validators, and post functions for transitions, with a bulk create option and a guide \[linked]. admin rights are needed.
</Accordion>

<Accordion title="Create version">
  This tool creates a new version in a jira project. it uses the post /rest/api/3/version endpoint and accepts parameters like name, description, projectid, released, archived, releasedate, and startdate to track project releases and milestones.
</Accordion>

<Accordion title="Create component">
  Create a component to organize issues in a project. anonymous access allowed, but requires project admin or global jira admin permissions.
</Accordion>

<Accordion title="Create resolution">
  Creates an issue resolution. **[permissions](https://dac-static.atlassian.com) required:** *administer jira* [global permission](https://confluence.atlassian.com/x/x4dklg).
</Accordion>

<Accordion title="Delete actors from project role">
  This procedure removes actors from a project role and can be done without logging in. requires either "administer projects" project or "administer jira" global permissions. use the provided link for default actor removal.
</Accordion>

<Accordion title="Delete app property forge">
  Deletes a forge app's property. **[permissions](https://dac-static.atlassian.com) required:** only forge apps can make this request.
</Accordion>

<Accordion title="Create issue type">
  Creates an issue type and adds it to the default issue type scheme. **[permissions](https://dac-static.atlassian.com) required:** *administer jira* [global permission](https://confluence.atlassian.com/x/x4dklg).
</Accordion>

<Accordion title="Create issue field option">
  This operation adds options to select list issue fields specifically for connect apps, not for native jira fields or other methods. each field and option can have up to 10,000 options or scopes. administer jira global permission is required.
</Accordion>

<Accordion title="Create screen tab">
  Creates a tab for a screen. **[permissions](https://dac-static.atlassian.com) required:** *administer jira* [global permission](https://confluence.atlassian.com/x/x4dklg).
</Accordion>

<Accordion title="Create filter">
  Creates a filter. the filter is shared according to the [default share scope](https://dac-static.atlassian.com). the filter is not selected as a favorite. **[permissions](https://dac-static.atlassian.com) required:** permission to access jira.
</Accordion>

<Accordion title="Delete attachment">
  Removes an issue attachment. anonymous access allowed. requires project permissions: "delete own attachments" for user-created attachments or "delete all attachments" for any attachment.
</Accordion>

<Accordion title="Delete app property">
  An authorized connect app with a matching `addonkey` can delete its property. also, forge apps can delete properties if they share the `app.connect.key`.
</Accordion>

<Accordion title="Delete and replace version">
  Deletes a project version and allows substitution with another from the same project. access requires 'administer jira' or 'administer projects' permissions and can be done anonymously.
</Accordion>

<Accordion title="Create group">
  Creates a group. **[permissions](https://dac-static.atlassian.com) required:** site administration (that is, member of the *site-admin* [group](https://confluence.atlassian.com/x/24xjl)).
</Accordion>

<Accordion title="Delete avatar">
  Deletes an avatar from a project or issue type. **[permissions](https://dac-static.atlassian.com) required:** *administer jira* [global permission](https://confluence.atlassian.com/x/x4dklg).
</Accordion>

<Accordion title="Delete comment">
  This tool will delete a comment from a jira issue using the delete /rest/api/3/issue/\{issueidorkey}/comment/\{id} endpoint. it requires the following parameters: issueidorkey (string) for the id or key of the issue, and id (string) for the id of the comment. the operation requires specific permissions including: browse projects, issue-level security permissions if applicable, and delete permissions (either delete all comments or delete own comments).
</Accordion>

<Accordion title="Create permission scheme">
  New permission scheme creation is available, with or without specifying permissions. requires "administer jira" global permission.
</Accordion>

<Accordion title="Delete comment property">
  To delete a comment property, users need "edit all comments" to delete any property or "edit own comments" to delete their own. additionally, if a comment is restricted, the user must belong to that specific role or group.
</Accordion>

<Accordion title="Create screen">
  Creates a screen with a default field tab. **[permissions](https://dac-static.atlassian.com) required:** *administer jira* [global permission](https://confluence.atlassian.com/x/x4dklg).
</Accordion>

<Accordion title="Create workflow scheme">
  Creates a workflow scheme. **[permissions](https://dac-static.atlassian.com) required:** *administer jira* [global permission](https://confluence.atlassian.com/x/x4dklg).
</Accordion>

<Accordion title="Create sprint">
  This tool creates a future sprint in jira. the sprint name and origin board id are required parameters. the tool allows for creating a new sprint with optional parameters like start date, end date, and goal.
</Accordion>

<Accordion title="Create issue link">
  Creates a link between two jira issues with an optional comment. the link type must be a valid link type name in your jira instance. requires appropriate permissions to view and link the specified issues.
</Accordion>

<Accordion title="Create issue link type">
  Create an issue link type in jira to define why issues are linked, including names/descriptions for relationship directions. requires issue linking enabled and 'administer jira' permissions.
</Accordion>

<Accordion title="Create issue type screen scheme">
  Creates an issue type screen scheme. **[permissions](https://dac-static.atlassian.com) required:** *administer jira* [global permission](https://confluence.atlassian.com/x/x4dklg).
</Accordion>

<Accordion title="Delete component">
  Anonymous users can delete a component if they have either "administer projects" permission for the related project or "administer jira" global permission. see provided links for details.
</Accordion>

<Accordion title="Create project">
  Creates a new project in jira. this action allows you to create a project with specified configurations including project type, template, permissions, and other settings. the project type and template must be compatible - see the project template key field description for valid combinations. requires jira admin permissions.
</Accordion>

<Accordion title="Create priority">
  Creates an issue priority. **[permissions](https://dac-static.atlassian.com) required:** *administer jira* [global permission](https://confluence.atlassian.com/x/x4dklg).
</Accordion>

<Accordion title="Delete custom field">
  Deletes a custom field permanently, asynchronous operation, track status via 'location' link. requires 'administer jira' global permission. more info on deletion at atlassian documentation.
</Accordion>

<Accordion title="Delete draft workflow scheme">
  Deletes a draft workflow scheme. **[permissions](https://dac-static.atlassian.com) required:** *administer jira* [global permission](https://confluence.atlassian.com/x/x4dklg).
</Accordion>

<Accordion title="Delete issue type">
  Deletes an issue type, substituting all instances with an alternative issue type. requires 'administer jira' permission. alternative types can be found at the provided resources.
</Accordion>

<Accordion title="Delete custom field options context">
  This operation allows deletion of a custom field option in jira, but cascading options must be removed first. it applies to jira-created fields, not connect app fields. requires jira admin permissions.
</Accordion>

<Accordion title="Delete custom field context">
  The provided text indicates that to delete a custom field context in jira, one needs to have the 'administer jira' global permission.
</Accordion>

<Accordion title="Delete project">
  To delete a project in jira, it must not be archived. first, restore it using the jira ui, if necessary. administer jira global permission is required.
</Accordion>

<Accordion title="Delete filter">
  To delete a filter in jira, you need access permission. only the filter creator or a user with 'administer jira' global permission can perform the deletion.
</Accordion>

<Accordion title="Delete default workflow">
  Resets default workflow to jira's system workflow; active schemes need `updatedraftifneeded`=true for edits, creating/updating a draft that can be published. requires *administer jira* permission.
</Accordion>

<Accordion title="Delete dashboard item property">
  Removes a dashboard property and doesn't require login. user must own the dashboard or have *administer jira* global permission to qualify.
</Accordion>

<Accordion title="Delete dashboard">
  Deletes a dashboard. **[permissions](https://dac-static.atlassian.com) required:** none the dashboard to be deleted must be owned by the user.
</Accordion>

<Accordion title="Delete issue">
  Deletes a jira issue. an issue cannot be deleted if it has subtasks unless deletesubtasks is true. permissions required: - browse projects and delete issues project permission for the project containing the issue - if issue-level security is configured, issue-level security permission to view the issue
</Accordion>

<Accordion title="Delete issue types for workflow in draft workflow scheme">
  Deletes the workflow-issue type mapping for a workflow in a workflow scheme's draft. **[permissions](https://dac-static.atlassian.com) required:** *administer jira* [global permission](https://confluence.atlassian.com/x/x4dklg).
</Accordion>

<Accordion title="Delete inactive workflow">
  A workflow can only be deleted if it's not active, a system workflow, or linked to any (draft) workflow scheme. administer jira global permissions required.
</Accordion>

<Accordion title="Delete screen tab">
  Deletes a screen tab. **[permissions](https://dac-static.atlassian.com) required:** *administer jira* [global permission](https://confluence.atlassian.com/x/x4dklg).
</Accordion>

<Accordion title="Delete screen scheme">
  Screen schemes in classic projects can be deleted unless linked to an issue type screen scheme. admin jira global permission is needed.
</Accordion>

<Accordion title="Delete project asynchronously">
  Project deletion is asynchronous and transactional; if it fails, the project remains. track progress via 'location' link and 'get task'. requires 'administer jira' global permission.
</Accordion>

<Accordion title="Delete issue types for workflow in workflow scheme">
  Removes a workflow-issue type mapping from a workflow scheme in jira. active schemes must use `updatedraftifneeded` for edits, creating or updating a draft that can be published. admin rights required.
</Accordion>

<Accordion title="Delete draft default workflow">
  Resets a draft workflow scheme's default to jira's system workflow; requires 'administer jira' global permission.
</Accordion>

<Accordion title="Delete ui modification">
  Deletes a ui modification. all the contexts that belong to the ui modification are deleted too. ui modification can only be deleted by forge apps. **[permissions](https://dac-static.atlassian.com) required:** none.
</Accordion>

<Accordion title="Delete user">
  Removes a user from jira's user base if successful. does not affect their atlassian account. site admin permissions required.
</Accordion>

<Accordion title="Delete project property">
  This operation removes a property from a project in jira and can be done anonymously, but requires either 'administer jira' global or 'administer projects' project permissions.
</Accordion>

<Accordion title="Delete issue type property">
  The text provides instructions to remove the "issue type property" in jira, noting that "administer jira" global permission is necessary for this operation.
</Accordion>

<Accordion title="Delete default actors from project role">
  Removes default actors from a project role in jira, with the restriction of deleting either a group or user per request, not both. pre-existing project roles remain unaffected. admin jira rights are required.
</Accordion>

<Accordion title="Evaluate jira expression">
  Test jira expressions to fetch data or plan usage with the jira expressions documentation. context variables such as user, issue, and project can be used. anonymous access is allowed; permissions influence outcomes.
</Accordion>

<Accordion title="Delete workflow scheme">
  You can delete a workflow scheme in jira only if it's not currently active. admin rights are required for this action.
</Accordion>

<Accordion title="Delete project avatar">
  Deletes a custom avatar from a project. note that system avatars cannot be deleted. **[permissions](https://dac-static.atlassian.com) required:** *administer projects* [project permission](https://confluence.atlassian.com/x/yodklg).
</Accordion>

<Accordion title="Delete field configuration">
  Delete field configurations only from company-managed projects. requires 'administer jira' global permission. see provided links for details.
</Accordion>

<Accordion title="Delete project category">
  Deletes a project category. **[permissions](https://dac-static.atlassian.com) required:** *administer jira* [global permission](https://confluence.atlassian.com/x/x4dklg).
</Accordion>

<Accordion title="Delete workflow for issue type in workflow scheme">
  Removes issue type-workflow mapping from a jira workflow scheme. for active schemes, set `updatedraftifneeded` to `true` to create/update a draft. admin jira permissions required.
</Accordion>

<Accordion title="Delete share permission">
  Deletes a share permission from a filter. **[permissions](https://dac-static.atlassian.com) required:** permission to access jira and the user must own the filter.
</Accordion>

<Accordion title="Find users">
  The operation searches for and filters active users based on a string and property, displays them within a range, allows anonymous access, respects privacy, and needs 'browse users and groups' permission for results.
</Accordion>

<Accordion title="Delete issue field option">
  This operation removes options only from select lists added by connect apps in jira fields, not options created in jira or with issue custom field options. admin jira global permission is required, but no jira permissions for the app's field.
</Accordion>

<Accordion title="Find users assignable to projects">
  Returns a list of assignable users in projects, filtering by attributes. it picks from a start point and up to a max, often returning fewer users. privacy settings may hide some info. can be accessed anonymously; no permissions required.
</Accordion>

<Accordion title="Export archived issue s">
  Admins can use an api to receive an email with a csv link for archived issues; it includes system fields but not custom ones. jira/site admin rights, a premium/enterprise plan, and sign-in are needed. only one active request is allowed.
</Accordion>

<Accordion title="Find users by query">
  The operation retrieves users matching a query, often less than `maxresults`, using `and`/`or` for roles/properties. 'browse users and groups' permission required.
</Accordion>

<Accordion title="Find users and groups">
  Search tool matches users/groups with query, insensitive for users but sensitive for groups. supports detailed searches with result highlighting. anonymous use allowed, but specific permission required.
</Accordion>

<Accordion title="Get advanced settings">
  Access jira's *advanced settings* via: jira icon > **jira settings** > **system** > **general configuration**, click **advanced settings**. requires *administer jira* permission.
</Accordion>

<Accordion title="Delete issue type scheme">
  Issue type schemes from classic projects can be deleted. projects using the scheme switch to the default. admin rights in jira are needed.
</Accordion>

<Accordion title="Fully update project role">
  Update a project role's name and description in jira; both fields are required. admin privileges needed. links provided for permissions details.
</Accordion>

<Accordion title="Find users for picker">
  The tool matches and highlights user queries, supports exclusions, and might return fewer results than the maximum due to privacy. use "get all users" for full results. anonymous searches yield exact names with restrictions.
</Accordion>

<Accordion title="Delete user property">
  This operation removes a property from a user in jira. to delete any user's property, the 'administer jira' permission is needed; to delete from one's own record, jira access suffices. it does not affect jira's user properties.
</Accordion>

<Accordion title="Get all application roles">
  The text provides instructions for jira administrators to manage application roles via a specific configuration page, noting that the "administer jira" global permission is required.
</Accordion>

<Accordion title="Get accessible project type by key">
  Returns a [project type](https://confluence.atlassian.com/x/var1nw) if it is accessible to the user. **[permissions](https://dac-static.atlassian.com) required:** permission to access jira.
</Accordion>

<Accordion title="Find users assignable to issues">
  List users eligible for jira issue assignment using `projectkeyorid` for new issues or `issuekey` for updates. during transitions, add `actiondescriptorid`. user privacy and selection range may limit results. access requires specific permissions.
</Accordion>

<Accordion title="Get account ids for users">
  Returns the account ids for the users specified in the `key` or `username` parameters. note that multiple `key` or `username` parameters can be specified. **[permissions](https://dac-static.atlassian.com) required:** permission to access jira.
</Accordion>

<Accordion title="Get all dashboards">
  Returns a list of dashboards owned by or shared with the user. the list may be filtered to include only favorite or owned dashboards. this operation can be accessed anonymously. **[permissions](https://dac-static.atlassian.com) required:** none.
</Accordion>

<Accordion title="Get all classification levels">
  Returns all classification levels. **[permissions](https://dac-static.atlassian.com) required:** none.
</Accordion>

<Accordion title="Delete workflow transition property">
  The text provides instructions for removing a property from a workflow transition, which affects its behavior. references include detailed documentation on transition and workflow properties. admin rights in jira are required.
</Accordion>

<Accordion title="Delete project role">
  Deletes an in-use project role if a replacement is provided. requires 'administer jira' global permission.
</Accordion>

<Accordion title="Get all field configurations">
  Retrieve a paginated list of field configurations for company-managed projects, filterable by item ids, defaults, or search terms. requires 'administer jira' permission.
</Accordion>

<Accordion title="Extend webhook life">
  Use this operation to extend the life of rest api webhooks beyond 30 days; it ignores webhooks with unrecognized ids. only connect and oauth 2.0 apps are permitted to use this.
</Accordion>

<Accordion title="Fetch migrated workflow rule details">
  Returns configurations for workflow transition rules migrated from server to cloud and owned by the calling connect app.
</Accordion>

<Accordion title="Delete issue link">
  This operation allows anonymous users to delete an issue link provided they have the 'browse project' permission for all linked projects, 'link issues' permission for at least one project, and view access if issue-level security is set.
</Accordion>

<Accordion title="Find users with browse permission">
  Summarize user search for those with issue browsing ability by `issuekey` or `projectkey`. limited results due to permissions; privacy settings apply. anonymous access if permitted. see docs for details.
</Accordion>

<Accordion title="Get all issue types for user">
  The operation allows anonymous access to issue types. users with *administer jira* permission can see all types; those with *browse projects* see types linked to accessible projects.
</Accordion>

<Accordion title="Delete issue type screen scheme">
  Deletes an issue type screen scheme. **[permissions](https://dac-static.atlassian.com) required:** *administer jira* [global permission](https://confluence.atlassian.com/x/x4dklg).
</Accordion>

<Accordion title="Delete field configuration scheme">
  Deletes a field configuration scheme, applicable only in company-managed projects. requires 'administer jira' global permission.
</Accordion>

<Accordion title="Get all field configuration schemes">
  The text provides a link for obtaining a paginated list of field configuration schemes specific to classic projects, with a requirement of the 'administer jira' global permission for access.
</Accordion>

<Accordion title="Delete version">
  This tool allows you to delete a version in jira. a version is a milestone or release point in a project that can be used to track progress and organize issues. the delete operation can be customized to handle associated issues and fix versions. permissions required: - administer jira global permission or - administer projects project permission for the project that contains the version
</Accordion>

<Accordion title="Get all labels">
  Returns a [paginated](https://dac-static.atlassian.com) list of labels.
</Accordion>

<Accordion title="Get all issue field options">
  Fetches a paginated list of select list issue field options added by connect apps. not for jira-created options. requires administer jira permission; no jira permissions needed for the app's field.
</Accordion>

<Accordion title="Get all metadata for an expanded attachment">
  Summarizes metadata retrieval for attachments, specifically zip files. includes id and name access, with project browsing rights and issue security permissions if needed. anonymous access allowed.
</Accordion>

<Accordion title="Delete locale">
  Use the user management rest api's update a user profile instead of deprecated method to revert user's locale to default. requires jira access permission.
</Accordion>

<Accordion title="Find components for projects">
  Get a paginated list of all project components, including global ones, anonymously. requires "browse projects" permission for the project.
</Accordion>

<Accordion title="Get all permissions">
  Returns all permissions, including: \* global permissions. \* project permissions. \* global permissions added by plugins. this operation can be accessed anonymously. **[permissions](https://dac-static.atlassian.com) required:** none.
</Accordion>

<Accordion title="Delete workflow transition rule configurations">
  This operation allows connect apps to delete their own post functions, conditions, and validators from workflows. permissions are exclusive to connect apps.
</Accordion>

<Accordion title="Get all issue type schemes">
  Retrieves a paginated list of issue type schemes for classic projects. requires "administer jira" global permission.
</Accordion>

<Accordion title="Get all projects">
  Deprecated method returns all projects a user can see. use the paginated "get projects" with search support instead. anonymous access available. requires 'browse' or 'administer' project permissions.
</Accordion>

<Accordion title="Get all project avatars">
  This api returns both system and custom project avatars without login. users need 'browse projects' permission for access.
</Accordion>

<Accordion title="Delete related work">
  This operation allows anonymous users to delete related work for a specific version, provided they have 'resolve issues' and 'edit issues' permissions for the project containing the version.
</Accordion>

<Accordion title="Get all project roles">
  Jira cloud project roles let users customize member associations per project, affecting permissions and workflows. "actors" are users/groups in roles, adjustable by admins either as defaults or per project.
</Accordion>

<Accordion title="Find users with permissions">
  Generates a user list based on criteria, access levels, and scope while respecting privacy. fully inclusive without searches. accessible without login but needs jira or admin rights.
</Accordion>

<Accordion title="Get all project categories">
  Returns all project categories. **[permissions](https://dac-static.atlassian.com) required:** permission to access jira.
</Accordion>

<Accordion title="Get all project types">
  Returns all [project types](https://confluence.atlassian.com/x/var1nw), whether or not the instance has a valid license for each type. this operation can be accessed anonymously. **[permissions](https://dac-static.atlassian.com) required:** none.
</Accordion>

<Accordion title="Get all screen tabs">
  Lists tabs on a screen, requiring "administer jira" global permission or "administer projects" within a project, linked via screen and issue type screen schemes.
</Accordion>

<Accordion title="Find groups">
  This service retrieves and highlights groups based on a search, suggesting matches while filtering unwanted ones. it sorts the results, shows totals, and allows anonymous queries with limited features.
</Accordion>

<Accordion title="Delete issue link type">
  This operation removes an issue link type in jira, but it requires the site to have issue linking enabled and the user to have 'administer jira' global permissions.
</Accordion>

<Accordion title="Delete notification scheme">
  Deletes a notification scheme. **[permissions](https://dac-static.atlassian.com) required:** *administer jira* [global permission](https://confluence.atlassian.com/x/x4dklg).
</Accordion>

<Accordion title="Get all screen tab fields">
  Summary: this function retrieves all fields for a jira screen tab, requiring "administer jira" global permission or "administer projects" permission if a project key is provided and the screen is linked via screen and issue type screen schemes.
</Accordion>

<Accordion title="Delete vote">
  The process removes a user's vote from an issue in jira, which needs 'allow users to vote on issues' enabled in general config. permissions needed: 'browse projects' for the project and issue-level security if applicable. see jira docs for details.
</Accordion>

<Accordion title="Get all statuses for project">
  This api returns valid statuses for project issues, based on issue type. accessible anonymously but requires "browse projects" permission for the relevant project.
</Accordion>

<Accordion title="Get all permission schemes">
  Jira's permission schemes pair holders with specific permissions based on holder type and id, covering project and issue management, with the option for custom permissions.
</Accordion>

<Accordion title="Find user keys by query">
  The operation searches and returns a paginated list of users based on a query, with filters and limits defined by `startat` and `maxresults`. it requires appropriate permissions and can handle complex queries with logical operators.
</Accordion>

<Accordion title="Delete issue property">
  This operation allows anonymous users to delete an issue's property, provided they have 'browse projects' and 'edit issues' permissions for the project, and issue-level security permissions if applicable.
</Accordion>

<Accordion title="Delete remote issue link by id">
  This operation deletes a remote issue link and requires active issue linking. anonymous access is allowed. permissions needed: browse, edit, and link issues within the project, and issue-level security if set.
</Accordion>

<Accordion title="Delete permission scheme">
  Deletes a permission scheme. **[permissions](https://dac-static.atlassian.com) required:** *administer jira* [global permission](https://confluence.atlassian.com/x/x4dklg).
</Accordion>

<Accordion title="Delete webhooks by id">
  Deletes only the calling app's webhooks by id, ignoring others. requires connect and oauth 2.0 app permissions.
</Accordion>

<Accordion title="Delete remote issue link by global id">
  Remove a remote issue link using its global id with escaped url characters. issue linking must be active. anonymous access allowed. requires 'browse projects' and 'link issues' permissions, plus issue-level security if applicable.
</Accordion>

<Accordion title="Delete worklog property">
  Removes a worklog property, available without login. requires 'browse projects' permission, issue-level security permission if set, and appropriate group or role if worklog visibility is restricted.
</Accordion>

<Accordion title="Delete workflow for issue type in draft workflow scheme">
  Deletes the issue type-workflow mapping for an issue type in a workflow scheme's draft. **[permissions](https://dac-static.atlassian.com) required:** *administer jira* [global permission](https://confluence.atlassian.com/x/x4dklg).
</Accordion>

<Accordion title="Delete permission scheme grant">
  Removes a permission grant from a scheme; requires *administer jira* global permission. details: [about permission schemes and grants](../api-group-permission-schemes/#about-permission-schemes-and-grants).
</Accordion>

<Accordion title="Delete worklog">
  Deletes a worklog from an issue. the user must have permission to delete the worklog by being the worklog author, having the delete all worklogs permission, or the administer project permission.
</Accordion>

<Accordion title="Delete issue security scheme">
  Deletes an issue security scheme. **[permissions](https://dac-static.atlassian.com) required:** *administer jira* [global permission](https://confluence.atlassian.com/x/x4dklg).
</Accordion>

<Accordion title="Get all statuses">
  Returns a list of all statuses available in jira. this action retrieves information about all issue statuses, including their ids, names, descriptions, and categories. this is particularly useful for workflow management and understanding the possible states an issue can be in.
</Accordion>

<Accordion title="Delete resolution">
  Asynchronously deletes an issue resolution. track the task status through the 'location' link response and use 'get task' for updates. administer jira global permission is required.
</Accordion>

<Accordion title="Delete watcher">
  To delete an issue watcher in jira, "allow users to watch issues" must be enabled. requires "browse projects" permission, issue-level security view access, and "manage watcher list" to remove others. see links for configuration and permissions.
</Accordion>

<Accordion title="Delete screen">
  Deletes a screen. a screen cannot be deleted if it is used in a screen scheme, workflow, or workflow draft. only screens used in classic projects can be deleted.
</Accordion>

<Accordion title="Delete priority">
  The text announces the deprecation of an issue priority deletion api, referring to the changelog for details. the deletion process is asynchronous, requiring admin permissions for jira, with status updates accessible via provided links.
</Accordion>

<Accordion title="Delete preference">
  The text describes how to reset a user preference to default settings in jira, noting that 'jira.user.locale' and 'jira.user.timezone' are deprecated, and recommending the user management rest api with proper permissions.
</Accordion>

<Accordion title="Edit issue">
  Issue edits update properties but not transitions via `update` and `fields`, accessible by key/id. to remove parent, use `update.parent.set.none`. admins may override screen security; anonymous edits allowed with correct permissions.
</Accordion>

<Accordion title="Get all users default">
  Provides a list of all atlassian account users with privacy filters applied based on preferences, which might hide emails. requires "browse users and groups" permission. more info on profile visibility is available.
</Accordion>

<Accordion title="Get all status categories">
  Returns a list of all status categories. **[permissions](https://dac-static.atlassian.com) required:** permission to access jira.
</Accordion>

<Accordion title="Get all time tracking providers">
  Jira has a default time tracking provider, with more available via atlassian marketplace apps. admin rights are needed for access and configuration. for details, visit the time tracking provider module.
</Accordion>

<Accordion title="Get approximate license count">
  This api returns an estimate of jira user accounts, caching data for 7 days. admin rights are required for access.
</Accordion>

<Accordion title="Get create metadata issue types for a project">
  This operation provides issue type metadata for a project to help with issue creation requests and can be used without login. *create issues* permission in the project is required.
</Accordion>

<Accordion title="Get all users">
  Get all users in jira action class. this action retrieves a list of all jira users including active, inactive, and deleted users that have not been removed from the database. it supports pagination parameters such as startat and maxresults, and requires 'browse users and groups' permission. returns: a list of user objects containing user details like account id, display name, email, etc.
</Accordion>

<Accordion title="Get comments">
  This operation anonymously retrieves all comments from an issue. users need "browse projects" permission, issue-level security permission, and must belong to the right group or role if comments have visibility restrictions.
</Accordion>

<Accordion title="Get approximate application license count">
  Retrieves an estimated count of user accounts for a jira license, data cached for 7 days. administer jira global permission required.
</Accordion>

<Accordion title="Get attachment thumbnail">
  Generates a thumbnail for an attachment, accessible without login. requires 'browse projects' permission and, if applicable, issue-level security permission. details: [get attachment content](https://dac-static.atlassian.com).
</Accordion>

<Accordion title="Get all workflows">
  Deprecated method returns either a single workflow or all jira workflows; use "get workflows paginated" instead. requires "administer jira" global permission. if `workflowname` is given, a single object is returned, otherwise an array.
</Accordion>

<Accordion title="Get dashboard item property keys">
  This operation lists dashboard item keys and allows anonymous access. users must be owners or have shared access. administrators are deemed system dashboard owners, accessible to all if anonymous access in jira is allowed.
</Accordion>

<Accordion title="Get data policy for the workspace eap">
  Returns data policy for the workspace.
</Accordion>

<Accordion title="Get app properties">
  Summary: connect app with matching `addonkey` can retrieve all its properties. forge apps also have access to these properties if linked to the same `app.connect.key`. permissions required.
</Accordion>

<Accordion title="Get columns">
  Retrieves filter's column configuration used in list view when columns set to filter, available anonymously. only returns details for filters owned, shared with user's group, or projects where user has permissions.
</Accordion>

<Accordion title="Get data policy for projects eap">
  Returns data policies for the projects specified in the request.
</Accordion>

<Accordion title="Get create issue metadata">
  Detailed project and issue type data for user requests in jira creation screens, now deprecated. information filters by query and accessible without login. requires project "create issues" permission. see deprecation notice for alternatives.
</Accordion>

<Accordion title="Get dashboard item property">
  The api allows users to customize app dashboard gadgets and provides item ids but lacks resource for item management. it supports anonymous access for owners or permitted users.
</Accordion>

<Accordion title="Get dynamic webhooks for app">
  Provides a paginated list of webhooks for the calling app, accessible only by connect and oauth 2.0 apps.
</Accordion>

<Accordion title="Get current user">
  This tool retrieves detailed information about the currently authenticated user in jira. it is essential for verifying authentication, getting user-specific information, checking user permissions, retrieving preferences, and identifying the user for further api operations.
</Accordion>

<Accordion title="Get comment">
  This tool retrieves a specific comment from a jira issue. it requires the 'issueidorkey' and 'id' parameters (with an optional 'expand' parameter) to fetch detailed information about a comment, including its content, author details, creation and update dates, and more. this action is essential for viewing and managing specific issue discussions in jira.
</Accordion>

<Accordion title="Get avatar image by id">
  Get a project or issue type avatar image by id. accessible without login for system avatars; requires "browse projects" permission for custom avatars related to specific projects or issue types.
</Accordion>

<Accordion title="Get edit issue metadata">
  This endpoint shows user-accessible issue fields, factoring in availability, visibility, project context, and permissions. editability requires certain flags and permissions, with exceptions for fields like attachments. anonymous use is permitted.
</Accordion>

<Accordion title="Get all workflow schemes">
  The service provides a paged list of all jira workflow schemes, excluding drafts. it requires the 'administer jira' global permission.
</Accordion>

<Accordion title="Get fields in trash paginated">
  Retrieves a paginated list of trashed custom fields matching a string in name/description. requires 'administer jira' permission.
</Accordion>

<Accordion title="Get comments by ids">
  Fetches a paginated list of comments by id, accessible anonymously if the user has relevant project permissions, issue-level security access, and visibility group or role rights.
</Accordion>

<Accordion title="Get events">
  Returns all issue events. **[permissions](https://dac-static.atlassian.com) required:** *administer jira* [global permission](https://confluence.atlassian.com/x/x4dklg).
</Accordion>

<Accordion title="Get field reference data get">
  The document offers guidance on jql search data, covering fields, functions, and reserved words for crafting jql queries and recommends using post to filter fields per project. access to the operation is unrestricted.
</Accordion>

<Accordion title="Get field auto complete suggestions">
  Get jql autocomplete suggestions for a field by specifying `fieldname`, with optional `fieldvalue`, `predicatename`, and `predicatevalue`. anonymous access is available. no permissions required.
</Accordion>

<Accordion title="Get fields paginated">
  Get a paginated list of classic jira project fields, including all fields, specific ones by `id`, or those with a string in their name or description using `query`. only "custom" type fields are searchable. requires jira admin permissions.
</Accordion>

<Accordion title="Get field configuration items">
  The text provides a link to a function that retrieves a paginated list of fields from classic company-managed project configurations, which requires jira admin global permissions.
</Accordion>

<Accordion title="Get app property">
  Returns an app's property key and value. access is limited to the connect app with a matching `addonkey` and forge apps with the same `app.connect.key`. permissions are required.
</Accordion>

<Accordion title="Get alternative issue types">
  Provides a list of alternative issue types sharing the same workflow, field configuration, and screen schemes. accessible without login. no permissions required.
</Accordion>

<Accordion title="Get field configuration issue type items">
  Generates a paginated list of field config issues for classic projects. requires 'administer jira' global permission.
</Accordion>

<Accordion title="Get audit records">
  Returns filtered audit records based on matches in specified fields, date range, and requires 'administer jira' global permission. filters include summary, category, event source, and various objectitem attributes.
</Accordion>

<Accordion title="Get field reference data post">
  The text offers a guide for jql searches with field/function info, reserved words, custom field filters by project, and efficient use of collapsed fields, all without needing permissions.
</Accordion>

<Accordion title="Get default actors for project role">
  Returns the [default actors](https://dac-static.atlassian.com) for the project role. **[permissions](https://dac-static.atlassian.com) required:** *administer jira* [global permission](https://confluence.atlassian.com/x/x4dklg).
</Accordion>

<Accordion title="Get avatar image by owner">
  This operation retrieves avatar images for projects or issue types, available anonymously. no permissions needed for system avatars. custom avatars require 'browse projects' permission for the related project or issue type.
</Accordion>

<Accordion title="Get custom field configurations">
  Retrieve a paginated list of configurations for a forge app's custom field type, filterable by id, fieldcontextid, issueid, or project/issue type. requires jira admin global permission.
</Accordion>

<Accordion title="Get field configuration schemes for projects">
  Provides a sorted, paginated list of field configuration schemes for classic projects, including associated project ids, with the first item being the default. requires jira admin permissions.
</Accordion>

<Accordion title="Get ids of deleted worklogs">
  Resource lists up to 1000 deleted worklog ids and timestamps after a specified date, with pagination using `until` and `nextpage`. excludes entries deleted in the last minute. jira access permission needed.
</Accordion>

<Accordion title="Get comment property">
  Retrieves a comment's value anonymously, needing 'browse projects' permission, issue-level security permission if set, and visibility group/role restrictions compliance if applied.
</Accordion>

<Accordion title="Get gadgets">
  The operation retrieves dashboard gadgets based on specified criteria: by list of ids, module key, list of uris, or all gadgets if no parameters are given. it can be accessed without any permissions.
</Accordion>

<Accordion title="Get group">
  Deprecated: to get group members, use `group/member` instead. requires "browse users and groups" or "administer jira" permissions.
</Accordion>

<Accordion title="Get ids of updated worklogs">
  Lists ids and timestamps of worklogs updated after a specific time, limited to 1000 per page and ordered by date. pagination available with `until` and `nextpage`. excludes last minute updates. viewing requires jira access and specific permissions.
</Accordion>

<Accordion title="Get filter">
  This operation anonymously returns a filter if it's owned by the user, shared within their group or project, or is public. no permissions required.
</Accordion>

<Accordion title="Get available gadgets">
  Gets a list of all available gadgets that can be added to all dashboards. **[permissions](https://dac-static.atlassian.com) required:** none.
</Accordion>

<Accordion title="Get default share scope">
  Returns the default sharing settings for new filters and dashboards for a user. **[permissions](https://dac-static.atlassian.com) required:** permission to access jira.
</Accordion>

<Accordion title="Get assigned permission scheme">
  Retrieves the project's permission scheme. requires 'administer jira' global permission or 'administer projects' project permission.
</Accordion>

<Accordion title="Get custom field contexts">
  Retrieve paginated custom field contexts from jira: get all, filter by ids, issue types, or project scope (global or limited). admin rights required.
</Accordion>

<Accordion title="Get avatar image by type">
  Returns the default project or issue type avatar image. this operation can be accessed anonymously. **[permissions](https://dac-static.atlassian.com) required:** none.
</Accordion>

<Accordion title="Get issue field option">
  This operation retrieves select list options from an issue field, but only for those added by connect apps. it won't work with options made directly in jira. administer jira permission is needed, but not jira permissions for the app's field.
</Accordion>

<Accordion title="Get issue link types">
  Fetches all issue link types if issue linking is active. accessible without login but requires 'browse projects' permission for any site project.
</Accordion>

<Accordion title="Get issue link">
  Creates an issue link accessible anonymously, requiring 'browse project' permission for all linked issues and viewing permissions if issue-level security is set.
</Accordion>

<Accordion title="Get default workflow">
  In jira, the default workflow applies to unassigned issue types within a scheme. requires *administer jira* global permission.
</Accordion>

<Accordion title="Get issue navigator default columns">
  Returns the default issue navigator columns. **[permissions](https://dac-static.atlassian.com) required:** *administer jira* [global permission](https://confluence.atlassian.com/x/x4dklg).
</Accordion>

<Accordion title="Get custom field contexts default values">
  Retrieve default settings for custom fields in jira, sorted by 'contextid'. different fields like date or user picker have varying defaults. no defaults returned if none set. supports forge fields; 'administer jira' rights needed.
</Accordion>

<Accordion title="Get available screen fields">
  Returns the fields that can be added to a tab on a screen. **[permissions](https://dac-static.atlassian.com) required:** *administer jira* [global permission](https://confluence.atlassian.com/x/x4dklg).
</Accordion>

<Accordion title="Get issue link type">
  Retrieves an issue link type from a site with issue linking enabled. anonymous access allowed. requires 'browse projects' permission for a project on the site.
</Accordion>

<Accordion title="Get issue">
  This tool retrieves the details of a specific jira issue using the get /rest/api/3/issue/\{issueidorkey} endpoint. it returns all relevant issue information, such as its summary, description, status, assignee, reporter, comments, attachments, and any custom fields configured in your jira instance.
</Accordion>

<Accordion title="Get issue picker suggestions">
  Provides auto-complete suggestions for issues via two lists: `history search` with user's past issues containing a query string, and `current search` with issues matching a jql expression and the query. accessible anonymously, no permissions needed.
</Accordion>

<Accordion title="Get comment property keys">
  Retrieves all comment property keys; accessible anonymously with 'browse projects' permission, issue-level security permission if set, and visibility restrictions adherence if applicable.
</Accordion>

<Accordion title="Get attachment content">
  Retrieves attachment contents with optional byte range. use 'get attachment thumbnail' for images. accessible anonymously, but requires 'browse projects' permission and issue-level security access if set. see http range header for byte ranges.
</Accordion>

<Accordion title="Get issue property">
  Returns the value of a property for an issue. this action makes a get request to the /rest/api/3/issue/\{issueidorkey}/properties/\{propertykey} endpoint and returns details including the key and value for the issue property. the operation can be accessed anonymously. permissions required: - browse projects project permission for the project containing the issue. - if issue-level security is configured, issue-level security permission to view the issue.
</Accordion>

<Accordion title="Get bulk permissions">
  The operation displays user access to projects/issues, defaults to the user, ignores invalid input, and caps at 1000. post-06/15/2024, anonymous users allowed, others require admin, and connected apps gain more rights.
</Accordion>

<Accordion title="Get issue resolutions">
  Returns a list of all issue resolution values. this tool retrieves all configured resolution types in the jira instance, providing details such as resolution ids, names, descriptions, and urls. it is useful for: - getting a list of available resolution types - finding the default resolution - obtaining resolution ids for other api calls - validating resolution names and ids before updating issues - understanding what options are available when closing issues
</Accordion>

<Accordion title="Get issue property keys">
  This operation provides urls and keys for an issue's properties, available anonymously, but requires the user to have *browse projects* permission and, if applicable, *issue-level security* permission to view the details.
</Accordion>

<Accordion title="Get issue security level">
  Summarizes issue security level details. ids can be found using the "get issue security scheme". accessible anonymously with no permissions needed.
</Accordion>

<Accordion title="Get draft default workflow">
  The default workflow for a jira workflow scheme draft assigns unmapped issue types to a specific workflow labeled *all unassigned issue types*. administering jira global permission is needed to access it.
</Accordion>

<Accordion title="Get custom field contexts for projects and issue types">
  Returns a paginated list of project-issue type mappings with applicable custom field context ids. if no specific context is assigned, a default one is used. duplicates aren't allowed in the request. administer jira global permission is required.
</Accordion>

<Accordion title="Get available workflow capabilities">
  Access workflow features with workflow/project id, including scope, types, rules, and sources. admin rights required. api gives details for validators/conditions and post functions.
</Accordion>

<Accordion title="Get component">
  Returns a component. this operation can be accessed anonymously. **[permissions](https://dac-static.atlassian.com) required:** *browse projects* [project permission](https://confluence.atlassian.com/x/yodklg) for project containing the component.
</Accordion>

<Accordion title="Get attachment metadata">
  Retrieves an attachment's metadata without returning the file. accessible anonymously; requires 'browse projects' permission and, if applicable, issue-level security permission.
</Accordion>

<Accordion title="Get issue security level members by issue security scheme">
  The text describes that only members with issue security levels from classic projects are returned. administering jira global permission is required for access.
</Accordion>

<Accordion title="Get issue security schemes">
  Returns all [issue security schemes](https://confluence.atlassian.com/x/j4lklg). **[permissions](https://dac-static.atlassian.com) required:** *administer jira* [global permission](https://confluence.atlassian.com/x/x4dklg).
</Accordion>

<Accordion title="Get issue security scheme">
  The text describes that a user can retrieve an issue security scheme and its levels if they have "administer jira" global permission or "administer projects" permission for a project using the scheme.
</Accordion>

<Accordion title="Get issue security levels">
  The service provides a paginated list of issue security levels for classic projects, with inclusive filtering by security scheme or level ids. jira administration permission is required.
</Accordion>

<Accordion title="Get issue type">
  Operation returns an issue type and can be used without login. requires "browse projects" permission in the relevant project or "administer jira" global permission.
</Accordion>

<Accordion title="Get issue security level members">
  Provides a paginated list of issue security level members for classic projects. filtering by security scheme and level ids is possible. requires 'administer jira' global permission.
</Accordion>

<Accordion title="Get component issues count">
  The operation counts component-assigned issues and allows anonymous access. it will update oauth 2.0 scopes on june 15, 2024, requiring `read:jira-work` or granular permissions. no permissions needed currently.
</Accordion>

<Accordion title="Get custom field option">
  Retrieval of jira custom field options from select lists requires *administer jira* or *browse projects* permissions and is not for connect app fields. anonymous access allowed.
</Accordion>

<Accordion title="Get bulk screen tabs">
  Returns the list of tabs for a bulk of screens. **[permissions](https://dac-static.atlassian.com) required:** \* *administer jira* [global permission](https://confluence.atlassian.com/x/x4dklg).
</Accordion>

<Accordion title="Get issue types for workflows in draft workflow scheme">
  Returns the workflow-issue type mappings for a workflow scheme's draft. **[permissions](https://dac-static.atlassian.com) required:** *administer jira* [global permission](https://confluence.atlassian.com/x/x4dklg).
</Accordion>

<Accordion title="Get issue types for custom field context">
  Provides a paginated list of custom field context to issue type mappings, ordered by context and issue type ids. available for all or specific contexts. requires jira admin global permission.
</Accordion>

<Accordion title="Get draft workflow scheme">
  Draft workflow schemes allow edits to active workflow schemes. when updated, a draft is made and modified; changes are then applied to the active scheme. only one draft per active scheme is allowed. admin rights required. more info on links provided.
</Accordion>

<Accordion title="Get contents metadata for an expanded attachment">
  This operation extracts metadata from files within a zip attachment anonymously, ideal for backend use. it requires 'browse projects' permission and respects issue-level security. for comprehensive attachment metadata, use 'get all metadata'.
</Accordion>

<Accordion title="Get changelogs">
  Access a paginated, date-ordered list of issue changelogs anonymously. requires 'browse projects' permission and, if set, issue-level security clearance.
</Accordion>

<Accordion title="Get issue types for project">
  This operation retrieves project issue types and can be used without login. required permissions: either "browse projects" in the project or "administer jira" globally.
</Accordion>

<Accordion title="Get avatars">
  This operation retrieves both system and custom avatars for projects or issue types, accessible even anonymously. custom avatars require the "browse projects" permission for the relevant project or issue type. system avatars require no permissions.
</Accordion>

<Accordion title="Get favorite filters">
  Returns user's visible favorite filters, including those owned, shared with their groups, their private/public projects, or the public. anonymous access allowed. filters not returned if access changes. (255 characters)
</Accordion>

<Accordion title="Get fields">
  The system shows essential and globally-configured jira fields, plus additional ones if the user has permission. anonymous users can access without permissions.
</Accordion>

<Accordion title="Get contexts for a field">
  Deprecated api to get a paginated list of field contexts is replaced by "get custom field contexts." admin rights required.
</Accordion>

<Accordion title="Get custom field options context">
  Returns a paginated list of custom field options, both normal and cascading, in display order for jira contexts. for connect app select list options, use specified issue custom field options operations. admin jira permissions required.
</Accordion>

<Accordion title="Get changelogs by ids">
  Retrieve issue changelogs by their ids; accessible without login. requires 'browse projects' permission and, if applicable, issue-level security clearance.
</Accordion>

<Accordion title="Get create field metadata for a project and issue type id">
  Retrieves field metadata for a project and issuetype to use in issue creation on atlassian. accessible anonymously with 'create issues' project permission needed.
</Accordion>

<Accordion title="Get global settings">
  Retrieves jira's global settings to check enabled features like subtasks, time tracking; includes time tracking config if active. access permission required.
</Accordion>

<Accordion title="Get dashboard">
  Anonymous users can access a dashboard. no permissions needed. to get a specific dashboard, it must be shared or owned by the user. 'administer jira' holders are deemed system dashboard owners, which is shared with all users.
</Accordion>

<Accordion title="Get failed webhooks">
  Lists recently failed webhook delivery attempts to connect apps within 72 hours, using cursor pagination. returns oldest failure first; use `failedafter` or provided url for next page.
</Accordion>

<Accordion title="Get application role">
  Returns an application role. **[permissions](https://dac-static.atlassian.com) required:** *administer jira* [global permission](https://confluence.atlassian.com/x/x4dklg).
</Accordion>

<Accordion title="Get application property">
  Get a single application property by specifying a `key` or an array of all editable properties. administer jira rights required. see links for property descriptions and permissions.
</Accordion>

<Accordion title="Get announcement banner configuration">
  Returns the current announcement banner configuration. **[permissions](https://dac-static.atlassian.com) required:** *administer jira* [global permission](https://confluence.atlassian.com/x/x4dklg).
</Accordion>

<Accordion title="Get permission scheme grant">
  Returns a permission grant. **[permissions](https://dac-static.atlassian.com) required:** permission to access jira.
</Accordion>

<Accordion title="Get issue type property keys">
  Get all issue type property keys; anonymous access allowed. requires 'administer jira' for any issue type; 'browse projects' for permitted projects.
</Accordion>

<Accordion title="Get issue type property">
  Access key and value of jira issue type property anonymously. requires 'administer jira' for any issue type, 'browse projects' for associated projects' permissions.
</Accordion>

<Accordion title="Get my permissions">
  Permissions vary by context (global, project, issue, comment) in a system; project rights can change with issue data. global permissions are constant, and some operations don't require login or permissions.
</Accordion>

<Accordion title="Get licensed project types">
  Returns all [project types](https://confluence.atlassian.com/x/var1nw) with a valid license.
</Accordion>

<Accordion title="Get projects using notification schemes paginated">
  Generates a list of company-managed projects with their notification plans through pagination, filtering by id, or displaying all by default. limited to projects with default schemes, jira access needed.
</Accordion>

<Accordion title="Get issue watchers">
  Gets the list of watchers for an issue. a watcher is a user who receives notifications when the issue is updated. this endpoint requires the 'browse projects' project permission for the project containing the issue. this operation requires the "allow users to watch issues" option to be on. this option is set in general configuration for jira.
</Accordion>

<Accordion title="Get notification scheme">
  This text describes a notification scheme in jira that outlines events and their notification recipients. access requires jira permissions and project administration rights.
</Accordion>

<Accordion title="Get issue type screen schemes for projects">
  Retrieves a paginated list of issue type screen schemes with their associated classic projects. requires jira admin global permission.
</Accordion>

<Accordion title="Get permission scheme">
  Returns a permission scheme. **[permissions](https://dac-static.atlassian.com) required:** permission to access jira.
</Accordion>

<Accordion title="Get license">
  Returns licensing information about the jira instance. **[permissions](https://dac-static.atlassian.com) required:** none.
</Accordion>

<Accordion title="Get locale">
  This resource returns a user's locale in jira: if unset or anonymous, the detected browser locale via 'accept-language' header is used, falling back to jira's default if no match is found. anonymous access is allowed; no permissions needed.
</Accordion>

<Accordion title="Get project notification scheme">
  The text outlines that to access the project's notification scheme, one needs either the 'administer jira' global permission or the 'administer projects' project permission.
</Accordion>

<Accordion title="Get issue types for workflows in workflow scheme">
  Returns the workflow-issue type mappings for a workflow scheme. **[permissions](https://dac-static.atlassian.com) required:** *administer jira* [global permission](https://confluence.atlassian.com/x/x4dklg).
</Accordion>

<Accordion title="Get notification schemes paginated">
  Generates a paginated list of notification schemes, sorted by name, including those with no recipients. requires jira access and admin rights to a related project for scheme visibility.
</Accordion>

<Accordion title="Get issue worklogs">
  Gets all work logs for an issue. the response includes details of all work logs for the issue that the user has permission to view. this action is essential for tracking time spent on issues and provides a comprehensive view of work logged against a specific issue, making it useful for project management, time tracking, and reporting purposes. permissions required: - browse projects project permission for the project that the issue is in. - if issue-level security is configured, issue-level security permission to view the issue. - if the worklog has visibility restrictions, belongs to the group or has the role visibility is restricted to.
</Accordion>

<Accordion title="Get issue type scheme">
  This tool retrieves detailed information about a specific issue type scheme in jira. an issue type scheme defines the mapping between issue types and projects. the action will return information about the scheme including its name, description, and the issue types associated with it.
</Accordion>

<Accordion title="Get project category by id">
  Returns a project category. **[permissions](https://dac-static.atlassian.com) required:** permission to access jira.
</Accordion>

<Accordion title="Get permission scheme grants">
  Returns all permission grants for a permission scheme. **[permissions](https://dac-static.atlassian.com) required:** permission to access jira.
</Accordion>

<Accordion title="Get project property">
  Retrieves the value of a jira project property, available even without authentication. requires 'browse projects' permission for the associated project.
</Accordion>

<Accordion title="Get screen schemes">
  Fetches a paginated list of screen schemes for classic projects, requiring the administer jira global permission.
</Accordion>

<Accordion title="Get required status mappings for workflow scheme update">
  The text outlines how to get status mappings for updating workflow schemes in jira, specifying that permissions such as 'administer jira' and 'administer projects' are required for updates.
</Accordion>

<Accordion title="Get project roles for project">
  Jira cloud provides a list of project roles with names and urls, accessible even anonymously. roles are shared across projects. admin rights needed. see details and permission links online.
</Accordion>

<Accordion title="Get screens for a field">
  Returns a [paginated](https://dac-static.atlassian.com) list of the screens a field is used in. **[permissions](https://dac-static.atlassian.com) required:** *administer jira* [global permission](https://confluence.atlassian.com/x/x4dklg).
</Accordion>

<Accordion title="Get permitted projects">
  Returns all the projects where the user is granted a list of project permissions. this operation can be accessed anonymously. **[permissions](https://dac-static.atlassian.com) required:** none.
</Accordion>

<Accordion title="Get project role for project">
  Retrieves project role details and associated actors, ordered by name. use 'get user' with 'groups' parameter to confirm user-role membership. anonymous access allowed. requires 'administer projects' or 'administer jira' permissions.
</Accordion>

<Accordion title="Get project role by id">
  The text provides a project role description and its default actors, sorted by display name, requiring 'administer jira' global permission for access.
</Accordion>

<Accordion title="Get remote issue link by id">
  The operation fetches a remote issue link, requires active issue linking, and can be anonymous. permissions needed: 'browse projects' for the issue's project and issue-level security if configured.
</Accordion>

<Accordion title="Get issue type screen scheme items">
  Retrieves a paginated list of issue type screen scheme items for classic projects. requires *administer jira* global permission.
</Accordion>

<Accordion title="Get project role details">
  Fetches all common project roles and their details. can be accessed without login. requires 'administer jira' or 'administer projects' permissions.
</Accordion>

<Accordion title="Get issue type screen scheme projects">
  Returns a paginated list of company-managed projects linked to an issue type screen scheme. requires 'administer jira' global permission.
</Accordion>

<Accordion title="Get project property keys">
  This api endpoint retrieves all property keys for a project and is accessible without login. users need 'browse projects' permission for access.
</Accordion>

<Accordion title="Get related work">
  Anonymously access work items linked to a specific version id; 'browse projects' permission needed for the associated project.
</Accordion>

<Accordion title="Get project components">
  The api returns all components in a project, offering a paginated list for projects with compass components. it's accessible anonymously but requires 'browse projects' permission. for full pagination, refer to a specific resource.
</Accordion>

<Accordion title="Get selected time tracking provider">
  The current time tracking provider is returned; if disabled, an empty response is given. administer jira global permission is required.
</Accordion>

<Accordion title="Get resolution">
  Returns an issue resolution value. **[permissions](https://dac-static.atlassian.com) required:** permission to access jira.
</Accordion>

<Accordion title="Get project components paginated">
  The api returns a paginated list of project components, including compass components linked to issues. anonymous access is supported if users have the 'browse projects' permission.
</Accordion>

<Accordion title="Get selectable issue field options">
  Provides a paginated list of select list issue field options from connect apps, not usable with jira-native options. requires jira access permissions.
</Accordion>

<Accordion title="Get user default columns">
  Returns the default issue table columns for a user. if no `accountid` is provided, the caller's details are returned. admin rights are needed to retrieve any user's details; jira access is required for one's own details.
</Accordion>

<Accordion title="Get resolutions">
  Returns a list of all issue resolution values. **[permissions](https://dac-static.atlassian.com) required:** permission to access jira.
</Accordion>

<Accordion title="Get modules">
  Returns all modules registered dynamically by the calling app. **[permissions](https://dac-static.atlassian.com) required:** only connect apps can make this request.
</Accordion>

<Accordion title="Get project type by key">
  Returns a [project type](https://confluence.atlassian.com/x/var1nw). this operation can be accessed anonymously. **[permissions](https://dac-static.atlassian.com) required:** none.
</Accordion>

<Accordion title="Get share permission">
  Summarizes filter share permissions: filters can be shared with user-owned groups, projects, logged-in users, or public. they can be accessed without login but only show if relevant to the user based on ownership or group/project membership.
</Accordion>

<Accordion title="Get share permissions">
  The function fetches various filter share permissions, including those for groups, projects, and public access, while enabling anonymous queries for user-specific and public filters.
</Accordion>

<Accordion title="Get user">
  User data is returned with respect to privacy settings, possibly concealing the email. more info on profile visibility and required "browse users and groups" global permission is available online.
</Accordion>

<Accordion title="Get status category">
  Returns a status category. status categories provided a mechanism for categorizing [statuses](https://dac-static.atlassian.com). **[permissions](https://dac-static.atlassian.com) required:** permission to access jira.
</Accordion>

<Accordion title="Get issue type schemes for projects">
  The text provides a link to access paginated lists of issue type schemes and their associated classic projects in jira. admin jira global permission is required for access.
</Accordion>

<Accordion title="Get project s sender email">
  Returns the [project's sender email address](https://confluence.atlassian.com/x/dolklg). **[permissions](https://dac-static.atlassian.com) required:** *browse projects* [project permission](https://confluence.atlassian.com/x/yodklg) for the project.
</Accordion>

<Accordion title="Get status">
  The operation retrieves a status linked to an active workflow, prioritizing the first status found if multiple have the same name. status can be fetched by id for specificity. no permissions needed; anonymous access allowed.
</Accordion>

<Accordion title="Get project features">
  Returns the list of features for a project.
</Accordion>

<Accordion title="Get transitions">
  This tool returns all transitions or a specific transition for an issue based on its status. it helps in determining available status changes and understanding what workflow transitions (including required screens and conditions) are available for an issue.
</Accordion>

<Accordion title="Get screens">
  Retrieves a paginated list of screens, filterable by specific screen ids. requires 'administer jira' global permission.
</Accordion>

<Accordion title="Get issue type scheme items">
  Get a paginated list of issue type scheme items for classic projects. requires the 'administer jira' global permission.
</Accordion>

<Accordion title="Get ui modifications">
  Gets ui modifications. ui modifications can only be retrieved by forge apps. **[permissions](https://dac-static.atlassian.com) required:** none.
</Accordion>

<Accordion title="Get user property">
  Returns a user's property value; if no key is provided, it lists available keys. does not access jira user properties. requires *administer jira* permission for others' properties, or user access for own.
</Accordion>

<Accordion title="Get user groups">
  Returns the groups to which a user belongs. **[permissions](https://dac-static.atlassian.com) required:** *browse users and groups* [global permission](https://confluence.atlassian.com/x/x4dklg).
</Accordion>

<Accordion title="Get user email">
  Returns a user's email address. this api is only available to apps approved by atlassian, according to these [guidelines](https://community.developer.atlassian.com/t/guidelines-for-requesting-access-to-email-address/27603).
</Accordion>

<Accordion title="Get users from group">
  The service provides a paginated list of users in a group, sorted by username (which is not shown for privacy), with required permissions being "browse users and groups" or "administer jira."
</Accordion>

<Accordion title="Get version s unresolved issues count">
  This operation provides the number of total and unresolved issues in a project version, is available without login, and requires 'browse projects' permission.
</Accordion>

<Accordion title="Get visible issue field options">
  Retrieves a user-viewable, paginated list of select list issue field options from connect apps only, not those created in jira or via the issue custom field options resource. jira access is required.
</Accordion>

<Accordion title="Get my filters">
  Fetches user's owned filters; includes favorites if `includefavourites` is true. requires jira access permission. visibility depends on ownership, group membership, or project permissions. if a favorited public filter goes private, it won't be returned.
</Accordion>

<Accordion title="Get user property keys">
  This function retrieves all property keys for a user but excludes jira-specific user properties. admin global permission is required for any user's keys, while jira access is needed for one's own keys.
</Accordion>

<Accordion title="Get valid project name">
  Validates project name availability, returning the original or a modified version with a sequence number. if a valid name can't be created, a 404 error is issued. no permissions required.
</Accordion>

<Accordion title="Get version">
  This operation retrieves a project version and is publicly accessible. however, browsing the project containing the version necessitates the "browse projects" permission.
</Accordion>

<Accordion title="Get user email bulk">
  Returns a user's email address. this api is only available to apps approved by atlassian, according to these [guidelines](https://community.developer.atlassian.com/t/guidelines-for-requesting-access-to-email-address/27603).
</Accordion>

<Accordion title="Get issue type screen schemes">
  Retrieves a paginated list of issue type screen schemes for classic projects. requires 'administer jira' global permission.
</Accordion>

<Accordion title="Get valid project key">
  Validates a project key and, if the key is invalid or in use, generates a valid random string for the project key. **[permissions](https://dac-static.atlassian.com) required:** none.
</Accordion>

<Accordion title="Get project issue security levels">
  This operation lists project-specific issue security levels accessible to the user, anonymously available but requires 'browse projects' and 'set issue security' permissions for detailed access.
</Accordion>

<Accordion title="Get workflow scheme">
  Returns a workflow scheme. **[permissions](https://dac-static.atlassian.com) required:** *administer jira* [global permission](https://confluence.atlassian.com/x/x4dklg).
</Accordion>

<Accordion title="Get workflow for issue type in draft workflow scheme">
  Returns the issue type-workflow mapping for an issue type in a workflow scheme's draft. **[permissions](https://dac-static.atlassian.com) required:** *administer jira* [global permission](https://confluence.atlassian.com/x/x4dklg).
</Accordion>

<Accordion title="Get project versions">
  Action to get all versions in a specified jira project. this tool retrieves all versions in a specified jira project. it provides a comprehensive list of project versions with their details including version id, version name, release status, start and release dates, and description. requires 'browse projects' project permission.
</Accordion>

<Accordion title="Get workflows paginated">
  Fetches a paginated list of classic workflows, detailing specified names or all published ones; excludes next-gen workflows. requires 'administer jira' global permission.
</Accordion>

<Accordion title="Get workflow transition properties">
  The text describes how transition properties affect workflow transitions in jira, linking to related resources. admin rights are necessary to make changes.
</Accordion>

<Accordion title="Get time tracking settings">
  Retrieves time tracking configurations like format and units. requires 'administer jira' global permission. more details: \[configuring time tracking] and \[permissions].
</Accordion>

<Accordion title="Get system avatars by type">
  Returns a list of system avatar details by owner type, where the owner types are issue type, project, or user. this operation can be accessed anonymously. **[permissions](https://dac-static.atlassian.com) required:** none.
</Accordion>

<Accordion title="Get task">
  This operation checks the status of a long-running async task, returning a json result when completed, retaining details for 14 days. oauth scopes update on june 15, 2024. requires admin permission or task creator access.
</Accordion>

<Accordion title="Get worklogs">
  The service returns up to 1000 worklog details for specified ids. access requires jira permissions, and worklogs are shown if they're public or if the user has viewing rights through a project role or group.
</Accordion>

<Accordion title="Get project issue type hierarchy">
  A project's issue hierarchy may have optional epics at top, standard issues like story/task/bug, and optional subtasks for breakdown. browsing the project requires permissions.
</Accordion>

<Accordion title="Get project versions paginated">
  Fetches a paginated list of project versions; for a full list without pagination, use the get project versions resource. anonymous access allowed but requires browse projects permission.
</Accordion>

<Accordion title="Get recent projects">
  The feature shows up to 20 recent projects visible to the user, accessible anonymously with appropriate permissions to browse, administer the project, or administer jira.
</Accordion>

<Accordion title="Get workflow scheme project associations">
  Generates a list of workflow schemes linked to projects, detailing project associations per scheme. team-managed/non-existent projects are excluded silently. no id for projects using 'default workflow scheme'. admin rights required.
</Accordion>

<Accordion title="Get workflow for issue type in workflow scheme">
  Returns the issue type-workflow mapping for an issue type in a workflow scheme. **[permissions](https://dac-static.atlassian.com) required:** *administer jira* [global permission](https://confluence.atlassian.com/x/x4dklg).
</Accordion>

<Accordion title="Get the default data classification level of a project">
  The text outlines that to return the default data classification for a project, one needs browse projects and administer projects permissions for the project, as well as administer jira global permission.
</Accordion>

<Accordion title="Get priority">
  Returns an issue priority. **[permissions](https://dac-static.atlassian.com) required:** permission to access jira.
</Accordion>

<Accordion title="Get remote issue links">
  Gets the remote issue links for a jira issue. this operation requires the link issue permission. it retrieves external remote links associated with a jira issue, with the ability to filter by issue key and global id. permissions required: - browse projects project permission for the project that the issue is in. - if issue-level security is configured, issue-level security permission to view the issue.
</Accordion>

<Accordion title="Get project mappings for custom field context">
  The function provides a pageable list of mappings between context and projects for a custom field, filterable by `contextid`. requires the *administer jira* global permission. invalid ids are discarded.
</Accordion>

<Accordion title="Get votes">
  This tool retrieves voting information for a specified issue in jira. it returns details about the number of votes an issue has received and the users who have voted on it. it is used to get vote details, including the vote count, whether the current user has voted, and details about the voters. note: this operation requires the "allow users to vote on issues" option to be enabled in jira settings. users without the "view voters and watchers" project permission won't see details in the voters field. permissions required: - browse projects project permission - if issue-level security is configured, issue-level security permission to view the issue
</Accordion>

<Accordion title="Get version s related issues count">
  The operation counts issues for a version based on `fixversion`, `affectedversion`, and a custom field. it's accessible without login but requires *browse projects* permission for the relevant project.
</Accordion>

<Accordion title="Get jira instance info">
  Returns information about the jira instance. this operation can be accessed anonymously. **[permissions](https://dac-static.atlassian.com) required:** none.
</Accordion>

<Accordion title="Get project">
  This operation provides project details and is accessible even without logging in. however, one must have the 'browse projects' permission for the specific project to use it.
</Accordion>

<Accordion title="Get is watching issue bulk">
  The feature checks if a user watches issues from a list; invalid ids return `false`. it requires "watch issues" permission, project browsing, and issue security access. details on jira config and permissions.
</Accordion>

<Accordion title="Get jira attachment settings">
  The operation returns attachment settings, detailing if enabled and the size limit, with user restrictions set by project permissions. it's accessible without login. no permissions required.
</Accordion>

<Accordion title="Get worklog">
  Returns all work logs for an issue. the endpoint provides detailed information about each work log including time spent, the author, and work timestamps. it is useful for tracking time spent on issues, generating time reports, auditing work on issues, project management, resource allocation, and billing purposes. permissions required: - browse projects project permission - if issue-level security is configured, issue-level security permission to view the issue - if the worklog has visibility restrictions, belongs to the group or has the role visibility is restricted to
</Accordion>

<Accordion title="Get priorities">
  Returns the list of all issue priorities. **[permissions](https://dac-static.atlassian.com) required:** permission to access jira.
</Accordion>

<Accordion title="Get projects using issue security schemes">
  Retrieve paginated list of projects with security schemes by filtering with scheme/project ids. if none provided, all mappings shown. for classic projects only; 'administer jira' rights needed.
</Accordion>

<Accordion title="Get project issue security scheme">
  Summary: the text provides a link to the issue security scheme for a project and states that one needs either 'administer jira' global permission or 'administer projects' project permission to access it.
</Accordion>

<Accordion title="Get workflow transition rule configurations">
  Get a filtered, paginated list of workflows with transition rules created by connect or forge apps. can be refined by rule types or keys. some workflows with no rules might appear due to server optimizations. only available to connect/forge apps.
</Accordion>

<Accordion title="Get preference">
  Retrieve user preferences using the user management rest api before 15/07/2024, as locale/timezone keys are deprecated. notification keys remain unaffected. permissions needed.
</Accordion>

<Accordion title="Get precomputations apps">
  This api returns a list of a function's precomputations, including creation, update, and last-used timestamps, and each has a jql fragment (value). access is exclusively for apps to inspect their own functions.
</Accordion>

<Accordion title="Get projects paginated">
  The operation provides a paginated list of projects a user can see, which can be accessed without login. visibility depends on having browse, administer projects permission, or administer jira global permission.
</Accordion>

<Accordion title="Jira edit issue">
  This action edits an existing issue in jira. it accepts parameters such as issueidorkey, fields, update, notifyusers, overridescreensecurity, and overrideeditableflag. the action handles field validation, permission checks, screen and workflow validations, and error handling, and returns a 204 status when the issue is updated successfully.
</Accordion>

<Accordion title="Remove watcher from issue">
  Removes a user from an issue's list of watchers. this operation requires the user to have permission to view the issue and to manage the issue's watchers. permissions required: - browse projects project permission for the project that the issue is in. - if issue-level security is configured, issue-level security permission to view the issue. - to remove users other than themselves from the watchlist, manage watcher list project permission for the project that the issue is in.
</Accordion>

<Accordion title="Move screen tab">
  Moves a screen tab. **[permissions](https://dac-static.atlassian.com) required:** *administer jira* [global permission](https://confluence.atlassian.com/x/x4dklg).
</Accordion>

<Accordion title="Reorder custom field options context">
  This operation allows reordering of jira custom field options. for connect app fields, use "issue custom field options (apps)" operations. administer jira global permission is required.
</Accordion>

<Accordion title="List issue comments">
  This tool retrieves all comments for a specific jira issue. it accepts a required parameter 'issueidorkey' along with optional parameters for pagination and sorting. the response includes an array of comment objects containing details like author info, comment body, timestamps, and visibility settings.
</Accordion>

<Accordion title="Move screen tab field">
  Moves a screen tab field. if `after` and `position` are provided in the request, `position` is ignored. **[permissions](https://dac-static.atlassian.com) required:** *administer jira* [global permission](https://confluence.atlassian.com/x/x4dklg).
</Accordion>

<Accordion title="Replace custom field options">
  This operation updates custom field options for select lists in jira, but not for options from connect/forge apps. admin jira permissions are required.
</Accordion>

<Accordion title="Publish draft workflow scheme">
  A draft workflow scheme with new statuses for issue types is published. issue status updates are mapped accordingly. the process is asynchronous; track status via provided links. admin jira rights needed.
</Accordion>

<Accordion title="Get worklog property">
  Fetches a worklog property value. anonymous access allowed. requires 'browse projects' permission, issue security permission if set, and worklog visibility group/role access.
</Accordion>

<Accordion title="List boards">
  This tool retrieves all boards that the authenticated user has permission to view. it supports optional parameters (startat, maxresults, type, name, projectkeyorid, includeprivate, orderby) to filter and paginate the results.
</Accordion>

<Accordion title="Remove issue types from field configuration scheme">
  This operation removes issue types from field configuration schemes in classic projects and requires 'administer jira' global permissions.
</Accordion>

<Accordion title="Search for dashboards">
  Access a filtered, paginated list of dashboards with specific attributes. anonymous users can view public dashboards; logged-in users see more, based on ownership, group, and project access.
</Accordion>

<Accordion title="Move issue to sprint">
  This tool moves one or more jira issues to a specific sprint. the sprint must be active or open to receive issues. it accepts a sprint id and an array of issue keys (up to 50 issues per operation).
</Accordion>

<Accordion title="Move custom field to trash">
  Deletes a custom field in jira to trash; admin rights needed. see guides for further details on deletion processes. [edit/delete info](https://confluence.atlassian.com/x/z44fow), [permissions](https://dac-static.atlassian.com).
</Accordion>

<Accordion title="Get worklog property keys">
  This operation, which can be accessed anonymously, returns worklog property keys but requires 'browse projects' permission for the issue's project, issue-level security permission if applicable, and visibility restriction compliance.
</Accordion>

<Accordion title="Remove issue types from context">
  Summary: admins with "administer jira" global permission can remove issue types from a custom field context, making it applicable to all issue types.
</Accordion>

<Accordion title="Jira get issue types">
  Returns all issue types visible to the user. this tool retrieves a list of all issue types visible to the user, including custom issue types, sub-task issue types, and standard issue types. it is essential for determining available issue types for creating new issues and for retrieving issue type metadata for project configuration. permissions required: - if the user has the "administer jira" global permission, all issue types are returned. - if the user has the "browse projects" project permission for one or more projects, only the issue types associated with those projects are returned.
</Accordion>

<Accordion title="Search for filters">
  Retrieve a paginated list of filters anonymously. filters can be fetched by 'id' or by matching multiple attributes. results are limited to filters owned, shared with user's group or project, or public filters. no specific permissions needed.
</Accordion>

<Accordion title="Set app property forge">
  Assigns a forge app property that can be accessed in jira expressions. app context variable for retrieval. use storage api otherwise. request body must be valid, non-empty json under 32768 chars. only forge apps have permissions.
</Accordion>

<Accordion title="Set default issue security levels">
  Sets default issue security levels for schemes. **[permissions](https://dac-static.atlassian.com) required:** *administer jira* [global permission](https://confluence.atlassian.com/x/x4dklg).
</Accordion>

<Accordion title="Reset columns">
  Reset filter column settings to default for filters owned by the user, those in shared groups, private projects with browse permission, public projects, and public filters. permission to access jira required.
</Accordion>

<Accordion title="Search issue ids using jql">
  Use jql to find issue ids. for more data, use the search endpoint, which is slower. anonymous access is allowed. required permissions are 'browse projects' and, if applicable, 'issue-level security'.
</Accordion>

<Accordion title="List sprints">
  This tool retrieves all sprints from a specified board and returns them in order of start date, with the most recent sprint appearing first. it supports parameters such as board id (required), state (optional), start at (optional, default: 0), and max results (optional, default: 50) for pagination.
</Accordion>

<Accordion title="Remove issue type from issue type scheme">
  This operation deletes an issue type from a scheme but can't remove types in use, from the default scheme, or the last in a scheme. admin rights needed.
</Accordion>

<Accordion title="Set application property">
  Jira allows changing application properties, such as the clone prefix and date formats, with default values listed. advanced settings affect jira's look and functionality, and should be altered with caution by jira admins.
</Accordion>

<Accordion title="Replace issue field option">
  De-select and replace select-list options on issues via jql query. only for options added by connect apps. requires *administer jira* permission to override security. asynchronous operation with a task link provided. not for jira-native field options.
</Accordion>

<Accordion title="Set app property">
  Stores custom data for an app using a non-empty json value up to 32768 characters. only connect apps with matching `addonkey` or forge apps can access these properties.
</Accordion>

<Accordion title="Set issue navigator default columns">
  Changes issue navigator default columns by passing 'columns' parameters in html form data via curl. if omitted, defaults are cleared. admin rights required. see atlassian docs for navigable fields info.
</Accordion>

<Accordion title="Move priorities">
  Changes the order of issue priorities. **[permissions](https://dac-static.atlassian.com) required:** *administer jira* [global permission](https://confluence.atlassian.com/x/x4dklg).
</Accordion>

<Accordion title="Set default priority">
  Sets default issue priority. **[permissions](https://dac-static.atlassian.com) required:** *administer jira* [global permission](https://confluence.atlassian.com/x/x4dklg).
</Accordion>

<Accordion title="Send notification for issue">
  This tool sends email notifications for a specific jira issue. it allows users to create customized email notifications that will be added to the mail queue and sent to specified recipients. it includes parameters to specify the issue id or key, subject, text body, optional html body, and recipient details. this tool is useful for automating notification workflows and ensuring that relevant stakeholders are informed of important issue updates.
</Accordion>

<Accordion title="Set actors for project role">
  Assigns new actors to a project role, replacing current actors. use a different option to add without replacing. requires project admin or jira admin permissions.
</Accordion>

<Accordion title="Search for issues using jql get">
  This tool allows searching for jira issues using jql (jira query language) queries. it provides a flexible way to search and filter issues based on various criteria, including pagination and custom field selection.
</Accordion>

<Accordion title="Set default share scope">
  Sets the default sharing for new filters and dashboards for a user. **[permissions](https://dac-static.atlassian.com) required:** permission to access jira.
</Accordion>

<Accordion title="Set issue property">
  This resource allows storing custom data on an issue with a valid json blob up to 32,768 characters, even anonymously. requires 'browse projects' and 'edit issues' permissions, plus issue-level security access if set.
</Accordion>

<Accordion title="Search issue security schemes">
  Get a paginated list of issue security schemes, filterable by project id. use a specific method to find all projects associated with a scheme. only for classic projects and requires jira admin permission.
</Accordion>

<Accordion title="Set columns">
  Use put with form data to set columns for a jira filter. only 'navigable' fields allowed, fetched using 'get fields'. restricted to filters owned by the user, their groups, or projects they have permissions for.
</Accordion>

<Accordion title="Move version">
  The text describes a feature that changes the order of version sequences in a jira project, which is available anonymously but requires 'browse projects' permission for the relevant project.
</Accordion>

<Accordion title="Map issue types to scheme workflows">
  Assign issue types to workflows within a scheme, setting a default workflow for unmapped types. active schemes require `updatedraftifneeded` set to `true` to edit. admin rights needed.
</Accordion>

<Accordion title="Set locale">
  Use the user management rest api's "[update a user profile](https://developer.atlassian.com/cloud/admin/user-management/rest/#api-users-account-id-manage-profile-patch)" to set user locale in jira; ensure appropriate permissions.
</Accordion>

<Accordion title="Set issue types for workflow in workflow scheme">
  Workflow scheme draft in jira can have issue types set and a default workflow assigned. unassigned issue types default to this workflow. admin permissions are required.
</Accordion>

<Accordion title="Set default resolution">
  Sets default issue resolution. **[permissions](https://dac-static.atlassian.com) required:** *administer jira* [global permission](https://confluence.atlassian.com/x/x4dklg).
</Accordion>

<Accordion title="Set issue type property">
  This api endpoint allows updating or creating a property for a jira issue type with a valid json blob up to 32768 characters. administer jira global permission is required.
</Accordion>

<Accordion title="Parse jql query">
  Parses and validates jql queries. validation is performed in context of the current user. this operation can be accessed anonymously. **[permissions](https://dac-static.atlassian.com) required:** none.
</Accordion>

<Accordion title="Set preference">
  The text covers how to set/update user/system preferences, like notifications and shortcuts, within a 255-character limit. old locale/timezone settings default to a new api that requires permissions.
</Accordion>

<Accordion title="Remove mappings from issue type screen scheme">
  Removes issue type to screen scheme mappings from an issue type screen scheme. **[permissions](https://dac-static.atlassian.com) required:** *administer jira* [global permission](https://confluence.atlassian.com/x/x4dklg).
</Accordion>

<Accordion title="Search for issues using jql post">
  This tool allows searching for jira issues using jql (jira query language) queries via post request. this endpoint is particularly useful for handling complex queries that exceed url length limits, supports additional parameters like startat, maxresults, fields, expand, validatequery, and properties, and provides enhanced flexibility for batch operations and paginated responses.
</Accordion>

<Accordion title="Set comment property">
  Set custom data on a comment by sending a valid, non-empty json under 32,768 characters. requires permissions to "edit all comments" or "edit own comments," with additional role/group membership if the comment is restricted.
</Accordion>

<Accordion title="Move resolutions">
  Changes the order of issue resolutions. **[permissions](https://dac-static.atlassian.com) required:** *administer jira* [global permission](https://confluence.atlassian.com/x/x4dklg).
</Accordion>

<Accordion title="Reset user default columns">
  Resets user's default issue table columns to system default; if no accountid specified, affects caller's defaults. administer jira rights needed to alter any user's columns, jira access required for self-reset.
</Accordion>

<Accordion title="Set project feature state">
  Sets the state of a project feature.
</Accordion>

<Accordion title="Search priorities">
  The service returns a paginated list of jira priorities, filterable by priority ids, project ids, and default field configurations for company-managed projects. inaccessible or invalid ids are ignored. jira access permission is required.
</Accordion>

<Accordion title="Set project property">
  Stores custom data in a project property on jira using a valid json blob (up to 32,768 chars). accessible anonymously but requires 'administer jira' or 'administer projects' permissions.
</Accordion>

<Accordion title="Set user default columns">
  Sets user's default issue table columns in jira. without an account id, it affects the caller's settings. if no columns are specified, defaults are cleared. admins can set any user's columns; others can only set their own. data is sent as html form data.
</Accordion>

<Accordion title="Remove member from issue security level">
  Removes an issue security level member from an issue security scheme. **[permissions](https://dac-static.atlassian.com) required:** *administer jira* [global permission](https://confluence.atlassian.com/x/x4dklg).
</Accordion>

<Accordion title="Set user property">
  This resource allows for setting custom user data. it doesn't affect jira user properties. admin rights are needed to modify any user, while self-edit requires jira access.
</Accordion>

<Accordion title="Merge versions">
  Merges two project versions by deleting one and updating references to it. alternative solution and permissions required are detailed. accessible anonymously.
</Accordion>

<Accordion title="Set workflow for issue type in draft workflow scheme">
  Sets the workflow for an issue type in a workflow scheme's draft. **[permissions](https://dac-static.atlassian.com) required:** *administer jira* [global permission](https://confluence.atlassian.com/x/x4dklg).
</Accordion>

<Accordion title="Register dynamic webhooks">
  Webhooks are set for oauth apps; they work if the app owner is the webhook registrar. only connect and oauth 2.0 apps have the necessary permissions to operate this.
</Accordion>

<Accordion title="Partial update project role">
  Operation updates either a project role's name or description, not both. only the name is changed if both are provided. administer jira global permission is required.
</Accordion>

<Accordion title="Unarchive issue s by issue keys id">
  Admins can unarchive up to 1000 issues per request from specific jira projects; details and errors are provided. no subtask direct unarchival. jira or site admin rights and premium/enterprise license needed. no anonymous access.
</Accordion>

<Accordion title="Set worklog property">
  Store custom data in a worklog by setting a property with a valid json blob, up to 32768 characters. anonymous access allowed. requires 'browse projects' and 'edit worklogs' permissions, and adherence to issue-level security if set.
</Accordion>

<Accordion title="Set workflow for issue type in workflow scheme">
  To modify an active workflow scheme's issue type in jira, set 'updatedraftifneeded' to 'true' to create/update a draft. publish the draft to apply changes. admin permissions required.
</Accordion>

<Accordion title="Update announcement banner configuration">
  Updates the announcement banner configuration. **[permissions](https://dac-static.atlassian.com) required:** *administer jira* [global permission](https://confluence.atlassian.com/x/x4dklg).
</Accordion>

<Accordion title="Restore custom field from trash">
  Restores a deleted custom field in jira, requiring 'administer jira' global permission. for details on deleting custom fields, visit provided links.
</Accordion>

<Accordion title="Search resolutions">
  Returns a paginated list of resolutions from company-managed projects in jira, filterable by resolution ids and default field configurations. access requires jira permissions.
</Accordion>

<Accordion title="Set project s sender email">
  Configures the project's email sender address; an empty 'emailaddress' resets to default. requires 'administer jira' or 'administer projects' permissions.
</Accordion>

<Accordion title="Restore deleted or archived project">
  Revives archived or recycled jira projects. requires 'administer jira' for company-managed or 'administer jira'/'administer projects' for team-managed projects.
</Accordion>

<Accordion title="Set project avatar">
  Use "load project avatar" to upload project avatars, then apply this operation to choose the displayed one. administer projects permission is necessary.
</Accordion>

<Accordion title="Update custom field options context">
  Updating custom field options in jira only applies to select list options made in jira or via its api. updates ignore unchanged values and omit them in the response. requires jira admin permissions. connect app options can't be updated this way.
</Accordion>

<Accordion title="Update custom field context">
  The text provides instructions for updating a jira custom field context and specifies that the user must have the 'administer jira' global permission to do so.
</Accordion>

<Accordion title="Update custom field value">
  Apps can update the value of their own declared custom fields for issues but only if they have the necessary permissions as the operation is restricted to the app that owns the fields.
</Accordion>

<Accordion title="Retrieve the attributes of service registries">
  Retrieve the attributes of given service registries. **[permissions](https://dac-static.atlassian.com) required:** only connect apps can make this request and the servicesids belong to the tenant you are requesting
</Accordion>

<Accordion title="Sanitize jql queries">
  The system transforms jql queries to use entity ids for privacy when users don't have access, altering clauses with restricted projects, but it's not gdpr compliant without admin rights.
</Accordion>

<Accordion title="Set custom field contexts default values">
  Sets default values for custom fields in contexts like date, options, and forge types. one default per request; set to null to unset. admin rights needed.
</Accordion>

<Accordion title="Update default workflow">
  Changes the default workflow in a scheme; active ones need `updatedraftifneeded` set to `true` to edit. creates/updates a draft workflow scheme in jira for publishing. admin rights required.
</Accordion>

<Accordion title="Update custom fields">
  Updates unique combinations of custom fields on issues. restricted to only the app that declared those fields and requires app ownership for updates.
</Accordion>

<Accordion title="Update dashboard">
  Updates a dashboard, replacing all the dashboard details with those provided. **[permissions](https://dac-static.atlassian.com) required:** none the dashboard to be updated must be owned by the user.
</Accordion>

<Accordion title="Search statuses paginated">
  The api returns a paginated list of statuses based on name or project searches. requires 'administer projects' and 'administer jira' permissions.
</Accordion>

<Accordion title="Update custom field configurations">
  Update a forge app's custom field settings in jira with "administer jira" global permission; the forge app itself doesn't need jira permissions.
</Accordion>

<Accordion title="Set time tracking settings">
  Sets the time tracking settings. **[permissions](https://dac-static.atlassian.com) required:** *administer jira* [global permission](https://confluence.atlassian.com/x/x4dklg).
</Accordion>

<Accordion title="Select time tracking provider">
  Selects a time tracking provider. **[permissions](https://dac-static.atlassian.com) required:** *administer jira* [global permission](https://confluence.atlassian.com/x/x4dklg).
</Accordion>

<Accordion title="Update draft default workflow">
  Sets the default workflow for a workflow scheme's draft. **[permissions](https://dac-static.atlassian.com) required:** *administer jira* [global permission](https://confluence.atlassian.com/x/x4dklg).
</Accordion>

<Accordion title="Set dashboard item property">
  Apps can add custom data gadgets to user dashboards, with a 32,768 character limit for json data, and controls for content and settings. dashboard ownership or admin rights are needed for access.
</Accordion>

<Accordion title="Register modules">
  Registers a list of modules. **[permissions](https://dac-static.atlassian.com) required:** only connect apps can make this request.
</Accordion>

<Accordion title="Remove screen tab field">
  Removes a field from a screen tab. **[permissions](https://dac-static.atlassian.com) required:** *administer jira* [global permission](https://confluence.atlassian.com/x/x4dklg).
</Accordion>

<Accordion title="Remove custom field context from projects">
  Removing projects from a custom field context makes it apply to all projects. if a project isn't in the context or causes duplicate global contexts, the operation fails. admin rights are required.
</Accordion>

<Accordion title="Update comment">
  This tool updates an existing comment on a jira issue. it requires permissions such as 'browse projects', 'edit all comments' or 'edit own comments', and appropriate visibility permissions if restrictions apply.
</Accordion>

<Accordion title="Remove filter as favorite">
  This function allows a user to remove a filter from their favorites. if a favorited public filter becomes private and invisible, it can't be unfavored. access to jira is required.
</Accordion>

<Accordion title="Remove the default data classification level from a project">
  To remove a project's default data classification level, users need 'administer projects' project permission and 'administer jira' global permission.
</Accordion>

<Accordion title="Remove notification from notification scheme">
  Removes a notification from a notification scheme. **[permissions](https://dac-static.atlassian.com) required:** *administer jira* [global permission](https://confluence.atlassian.com/x/x4dklg).
</Accordion>

<Accordion title="Remove modules">
  Remove all or a list of modules registered by the calling app. **[permissions](https://dac-static.atlassian.com) required:** only connect apps can make this request.
</Accordion>

<Accordion title="Remove group">
  Deletes a group. **[permissions](https://dac-static.atlassian.com) required:** site administration (that is, member of the *site-admin* strategic [group](https://confluence.atlassian.com/x/24xjl)).
</Accordion>

<Accordion title="Update custom field">
  Updates a custom field. **[permissions](https://dac-static.atlassian.com) required:** *administer jira* [global permission](https://confluence.atlassian.com/x/x4dklg).
</Accordion>

<Accordion title="Remove issue security level">
  Removes an issue security level asynchronously. check the task status via the 'location' link, and get updates using 'get task'. admin jira global permission needed.
</Accordion>

<Accordion title="Remove gadget from dashboard">
  Removes a dashboard gadget from a dashboard. when a gadget is removed from a dashboard, other gadgets in the same column are moved up to fill the emptied position. **[permissions](https://dac-static.atlassian.com) required:** none.
</Accordion>

<Accordion title="Remove user from group">
  Removes a user from a group. **[permissions](https://dac-static.atlassian.com) required:** site administration (that is, member of the *site-admin* [group](https://confluence.atlassian.com/x/24xjl)).
</Accordion>

<Accordion title="Update draft workflow scheme">
  Updates or creates a draft workflow scheme for an existing active workflow. each active scheme can only have one draft. administer jira global permission required.
</Accordion>

<Accordion title="Transition issue">
  This operation transitions an issue, updates its fields if a screen is present, and requires certain permissions. use 'fields' in the request to specify updates. it's accessible anonymously, but project and issue-level permissions are needed.
</Accordion>

<Accordion title="Update component">
  Operation updates a component, overwrites given fields, and can unset lead with empty `leadaccountid`. anonymous access permitted. needs *administer projects* or *administer jira* permissions.
</Accordion>

<Accordion title="Update field configuration items">
  Updates, and restricts, field configurations in classic projects; sets text/wiki renderers but excludes autocomplete. admin rights required.
</Accordion>

<Accordion title="Update the default data classification level of a project">
  Updated project's default data classification level; requires 'administer projects' project permission and 'administer jira' global permission.
</Accordion>

<Accordion title="Update project">
  Updated project details via a request with optional parameters; schemes update only when included. admin jira global permission needed for schemes or project key changes; otherwise, admin projects permission suffices.
</Accordion>

<Accordion title="Validate create workflows">
  To bulk create workflows in jira, you need 'administer jira' permission for global workflows and 'administer projects' for project-specific ones.
</Accordion>

<Accordion title="Update screen tab">
  Updates the name of a screen tab. **[permissions](https://dac-static.atlassian.com) required:** *administer jira* [global permission](https://confluence.atlassian.com/x/x4dklg).
</Accordion>

<Accordion title="Update issue security scheme">
  Updates the issue security scheme. **[permissions](https://dac-static.atlassian.com) required:** *administer jira* [global permission](https://confluence.atlassian.com/x/x4dklg).
</Accordion>

<Accordion title="Update issue link type">
  This operation updates an issue link type in jira, requiring the site to have issue linking enabled and the user to have the 'administer jira' global permission.
</Accordion>

<Accordion title="Update gadget on dashboard">
  Changes the title, position, and color of the gadget on a dashboard. **[permissions](https://dac-static.atlassian.com) required:** none.
</Accordion>

<Accordion title="Update field configuration">
  This operation updates a field configuration's name and description for company-managed projects and requires 'administer jira' global permission.
</Accordion>

<Accordion title="Update field configuration scheme">
  This operation updates field configuration schemes for classic projects in jira and requires 'administer jira' global permission.
</Accordion>

<Accordion title="Update priority">
  Updates an issue priority. **[permissions](https://dac-static.atlassian.com) required:** *administer jira* [global permission](https://confluence.atlassian.com/x/x4dklg).
</Accordion>

<Accordion title="Update issue type">
  Updates the issue type. **[permissions](https://dac-static.atlassian.com) required:** *administer jira* [global permission](https://confluence.atlassian.com/x/x4dklg).
</Accordion>

<Accordion title="Update notification scheme">
  Updates a notification scheme. **[permissions](https://dac-static.atlassian.com) required:** *administer jira* [global permission](https://confluence.atlassian.com/x/x4dklg).
</Accordion>

<Accordion title="Update issue field option">
  Update or create select list options for an issue field in connect apps by providing an identical option id in both path and body. admin rights needed; not for jira-built issue fields.
</Accordion>

<Accordion title="Update remote issue link by id">
  The text describes updating a remote issue link, where unset fields default to null. it requires active issue linking and can be done anonymously but needs 'browse projects' and 'link issues' permissions and potentially issue-level security permissions.
</Accordion>

<Accordion title="Validate project key">
  Validates a project key by confirming the key is a valid string and not in use. **[permissions](https://dac-static.atlassian.com) required:** none.
</Accordion>

<Accordion title="Update screen">
  Updates a screen. only screens used in classic projects can be updated. **[permissions](https://dac-static.atlassian.com) required:** *administer jira* [global permission](https://confluence.atlassian.com/x/x4dklg).
</Accordion>

<Accordion title="Validate update workflows">
  To bulk update workflows, you need "administer jira" permission for global workflows and "administer projects" for project-specific ones.
</Accordion>

<Accordion title="Update permission scheme">
  Updating a permission scheme either changes its name/description or replaces all grants with a given list; an empty list removes all grants. specific endpoints handle individual grant changes. admin rights are needed.
</Accordion>

<Accordion title="Update screen scheme">
  Updates a screen scheme. only screen schemes used in classic projects can be updated. **[permissions](https://dac-static.atlassian.com) required:** *administer jira* [global permission](https://confluence.atlassian.com/x/x4dklg).
</Accordion>

<Accordion title="Update precomputations apps">
  Update the precomputation value of a function created by a forge/connect app. **[permissions](https://dac-static.atlassian.com) required:** an api for apps to update their own precomputations.
</Accordion>

<Accordion title="Update issue security level">
  Updates the issue security level. **[permissions](https://dac-static.atlassian.com) required:** *administer jira* [global permission](https://confluence.atlassian.com/x/x4dklg).
</Accordion>

<Accordion title="Update resolution">
  Updates an issue resolution. **[permissions](https://dac-static.atlassian.com) required:** *administer jira* [global permission](https://confluence.atlassian.com/x/x4dklg).
</Accordion>

<Accordion title="Update issue type scheme">
  Updates an issue type scheme. **[permissions](https://dac-static.atlassian.com) required:** *administer jira* [global permission](https://confluence.atlassian.com/x/x4dklg).
</Accordion>

<Accordion title="Update filter">
  Updates a filter. use this operation to update a filter's name, description, jql, or sharing. **[permissions](https://dac-static.atlassian.com) required:** permission to access jira, however the user must own the filter.
</Accordion>

<Accordion title="Update ui modification">
  Forge apps can update ui modifications, each with up to 1,000 contexts; a single context can be used in up to 100 such modifications. no permissions needed if no context is set; 'browse projects' permission required for context-specific modifications.
</Accordion>

<Accordion title="Update worklog">
  Update jira worklog by enabling time tracking, checking permissions (project browsing, issue security viewing, worklog editing), adhering to visibility rules. anonymous edits allowed. for setup, see the time tracking configuration guide.
</Accordion>

<Accordion title="Update version">
  This operation updates a project version and can be done anonymously. it requires either "administer jira" global permission or "administer projects" project permission for the relevant project.
</Accordion>

<Accordion title="Update project category">
  Updates a project category. **[permissions](https://dac-static.atlassian.com) required:** *administer jira* [global permission](https://confluence.atlassian.com/x/x4dklg).
</Accordion>

<Accordion title="Update related work">
  Generic related works can be updated via rest apis; archived ones cannot. anonymous access allowed, but "resolve issues" and "edit issues" permissions needed for the project's version.
</Accordion>

<Accordion title="Update workflow scheme">
  This api updates workflow schemes in company and team projects instantly; changes in issue statuses trigger issue migrations. admin permissions are required for updates.
</Accordion>

<Accordion title="Update workflow transition property">
  Updating a workflow transition modifies an existing property or adds a new one if it's not present, altering the transition's behavior. administer jira global permission is required. more info on transition and workflow properties is available online.
</Accordion>

<Accordion title="Update workflow transition rule configurations">
  Jira now allows the creator app (connect or forge) to update workflow transition rules, such as post functions, conditions, validators, disable rules, and add tags, with default enabled status and restricted to authorized apps.
</Accordion>

<Accordion title="Update issue type screen scheme default screen scheme">
  Updates the default screen scheme in an issue type screen scheme for all issue types not individually mapped. requires administer jira global permission.
</Accordion>

<Accordion title="Update issue type screen scheme">
  Updates an issue type screen scheme. **[permissions](https://dac-static.atlassian.com) required:** *administer jira* [global permission](https://confluence.atlassian.com/x/x4dklg).
</Accordion>


# Junglescout
Source: https://docs.push.ai/integrations/junglescout



Jungle Scout assists Amazon sellers with product research, sales estimates, and competitive insights to optimize inventory, pricing, and listing strategies

<Accordion title="Retrieve historical search volume data for a keyword">
  Fetches the historical search volume data for a specified keyword over a given time period.
</Accordion>

<Accordion title="Query the product database">
  Queries the jungle scout product database to retrieve product data based on various filters. compatible parameters include marketplace, sort, page size, product tiers, seller types, categories, exclude top brands, exclude unavailable products, min price, max price, min net, max net, min rank, max rank, min sales, max sales, min revenue, max revenue, min reviews, max reviews, min rating, max rating, min weight, max weight, min sellers, max sellers, min lqs, max lqs, min updated at, and max updated at.
</Accordion>

<Accordion title="Retrieve data for a specific keyword query">
  Returns data based on a specific keyword query, including search volume and competition.
</Accordion>

<Accordion title="Retrieve sales estimates data">
  Fetches sales estimates data for specified parameters.
</Accordion>

<Accordion title="Retrieve keyword data for specified asins">
  Returns keywords for which the queried asin(s) appear in amazon search results. for a given keyword, jungle scout collects up to 3 pages of amazon keyword search results. query up to 10 asins at a time. apply filters to narrow search results.
</Accordion>

<Accordion title="Retrieve share of voice data">
  Fetches share of voice data for specified keywords.
</Accordion>


# Klaviyo
Source: https://docs.push.ai/integrations/klaviyo



Klaviyo is a data-driven email and SMS marketing platform that allows e-commerce brands to deliver targeted messages, track conversions, and scale customer relationships

<Accordion title="Assign campaign message template">
  Creates a non-reusable version of the template and assigns it to the message.

  *rate limits*:

  burst: `10/s`

  steady: `150/m` **scopes:** `campaigns:write`
</Accordion>

<Accordion title="Bulk create events">
  This api endpoint creates or updates profiles by batching up to 1,000 events, with a 5mb payload limit. minimum required: a profile id and metric name. it has rate limits of 10 events per second burst and 150 events per minute. scope is `events:write`.
</Accordion>

<Accordion title="Bulk create client events">
  Use the client-side endpoint with a public api key to track profile activity. it accepts up to 1000 events/request with rates of 10/s burst and 150/m steady. for server-side, use the bulk create event endpoint.
</Accordion>

<Accordion title="Create campaign clone">
  Clones an existing campaign, returning a new campaign based on the original with a new id and name.

  *rate limits*:

  burst: `10/s`

  steady: `150/m` **scopes:** `campaigns:write`
</Accordion>

<Accordion title="Create campaign send job">
  Trigger a campaign to send asynchronously

  *rate limits*:

  burst: `10/s`

  steady: `150/m` **scopes:** `campaigns:write`
</Accordion>

<Accordion title="Create back in stock subscription">
  Use the server-side endpoint to subscribe to restock alerts, following the back in stock api guide. for client-side, use the post endpoint provided. rate limits: 350/s burst and 3500/m steady. required scopes: catalogs:write, profiles:write.
</Accordion>

<Accordion title="Create tag relationships flows">
  Assign tags to flows using their ids in the request body, ensuring a flow is not linked to over 100 tags. rate limits are 3/s burst and 60/m steady. required scopes: `flows:write` and `tags:write`. tag: flow-tag association limits
</Accordion>

<Accordion title="Create campaign recipient estimation job">
  Start an async task to update campaign recipient estimates. track it using the `get campaign recipient estimation job` and get the final count via `get campaign recipient estimation`. rate limits are 10/s burst, 150/m steady with `campaigns:write` scope.
</Accordion>

<Accordion title="Create tag group">
  Create tag groups up to 50 per account, defaulting to non-exclusive unless specified. related resources can have multiple non-exclusive tags but only one if exclusive. rate limits: 3/s burst, 60/m steady. scopes needed: tags:read, tags:write.
</Accordion>

<Accordion title="Create catalog category">
  Create a new catalog category.

  *rate limits*:

  burst: `75/s`

  steady: `700/m` **scopes:** `catalogs:write`
</Accordion>

<Accordion title="Create template render">
  Render an email template with specific context and sparse fieldsets, then get html/plain text. rate limit: 3/s burst, 60/m steady. scope: templates:read.
</Accordion>

<Accordion title="Create tag relationships campaigns">
  Summary: link a tag to campaigns, ensuring a limit of 100 tags per campaign. campaign ids should be sent via request body. rate limit: 3/s, 60/m. required scopes: campaigns:write, tags:write. tag: #campaigntagginglimits
</Accordion>

<Accordion title="Delete catalog category">
  Delete a catalog category using the given category id.

  *rate limits*:

  burst: `75/s`

  steady: `700/m` **scopes:** `catalogs:write`
</Accordion>

<Accordion title="Create campaign">
  Creates a campaign given a set of parameters, then returns it.

  *rate limits*:

  burst: `10/s`

  steady: `150/m` **scopes:** `campaigns:write`
</Accordion>

<Accordion title="Delete campaign">
  Delete a campaign with the given campaign id.

  *rate limits*:

  burst: `10/s`

  steady: `150/m` **scopes:** `campaigns:write`
</Accordion>

<Accordion title="Create coupon">
  Creates a new coupon.

  *rate limits*:

  burst: `3/s`

  steady: `60/m` **scopes:** `coupons:write`
</Accordion>

<Accordion title="Create catalog category relationships items">
  Create a new item relationship for the given category id.

  *rate limits*:

  burst: `75/s`

  steady: `700/m` **scopes:** `catalogs:write`
</Accordion>

<Accordion title="Delete catalog item relationships categories">
  Delete catalog category relationships for the given item id.

  *rate limits*:

  burst: `75/s`

  steady: `700/m` **scopes:** `catalogs:write`
</Accordion>

<Accordion title="Create webhook">
  Create a new webhook

  *rate limits*:

  burst: `1/s`

  steady: `15/m` **scopes:** `webhooks:write`
</Accordion>

<Accordion title="Delete catalog category relationships items">
  Delete item relationships for the given category id.

  *rate limits*:

  burst: `75/s`

  steady: `700/m` **scopes:** `catalogs:write`
</Accordion>

<Accordion title="Create catalog item">
  Create a new catalog item.

  *rate limits*:

  burst: `75/s`

  steady: `700/m` **scopes:** `catalogs:write`
</Accordion>

<Accordion title="Delete catalog variant">
  Delete a catalog item variant with the given variant id.

  *rate limits*:

  burst: `75/s`

  steady: `700/m` **scopes:** `catalogs:write`
</Accordion>

<Accordion title="Delete coupon">
  Delete the coupon with the given coupon id.

  *rate limits*:

  burst: `3/s`

  steady: `60/m` **scopes:** `coupons:write`
</Accordion>

<Accordion title="Delete catalog item">
  Delete a catalog item with the given item id.

  *rate limits*:

  burst: `75/s`

  steady: `700/m` **scopes:** `catalogs:write`
</Accordion>

<Accordion title="Delete flow">
  Delete a flow with the given flow id.

  *rate limits*:

  burst: `3/s`

  steady: `60/m` **scopes:** `flows:write`
</Accordion>

<Accordion title="Delete coupon code">
  Deletes a coupon code specified by the given identifier synchronously. if a profile has been assigned to the coupon code, an exception will be raised

  *rate limits*:

  burst: `350/s`

  steady: `3500/m` **scopes:** `coupon-codes:write`
</Accordion>

<Accordion title="Delete list">
  Delete a list with the given list id.

  *rate limits*:

  burst: `10/s`

  steady: `150/m` **scopes:** `lists:write`
</Accordion>

<Accordion title="Create catalog item relationships categories">
  Create a new catalog category relationship for the given item id.

  *rate limits*:

  burst: `75/s`

  steady: `700/m` **scopes:** `catalogs:write`
</Accordion>

<Accordion title="Create template clone">
  Clone a template by its id, but cloning fails if account has 1,000+ templates. api limit: 1,000 templates. rate limits are 10 per second and 150 per minute. requires `templates:write` scope.
</Accordion>

<Accordion title="Create tag relationships lists">
  Summary: a tag can be added to one or more lists, with a max of 100 tags per list. use the request body to link tag and list ids. tag: #apiusagelimits scopes: lists:write, tags:write
</Accordion>

<Accordion title="Delete tag relationships flows">
  Remove a tag's association with one or more flows. use the request body to pass in the id(s) of the flows(s) whose association with the tag will be removed.

  *rate limits*:

  burst: `3/s`

  steady: `60/m` **scopes:** `flows:write` `tags:write`
</Accordion>

<Accordion title="Delete segment">
  Delete a segment with the given segment id.

  *rate limits*:

  burst: `3/s`

  steady: `60/m` **scopes:** `segments:write`
</Accordion>

<Accordion title="Delete tag relationships campaigns">
  Disconnect a tag from campaigns using the campaign id(s) in the request body. rate limits: 3 requests/second, 60 requests/minute. required scopes: campaigns:write, tags:write.
</Accordion>

<Accordion title="Delete tag">
  Delete the tag with the given tag id. any associations between the tag and other resources will also be removed.

  *rate limits*:

  burst: `3/s`

  steady: `60/m` **scopes:** `tags:read` `tags:write`
</Accordion>

<Accordion title="Delete tag group">
  Delete a specified tag group and its contents; associated resource links will be removed. the default group is undeletable. rate limits: 3/s burst, 60/m steady. requires tags:read and tags:write permissions.
</Accordion>

<Accordion title="Delete tag relationships lists">
  Remove a tag's association with one or more lists. use the request body to pass in the id(s) of the list(s) whose association with the tag will be removed.

  *rate limits*:

  burst: `3/s`

  steady: `60/m` **scopes:** `lists:write` `tags:write`
</Accordion>

<Accordion title="Delete template">
  Delete a template with the given template id.

  *rate limits*:

  burst: `10/s`

  steady: `150/m` **scopes:** `templates:write`
</Accordion>

<Accordion title="Create coupon code">
  Synchronously creates a coupon code for the given coupon.

  *rate limits*:

  burst: `350/s`

  steady: `3500/m` **scopes:** `coupon-codes:write`
</Accordion>

<Accordion title="Delete tag relationships segments">
  Use the request body to de-associate a tag from specified segment ids. rate limits are 3 requests/sec and 60 requests/min. required scopes are 'segments:write' and 'tags:write'.
</Accordion>

<Accordion title="Create tag relationships segments">
  Summary: set tag associations with segments using the request body, limited to one tag per segment and up to 100 tags per segment. rate limits are three requests per second and sixty per minute. tags: segments:write, tags:write
</Accordion>

<Accordion title="Delete webhook">
  Delete a webhook with the given id.

  *rate limits*:

  burst: `1/s`

  steady: `15/m` **scopes:** `webhooks:write`
</Accordion>

<Accordion title="Get account">
  Retrieve a single account object by its account id. you can only request the account by which the private api key was generated.

  *rate limits*:

  burst: `1/s`

  steady: `15/m` **scopes:** `accounts:read`
</Accordion>

<Accordion title="Get bulk profile import job">
  Get a bulk profile import job with the given job id.

  *rate limits*:

  burst: `10/s`

  steady: `150/m` **scopes:** `lists:read` `profiles:read`
</Accordion>

<Accordion title="Get accounts">
  Use a private api key to fetch an associated account's details like contact info, timezone, and currency, as well as validate the key. rate limit: 1 request/second, 15 requests/minute. scope required: `accounts:read`.
</Accordion>

<Accordion title="Create catalog variant">
  Create a new variant for a related catalog item.

  *rate limits*:

  burst: `75/s`

  steady: `700/m` **scopes:** `catalogs:write`
</Accordion>

<Accordion title="Create template">
  Summary: custom html templates can be created unless an account reaches 1,000 template limit. use sparse fieldsets to request specific fields. rate limits are 10 per second and 150 per minute. requires 'templates:write' scope.
</Accordion>

<Accordion title="Add profile to list">
  Use the subscribe profiles endpoint to add profiles to a list by id, with a max of 1000 per call. ideal for giving marketing consent. rate limits: 10/s burst, 150/m steady. requires lists:write and profiles:write scopes.
</Accordion>

<Accordion title="Create list">
  Create a new list.

  *rate limits*:

  burst: `10/s`

  steady: `150/m`

  daily: `100/d` **scopes:** `lists:write`
</Accordion>

<Accordion title="Create or update push token">
  Migrate or create push tokens with klaviyo's endpoint, utilizing their mobile sdks for ios & android. rate limits: 75/s burst, 700/m steady. requires profiles:write and push-tokens:write scopes.
</Accordion>

<Accordion title="Create or update client profile">
  Update user profiles without tracking using a public client-side api; use a private server-side api for identifier changes. burst rate is 350 requests/sec and 3500 requests/min with 'profiles:write' access.
</Accordion>

<Accordion title="Create or update client push token">
  This endpoint for mobile sdks (ios & android) creates/updates push tokens using a public api key. push notifications must be enabled. for migrating tokens use the server-side post endpoint. rate limits are 3/s burst, 150/m steady.
</Accordion>

<Accordion title="Create client back in stock subscription">
  Use the endpoint for client-side back in stock notifications with a public api key. for server-side, use post /api/back-in-stock-subscriptions. limits are 350 requests per second and 3500 per minute. requires 'catalogs:write' and 'profiles:write' scopes.
</Accordion>

<Accordion title="Create tag">
  Summary: instructions on creating a tag within an account's designated tag group with a maximum of 500 tags, with optional tag group specification. rate limits are 3/s burst and 60/min steady. tag: #tagcreationlimitandrate
</Accordion>

<Accordion title="Create client event">
  Create client-side events to track profiles using a public api key, not for updating identifiers (server-side only). rate limits: 350/s, 3500/m. use `events:write` scope.
</Accordion>

<Accordion title="Create profile">
  Create a new profile.

  *rate limits*:

  burst: `75/s`

  steady: `700/m` **scopes:** `profiles:write`
</Accordion>

<Accordion title="Create segment">
  Create a segment.

  *rate limits*:

  burst: `1/s`

  steady: `15/m`

  daily: `100/d` **scopes:** `segments:write`
</Accordion>

<Accordion title="Create or update profile">
  Create/update a profile with given attributes. returns 201 for creation, 200 for update. empty fields are cleared with `null`; omitted fields remain. rate limits: 75/s burst, 700/m steady. scope required: `profiles:write`.
</Accordion>

<Accordion title="Create event">
  Create or update a profile event with minimum identifiers and metric name. success means validation, not completion. burst limit: 350/s, steady: 3500/m. scope required: `events:write`.
</Accordion>

<Accordion title="Create client subscription">
  Endpoint manages email/sms opt-ins using consent and requires public api key for client use. allows single-channel with details. rate limit: 100/s burst, 700/m steady, under 'subscriptions:write'.
</Accordion>

<Accordion title="Get bulk profile import job profiles">
  Get profiles for the bulk profile import job with the given id.

  *rate limits*:

  burst: `10/s`

  steady: `150/m` **scopes:** `profiles:read`
</Accordion>

<Accordion title="Get bulk profile import job relationships profiles">
  Get profile relationships for the bulk profile import job with the given id.

  *rate limits*:

  burst: `10/s`

  steady: `150/m` **scopes:** `profiles:read`
</Accordion>

<Accordion title="Get bulk profile import jobs">
  Get all bulk profile import jobs. returns a maximum of 100 jobs per request.

  *rate limits*:

  burst: `10/s`

  steady: `150/m` **scopes:** `lists:read` `profiles:read`
</Accordion>

<Accordion title="Get bulk profile import job lists">
  Get list for the bulk profile import job with the given id.

  *rate limits*:

  burst: `10/s`

  steady: `150/m` **scopes:** `lists:read`
</Accordion>

<Accordion title="Get bulk profile import job errors">
  Get import errors for the bulk profile import job with the given id.

  *rate limits*:

  burst: `10/s`

  steady: `150/m` **scopes:** `profiles:read`
</Accordion>

<Accordion title="Get catalog category">
  Get a catalog category with the given category id.

  *rate limits*:

  burst: `350/s`

  steady: `3500/m` **scopes:** `catalogs:read`
</Accordion>

<Accordion title="Get coupon">
  Get a specific coupon with the given coupon id.

  *rate limits*:

  burst: `75/s`

  steady: `700/m` **scopes:** `coupons:read`
</Accordion>

<Accordion title="Get campaign message template">
  Return the related template

  *rate limits*:

  burst: `10/s`

  steady: `150/m` **scopes:** `campaigns:read` `templates:read`
</Accordion>

<Accordion title="Get delete items job">
  Get a catalog item bulk delete job with the given job id.

  *rate limits*:

  burst: `350/s`

  steady: `3500/m` **scopes:** `catalogs:read`
</Accordion>

<Accordion title="Get bulk profile import job relationships lists">
  Get list relationship for the bulk profile import job with the given id.

  *rate limits*:

  burst: `10/s`

  steady: `150/m` **scopes:** `lists:read`
</Accordion>

<Accordion title="Get delete variants job">
  Get a catalog variant bulk delete job with the given job id.

  *rate limits*:

  burst: `350/s`

  steady: `3500/m` **scopes:** `catalogs:read`
</Accordion>

<Accordion title="Get coupon relationships coupon codes">
  Gets the coupon relationship associated with the given coupon code id

  *rate limits*:

  burst: `75/s`

  steady: `700/m` **scopes:** `coupons:read`
</Accordion>

<Accordion title="Get campaign">
  Returns a specific campaign based on a required id.

  *rate limits*:

  burst: `10/s`

  steady: `150/m` **scopes:** `campaigns:read`
</Accordion>

<Accordion title="Get catalog categories">
  Retrieve up to 100 account catalog categories, sortable by creation date. only `$custom` integration and `$default` catalog types supported. rate limits are 350/s and 3500/m. requires `catalogs:read` scope.
</Accordion>

<Accordion title="Get campaign message relationships template">
  Returns the id of the related template

  *rate limits*:

  burst: `10/s`

  steady: `150/m` **scopes:** `campaigns:read` `templates:read`
</Accordion>

<Accordion title="Get delete variants jobs">
  Get all catalog variant bulk delete jobs. returns a maximum of 100 jobs per request.

  *rate limits*:

  burst: `350/s`

  steady: `3500/m` **scopes:** `catalogs:read`
</Accordion>

<Accordion title="Get delete categories jobs">
  Get all catalog category bulk delete jobs. returns a maximum of 100 jobs per request.

  *rate limits*:

  burst: `350/s`

  steady: `3500/m` **scopes:** `catalogs:read`
</Accordion>

<Accordion title="Get event">
  Get an event with the given event id.

  *rate limits*:

  burst: `10/s`

  steady: `150/m` **scopes:** `events:read`
</Accordion>

<Accordion title="Get flow flow actions">
  Get all flow actions associated with the given flow id. returns a maximum of 50 flows per request, which can be paginated with cursor-based pagination.

  *rate limits*:

  burst: `3/s`

  steady: `60/m` **scopes:** `flows:read`
</Accordion>

<Accordion title="Get flow action relationships messages">
  Retrieves up to 50 flow message relationships per request for a specified flow action id, with cursor pagination. rate limits: 3/s burst, 60/min steady. requires `flows:read` scope.
</Accordion>

<Accordion title="Get create categories job">
  Get a catalog category bulk create job with the given job id. an `include` parameter can be provided to get the following related resource data: `categories`.

  *rate limits*:

  burst: `350/s`

  steady: `3500/m` **scopes:** `catalogs:read`
</Accordion>

<Accordion title="Get catalog category items">
  Retrieve up to 100 sorted items per request from a category using the category id. sort by 'created' field. rate limits are 350/s burst and 3500/m steady. requires 'catalogs:read' scope.
</Accordion>

<Accordion title="Get flow">
  Get a flow with the given flow id.

  *rate limits*:

  burst: `3/s`

  steady: `60/m` **scopes:** `flows:read`
</Accordion>

<Accordion title="Get coupons">
  Get all coupons in an account. to learn more, see our \[coupons api guide]\([https://developers.klaviyo.com/en/docs/use](https://developers.klaviyo.com/en/docs/use) klaviyos coupons api).

  *rate limits*:

  burst: `75/s`

  steady: `700/m` **scopes:** `coupons:read`
</Accordion>

<Accordion title="Get flow for flow action">
  Get the flow associated with the given action id.

  *rate limits*:

  burst: `3/s`

  steady: `60/m` **scopes:** `flows:read`
</Accordion>

<Accordion title="Get flows">
  Get all flows in an account. returns a maximum of 50 flows per request, which can be paginated with cursor-based pagination.

  *rate limits*:

  burst: `3/s`

  steady: `60/m` **scopes:** `flows:read`
</Accordion>

<Accordion title="Get flow message relationships action">
  Get the \[relationship]\([https://developers.klaviyo.com/en/reference/api](https://developers.klaviyo.com/en/reference/api) overview#relationships) for a flow message's flow action, given the flow id.

  *rate limits*:

  burst: `3/s`

  steady: `60/m` **scopes:** `flows:read`
</Accordion>

<Accordion title="Get catalog category relationships items">
  Get all items in the given category id. returns a maximum of 100 items per request.

  *rate limits*:

  burst: `350/s`

  steady: `3500/m` **scopes:** `catalogs:read`
</Accordion>

<Accordion title="Get flow message">
  Get the flow message of a flow with the given message id.

  *rate limits*:

  burst: `3/s`

  steady: `60/m` **scopes:** `flows:read`
</Accordion>

<Accordion title="Get campaign recipient estimation">
  Get estimated recipients for a given campaign id using `create campaign recipient estimation job`. rate limits are 10/s burst and 150/m steady. required scope: `campaigns:read`.
</Accordion>

<Accordion title="Get flow message template">
  Return the related template

  *rate limits*:

  burst: `3/s`

  steady: `60/m` **scopes:** `templates:read`
</Accordion>

<Accordion title="Get flow message relationships template">
  Returns the id of the related template

  *rate limits*:

  burst: `3/s`

  steady: `60/m` **scopes:** `templates:read`
</Accordion>

<Accordion title="Get create categories jobs">
  Get all catalog category bulk create jobs. returns a maximum of 100 jobs per request.

  *rate limits*:

  burst: `350/s`

  steady: `3500/m` **scopes:** `catalogs:read`
</Accordion>

<Accordion title="Get events">
  Get all events in an account requests can be sorted by the following fields: `datetime`, `timestamp` returns a maximum of 200 events per page.

  *rate limits*:

  burst: `350/s`

  steady: `3500/m` **scopes:** `events:read`
</Accordion>

<Accordion title="Get campaign recipient estimation job">
  Retrieve the status of a recipient estimation job triggered with the `create campaign recipient estimation job` endpoint.

  *rate limits*:

  burst: `10/s`

  steady: `150/m` **scopes:** `campaigns:read`
</Accordion>

<Accordion title="Get flow relationships flow actions">
  Retrieve all flow action relationships for a specific flow id, sortable by `id`, `status`, `created`, `updated`. refine with filters, max 50 per page, paginated by `page[size]` and `page[number]`. rate limits: burst 3/s, steady 60/m. scope: `flows:read`.
</Accordion>

<Accordion title="Get flow tags">
  Return all tags associated with the given flow id.

  *rate limits*:

  burst: `3/s`

  steady: `60/m` **scopes:** `flows:read` `tags:read`
</Accordion>

<Accordion title="Get catalog item">
  Get a specific catalog item with the given item id.

  *rate limits*:

  burst: `350/s`

  steady: `3500/m` **scopes:** `catalogs:read`
</Accordion>

<Accordion title="Get flow relationships tags">
  Return the tag ids of all tags associated with the given flow.

  *rate limits*:

  burst: `3/s`

  steady: `60/m` **scopes:** `flows:read` `tags:read`
</Accordion>

<Accordion title="Get event metric">
  Get the metric for an event with the given event id.

  *rate limits*:

  burst: `350/s`

  steady: `3500/m` **scopes:** `events:read` `metrics:read`
</Accordion>

<Accordion title="Get form">
  Get the form with the given id.

  *rate limits*:

  burst: `3/s`

  steady: `60/m` **scopes:** `forms:read`
</Accordion>

<Accordion title="Get coupon code">
  Returns a coupon code specified by the given identifier.

  *rate limits*:

  burst: `350/s`

  steady: `3500/m` **scopes:** `coupon-codes:read`
</Accordion>

<Accordion title="Get create items job">
  Get a catalog item bulk create job with the given job id. an `include` parameter can be provided to get the following related resource data: `items`.

  *rate limits*:

  burst: `350/s`

  steady: `3500/m` **scopes:** `catalogs:read`
</Accordion>

<Accordion title="Get forms">
  Get all forms in an account.

  *rate limits*:

  burst: `3/s`

  steady: `60/m` **scopes:** `forms:read`
</Accordion>

<Accordion title="Get campaign relationships campaign messages">
  Returns the ids of all messages associated with the given campaign.

  *rate limits*:

  burst: `10/s`

  steady: `150/m` **scopes:** `campaigns:read`
</Accordion>

<Accordion title="Get delete items jobs">
  Get all catalog item bulk delete jobs. returns a maximum of 100 jobs per request.

  *rate limits*:

  burst: `350/s`

  steady: `3500/m` **scopes:** `catalogs:read`
</Accordion>

<Accordion title="Get event profile">
  Get the profile associated with an event with the given event id.

  *rate limits*:

  burst: `350/s`

  steady: `3500/m` **scopes:** `events:read` `profiles:read`
</Accordion>

<Accordion title="Get form version">
  Get the form version with the given id.

  *rate limits*:

  burst: `3/s`

  steady: `60/m` **scopes:** `forms:read`
</Accordion>

<Accordion title="Get form for form version">
  Get the form associated with the given form version.

  *rate limits*:

  burst: `3/s`

  steady: `60/m` **scopes:** `forms:read`
</Accordion>

<Accordion title="Get form id for form version">
  Get the id of the form associated with the given form version.

  *rate limits*:

  burst: `3/s`

  steady: `60/m` **scopes:** `forms:read`
</Accordion>

<Accordion title="Get catalog items">
  Retrieve up to 100 sorted catalog items per account, with `$custom` integration and `$default` type. rate limits: 350/s burst, 3500/m steady. scope required: `catalogs:read`.
</Accordion>

<Accordion title="Get create items jobs">
  Get all catalog item bulk create jobs. returns a maximum of 100 jobs per request.

  *rate limits*:

  burst: `350/s`

  steady: `3500/m` **scopes:** `catalogs:read`
</Accordion>

<Accordion title="Get list">
  Api allows 75 req/sec and 700 req/min, but with 'profile count' param, it's 1 req/sec and 15 req/min. 'lists:read' scope needed. see developer guide for details.
</Accordion>

<Accordion title="Get images">
  Get all images in an account.

  *rate limits*:

  burst: `10/s`

  steady: `150/m` **scopes:** `images:read`
</Accordion>

<Accordion title="Get lists">
  Retrieve a filtered selection of account lists by fields like `id`, `name`, `created`, and `updated`. limited to 10 results per page with burst rate limits of 75 requests/second and a steady rate of 700 requests/minute. requires `lists:read` scope.
</Accordion>

<Accordion title="Get flow action">
  Get a flow action from a flow with the given flow action id.

  *rate limits*:

  burst: `3/s`

  steady: `60/m` **scopes:** `flows:read`
</Accordion>

<Accordion title="Get event relationships metric">
  Get a list of related metrics for an event

  *rate limits*:

  burst: `350/s`

  steady: `3500/m` **scopes:** `events:read` `metrics:read`
</Accordion>

<Accordion title="Get campaign relationships tags">
  Returns the ids of all tags associated with the given campaign.

  *rate limits*:

  burst: `3/s`

  steady: `60/m` **scopes:** `campaigns:read` `tags:read`
</Accordion>

<Accordion title="Get campaigns">
  To list campaigns, use a channel filter (`email` or `sms`). rate limits apply: 10/s (burst), 150/m (steady). required scope: `campaigns:read`.
</Accordion>

<Accordion title="Get list relationships tags">
  Returns the tag ids of all tags associated with the given list.

  *rate limits*:

  burst: `3/s`

  steady: `60/m` **scopes:** `lists:read` `tags:read`
</Accordion>

<Accordion title="Get list tags">
  Return all tags associated with the given list id.

  *rate limits*:

  burst: `3/s`

  steady: `60/m` **scopes:** `lists:read` `tags:read`
</Accordion>

<Accordion title="Get event relationships profile">
  Get profile \[relationships]\([https://developers.klaviyo.com/en/reference/api](https://developers.klaviyo.com/en/reference/api) overview#relationships) for an event with the given event id.

  *rate limits*:

  burst: `350/s`

  steady: `3500/m` **scopes:** `events:read` `profiles:read`
</Accordion>

<Accordion title="Get list profiles">
  Retrieve profiles in a list by id, filterable by email/phone/push token/join date, sortable by join date. regular rate limit: 75/s, 700/m; with predictive analytics: 10/s, 150/m. details at klaviyo guide. scopes required: lists:read, profiles:read.
</Accordion>

<Accordion title="Get create variants job">
  Get a catalog variant bulk create job with the given job id. an `include` parameter can be provided to get the following related resource data: `variants`.

  *rate limits*:

  burst: `350/s`

  steady: `3500/m` **scopes:** `catalogs:read`
</Accordion>

<Accordion title="Get campaign send job">
  Get a campaign send job

  *rate limits*:

  burst: `10/s`

  steady: `150/m` **scopes:** `campaigns:read`
</Accordion>

<Accordion title="Get flow action for message">
  Get the flow action for a flow message with the given message id.

  *rate limits*:

  burst: `3/s`

  steady: `60/m` **scopes:** `flows:read`
</Accordion>

<Accordion title="Get metric">
  Get a metric with the given metric id.

  *rate limits*:

  burst: `10/s`

  steady: `150/m` **scopes:** `metrics:read`
</Accordion>

<Accordion title="Get list relationships profiles">
  Get profile membership \[relationships]\([https://developers.klaviyo.com/en/reference/api](https://developers.klaviyo.com/en/reference/api) overview#relationships) for a list with the given list id.

  *rate limits*:

  burst: `75/s`

  steady: `700/m` **scopes:** `lists:read` `profiles:read`
</Accordion>

<Accordion title="Get create variants jobs">
  Get all catalog variant bulk create jobs. returns a maximum of 100 jobs per request.

  *rate limits*:

  burst: `350/s`

  steady: `3500/m` **scopes:** `catalogs:read`
</Accordion>

<Accordion title="Get metrics">
  Get all metrics in an account. requests can be filtered by the following fields: integration `name`, integration `category` returns a maximum of 200 results per page.

  *rate limits*:

  burst: `10/s`

  steady: `150/m` **scopes:** `metrics:read`
</Accordion>

<Accordion title="Get profile relationships lists">
  Get list memberships for a profile with the given profile id.

  *rate limits*:

  burst: `3/s`

  steady: `60/m` **scopes:** `lists:read` `profiles:read`
</Accordion>

<Accordion title="Get profile lists">
  Get list memberships for a profile with the given profile id.

  *rate limits*:

  burst: `3/s`

  steady: `60/m` **scopes:** `lists:read` `profiles:read`
</Accordion>

<Accordion title="Get image">
  Get the image with the given image id.

  *rate limits*:

  burst: `10/s`

  steady: `150/m` **scopes:** `images:read`
</Accordion>

<Accordion title="Get profile">
  Get the profile with the given profile id.

  *rate limits*:

  burst: `75/s`

  steady: `700/m` **scopes:** `profiles:read`
</Accordion>

<Accordion title="Get profiles">
  Retrieve account profiles, sort by various fields. rate limits: 75/s burst, 700/m steady; lower with `predictive analytics`. details at developers.klaviyo.com. requires `profiles:read` scope.
</Accordion>

<Accordion title="Get segments">
  Fetch segments from an account with filters like `name`, `created`, and `updated`. max 10 results/page. rate limits are 75/s burst, 700/m steady. requires `segments:read` scope.
</Accordion>

<Accordion title="Get delete categories job">
  Get a catalog category bulk delete job with the given job id.

  *rate limits*:

  burst: `350/s`

  steady: `3500/m` **scopes:** `catalogs:read`
</Accordion>

<Accordion title="Get profile relationships segments">
  Get segment membership relationships for a profile with the given profile id.

  *rate limits*:

  burst: `3/s`

  steady: `60/m` **scopes:** `profiles:read` `segments:read`
</Accordion>

<Accordion title="Get segment">
  Fetch a segment by id with default rates of 75/s and 700/m, or with `additional-fields` at 1/s and 15/m. for details, visit the provided guide. required scope: `segments:read`.
</Accordion>

<Accordion title="Get catalog item categories">
  Retrieve the catalog categories for an item by id, sorted by 'created' date, with a 100-category maximum per request. rate limits: 350/s burst, 3500/m steady. requires 'catalogs:read' scope.
</Accordion>

<Accordion title="Get profile segments">
  Get segment memberships for a profile with the given profile id.

  *rate limits*:

  burst: `3/s`

  steady: `60/m` **scopes:** `profiles:read` `segments:read`
</Accordion>

<Accordion title="Get flow action messages">
  Retrieve up to 50 flow messages per request by action id, sortable by various fields, with ascending/descending options, and paginated using `page[size]` and `page[number]`. rate limits: 3/s burst, 60/m steady. scope required: `flows:read`.
</Accordion>

<Accordion title="Get segment profiles">
  Retrieve profiles in a segment by id, filtering by email, phone, token, or join date, and sorting by join date. rate limit: 75/s burst, 700/m steady. requires profiles:read and segments:read scopes.
</Accordion>

<Accordion title="Get coupon code relationships coupon">
  Gets a list of coupon code relationships associated with the given coupon id

  *rate limits*:

  burst: `75/s`

  steady: `700/m` **scopes:** `coupon-codes:read`
</Accordion>

<Accordion title="Get segment relationships profiles">
  Get all profile membership \[relationships]\([https://developers.klaviyo.com/en/reference/api](https://developers.klaviyo.com/en/reference/api) overview#relationships) for the given segment id.

  *rate limits*:

  burst: `75/s`

  steady: `700/m` **scopes:** `profiles:read` `segments:read`
</Accordion>

<Accordion title="Get flow action relationships flow">
  Get the flow associated with the given action id.

  *rate limits*:

  burst: `3/s`

  steady: `60/m` **scopes:** `flows:read`
</Accordion>

<Accordion title="Get catalog variant">
  Get a catalog item variant with the given variant id.

  *rate limits*:

  burst: `350/s`

  steady: `3500/m` **scopes:** `catalogs:read`
</Accordion>

<Accordion title="Get coupon for coupon code">
  Get the coupon associated with a given coupon code id.

  *rate limits*:

  burst: `75/s`

  steady: `700/m` **scopes:** `coupons:read`
</Accordion>

<Accordion title="Get catalog item relationships categories">
  Get all catalog categories that a particular item is in. returns a maximum of 100 categories per request.

  *rate limits*:

  burst: `350/s`

  steady: `3500/m` **scopes:** `catalogs:read`
</Accordion>

<Accordion title="Get coupon code bulk create jobs">
  Get all coupon code bulk create jobs. returns a maximum of 100 jobs per request.

  *rate limits*:

  burst: `75/s`

  steady: `700/m` **scopes:** `coupon-codes:read`
</Accordion>

<Accordion title="Get campaign message campaign">
  Return the related campaign

  *rate limits*:

  burst: `10/s`

  steady: `150/m` **scopes:** `campaigns:read`
</Accordion>

<Accordion title="Get campaign message">
  Returns a specific message based on a required id.

  *rate limits*:

  burst: `10/s`

  steady: `150/m` **scopes:** `campaigns:read`
</Accordion>

<Accordion title="Get campaign campaign messages">
  Return all messages that belong to the given campaign.

  *rate limits*:

  burst: `10/s`

  steady: `150/m` **scopes:** `campaigns:read`
</Accordion>

<Accordion title="Get catalog item variants">
  Retrieve up to 100 variants per request for a specific item id, sortable by creation date. rate limits are 350/s burst and 3500/m steady. requires 'catalogs:read' scope.
</Accordion>

<Accordion title="Get campaign message relationships campaign">
  Returns the id of the related campaign

  *rate limits*:

  burst: `10/s`

  steady: `150/m` **scopes:** `campaigns:read`
</Accordion>

<Accordion title="Get catalog variants">
  Retrieve up to 100 account variants per request, sortable by creation date. supports only `$custom` integration and `$default` catalog types. rate limits are 350/s burst and 3500/m steady. requires `catalogs:read` scope.
</Accordion>

<Accordion title="Get campaign tags">
  Return all tags that belong to the given campaign.

  *rate limits*:

  burst: `3/s`

  steady: `60/m` **scopes:** `campaigns:read` `tags:read`
</Accordion>

<Accordion title="Get coupon code bulk create job">
  Get a coupon code bulk create job with the given job id.

  *rate limits*:

  burst: `75/s`

  steady: `700/m` **scopes:** `coupon-codes:read`
</Accordion>

<Accordion title="Get coupon codes">
  Obtains coupon codes using necessary coupon or profile filters. rate limits: 350/s, 3500/m. requires 'coupon-codes:read' scope.
</Accordion>

<Accordion title="Get coupon codes for coupon">
  Gets a list of coupon codes associated with the given coupon id

  *rate limits*:

  burst: `75/s`

  steady: `700/m` **scopes:** `coupon-codes:read`
</Accordion>

<Accordion title="Get segment relationships tags">
  If `related resource` is `tags`, returns the tag ids of all tags associated with the given segment id.

  *rate limits*:

  burst: `3/s`

  steady: `60/m` **scopes:** `segments:read` `tags:read`
</Accordion>

<Accordion title="Spawn bulk profile import job">
  Initiate a job to create/update a batch of profiles, up to 10,000 with a max size of 5mb per request. rate limits: 10/s burst, 150/m steady. requires `lists:write` and `profiles:write` scopes. more info in the bulk profile import api guide.
</Accordion>

<Accordion title="Get tag relationships lists">
  Returns the ids of all lists associated with the given tag.

  *rate limits*:

  burst: `3/s`

  steady: `60/m` **scopes:** `lists:read` `tags:read`
</Accordion>

<Accordion title="Spawn update items job">
  You can bulk update up to 100 catalog items with a 5mb payload limit. a max of 500 jobs can run concurrently. rate limits are 75 requests/second and 700 requests/minute. required scope: `catalogs:write`.
</Accordion>

<Accordion title="Suppress profiles">
  Suppress profiles by email, segment, or list id to stop email marketing, regardless of consent. view guides for details. max 100 emails per request, with rate limits of 75/s and 700/m. scopes: profiles:write, subscriptions:write.
</Accordion>

<Accordion title="Get webhooks">
  Get all webhooks in an account.

  *rate limits*:

  burst: `1/s`

  steady: `15/m` **scopes:** `webhooks:read`
</Accordion>

<Accordion title="Get tag">
  Retrieve the tag with the given tag id.

  *rate limits*:

  burst: `3/s`

  steady: `60/m` **scopes:** `tags:read`
</Accordion>

<Accordion title="Get tag tag group">
  Returns the tag group resource for a given tag id.

  *rate limits*:

  burst: `3/s`

  steady: `60/m` **scopes:** `tags:read`
</Accordion>

<Accordion title="Get tag group relationships tags">
  Returns the tag ids of all tags inside the given tag group.

  *rate limits*:

  burst: `3/s`

  steady: `60/m` **scopes:** `tags:read`
</Accordion>

<Accordion title="Subscribe profiles">
  The api supports double opt-in for marketing, with 'historical import' bypassing consent. it resets opt-outs for returning users. caps at 1000 profiles, 75/s, and 700/min. needs 'lists:write', 'profiles:write', 'subscriptions:write' permissions.
</Accordion>

<Accordion title="Update catalog category relationships items">
  Update item relationships for the given category id.

  *rate limits*:

  burst: `75/s`

  steady: `700/m` **scopes:** `catalogs:write`
</Accordion>

<Accordion title="Spawn update variants job">
  Create a job to bulk update up to 100 catalog variants with a 5mb payload limit. a max of 500 jobs may run concurrently. rate limits are 75/s burst and 700/m steady. requires `catalogs:write` scope.
</Accordion>

<Accordion title="Get segment tags">
  Return all tags associated with the given segment id.

  *rate limits*:

  burst: `3/s`

  steady: `60/m` **scopes:** `segments:read` `tags:read`
</Accordion>

<Accordion title="Get tag group tags">
  Return the tags for a given tag group id.

  *rate limits*:

  burst: `3/s`

  steady: `60/m` **scopes:** `tags:read`
</Accordion>

<Accordion title="Get webhook">
  Get the webhook with the given id.

  *rate limits*:

  burst: `1/s`

  steady: `15/m` **scopes:** `webhooks:read`
</Accordion>

<Accordion title="Update catalog category">
  Update a catalog category with the given category id.

  *rate limits*:

  burst: `75/s`

  steady: `700/m` **scopes:** `catalogs:write`
</Accordion>

<Accordion title="Request profile deletion">
  To delete a profile, use only one identifier: email, phone number, or id. requests are asynchronous and can be tracked. ensure legal compliance; refer to docs. rate limits: 3 per second, 60 per minute.
</Accordion>

<Accordion title="Get tag relationships segments">
  Returns the ids of all segments associated with the given tag.

  *rate limits*:

  burst: `3/s`

  steady: `60/m` **scopes:** `segments:read` `tags:read`
</Accordion>

<Accordion title="Update catalog item relationships categories">
  Update catalog category relationships for the given item id.

  *rate limits*:

  burst: `75/s`

  steady: `700/m` **scopes:** `catalogs:write`
</Accordion>

<Accordion title="Update catalog item">
  Update a catalog item with the given item id.

  *rate limits*:

  burst: `75/s`

  steady: `700/m` **scopes:** `catalogs:write`
</Accordion>

<Accordion title="Get webhook topic">
  Get the webhook topic with the given id.

  *rate limits*:

  burst: `1/s`

  steady: `15/m` **scopes:** `webhooks:read`
</Accordion>

<Accordion title="Get tag relationships tag group">
  Returns the id of the tag group related to the given tag.

  *rate limits*:

  burst: `3/s`

  steady: `60/m` **scopes:** `tags:read`
</Accordion>

<Accordion title="Update coupon">
  *rate limits*:

  burst: `3/s`

  steady: `60/m` **scopes:** `coupons:write`
</Accordion>

<Accordion title="Get template">
  Get a template with the given template id.

  *rate limits*:

  burst: `10/s`

  steady: `150/m` **scopes:** `templates:read`
</Accordion>

<Accordion title="Update tag group">
  Update the tag group with the given tag group id. only a tag group's `name` can be changed. a tag group's `exclusive` or `default` value cannot be changed.

  *rate limits*:

  burst: `3/s`

  steady: `60/m` **scopes:** `tags:read` `tags:write`
</Accordion>

<Accordion title="Get templates">
  Retrieve account templates with sorting options (`id`, `name`, `created`, `updated`). limit of 10 results per page, rate limits at 10/s burst and 150/m steady. requires `templates:read` scope.
</Accordion>

<Accordion title="Update tag">
  Update the tag with the given tag id. only a tag's `name` can be changed. a tag cannot be moved from one tag group to another.

  *rate limits*:

  burst: `3/s`

  steady: `60/m` **scopes:** `tags:read` `tags:write`
</Accordion>

<Accordion title="Unregister client push token">
  This endpoint unsubscribes a push token, for use with klaviyo's mobile sdks and a public api key. push notifications must be on. rate limits are 3/s and 60/m.
</Accordion>

<Accordion title="Update segment">
  Update a segment with the given segment id.

  *rate limits*:

  burst: `1/s`

  steady: `15/m`

  daily: `100/d` **scopes:** `segments:write`
</Accordion>

<Accordion title="Update catalog variant">
  Update a catalog item variant with the given variant id.

  *rate limits*:

  burst: `75/s`

  steady: `700/m` **scopes:** `catalogs:write`
</Accordion>

<Accordion title="Update coupon code">
  Updates a coupon code specified by the given identifier synchronously. we allow updating the 'status' and 'expires at' of coupon codes.

  *rate limits*:

  burst: `350/s`

  steady: `3500/m` **scopes:** `coupon-codes:write`
</Accordion>

<Accordion title="Get webhook topics">
  Get all webhook topics in a klaviyo account.

  *rate limits*:

  burst: `1/s`

  steady: `15/m` **scopes:** `webhooks:read`
</Accordion>

<Accordion title="Unsubscribe profiles">
  Opt-out profiles from email or sms marketing. unsubscribe up to 100 profiles at a time with burst (75/s) and steady (700/m) rate limits. use different method to remove without affecting subscriptions. more on consent and removal in the provided links.
</Accordion>

<Accordion title="Update template">
  Update a template with the given template id. does not currently update drag & drop templates.

  *rate limits*:

  burst: `10/s`

  steady: `150/m` **scopes:** `templates:write`
</Accordion>

<Accordion title="Upload image from file">
  Upload an image from a file. if you want to import an image from an existing url or a data uri, use the upload image from url endpoint instead.

  *rate limits*:

  burst: `3/s`

  steady: `100/m`

  daily: `100/d` **scopes:** `images:write`
</Accordion>

<Accordion title="Update webhook">
  Update the webhook with the given id.

  *rate limits*:

  burst: `1/s`

  steady: `15/m` **scopes:** `webhooks:write`
</Accordion>

<Accordion title="Get update categories job">
  Get a catalog category bulk update job with the given job id. an `include` parameter can be provided to get the following related resource data: `categories`.

  *rate limits*:

  burst: `350/s`

  steady: `3500/m` **scopes:** `catalogs:read`
</Accordion>

<Accordion title="Upload image from url">
  Import an image from a url or data uri. if you want to upload an image from a file, use the upload image from file endpoint instead.

  *rate limits*:

  burst: `3/s`

  steady: `100/m`

  daily: `100/d` **scopes:** `images:write`
</Accordion>

<Accordion title="Get tag groups">
  Retrieve up to 25 tag groups per account, sortable/filterable by specific attributes. default group included. supports cursor pagination and adheres to rate limits of 3 requests per second and 60 per minute. requires `tags:read` scope.
</Accordion>

<Accordion title="Unsuppress profiles">
  Remove 'user suppressed' blocks on profiles manually via email, segment, or list id. does not affect unsubscribes or other suppressions. limits: 100 emails per request, 75/s burst, 700/m steady. scope: 'subscriptions:write'.
</Accordion>

<Accordion title="Update flow status">
  Update the status of a flow with the given flow id, and all actions in that flow.

  *rate limits*:

  burst: `3/s`

  steady: `60/m` **scopes:** `flows:write`
</Accordion>

<Accordion title="Merge profiles">
  Queue a task to merge one source profile into a destination profile using their ids. deletes the source afterwards. visit help center for details. rate limits: 10/s burst, 150/m steady. needs `profiles:write` scope.
</Accordion>

<Accordion title="Get update categories jobs">
  Get all catalog category bulk update jobs. returns a maximum of 100 jobs per request.

  *rate limits*:

  burst: `350/s`

  steady: `3500/m` **scopes:** `catalogs:read`
</Accordion>

<Accordion title="Get tag group">
  Retrieve the tag group with the given tag group id.

  *rate limits*:

  burst: `3/s`

  steady: `60/m` **scopes:** `tags:read`
</Accordion>

<Accordion title="Query campaign values">
  Returns the requested campaign analytics values data

  *rate limits*:

  burst: `1/s`

  steady: `2/m`

  daily: `225/d` **scopes:** `campaigns:read`
</Accordion>

<Accordion title="Update image">
  Update the image with the given image id.

  *rate limits*:

  burst: `10/s`

  steady: `150/m` **scopes:** `images:write`
</Accordion>

<Accordion title="Update campaign">
  Update a campaign with the given campaign id.

  *rate limits*:

  burst: `10/s`

  steady: `150/m` **scopes:** `campaigns:write`
</Accordion>

<Accordion title="Spawn coupon code bulk create job">
  Create a coupon-code-bulk-create-job to bulk create a list of coupon codes. max number of jobs queued at once we allow for is 100.

  *rate limits*:

  burst: `75/s`

  steady: `700/m` **scopes:** `coupon-codes:write`
</Accordion>

<Accordion title="Get update items job">
  Get a catalog item bulk update job with the given job id. an `include` parameter can be provided to get the following related resource data: `items`.

  *rate limits*:

  burst: `350/s`

  steady: `3500/m` **scopes:** `catalogs:read`
</Accordion>

<Accordion title="Get tags">
  Retrieve up to 50 account tags at once, filterable/sortable by name or id, with cursor pagination. rate limits: 3/s burst, 60/m steady. requires `tags:read` scope.
</Accordion>

<Accordion title="Update list">
  Update the name of a list with the given list id.

  *rate limits*:

  burst: `10/s`

  steady: `150/m` **scopes:** `lists:write`
</Accordion>

<Accordion title="Update campaign message">
  Update a campaign message

  *rate limits*:

  burst: `10/s`

  steady: `150/m` **scopes:** `campaigns:write`
</Accordion>

<Accordion title="Query flow series">
  Returns the requested flow analytics series data

  *rate limits*:

  burst: `1/s`

  steady: `2/m`

  daily: `225/d` **scopes:** `flows:read`
</Accordion>

<Accordion title="Get update items jobs">
  Get all catalog item bulk update jobs. returns a maximum of 100 jobs per request.

  *rate limits*:

  burst: `350/s`

  steady: `3500/m` **scopes:** `catalogs:read`
</Accordion>

<Accordion title="Update profile">
  Update profiles with the provided id. setting fields to `null` clears them; omitting fields retains existing data. rate limits: 75/s burst, 700/m steady. required scope: `profiles:write`.
</Accordion>

<Accordion title="Spawn create categories job">
  Create bulk job for up to 100 catalog categories with a 5mb size limit and a max of 500 concurrent jobs. rate limits: 75/s burst, 700/m steady. requires 'catalogs:write' scope.
</Accordion>

<Accordion title="Get update variants job">
  Get a catalog variate bulk update job with the given job id. an `include` parameter can be provided to get the following related resource data: `variants`.

  *rate limits*:

  burst: `350/s`

  steady: `3500/m` **scopes:** `catalogs:read`
</Accordion>

<Accordion title="Update campaign send job">
  Permanently cancel the campaign, setting the status to canceled or revert the campaign, setting the status back to draft

  *rate limits*:

  burst: `10/s`

  steady: `150/m` **scopes:** `campaigns:write`
</Accordion>

<Accordion title="Get tag relationships campaigns">
  Returns the ids of all campaigns associated with the given tag.

  *rate limits*:

  burst: `3/s`

  steady: `60/m` **scopes:** `campaigns:read` `tags:read`
</Accordion>

<Accordion title="Get version ids for form">
  Get the ids of the form versions for the given form.

  *rate limits*:

  burst: `3/s`

  steady: `60/m` **scopes:** `forms:read`
</Accordion>

<Accordion title="Get versions for form">
  Get the form versions for the given form.

  *rate limits*:

  burst: `3/s`

  steady: `60/m` **scopes:** `forms:read`
</Accordion>

<Accordion title="Spawn delete items job">
  Delete batches of catalog items with a bulk job, max 100 items/request, 5mb size limit, and up to 500 concurrent jobs. rate limits are 75/s burst and 700/m steady. requires `catalogs:write` scope.
</Accordion>

<Accordion title="Query flow values">
  Returns the requested flow analytics values data

  *rate limits*:

  burst: `1/s`

  steady: `2/m`

  daily: `225/d` **scopes:** `flows:read`
</Accordion>

<Accordion title="Spawn delete categories job">
  Delete multiple catalog categories in bulk, with a limit of 100 per request and a 5mb payload size. a maximum of 500 concurrent jobs permitted. rate limits are 75/s burst and 700/min steady. requires `catalogs:write` scope.
</Accordion>

<Accordion title="Spawn create items job">
  Create batches of up to 100 catalog items with a 5mb size limit using the bulk job, which allows 500 concurrent jobs. rate limits are 75/s burst and 700/m steady. requires `catalogs:write` scope.
</Accordion>

<Accordion title="Spawn create variants job">
  Initiate a job to bulk create up to 100 catalog variants, with a 5mb payload size limit. a max of 500 jobs can run concurrently. rate limits are 75/s burst and 700/m steady. requires 'catalogs:write' scope.
</Accordion>

<Accordion title="Get update variants jobs">
  Get all catalog variant bulk update jobs. returns a maximum of 100 jobs per request.

  *rate limits*:

  burst: `350/s`

  steady: `3500/m` **scopes:** `catalogs:read`
</Accordion>

<Accordion title="Spawn update categories job">
  Create a job to bulk update up to 100 categories, with a 5mb size limit and a maximum of 500 concurrent jobs. burst rate limit is 75/s, steady is 700/m. requires `catalogs:write` scope.
</Accordion>

<Accordion title="Spawn delete variants job">
  Delete multiple catalog variants with a bulk job, max 100 per request, 5mb size limit. only 500 jobs can run concurrently. rate limits: 75/s burst, 700/m steady. requires `catalogs:write` scope.
</Accordion>

<Accordion title="Get tag relationships flows">
  Returns the ids of all flows associated with the given tag.

  *rate limits*:

  burst: `3/s`

  steady: `60/m` **scopes:** `flows:read` `tags:read`
</Accordion>

<Accordion title="Remove profile from list">
  Delete profiles from a marketing list using its id without affecting overall consent. use unsubscribe profiles for complete unsubscribing. limit: 1000 profiles per call, 10 calls/s, 150 calls/m. required scopes: `lists:write`, `profiles:write`.
</Accordion>

<Accordion title="Query metric aggregates">
  The klaviyo endpoint fetches metric events, handling json requests for custom data queries, sorting, and filtering; offers grouping and time-based filters; requires adherence to rate limits (3 requests per second, 60 per minute) under 'metrics:read'.
</Accordion>


# Kommo
Source: https://docs.push.ai/integrations/kommo



Kommo CRM (formerly amoCRM) integration tool for managing customer relationships,
sales pipelines, and business processes. This tool enables automation of various
CRM operations including:

<Accordion title="Create Kommo Companies">
  Action to add one or more companies into the kommo account.
</Accordion>

<Accordion title="Create Kommo Contact">
  Action to create one or more contacts in kommo crm.
</Accordion>

<Accordion title="List Kommo Companies">
  Action to list kommo companies with various filter options.
</Accordion>

<Accordion title="Create Kommo Lead">
  Action to create one or more leads in kommo crm.
</Accordion>

<Accordion title="Create Kommo Tasks">
  Action to create a task in kommo crm.
</Accordion>

<Accordion title="List Kommo Custom Fields">
  Action to list custom fields in kommo crm.
</Accordion>

<Accordion title="List Kommo Tasks">
  Action to list tasks in kommo crm.
</Accordion>

<Accordion title="Update Kommo Contact">
  Action to update contacts in kommo crm.
</Accordion>

<Accordion title="Update Kommo Lead">
  Action to update a lead in kommo crm.
</Accordion>

<Accordion title="List Kommo Contacts">
  Action to list contacts in kommo crm.
</Accordion>

<Accordion title="Update Kommo Company">
  Action to update a single company in kommo crm.
</Accordion>

<Accordion title="Update Kommo Task">
  Action to update a task in kommo crm.
</Accordion>

<Accordion title="List Kommo Leads">
  Action to list leads in kommo crm.
</Accordion>

<Accordion title="List Kommo Lead Pipelines">
  Action to list lead pipelines in kommo crm.
</Accordion>

<Accordion title="List Kommo Pipeline Stages">
  Action to list stages of a pipeline in kommo crm.
</Accordion>


# Linear
Source: https://docs.push.ai/integrations/linear



Connect to Linear to create and manage issues, list projects, teams, and more

<Accordion title="Create linear comment">
  Create a new comment on a linear issue
</Accordion>

<Accordion title="Create linear attachment">
  Create a new attachment on a linear issue
</Accordion>

<Accordion title="Get Create Issue Default Params">
  Use this action before creating a linear issue to get the default issue estimate and state for a linear team.
</Accordion>

<Accordion title="Delete Issue">
  Delete an issue in linear using the issue id.
</Accordion>

<Accordion title="Donwload Issue Attachments">
  Download attachments from a linear issue.
</Accordion>

<Accordion title="Create linear issue">
  Create a new issue in a linear account and return the url of the created issue. note: use linear create linear issue details action to get the default state and estimate for a linear team.
</Accordion>

<Accordion title="Get Labels by Team">
  Get the list of labels in a linear team
</Accordion>

<Accordion title="Create Label">
  Create a new label in a linear team
</Accordion>

<Accordion title="Get Linear Issue">
  Get the details of a linear issue like title, description, attachments, comments.
</Accordion>

<Accordion title="List linear projects">
  Get the list of projects in a linear account
</Accordion>

<Accordion title="Get Issues by Project">
  Get the list of issues in a linear project
</Accordion>

<Accordion title="Get Cycles by Team">
  Get the list of cycles in a linear team.
</Accordion>

<Accordion title="Get All Cycles">
  Get the list of all cycles in a linear account
</Accordion>

<Accordion title="Get States by Team">
  Get the list of states in a linear team.
</Accordion>

<Accordion title="Remove Label from Linear Issue">
  This tool removes a specific label from an existing linear issue. it enables users to remove a label from an issue, complementing the existing linear create linear label tool for complete label management.
</Accordion>

<Accordion title="Get Teams by Project">
  Get the list of teams in a linear account filtered by project id
</Accordion>

<Accordion title="Run Query or Mutation">
  Run a query or mutation on linear
</Accordion>

<Accordion title="Update issue">
  Updates an existing issue in linear with the specified parameters. this tool allows modification of various issue attributes including title, description, status, priority, labels, and more.
</Accordion>


# Linkedin
Source: https://docs.push.ai/integrations/linkedin



Connect to Linked to send and manage emails.

<Accordion title="Get My Info">
  Action to get info of currently authenticated profile from linkedin. this action can be used to get the author identifier (author id) to create posts.
</Accordion>

<Accordion title="Create LinkedIn Post">
  Create linkedin post
</Accordion>

<Accordion title="Get Company Info">
  Fetch organization acls for the authenticated user. shows organizations where the user has specific roles (e.g., administrator). required oauth scope: - r organization admin note: this endpoint only returns organizations where the user has roles. if the user lacks administrative roles, the response will be empty.
</Accordion>

<Accordion title="Delete LinkedIn Post">
  Action to delete a post on linkedin.
</Accordion>


# Linkhut
Source: https://docs.push.ai/integrations/linkhut



LinkHut manages bookmarked links in a minimalistic, shareable interface, helping teams organize URLs and track references in one place

<Accordion title="Delete bookmark">
  This tool allows users to delete a bookmark from their linkhut account by providing the bookmark url. it operates independently and only requires the url parameter to identify and remove the bookmark.
</Accordion>

<Accordion title="Add bookmark">
  Adds a new bookmark to linkhut. the bookmark can be marked as private/public and read/unread, with optional tags and notes.
</Accordion>

<Accordion title="Get bookmarks">
  This tool retrieves all bookmarks from the user's linkhut account. it makes a get request to the api endpoint and handles authentication. the tool returns a list of bookmarks including details such as url, title, tags, notes, and timestamp.
</Accordion>

<Accordion title="Update Bookmark">
  This tool allows users to update an existing bookmark in linkhut. the tool updates the metadata of a bookmark including its title, description, and tags.
</Accordion>

<Accordion title="Get all tags">
  Retrieves a list of all tags and their usage counts for the authenticated user. no additional parameters required besides authentication.
</Accordion>


# Linkup
Source: https://docs.push.ai/integrations/linkup



Search the Web for Relevant Results (RAG Use Case)

<Accordion title="Search Linkup">
  This tool allows users to search and retrieve insights using the linkup api. it implements a search functionality via the post /search endpoint and supports various parameters including 'query', 'depth', and 'output type' (with options such as 'sourcedanswer', 'searchresults', and 'structured'). optional inclusion of images is available via the include images parameter.
</Accordion>

<Accordion title="Get Natural Language Answer">
  This tool gets a natural language answer to a given question using linkup's api. it processes the question with provided parameters (query and depth) and returns a structured answer with text and sources used. it supports varying precision based on defined depth and is designed for natural language query responses.
</Accordion>


# Listennotes
Source: https://docs.push.ai/integrations/listennotes



The best podcast search engine.

<Accordion title="Get podcast audience by id">
  Retrieves audience information for a specific podcast identified by its unique id. this endpoint allows users to access demographic data, listening statistics, or other audience-related metrics for a particular podcast. it's useful for podcast creators, marketers, or analysts who want to understand their audience better or track the performance of their content. the tool returns aggregated data about the podcast's listeners, which may include but is not limited to age groups, geographic distribution, listening habits, or engagement metrics. it should be used when detailed audience insights for a specific podcast are needed. note that this endpoint does not provide real-time listener counts or individual listener data to protect user privacy.
</Accordion>

<Accordion title="Fetch related searches data">
  Retrieves a list of related search queries based on the current context or user's recent search activity. this endpoint is useful for enhancing user experience by suggesting alternative or complementary search terms, potentially increasing engagement and discovery within the platform. it should be used when you want to provide users with additional search options or ideas related to their current interests or queries. the endpoint does not require any explicit parameters, relying instead on server-side logic to determine the context for generating related searches. note that the specific algorithm for generating related searches and the format of the response are not detailed in the schema, so integrators should be prepared to handle various response structures.
</Accordion>

<Accordion title="Retrieve genre list">
  The getgenres endpoint retrieves a comprehensive list of available genres within the listennotestest platform. this endpoint is designed to provide users with up-to-date information on content categories, which can be used for filtering, organizing, or subscribing to specific types of content. it's particularly useful for applications that need to populate genre-based dropdown menus, create content recommendation systems, or set up genre-specific notification preferences. the endpoint does not require any input parameters, making it simple to use for fetching the entire genre catalog. however, users should be aware that the response may contain a large amount of data, depending on the number of genres available in the system.
</Accordion>

<Accordion title="Retrieve regions">
  Retrieves information about available regions in the listennotestest platform. this endpoint allows users to fetch a list of regions, which can be used for filtering content, setting up notifications, or managing regional preferences. it should be used when the client needs to know what regions are supported by the platform or when regional data is required for other operations. the endpoint returns basic details about each region, potentially including region codes, names, and any associated metadata. it does not provide detailed statistics or real-time data about events within these regions.
</Accordion>

<Accordion title="Post episodes by ids">
  The listennotestest episodes post endpoint allows users to retrieve metadata for multiple podcast episodes in a single request. this post endpoint accepts a list of episode ids and returns detailed information about each specified episode. it's particularly useful for bulk retrieval of episode data, reducing the number of api calls needed when working with multiple episodes. the endpoint should be used when you need to fetch information about specific, known episodes rather than searching or browsing. keep in mind that this endpoint is focused on retrieval only and does not support creating, updating, or deleting episode data.
</Accordion>

<Accordion title="Spell check retrieval">
  The spellcheck endpoint provides a spell-checking service for text input. it allows users to verify the spelling of words or phrases, likely related to audio content or podcast descriptions within the listennotestest platform. this tool should be used when there's a need to ensure the correctness of textual content, such as titles, descriptions, or tags associated with audio files or podcasts. the endpoint doesn't specify any parameters, suggesting it might use query parameters for input or have a default behavior. it's important to note that without more specific information, the exact input method and response format are not clear, which may require additional documentation or testing to fully understand its usage.
</Accordion>

<Accordion title="Delete podcast by id">
  Deletes a specific podcast from the system based on its unique identifier. this endpoint should be used when you want to permanently remove a podcast and all its associated data from the platform. it's important to note that this action is irreversible, so it should be used with caution. once a podcast is deleted, it cannot be recovered, and all related notifications and updates for that podcast will cease. this endpoint is typically used for managing outdated content, removing test data, or complying with content removal requests.
</Accordion>

<Accordion title="Retrieve trending searches">
  Retrieves a list of currently trending search terms related to podcasts. this endpoint provides real-time insights into popular topics and interests among podcast listeners. it's particularly useful for content creators, marketers, and researchers who want to stay updated on current trends in the podcast industry. the endpoint returns a curated list of search terms, likely ranked by popularity or recent search volume. while it offers valuable trend data, it does not provide detailed analytics or historical trend information. users should be aware that the trending searches may change frequently and might be influenced by various factors such as current events, seasonal topics, or platform-specific promotions.
</Accordion>

<Accordion title="Retrieve language list">
  Retrieves a list of supported languages in the listen notes api. this endpoint provides information about the languages available for use within the platform, which can be crucial for internationalization and localization efforts. use this endpoint when you need to know which languages are supported by the api, such as for filtering content or setting user preferences. the response likely includes language codes and possibly their corresponding names or additional metadata. note that this endpoint doesn't accept any parameters, offering a static list of supported languages.
</Accordion>

<Accordion title="Post podcast rss by id">
  Retrieves or generates an rss feed for a specific podcast identified by its unique id. this endpoint allows users to access the podcast's content in a standardized rss format, which can be used for syndication or integration with podcast players and aggregators. the rss feed typically includes information such as episode titles, descriptions, publication dates, and audio file urls. use this endpoint when you need to programmatically access a podcast's rss feed, for example, to set up notifications for new episodes or to integrate the podcast content into another application. note that this endpoint does not create or modify the podcast itself; it only provides access to the existing podcast data in rss format.
</Accordion>

<Accordion title="Get playlists">
  Retrieves a list of playlists from the listen notes platform. this endpoint allows users to fetch all available playlists associated with their account or publicly accessible playlists. it should be used when you need to display a collection of playlists, such as in a user's library or for browsing purposes. the endpoint returns basic information about each playlist, which may include the playlist name, creator, number of episodes, and other relevant metadata. note that this endpoint likely returns a limited number of playlists per request, and pagination might be necessary for retrieving large collections. it does not provide detailed information about the episodes within each playlist; separate api calls would be required to fetch that level of detail.
</Accordion>

<Accordion title="Search episode titles">
  The search episode titles endpoint allows users to search for and retrieve episode titles based on specified criteria. it provides a powerful way to find relevant episodes quickly, supporting real-time updates and notifications for changes in episode titles. this endpoint is particularly useful for applications that need to display or monitor podcast content, offering up-to-date information on episode titles across various shows or categories. while it excels at title searches, it may not provide full episode details or content, focusing primarily on the title information.
</Accordion>

<Accordion title="Get curated podcasts">
  Retrieves a list of curated podcasts from the listen notes platform. this endpoint provides access to a collection of handpicked and organized podcasts, likely curated by experts or algorithms. it's useful for discovering high-quality content or featuring recommended podcasts to users. the endpoint returns a selection of podcasts, possibly grouped by themes, genres, or other criteria. while it offers a curated selection, it may not provide exhaustive search capabilities or personalized recommendations based on individual user preferences.
</Accordion>

<Accordion title="Retrieve podcast by id">
  Retrieves detailed information about a specific podcast using its unique identifier. this endpoint allows users to fetch comprehensive data about a particular podcast, including but not limited to its title, description, author, episode list, and other metadata. it's ideal for applications that need to display in-depth information about a single podcast or integrate podcast data into their systems. the endpoint should be used when detailed information about a known podcast is required, rather than for searching or browsing multiple podcasts. note that this endpoint only provides information for podcasts that exist within the listen notes database and may not include real-time updates for very recent changes to the podcast.
</Accordion>

<Accordion title="Submit podcast rss url">
  The submit podcast endpoint allows users to submit a podcast for inclusion in the listen notes database. this tool should be used when a user wants to add a new podcast to the listen notes platform or update an existing podcast's information. it requires the rss feed url of the podcast and optionally accepts an email address for status notifications. the endpoint is designed for simplicity, focusing solely on podcast submission without providing additional podcast management features. note that submission does not guarantee immediate inclusion; podcasts are subject to review before being added to the database.
</Accordion>

<Accordion title="Retrieve episode by id">
  Retrieves detailed information about a specific episode using its unique identifier. this endpoint allows users to access comprehensive data about an individual episode, which may include metadata such as title, description, publication date, duration, and associated podcast information. it's particularly useful when you need to display or process information about a single episode. the endpoint should be used when detailed information about a known episode is required, but it won't provide lists of episodes or search functionality. note that the response structure and the exact fields returned are not specified in the given schema, so the actual content may vary based on the api implementation.
</Accordion>

<Accordion title="Get typeahead suggestions">
  The typeahead endpoint provides real-time search suggestions as users type their queries. it's designed to enhance the user experience by offering relevant autocomplete options, making it easier for users to find podcasts, episodes, or other content on the listen notes platform. this endpoint should be used to implement a dynamic search box that updates suggestions with each keystroke. it's particularly useful for improving search efficiency and accuracy by guiding users towards valid search terms. the endpoint likely returns a json array of matching results, which may include basic information like titles, ids, and possibly thumbnail images for each suggestion. it's important to note that this endpoint is intended for quick, lightweight suggestions and may not provide full details about each result - for comprehensive information, additional api calls might be necessary.
</Accordion>

<Accordion title="Create podcast via form data">
  The listennotestest podcasts post endpoint allows users to retrieve information about multiple podcasts using various identifiers such as listen notes ids, rss feed urls, apple podcasts ids, or spotify ids. it can optionally fetch the latest episodes for the specified podcasts. this endpoint is useful for bulk podcast data retrieval and for staying updated on recent episodes across multiple shows. it's particularly valuable for applications that need to sync or update podcast information from different platforms. the endpoint has a limit of returning up to 15 latest episodes per request, so for comprehensive episode history, multiple calls may be necessary.
</Accordion>

<Accordion title="Get podcast domains by name">
  Retrieves a list of podcasts associated with a specified domain name. this endpoint allows users to discover podcasts that are produced or hosted by a particular website or organization. it's useful for content aggregation, competitive analysis, or finding podcasts related to specific brands or companies. the tool returns podcast information for the given domain, which may include multiple podcasts if the domain produces several shows. it should be used when you need to find all podcasts linked to a specific web domain. note that this endpoint may not capture podcasts that are hosted on general podcast platforms unless they have a custom domain setup.
</Accordion>

<Accordion title="Retrieve curated podcast by id">
  Retrieves detailed information about a specific curated podcast using its unique identifier. this endpoint allows users to access comprehensive data about a carefully selected podcast collection, including its contents, curator information, and associated metadata. it's particularly useful for applications that want to display or analyze curated podcast lists. the endpoint should be used when detailed information about a known curated podcast is required, but it won't provide a list of all available curated podcasts or allow modifications to the curated content.
</Accordion>

<Accordion title="Get podcast recommendations by id">
  Retrieves a list of podcast recommendations based on a specified podcast id. this endpoint is designed to help users discover new podcasts that are similar or related to a podcast they already enjoy. it can be used to enhance user experience by providing personalized content suggestions, increasing engagement, and broadening the listener's podcast library. the recommendations are likely based on factors such as genre, topics, popularity, and listening patterns of users with similar interests. while this tool is excellent for content discovery, it should not be relied upon for comprehensive podcast information or metadata retrieval.
</Accordion>

<Accordion title="Listen to just listen endpoint">
  The 'just listen' endpoint is a basic listener or health check mechanism for the listennotestest app. it allows users to verify the availability and responsiveness of the service without requiring any input parameters. this endpoint should be used for monitoring the status of the listennotestest service or as a simple ping to ensure the api is operational. it's important to note that this endpoint likely doesn't provide any specific data about podcasts or user accounts. the response is expected to be minimal, possibly just confirming that the service is up and running. while useful for basic health checks, it should not be relied upon for any complex operations or data retrieval within the listennotestest ecosystem.
</Accordion>

<Accordion title="Get episode recommendations by id">
  Retrieves a list of recommended podcast episodes based on a specific episode id. this endpoint utilizes the listen notes api to generate personalized content suggestions, helping users discover new episodes similar to ones they've already enjoyed. it's ideal for enhancing user engagement and content discovery within podcast applications. the recommendations are likely based on factors such as episode content, listener behavior, and popularity. use this endpoint when you want to provide users with tailored podcast suggestions or implement a "you might also like" feature. note that the quality and relevance of recommendations may vary depending on the popularity and metadata of the source episode.
</Accordion>

<Accordion title="Fetch best podcasts list">
  The getbestpodcasts endpoint retrieves a curated list of the best podcasts from the listen notes platform. it allows users to access a collection of top-rated or popular podcasts, which can be filtered by genre, region, and content rating. this endpoint is useful for discovering high-quality podcast content, creating recommendation systems, or populating podcast directories. the results are paginated for efficient data retrieval and can be customized to exclude explicit content if required. while it provides a valuable overview of top podcasts, it may not include real-time updates or notifications about new episodes or changes in podcast rankings.
</Accordion>

<Accordion title="Retrieve playlist by id">
  Retrieves detailed information about a specific playlist using its unique identifier. this endpoint allows users to fetch comprehensive data about a playlist, including its name, description, creator, tracks, and other relevant metadata. it's particularly useful when you need to display or process information about a known playlist. the endpoint should be used when you have the playlist's id and require its current, up-to-date details. note that this endpoint only provides read access to playlist data and does not allow for modifications. it may not include real-time listening statistics or user-specific interaction data with the playlist.
</Accordion>

<Accordion title="Search operation endpoint">
  The search endpoint allows users to query notifications or events within the listennotestest platform. it provides a way to find specific notifications based on keywords or identifiers, helping users locate relevant information quickly. this get request likely returns a list of matching notifications or events, which can be useful for monitoring specific activities or retrieving historical data. the endpoint supports basic search functionality and potentially includes options for pagination and sorting to manage large result sets efficiently.
</Accordion>


# Lmnt
Source: https://docs.push.ai/integrations/lmnt



LMNT is an API for text-to-speech and voice cloning

<Accordion title="Get Synthesize Speech">
  Synthesizes speech from text using a specific voice in lmnt.
</Accordion>

<Accordion title="Update Voice Info">
  Updates information about a specific voice in lmnt.
</Accordion>

<Accordion title="Create Voice">
  Creates a voice in lmnt.
</Accordion>

<Accordion title="Delete Voice Info">
  Deletes information about a specific voice in lmnt.
</Accordion>

<Accordion title="Get Account">
  Gets an account in lmnt.
</Accordion>

<Accordion title="Get Voices List">
  Gets a list of voices in lmnt.
</Accordion>

<Accordion title="Get Voice Info">
  Gets information about a specific voice in lmnt.
</Accordion>


# Mailchimp
Source: https://docs.push.ai/integrations/mailchimp



Mailchimp is an email marketing and automation platform providing campaign templates, audience segmentation, and performance analytics to drive engagement and conversions

<Accordion title="Add folder">
  Create a new folder in the file manager.
</Accordion>

<Accordion title="Add export">
  Create a new account export in your mailchimp account.
</Accordion>

<Accordion title="Add file">
  Upload a new image or file to the file manager.
</Accordion>

<Accordion title="Add cart">
  Add a new cart to a store.
</Accordion>

<Accordion title="Add interest category">
  Create a new interest category.
</Accordion>

<Accordion title="Add cart line item">
  Add a new line item to an existing cart.
</Accordion>

<Accordion title="Add member to list">
  Add a new member to the list.
</Accordion>

<Accordion title="Add member to segment">
  Add a member to a static segment.
</Accordion>

<Accordion title="Add interest in category">
  Create a new interest or 'group name' for a specific category.
</Accordion>

<Accordion title="Add landing page">
  Create a new mailchimp landing page.
</Accordion>

<Accordion title="Add order line item">
  Add a new line item to an existing order.
</Accordion>

<Accordion title="Add or remove member tags">
  Add or remove tags from a list member. if a tag that does not exist is passed in and set as 'active', a new tag will be created.
</Accordion>

<Accordion title="Add connected site">
  Create a new mailchimp connected site.
</Accordion>

<Accordion title="Add automation">
  Create a new classic automation in your mailchimp account.
</Accordion>

<Accordion title="Add merge field">
  Add a new merge field for a specific audience.
</Accordion>

<Accordion title="Add product">
  Add a new product to a store.
</Accordion>

<Accordion title="Add order">
  Add a new order to a store.
</Accordion>

<Accordion title="Add or update customer">
  Add or update a customer.
</Accordion>

<Accordion title="Add or update product variant">
  Add or update a product variant.
</Accordion>

<Accordion title="Add batch webhook">
  Configure a webhook that will fire whenever any batch request completes processing. you may only have a maximum of 20 batch webhooks.
</Accordion>

<Accordion title="Add customer">
  Add a new customer to a store.
</Accordion>

<Accordion title="Add product variant">
  Add a new variant to the product.
</Accordion>

<Accordion title="Add product image">
  Add a new image to the product.
</Accordion>

<Accordion title="Add or update list member">
  Add or update a list member.
</Accordion>

<Accordion title="Add promo code">
  Add a new promo code to a store.
</Accordion>

<Accordion title="Add segment">
  Create a new segment in a specific list.
</Accordion>

<Accordion title="Add list">
  Create a new list in your mailchimp account.
</Accordion>

<Accordion title="Add promo rule">
  Add a new promo rule to a store.
</Accordion>

<Accordion title="Add domain to account">
  Add a domain to the account.
</Accordion>

<Accordion title="Add member note">
  Add a new note for a specific subscriber.
</Accordion>

<Accordion title="Batch add or remove members">
  Batch add/remove list members to static segment
</Accordion>

<Accordion title="Add webhook">
  Create a new webhook for a specific list.
</Accordion>

<Accordion title="Create a survey campaign">
  Utilize the list id and survey id to generate a campaign that links to your survey.
</Accordion>

<Accordion title="Batch subscribe or unsubscribe">
  Batch subscribe or unsubscribe list members.
</Accordion>

<Accordion title="Add template">
  Create a new template for the account. only classic templates are supported.
</Accordion>

<Accordion title="Add template folder">
  Create a new template folder.
</Accordion>

<Accordion title="Add store">
  Add a new store to your mailchimp account.
</Accordion>

<Accordion title="Cancel campaign">
  Cancel a regular or plain-text campaign after you send, before all of your recipients receive it. this feature is included with mailchimp pro.
</Accordion>

<Accordion title="Add campaign">
  Create a new mailchimp campaign.
</Accordion>

<Accordion title="Delete batch request">
  Stops a batch request from running. since only one batch request is run at a time, this can be used to cancel a long running request. the results of any completed operations will not be available after this call.
</Accordion>

<Accordion title="Archive automation">
  Archiving will permanently end your automation and keep the report data. you'll be able to replicate your archived automation, but you can't restart it.
</Accordion>

<Accordion title="Campaign abuse report details">
  Get information about a specific abuse report for a campaign.
</Accordion>

<Accordion title="Campaign statistics feedback">
  Get feedback based on a campaign's statistics. advice feedback is based on campaign stats like opens, clicks, unsubscribes, bounces, and more.
</Accordion>

<Accordion title="Customer journeys api trigger for a contact">
  Create a trigger step in the customer journey builder via the api. use the provided url with \{journey id} and \{step id} to activate conditions for a contact.
</Accordion>

<Accordion title="Delete batch webhook">
  Remove a batch webhook. webhooks will no longer be sent to the given url.
</Accordion>

<Accordion title="Add subscriber to workflow email">
  Manually add a subscriber to a workflow, bypassing the default trigger settings. you can also use this endpoint to trigger a series of automated emails in an api 3.0 workflow type.
</Accordion>

<Accordion title="Archive list member">
  Archive a list member. to permanently delete, use the delete-permanent action.
</Accordion>

<Accordion title="Customize signup form">
  Customize a list's default signup form.
</Accordion>

<Accordion title="Add event">
  Add an event for a list member.
</Accordion>

<Accordion title="Add campaign folder">
  Create a new campaign folder.
</Accordion>

<Accordion title="Add campaign feedback">
  Add feedback on a specific campaign.
</Accordion>

<Accordion title="Get connected site">
  Get information about a specific connected site.
</Accordion>

<Accordion title="Delete list member">
  Delete all personally identifiable information related to a list member, and remove them from a list. this will make it impossible to re-import the list member.
</Accordion>

<Accordion title="Get campaign folder">
  Get information about a specific folder used to organize campaigns.
</Accordion>

<Accordion title="Delete cart">
  Delete a cart.
</Accordion>

<Accordion title="Delete campaign folder">
  Delete a specific campaign folder, and mark all the campaigns in the folder as 'unfiled'.
</Accordion>

<Accordion title="Delete merge field">
  Delete a specific merge field.
</Accordion>

<Accordion title="Delete list">
  Delete a list from your mailchimp account. if you delete a list, you'll lose the list history—including subscriber activity, unsubscribes, complaints, and bounces. you'll also lose subscribers' email addresses, unless you exported and backed up your list.
</Accordion>

<Accordion title="Delete campaign feedback message">
  Remove a specific feedback message for a campaign.
</Accordion>

<Accordion title="Get batch webhook info">
  Get information about a specific batch webhook.
</Accordion>

<Accordion title="Delete interest category">
  Delete a specific interest category.
</Accordion>

<Accordion title="Delete connected site">
  Remove a connected site from your mailchimp account.
</Accordion>

<Accordion title="Delete domain">
  Delete a verified domain from the account.
</Accordion>

<Accordion title="Delete template">
  Delete a specific template.
</Accordion>

<Accordion title="Delete campaign">
  Remove a campaign from your mailchimp account.
</Accordion>

<Accordion title="Get campaign content">
  Get the html and plain-text content for a campaign.
</Accordion>

<Accordion title="Get campaign info">
  Get information about a specific campaign.
</Accordion>

<Accordion title="Get campaign feedback message">
  Get a specific feedback message from a campaign.
</Accordion>

<Accordion title="Delete webhook">
  Delete a specific webhook in a list.
</Accordion>

<Accordion title="Get interest in category">
  Get interests or 'group names' for a specific category.
</Accordion>

<Accordion title="Get growth history by month">
  Get a summary of a specific list's growth activity for a specific month and year.
</Accordion>

<Accordion title="Delete cart line item">
  Delete a specific cart line item.
</Accordion>

<Accordion title="Get interest category info">
  Get information about a specific interest category.
</Accordion>

<Accordion title="Delete template folder">
  Delete a specific template folder, and mark all the templates in the folder as 'unfiled'.
</Accordion>

<Accordion title="Get information about all surveys for a list">
  Get information about all available surveys for a specific list.
</Accordion>

<Accordion title="Get folder">
  Get information about a specific folder in the file manager.
</Accordion>

<Accordion title="Get conversation">
  Api endpoint for conversations is deprecated, replaced by inbox. although historical data is accessible, new campaign replies and messages are not retrievable through this endpoint.
</Accordion>

<Accordion title="Delete customer">
  Delete a customer from a store.
</Accordion>

<Accordion title="Get landing page info">
  Get information about a specific page.
</Accordion>

<Accordion title="Get member info">
  Get information about a specific list member, including a currently subscribed, unsubscribed, or bounced member.
</Accordion>

<Accordion title="Get landing page content">
  Get the html for your landing page.
</Accordion>

<Accordion title="Get member note">
  Get a specific note for a specific list member.
</Accordion>

<Accordion title="Get merge field">
  Get information about a specific merge field.
</Accordion>

<Accordion title="Delete workflow email">
  Removes an individual classic automation workflow email. emails from certain workflow types, including the abandoned cart email (abandonedcart) and product retargeting email (abandonedbrowse) workflows, cannot be deleted.
</Accordion>

<Accordion title="Get customer info">
  Get information about a specific customer.
</Accordion>

<Accordion title="Get opened campaign subscriber">
  Get information about a specific subscriber who opened a campaign.
</Accordion>

<Accordion title="Get segment info">
  Get information about a specific segment.
</Accordion>

<Accordion title="Delete file">
  Remove a specific file from the file manager.
</Accordion>

<Accordion title="Delete note">
  Delete a specific note for a specific list member.
</Accordion>

<Accordion title="Get product variant info">
  Get information about a specific product variant.
</Accordion>

<Accordion title="Get message">
  The conversation endpoint is outdated and replaced by inbox, which isn't supported by it. historical conversation data is accessible, but new replies and inbox messages are not.
</Accordion>

<Accordion title="Get store info">
  Get information about a specific store.
</Accordion>

<Accordion title="Get landing page report">
  Get report of a landing page.
</Accordion>

<Accordion title="Get campaign recipient info">
  Get information about a specific campaign recipient.
</Accordion>

<Accordion title="Get domain info">
  Get the details for a single domain on the account.
</Accordion>

<Accordion title="Get promo rule">
  Get information about a specific promo rule.
</Accordion>

<Accordion title="Get order info">
  Get information about a specific order.
</Accordion>

<Accordion title="Get subscriber removed from workflow">
  Get information about a specific subscriber who was removed from a classic automation workflow.
</Accordion>

<Accordion title="Get campaign link details">
  Get click details for a specific link in a campaign.
</Accordion>

<Accordion title="Get promo code">
  Get information about a specific promo code.
</Accordion>

<Accordion title="Get abuse report">
  Get details about a specific abuse report.
</Accordion>

<Accordion title="Get latest chimp chatter">
  Return the chimp chatter for this account ordered by most recent.
</Accordion>

<Accordion title="Get survey question report">
  Get report for a survey question.
</Accordion>

<Accordion title="Get account export info">
  Get information about a specific account export.
</Accordion>

<Accordion title="Get subscriber email activity">
  Get a specific list member's activity in a campaign including opens, clicks, and bounces.
</Accordion>

<Accordion title="Delete order">
  Delete an order.
</Accordion>

<Accordion title="Delete interest in category">
  Delete interests or group names in a specific category.
</Accordion>

<Accordion title="Delete folder">
  Delete a specific folder in the file manager.
</Accordion>

<Accordion title="Get template folder">
  Get information about a specific folder used to organize templates.
</Accordion>

<Accordion title="Get template info">
  Get information about a specific template.
</Accordion>

<Accordion title="Delete landing page">
  Delete a landing page.
</Accordion>

<Accordion title="Get facebook ad info">
  Get details of a facebook ad.
</Accordion>

<Accordion title="Get unsubscribed member">
  Get information about a specific list member who unsubscribed from a campaign.
</Accordion>

<Accordion title="Get workflow email info">
  Get information about an individual classic automation workflow email.
</Accordion>

<Accordion title="Get webhook info">
  Get information about a specific webhook.
</Accordion>

<Accordion title="Get order line item">
  Get information about a specific order line item.
</Accordion>

<Accordion title="Get list info">
  Get information about a specific list in your mailchimp account. results include list members who have signed up but haven't confirmed their subscription yet and unsubscribed or cleaned.
</Accordion>

<Accordion title="Get lists info">
  Get information about all lists in the account.
</Accordion>

<Accordion title="Get survey report">
  Get report for a survey.
</Accordion>

<Accordion title="List account exports">
  Get a list of account exports for a given account.
</Accordion>

<Accordion title="Delete order line item">
  Delete a specific order line item.
</Accordion>

<Accordion title="List answers for question">
  Get answers for a survey question.
</Accordion>

<Accordion title="Get facebook ad report">
  Get report of a facebook ad.
</Accordion>

<Accordion title="Get product image info">
  Get information about a specific product image.
</Accordion>

<Accordion title="Get survey response">
  Get a single survey response.
</Accordion>

<Accordion title="Get survey">
  Get details about a specific survey.
</Accordion>

<Accordion title="Get campaign report">
  Get report details for a specific sent campaign.
</Accordion>

<Accordion title="Get authorized app info">
  Get information about a specific authorized application.
</Accordion>

<Accordion title="List automated emails">
  Get a summary of the emails in a classic automation workflow.
</Accordion>

<Accordion title="List abuse reports">
  Get all abuse reports for a specific list.
</Accordion>

<Accordion title="Get product info">
  Get information about a specific product.
</Accordion>

<Accordion title="List authorized apps">
  Get a list of an account's registered, connected applications.
</Accordion>

<Accordion title="Get campaign send checklist">
  Review the send checklist for a campaign, and resolve any issues before sending.
</Accordion>

<Accordion title="List automations">
  Get a summary of an account's classic automations.
</Accordion>

<Accordion title="Delete product">
  Delete a product.
</Accordion>

<Accordion title="List automated email subscribers">
  Get information about a classic automation email queue.
</Accordion>

<Accordion title="Delete promo code">
  Delete a promo code from a store.
</Accordion>

<Accordion title="Delete promo rule">
  Delete a promo rule from a store.
</Accordion>

<Accordion title="Get cart info">
  Get information about a specific cart.
</Accordion>

<Accordion title="Delete product image">
  Delete a product image.
</Accordion>

<Accordion title="Get cart line item">
  Get information about a specific cart line item.
</Accordion>

<Accordion title="Get file">
  Get information about a specific file in the file manager.
</Accordion>

<Accordion title="Get automation info">
  Get a summary of an individual classic automation workflow's settings and content. the `trigger settings` object returns information for the first email in the workflow.
</Accordion>

<Accordion title="Get clicked link subscriber">
  Get information about a specific subscriber who clicked a link in a specific campaign.
</Accordion>

<Accordion title="Delete store">
  Delete a store. deleting a store will also delete any associated subresources, including customers, orders, products, and carts.
</Accordion>

<Accordion title="Delete segment">
  Delete a specific segment in a list.
</Accordion>

<Accordion title="Get automated email subscriber">
  Get information about a specific subscriber in a classic automation email queue.
</Accordion>

<Accordion title="List api root resources">
  Get links to all other resources available in the api.
</Accordion>

<Accordion title="Get batch operation status">
  Get the status of a batch request.
</Accordion>

<Accordion title="Delete product variant">
  Delete a product variant.
</Accordion>

<Accordion title="List account orders">
  Get information about an account's orders.
</Accordion>

<Accordion title="List batch requests">
  Get a summary of batch requests that have been made.
</Accordion>

<Accordion title="List interest categories">
  Get information about a list's interest categories.
</Accordion>

<Accordion title="List order line items">
  Get information about an order's line items.
</Accordion>

<Accordion title="List batch webhooks">
  Get all webhooks that have been configured for batches.
</Accordion>

<Accordion title="List segments">
  Get information about all available segments for a specific list.
</Accordion>

<Accordion title="List campaign recipients">
  Get information about campaign recipients.
</Accordion>

<Accordion title="List campaign open details">
  Get detailed information about any campaign emails that were opened by a list member.
</Accordion>

<Accordion title="List clicked link subscribers">
  Get information about list members who clicked on a specific link in a campaign.
</Accordion>

<Accordion title="List messages">
  Legacy "conversations" endpoint is deprecated; use "inbox" for new messages. old conversations are accessible, but new campaign replies and inbox messages are not.
</Accordion>

<Accordion title="List connected sites">
  Get all connected sites in an account.
</Accordion>

<Accordion title="List orders">
  Get information about a store's orders.
</Accordion>

<Accordion title="List campaign feedback">
  Get team feedback while you're working together on a mailchimp campaign.
</Accordion>

<Accordion title="List merge fields">
  Get a list of all merge fields for an audience.
</Accordion>

<Accordion title="List campaign folders">
  Get all folders used to organize campaigns.
</Accordion>

<Accordion title="List interests in category">
  Get a list of this category's interests.
</Accordion>

<Accordion title="List campaign details">
  Get information about clicks on specific links in your mailchimp campaigns.
</Accordion>

<Accordion title="List campaigns">
  Get all campaigns in an account.
</Accordion>

<Accordion title="Pause automation emails">
  Pause all emails in a specific classic automation workflow.
</Accordion>

<Accordion title="List templates">
  Get a list of an account's available templates.
</Accordion>

<Accordion title="List campaign reports">
  Get campaign reports.
</Accordion>

<Accordion title="List sending domains">
  Get all of the sending domains on the account.
</Accordion>

<Accordion title="List signup forms">
  Get signup forms for a specific list.
</Accordion>

<Accordion title="List top email clients">
  Get a list of the top email clients based on user-agent strings.
</Accordion>

<Accordion title="Pause rss campaign">
  Pause an rss-driven campaign.
</Accordion>

<Accordion title="Remove subscriber from workflow">
  Remove a subscriber from any point in a classic automation workflow; once removed, they cannot be re-added to that workflow.
</Accordion>

<Accordion title="List product">
  Get information about a store's products.
</Accordion>

<Accordion title="List survey responses">
  Get responses to a survey.
</Accordion>

<Accordion title="List template folders">
  Get all folders used to organize templates.
</Accordion>

<Accordion title="Publish a survey">
  Publish a survey that is in draft, unpublished, or has been previously published and edited.
</Accordion>

<Accordion title="List conversations">
  List of conversations for an account is available via an endpoint, but it's deprecated in favor of inbox. the endpoint excludes new inbox data including campaign replies and messages. past conversations remain accessible.
</Accordion>

<Accordion title="List campaign product activity">
  Get breakdown of product activity for a campaign
</Accordion>

<Accordion title="Mailchimp Ping">
  A health check for the api that won't return any account-specific information.
</Accordion>

<Accordion title="Publish landing page">
  Publish a landing page that is in draft, unpublished, or has been previously published and edited.
</Accordion>

<Accordion title="List landing pages">
  Get all landing pages.
</Accordion>

<Accordion title="Remove list member from segment">
  Remove a member from the specified static segment.
</Accordion>

<Accordion title="List customers">
  Get information about a store's customers.
</Accordion>

<Accordion title="List product images">
  Get information about a product's images.
</Accordion>

<Accordion title="Resend campaign">
  Remove the guesswork for resending a campaign to certain segments. you can use this endpoint as a shortcut to replicate a campaign and resend it to common segments, such as those who didn't open the campaign, or any new subscribers since it was sent.
</Accordion>

<Accordion title="Replicate campaign">
  Replicate a campaign in saved or send status.
</Accordion>

<Accordion title="List stored files">
  Get a list of available images and files stored in the file manager for the account.
</Accordion>

<Accordion title="Schedule campaign">
  Schedule a campaign for delivery. if you're using multivariate campaigns to test send times or sending rss campaigns, use the send action instead.
</Accordion>

<Accordion title="Search campaigns">
  Search all campaigns for the specified query terms.
</Accordion>

<Accordion title="Send campaign">
  Send a mailchimp campaign. for rss campaigns, the campaign will send according to its schedule. all other campaigns will send immediately.
</Accordion>

<Accordion title="Send test email">
  Send a test email.
</Accordion>

<Accordion title="List carts">
  Get information about a store's carts.
</Accordion>

<Accordion title="List landing pages reports">
  Get reports of landing pages.
</Accordion>

<Accordion title="List product variants">
  Get information about a product's variants.
</Accordion>

<Accordion title="List domain performance stats">
  Get statistics for the top-performing email domains in a campaign.
</Accordion>

<Accordion title="Set campaign content">
  Set the content for a campaign.
</Accordion>

<Accordion title="List cart line items">
  Get information about a cart's line items.
</Accordion>

<Accordion title="List promo codes">
  Get information about a store's promo codes.
</Accordion>

<Accordion title="Unschedule campaign">
  Unschedule a scheduled campaign that hasn't started sending.
</Accordion>

<Accordion title="Start batch operation">
  Begin processing a batch operations request.
</Accordion>

<Accordion title="Start automation emails">
  Start all emails in a classic automation workflow.
</Accordion>

<Accordion title="Update campaign folder">
  Update a specific folder used to organize campaigns.
</Accordion>

<Accordion title="List child campaign reports">
  Get a list of reports with child campaigns for a specific parent campaign.
</Accordion>

<Accordion title="Unpublish a survey">
  Unpublish a survey that has been published.
</Accordion>

<Accordion title="List promo rules">
  Get information about a store's promo rules.
</Accordion>

<Accordion title="Update campaign feedback message">
  Update a specific feedback message for a campaign.
</Accordion>

<Accordion title="Update batch webhook">
  Update a webhook that will fire whenever any batch request completes processing.
</Accordion>

<Accordion title="Search for tags on a list by name">
  Search for tags on a list by name. if no name is provided, will return all tags on the list.
</Accordion>

<Accordion title="Start automated email">
  Start an automated email.
</Accordion>

<Accordion title="Search members">
  Search for list members. this search can be restricted to a specific list, or can be used to search across all lists in an account.
</Accordion>

<Accordion title="List unsubscribed members">
  Get information about members who have unsubscribed from a specific campaign.
</Accordion>

<Accordion title="Unpublish landing page">
  Unpublish a landing page that is in draft or has been published.
</Accordion>

<Accordion title="List stores">
  Get information about all stores in the account.
</Accordion>

<Accordion title="Resume rss campaign">
  Resume an rss-driven campaign.
</Accordion>

<Accordion title="List top open activities">
  Get top open locations for a specific campaign.
</Accordion>

<Accordion title="Update cart line item">
  Update a specific cart line item.
</Accordion>

<Accordion title="Update interest category">
  Update a specific interest category.
</Accordion>

<Accordion title="Update folder">
  Update a specific file manager folder.
</Accordion>

<Accordion title="List webhooks">
  Get information about all webhooks for a specific list.
</Accordion>

<Accordion title="List eepurl activity">
  Get a summary of social activity for the campaign, tracked by eepurl.
</Accordion>

<Accordion title="List recent activity">
  Get up to the previous 180 days of daily detailed aggregated activity stats for a list, not including automation activity.
</Accordion>

<Accordion title="Update file">
  Update a file in the file manager.
</Accordion>

<Accordion title="List recent member notes">
  Get recent notes for a specific list member.
</Accordion>

<Accordion title="Retrieve campaign abuse complaints">
  Get a list of abuse complaints for a specific campaign.
</Accordion>

<Accordion title="Update customer">
  Update a customer.
</Accordion>

<Accordion title="Update interest in category">
  Update interests or 'group names' for a specific category.
</Accordion>

<Accordion title="List subscribers removed from workflow">
  Get information about subscribers who were removed from a classic automation workflow.
</Accordion>

<Accordion title="List member events">
  Get events for a contact.
</Accordion>

<Accordion title="Update lists">
  Update the settings for a specific list.
</Accordion>

<Accordion title="List survey question reports">
  Get reports for survey questions.
</Accordion>

<Accordion title="Pause automated email">
  Pause an automated email.
</Accordion>

<Accordion title="Update landing page">
  Update a landing page.
</Accordion>

<Accordion title="List members in segment">
  Get information about members in a saved segment.
</Accordion>

<Accordion title="Retrieve folder contents">
  Get a list of available images and files stored in this folder.
</Accordion>

<Accordion title="List members info">
  Get information about members in a specific mailchimp list.
</Accordion>

<Accordion title="List facebook ecommerce report">
  Get breakdown of product activity for an outreach.
</Accordion>

<Accordion title="List member tags">
  Get the tags on a list member.
</Accordion>

<Accordion title="List member goal events">
  Get the last 50 goal events for a member on a specific list.
</Accordion>

<Accordion title="List facebook ads">
  Get list of facebook ads.
</Accordion>

<Accordion title="List locations">
  Get the locations (countries) that the list's subscribers have been tagged to based on geocoding their ip address.
</Accordion>

<Accordion title="List growth history data">
  Get a month-by-month summary of a specific list's growth activity.
</Accordion>

<Accordion title="List survey reports">
  Get reports for surveys.
</Accordion>

<Accordion title="List email activity">
  Get a list of member's subscriber activity in a specific campaign.
</Accordion>

<Accordion title="Update cart">
  Update a specific cart.
</Accordion>

<Accordion title="List folders">
  Get a list of all folders in the file manager.
</Accordion>

<Accordion title="List facebook ads reports">
  Get reports of facebook ads.
</Accordion>

<Accordion title="Update campaign settings">
  Update some or all of the settings for a specific campaign.
</Accordion>

<Accordion title="Update store">
  Update a store.
</Accordion>

<Accordion title="Update note">
  Update a specific note for a specific list member.
</Accordion>

<Accordion title="Update workflow email">
  Update settings for a classic automation workflow email. only works with workflows of type: abandonedbrowse, abandonedcart, emailfollowup, or singlewelcome.
</Accordion>

<Accordion title="Update merge field">
  Update a specific merge field.
</Accordion>

<Accordion title="Update product variant">
  Update a product variant.
</Accordion>

<Accordion title="Verify connected site script">
  Verify that the connected sites script has been installed, either via the script url or fragment.
</Accordion>

<Accordion title="View default content">
  Get the sections that you can edit in a template, including each section's default content.
</Accordion>

<Accordion title="Update list member">
  Update information for a specific list member.
</Accordion>

<Accordion title="Update product">
  Update a specific product.
</Accordion>

<Accordion title="Update template">
  Update the name, html, or `folder id` of an existing template.
</Accordion>

<Accordion title="Update order">
  Update a specific order.
</Accordion>

<Accordion title="Update webhook">
  Update the settings for an existing webhook.
</Accordion>

<Accordion title="Update promo code">
  Update a promo code.
</Accordion>

<Accordion title="View recent activity 50">
  Get the last 50 events of a member's activity on a specific list, including opens, clicks, and unsubscribes.
</Accordion>

<Accordion title="Update product image">
  Update a product image.
</Accordion>

<Accordion title="Update promo rule">
  Update a promo rule.
</Accordion>

<Accordion title="Verify domain">
  Verify a domain for sending.
</Accordion>

<Accordion title="Update template folder">
  Update a specific folder used to organize templates.
</Accordion>

<Accordion title="Update order line item">
  Update a specific order line item.
</Accordion>

<Accordion title="View recent activity">
  Get a member's activity on a specific list, including opens, clicks, and unsubscribes.
</Accordion>


# Mem0
Source: https://docs.push.ai/integrations/mem0



Mem0 assists with AI-driven note-taking, knowledge recall, and productivity tools, allowing users to organize, search, and generate content from stored information

<Accordion title="Add organization member">
  Add a new member to a specific organization.
</Accordion>

<Accordion title="Add member to project">
  Add a new member to a specific project within an organization.
</Accordion>

<Accordion title="Create an export job with schema">
  Create a structured export of memories based on a provided schema.
</Accordion>

<Accordion title="Create agent with metadata">
  Create a new agent.
</Accordion>

<Accordion title="Create new organization">
  Create a new organization.
</Accordion>

<Accordion title="Create new app with metadata">
  Create a new app.
</Accordion>

<Accordion title="Create run">
  Create a new agent run.
</Accordion>

<Accordion title="Create memory entry">
  Get all memories
</Accordion>

<Accordion title="Create user with metadata">
  Create a new user.
</Accordion>

<Accordion title="Create project">
  Create a new project within an organization.
</Accordion>

<Accordion title="Delete an organization">
  Delete an organization by its id.
</Accordion>

<Accordion title="Delete memory by id">
  Get or update or delete a memory.
</Accordion>

<Accordion title="Create memory with messages and metadata">
  Add memories
</Accordion>

<Accordion title="Delete entity by type and id">
  Deletes a specific entity from the mem0 system based on the provided entity type and id. this endpoint should be used when you need to permanently remove an entity, such as a user, agent, app, or run, from the system. the operation is irreversible, so it should be used with caution. this endpoint performs a hard delete, completely removing the entity and its associated data from mem0. it's important to note that this operation may have cascading effects on related data or dependencies within the system.
</Accordion>

<Accordion title="Delete memory batch with uuids">
  Batch delete multiple memories (up to 1000) in a single api call.
</Accordion>

<Accordion title="Delete project member">
  Removes a member from a specific project within an organization in the mem0 b2b saas integration platform. this endpoint is used to revoke a user's access to a particular project, which may be necessary when team members change roles, leave the organization, or no longer require access to the project. it's important to note that this action only affects the user's membership in the specified project and does not remove them from the organization entirely. use this endpoint carefully, as it immediately terminates the user's ability to interact with the project through the mem0 platform.
</Accordion>

<Accordion title="Delete memories endpoint">
  Delete memories
</Accordion>

<Accordion title="Get organization members">
  Retrieve a list of members for a specific organization.
</Accordion>

<Accordion title="Get project details">
  Retrieve details of a specific project within an organization.
</Accordion>

<Accordion title="Get entity by id">
  Retrieves detailed information about a specific entity within the mem0 platform. this endpoint is used to fetch comprehensive data related to a particular entity, identified by its type and unique id. it's particularly useful when you need to access or verify the current state, attributes, or configuration of an entity in your integration or workflow setup. the endpoint should be used when detailed information about a single entity is required, rather than for bulk data retrieval or updates. note that the specific details returned may vary depending on the entity type, and some information might be subject to user permissions or data privacy settings within mem0.
</Accordion>

<Accordion title="Retrieve organization information by id">
  Get a organization.
</Accordion>

<Accordion title="Export data based on filters">
  Get the latest memory export.
</Accordion>

<Accordion title="Get projects">
  Retrieve a list of projects for a specific organization.
</Accordion>

<Accordion title="List organizations">
  Retrieves a list of organizations registered on the mem0 platform. this endpoint is essential for administrators or authorized users to get an overview of all organizations in the system. it can be used for various purposes such as user management, access control, or generating reports. the endpoint does not provide detailed information about each organization; it likely returns a basic list of organization names or ids. note that the response may be paginated for efficiency if there are many organizations.
</Accordion>

<Accordion title="Retrieve memory by entity">
  Retrieves all memories associated with a specific entity in the mem0 platform. this endpoint is used to access stored information, such as user preferences, chat history, or any other type of data that has been saved as a "memory" for the given entity. it's particularly useful for retrieving context or historical data related to a user or a specific interaction. the endpoint should be used when you need to recall or analyze previously stored information for a particular entity. it does not create, update, or delete memories; it only retrieves existing ones. the response will likely include all memories associated with the specified entity, but the exact structure and content of the memories are not detailed in this schema.
</Accordion>

<Accordion title="Retrieve memory by id">
  Get a memory.
</Accordion>

<Accordion title="Delete project">
  Delete a specific project and its related data.
</Accordion>

<Accordion title="Get entities filters">
  Retrieves the list of available filters for entities in the mem0 system. this endpoint allows developers to fetch predefined filters that can be used to query and manage entities within the b2b saas integration platform. it's particularly useful when you need to understand what filtering options are available for narrowing down entity searches or for implementing advanced data synchronization logic. the endpoint returns a comprehensive list of filters, which may include options for filtering by entity type, creation date, modification date, or other relevant attributes specific to mem0's entity structure. use this endpoint when you need to build dynamic filtering interfaces or when you want to explore the available filtering capabilities of the mem0 platform. note that this endpoint only provides the filter definitions and does not apply any filters to the actual entity data.
</Accordion>

<Accordion title="Search memories by query">
  Perform a semantic search on memories.
</Accordion>

<Accordion title="Get project members">
  Retrieve a list of members for a specific project.
</Accordion>

<Accordion title="Search memories with filters">
  Search memories based on a query and filters.
</Accordion>

<Accordion title="Retrieve events data">
  Retrieves a list of events from the mem0 platform's structured memory layer. this endpoint allows developers to access the interaction history and contextual information stored for ai assistants and agents. it can be used to fetch recent events, analyze user preferences, or gather data for personalization purposes. the endpoint returns events in chronological order, which may include user interactions, system actions, or any other recorded occurrences within the mem0 ecosystem. it's particularly useful for applications that need to maintain context across multiple interactions or sessions. note that while this endpoint provides access to event data, it may not include sensitive user information and could be subject to privacy constraints.
</Accordion>

<Accordion title="Update memory batch with uuid">
  Batch update multiple memories (up to 1000) in a single api call.
</Accordion>

<Accordion title="Update project member role">
  Update the role of a member in a specific project within an organization.
</Accordion>

<Accordion title="Update memory text content">
  Get or update or delete a memory.
</Accordion>

<Accordion title="Retrieve memory history by id">
  Retrieve the history of a memory.
</Accordion>

<Accordion title="Remove a member from the organization">
  This endpoint removes a specified member from an organization within the mem0 b2b saas integration platform. it should be used when an organization administrator needs to revoke a user's access to the organization, such as when an employee leaves the company or changes roles. the endpoint requires the organization id (specified in the path) and the username of the member to be removed. it's important to note that this action is irreversible and will immediately terminate the user's access to all organization resources. the endpoint does not provide any information about the success or failure of the operation in the schema, so proper error handling should be implemented in the client application.
</Accordion>

<Accordion title="Retrieve all events for the currently logged in user">
  This endpoint returns a paginated list of events associated with the authenticated user. you can filter the events by event type, start date, and end date. query parameters: - event type: filter by event type (add or search) - start date: filter events after this date (format: yyyy-mm-dd) - end date: filter events before this date (format: yyyy-mm-dd) - page: page number for pagination - page size: number of items per page (default: 50, max: 100)
</Accordion>

<Accordion title="Update organization member role">
  Update the role of an existing member in a specific organization.
</Accordion>

<Accordion title="Retrieve memory related statistics for the authenticated user">
  This endpoint returns the following statistics: - total number of memories created - total number of search events - total number of add events
</Accordion>

<Accordion title="Update project">
  Update a specific project's settings.
</Accordion>

<Accordion title="Retrieve memory list">
  Get all memories
</Accordion>

<Accordion title="Get entities list">
  Retrieves a list of entities from the mem0 b2b saas integration platform. this endpoint allows developers to fetch all available entities, which can represent various data objects or resources within the system. it should be used when a comprehensive view of all entities is required, such as for data synchronization, inventory checks, or generating reports. the endpoint returns a collection of entity objects, likely including their identifiers and key attributes. however, it may not provide detailed information for each entity, and there might be limitations on the number of entities returned in a single request. for more specific entity data or filtered results, additional api calls or parameters may be necessary.
</Accordion>


# Metaads
Source: https://docs.push.ai/integrations/metaads



Meta Ads Marketing API Integration

This tool provides access to Meta's Marketing API for managing ad campaigns,
ad sets, ads, and custom audiences, as well as retrieving insights and analytics.

<Accordion title="Delete Ad Creative">
  Delete ad creative
</Accordion>

<Accordion title="Resume Campaign">
  Resume a paused advertising campaign using the meta marketing api. this sets the campaign status to active so it can deliver ads again. note that child ad sets and ads that were previously active will also resume delivery, but those that were individually paused will remain paused.
</Accordion>

<Accordion title="Preview Ad Creative">
  Preview ad creative
</Accordion>

<Accordion title="Delete Campaign">
  Delete an advertising campaign using the meta marketing api. this marks the campaign as deleted, which prevents it from delivering ads. note that deleted campaigns are not permanently removed from meta's systems and can still be viewed in reports.
</Accordion>

<Accordion title="Create Ad">
  Create a new ad within an ad set using the meta marketing api. supports various ad formats including image, video, carousel, and collection ads.
</Accordion>

<Accordion title="Read Ad Sets">
  Retrieve ad sets from a meta ad account using the marketing api. returns information about the ad sets including their status, targeting, and other properties.
</Accordion>

<Accordion title="Upload Ad Image">
  Upload an image for use in meta ad creatives using the marketing api. the image can later be referenced by its hash when creating ad creatives.
</Accordion>

<Accordion title="Update Ad Creative">
  Update ad creative
</Accordion>

<Accordion title="Get Ad Creative">
  Get ad creative
</Accordion>

<Accordion title="Create Ad Creative">
  Create a new ad creative using the meta marketing api. ad creatives are reusable visual and interactive elements that define how your ad looks and behaves: - can be used in multiple ads - support various formats (image, video, carousel) - include text, media, and call-to-action buttons - must follow meta's ad policies
</Accordion>

<Accordion title="Update Campaign">
  Update an existing advertising campaign using the meta marketing api. allows modification of campaign properties like name, status, budget, and bidding strategy. only the fields that need to be updated should be included in the request.
</Accordion>

<Accordion title="Get Insights">
  Get insights data for a meta ads object (ad account, campaign, ad set, or ad) using the meta marketing api. supports various metrics, breakdowns, and filtering options with flexible date ranges.
</Accordion>

<Accordion title="Pause Campaign">
  Pause an advertising campaign using the meta marketing api. this stops the campaign from delivering ads but allows it to be resumed later. all child ad sets and ads will also be paused with an effective status of campaign paused.
</Accordion>

<Accordion title="Create Campaign">
  Create a new advertising campaign using the meta marketing api. supports various campaign objectives, budgets, and bidding strategies.
</Accordion>

<Accordion title="Create Ad Set">
  Create a new ad set within a campaign using the meta marketing api. supports detailed targeting options, budgets, and optimization goals.
</Accordion>

<Accordion title="Create Custom Audience">
  Create a new custom audience using the meta marketing api. supports various types of custom audiences including customer lists, website visitors, and app users.
</Accordion>


# Microsoft clarity
Source: https://docs.push.ai/integrations/microsoft_clarity



Microsoft Clarity is a free, easy-to-use tool that captures how real
people actually use your site.

<Accordion title="Data Export">
  Export data from microsoft clarity.
</Accordion>


# Microsoft teams
Source: https://docs.push.ai/integrations/microsoft_teams



Connect to Microsoft Teams to manage channels.

<Accordion title="Create Channel">
  Creates a new channel in a microsoft teams team using the microsoft graph api.
</Accordion>

<Accordion title="Get All Chats">
  Retrieve a list of all chats that a user is part of in microsoft teams using the microsoft graph api.
</Accordion>

<Accordion title="Get All Chat Messages">
  Retrieve all messages from a specific microsoft teams chat using the microsoft graph api.
</Accordion>

<Accordion title="List Team Channels">
  Retrieves a list of channels within a microsoft teams team using the microsoft graph api.
</Accordion>

<Accordion title="Create Chat">
  Creates a new microsoft teams chat (one-on-one or group) via ms graph. if a 'oneonone' chat already exists for the same 2 members, the existing chat is returned.
</Accordion>

<Accordion title="List Chat Messages">
  Retrieves a list of messages from a microsoft teams chat using the microsoft graph api.
</Accordion>

<Accordion title="Reply to Teams Channel Message">
  Posts a reply to a message in a microsoft teams channel using the microsoft graph api.
</Accordion>

<Accordion title="Post Message to Teams Channel">
  Posts a message to a channel in microsoft teams using the microsoft graph api.
</Accordion>

<Accordion title="Get Teams Message">
  Retrieve a specific message from a microsoft teams channel using the microsoft graph api.
</Accordion>

<Accordion title="Send Message to Teams Chat">
  Posts a message to a chat in microsoft teams using the microsoft graph api.
</Accordion>

<Accordion title="List People">
  Retrieve a collection of person objects from microsoft graph people api. returns the raw json response in 'response data'.
</Accordion>

<Accordion title="Create Online Meeting">
  Creates a new online meeting in microsoft teams using the microsoft graph api. this creates a standalone meeting that isn't associated with any event on the user's calendar.
</Accordion>

<Accordion title="List Teams">
  Retrieves a list of all microsoft teams within the organization using the microsoft graph api.
</Accordion>


# Mixpanel
Source: https://docs.push.ai/integrations/mixpanel



Mixpanel is an analytics platform that helps companies measure user
engagement and retention.

<Accordion title="List Saved Cohorts">
  Get list of all cohorts in a mixpanel project. returns cohort details including name, id, count, description, creation date, and visibility. the query api has a rate limit of 60 queries per hour and a maximum of 5 concurrent queries.
</Accordion>

<Accordion title="List Saved Funnels">
  Get the names and funnel ids of your funnels. the query api has a rate limit of 60 queries per hour and a maximum of 5 concurrent queries.
</Accordion>

<Accordion title="Get Aggregate Event Counts">
  Get aggregate event counts over time. supports different types of aggregation: general, unique, average, sum.
</Accordion>

<Accordion title="Execute JQL Query">
  Execute a custom jql (javascript query language) query against mixpanel's query api. key constraints: - 60 queries/hour, max 5 concurrent queries. - 2-minute execution timeout. - 5 gb data processing limit, 2 gb output limit. - no remote network requests (xmlhttprequest) are allowed inside the jql script.
</Accordion>

<Accordion title="Get Aggregated Event Property Values">
  Get unique, total, or average data for a single event and property over days, weeks, or months. the query api has a rate limit of 60 queries per hour and a maximum of 5 concurrent queries.
</Accordion>

<Accordion title="Get Profile Event Activity">
  Get event activity feed for specified users from mixpanel query api. the query api has a rate limit of 60 queries per hour and a maximum of 5 concurrent queries.
</Accordion>

<Accordion title="Query Frequency Report">
  Get data about how frequently users are performing events. the query api has a rate limit of 60 queries per hour and a maximum of 5 concurrent queries. example response with unit="day" and addiction unit="hour": \{ "2012-01-01": \[305, 107, 60, 41, ...], # users who did event in 1+ hours, 2+ hours, etc. "2012-01-02": \[495, 204, 117, 77, ...], "2012-01-03": \[671, 324, 176, 122, ...] }
</Accordion>

<Accordion title="Get Top Event Properties">
  Get the top property names for an event. the query api has a rate limit of 60 queries per hour and a maximum of 5 concurrent queries.
</Accordion>

<Accordion title="Query Numeric Segmentation Report">
  Get data for an event, segmented and filtered by properties, with values placed into numeric buckets. the query api has a rate limit of 60 queries per hour and a maximum of 5 concurrent queries.
</Accordion>

<Accordion title="Query Saved Insight">
  Get data from your insights reports. the query api has a rate limit of 60 queries per hour and a maximum of 5 concurrent queries.
</Accordion>

<Accordion title="Get Top Events">
  Get a list of the most common events over the last 31 days. the query api has a rate limit of 60 queries per hour and a maximum of 5 concurrent queries.
</Accordion>

<Accordion title="Query Saved Funnel">
  Get data for a funnel. the query api has a rate limit of 60 queries per hour and a maximum of 5 concurrent queries.
</Accordion>

<Accordion title="Query Profiles">
  Query user or group profile data from mixpanel. returns list of profiles that match specified parameters. the query api has a rate limit of 60 queries per hour and a maximum of 5 concurrent queries.
</Accordion>

<Accordion title="Query Segmentation Report">
  Get data for an event, segmented and filtered by properties. the query api has a rate limit of 60 queries per hour and a maximum of 5 concurrent queries.
</Accordion>

<Accordion title="Query Numeric Sum Report">
  Sums an expression for events per unit time. the query api has a rate limit of 60 queries per hour and a maximum of 5 concurrent queries. example response: \{ "status": "ok", "computed at": "2024-01-20t12:00:00", "results": \{ "2024-01-01": 150.5, "2024-01-02": 245.75, "2024-01-03": 198.25 } }
</Accordion>

<Accordion title="Query Numeric Average Report">
  Averages an expression for events per unit time. the query api has a rate limit of 60 queries per hour and a maximum of 5 concurrent queries. example response: \{ "status": "ok", "results": \{ "2024-01-01": 25.5, "2024-01-02": 32.75, "2024-01-03": 28.25 } }
</Accordion>

<Accordion title="Get Today's Top Events">
  Get the top events for today, with their counts and the normalized percent change from yesterday. the query api has a rate limit of 60 queries per hour and a maximum of 5 concurrent queries.
</Accordion>

<Accordion title="Get Top Event Property Values">
  Get the top values for a property. the query api has a rate limit of 60 queries per hour and a maximum of 5 concurrent queries.
</Accordion>

<Accordion title="Query Retention Report">
  Get cohort analysis data. the query api has a rate limit of 60 queries per hour and a maximum of 5 concurrent queries.
</Accordion>


# Monday
Source: https://docs.push.ai/integrations/monday



Monday is a cloud-based work operating system where teams create
workflow apps in minutes to run their processes, projects, and
everyday work.

<Accordion title="Delete item">
  Action to delete an item in monday.com. returns raw json.
</Accordion>

<Accordion title="Delete group">
  Action to delete a group from a monday.com board. returns raw json response unmodified.
</Accordion>

<Accordion title="Update board">
  Action to update a board's attribute on monday.com via graphql. returns the entire raw json response as-is.
</Accordion>

<Accordion title="Add users to board">
  Action to add users to a board in monday.com.
</Accordion>

<Accordion title="Duplicate item">
  Action to duplicate an item in monday.com using graphql. returns the raw json response.
</Accordion>

<Accordion title="Archive board">
  Action to archive a board in monday.com using graphql. returns the entire json response unmodified.
</Accordion>

<Accordion title="Get group details">
  Action to retrieve details about a specific group in a monday.com board. returns the entire json response unmodified.
</Accordion>

<Accordion title="Archive item">
  Action to archive an item on monday.com. returns raw json.
</Accordion>

<Accordion title="List boards">
  Action to list boards from monday.com using graphql.
</Accordion>

<Accordion title="Change simple column value">
  Action to change a single column value using a simple string in monday.com.
</Accordion>

<Accordion title="List board items">
  Action to retrieve all items from a specific monday.com board. returns the full json payload, unmodified.
</Accordion>

<Accordion title="Create column">
  Action to create a new column on a monday.com board. returns the raw json response.
</Accordion>

<Accordion title="List columns">
  Action to retrieve columns from a specific board in monday.com. returns the raw json response.
</Accordion>

<Accordion title="Create board">
  Action to create a board in monday.com via graphql.
</Accordion>

<Accordion title="List items">
  Action to query items by ids in monday.com via graphql. returns the raw json response.
</Accordion>

<Accordion title="Create group">
  Action to create a new group on a monday.com board. returns the entire json response unmodified.
</Accordion>

<Accordion title="List users">
  Action to retrieve users from monday.com via the 'users' query. returns the raw json response (including data and errors).
</Accordion>

<Accordion title="Move item to board">
  Action to move an item to another board in monday.com. returns the raw json response.
</Accordion>

<Accordion title="Create item">
  Action to create a new item on a monday.com board via graphql. returns the entire raw json response.
</Accordion>

<Accordion title="Delete column">
  Action to delete a column in monday.com. returns the raw json response.
</Accordion>

<Accordion title="Move item to group">
  Action to move an item to another group in the same board. returns the raw json response.
</Accordion>


# More trees
Source: https://docs.push.ai/integrations/more_trees



More Trees is a sustainability-focused platform planting trees on behalf of individuals or businesses aiming to offset carbon footprints and support reforestation

<Accordion title="Get Total Carbon Offset">
  This tool retrieves the total carbon offset and other forest-related information for the authenticated user. it provides comprehensive data about the user's forest, including the total co₂ captured, number of trees planted, gifted, and received. authentication is provided via an api key in the headers (x-api-key) and no additional parameters are needed as it fetches data for the authenticated user.
</Accordion>


# Neon
Source: https://docs.push.ai/integrations/neon



Postgres, on a serverless platform designed to help you build reliable and scalable applications faster

<Accordion title="Get consumption history projects">
  Retrieves the consumption history for specified projects within the neon platform. this endpoint allows users to fetch detailed metrics about resource usage over time, enabling effective monitoring and analysis of project-level consumption. it's particularly useful for tracking costs, identifying usage patterns, and optimizing resource allocation across different projects. the endpoint supports querying data for specific time periods and can provide aggregated data at various granularities (e.g., hourly, daily, monthly). while it offers comprehensive consumption data, it does not provide real-time usage information or predictive analytics.
</Accordion>

<Accordion title="Create project with quota and settings">
  Creates a new neon project with specified configuration settings. this endpoint allows you to set up a customized postgresql environment with various options for resource management, networking, and performance optimization. it's ideal for initializing a new database project with tailored settings for quota management, ip access control, autoscaling, and more. use this when you need to establish a new neon project with specific requirements or when you want to take advantage of neon's advanced features like logical replication or custom maintenance windows. note that some settings, once configured, may not be easily changed later, so careful consideration of your project needs is recommended before creation.
</Accordion>

<Accordion title="Create new project branch">
  Creates a new branch in a neon project with optional compute endpoints. this endpoint allows you to specify the parent branch, branch name, and various configuration options for both the branch and its compute endpoints. it can be used to create development environments, test new features, or set up isolated database instances. the endpoint supports advanced features like autoscaling, custom provisioners, and suspend timeout configuration for optimizing resource usage and performance.
</Accordion>

<Accordion title="Delete project branch role">
  Deletes a specific role from a branch within a project in the neon b2b saas integration platform. this endpoint is used to remove access permissions associated with a particular role in a specific project branch. it's particularly useful when restructuring access control or removing obsolete roles from a project's branch. the operation is permanent and cannot be undone, so it should be used with caution. this endpoint does not return any data upon successful deletion, typically responding with a 204 no content status.
</Accordion>

<Accordion title="Get current user information">
  Retrieves the profile information for the currently authenticated user. this endpoint should be used when you need to access details about the user making the api request, such as their username, email, or other account-related information. it's particularly useful for personalizing user experiences or retrieving user-specific settings within the neon platform. the endpoint doesn't accept any parameters, as it relies solely on the authentication token to identify the user. note that this endpoint will only return information for the authenticated user and cannot be used to retrieve profiles of other users.
</Accordion>

<Accordion title="Get user organizations">
  Retrieves a list of organizations associated with the currently authenticated user in the neon platform. this endpoint allows users to view all the organizations they are a member of, providing essential information for managing multi-organization access and permissions. it should be used when a user needs to identify their organizational affiliations or when an application needs to determine a user's organization memberships for access control or data segregation purposes. the endpoint does not modify any data and is safe for frequent calls. note that it only returns organizations the user is actively a member of and won't include pending invitations or previously left organizations.
</Accordion>

<Accordion title="Get organization api keys">
  Retrieves a list of all api keys associated with a specific organization in the neon b2b saas integration platform. this endpoint is crucial for administrators to manage and monitor api access within their organization. it provides a comprehensive view of all active api keys, enabling effective access control and security auditing. use this endpoint when you need to review, track, or manage the api keys in use by your organization, such as during security reviews or when updating access permissions.
</Accordion>

<Accordion title="Get schema for project branch">
  Retrieves the schema definition for a specific branch within a project in the neon b2b saas integration platform. this endpoint is crucial for developers and integrators who need to understand the data structure of a particular branch, enabling proper data mapping and ensuring consistency across integrations. it should be used when setting up new integrations, updating existing ones, or troubleshooting data-related issues within a project branch. the endpoint provides a detailed view of the data fields, types, and relationships, but does not modify the schema itself.
</Accordion>

<Accordion title="Get vpc region endpoints">
  Retrieves a list of vpc endpoints for a specified organization within a particular aws region. this endpoint allows developers to obtain information about the virtual network interfaces that enable private communication between a vpc and supported aws services. it should be used when you need to audit, manage, or gather information about the existing vpc endpoints in a specific organizational context and geographic location. the endpoint provides a comprehensive view of how the organization's vpc is connected to various aws services, which is crucial for network architecture planning and security audits. note that this endpoint only lists the vpc endpoints; it does not provide detailed configuration information or allow for modifications to the endpoints.
</Accordion>

<Accordion title="Add new jwks to project endpoint">
  Adds a new json web key set (jwks) to a specific endpoint of a project in the neon b2b saas integration platform. this endpoint is crucial for setting up secure authentication and authorization mechanisms, allowing seamless integration with various identity providers. use this when configuring a new authentication source or updating existing jwks information for your project. the endpoint supports multiple authentication providers and allows for branch-specific configurations and role mappings. note that a maximum of 10 role names can be associated with each jwks.
</Accordion>

<Accordion title="Access project details by id">
  Retrieves detailed information about a specific project within the neon b2b saas integration platform. this endpoint is used to fetch comprehensive data about a project, including its configuration, associated workflows, and current status. it's particularly useful when you need to review or analyze the settings and progress of an integration project. the endpoint should be used when detailed project information is required, such as during troubleshooting, reporting, or when preparing to make updates to a project. it does not modify any project data and is safe for frequent calls. however, it may not provide real-time updates for ongoing integration processes; for that, a separate status or logs endpoint might be more appropriate.
</Accordion>

<Accordion title="Get project branches">
  Retrieves detailed information about a specific branch within a neon project. this endpoint allows developers to fetch the current state and configuration of a branch, including its name, creation timestamp, and other relevant metadata. it's particularly useful when you need to verify branch details, check its status, or gather information for further operations on the branch. the endpoint should be used when you require up-to-date information about a single branch in your project's context. note that this endpoint only provides read access and does not modify any branch data.
</Accordion>

<Accordion title="Patch branch database information">
  Updates the properties of a specific database within a project branch in the neon platform. this endpoint allows for partial modifications of database attributes, such as changing its name or owner. it should be used when you need to rename a database or transfer ownership to a different role within the same project and branch. the update is performed using the patch method, allowing for selective property changes without affecting unspecified attributes. note that this operation modifies existing database metadata and does not create new databases or alter the actual data within the database.
</Accordion>

<Accordion title="List api keys">
  Retrieves a list of api keys associated with the authenticated user's neon account. this endpoint allows developers to view and manage their existing api keys, which are crucial for authentication when making requests to the neon api. it provides an overview of all active api keys, including their identifiers and potentially other metadata such as creation date or last used date. this tool should be used when you need to audit your api keys, check for any unauthorized keys, or before creating a new key to ensure you're not exceeding any limits. it does not provide the actual secret key values for security reasons, nor does it allow for the creation or deletion of keys.
</Accordion>

<Accordion title="Modify branch details in project">
  Updates the details of a specific branch within a project in the neon platform. this endpoint allows you to modify the name and protection status of an existing branch. it is particularly useful when you need to rename a branch or change its protection settings without creating a new branch. the endpoint uses partial updates, so you can specify only the fields you want to change. this tool should be used when managing branch configurations in a neon project, but it cannot be used to create new branches or delete existing ones.
</Accordion>

<Accordion title="List shared projects">
  Retrieves a list of shared projects accessible to the authenticated user within the neon b2b saas integration platform. this endpoint is used to fetch information about projects that have been shared across different parts of the organization or with external collaborators. it provides an overview of all shared resources, enabling users to manage and access data integration workflows efficiently. the endpoint should be used when a user needs to view or manage their shared project portfolio, facilitating better collaboration and resource utilization across the platform. note that this endpoint likely returns only basic project information; detailed project data may require additional api calls.
</Accordion>

<Accordion title="Delete project by id">
  Deletes a specific project from the neon b2b saas integration platform. this endpoint permanently removes all data, configurations, and resources associated with the specified project. it should be used with caution, as the deletion process is irreversible. this operation is typically performed when a project is no longer needed or to clean up unused resources. the endpoint requires the project's unique identifier and likely needs proper authentication to ensure only authorized users can delete projects. after successful deletion, the project and its data will no longer be accessible through any other api endpoints.
</Accordion>

<Accordion title="Reset role password for branch">
  Resets the password for a specific role within a project branch in the neon b2b saas integration platform. this endpoint is used to manage user access and security by allowing administrators to force a password reset for a particular role. it should be used when there's a need to update or secure access for a specific role, such as when an employee leaves the organization or as part of regular security practices. the operation is performed on a specific project and branch, ensuring that the correct environment is targeted. note that this action will invalidate the current password, and a new password will need to be set or communicated to the role user.
</Accordion>

<Accordion title="Restart project endpoint">
  Restarts a specific endpoint within a project in the neon b2b saas integration platform. this endpoint is used to reinitialize or reset the state of an integration endpoint, which can be helpful for applying configuration changes, clearing cached data, or resolving issues with the endpoint's operation. the restart operation is triggered by sending a post request to the specified url with the required project and endpoint identifiers. this tool should be used when an endpoint needs to be refreshed or when troubleshooting integration problems. it's important to note that restarting an endpoint may cause a brief interruption in its availability, so it should be used judiciously and preferably during maintenance windows or low-traffic periods.
</Accordion>

<Accordion title="Create vpc endpoint label">
  Updates the label of a specific vpc endpoint within a project in the neon b2b saas integration platform. this endpoint allows users to modify the identifier of an existing vpc endpoint, enhancing organization and management of network resources. it should be used when there's a need to rename or re-categorize a vpc endpoint for better clarity or changed purposes. the operation is idempotent, meaning repeated calls with the same label will not create additional changes. note that this endpoint only updates the label and does not modify any other properties or configurations of the vpc endpoint.
</Accordion>

<Accordion title="Delete project endpoint">
  Deletes a specific endpoint within a neon project. this operation permanently removes the endpoint and all associated resources, such as configurations and access points. use this endpoint when you need to decommission or clean up unused endpoints in your project. it's important to note that this action is irreversible, so ensure you have backed up any necessary data or configurations before proceeding. this endpoint should be used with caution, as it will immediately terminate access to the specified endpoint and may impact any systems or applications relying on it.
</Accordion>

<Accordion title="Fetch database for branch">
  Retrieves a list of databases associated with a specific project and branch in the neon platform. this endpoint allows developers to view all databases within a particular project and branch context, which is useful for managing different environments (e.g., development, staging, production) or versions of an application's database setup. it should be used when you need to inventory the databases in a specific branch or verify the existence of databases in a particular project environment. the endpoint does not provide detailed information about each database's schema or contents; it's primarily for listing purposes.
</Accordion>

<Accordion title="Retrieve all regions">
  Retrieves a list of available geographic regions supported by the neon b2b saas integration platform. this endpoint provides crucial information about the different areas where the api is accessible and optimized for service delivery. it should be used when developers need to understand the platform's global coverage, select appropriate endpoints for data localization, or implement region-specific configurations. the endpoint returns details about each region, which may include region identifiers, names, and potentially associated endpoints or data centers. this information is essential for ensuring compliance with data residency regulations and optimizing performance by choosing the most suitable region for specific integration needs.
</Accordion>

<Accordion title="Restore project branch">
  This endpoint restores a branch to a specific state or point in time. use it to recover data, revert changes, or create new branch states based on historical data. the restoration uses either a log sequence number (lsn) or timestamp from the source branch. important: for self-restoration or branches with children, use preserve under name to save the current state. note: restoration time varies based on data volume and restoration point.
</Accordion>

<Accordion title="Retrieve branch database details">
  Retrieves detailed information about a specific database within a neon project and branch. this endpoint allows developers to fetch crucial metadata and configuration details for a given database, enabling them to monitor and manage their database resources effectively. it should be used when you need to inspect the current state, settings, or properties of a particular database in your neon environment. the endpoint provides a snapshot of the database's characteristics but does not modify any data or settings.
</Accordion>

<Accordion title="Delete project jwks by id">
  Deletes a specific json web key set (jwks) associated with a given project in the neon b2b saas integration platform. this endpoint is used to remove outdated or unnecessary cryptographic keys from a project's key management system. it should be used when rotating keys, decommissioning integrations, or as part of regular key hygiene practices. the operation is irreversible, so caution should be exercised to ensure the correct jwks is being deleted. this endpoint does not provide information about the jwks being deleted or return the deleted keys for security reasons.
</Accordion>

<Accordion title="Retrieve branch endpoints">
  Retrieves a list of endpoints associated with a specific branch of a project in the neon platform. this endpoint is used to fetch detailed information about the available integration points or api endpoints within a particular branch of a project. it's particularly useful for developers who need to understand the structure and capabilities of a branch in terms of its exposed endpoints. the returned data likely includes information such as endpoint urls, supported methods, and potentially brief descriptions or metadata about each endpoint. this tool should be used when you need to explore or audit the available endpoints for a given branch, which is crucial for managing integrations and workflows in the neon b2b saas integration platform.
</Accordion>

<Accordion title="Add project email permission">
  Adds permissions for a specified email address to a particular project within the neon b2b saas integration platform. this endpoint is used to grant access or specific rights to users for a given project, enabling collaboration and controlled resource sharing. it should be called when you need to add a new user to a project or modify existing user permissions. the endpoint associates the provided email with the specified project, likely setting up default or predefined permission levels. note that this endpoint only adds permissions and does not provide information about existing permissions or remove them.
</Accordion>

<Accordion title="Retrieve organization invitations">
  Retrieves a list of all pending invitations for a specified organization. this endpoint allows organization administrators to view and manage outstanding invitations sent to potential new members. it should be used when there's a need to track who has been invited to join the organization, review invitation statuses, or perform invitation-related administrative tasks. the endpoint returns details about each invitation, which may include the invitee's email, the invitation date, and the current status. it does not provide information about active members or expired invitations.
</Accordion>

<Accordion title="Create vpc endpoint with label">
  Updates the label of a specific vpc endpoint within an organization's virtual private cloud (vpc) in a particular aws region. this endpoint allows you to change the descriptive name or identifier associated with a vpc endpoint, which can be useful for better organization and management of your vpc resources. the new label helps in identifying and categorizing the vpc endpoint within your infrastructure. this endpoint should be used when you need to modify the existing label of a vpc endpoint, perhaps due to changes in its purpose or to align with updated naming conventions in your organization. it's important to note that this operation only updates the label and does not affect the functionality or configuration of the vpc endpoint itself.
</Accordion>

<Accordion title="Retrieve organization by id">
  Retrieves detailed information about a specific organization within the neon platform. this endpoint allows you to access comprehensive data about an organization, including its configuration, members, and associated projects. use this when you need to view or verify an organization's current state, such as checking membership, reviewing settings, or auditing organization-level information. the endpoint returns a snapshot of the organization at the time of the request and does not provide historical data or future projections. it's particularly useful for administrative tasks, reporting, and maintaining organizational oversight within the neon ecosystem.
</Accordion>

<Accordion title="Retrieve jwks for project">
  Retrieves the json web key set (jwks) for a specified project. this endpoint should be used when a client needs to obtain the public keys necessary for verifying json web tokens (jwts) issued by the project. the jwks contains the cryptographic keys used in the project's authentication process. it's essential for implementing secure, token-based authentication in applications integrated with the neon platform. this endpoint is typically called during the initial setup of a client application or when rotating security keys. note that the jwks should be cached by clients to reduce unnecessary api calls, but periodic refreshes are recommended to ensure up-to-date keys.
</Accordion>

<Accordion title="Retrieve account consumption history">
  Retrieves the consumption history for a specified account within the neon platform. this endpoint provides detailed information about resource usage and associated costs over a given time period. it's particularly useful for analyzing usage patterns, forecasting future resource needs, and managing costs in the neon b2b saas integration platform. the endpoint returns data such as compute time, storage usage, api calls, and any other billable resources specific to the neon service. users can specify a date range and optionally filter by resource types to get a granular view of their consumption. this tool should be used when detailed analytics on resource utilization and spending are required, such as for budget planning, usage optimization, or billing reconciliation. it does not provide real-time usage data and may have a slight delay in reflecting the most recent consumption.
</Accordion>

<Accordion title="Retrieve project endpoint details">
  Retrieves detailed information about a specific endpoint within a project in the neon b2b saas integration platform. this endpoint allows developers to fetch configuration, status, and other relevant details of a particular endpoint associated with a given project. use this when you need to inspect or verify the settings of an individual endpoint, such as its connection parameters, data mapping configurations, or current operational status. the endpoint is particularly useful for troubleshooting integration issues, auditing endpoint configurations, or gathering information for reporting purposes. note that this endpoint only provides read access to endpoint details and does not allow modifications.
</Accordion>

<Accordion title="Add role to branch">
  Creates a new role within a specific branch of a project in the neon b2b saas integration platform. this endpoint allows for fine-grained access control by enabling the creation of custom roles at the branch level. it should be used when setting up or modifying the permission structure for a particular branch within a project. the created role can later be assigned to users, granting them specific permissions within the branch context. note that this endpoint only creates the role; additional steps may be required to assign permissions to the role or associate it with users.
</Accordion>

<Accordion title="Get project branch role">
  Retrieves detailed information about a specific role within a particular branch of a neon project. this endpoint is used to fetch the current configuration, permissions, and other relevant details associated with the specified role. it's particularly useful for auditing access controls, verifying role settings, or gathering information before making modifications to role permissions. the endpoint requires precise identification of the project, branch, and role, ensuring that the correct role information is retrieved from the appropriate context within the neon platform's hierarchical structure.
</Accordion>

<Accordion title="Retrieve organization member info">
  Retrieves detailed information about a specific member within an organization in the neon b2b saas integration platform. this endpoint allows you to fetch comprehensive data about an individual member, including their user id, assigned role within the organization, join date, and potentially other relevant details. it's particularly useful for organization administrators who need to review or verify a member's status and permissions. the endpoint requires both the organization id and the member id to be specified, ensuring precise and secure access to member information. use this when you need to access or display detailed information about a particular member in your organization management interfaces or for auditing purposes.
</Accordion>

<Accordion title="Fetch organization members by id">
  Retrieves a list of all members associated with a specific organization in the neon b2b saas integration platform. this endpoint allows you to fetch detailed information about the users or entities that belong to the organization, which is crucial for managing access, roles, and permissions within the platform. use this endpoint when you need to review the current membership of an organization, audit user access, or gather member information for reporting purposes. the endpoint returns comprehensive member details, but it does not modify any data or provide information about non-member users. keep in mind that for large organizations, the response may be paginated to manage the data volume efficiently.
</Accordion>

<Accordion title="Retrieve projects list">
  Retrieves a list of all neon projects associated with the authenticated user's account. this endpoint provides a comprehensive overview of the user's projects, enabling efficient project management and integration workflows. it should be used when you need to obtain information about multiple projects at once, such as for dashboard displays, project selection interfaces, or batch processing tasks. the endpoint returns project details in json format, which can be easily parsed and utilized in various applications or data analysis processes. note that while this endpoint gives a broad view of projects, it may not include detailed data sets or specific project contents, which might require additional api calls.
</Accordion>

<Accordion title="Delete project permission">
  Deletes a specific permission associated with a project in the neon b2b saas integration platform. this endpoint is used to remove access rights or privileges from a project, which is crucial for maintaining proper access control and security. it should be used when you need to revoke or remove a particular permission that is no longer required or valid for the project. this operation is permanent and cannot be undone, so it should be used with caution. the endpoint requires both the project id and the specific permission id to ensure precise permission management within the project context.
</Accordion>

<Accordion title="Retrieve project operations">
  Retrieves a list of operations associated with a specific project in the neon b2b saas integration platform. this endpoint should be used when you need to fetch all operations related to a particular project, such as for monitoring ongoing tasks, auditing completed actions, or planning future integrations. it provides a comprehensive view of the project's operational landscape, which is crucial for managing complex integration workflows. note that this endpoint only returns the operations list and may not include detailed information about each operation's current status or results; separate api calls might be necessary for such details.
</Accordion>

<Accordion title="Delete api key by id">
  Deletes a specific api key from the neon platform. this endpoint should be used when you need to revoke access for a particular api key, such as when an employee leaves the organization or when you suspect the key has been compromised. the operation is irreversible, so use it with caution. once deleted, any applications or services using this api key will lose access to neon's api. this endpoint helps maintain the security of your neon account by allowing you to manage and control api key access effectively.
</Accordion>

<Accordion title="Retrieve vpc endpoints for project">
  Retrieves a list of vpc (virtual private cloud) endpoints associated with a specific project in the neon b2b saas integration platform. this endpoint allows developers to fetch information about private network connections that enable secure communication between the project's resources and various aws services without traversing the public internet. use this endpoint when you need to audit, manage, or view the current vpc endpoint configurations for a given project. it's particularly useful for ensuring proper network isolation and security in complex integration scenarios. the endpoint does not create or modify vpc endpoints; it only provides read access to existing configurations.
</Accordion>

<Accordion title="Retrieve project permissions">
  Retrieves the current permissions settings for a specific project within the neon b2b saas integration platform. this endpoint allows users to view the access rights and roles assigned to various users or entities for the specified project. it should be used when you need to audit or review the current permission structure of a project, such as before making changes or for compliance checks. the endpoint returns a comprehensive list of permissions but does not modify any settings. it's important to note that this endpoint only provides a snapshot of permissions at the time of the call and does not reflect any pending changes or provide historical permission data.
</Accordion>

<Accordion title="Set branch as default">
  Sets a specified branch as the default branch for a given project in neon. this endpoint allows users to designate a particular branch as the primary or main branch for a project, which can be useful for organizing workflows and setting default behaviors. the operation is performed using a post request, indicating that it modifies the state of the project. use this endpoint when you need to change the default branch of a project, such as after creating a new branch or deciding to switch the main development focus. it's important to note that this action may affect how other operations interact with the project, as many systems use the default branch as a reference point for various functionalities.
</Accordion>

<Accordion title="Reveal role password in branch">
  Reveals the password for a specific role within a branch of a neon project. this endpoint is used when you need to retrieve a previously hidden or encrypted password for a database role. it's particularly useful for administrators who need to access or share role credentials securely. the endpoint should be used cautiously, as it exposes sensitive information. it does not modify the password, only retrieves it. note that frequent use of this endpoint may be logged or restricted for security purposes.
</Accordion>

<Accordion title="Send organization invitations">
  Creates and sends invitations to join an organization in the neon b2b saas integration platform. this endpoint allows administrators to invite multiple users simultaneously, specifying their email addresses and intended roles within the organization. it should be used when expanding the organization's membership or when assigning new roles to incoming members. the endpoint does not verify if the email addresses are associated with existing neon accounts; it simply sends out invitations to the specified email addresses.
</Accordion>

<Accordion title="Start endpoint for project">
  Initiates a specific process or workflow associated with a particular endpoint within a project in the neon b2b saas integration platform. this endpoint is used to start automated tasks, data synchronization jobs, or other predefined processes that have been configured for the specified project and endpoint. it's particularly useful for triggering scheduled or on-demand integrations between different business applications. the endpoint should be used when you need to manually start a process that is usually automated or when restarting a failed process. it's important to note that this endpoint only starts the process; it does not provide information about the process status or results. separate endpoints may be required to monitor the progress or retrieve the outcomes of the started process.
</Accordion>

<Accordion title="Get project connection uri">
  Retrieves the connection uri for a specified project within the neon b2b saas integration platform. this endpoint is crucial for establishing connectivity to a project's resources, enabling access to its data and functionalities. use this when you need to programmatically obtain the connection details for a specific project, which is essential for integrating with the project's data sources or services. the connection uri serves as a unique identifier and access point for the project, facilitating seamless data exchange and workflow automation between different systems and applications within the neon ecosystem.
</Accordion>

<Accordion title="Fetch vpcendpoint details by id">
  Retrieves detailed information about a specific vpc endpoint within an organization's infrastructure in a particular aws region. this endpoint allows developers to access configuration details, status, and other relevant information about the vpc endpoint, which is crucial for managing private connectivity between vpcs and supported aws services. use this endpoint when you need to inspect or verify the settings of a vpc endpoint, troubleshoot connectivity issues, or gather information for compliance and auditing purposes. the endpoint provides a comprehensive view of the vpc endpoint's current state but does not allow modifications to the endpoint configuration.
</Accordion>

<Accordion title="Delete vpc endpoint by ids">
  Deletes a specific vpc endpoint within a given organization and region in the neon b2b saas integration platform. this endpoint should be used when you need to remove a vpc endpoint that is no longer required, perhaps due to changes in network configuration or service usage. the operation is irreversible, so caution should be exercised when invoking this endpoint. it's important to note that deleting a vpc endpoint may impact the connectivity between your vpc and the associated aws service, potentially disrupting ongoing operations that rely on this endpoint.
</Accordion>

<Accordion title="Get branches for project">
  Retrieves a list of branches associated with a specific project in the neon b2b saas integration platform. this endpoint should be used when you need to get an overview of all branches within a particular project, which is useful for version management and workflow control. it provides information about different versions or development stages of the project, allowing for efficient project management and collaboration. the endpoint is particularly helpful when planning merges, reviewing project history, or deciding on which branch to base new development work.
</Accordion>

<Accordion title="Transfer user projects to organization">
  Transfers multiple projects from the authenticated user's personal account to a specified organization within the neon b2b saas integration platform. this endpoint allows for bulk transfer of projects, enabling efficient management of project ownership and organization. it should be used when reorganizing project structures or when moving projects from individual ownership to team or company-wide access. the endpoint is limited to transferring a maximum of 400 projects in a single request, which helps maintain system performance and prevents abuse. it's important to note that this operation is likely irreversible, so users should exercise caution and confirm the transfer details before execution.
</Accordion>

<Accordion title="Delete organization api key">
  Deletes a specific api key associated with an organization in the neon platform. this endpoint is used to revoke access for a particular api key, enhancing security by removing unused or compromised keys. it should be used when an api key is no longer needed, when rotating keys for security purposes, or when an api key may have been exposed. once deleted, the api key cannot be recovered, and any systems using this key will lose access to the neon api. ensure you have a backup or replacement key in place before deletion to avoid service interruptions.
</Accordion>

<Accordion title="Suspend project endpoint by id">
  Suspends a specific endpoint within a project in the neon b2b saas integration platform. this operation temporarily disables the endpoint, preventing it from processing further requests until it is resumed. use this endpoint when you need to conserve resources, perform maintenance, or temporarily halt operations for a particular integration point. the suspension is reversible, allowing you to resume the endpoint's functionality when needed. this tool is particularly useful for managing resource utilization and costs in your neon project by allowing fine-grained control over individual endpoints.
</Accordion>

<Accordion title="Delete organization member">
  Removes a specific member from an organization within the neon b2b saas integration platform. this endpoint should be used when an organization administrator needs to revoke a user's membership, such as when an employee leaves the company or their role changes. the operation is permanent and will immediately remove the member's access to the organization's resources within neon. it's important to note that this action cannot be undone through the api, and re-adding a removed member would require a new invitation process. use this endpoint with caution, as it directly affects user access and organization structure.
</Accordion>

<Accordion title="Create api key for organization">
  Creates a new api key for the specified organization, with optional project-specific access limitations. this endpoint is used to generate and manage api keys, which are essential for authenticating and authorizing access to neon's b2b saas integration platform. the created api key can be used to interact with various services and endpoints within the organization's scope. if a project id is provided, the api key's access will be restricted to that specific project, enabling fine-grained access control. this is particularly useful in multi-project environments where different teams or integrations require isolated access. the endpoint requires a key name to be specified, allowing for easy identification and management of multiple api keys within the organization. it's important to note that the actual api key value will be returned in the response, and should be securely stored as it cannot be retrieved later.
</Accordion>

<Accordion title="Delete database from branch">
  Deletes a specific database from a designated branch within a project in the neon platform. this endpoint should be used when you need to permanently remove a database and all its associated data from a particular branch of a project. it's crucial to use this endpoint with caution as the deletion operation is irreversible. this tool is particularly useful for cleaning up unnecessary databases, managing storage, or removing test databases that are no longer needed. however, it should not be used for temporary data management; instead, consider using database suspension or archiving features if available. note that this operation only affects the specified branch and does not impact the database in other branches or the main project.
</Accordion>

<Accordion title="Delete vpc endpoint by project id">
  Deletes a specific vpc endpoint within a designated project in the neon platform. this endpoint should be used when you need to remove a vpc endpoint that is no longer required or has become obsolete. the operation is irreversible, so it should be used with caution. once a vpc endpoint is deleted, any connections or integrations relying on it will be disrupted. this endpoint is particularly useful for cleaning up resources and managing network configurations in your neon projects.
</Accordion>

<Accordion title="Create branch database">
  Creates a new database within a specified project and branch in the neon platform. this endpoint allows users to set up a new database with a custom name and assign an owner role, facilitating the organization and management of databases within the neon ecosystem. it should be used when initializing a new database for a specific project or when branching requires a separate database instance. the endpoint is particularly useful for developers and database administrators who need to quickly set up new databases as part of their workflow or application deployment process. note that this operation only creates the database; additional steps may be required to configure specific schemas, tables, or access permissions within the newly created database.
</Accordion>

<Accordion title="Delete project branch by id">
  Deletes a specific branch within a project in the neon b2b saas integration platform. this endpoint permanently removes the specified branch and all associated data from the project. it should be used when a branch is no longer needed, such as after merging changes or abandoning a development path. caution should be exercised when using this endpoint, as the deletion is irreversible. it's important to ensure that any valuable data or configurations in the branch have been backed up or merged before deletion. this operation cannot be undone, so double-checking the project id and branch id before execution is crucial to avoid accidental deletions.
</Accordion>

<Accordion title="Get branch roles for project">
  Retrieves the roles associated with a specific branch within a project in the neon b2b saas integration platform. this endpoint is used to fetch the current role assignments for a given project and branch combination, which is essential for managing access control and permissions within the neon ecosystem. it should be used when you need to review or audit the roles assigned to a particular branch, such as before making changes to permissions or when verifying the current access structure. the endpoint does not modify any roles; it only provides a read-only view of the existing role assignments. keep in mind that the response will only include roles for the specified branch and does not provide information about roles in other branches or at the project level.
</Accordion>

<Accordion title="Get project endpoint information">
  Retrieves a list of all endpoints associated with a specific project in the neon b2b saas integration platform. this endpoint should be used when you need to obtain information about the available integration points or data connections within a particular project. it provides an overview of the project's configured endpoints, which can be useful for monitoring, auditing, or managing the project's integration setup. the response likely includes details such as endpoint names, types, and statuses, though the exact structure is not specified in the given schema. this endpoint is essential for developers and administrators working with multiple integrations within a single project in the neon platform.
</Accordion>

<Accordion title="Create compute endpoint">
  Creates a new compute endpoint for a specified branch within a neon project. this endpoint allows for detailed configuration of database resources, including read/write capabilities, regional placement, autoscaling limits, and connection pooling settings. it's primarily used when setting up new database instances or modifying existing database configurations to meet specific performance, scaling, or operational requirements. the endpoint provides fine-grained control over compute resources, enabling optimized database operations for various use cases from development to production environments.
</Accordion>

<Accordion title="Create new api key">
  Creates a new api key for accessing the neon b2b saas integration platform. this endpoint should be used when setting up new integrations, creating separate keys for different environments (e.g., production, testing), or rotating existing keys for security purposes. the created api key will be used for authenticating and authorizing requests to other neon api endpoints. note that this endpoint only creates the key; it does not manage permissions or access levels, which must be configured separately. after creation, ensure the key is securely stored, as it may not be retrievable in plain text again.
</Accordion>

<Accordion title="Get project operation by id">
  Retrieves detailed information about a specific operation within a project in the neon b2b saas integration platform. this endpoint is used when you need to fetch the current status, details, or results of a particular operation that has been initiated or is ongoing within a project. it's particularly useful for monitoring the progress of long-running tasks, checking the outcome of automated workflows, or auditing past activities. the endpoint requires both a project id and an operation id to uniquely identify the operation you're querying. it should be used when you have these identifiers and need up-to-date information about the operation. note that this endpoint only provides information about the operation itself and does not modify or execute any actions.
</Accordion>

<Accordion title="Update organization member role">
  Updates the role of a specific member within an organization in the neon b2b saas integration platform. this endpoint allows changing a member's role between 'admin' and 'member', which affects their permissions and access levels within the organization. use this endpoint when you need to promote a regular member to an admin role or demote an admin to a regular member role. it's crucial for managing access control and permissions within your organization. note that this operation may have significant implications on the member's ability to manage resources and other members within the organization.
</Accordion>

<Accordion title="Update project compute endpoint settings">
  Updates the configuration of a specific compute endpoint within a neon project. this endpoint allows fine-tuning of various settings such as autoscaling limits, provisioner type, connection pooling, and auto-suspend behavior. it's particularly useful for optimizing performance, resource allocation, and cost management of your neon compute endpoints. the endpoint should be used when you need to modify the behavior or resources of an existing compute endpoint to better suit your application's needs or to implement changes in your infrastructure strategy. note that some parameters are deprecated, and care should be taken to use the most current features and settings.
</Accordion>

<Accordion title="Update project settings by id">
  Updates the configuration and settings of a specific neon project. this endpoint allows fine-grained control over various aspects of a project, including resource quotas, security settings, maintenance windows, and default endpoint configurations. it's particularly useful for adjusting project parameters to optimize performance, enhance security, or comply with specific operational requirements. the endpoint should be used when changes to project-wide settings are necessary, such as modifying resource limits, adjusting ip access controls, or reconfiguring maintenance schedules. note that some changes, like enabling logical replication, may have significant impacts on project operations and cannot be reversed. care should be taken when modifying critical settings to avoid unintended consequences on project functionality or availability.
</Accordion>


# Ngrok
Source: https://docs.push.ai/integrations/ngrok



Ngrok creates secure tunnels to locally hosted applications, enabling developers to share and test webhooks or services without configuring complex network settings

<Accordion title="Delete API Key">
  Delete an api key by its id. this action permanently removes the specified api key from your ngrok account. this is an important security feature that allows users to revoke access when an api key is compromised or no longer needed. once deleted, the api key cannot be recovered and any services using it will lose access.
</Accordion>

<Accordion title="Get IP Restriction Details">
  This tool retrieves detailed information about a specific ip restriction by its id. it is used to control which ip addresses can access ngrok resources, including the api, by fetching complete details of the ip restriction. this action is essential for auditing and verification in ip restriction management.
</Accordion>

<Accordion title="List HTTPS Edges">
  Lists all https edges in your ngrok account. https edges are configurations that tell ngrok how to handle https traffic. the action returns a paginated list of all https edges associated with your account.
</Accordion>

<Accordion title="List API Keys">
  This tool lists all api keys owned by the user. the api keys are used to authenticate api requests to ngrok's rest api. the endpoint returns a paginated list of api keys.
</Accordion>

<Accordion title="List All Endpoints">
  List all active endpoints on the ngrok account. this tool will list all active endpoints on the ngrok account, providing visibility into running tunnels and endpoints. it requires no input parameters beyond authentication and serves as a fundamental component for monitoring, managing, and referencing ngrok resources.
</Accordion>

<Accordion title="Create API Key">
  Creates a new api key for authenticating with the ngrok api. this tool allows programmatic creation of api keys that can be used to access ngrok's api services.
</Accordion>

<Accordion title="List IP Policy Rules">
  This tool lists all ip policy rules associated with your ngrok account. it retrieves detailed information including rule id, creation timestamp, description, metadata, cidr, the associated ip policy, and the action (allow or deny) for each rule. it supports pagination with parameters 'limit' for the maximum number of results and 'before id' for pagination.
</Accordion>

<Accordion title="List IP Restrictions">
  This tool retrieves a list of all ip restrictions configured on the ngrok account. it allows users to audit and review all ip-based access restrictions on their ngrok account for enhanced security management. the api endpoint supports pagination with optional parameters such as 'limit' and 'before id', and returns a detailed json response containing attributes like id, uri, created at, description, metadata, enforced, type, and associated ip policies.
</Accordion>

<Accordion title="List Active Tunnels">
  List all active tunnels in the ngrok account. this tool lists all active tunnels in the ngrok account, providing details such as tunnel id, public url, start time, protocol, configuration details, and metadata. it requires no input parameters beyond authentication and returns a paginated list of all running tunnels with their complete status information.
</Accordion>


# Notion
Source: https://docs.push.ai/integrations/notion



Notion centralizes notes, docs, wikis, and tasks in a unified workspace, letting teams build custom workflows for collaboration and knowledge management

<Accordion title="Fetch All Unresolved Comments">
  Retrieves a list of un-resolved comment objects from a page or block.
</Accordion>

<Accordion title="Query Database">
  Get list of rows from a notion database filtered and sorted. each row in notion database is represented as a page. each column in the database is represented as a property. to use sorting, filtering find all the properties in the database by using the fetch database action. the response may contain fewer than page size of results and supports pagination.
</Accordion>

<Accordion title="Fetch Database">
  Retrieves a database object — information that describes the structure and columns of a database — for a provided database id. the response adheres to any limits to an integration’s capabilities. to fetch database rows rather than columns, use the query a database endpoint.
</Accordion>

<Accordion title="Fetch Notion Blocks">
  Retrieves a block object using the id specified. if the block returned contains the key has children: true, use the retrieve block children endpoint to get the list of children. to retrieve page content for a specific page, use retrieve block children and set the page id as the block id.
</Accordion>

<Accordion title="Fetch Notion Block Children">
  Returns a paginated array of child block objects contained in the block using the id specified. page content is represented by block childrens. use this function to get complete content of page. returns only the first level of children for the specified block. the response may contain fewer than page size of results. this endpoint requires an integration to have read content capabilities.
</Accordion>

<Accordion title="Fetch Database Row">
  Each row in database is a page in notion so page id & row id is a uuid of that page. id of the notion page to fetch. to fetch content of a page, "fetch block children" action can be used.
</Accordion>

<Accordion title="Get About Me">
  Gets 1. the user id associated with the notion integration. 2. the information about notion account like name of organisation. to get more details about user, you can use the user id to get user details
</Accordion>

<Accordion title="Search_List Notion Page">
  Search a page in notion. keep the value of parameter query "" to get list of all pages and their ids. this api can be used to search for all available pages currently to get their page ids. it can also be used to find the relevant page id with a specific title or content. if you want to create a page and need all possible parent page ids, then use this api to fetch it. if the response is empty, do a search with empty query to get list of all pages that have been given access to.
</Accordion>

<Accordion title="Add Content Notion Page">
  Adds a single content block to a notion page. multiple calls needed for multiple blocks. note: only supports adding to notion pages. blocks that can contain children: - page (any block type) - toggle (any nested content) - to-do (nested to-dos/blocks) - bulleted list (nested lists/blocks) - numbered list (nested lists/blocks) - callout (child blocks) - quote (nested blocks)
</Accordion>

<Accordion title="Get About User">
  Get information about the user account using the user id
</Accordion>

<Accordion title="Get Page Property">
  Action to retrieve a specific property value from a notion page.
</Accordion>

<Accordion title="Archive Notion Page">
  Archive or unarchive a page in notion.
</Accordion>

<Accordion title="Append Block Children">
  This tool allows appending new child blocks to an existing block in notion. it specifically handles appending blocks to an existing parent block rather than creating new page content. the endpoint uses a patch request to `/v1/blocks/\{block id\}/children` and facilitates adding new content to existing blocks, extending lists or toggle blocks, inserting new blocks between existing content, and building nested block structures.
</Accordion>

<Accordion title="Create Notion Page">
  Create a page in notion under page with id parent id. \* if a specific parent id is given, directly create the page under that parent. \* if no parent id is given, search for all the pages in notion workspace and find the one which is appropriate and select it as parent page. the parent id required is a unique uuid representing the parent page id which can be found notion search notion page tool. this is a new agent format for adding content to a notion page. example of a new format is \{ "parent id": "59833787-2cf9-4fdf-8782-e53db20768a5", "title": "my new report", "icon": "😻", "cover": "[https://google.com/image.png](https://google.com/image.png)", } don't use the old format, it is not compatible with agents
</Accordion>

<Accordion title="Delete Blocks">
  Sets a block object, including page blocks, to archived: true using the id specified. this can be used to delete a block, page, or database. note: in the notion ui application, this moves the block to the "trash" where it can still be accessed and restored. to restore the block with the api, use the update a block or update page respectively.
</Accordion>

<Accordion title="Update Row Database">
  Each row in the database is a new page in notion. so updating a row in the database is the same as updating a property of a page in notion. this action updates a specific value in a row in the notion database. for different column/property types --> value should be -title,rich text - text ex. "hello world" -number - number ex. 23.4 -select - select ex. "india" -multi select - multi select comma separated values ex. "india,usa" -date - format ex. "2021-05-11t11:00:00.000-04:00", -people - comma separated ids of people ex. "123,456" -url - a url. -files - comma separated urls -checkbox - "true" or "false"
</Accordion>

<Accordion title="Update Database Schema">
  Update a database schema in notion. using this you can change the columns/properties of a database.
</Accordion>

<Accordion title="List Users">
  List all users returns a paginated list of users for the workspace. the response may contain fewer than page size of results. guests are not included in the response.
</Accordion>

<Accordion title="Insert Row Database">
  Each row in the database is a new page in notion. inserting a row in the database creates a page in notion, and includes extra properties as a structured list of key-value pairs for all columns in the database. this action locates the correct database id in the notion workspace and inserts a new page. for each property type, the expected format is: - title, rich text: "text" (e.g., "hello world") (important: max 2000 characters, longer text will be truncated) - number: number (e.g., 23.4) - select: select (e.g., "india") - multi select: array of strings (e.g., "india,usa") - date: iso 8601 format (e.g., "2021-05-11t11:00:00.000-04:00") - people: array of user ids (e.g., "123,456") - url: a url - files: array of urls - checkbox: true or false
</Accordion>

<Accordion title="Update block">
  Updates an existing block within a notion page. this action supports modifying various block types such as paragraphs, headings, list items, toggles, and to-do items using the patch /v1/blocks/\{block id} endpoint.
</Accordion>

<Accordion title="Duplicate Page">
  Duplicates a notion page with all its content and properties. this action creates an exact copy of an existing notion page, including all its content, properties, and nested blocks. the duplicate can be created in the same or a different parent location.
</Accordion>

<Accordion title="Create Comment">
  Create a comment on a page in notion. there are two locations where a new comment can be added (via the public api). to add a new comment to a 1. page, a parent object with a page id must be provided in the body params. 2. existing discussion thread, a discussion id string must be provided in the body params. (inline comments to start a new discussion thread cannot be created via the public api.) either the parent.page id or discussion id parameter must be provided — not both.
</Accordion>

<Accordion title="Create Notion Database">
  Creates a database as a subpage in the specified parent page, with the specified properties schema/columns. currently, the parent of a new database must be a notion page. you cannot update the schema of an existing database using this action. use update schema database action to update the schema or add/remove columns. only use this to create a new database. the title will be automatically converted to notion's rich text format internally.
</Accordion>


# One drive
Source: https://docs.push.ai/integrations/one_drive



OneDrive is Microsoft’s cloud storage solution enabling users to store, sync, and share files across devices, offering offline access, real-time collaboration, and enterprise-grade security

<Accordion title="Find Item">
  Finds an item by name in onedrive using microsoft graph api.
</Accordion>

<Accordion title="Find Folder">
  Finds a folder by name in onedrive using microsoft graph api.
</Accordion>

<Accordion title="List OneDrive Items">
  Retrieve all files and folders from the root directory of onedrive using the microsoft graph api.
</Accordion>

<Accordion title="Upload File">
  Uploads a file to onedrive using microsoft graph api.
</Accordion>

<Accordion title="Download Item">
  Downloads a file from onedrive using microsoft graph api.
</Accordion>

<Accordion title="Create New Text File">
  Creates a new text file in onedrive with the specified content.
</Accordion>

<Accordion title="Create Folder">
  Creates a new folder in onedrive using microsoft graph api.
</Accordion>


# Onepage
Source: https://docs.push.ai/integrations/onepage



API for enriching user and company data, providing endpoints for token validation and generic search.

<Accordion title="Token details request">
  Retrieves detailed information about a specific token in the onepage system. this endpoint should be used when you need to obtain comprehensive data about a token, such as its associated permissions, expiration date, or other metadata. it's particularly useful for token management tasks, such as verifying token validity or checking token attributes. the endpoint accepts a single token and returns its corresponding details. it should not be used for token creation, deletion, or modification operations. note that the specific details returned may vary based on the onepage implementation and the token's type or purpose.
</Accordion>

<Accordion title="Search input post request">
  The searchinput endpoint allows users to perform a search query within the onepage platform. it accepts a required search string and optional parameters for language and output format customization. this endpoint is designed for retrieving relevant information based on user-specified search terms, with the ability to filter results by language and choose between structured (json) or plain text output. use this endpoint when you need to search for specific content or information within the onepage ecosystem. it's particularly useful for integrating search functionality into applications or workflows that interact with onepage data. note that this endpoint focuses solely on search functionality and does not provide additional features like content creation or modification.
</Accordion>


# Open sea
Source: https://docs.push.ai/integrations/open_sea



OpenSea is the world's first and largest NFT marketplace for NFTs and crypto collectibles.

<Accordion title="Create listing">
  List a single nft (erc721 or erc1155) for sale on the opensea marketplace.
</Accordion>

<Accordion title="Fulfill listing">
  Retrieve all the information, including signatures, needed to fulfill a listing directly onchain.
</Accordion>

<Accordion title="Get collection stats">
  Get stats for a single collection on opensea.
</Accordion>

<Accordion title="Get collections">
  Get a list of opensea collections with optional filtering and pagination.
</Accordion>

<Accordion title="Get contract">
  Get a smart contract for a given chain and address.
</Accordion>

<Accordion title="Get events">
  Get a list of events from opensea based on various filters like timestamps and event types.
</Accordion>

<Accordion title="Refresh nft metadata">
  Refresh metadata for a single nft.
</Accordion>

<Accordion title="Get account">
  Get an opensea account profile including details such as bio, social media usernames, and profile image.
</Accordion>

<Accordion title="Get listings">
  Get the complete set of active, valid listings.
</Accordion>

<Accordion title="Fulfill offer">
  Retrieve all the information, including signatures, needed to fulfill an offer directly onchain.
</Accordion>

<Accordion title="Get nft">
  Get metadata, traits, ownership information, and rarity for a single nft.
</Accordion>

<Accordion title="Get all listings by collection">
  Get all active, valid listings for a single collection.
</Accordion>

<Accordion title="Get order">
  Get a single order, offer or listing, by its order hash. protocol and chain are required to prevent hash collisions.
</Accordion>

<Accordion title="Get all offers by collection">
  Get all active, valid offers for the specified collection. this includes individual and criteria offers.
</Accordion>

<Accordion title="Get payment token">
  Get a smart contract for a given chain and address.
</Accordion>

<Accordion title="Get traits">
  Get the traits in a collection.
</Accordion>

<Accordion title="Get best listing by nft">
  Get the best listing for an nft.
</Accordion>

<Accordion title="Get collection">
  Get a single collection including details such as fees, traits, and links.
</Accordion>

<Accordion title="Build criteria offer">
  Build a portion of a criteria offer including the merkle tree needed to post an offer.
</Accordion>

<Accordion title="Create criteria offer">
  Create a criteria offer to purchase any nft in a collection or which matches the specified trait.
</Accordion>

<Accordion title="Cancel order">
  Offchain cancel a single order, offer or listing, by its order hash when protected by the signedzone. protocol and chain are required to prevent hash collisions. please note cancellation is only assured if a fulfillment signature was not vended prior to cancellation.
</Accordion>

<Accordion title="Create item offer">
  Create an offer to purchase a single nft (erc721 or erc1155).
</Accordion>


# Outlook
Source: https://docs.push.ai/integrations/outlook



Outlook is Microsoft’s email and calendaring platform integrating contacts, tasks, and scheduling, enabling users to manage communications and events in a unified workspace

<Accordion title="Download Outlook Attachment">
  Download an attachment from an outlook mail.
</Accordion>

<Accordion title="Create Draft Reply">
  Create a draft reply to an email using microsoft graph api for outlook.
</Accordion>

<Accordion title="Get Contact">
  Get a specific contact by id from outlook using microsoft graph api.
</Accordion>

<Accordion title="Get Profile">
  Get the profile of a user in outlook using microsoft graph api.
</Accordion>

<Accordion title="Get Calendar Event">
  Get a specific calendar event by id from outlook using microsoft graph api.
</Accordion>

<Accordion title="Delete Calendar Event">
  Delete a calendar event using microsoft graph api for outlook.
</Accordion>

<Accordion title="Get Email Message">
  Retrieve an email message by its id using the microsoft graph api.
</Accordion>

<Accordion title="Delete Contact">
  Delete a contact from the user's outlook contacts using microsoft graph api. the contact id can be obtained from outlook get contacts or outlook get contact actions.
</Accordion>

<Accordion title="Get Schedule">
  Get the free/busy schedule of users and resources for a specific time period. this action requires a minimum of calendars.readbasic permission and can retrieve availability information for up to 20 users or resources at once, for a time period of up to 62 days.
</Accordion>

<Accordion title="List Outlook Contacts">
  Action to list outlook contacts using microsoft graph.
</Accordion>

<Accordion title="List Outlook Attachments">
  Retrieve a list of attachments for a specific outlook email message using microsoft graph api, omitting any base64 content bytes.
</Accordion>

<Accordion title="List Events">
  List events in the user's calendar using microsoft graph api for outlook.
</Accordion>

<Accordion title="Search Outlook Messages">
  Action to search outlook messages using the microsoft search api for work/school accounts. note: this tool only supports microsoft 365/enterprise accounts and does not support @hotmail.com or @outlook.com addresses.
</Accordion>

<Accordion title="List Messages">
  List messages in the user's mailbox using microsoft graph api for outlook.
</Accordion>

<Accordion title="Send Email">
  Send an email using microsoft graph api for outlook.
</Accordion>

<Accordion title="Reply to Email">
  Reply to an email using microsoft graph api for outlook.
</Accordion>

<Accordion title="Create Calendar Event">
  Create an event in the user's calendar via microsoft graph api. this tool expects a flattened 'attendees info' from the user/llm, then transforms them into the nested shape required by microsoft graph.
</Accordion>

<Accordion title="Update Calendar Event">
  Update an event in the user's calendar using microsoft graph api for outlook.
</Accordion>

<Accordion title="Update Email Message">
  Update an existing email message.
</Accordion>

<Accordion title="Update Contact">
  Update an existing contact for the user in outlook contacts.
</Accordion>

<Accordion title="Create Email Draft">
  Create a draft email using microsoft graph api for outlook.
</Accordion>

<Accordion title="Create Contact">
  Create a new contact in the user's outlook contacts using microsoft graph api.
</Accordion>


# Pagerduty
Source: https://docs.push.ai/integrations/pagerduty



Integrate PagerDuty to manage incidents, schedules, and alerts directly from your application.

<Accordion title="Add service to incident workflow trigger">
  This endpoint adds a service to an existing incident workflow trigger in pagerduty. it allows you to associate a specific service with a trigger, enabling automated incident management processes for that service. use this endpoint when you need to connect a service to an incident workflow, typically during the setup or modification of your incident response procedures. the endpoint requires the trigger's id and the service's id to make the association. it's important to note that this operation doesn't create new services or triggers, but rather links existing ones. ensure that both the trigger and service exist in your pagerduty account before making this call.
</Accordion>

<Accordion title="Aggregate incident metrics with filters">
  Retrieves and aggregates metrics for incidents across all services in pagerduty. this endpoint allows for extensive filtering and customization of incident data, enabling detailed analysis of operational performance. it's particularly useful for generating reports, identifying trends, and assessing incident management efficiency over specified time periods. the endpoint supports various filtering criteria, time zone adjustments, and aggregation options, making it a powerful tool for both high-level overviews and granular incident analytics. however, users should be aware of the complexity of the filtering options and ensure they provide accurate parameters to obtain relevant data.
</Accordion>

<Accordion title="Audit escalation policy records">
  Retrieves the audit records for a specific escalation policy in pagerduty. this endpoint allows users to access a detailed history of changes made to the escalation policy, including modifications to escalation rules, associated services, and on-call schedules. it's particularly useful for compliance tracking, troubleshooting, and understanding how the incident response process has been adjusted over time. the audit records provide transparency into who made changes, what was changed, and when the changes occurred, helping teams maintain accountability and optimize their incident management workflows.
</Accordion>

<Accordion title="Associate service dependencies">
  Associates multiple service dependencies in pagerduty, allowing you to define relationships between supporting and dependent services. this endpoint is used to establish a hierarchical structure of services, which is crucial for effective incident management and impact analysis. it enables you to create multiple dependencies in a single api call, improving efficiency when setting up complex service relationships. use this endpoint when you need to define or update the dependency structure of your services in pagerduty, such as during initial setup, service restructuring, or when adding new services to your incident management workflow.
</Accordion>

<Accordion title="Associate team with automation action">
  This endpoint associates a specific team with an automation action in pagerduty. it allows you to link a team to an automated workflow, enabling better organization and management of automation actions within your incident response processes. use this endpoint when you need to assign responsibility for an automation action to a particular team or when restructuring your automation workflows. the association helps in tracking, auditing, and managing permissions for automation actions across different teams in your organization. note that this endpoint only creates the association; it does not create new teams or automation actions.
</Accordion>

<Accordion title="Aggregate escalation policy incident metrics">
  This endpoint analyzes and aggregates incident metrics across all escalation policies in pagerduty. it allows for detailed filtering and customization of the analysis, enabling users to gain insights into incident patterns, response times, and escalation effectiveness. the endpoint is particularly useful for operational reviews, performance analysis, and identifying areas for improvement in incident management processes. it provides flexibility in data selection through various filters and supports different time-based aggregations for comprehensive reporting.
</Accordion>

<Accordion title="Create and manage custom incident fields">
  Creates a new custom field for incidents in pagerduty. this endpoint allows you to define additional data points to be associated with incidents, enhancing incident management and reporting capabilities. custom fields can be used to store various types of information such as environment, severity, or any other relevant metadata. the field can be configured with different data types and value constraints, allowing for flexible and structured data capture. use this endpoint when you need to extend the incident data model with organization-specific information. note that once created, certain properties of a custom field cannot be changed, so careful planning of field structure is important.
</Accordion>

<Accordion title="Create a custom field for an incident type">
  Create a custom field for an incident type. custom fields (cf) are a feature which will allow customers to extend incidents with their own custom data, to provide additional context and support features such as customized filtering, search and analytics. custom fields can be applied to different incident types. \<!-- theme: warning --> > ### early access > this endpoint is in early access and may change at any time. you must pass in the x-early-access header to access it. scoped oauth requires: `custom fields.write`
</Accordion>

<Accordion title="Count paused incident reports">
  Retrieves the count of paused incident reports in the pagerduty system. this endpoint is part of pagerduty's incident management and analytics features, providing a quick way to quantify the number of incidents that are currently in a paused state. it's particularly useful for generating high-level analytics, tracking incident management efficiency, and identifying trends in incident handling. the endpoint returns a simple count, making it ideal for dashboard displays or periodic system status checks. it should be used when a rapid overview of paused incidents is needed, but it won't provide detailed information about individual incidents.
</Accordion>

<Accordion title="Convert service rule by id">
  Converts the rules associated with a specific pagerduty service to a new or optimized format. this endpoint is used to update and standardize the incident management rules for a given service, improving the efficiency and consistency of alert handling. it should be used when there's a need to modernize rule sets, apply best practices, or adapt rules to changing service requirements. the conversion process is applied to all rules linked to the specified service id, potentially modifying their structure or behavior. it's important to note that this operation may impact existing incident routing and alerting patterns, so it should be used cautiously and preferably during a maintenance window.
</Accordion>

<Accordion title="Create automation runner endpoint">
  Creates a new automation runner in the pagerduty incident management system. this endpoint allows you to set up either a sidecar runner, which polls for invocations externally, or a runbook runner, which communicates directly with a runbook instance. use this when you need to automate actions within pagerduty, such as incident response processes or scheduled tasks. the runner can be associated with specific teams for better organization and access control. note that the required parameters differ based on the chosen runner type, with runbook runners requiring additional configuration for server connection.
</Accordion>

<Accordion title="Create an incident type">
  Create a new incident type. incident types are a feature which will allow customers to categorize incidents, such as a security incident, a major incident, or a fraud incident. \<!-- theme: warning --> > ### early access > this endpoint is in early access and may change at any time. you must pass in the x-early-access header to access it. for more information see the [api concepts document](../../api-reference/zg9joji3ndc5nzc-api-concepts#incidenttype) scoped oauth requires: `incident types.write`
</Accordion>

<Accordion title="Create user status update notification rule">
  Creates a new status update notification rule for a specific user in pagerduty. this endpoint allows you to define how a user will be notified about incident status updates. it's used to customize notification preferences for individual users, ensuring they receive timely updates through their preferred contact method. the rule specifies which contact method (email, phone, push notification, or sms) should be used for sending status updates. this is particularly useful for tailoring notification strategies to match users' roles and responsibilities within the incident management process.
</Accordion>

<Accordion title="Delete incident workflow trigger by id">
  Deletes a specific trigger associated with an incident workflow in pagerduty. this endpoint is used to remove an automated trigger that initiates a predefined workflow in response to incidents. it should be used when you need to modify your incident response automation by removing outdated or unnecessary triggers. this operation is permanent and cannot be undone, so it should be used with caution. the endpoint does not return any data upon successful deletion, typically responding with a 204 no content status.
</Accordion>

<Accordion title="Delete business service priority thresholds">
  Deletes all priority thresholds for business services in the pagerduty account. this endpoint is used to remove the configured priority settings that determine how incidents are escalated based on their urgency for business services. it should be used when you want to reset or remove all priority threshold configurations across your business services. this operation is irreversible and will affect how future incidents are prioritized and escalated for all business services in the account. it's important to note that this action does not delete the business services themselves, only their associated priority thresholds.
</Accordion>

<Accordion title="Create extension object">
  Creates a new extension in pagerduty, allowing for additional functionality or integrations to be added to your services. this endpoint is used to set up webhooks, custom integrations, or other specific features that enhance the capabilities of your pagerduty account. the extension is defined by its name, associated services, and a specific extension schema that determines its behavior. use this endpoint when you need to automate the creation of extensions, such as setting up multiple webhooks or implementing custom workflows. it's particularly useful for large-scale deployments or when programmatically managing your pagerduty configuration. note that the extension can be temporarily disabled by pagerduty if issues arise, such as repeated rejections from a webhook server.
</Accordion>

<Accordion title="Create handoff notification rule">
  Creates a new on-call handoff notification rule for a specific user in pagerduty. this endpoint allows you to set up automated notifications for when a user is about to start or end their on-call shift. it defines how and when the user should be notified about upcoming handoffs, helping to ensure smooth transitions between on-call periods. use this when you need to establish or modify the way a user is informed about their on-call responsibilities. the rule can be set for incoming shifts, outgoing shifts, or both, and can use various contact methods like email, phone, push notifications, or sms. note that this endpoint creates a new rule and does not modify existing ones.
</Accordion>

<Accordion title="Create business service">
  This endpoint creates a new business service in pagerduty, which represents a specific service or application that can be monitored and managed within the incident management platform. it allows you to define essential properties of the service, including its name, description, point of contact, and the team responsible for it. use this endpoint when you need to add a new service to your pagerduty account for monitoring and incident management. the created business service can be later associated with technical services, incidents, and escalation policies. note that this endpoint only creates the business service; additional configuration may be required to set up monitoring and alerting for the service.
</Accordion>

<Accordion title="Delete a field option for a custom field">
  Delete a field option for a custom field. \<!-- theme: warning --> > ### early access > this endpoint is in early access and may change at any time. you must pass in the x-early-access header to access it. scoped oauth requires: `custom fields.write`
</Accordion>

<Accordion title="Create new webhook subscription">
  Creates a new webhook subscription in pagerduty to receive specific event notifications. this endpoint allows users to set up automated notifications for various incident-related events, such as triggers, acknowledgments, and resolutions. the webhook can be configured to filter events by service, team, or account-wide, and supports custom http headers for enhanced integration capabilities. use this when you need to integrate pagerduty's real-time incident updates with external systems or workflows. note that the webhook's secret for payload verification is only provided in the initial creation response and cannot be retrieved later.
</Accordion>

<Accordion title="Delete a custom field for an incident type">
  Delete a custom field for an incident type. custom fields (cf) are a feature which will allow customers to extend incidents with their own custom data, to provide additional context and support features such as customized filtering, search and analytics. custom fields can be applied to different incident types. \<!-- theme: warning --> > ### early access > this endpoint is in early access and may change at any time. you must pass in the x-early-access header to access it. scoped oauth requires: `custom fields.write`
</Accordion>

<Accordion title="Create a ruleset">
  Creates a new ruleset in pagerduty for managing incident routing and notification rules. this endpoint allows you to define a named set of rules that determine how incidents are processed and directed to specific teams or users. it's particularly useful when setting up or modifying your incident management workflow. the created ruleset can be global, affecting all incoming incidents, or assigned to a specific team for more targeted incident routing. note that while you can create the ruleset structure with this call, the actual rules within the ruleset must be added separately using other api endpoints.
</Accordion>

<Accordion title="Delete business service by id">
  Deletes a specific business service from the pagerduty system. this endpoint should be used when you want to permanently remove a business service that is no longer needed or relevant to your organization's incident management structure. it's important to note that this action is irreversible and will remove all associations between the deleted business service and any technical services or incidents. use this endpoint with caution, as it may impact reporting and historical data related to the deleted business service. before deletion, ensure that no active incidents or dependencies rely on this business service to avoid disruptions in your incident management workflow.
</Accordion>

<Accordion title="Create a trigger">
  Create new incident workflow trigger scoped oauth requires: `incident workflows.write`
</Accordion>

<Accordion title="Delete incident workflow by id">
  Deletes a specific incident workflow from the pagerduty system. this endpoint should be used when you want to permanently remove a customized sequence of automated actions and triggers associated with incident management. it's important to note that this action is irreversible, and once deleted, the workflow cannot be recovered. use this endpoint with caution, ensuring that the workflow is no longer needed before deletion. this operation helps in maintaining a clean and relevant set of incident workflows, improving overall incident management efficiency.
</Accordion>

<Accordion title="Create a field option for a custom field">
  Create a field option for a custom field. custom fields (cf) are a feature which will allow customers to extend incidents with their own custom data, to provide additional context and support features such as customized filtering, search and analytics. custom fields can be applied to different incident types. \<!-- theme: warning --> > ### early access > this endpoint is in early access and may change at any time. you must pass in the x-early-access header to access it. scoped oauth requires: `custom fields.write`
</Accordion>

<Accordion title="Create escalation policy">
  Creates a new escalation policy in pagerduty, defining how incidents are escalated to different responders or teams. this endpoint allows you to set up a structured response plan for managing incidents, including escalation rules, targets, and associated services or teams. use this when setting up or modifying incident management workflows. the created policy determines the sequence of notifications and assignments for unacknowledged incidents. note that while you can create the policy structure, actual service associations are read-only and must be managed separately. only one team can be associated with a policy, and the account must have the 'teams' ability to use this feature.
</Accordion>

<Accordion title="Create event rule in ruleset">
  Creates a new event rule within a specified ruleset in pagerduty's incident management system. this endpoint allows you to define complex conditions for event matching and specify actions to be taken when an event meets those conditions. use this to automate incident response, customize alert routing, and fine-tune event processing based on specific criteria. the created rule becomes part of the ruleset's evaluation sequence, affecting how incoming events are processed and managed.
</Accordion>

<Accordion title="Create or update status page post">
  Creates a new post on a specified pagerduty status page. this endpoint allows you to publish information about incidents or scheduled maintenance, including details such as the post type, timing, and associated updates. use this to communicate service status, planned downtime, or ongoing issues to your users or customers. the post can include multiple updates, each with its own message, severity, and impact on specific services. this is particularly useful for providing real-time information during incidents or for scheduling and describing maintenance windows.
</Accordion>

<Accordion title="Create incident field option">
  Creates a new field option for a specific custom field in pagerduty's incident management system. this endpoint allows you to add predefined options to custom fields, enhancing the ability to categorize and filter incidents with consistent, structured data. use this when you need to expand the list of selectable values for a string-type custom field. the new option becomes immediately available for selection when updating or creating incidents. note that this operation is specific to custom fields of type 'string' and cannot be used for other data types. ensure that the field id in the url corresponds to an existing custom field in your pagerduty account.
</Accordion>

<Accordion title="Delete response play">
  Deletes a specific response play from the pagerduty system. this endpoint should be used when you need to remove an outdated or unnecessary response play from your incident management workflow. it permanently eliminates the predefined sequence of actions associated with the specified response play id. use this endpoint with caution, as the deletion is irreversible and may impact automated incident response processes. this operation is particularly useful for maintaining an up-to-date and efficient set of response strategies in your pagerduty account.
</Accordion>

<Accordion title="Create event orchestration">
  Creates a new event orchestration in pagerduty, which defines how incoming events are processed and routed to appropriate services. this endpoint allows you to set up a configuration that manages the flow of events from various integrations, ensuring efficient incident handling. use this when you need to establish a new set of rules for event routing, especially when introducing new services or reorganizing your incident management workflow. the created orchestration can later be associated with specific integrations using their routing keys. note that while you can create the orchestration structure, the actual integrations and routing details are managed separately and will be populated as read-only information once configured.
</Accordion>

<Accordion title="Delete incident workflow trigger service">
  This endpoint removes a specific service from a trigger within an incident workflow in pagerduty. it is used to modify the configuration of an existing incident workflow by disassociating a service from a particular trigger. this action is useful when you need to update the automation rules or remove a service from the automated response process for certain incidents. the endpoint requires both the trigger id and the service id to be specified in the url path. upon successful execution, the specified service will no longer be associated with the trigger, affecting future incident workflow executions. this operation cannot be undone, so it should be used with caution to avoid disrupting critical incident management processes.
</Accordion>

<Accordion title="Delete integration from event orchestration">
  Removes a specific integration from an event orchestration in pagerduty. this endpoint is used to disconnect a particular tool or service from the event orchestration setup, effectively stopping it from triggering or modifying incidents within that orchestration. it's particularly useful when you need to retire an old integration or reconfigure your event management workflow. be cautious when using this endpoint, as deleting an integration is irreversible and may impact your incident response processes if not properly planned.
</Accordion>

<Accordion title="Delete service rule by id">
  Deletes a specific rule from a pagerduty service. this endpoint is used to permanently remove a rule that defines conditions for incident creation or automation within a particular service. it should be used when you need to eliminate an outdated, incorrect, or no longer needed rule from your service configuration. the operation cannot be undone, so use it with caution. this endpoint does not return the deleted rule's details; it only confirms the successful deletion.
</Accordion>

<Accordion title="Delete ruleset by id">
  Deletes a specific ruleset from the pagerduty system based on the provided id. this endpoint should be used when you need to remove an existing ruleset, which may be necessary during incident management reconfiguration or when cleaning up obsolete rulesets. the deletion is permanent and cannot be undone, so use this endpoint with caution. it's important to note that deleting a ruleset will affect the incident routing and escalation policies associated with it, potentially impacting your organization's incident response workflow.
</Accordion>

<Accordion title="Delete tag by id">
  Deletes a specific tag from the pagerduty system based on its unique identifier. this endpoint should be used when you need to remove a tag that is no longer relevant or necessary for categorizing incidents, services, or other resources in pagerduty. it's important to note that deleting a tag will remove it from all associated resources, which could impact filtering and organization within the pagerduty platform. this operation is irreversible, so it should be used with caution. the endpoint does not return the deleted tag's information, so if you need to reference the tag details, you should retrieve them before deletion.
</Accordion>

<Accordion title="Delete service by id">
  Deletes a specific service from the pagerduty account. this endpoint should be used when you need to permanently remove a service that is no longer required or active. it's important to note that this operation is irreversible and will delete all associated incidents, alerts, and integrations for the specified service. use this endpoint with caution, as it can impact your incident management workflow. before deletion, ensure that the service is no longer needed and that all relevant data has been backed up if necessary.
</Accordion>

<Accordion title="Create or update status page postmortem">
  Creates or updates a postmortem for a specific status page post in pagerduty. this endpoint allows you to add detailed analysis and insights about an incident after its resolution. the postmortem can include rich-text content and offers the option to notify subscribers. use this when you need to provide a comprehensive review of an incident, its root causes, and lessons learned. it's particularly useful for maintaining transparency and improving incident response processes. note that the postmortem is limited to 10,000 characters and is always associated with an existing status page post.
</Accordion>

<Accordion title="Delete team by id">
  Deletes a specific team from the pagerduty system based on the provided team id. this endpoint should be used when you need to remove a team that is no longer required in your incident management structure. it's important to note that deleting a team is a permanent action and cannot be undone. before deletion, ensure that all associated users, schedules, and escalation policies have been properly reassigned or removed to prevent disruption to your incident management workflows. this operation does not delete the users within the team; it only removes the team structure itself.
</Accordion>

<Accordion title="Delete subscription from status page">
  Deletes a specific subscription associated with a pagerduty status page. this endpoint is used to remove a subscription, effectively stopping notifications or updates related to the status page for the subscribed entity. it should be used when a user or system no longer needs to receive alerts or information about a particular status page. this operation is permanent and cannot be undone, so it should be used with caution. the endpoint requires both the status page id and the specific subscription id to ensure precise removal of the intended subscription.
</Accordion>

<Accordion title="Delete cache variable for event">
  Deletes a specific cache variable associated with an event orchestration in pagerduty. this endpoint is used to remove temporary data storage that was previously set up for use in event orchestration workflows. it should be used when you need to clean up or remove outdated cache variables that are no longer needed in your event management process. this operation is permanent and cannot be undone, so it should be used with caution. the endpoint requires both the event orchestration id and the specific cache variable id to ensure precise removal of the intended data.
</Accordion>

<Accordion title="Delete status page postmortem">
  This endpoint allows you to delete a postmortem associated with a specific post on a pagerduty status page. it is used to remove the detailed analysis and lessons learned from an incident after it has been resolved and documented. this action is permanent and should be used with caution, as it will remove valuable information about past incidents. the endpoint is particularly useful for maintaining the relevance of status page content, removing outdated postmortems, or correcting information that should not have been published. it's important to note that this operation cannot be undone, so it's recommended to have a backup of the postmortem content before deletion if retention of this information is necessary for internal records.
</Accordion>

<Accordion title="Delete cache variable from service">
  This endpoint deletes a specific cache variable associated with a service in pagerduty's event orchestration system. it is used to remove temporary data that is no longer needed, helping to maintain system efficiency. the endpoint should be used when you want to permanently remove a cache variable from a particular service, such as when the variable is obsolete or to free up resources. it's important to note that this action is irreversible, and once deleted, the cache variable cannot be recovered. use this endpoint with caution to avoid accidentally removing critical data used in event orchestrations.
</Accordion>

<Accordion title="Delete rule from ruleset by id">
  Deletes a specific rule from a ruleset in pagerduty's incident management platform. this endpoint allows users to remove individual event rules, providing flexibility in managing and updating rulesets. it should be used when you need to eliminate an outdated, unnecessary, or incorrect rule from a ruleset. the operation is permanent and cannot be undone, so caution should be exercised when using this endpoint. it's important to note that deleting a rule may affect the event routing and actions defined in the ruleset, potentially impacting incident management workflows.
</Accordion>

<Accordion title="Delete status update notification rule">
  Deletes a specific status update notification rule associated with a user in the pagerduty system. this endpoint allows administrators or users with appropriate permissions to remove custom notification rules for status updates, helping to manage and streamline the user's notification preferences. it should be used when a particular status update notification rule is no longer needed or requires removal from the user's settings. the operation is irreversible, so caution should be exercised when invoking this endpoint. it's important to note that this endpoint only removes the specified rule and does not affect other notification rules or user settings.
</Accordion>

<Accordion title="Create workflow integration connection">
  Create a new workflow integration connection. scoped oauth requires: `workflow integrations:connections.write`
</Accordion>

<Accordion title="Create or update statuspage post update information">
  Creates or updates a post update on a specific pagerduty status page. this endpoint allows you to add new information or modify existing updates related to an incident or maintenance event. use this when you need to communicate changes in status, provide additional details, or update the severity of an ongoing situation. the post update can include a custom message, current status, severity level, and list of impacted services. you can also control whether subscribers should be notified and optionally schedule future updates. this tool is essential for maintaining clear and timely communication with stakeholders during incidents or planned maintenance periods. note that this endpoint does not create new status page posts; it only adds updates to existing posts.
</Accordion>

<Accordion title="Delete custom field by field id">
  Deletes a specific custom field from incidents in pagerduty. this endpoint allows users to remove a custom field that is no longer needed or relevant for incident management. it should be used when you want to permanently delete a custom field from all incidents, both existing and future. the operation is irreversible, so caution should be exercised when using this endpoint. it's important to note that this action will remove the specified custom field and its associated data from all incidents, which could impact reporting and analysis based on that field.
</Accordion>

<Accordion title="Delete team escalation policy">
  This endpoint removes an escalation policy association from a specific team in pagerduty. it is used to update team configurations by disassociating an escalation policy that is no longer needed or relevant for the team's incident management process. the operation is irreversible and should be used with caution, as it may affect the team's incident response workflow. this endpoint is particularly useful when reorganizing team responsibilities or during cleanup of outdated escalation policies. it does not delete the escalation policy itself, but only removes its association with the specified team.
</Accordion>

<Accordion title="Delete user session by id">
  Deletes all active sessions for a specified user in the pagerduty system. this endpoint is used to forcibly log out a user from all devices and applications where they might be currently authenticated. it's particularly useful for security purposes, such as when a user's credentials may have been compromised, or when offboarding an employee. the operation is irreversible and will require the user to re-authenticate on all devices. use with caution as it may disrupt the user's ongoing work if not coordinated properly.
</Accordion>

<Accordion title="Delete user notification rule">
  Deletes a specific notification rule for a user in pagerduty. this endpoint allows administrators or users with appropriate permissions to remove custom notification rules, modifying how and when a user receives alerts about incidents. it should be used when updating a user's notification preferences or when a specific notification rule is no longer needed. the deletion is permanent and cannot be undone, so caution should be exercised when using this endpoint. it's important to note that this action does not affect the user's default notification rules or their overall ability to receive notifications; it only removes the specified custom rule.
</Accordion>

<Accordion title="Delete user contact method">
  Deletes a specific contact method associated with a user in pagerduty. this endpoint should be used when you need to remove an outdated or unnecessary contact method from a user's profile. it permanently removes the specified contact method, so use with caution. this operation cannot be undone. ensure that the user has at least one remaining contact method after deletion to maintain their ability to receive notifications. this endpoint is particularly useful for maintaining up-to-date user profiles and streamlining communication channels.
</Accordion>

<Accordion title="Create incident record">
  Creates a new incident in pagerduty with specified details and assignments. use this endpoint when an event requires immediate attention from on-call teams. it supports comprehensive incident documentation, including priority, urgency, and conference bridge information. the 'incident key' parameter helps prevent duplicate incidents, crucial for maintaining a clean incident list.
</Accordion>

<Accordion title="Create response play for incidents">
  Creates a new response play in pagerduty, which is a predefined set of actions to be executed in response to an incident. this endpoint allows you to configure automated responses, including adding subscribers, assigning responders, setting up conference details, and defining how the response play can be triggered. use this when you want to standardize and automate your incident management process, ensuring consistent and efficient responses to different types of incidents. the response play can be set to run automatically for specific services or be manually triggered by team members or responders, depending on the configuration. this tool is particularly useful for creating templated responses for common incident types or for implementing best practices across your organization's incident management workflow.
</Accordion>

<Accordion title="Delete team from automation action">
  This endpoint removes a specific team's access to an automation action in pagerduty. it's used to revoke permissions when a team no longer needs to use or should not have access to a particular automation action. this operation is permanent and cannot be undone through this endpoint. it should be used carefully, as it will immediately prevent the specified team from executing the automation action. this endpoint is particularly useful for managing access control and ensuring that only authorized teams can perform certain automated tasks.
</Accordion>

<Accordion title="Delete user from team by id">
  This endpoint removes a specific user from a designated team within the pagerduty incident management platform. it is used to update team compositions by disassociating a user from a particular team, which affects the user's involvement in that team's incident responses and escalation policies. this operation is particularly useful when restructuring teams, offboarding employees, or adjusting user roles and responsibilities. the endpoint requires both the team's unique identifier and the user's unique identifier to ensure precise user-team disassociation. it's important to note that this action does not delete the user from the pagerduty account; it only removes their association with the specified team. use this endpoint cautiously, as it immediately affects the user's ability to receive and respond to incidents related to the team.
</Accordion>

<Accordion title="Delete maintenance window by id">
  Deletes a specific maintenance window in pagerduty's incident management system. this endpoint is used to permanently remove a scheduled maintenance window, effectively re-enabling any services and integrations that were temporarily disabled during the maintenance period. it should be used when a maintenance window is no longer needed or was created in error. once deleted, the maintenance window cannot be recovered, so caution should be exercised when using this endpoint. this operation is particularly useful for cleaning up obsolete maintenance windows or adjusting scheduled maintenance plans.
</Accordion>

<Accordion title="Delete escalation policy by id">
  Permanently removes a specific escalation policy from the pagerduty system. this endpoint should be used when an escalation policy is no longer needed or has become obsolete. once deleted, the escalation policy cannot be recovered, and any services or incidents associated with it will need to be reassigned. exercise caution when using this endpoint, as it will impact incident routing and may affect your team's ability to respond to alerts if not properly managed. it's recommended to review and update any dependent services before deleting an escalation policy.
</Accordion>

<Accordion title="Delete workflow integration connection">
  Delete a workflow integration connection. scoped oauth requires: `workflow integrations:connections.write`
</Accordion>

<Accordion title="Delete webhook subscription by id">
  Deletes a specific webhook subscription from your pagerduty account. this endpoint should be used when you want to stop receiving notifications for a particular webhook subscription, such as when the integration is no longer needed or when updating your notification preferences. once deleted, the webhook subscription will immediately cease to function, and you will no longer receive notifications for the events it was configured to monitor. this action is irreversible, so use it with caution. if you need to temporarily disable notifications, consider using other management options instead of deletion.
</Accordion>

<Accordion title="Delete account subscription by id">
  Deletes the account subscription associated with a specific business service in pagerduty. this endpoint is used to terminate the subscription or billing relationship between a business service and the account. it should be used when you need to discontinue the subscription for a particular business service, such as when the service is no longer needed or when restructuring your pagerduty setup. this action is irreversible, so it should be used with caution. the endpoint does not return any specific data upon successful deletion, likely providing only a success status code.
</Accordion>

<Accordion title="Delete user session by type">
  This endpoint deletes a specific user session in pagerduty. it is used to forcibly terminate an active session for a given user, effectively logging them out from a particular device or application. this operation is crucial for maintaining security, especially when you need to revoke access immediately, such as when a device is lost or stolen, or when suspicious activity is detected. the endpoint requires the user id, session type, and specific session id to accurately target and remove the desired session. it should be used cautiously as it will immediately terminate the user's access without warning.
</Accordion>

<Accordion title="Enable extension by id">
  Enables a specific extension in the pagerduty system. this endpoint is used to activate an extension that has been previously configured but is currently inactive. it allows users to turn on additional functionalities or integrations within their pagerduty account. the extension is identified by its unique id, which must be provided in the request path. this action is typically used when setting up new integrations, reactivating temporarily disabled features, or as part of automated workflows for managing pagerduty configurations. note that enabling an extension may have immediate effects on the account's behavior, such as allowing new types of alerts or activating connections with external services.
</Accordion>

<Accordion title="Delete runner team association">
  This endpoint removes a team's association from a specific automation action runner in pagerduty. it is used to revoke a team's access to execute or manage tasks on a particular runner. the operation is permanent and should be used when you no longer want a team to have access to the runner's capabilities. this action is typically performed for security reasons, organizational changes, or when refining access control within your pagerduty environment. note that this endpoint only removes the association; it does not delete the runner or the team themselves.
</Accordion>

<Accordion title="Disassociate service dependencies">
  This endpoint disassociates service dependencies in pagerduty by deleting specified relationships between supporting and dependent services. it allows for the removal of multiple service dependencies in a single api call, enabling efficient management of service hierarchies and relationships within the pagerduty platform. the endpoint should be used when restructuring service dependencies, removing obsolete relationships, or updating the service topology. it's important to note that this operation is irreversible and will immediately affect the dependency structure of the services involved.
</Accordion>

<Accordion title="Enable webhook subscription by id">
  Activates a specific webhook subscription in pagerduty, enabling the system to send notifications for the events configured in that subscription. this endpoint should be used when you want to start receiving webhook notifications after creating or previously disabling a subscription. it's particularly useful for managing notification flows dynamically, such as during maintenance periods or when integrating new systems. note that this operation only affects the specified subscription and does not modify its configuration or event filters.
</Accordion>

<Accordion title="Edit webhook subscription by id">
  The updatewebhooksubscription endpoint allows you to modify an existing webhook subscription in pagerduty. this put method enables users to update the events they want to be notified about, change the filter criteria for triggering notifications, update the subscription's description, and toggle its active state. it's particularly useful for adjusting notification preferences as your incident management needs evolve. the endpoint requires specifying the webhook subscription id in the url path and accepts a json body with the updated subscription details. note that while you can update multiple aspects of the subscription, you must provide at least the 'events' array in your request. be cautious when updating filters, as this can significantly change which incidents trigger notifications.
</Accordion>

<Accordion title="Execute response play by id">
  Executes a predefined response play for a specific incident in pagerduty. this endpoint allows you to trigger a sequence of automated actions designed to manage and respond to the given incident. it's useful for standardizing and streamlining your incident response process, ensuring consistent handling of similar incidents. the endpoint requires you to specify the incident for which the response play should be run, using the incident's unique identifier. note that the response play itself is identified by the id in the url path, not in the request body.
</Accordion>

<Accordion title="Delete user by id">
  Deletes a specific user from the pagerduty system using their unique identifier. this endpoint should be used when you need to permanently remove a user's account, such as when an employee leaves the organization or no longer requires access to the incident management system. it's important to note that deleting a user is irreversible and will remove all associated data, including their contact information, notification rules, and incident history. before deletion, ensure that any ongoing incidents or schedules involving this user are reassigned to prevent disruptions in incident management workflows. this operation cannot be undone, so it should be used with caution and only when absolutely necessary.
</Accordion>

<Accordion title="Delete addon by id">
  Deletes a specific add-on from the pagerduty account using its unique identifier. this endpoint should be used when you want to remove an integration or extension that is no longer needed or active in your pagerduty setup. it's important to note that this action is irreversible, and once an add-on is deleted, it cannot be recovered without re-adding it. use this endpoint with caution, as removing an add-on may impact any automated workflows or integrations that depend on it.
</Accordion>

<Accordion title="Fetch custom incident field by id">
  Retrieves detailed information about a specific custom field associated with incidents in pagerduty. this endpoint allows users to fetch the configuration and attributes of a custom field by providing its unique identifier. it's useful for verifying custom field settings, understanding the structure of additional data points on incidents, or preparing to update a custom field. the endpoint should be used when detailed information about a particular custom field is needed, such as its name, data type, or any predefined options. note that this endpoint only provides information about the custom field itself, not the values assigned to incidents.
</Accordion>

<Accordion title="Delete template by id">
  Deletes a specific template from the pagerduty account. this endpoint is used to permanently remove a template configuration, which can be useful for cleaning up outdated or unnecessary incident response plans. once deleted, the template cannot be recovered, so use this operation with caution. it should be used when you no longer need a particular template for incident management or when you want to replace an old template with a new one. this operation does not affect any ongoing incidents that may have been created using the template.
</Accordion>

<Accordion title="Delete schedule by id">
  The deleteschedule endpoint removes a specific schedule from the pagerduty system. it is used to delete outdated or unnecessary on-call schedules, helping to maintain an organized and efficient incident management workflow. this operation is permanent and cannot be undone, so it should be used with caution. the endpoint is particularly useful when restructuring team rotations or when a project or team associated with the schedule is no longer active. it's important to note that deleting a schedule does not affect any historical data or past incidents associated with it, but it will prevent the schedule from being used in future incident assignments.
</Accordion>

<Accordion title="Create incident workflow">
  This endpoint creates a new incident workflow in pagerduty, allowing users to define a series of automated steps to be executed during incident response. it enables the setup of complex, multi-step processes that can include actions like sending notifications, updating statuses, or triggering other integrated systems. the workflow creation is highly customizable, supporting various action types and nested workflows, making it suitable for diverse incident management scenarios across different team structures and response protocols.
</Accordion>

<Accordion title="Create schedule overrides configuration">
  Creates one or more overrides for a specific schedule in pagerduty. this endpoint allows you to temporarily modify the on-call schedule by assigning different users for specific time periods. it's useful for handling planned absences, shift swaps, or special coverage requirements without permanently altering the regular schedule. the overrides are applied to the schedule identified by the \{id} parameter in the endpoint url. multiple overrides can be created in a single request, enabling efficient batch modifications to the schedule. each override specifies a start time, end time, and the user who will be on call during that period. the endpoint should be used when temporary changes to the on-call rotation are needed. it does not modify the underlying schedule configuration.
</Accordion>

<Accordion title="Fetch cache variable for event orchestration">
  Retrieves detailed information about a specific cache variable within an event orchestration in pagerduty. this endpoint allows users to fetch the current state and configuration of a cache variable, which is used to store temporary data for optimizing event orchestration performance. it's particularly useful when you need to inspect or debug the cached data being used in your event orchestration workflows. the endpoint should be used when you need to verify the contents of a specific cache variable or when troubleshooting issues related to event orchestration data caching. note that this endpoint only provides read access to the cache variable and cannot be used to modify its contents.
</Accordion>

<Accordion title="Delete event by id">
  Deletes a specific event orchestration from the pagerduty system. this endpoint should be used when you want to permanently remove an event orchestration configuration, including all its associated rules and routing logic. it's important to note that this action is irreversible, and once an event orchestration is deleted, it cannot be recovered. before using this endpoint, ensure that the event orchestration is no longer needed and that its deletion won't disrupt any critical event routing or automation processes in your pagerduty setup. this endpoint is particularly useful during cleanup operations or when restructuring your event management workflow.
</Accordion>

<Accordion title="Fetch incident analytics by id">
  Retrieves raw analytics data for a specific incident in pagerduty. this endpoint provides unprocessed incident information, allowing for detailed analysis and custom reporting. it should be used when in-depth, granular data about a particular incident is needed, such as for investigating complex issues or generating custom analytics. the endpoint returns comprehensive incident details, which may include timestamps, status changes, assignee information, and other relevant metrics. however, it does not provide pre-analyzed or aggregated data; users will need to process the raw data themselves for specific insights.
</Accordion>

<Accordion title="Delete oncall handoff notification rule">
  This endpoint deletes a specific on-call handoff notification rule for a given user in pagerduty. it is used to remove custom notification settings for when on-call responsibilities are transferred between team members. this operation is permanent and cannot be undone, so it should be used with caution. the endpoint is particularly useful for maintaining clean and up-to-date notification configurations, especially when certain handoff rules are no longer needed or have become obsolete. it requires both the user's id and the specific rule id to ensure precise targeting of the rule to be deleted.
</Accordion>

<Accordion title="Delete alert grouping setting">
  This endpoint allows you to delete specific alert grouping settings in pagerduty. it is used to remove outdated or unnecessary configurations that determine how alerts are grouped into incidents. the deletion is permanent and cannot be undone, so it should be used with caution. this operation is particularly useful when updating your incident management strategy or cleaning up unused configurations to maintain an efficient alert grouping system. note that deleting these settings may affect how future alerts are grouped, potentially impacting your team's incident response workflow.
</Accordion>

<Accordion title="Create service event rule">
  Creates a new event rule for a specific service in pagerduty. this endpoint allows you to define complex conditions and actions for handling incoming events, enabling automated incident management and alert routing. use this when you need to set up custom logic for processing events, such as setting priorities, annotating incidents, or suppressing alerts based on specific criteria. the rule's position in the evaluation order can be specified, and various time-based conditions can be applied to control when the rule is active. this endpoint is crucial for fine-tuning your incident response workflow and reducing alert noise.
</Accordion>

<Accordion title="Fetch escalation polices list">
  Retrieves a list of escalation policies configured in the pagerduty account. this endpoint allows users to access detailed information about how incidents are escalated within their organization, including the sequence of notifications and assignments for different teams or individuals. it's particularly useful for reviewing and auditing the incident response process, ensuring that critical alerts are properly routed and escalated. the endpoint provides a comprehensive view of all escalation policies, which is essential for maintaining an effective incident management strategy. however, it does not modify any existing policies or create new ones; it's purely for retrieval and review purposes.
</Accordion>

<Accordion title="Delete extension by id">
  Deletes a specific extension from the pagerduty service. this endpoint should be used when you want to remove an additional feature or integration that has been previously added to your pagerduty account. it's particularly useful for cleaning up obsolete integrations or disabling unwanted functionalities. note that deleting an extension is permanent and cannot be undone, so use this endpoint with caution. this operation doesn't affect the core pagerduty service, only the specified extension.
</Accordion>

<Accordion title="Fetch outlier incident by id">
  Retrieves detailed information about an outlier incident associated with a specific incident in pagerduty. this endpoint is used to gather insights on incidents that deviate significantly from normal patterns, helping teams identify and analyze unusual or potentially critical issues. it should be used when investigating anomalies in incident patterns or when conducting post-incident reviews. the endpoint provides specific data about the outlier incident, which can be crucial for understanding unique characteristics or severity of the issue compared to typical incidents.
</Accordion>

<Accordion title="Create incident workflow instance">
  Creates a new instance of an incident workflow for a specific incident in pagerduty. this endpoint allows you to initiate a predefined workflow process for managing and resolving an ongoing incident. it links the workflow instance to a particular incident, enabling automated and standardized incident response procedures. use this when you need to start a structured response process for a newly created or existing incident. the endpoint is particularly useful for ensuring consistent handling of incidents across your organization and for tracking the progress of incident resolution through defined stages.
</Accordion>

<Accordion title="Fetch post update status">
  Retrieves detailed information about a specific post update on a pagerduty status page. this endpoint allows you to fetch the content and metadata of a particular update made to a post, providing insight into the chronological changes and communications related to an incident or maintenance event. use this when you need to review or display the exact content of a specific update, such as for auditing purposes or to provide detailed information to stakeholders. the endpoint requires the unique identifiers for the status page, the post, and the specific update, ensuring precise retrieval of the desired information. it's particularly useful for tracking the evolution of an incident's communication or for analyzing the effectiveness of status updates over time.
</Accordion>

<Accordion title="Fetch priorities list">
  Retrieves a list of existing priorities in the pagerduty system, ordered from most severe to least severe. this endpoint should be used when you need to obtain information about the current priority levels configured in your pagerduty account. it's particularly useful for integrations that need to reference or display priority information, or for administrators who want to review the existing priority structure. the endpoint provides a read-only view of priorities and does not allow for creation, modification, or deletion of priority levels. keep in mind that this api call is subject to rate limiting, so it should not be called excessively in short periods.
</Accordion>

<Accordion title="Fetch runner teams integration">
  Retrieves a list of teams associated with a specific automation action runner in pagerduty. this endpoint allows users to identify which teams have access to or are responsible for a particular runner, facilitating better management and organization of automation resources. it's particularly useful for administrators who need to audit runner permissions or when planning to modify team access to automation capabilities. the endpoint returns team information related to the specified runner only and does not provide details about the runner itself or its automation actions.
</Accordion>

<Accordion title="Fetch related change events for incident">
  Retrieves a list of change events related to a specific incident in pagerduty. this endpoint is used to gather contextual information about changes or updates associated with an incident, which can be crucial for understanding its progression and resolution. it provides insights into actions taken, system modifications, or other relevant events that occurred in connection with the incident. use this endpoint when investigating incident timelines, auditing response actions, or compiling comprehensive incident reports. note that this endpoint only returns change events directly linked to the specified incident and does not provide general incident details or unrelated events.
</Accordion>

<Accordion title="Fetch related incidents by id">
  Retrieves a list of incidents that are potentially related to a specified incident in pagerduty. this endpoint utilizes machine learning algorithms to identify and return incidents that may be connected or similar to the given incident. it's particularly useful for incident management teams to gain a broader context of ongoing issues, identify patterns, and potentially streamline resolution processes. the endpoint should be used when investigating an incident to discover any correlated problems or when trying to understand the wider impact of a particular issue across the system. it does not modify any incident data and is intended for informational purposes only.
</Accordion>

<Accordion title="Fetch event orchestrations">
  Retrieves a list of event orchestrations configured in the pagerduty account. event orchestrations are used to manage and automate the routing and handling of events and incidents. this endpoint allows you to fetch details about existing orchestrations, which can be useful for auditing, reporting, or managing your incident response workflows. the response typically includes information such as orchestration names, associated routing keys, and configured rules. use this endpoint when you need to review or list the current event orchestrations in your pagerduty setup. note that this endpoint does not provide real-time event data or incident details, only the configuration of the orchestrations themselves.
</Accordion>

<Accordion title="Delete schedule override by id">
  This endpoint deletes a specific override from a pagerduty schedule. it allows users to remove temporary changes made to the regular schedule, reverting it back to its original state. this operation is useful for canceling previously set overrides that are no longer needed, such as temporary shift changes or one-time schedule adjustments. the deletion is permanent and cannot be undone, so it should be used with caution. this endpoint is particularly helpful for maintaining schedule integrity and ensuring that only current and relevant overrides remain active.
</Accordion>

<Accordion title="Fetch incident list">
  Retrieves a list of incidents from pagerduty based on specified criteria. this endpoint allows users to fetch multiple incidents, making it useful for incident management, reporting, and analysis. it supports filtering by status and date range, as well as pagination for handling large result sets. the endpoint is particularly valuable for obtaining an overview of recent or ongoing incidents, tracking incident trends, or integrating pagerduty incident data into external systems or dashboards. note that while this endpoint provides a summary of incidents, it may not include full details for each incident; separate api calls might be necessary to fetch comprehensive information for individual incidents.
</Accordion>

<Accordion title="Delete field option">
  This endpoint deletes a specific field option from a custom field in pagerduty's incident management system. it allows you to remove predefined options that are no longer needed or relevant for incident categorization or data collection. use this endpoint when you want to update the available options for a custom field by removing outdated or unnecessary choices. be cautious when using this endpoint, as deleting a field option may impact existing incidents that use this option and could affect reporting or automation based on these custom fields. this operation cannot be undone, so it's advisable to have a backup of your custom field configuration before making changes.
</Accordion>

<Accordion title="Create integration for orchestration">
  Creates a new integration within an existing event orchestration in pagerduty. this endpoint allows users to set up connections between pagerduty and external systems or services, enabling automated event management and incident response. it should be used when adding a new integration to an event orchestration, such as connecting a monitoring tool or alerting system. the endpoint requires minimal information, focusing on the integration's label for identification purposes. note that this endpoint only creates the integration; additional configuration may be required in the pagerduty interface or through other api calls to fully set up the integration's functionality.
</Accordion>

<Accordion title="Delete all oauth delegations">
  Delete all oauth delegations as per provided query parameters. an oauth delegation represents an instance of a user or account's authorization to an app (via oauth) to access their pagerduty account. common apps include the pagerduty mobile app, slack, microsoft teams, and third-party apps. deleting an oauth delegation will revoke that instance of an app's access to that user or account. to grant access again, reauthorization/reauthentication may be required. at this time, this endpoint only supports deleting mobile app oauth delegations for a given user. this is equivalent to signing users out of the mobile app. this is an asynchronous api, the deletion request itself will be processed within 24 hours. scoped oauth requires: `oauth delegations.write`
</Accordion>

<Accordion title="Create integration for service">
  This endpoint creates a new integration for a specific pagerduty service. it allows you to set up various types of integrations, including email-based and events api v2 integrations. the primary use case is to establish new channels for incident creation and management within a pagerduty service. this tool is particularly useful when setting up automated alerting systems or connecting external monitoring tools to pagerduty. the integration type and configuration options determine how incidents are triggered and processed. note that this endpoint focuses on creation only and does not handle updating or deleting existing integrations.
</Accordion>

<Accordion title="Create maintenance window object">
  Creates a new maintenance window in pagerduty, allowing you to schedule periods of planned maintenance for specific services. during a maintenance window, incidents are not created for the affected services, preventing unnecessary alerts and notifications. this endpoint is useful for planning and executing system upgrades, patches, or other maintenance tasks without triggering false alarms. the maintenance window has a defined start and end time, can be associated with multiple services, and optionally linked to specific teams. it's important to note that while incidents are suppressed during the maintenance window, underlying issues are still logged and can be reviewed later if needed.
</Accordion>

<Accordion title="Create statuspage subscription">
  Creates a new subscription for a pagerduty status page. this endpoint allows users to set up notifications for specific status pages or components within those pages. it's used to keep subscribers informed about updates, incidents, or changes to the monitored services. the subscription can be configured for either email or webhook notifications, allowing for flexible integration with various notification systems. this tool should be used when setting up new monitoring or alert systems, or when adding new stakeholders who need to be kept informed about service status. it's particularly useful for devops teams, it managers, or customer support teams who need real-time updates on service health. note that this endpoint only creates the subscription; it does not manage or trigger the actual notifications.
</Accordion>

<Accordion title="Create new schedule layer">
  Creates a new on-call schedule in pagerduty, defining rotation patterns for team members. this endpoint allows you to set up complex schedules with multiple layers, each having its own rotation pattern, user assignments, and time restrictions. use it to establish new on-call rotations, manage team availability, and ensure continuous incident response coverage. the created schedule can be used in escalation policies to determine who gets notified during incidents. note that while you can create a basic schedule structure, some elements like rendered schedule entries are read-only and will be populated by the system after creation.
</Accordion>

<Accordion title="Delete automation actions runner by id">
  Deletes a specific automation runner from the pagerduty system. this endpoint is used to permanently remove an automation runner, which is responsible for executing automated tasks and workflows. it should be used when an automation runner is no longer needed or needs to be replaced. once deleted, all associated automated actions and schedules tied to this runner will be affected. exercise caution when using this endpoint, as the deletion is irreversible and may impact existing automation setups.
</Accordion>

<Accordion title="Delete post from status page">
  This endpoint deletes a specific post from a pagerduty status page. it is used to remove outdated or irrelevant information from a status page, helping to maintain clear and accurate communication with users about service status. the operation is irreversible, so it should be used with caution. this endpoint is particularly useful for cleaning up resolved incidents or removing erroneous updates. it does not provide any ability to modify or retrieve post content; it only removes the specified post entirely from the status page.
</Accordion>

<Accordion title="Create new service">
  Creates a new service in pagerduty, which is a key component for managing incidents and alerts. this endpoint allows you to set up a service with various configurations including escalation policies, incident urgency rules, support hours, and alert grouping parameters. use this when you need to add a new monitored service to your pagerduty account, such as a new application, infrastructure component, or business process. the created service will be used as a target for incoming alerts and incidents, helping to organize and streamline your incident management process. note that some advanced features like intelligent alert grouping may depend on your pagerduty plan.
</Accordion>

<Accordion title="Delete post update by id">
  This endpoint deletes a specific post update from a status page post in pagerduty. it allows users to remove outdated or incorrect information from a status page, ensuring that only relevant and accurate updates are displayed. the endpoint should be used when an organization needs to retract or remove a previously published update on their status page. it's important to note that this action is permanent and cannot be undone, so it should be used with caution. this endpoint is particularly useful for maintaining the accuracy and relevance of status page communications during incident management or scheduled maintenance periods.
</Accordion>

<Accordion title="Delete automation action by id">
  Deletes a specific automation action from the pagerduty system. this endpoint is used to permanently remove an automation action, which includes any associated scripts or jobs in runbook automation. it should be used when an automation action is no longer needed or has become obsolete. once deleted, the action cannot be recovered, so use this endpoint with caution. this operation is typically performed by administrators or users with appropriate permissions to manage automation actions.
</Accordion>

<Accordion title="Create user notification rule">
  Creates a new notification rule for a specific user in pagerduty. this endpoint allows you to define how and when a user should be notified about assigned incidents. you can specify the delay before notification, the method of contact, and the urgency level of incidents that trigger this rule. this is particularly useful for customizing alert behaviors for different users based on their preferences or role within the organization. the rule created will be associated with the user identified by the provided id in the url path.
</Accordion>

<Accordion title="Create status update template">
  Creates a new template in pagerduty for standardized status updates. this endpoint allows users to define customizable templates for various notification types, including emails and short messages. it's primarily used to streamline communication during incident management by providing consistent and pre-formatted status update messages. the template can include placeholders for dynamic content, allowing for personalized and context-specific notifications. this endpoint should be used when setting up new standardized communication formats for incident updates, but it's important to note that currently only 'status update' type templates are supported.
</Accordion>

<Accordion title="Delete automation action service by id">
  This endpoint removes a specific automation action from a particular service in pagerduty. it is used to disassociate an automated workflow or action from a service, effectively stopping that action from being triggered for incidents related to the specified service. this operation is useful when you need to update your incident management workflow or when an automated action is no longer relevant for a specific service. it's important to note that this endpoint only removes the association between the action and the service; it does not delete the automation action itself from the system. use this endpoint with caution, as removing an automation action from a service will immediately affect the incident response process for that service.
</Accordion>

<Accordion title="Create new team with details">
  Creates a new team within your pagerduty account. this endpoint allows you to establish a group of users with shared responsibilities, often used for organizing incident management and on-call schedules. use this when setting up a new department, project team, or any other group that needs to collaborate on incident responses. the created team can be configured as public or private, determining the level of access for non-members. note that while you can create the team structure with this call, you'll need separate api calls to add members or assign schedules to the team.
</Accordion>

<Accordion title="Create new tag in system">
  Creates a new tag in pagerduty for labeling and categorizing entities. this endpoint allows users to add a custom label to their pagerduty account, which can be used to organize and filter various resources such as incidents, services, or teams. the created tag can be subsequently assigned to relevant entities to improve organization and searchability within the pagerduty platform. use this endpoint when you need to introduce a new categorization or labeling scheme in your pagerduty setup. note that this endpoint only creates the tag; assigning it to specific entities would require separate api calls.
</Accordion>

<Accordion title="Create user object">
  Creates a new user in the pagerduty system with the specified attributes. this endpoint should be used when onboarding new team members or adding users to your pagerduty account. it allows you to set up essential user information, including name, email, role, and time zone preferences. the created user will have default contact methods and notification rules, which can be customized later. note that some fields like teams, contact methods, and notification rules cannot be set during user creation and must be managed separately. the endpoint requires at minimum a name, email, and user type, with several optional fields for further customization.
</Accordion>

<Accordion title="Get addons list">
  Retrieves a list of all addons associated with the pagerduty account. this endpoint allows users to view the additional features or integrations that have been added to enhance the platform's capabilities. it provides an overview of the current addons, which can include third-party services or custom extensions that extend the functionality of the core pagerduty system. this endpoint is useful for auditing the account's current addons, planning for potential new integrations, or managing existing ones. note that this endpoint only returns basic information about the addons and may not include detailed configuration settings for each addon.
</Accordion>

<Accordion title="Fetch user contact method">
  Retrieves detailed information about a specific contact method for a particular user in pagerduty. this endpoint allows you to fetch the configuration and settings of a single contact method, such as an email address, phone number, or push notification settings, associated with a user's account. it's useful for verifying or auditing user contact information, or when you need to display or update a specific contact method. the endpoint requires both the user id and the contact method id to pinpoint the exact resource. it does not modify any data and is safe for frequent calls, but should be used judiciously in high-volume scenarios to avoid hitting rate limits.
</Accordion>

<Accordion title="Get oauth delegations revocation requests status">
  Get the status of all oauth delegations revocation requests for this account, specifically how many requests are still pending. this endpoint is limited to account owners and admins. scoped oauth requires: `oauth delegations.read`
</Accordion>

<Accordion title="Get post from status page by id">
  Retrieves detailed information about a specific post on a pagerduty status page. this endpoint allows you to fetch the content, timestamp, and any associated metadata for a particular update or message that has been posted to a status page. it's particularly useful for retrieving historical updates about incidents, maintenance notices, or general service status communications. use this endpoint when you need to access or display the full details of a specific status update, such as when building a custom status page interface or integrating pagerduty status updates into another system. note that this endpoint only retrieves information for existing posts; it cannot be used to create, modify, or delete posts.
</Accordion>

<Accordion title="Fetch status pages">
  Retrieves a list of all status pages configured in the pagerduty account. status pages provide real-time information about the operational status of services, ongoing incidents, and planned maintenance. this endpoint should be used when you need to obtain an overview of all available status pages, which can be useful for monitoring, reporting, or integrating status information into other systems. the response will include details such as the status page id, name, and current state. note that this endpoint does not provide the actual content of each status page, but rather metadata about the pages themselves.
</Accordion>

<Accordion title="Get paused incident alerts">
  Retrieves alerts associated with paused incident reports in pagerduty. this endpoint allows users to fetch information about alerts that have been temporarily halted in the reporting process. it's useful for reviewing and managing incidents that have been paused, potentially for prioritization or during maintenance periods. the endpoint returns a list of alerts related to paused incident reports, which can help in assessing the current state of incident management and decision-making for further actions. note that this endpoint only provides information about paused alerts and does not include details about active or resolved incidents.
</Accordion>

<Accordion title="Get cache variables for service">
  Retrieves the cache variables associated with a specific service in pagerduty's event orchestration system. this endpoint allows you to access temporary storage data used within event orchestration workflows for the specified service. it's particularly useful for debugging, auditing, or analyzing the current state of event handling for a service. the retrieved cache variables can provide insights into how events are being processed and what data is being stored temporarily during orchestration. this endpoint should be used when you need to inspect or verify the cache variables for a particular service, which can be helpful in troubleshooting or optimizing event orchestration workflows.
</Accordion>

<Accordion title="Get business services priority thresholds">
  Retrieves the current priority threshold settings for all business services in pagerduty. this endpoint allows users to fetch the configured thresholds that determine incident prioritization and escalation for each business service. it should be used when auditing or reviewing the current priority configurations across the organization's services. the tool provides a comprehensive view of how incidents are categorized and escalated based on their severity for different business services. it does not allow modification of these thresholds; for changes, a separate update endpoint would be required.
</Accordion>

<Accordion title="Get response plays">
  Retrieves a list of response plays configured in the pagerduty account. response plays are predefined sets of actions that can be automatically executed when an incident occurs, helping to streamline and standardize incident response processes. this endpoint allows you to fetch and review existing response plays, which is useful for auditing, reporting, or integrating response play information into other systems. the list can be paginated and filtered using various parameters to manage large sets of response plays efficiently.
</Accordion>

<Accordion title="Get event orchestration cache variables">
  Retrieves the cache variables associated with a specific event orchestration in pagerduty. this endpoint allows you to access temporary data storage elements used during event orchestration processes, which are crucial for maintaining context and improving efficiency in incident management workflows. use this endpoint when you need to inspect or debug the current state of an event orchestration's cache variables, or when you want to retrieve stored information for further processing in your incident management pipeline. note that cache variables are temporary and may not persist indefinitely, so the retrieved data represents the current state at the time of the api call.
</Accordion>

<Accordion title="Get incident alert details">
  Retrieves detailed information about a specific alert associated with a particular incident in pagerduty. this endpoint is used when you need to access the properties and current state of an individual alert within the context of its parent incident. it's particularly useful for tracking the progression of an alert, understanding its current status, and gathering related metadata. the endpoint should be called when detailed information about a single alert is required, rather than for bulk operations or listing multiple alerts. note that this endpoint focuses on retrieving data and does not modify the alert or incident.
</Accordion>

<Accordion title="Get maintenance window by id">
  Retrieves detailed information about a specific maintenance window in pagerduty. this endpoint allows users to access the configuration, schedule, and status of a particular maintenance window using its unique identifier. it's useful for reviewing planned maintenance periods, verifying window settings, or checking the current status of a maintenance window. the endpoint should be used when detailed information about a single maintenance window is needed, rather than for listing all maintenance windows or creating new ones.
</Accordion>

<Accordion title="Get event orchestration by id">
  Retrieves detailed information about a specific event orchestration in pagerduty using its unique identifier. this endpoint allows users to fetch the configuration and settings of a particular event orchestration, which is crucial for understanding and analyzing how incidents are being managed and automated within the pagerduty system. it should be used when you need to review or audit the setup of an event orchestration, such as its routing rules, filters, and associated services. the endpoint provides a comprehensive view of the orchestration but does not modify any settings. keep in mind that access to this information may be restricted based on the user's permissions within the pagerduty account.
</Accordion>

<Accordion title="Fetch vendor list">
  Retrieves a list of vendors or third-party integrations available in the pagerduty platform. this endpoint allows users to access information about various services and tools that can be integrated with pagerduty for enhanced incident management and alerting capabilities. use this endpoint when you need to explore or review the available integrations, such as monitoring tools, ticketing systems, or communication platforms. the response likely includes details such as vendor names, integration types, and possibly configuration options. note that this endpoint does not provide real-time status of integrations or perform any actions on the integrations themselves.
</Accordion>

<Accordion title="Get automation action by id">
  Retrieves detailed information about a specific automation action in pagerduty's incident management platform. this endpoint allows users to fetch the configuration and attributes of a predefined automation action by its unique identifier. it's particularly useful when you need to review or audit the settings of an existing automation action, such as its triggers, conditions, or associated workflows. the endpoint should be used when detailed information about a single automation action is required, rather than for listing multiple actions. note that this endpoint only provides read access to the automation action details and cannot be used to modify the action.
</Accordion>

<Accordion title="Get business service subscribers by id">
  Retrieves a list of subscribers for a specific business service in pagerduty. this endpoint allows you to fetch all users or teams configured to receive notifications for incidents related to the specified business service. it's useful for auditing who is responsible for responding to issues within a particular service, or for managing notification settings at a service level. the endpoint returns read-only data and does not modify any configurations. use this when you need to review or verify the current subscriber list for a business service, such as during incident response planning or service ownership reviews.
</Accordion>

<Accordion title="Filter and aggregate incident metrics">
  Analyzes and aggregates incident metrics across teams in pagerduty, allowing for detailed filtering and customization of results. this endpoint is used to gain insights into incident patterns, team performance, and overall operational efficiency. it provides flexible options for data selection, time range specification, and result presentation, making it valuable for generating reports, identifying trends, and optimizing incident management processes. the endpoint is particularly useful for operational reviews, team performance assessments, and strategic planning in incident response.
</Accordion>

<Accordion title="Get webhook subscription by id">
  Retrieves detailed information about a specific webhook subscription in pagerduty. this endpoint allows you to fetch the configuration and status of a webhook subscription, including its delivery method, subscribed events, and any applied filters. use this when you need to review or verify the settings of an existing webhook subscription, such as checking which events it's configured to receive or confirming its current status. the endpoint provides a snapshot of the subscription's configuration but does not include historical data about past webhook deliveries or failures.
</Accordion>

<Accordion title="Get status page subscription">
  Retrieves detailed information about a specific subscription associated with a particular status page in pagerduty. this endpoint allows users to fetch subscription details such as the subscriber's contact information, notification preferences, and current subscription status. it should be used when you need to review or verify the details of an existing subscription for a status page. the endpoint is particularly useful for managing and auditing subscriber information, troubleshooting notification issues, or when updating subscription settings. note that this endpoint only provides read access to subscription data and cannot be used to modify or create new subscriptions.
</Accordion>

<Accordion title="Get teams associated with action id">
  Retrieves the list of teams associated with a specific automation action in pagerduty. this endpoint is useful for understanding which teams are responsible for or have access to a particular automated process in the incident management workflow. it can be used to audit team assignments, manage access control, or gather information for reporting purposes. the endpoint returns only the teams linked to the specified automation action and does not provide details about the action itself or other related resources.
</Accordion>

<Accordion title="Get cache variable by id">
  Retrieves detailed information about a specific cache variable associated with a particular service within an event orchestration in pagerduty. this endpoint allows you to access the current state and configuration of a cache variable, which can be crucial for understanding and troubleshooting event orchestration workflows. use this when you need to inspect or verify the settings of a cache variable for a given service, such as during debugging or auditing processes. the endpoint provides read-only access and does not allow modification of the cache variable. keep in mind that the response will only include information about the specified cache variable and will not provide a comprehensive view of all variables or the entire event orchestration configuration.
</Accordion>

<Accordion title="Get rule from ruleset by id">
  Retrieves detailed information about a specific rule within a pagerduty ruleset. this endpoint allows users to fetch the configuration and settings of an individual rule, which is essential for understanding how incidents are being automated and managed. it should be used when detailed information about a particular rule's conditions, actions, or other properties is needed. this endpoint is particularly useful for auditing ruleset configurations, troubleshooting automation issues, or preparing to update rule settings. it does not modify any data and is safe for frequent use in monitoring or dashboard applications. however, it will not provide an overview of all rules in a ruleset or allow for rule modifications.
</Accordion>

<Accordion title="Get team notification subscriptions">
  Retrieves the notification subscriptions for a specific team in pagerduty. this endpoint allows you to fetch detailed information about how a team is configured to receive notifications for various events and incidents. it's particularly useful for auditing a team's notification settings, understanding their alert preferences, and ensuring that the right people are notified at the right time. the endpoint should be used when you need to review or analyze a team's current notification setup, but it won't allow you to modify these settings directly. keep in mind that the response may include sensitive information about team members and their notification preferences, so use this endpoint judiciously and in compliance with your organization's data privacy policies.
</Accordion>

<Accordion title="Get template by id">
  Retrieves detailed information about a specific template in pagerduty by its unique identifier. this endpoint is used to access the configuration and settings of a pre-defined template, which can include incident response procedures, notification rules, and other standardized actions. it's particularly useful when you need to review or reference an existing template for incident management purposes. the endpoint returns comprehensive data about the template, but does not modify or create new templates.
</Accordion>

<Accordion title="Get team members by id">
  Retrieves a list of all members associated with a specific team in pagerduty. this endpoint is useful for obtaining detailed information about the composition of a team, including user ids, names, roles, and contact information of team members. it should be used when you need to review or audit team membership, update on-call rotations, or gather information for reporting purposes. the endpoint does not modify team membership; it only provides read access to the current team roster. keep in mind that the response may be paginated for teams with a large number of members.
</Accordion>

<Accordion title="Get automation action runner by id">
  Retrieves detailed information about a specific automation action runner in pagerduty. this endpoint allows users to fetch the configuration, status, and other relevant details of a runner by providing its unique identifier. it's particularly useful for monitoring the health and settings of individual runners, which are crucial components in pagerduty's automated incident response system. this tool should be used when you need to inspect or verify the properties of a specific runner, such as its connection status, associated scripts, or execution environment. it does not modify the runner's configuration or trigger any actions; it's purely for information retrieval.
</Accordion>

<Accordion title="Get escalation policy by id">
  Retrieves detailed information about a specific escalation policy in pagerduty. this endpoint allows you to fetch the complete configuration of an escalation policy, including its name, description, escalation rules, and associated services. use this when you need to review or audit an existing escalation policy's setup. it's particularly useful for understanding how incidents are being routed and escalated within your organization. this endpoint does not modify any data and is safe for frequent calls, but be mindful of rate limits. note that it only provides information for a single policy; to list multiple policies, you would need a different endpoint.
</Accordion>

<Accordion title="Get event orchestration integration">
  Retrieves detailed information about a specific integration associated with an event orchestration in pagerduty. this endpoint allows you to fetch the configuration and settings of a particular integration within the context of an event orchestration. use this when you need to inspect or verify the setup of an integration, such as its type, configuration parameters, or connection status. the endpoint is particularly useful for troubleshooting integration issues or when you need to review the current state of an integration as part of your incident management workflow. note that this endpoint only provides read access to the integration details and cannot be used to modify the integration.
</Accordion>

<Accordion title="Invoke automation action by id">
  Invokes a specific automation action in pagerduty, associating it with a particular incident. this endpoint allows you to trigger pre-defined automated tasks or workflows within the pagerduty incident management system. it's particularly useful for executing custom actions or scripts in response to specific incidents, enhancing the incident response process. the action is identified by its unique id, and the invocation must be linked to an existing incident through its incident id. this endpoint should be used when you need to programmatically execute automation actions as part of your incident management workflow or integration with other systems.
</Accordion>

<Accordion title="Install add on endpoint">
  This endpoint allows you to install a new add-on to your pagerduty account, enhancing its functionality with custom integrations. add-ons can be either full-page or incident-specific, providing additional context or tools within the pagerduty interface. use this endpoint when you want to integrate external resources or custom dashboards into your pagerduty workflow. the add-on must have a secure https source url and a unique name within your account. note that while you can install multiple add-ons, each must serve a distinct purpose and have a different name and source url.
</Accordion>

<Accordion title="Get the global orchestration for an event orchestration">
  Get the global orchestration for an event orchestration. global orchestration rules allows you to create a set of event rules. these rules evaluate against all events sent to an event orchestration. when a matching rule is found, it can modify and enhance the event and can route the event to another set of global rules within this orchestration for further processing. for more information see the [api concepts document](../../api-reference/zg9joji3ndc5nzc-api-concepts#event-orchestrations) scoped oauth requires: `event orchestrations.read`
</Accordion>

<Accordion title="Get workflow integration">
  Get details about a workflow integration. scoped oauth requires: `workflow integrations.read`
</Accordion>

<Accordion title="Get workflow integration connection">
  Get details about a workflow integration connection. scoped oauth requires: `workflow integrations:connections.read`
</Accordion>

<Accordion title="Get schedules">
  Retrieves a list of all schedules from your pagerduty account. this endpoint provides essential information about on-call rotations, helping teams manage and organize their incident response workflows. use this when you need to view all existing schedules, such as during schedule audits, team restructuring, or when setting up integrations that require schedule ids. the endpoint returns basic details for each schedule, which can be used to make further api calls for more specific information. note that this endpoint does not provide the full details of each schedule's rotation patterns; for that, you would need to make additional api calls using the schedule ids returned by this endpoint.
</Accordion>

<Accordion title="List incident status update subscribers">
  Retrieves a list of subscribers to status updates for a specific incident in pagerduty. this endpoint allows you to see all users or services that are currently subscribed to receive notifications about status changes for the given incident. it's useful for understanding who is being kept informed about the incident's progress. this tool should be used when you need to review or audit the notification list for an incident, ensuring that all necessary stakeholders are included. it does not modify the subscriber list; for adding or removing subscribers, separate endpoints would be required.
</Accordion>

<Accordion title="Get a field option on a custom field">
  Get a field option on a custom field \<!-- theme: warning --> > ### early access > this endpoint is in early access and may change at any time. you must pass in the x-early-access header to access it. scoped oauth requires: `custom fields.read`
</Accordion>

<Accordion title="List field options on a custom field">
  List field options for a custom field. custom fields (cf) are a feature which will allow customers to extend incidents with their own custom data, to provide additional context and support features such as customized filtering, search and analytics. custom fields can be applied to different incident types. \<!-- theme: warning --> > ### early access > this endpoint is in early access and may change at any time. you must pass in the x-early-access header to access it. scoped oauth requires: `custom fields.read`
</Accordion>

<Accordion title="Get automation action team by team id">
  Retrieves detailed information about a specific automation action's association with a particular team in pagerduty. this endpoint allows you to examine how an automation action is configured or applied within the context of a specific team. it's useful for understanding the relationship between automation actions and teams, which can be crucial for managing incident response workflows and team-specific automations. the endpoint should be used when you need to verify or audit the automation action settings for a particular team, or when troubleshooting team-specific automation behaviors.
</Accordion>

<Accordion title="Get event integrations by id">
  Retrieves a list of integrations associated with a specific event orchestration in pagerduty. this endpoint allows users to fetch all the integrations that are configured for a particular event orchestration, providing insights into how incidents are being routed and managed. it's useful for auditing the current setup of an event orchestration or when planning to modify the orchestration's integration configuration. the endpoint returns details about each integration, which may include integration types, configurations, and other relevant metadata. use this when you need to review or analyze the integrations tied to a specific event orchestration for troubleshooting, reporting, or system optimization purposes.
</Accordion>

<Accordion title="Get extension schema by id">
  Retrieves a specific extension schema from pagerduty by its unique identifier. this endpoint is used to fetch detailed information about a custom data structure that extends the functionality of the pagerduty api. it's particularly useful for developers who need to understand or work with custom fields or data structures in their pagerduty integrations. the endpoint returns the complete definition of the requested extension schema, including any custom fields, their types, and other metadata. this tool should be used when you need to inspect or verify the structure of a specific extension schema, but it won't allow you to modify the schema or create new ones. keep in mind that access to extension schemas may be subject to account permissions and the schema must exist in the pagerduty account for the request to succeed.
</Accordion>

<Accordion title="List automation action details">
  This endpoint retrieves a list of automation actions configured in the pagerduty account. automation actions are predefined tasks or operations that can be executed automatically in response to incidents or other triggers. the endpoint allows users to view all available automation actions, which can be useful for auditing, managing, or integrating these actions into other workflows. it supports pagination for handling large sets of actions and can include related information about associated services and teams. use this endpoint when you need to review, inventory, or programmatically access the automation capabilities within your pagerduty environment. note that this endpoint only provides information about existing actions and does not create, modify, or execute the actions themselves.
</Accordion>

<Accordion title="List extension schemas">
  Retrieves all available extension schemas from the pagerduty api. this endpoint allows users to fetch custom schema extensions that have been defined for their pagerduty account. extension schemas are used to add custom data structures or validation rules to the standard api schema, enabling more flexible and tailored data management. this tool is particularly useful when you need to understand the custom data fields or structures that have been added to your pagerduty implementation. it does not create, modify, or delete extension schemas; it only provides a read-only view of the existing schemas.
</Accordion>

<Accordion title="Get service impacts by url slug">
  Retrieves service impacts for a specific status dashboard in pagerduty. this endpoint allows users to fetch real-time information about how incidents or maintenance activities are affecting services displayed on a particular dashboard. it's useful for monitoring the current state of services, understanding ongoing issues, and assessing the overall health of systems represented in the specified dashboard. the endpoint should be used when you need to programmatically access up-to-date service impact data for a known status dashboard, enabling integration with other monitoring or reporting tools. note that this endpoint only provides information for a single dashboard at a time and requires knowledge of the dashboard's url slug.
</Accordion>

<Accordion title="List all workflow integration connections">
  List all workflow integration connections. scoped oauth requires: `workflow integrations:connections.read`
</Accordion>

<Accordion title="Get incident log entries by id">
  Retrieves all log entries associated with a specific incident in pagerduty. this endpoint provides a comprehensive history of actions, notifications, and status changes related to the incident. it should be used when detailed information about the lifecycle of an incident is needed, such as for post-incident reviews, auditing, or tracking the incident resolution process. the endpoint returns log entries in chronological order, allowing users to trace the incident's progression from creation to resolution. note that the number of log entries returned may be large for long-running or complex incidents, so pagination might be necessary (though not specified in the given schema).
</Accordion>

<Accordion title="Get severity for status page">
  Retrieves detailed information about a specific severity level on a particular status page in pagerduty. this endpoint is used to fetch the configuration and metadata associated with a severity, which is crucial for understanding how incidents are categorized and communicated on a status page. it provides insights into how different levels of service disruptions are represented and managed within the pagerduty system. this tool is essential for developers and administrators who need to programmatically access or audit severity configurations on status pages, enabling them to ensure consistent incident communication across their organization.
</Accordion>

<Accordion title="List incident types">
  List the available incident types incident types are a feature which will allow customers to categorize incidents, such as a security incident, a major incident, or a fraud incident. these can be filtered by enabled or disabled types. \<!-- theme: warning --> > ### early access > this endpoint is in early access and may change at any time. you must pass in the x-early-access header to access it. for more information see the [api concepts document](../../api-reference/zg9joji3ndc5nzc-api-concepts#incidenttype) scoped oauth requires: `incident types.read`
</Accordion>

<Accordion title="Get the service orchestration for a service">
  Get a service orchestration. a service orchestration allows you to create a set of event rules. the service orchestration evaluates events sent to this service against each of its rules, beginning with the rules in the "start" set. when a matching rule is found, it can modify and enhance the event and can route the event to another set of rules within this service orchestration for further processing. for more information see the [api concepts document](../../api-reference/zg9joji3ndc5nzc-api-concepts#event-orchestrations) scoped oauth requires: `services.read`
</Accordion>

<Accordion title="Get impact by status page id">
  Retrieves detailed information about a specific impact on a pagerduty status page. this endpoint allows you to fetch the current state and details of a particular impact, such as its severity, affected components, and any updates related to the impact. it's useful for monitoring the progress of ongoing incidents or reviewing past impacts on your services. the endpoint should be used when you need to get the most up-to-date information about a known impact, especially during incident management or when providing updates to stakeholders. note that this endpoint only provides information about a single impact and does not give an overview of all impacts on a status page.
</Accordion>

<Accordion title="Get incident workflows">
  Retrieves a list of incident workflows configured in the pagerduty account. this endpoint allows users to fetch information about automated sequences of actions set up to respond to incidents. it's useful for reviewing existing workflows, auditing incident response processes, or gathering data for reporting purposes. the endpoint supports pagination and filtering by workflow name. it does not create, modify, or delete workflows; it's purely for retrieval of workflow information.
</Accordion>

<Accordion title="List incident type custom fields">
  List the custom fields for an incident type. custom fields (cf) are a feature which will allow customers to extend incidents with their own custom data, to provide additional context and support features such as customized filtering, search and analytics. custom fields can be applied to different incident types. \<!-- theme: warning --> > ### early access > this endpoint is in early access and may change at any time. you must pass in the x-early-access header to access it. scoped oauth requires: `custom fields.read`
</Accordion>

<Accordion title="Ping webhook subscription">
  The pingwebhooksubscription endpoint sends a test post request to a specified webhook subscription in your pagerduty account. this tool is used to verify that a webhook subscription is correctly configured and can receive notifications. it's particularly useful after setting up a new webhook subscription or when troubleshooting integration issues. the endpoint doesn't modify any data but simulates a real webhook delivery, allowing you to confirm that your systems can properly receive and process pagerduty webhooks. note that this tool only tests the delivery mechanism and doesn't validate the processing of specific event types on your end.
</Accordion>

<Accordion title="List workflow integration connections">
  List all workflow integration connections for a specific workflow integration. scoped oauth requires: `workflow integrations:connections.read`
</Accordion>

<Accordion title="List workflow integrations">
  List available workflow integrations. scoped oauth requires: `workflow integrations.read`
</Accordion>

<Accordion title="Post account subscription for business service">
  This endpoint creates or updates an account subscription for a specific business service in pagerduty. it allows users to manage subscription settings, such as notification preferences or service-level agreements, for a particular business service identified by its unique id. use this endpoint when you need to set up new subscription configurations or modify existing ones for a business service. the endpoint is particularly useful for automating subscription management across multiple business services or integrating subscription updates with other systems. note that this operation may affect billing or service access, so it should be used carefully and with proper authorization.
</Accordion>

<Accordion title="Get a trigger">
  Retrieve an existing incident workflows trigger scoped oauth requires: `incident workflows.read`
</Accordion>

<Accordion title="List licenses">
  The listlicenses endpoint retrieves a comprehensive list of all licenses associated with the authenticated pagerduty account. this tool is essential for administrators and account managers who need to review, audit, or manage the licensing status of their pagerduty implementation. it provides an overview of all active licenses, including details such as license type, expiration date, and the number of users covered. this endpoint should be used when you need to perform license inventory, plan for renewals, or ensure compliance with your service agreement. note that while it offers a complete view of licenses, it does not provide functionalities to modify licenses directly through the api.
</Accordion>

<Accordion title="Get incident workflows actions">
  Retrieves a list of all available actions that can be used in incident workflows within pagerduty. this endpoint provides information about the various automated tasks and responses that can be configured to streamline incident management processes. it should be used when setting up or modifying incident workflows to understand the range of actions available for automation. the endpoint returns details about each action, which may include its name, description, and any configurable parameters. this tool is particularly useful for developers and system administrators who are designing or optimizing their incident response procedures in pagerduty. note that while this endpoint retrieves action information, it does not execute or modify any actions itself.
</Accordion>

<Accordion title="Post alert grouping settings">
  Creates a new alert grouping setting in pagerduty, defining how alerts will be automatically grouped into incidents based on specified configurations. this endpoint allows users to set up intelligent alert grouping rules, improving incident management efficiency by reducing noise and consolidating related alerts. it's particularly useful for teams looking to streamline their incident response process and minimize alert fatigue. the setting can be applied to one or multiple services, with the option to use content-based or intelligent grouping algorithms.
</Accordion>

<Accordion title="Get user notification subscriptions">
  Retrieves the notification subscriptions for a specific user in pagerduty. this endpoint allows you to fetch detailed information about how a user is configured to receive various types of notifications, such as incident alerts, updates, or system messages. it's useful for auditing a user's notification settings, troubleshooting communication issues, or when you need to review or modify a user's notification preferences programmatically. the response likely includes a list of subscription objects, each detailing the type of notification, delivery method (e.g., email, sms), and any specific rules or filters applied. this endpoint should be used when you need to understand or manage a user's notification setup within pagerduty.
</Accordion>

<Accordion title="Manage cache variables for event service">
  Creates a new cache variable for a specific service in pagerduty's event orchestrations. this endpoint allows you to define a cache variable that can store either the most recent value from an event field or count trigger events within a specified time range. cache variables are useful for maintaining temporary data related to events, which can be used in event routing and management. the created cache variable can be used to enhance event processing logic and improve incident management workflows.
</Accordion>

<Accordion title="Post analytics metrics responder filters">
  The analyzerespondermetrics endpoint aggregates and analyzes responder performance metrics for pagerduty incidents. it provides insights into response times, efficiency, and workload distribution. this tool is ideal for assessing and optimizing incident response processes, offering flexible filtering options for focused analysis. note that it provides aggregated data, not real-time information, with a maximum analysis range of one year.
</Accordion>

<Accordion title="Get specific post update status">
  Retrieves the updates for a specific post on a pagerduty status page. this endpoint allows users to fetch the chronological list of updates made to a particular post, providing detailed information about how the status or information has changed over time. it's particularly useful for tracking the progression of an incident or maintenance event that has been communicated through a status page. the endpoint should be used when there's a need to review the history of updates for a specific status page post, such as during post-incident reviews or when compiling reports on communication effectiveness during incidents.
</Accordion>

<Accordion title="Post incident note using id">
  Adds a new note to an existing incident in pagerduty. this endpoint allows users to append additional information, updates, or comments to a specific incident identified by its unique id. it's particularly useful for documenting the progress of incident resolution, sharing important observations, or recording actions taken. the note content can include any text relevant to the incident management process, helping teams collaborate and maintain a clear record of the incident's timeline and handling.
</Accordion>

<Accordion title="Post event orchestration cache variables">
  Creates a new cache variable within a pagerduty event orchestration. this endpoint allows you to define a cache variable that can store dynamic data related to events, either based on recent values extracted from event fields or by counting trigger events within a specified time range. cache variables are useful for maintaining state across multiple events and can be used in event routing and automation rules. the created cache variable can be configured with conditions to determine when it should be updated and can be optionally disabled. this tool should be used when setting up complex event orchestrations that require stateful processing or when implementing advanced automation workflows in pagerduty.
</Accordion>

<Accordion title="Post incident metrics">
  This endpoint retrieves analytics metrics for responder teams based on incident data in pagerduty. it allows for detailed filtering and customization of the data set, enabling users to analyze team and responder performance across various dimensions such as time range, urgency, priorities, and specific teams or responders. the endpoint is particularly useful for generating reports, assessing team efficiency, and identifying trends in incident management. it should be used when comprehensive analytics on responder team performance are needed, especially for large-scale or complex incident management scenarios. however, it's important to note that the endpoint has a maximum time range of one year for analysis, and the results are limited to the data the requestor has access to within the pagerduty system.
</Accordion>

<Accordion title="Post incidents analytics with filters">
  The analyzerawincidents endpoint retrieves and analyzes raw incident data from pagerduty. it allows users to fetch detailed information about incidents with various filtering options. this endpoint is useful for generating custom reports, performing trend analysis, or investigating specific incident sets. it supports extensive filtering, pagination, and result customization, making it ideal for in-depth incident reviews and pattern analysis.
</Accordion>

<Accordion title="List supporting service impacts">
  Retrieves information about the impacts of supporting services on a specific business service in pagerduty. this endpoint is used to understand the relationships and dependencies between a primary business service and its supporting services, along with the potential impacts these relationships may have on incident management and service reliability. it's particularly useful for assessing the cascading effects of incidents across interconnected services and for proactive risk management. the endpoint should be used when analyzing service dependencies, planning incident response strategies, or evaluating the overall resilience of your service infrastructure. note that this endpoint focuses on impact information and may not provide real-time incident data or detailed metrics about the services themselves.
</Accordion>

<Accordion title="Post team to runner">
  This endpoint adds a team to an automation action runner in pagerduty. it allows you to associate a specific team with a runner, enabling better organization and management of automation processes within your incident response workflow. use this endpoint when you need to grant a team access to or responsibility for a particular automation action runner. this association is crucial for maintaining proper access control and ensuring that the right teams are involved in specific automation tasks. the endpoint requires the runner's id and the team's reference information, including its unique identifier and type.
</Accordion>

<Accordion title="Post responder incidents with filters">
  Retrieves a list of incidents associated with a specific responder in the pagerduty incident management system. this endpoint allows for detailed filtering and pagination of incident data, making it ideal for analyzing a responder's workload, performance, and incident trends over time. it supports various filter criteria such as creation time range, urgency, major incident status, team and service associations, and priority levels. the tool is particularly useful for generating reports, conducting operational reviews, and optimizing incident response processes. it should be used when detailed incident information for a specific responder is needed, but not for real-time incident updates or for modifying incident data.
</Accordion>

<Accordion title="List templates">
  Retrieves a list of templates available in the pagerduty system. templates are pre-defined configurations used for creating alerts, notifications, and other automated processes within pagerduty. this endpoint should be used when you need to view or manage the existing templates in your pagerduty account. it provides an overview of all templates, which can be useful for auditing, updating, or selecting templates for use in incident management workflows. the endpoint does not create, modify, or delete templates; it is solely for retrieving template information.
</Accordion>

<Accordion title="Get user sessions by id">
  Retrieves all active sessions for a specific user in pagerduty. this endpoint allows you to fetch information about a user's current login sessions, which can be useful for auditing, security monitoring, or managing user access. it provides details such as session start times, device information, and ip addresses for each active session. use this endpoint when you need to track user activity, investigate potential security issues, or manage concurrent logins. note that this endpoint only returns information about active sessions and does not provide historical session data or the ability to modify sessions.
</Accordion>

<Accordion title="Preview schedule object">
  The preview schedule endpoint allows you to simulate and visualize a pagerduty schedule configuration before actually creating or updating it. this tool is essential for validating complex on-call rotations, ensuring proper coverage, and identifying potential gaps or conflicts in your schedule design. it accepts a complete schedule object, including multiple layers, users, and restrictions, and returns a preview of how the schedule would operate if implemented. this preview includes rendered schedule entries, showing exactly who would be on-call at specific times. use this endpoint when designing new schedules, modifying existing ones, or troubleshooting scheduling issues to ensure optimal on-call coverage without affecting your live environment. the preview does not create or modify any actual schedules in your pagerduty account.
</Accordion>

<Accordion title="Get incident workflow action by id">
  Retrieves detailed information about a specific action within an incident workflow in pagerduty. this endpoint allows users to fetch the configuration, settings, and other relevant details of a particular workflow action by providing its unique identifier. it is useful for inspecting the current state of an action, troubleshooting workflow issues, or gathering information for reporting purposes. the endpoint should be used when you need to examine or verify the properties of an individual workflow action, but it does not modify or execute the action itself.
</Accordion>

<Accordion title="Post incidents metrics filtered by service">
  The analyzeincidentmetrics endpoint aggregates and analyzes incident data for pagerduty services based on specified filters and parameters. it allows users to generate detailed reports and insights on incident management performance across various dimensions such as time, urgency, teams, and services. this endpoint is particularly useful for operational reviews, trend analysis, and performance monitoring of incident response processes. the tool provides flexible filtering options to focus on specific subsets of incidents and supports various time-based aggregations for comprehensive analysis. it's important to note that while the endpoint offers extensive customization, it has a maximum supported time range of one year between the start and end dates for incident creation.
</Accordion>

<Accordion title="Post team notification subscription">
  Creates notification subscriptions for a specific team in pagerduty. this endpoint allows you to subscribe a team to receive notifications for one or more incidents or business services. use this when you want to ensure a team is notified about specific critical events or the status of important business services. the endpoint requires a list of subscribable entities, each identified by a unique id and type. it's particularly useful for setting up or updating a team's notification preferences in bulk. note that this endpoint only creates new subscriptions and doesn't affect existing ones.
</Accordion>

<Accordion title="Render template for incident">
  Renders a specific template for a given incident in pagerduty. this endpoint allows you to generate a formatted report or message based on a pre-defined template and the provided incident information. it's particularly useful for creating standardized incident reports, status updates, or notifications. the rendered template can incorporate details from the incident, a status update message, and any additional external data provided. use this endpoint when you need to generate consistent, formatted output for incident communication or documentation purposes. note that the template itself must be created and configured separately; this endpoint only handles the rendering process based on the template identified by the url parameter \{id}.
</Accordion>

<Accordion title="Post analytic metrics on escalation policies">
  Retrieves and aggregates analytics metrics for incidents related to escalation policies in pagerduty. this endpoint allows for detailed filtering and customization of incident data, enabling users to analyze trends, performance, and patterns in their incident management process. it's particularly useful for generating reports, identifying areas for improvement, and understanding the effectiveness of escalation policies over time. the endpoint supports various filtering options, time zone specifications, and time-based aggregation, making it a powerful tool for operational insights and decision-making in incident management.
</Accordion>

<Accordion title="Merge source incidents into target incident">
  Merges multiple source incidents into a target incident in pagerduty's incident management system. this endpoint allows users to consolidate related or duplicate incidents into a single, primary incident for streamlined management and resolution. the operation combines the specified source incidents into the target incident identified by the url path, marking the source incidents as resolved. this tool should be used when multiple incidents are determined to be part of the same underlying issue or when consolidating incident management efforts. it's particularly useful for reducing noise and focusing on the root cause of related issues. note that this action is irreversible, so care should be taken to ensure that the incidents are truly related before merging.
</Accordion>

<Accordion title="Get user session by type">
  Retrieves detailed information about a specific user session in pagerduty. this endpoint allows you to fetch session-related data for a particular user, filtered by session type and identified by a unique session id. it's useful for monitoring user activity, troubleshooting authentication issues, or auditing system access. the endpoint returns data about the specified session, which may include creation time, last activity timestamp, expiration time, and other relevant session attributes. it should be used when detailed information about a user's specific session is required, but it does not provide information about other sessions or general user account details.
</Accordion>

<Accordion title="Post service automation action">
  This endpoint adds a service to an existing automation action in pagerduty. it allows users to associate a specific service with an automation action, enabling the action to be applied to incidents or events related to that service. the endpoint requires the automation action's id in the url path and a service reference object in the request body. it should be used when configuring or updating automation actions to include additional services in their scope of operation. this endpoint is particularly useful for expanding the reach of automation actions across multiple services within an organization's pagerduty setup.
</Accordion>

<Accordion title="Retrieve abilities list">
  Retrieves a list of abilities or capabilities available in the pagerduty system. this endpoint allows users to query and understand the features and functionalities they can access or perform within pagerduty. it's particularly useful for determining the scope of actions available to the authenticated user or for checking the overall feature set of the pagerduty instance. the endpoint should be used when you need to discover or verify the available abilities, such as during initial setup, permission audits, or when planning integrations. it does not modify any data and is safe to call frequently.
</Accordion>

<Accordion title="Post change events">
  Creates a new change event in the pagerduty system. this endpoint allows you to record and track significant changes or updates within your infrastructure or services. use this when you want to log important modifications, deployments, or system alterations that may impact incident management or operational processes. the change event data can be used for correlation with incidents, providing context for potential issues or for auditing purposes. this endpoint is particularly useful for maintaining a comprehensive change log and enhancing the incident response process by providing additional context about recent system changes.
</Accordion>

<Accordion title="Get status for status page by id">
  Retrieves the current status of a specific item on a pagerduty status page. this endpoint is used to fetch up-to-date information about the operational state of a particular service or component listed on a status page. it's particularly useful for integrations that need to monitor or display the latest status of services to users or internal systems. the endpoint requires both the status page id and the specific status item id, allowing for precise querying of individual service statuses within a larger status page context. this tool should be used when you need to programmatically check the current state of a specific service on a pagerduty status page, such as during incident management or for creating custom dashboards.
</Accordion>

<Accordion title="Post incident metrics with filters">
  This endpoint retrieves and aggregates analytics metrics for incidents across all teams in pagerduty. it allows users to apply various filters and parameters to analyze incident data, such as creation date range, urgency, team associations, and more. the endpoint is particularly useful for generating reports, identifying trends, and performing operational reviews across multiple teams and services. it provides flexibility in data aggregation and sorting, enabling users to customize their analysis based on specific needs and time frames. however, users should be aware of the one-year limitation on the date range when using the created at filters.
</Accordion>

<Accordion title="Get status dashboard by id">
  Retrieves detailed information about a specific status dashboard in pagerduty. this endpoint allows users to fetch the current configuration, components, and status of a particular dashboard, which is crucial for monitoring system health and managing incidents efficiently. it should be used when you need to access up-to-date information about a known status dashboard, such as during incident response or when updating dashboard configurations. the endpoint will not modify any data and is intended for read-only operations.
</Accordion>

<Accordion title="Retrieve ability by id">
  Retrieves detailed information about a specific ability (feature capability) associated with a pagerduty account using its unique identifier. this endpoint allows users to query the system for the status and details of a particular feature, such as 'teams' or 'incident management', to determine if it's available and potentially get additional configuration information. it's particularly useful when you need to verify the presence of a specific functionality or gather more details about a feature's implementation in your account. the endpoint should not be used to modify abilities or retrieve information about multiple abilities simultaneously.
</Accordion>

<Accordion title="Migrate integration between orchestrations">
  This endpoint facilitates the migration of an integration from one event orchestration to another within pagerduty. it allows users to reassign an existing integration to a different event orchestration, maintaining the integration's configuration while updating its association. this operation is useful when restructuring event management workflows or optimizing incident routing. the endpoint should be used when there's a need to change how a specific integration interacts with pagerduty's event processing system. it's important to note that this process only changes the association and does not modify the integration's settings or connected external services.
</Accordion>

<Accordion title="Get user status update notification rules">
  Retrieves the status update notification rules for a specific user in pagerduty. this endpoint allows you to fetch the configured rules that determine how and when a user receives notifications about status changes in incidents or services they are associated with. it's useful for understanding a user's current notification preferences and can be helpful when auditing or updating user settings. the endpoint returns a list of notification rules, each detailing the conditions under which status update notifications are sent to the user.
</Accordion>

<Accordion title="Get an incident type">
  Get detailed information about a single incident type. accepts either an incident type id, or an incident type name. incident types are a feature which will allow customers to categorize incidents, such as a security incident, a major incident, or a fraud incident. \<!-- theme: warning --> > ### early access > this endpoint is in early access and may change at any time. you must pass in the x-early-access header to access it. for more information see the [api concepts document](../../api-reference/zg9joji3ndc5nzc-api-concepts#incident) scoped oauth requires: `incident types.read`
</Accordion>

<Accordion title="Get alert grouping settings">
  Retrieves the current alert grouping settings for the pagerduty account. this endpoint provides information on how alerts are automatically grouped together in the incident management system. it should be used when you need to understand or audit the current configuration for alert grouping, which can impact how incidents are organized and presented to responders. the endpoint returns the global settings that apply across the account, but it does not provide information about service-specific alert grouping rules or real-time grouping status of active incidents. this information is crucial for administrators managing large-scale incident response processes or when troubleshooting alert noise issues.
</Accordion>

<Accordion title="Get an incident type custom field">
  Get a custom field for an incident type. custom fields (cf) are a feature which will allow customers to extend incidents with their own custom data, to provide additional context and support features such as customized filtering, search and analytics. custom fields can be applied to different incident types. \<!-- theme: warning --> > ### early access > this endpoint is in early access and may change at any time. you must pass in the x-early-access header to access it. scoped oauth requires: `custom fields.read`
</Accordion>

<Accordion title="Get log entries">
  Retrieves log entries from the pagerduty system, providing a detailed history of events and actions related to incidents and system activities. this endpoint is crucial for auditing purposes, allowing users to track changes, responses, and other important events within their incident management workflow. it supports filtering by date range and specific incidents, making it useful for both broad overview analysis and detailed incident investigations. the endpoint uses pagination to manage large sets of log entries, ensuring efficient data retrieval and processing.
</Accordion>

<Accordion title="Get audit records">
  Retrieves a list of audit records from the pagerduty system. this endpoint allows users to access logs of configuration changes made to pagerduty resources, such as account objects. the records are sorted by execution time, with the newest records appearing first. this tool is particularly useful for tracking and reviewing changes, conducting security audits, or generating reports on system modifications. it provides a comprehensive view of who made what changes and when, enhancing transparency and accountability within the organization. the endpoint supports pagination and date range filtering to manage large volumes of audit data effectively.
</Accordion>

<Accordion title="Get status page impacts by id">
  Retrieves the impacts associated with a specific status page in pagerduty. this endpoint allows users to fetch detailed information about service disruptions, incidents, or other events affecting the services displayed on a particular status page. it is useful for monitoring the current state of services, understanding the severity and scope of ongoing issues, and keeping stakeholders informed about service health. the endpoint should be used when there's a need to programmatically access impact data for a status page, such as for integration with other monitoring tools or for creating custom dashboards.
</Accordion>

<Accordion title="Post incident status update">
  Posts a status update for a specific incident in pagerduty. this endpoint allows you to add new information or progress reports to an ongoing incident, keeping stakeholders informed about the current state of the issue. it supports both simple text updates and more detailed custom html email updates. use this when you need to communicate important changes, actions taken, or any relevant information about the incident to the team or stakeholders. the endpoint is particularly useful for maintaining a clear timeline of the incident's progression and ensuring all parties have the most up-to-date information. note that while a simple message is always required, you have the option to provide additional details through a custom html email by including both the 'subject' and 'html message' fields.
</Accordion>

<Accordion title="Get automation actions runners">
  Retrieves a list of automation action runners associated with the pagerduty account. this endpoint allows users to view all available runners that can execute automation actions within their incident management workflow. it provides essential information about each runner, such as its id, name, and current status. use this endpoint when you need to manage, monitor, or select runners for executing automation actions. the response typically includes details that help in understanding the capacity and availability of runners for performing automated tasks. this endpoint is particularly useful for administrators and devops teams who need to oversee and optimize their automation infrastructure within pagerduty.
</Accordion>

<Accordion title="Get alerts by incident id">
  Retrieves all alerts associated with a specific incident in pagerduty. this endpoint allows users to fetch detailed information about the notifications and alerts that were triggered as part of an incident's lifecycle. it is particularly useful for incident postmortems, auditing purposes, or understanding the notification flow during an incident. the endpoint returns a list of alerts, which may include information such as alert creation time, alert status, and the targets (users or services) that received the notifications. it should be used when detailed alert information for a known incident is required, but it will not provide information about the incident itself beyond its associated alerts.
</Accordion>

<Accordion title="Modify entity tags">
  This endpoint allows you to modify the tags associated with a specific entity in pagerduty. it provides functionality to both add new tags and remove existing ones in a single api call. the endpoint is particularly useful for updating the categorization or labeling of pagerduty entities such as incidents, services, or users. it supports adding tags by label (creating new ones if necessary) or by reference, and removing tags by their unique identifiers. this flexibility allows for efficient tag management across your pagerduty resources, enabling better organization and easier searching of entities. use this endpoint when you need to update the tags for a specific entity, either to refine its categorization or to align it with current operational needs.
</Accordion>

<Accordion title="Get aggregated pd advance usage data">
  Provides aggregated metrics for the usage of pd advance. \<!-- theme: info --> > **note:** analytics data is updated [periodically](https://support.pagerduty.com/main/docs/insights#:~:text=data%20update%20schedule). it takes up to 24 hours before new incidents appear in the analytics api. scoped oauth requires: `analytics.read`
</Accordion>

<Accordion title="Retrieve business service impactors">
  Retrieves a list of impactors currently affecting business services in pagerduty. impactors are entities or events that have the potential to negatively impact the performance, availability, or functionality of one or more business services. this endpoint is essential for proactive incident management, risk assessment, and maintaining service reliability. use this endpoint to get a comprehensive view of potential threats to your business services, allowing you to prioritize your response and allocate resources effectively. the returned data can be used to identify patterns, anticipate cascading failures, and improve overall system resilience. while this endpoint provides valuable information about current impactors, it does not offer historical data or predictive analysis. it should be used in conjunction with other monitoring and analysis tools for a complete understanding of your service health and potential risks.
</Accordion>

<Accordion title="Retrieve incident custom fields">
  Retrieves a list of custom fields associated with incidents in pagerduty. custom fields are additional data points that can be added to incidents to provide more detailed information tailored to specific organizational needs. this endpoint allows you to fetch all defined custom fields, which can be useful for understanding the structure of incident data, preparing for incident creation or updates, or auditing the current custom field configuration. the response will include details such as field names, types, and any predefined options for each custom field. use this endpoint when you need to review or work with the custom field definitions in your pagerduty account, such as when integrating with other systems or preparing reports that involve custom incident data.
</Accordion>

<Accordion title="Retrieve entity tags by id and type">
  Retrieves the tags associated with a specific entity in pagerduty. this endpoint allows you to fetch all tags linked to a particular resource, such as an incident, service, user, team, or escalation policy. it's useful for understanding how resources are categorized and organized within your pagerduty account. the endpoint should be used when you need to review or analyze the tagging structure of a specific entity, which can aid in incident management, reporting, and integration with other systems. note that this endpoint only retrieves existing tags and does not modify them; separate endpoints are required for tag management operations.
</Accordion>

<Accordion title="Retrieve business service impacts">
  Retrieves the impacts of a specific incident on business services within pagerduty. this endpoint allows users to assess the scope and severity of an ongoing incident by providing detailed information about which business services are affected and to what extent. it should be used when there's a need to understand the broader implications of an incident across the organization's critical operations. the tool is particularly useful for incident managers, stakeholders, and support teams who need to prioritize response efforts based on the impact severity. note that this endpoint only provides impact data for a single incident at a time and does not offer historical or aggregate impact information across multiple incidents.
</Accordion>

<Accordion title="Retrieve change event information">
  Retrieves a list of change events from the pagerduty system within a specified time range. change events represent notifications or updates that occur within a pagerduty account, such as modifications to teams, services, or escalation policies. this endpoint is useful for monitoring and auditing changes in the pagerduty configuration, helping to track system modifications and ensure compliance with change management processes. the response typically includes details about each change event, such as the type of change, affected resources, timestamp, and the user who initiated the change. use this endpoint when you need to review recent changes, investigate system modifications, or generate reports on configuration updates within your pagerduty account.
</Accordion>

<Accordion title="Retrieve action services by id">
  Retrieves a list of services associated with a specific automation action in pagerduty. this endpoint allows users to fetch all services that are linked to a particular automation action, providing insights into which components or systems are affected by the automated process. it's useful for auditing automation configurations, understanding the scope of automated actions, and managing incident response workflows. the endpoint should be used when you need to review or verify the services connected to an automation action, but it won't provide details about the action itself or modify any existing configurations.
</Accordion>

<Accordion title="Retrieve addon by id">
  Retrieves detailed information about a specific addon installed on a pagerduty account. this endpoint allows users to fetch the current configuration, status, and other relevant details of an addon without modifying it. it's particularly useful for auditing installed addons, troubleshooting integration issues, or gathering information before making changes to an addon's setup. the endpoint returns a comprehensive view of the addon, which may include its type, version, configuration parameters, and current operational status. use this endpoint when you need to inspect or verify the details of a particular addon in your pagerduty environment.
</Accordion>

<Accordion title="Retrieve event orchestration router by id">
  Retrieves the router configuration for a specific event orchestration in pagerduty. this endpoint allows you to fetch detailed information about how incidents and events are routed within a particular event orchestration setup. use this endpoint when you need to understand or audit the current routing logic for an event orchestration, such as determining which teams or escalation policies are assigned to handle specific types of incidents. the returned data will include routing rules, conditions, and associated actions, but will not modify any existing configurations. this endpoint is particularly useful for incident response planning and optimization of event management workflows.
</Accordion>

<Accordion title="Retrieve incident by incident id">
  Retrieves detailed information about a specific incident in pagerduty using its unique identifier. this endpoint allows users to access comprehensive data about an individual incident, including its current status, assigned responders, and related metadata. it is particularly useful for tracking the progress of an ongoing incident, reviewing historical incident data, or integrating incident details into external systems or reports. the endpoint should be used when specific incident information is needed, rather than for retrieving bulk or summarized incident data. note that this endpoint provides a snapshot of the incident at the time of the request and may not reflect real-time updates without subsequent api calls.
</Accordion>

<Accordion title="Retrieve business service dependencies">
  Retrieves the service dependencies for a specific business service in pagerduty. this endpoint allows you to fetch a list of services that are dependent on or related to the specified business service, helping to understand the interconnections within your incident management structure. use this when you need to analyze the impact of incidents on critical business functions or when planning incident response strategies. the endpoint provides a snapshot of the current dependency structure and does not include historical data or future planned changes to service relationships.
</Accordion>

<Accordion title="Retrieve extension list">
  Retrieves a list of all extensions associated with the authenticated pagerduty account. extensions are additional features or integrations that enhance pagerduty's functionality, such as custom notification methods or third-party service connections. this endpoint is useful for auditing the extensions currently in use, planning integration strategies, or managing the account's extension ecosystem. it provides a comprehensive overview of all extensions without the need for specific query parameters. however, it does not allow for filtering or sorting of the results, so all data processing must be done client-side.
</Accordion>

<Accordion title="Retrieve extension by id">
  Retrieves detailed information about a specific extension in pagerduty. this endpoint allows users to fetch the configuration and status of an individual extension by providing its unique identifier. it is particularly useful when you need to review or verify the settings of a specific extension, such as its type, configuration parameters, or associated service. this endpoint should be used when detailed information about a known extension is required, but it cannot be used to list all extensions or modify extension settings.
</Accordion>

<Accordion title="Retrieve entity tags by id">
  Retrieves the tags associated with a specific entity in the pagerduty system. this endpoint allows you to fetch all tags that have been assigned to a particular resource, such as a user, team, service, or incident. it's useful for categorization, filtering, and organizing entities within pagerduty. the endpoint requires specifying both the entity type and its unique identifier to correctly locate the resource. this operation is read-only and does not modify any data.
</Accordion>

<Accordion title="Retrieve automation service action">
  Retrieves information about how a specific automation action is associated with a particular service in pagerduty. this endpoint allows users to query the relationship between an automation action and a service, providing details on how the action is configured or applied within the context of the specified service. it's useful for understanding the automation setup for incident management and response processes for a given service. the endpoint requires both the automation action id and the service id to fetch the relevant association details.
</Accordion>

<Accordion title="Retrieve incident custom field values">
  Retrieves the custom field values associated with a specific incident in pagerduty. this endpoint allows users to access additional metadata that has been added to an incident, providing more context and enabling better incident management. it should be used when detailed information about an incident's custom fields is needed, such as for reporting, analysis, or integration with other systems. the endpoint returns only the custom field values and does not modify the incident or its fields.
</Accordion>

<Accordion title="Retrieve automation action invocations">
  Retrieves a list of automation action invocations from the pagerduty incident management platform. this endpoint allows users to query and review the history of automated actions that have been executed within their pagerduty environment. it can be used to audit automation processes, track the frequency and timing of automated responses, and analyze the effectiveness of incident management workflows. the endpoint is particularly useful for administrators and devops teams who need to monitor and optimize their automated incident response strategies. note that while this endpoint provides historical data, it does not trigger new automated actions or modify existing ones.
</Accordion>

<Accordion title="Retrieve active service event by id">
  Retrieves the active event orchestration configuration for a specific pagerduty service. this endpoint allows you to fetch the current rules and settings that determine how incidents are created and routed for the specified service. use this when you need to review or audit the active event handling setup for a particular service. it's particularly useful for understanding how incoming events are being processed and managed within your pagerduty environment. this endpoint focuses solely on the active configuration and does not provide historical data or allow modifications to the orchestration rules.
</Accordion>

<Accordion title="Retrieve business services">
  The listbusinessservices endpoint retrieves a comprehensive list of all business services configured within a pagerduty account. this get operation provides an overview of the critical business functions monitored and managed through pagerduty's incident management platform. it's particularly useful for obtaining a holistic view of an organization's service hierarchy, conducting audits, or integrating service information with other systems. while the endpoint doesn't appear to offer filtering or pagination options, it serves as a fundamental tool for understanding the scope of services under management. users should be aware that the response may include a large amount of data for accounts with numerous business services, potentially impacting response times for accounts with extensive service catalogs.
</Accordion>

<Accordion title="Retrieve incident field options">
  Retrieves the available field options for a specific custom field associated with incidents in pagerduty. this endpoint allows users to fetch the predefined set of values that can be assigned to a particular custom field, enabling efficient incident management and customization. use this endpoint when you need to populate dropdowns, validate input, or understand the possible values for a custom field in your incident management workflow. it's particularly useful for maintaining consistency in incident data and facilitating automated processes that interact with custom fields.
</Accordion>

<Accordion title="Retrieve past incidents">
  Retrieves a list of past incidents related to a specific incident in pagerduty. this endpoint allows users to explore the historical context of an incident by fetching previous occurrences or related issues. it's particularly useful for identifying recurring problems, analyzing incident patterns, and improving overall incident management processes. the endpoint should be used when investigating the root cause of an incident or when compiling reports on incident history. note that this endpoint focuses on historical data and does not provide real-time incident information or updates to the current incident status.
</Accordion>

<Accordion title="Retrieve oncall handoff notification rules">
  Retrieves the on-call handoff notification rules for a specific user in pagerduty. this endpoint allows you to fetch the configured rules that determine how and when a user is notified about on-call schedule transitions. it's particularly useful for understanding and auditing a user's notification preferences during shift changes or when responsibilities are transferred between team members. the retrieved rules may include settings for different notification methods (e.g., email, sms, push notifications) and timing preferences relative to the handoff. this endpoint should be used when you need to review or manage a user's on-call handoff communication settings, but it does not allow for modification of these rules.
</Accordion>

<Accordion title="Retrieve log entry by id">
  Retrieves detailed information about a specific log entry in the pagerduty system. this endpoint is used to access the complete record of an event or action that occurred within pagerduty, such as incident updates, user actions, or system changes. it's particularly useful for auditing purposes, investigating specific actions taken during incident management, or gathering detailed information about system activities. the endpoint returns a single log entry based on the provided id, allowing for precise tracking and analysis of individual events within the incident management lifecycle. note that this endpoint is not designed for real-time monitoring or bulk log retrieval; it's intended for accessing specific, historical log entries when detailed information about a particular event is required.
</Accordion>

<Accordion title="Retrieve integration by service id">
  Retrieves detailed information about a specific integration associated with a particular service in pagerduty. this endpoint allows you to fetch the configuration and status of an integration, which can be crucial for understanding how external systems or tools are connected to your pagerduty service. use this when you need to review or troubleshoot a specific integration's settings within the context of a service. it's particularly useful for auditing your integrations or preparing for updates to your incident management workflow. note that this endpoint only provides read access to integration details and cannot be used to modify the integration.
</Accordion>

<Accordion title="Retrieve response play by id">
  Retrieves detailed information about a specific response play in the pagerduty incident management system. this endpoint allows users to access the configuration and actions associated with a predefined response play, which is used to automate and streamline incident response processes. it's particularly useful when you need to review or audit the steps in a response play, or when preparing to update an existing response play. the endpoint returns comprehensive data about the response play, including its name, description, and the sequence of actions it performs during an incident.
</Accordion>

<Accordion title="Retrieve oncall list">
  Retrieves the current on-call information for your pagerduty account. this endpoint provides a comprehensive view of who is currently on-call across various schedules and escalation policies. it's particularly useful for getting an overview of your organization's current on-call status, identifying who is responsible for incident response at any given time, and planning team availability. the endpoint supports filtering by users, escalation policies, and schedules, making it versatile for different querying needs. it also allows for pagination and including additional details like contact methods and schedule information. this tool should be used when you need to quickly assess the current on-call situation or gather data for on-call analytics. note that while it provides current and near-future on-call information, it may not be suitable for long-term scheduling or historical analysis beyond a 3-month window.
</Accordion>

<Accordion title="Retrieve ruleset by id">
  Retrieves detailed information about a specific ruleset in pagerduty using its unique identifier. this endpoint allows you to fetch the complete configuration and settings of a single ruleset, which is essential for understanding how incident responses are automated and managed. use this when you need to review, audit, or troubleshoot a particular ruleset's configuration. the response will include all relevant details such as the ruleset's name, type, routing keys, and associated rules. it's particularly useful when you need to examine the exact setup of a ruleset without making any changes. note that this endpoint only provides read access and cannot be used to modify the ruleset.
</Accordion>

<Accordion title="Retrieve oncall handoff notification rule">
  Retrieves detailed information about a specific on-call handoff notification rule for a given user in pagerduty. this endpoint is crucial for managing and reviewing the notification settings that govern how users are alerted during on-call responsibility transitions. it provides access to the configuration of rules that determine when and how a user is notified about upcoming on-call shifts or handoffs. this tool should be used when there's a need to inspect or audit the notification preferences for on-call transitions of a particular user. it's particularly useful for team leads or administrators who need to ensure smooth handoffs between team members during critical incident management periods.
</Accordion>

<Accordion title="Retrieve change event by id">
  Retrieves detailed information about a specific change event in pagerduty using its unique identifier. this endpoint is crucial for tracking and auditing changes within your incident management workflow. it provides comprehensive data about a single change event, which may include the type of change, when it occurred, who initiated it, and its impact on related incidents or services. use this endpoint when you need to investigate the details of a particular change, such as during incident postmortems or when analyzing the effectiveness of change management processes. the endpoint is particularly useful for understanding the context and timeline of changes that may have affected your systems or services.
</Accordion>

<Accordion title="Retrieve notifications">
  Retrieves notifications from the pagerduty system. this endpoint allows users to fetch information about alerts, incidents, and other important notifications generated within the pagerduty platform. it's particularly useful for monitoring recent activity, tracking incident updates, or integrating pagerduty notifications into other systems. the endpoint likely supports filtering and sorting options to help users narrow down the results to relevant notifications. however, it's important to note that real-time notifications might not be immediately available through this endpoint, and there could be a slight delay between an event occurring and its notification being accessible via this api call.
</Accordion>

<Accordion title="Retrieve business service by id">
  Retrieves detailed information about a specific business service in pagerduty using its unique identifier. this endpoint allows users to fetch the current configuration, settings, and metadata associated with a particular business service. it should be used when detailed information about a single business service is needed, such as during service audits, configuration reviews, or when updating service information. the endpoint provides a comprehensive view of the service but does not include real-time incident data or historical performance metrics. it's particularly useful for integrations that need to sync or display business service information in external systems.
</Accordion>

<Accordion title="Retrieve license allocations">
  Retrieves the current license allocations for the pagerduty account. this endpoint provides an overview of how licenses are distributed across users, teams, or other entities within the organization. it should be used when you need to audit license usage, plan for license renewals, or manage resource allocation within your pagerduty account. the response likely includes details such as the total number of licenses, allocated licenses, and possibly information about which users or teams are using the licenses. this endpoint does not modify any license allocations; it is for informational purposes only. keep in mind that the response may be paginated for accounts with a large number of license allocations.
</Accordion>

<Accordion title="Retrieve current user info">
  Retrieves the profile information of the currently authenticated user in the pagerduty system. this endpoint provides access to personal details, settings, and account information associated with the user making the api request. it's particularly useful for applications that need to display or utilize user-specific data without requiring additional input. the endpoint should be used when an application needs to fetch up-to-date information about the current user, such as their name, email, role, or other account-related details. note that this endpoint does not provide information about other users in the organization, nor does it allow for modifications to the user profile.
</Accordion>

<Accordion title="Retrieve incident workflow by id">
  Retrieves detailed information about a specific incident workflow in pagerduty. this endpoint allows users to fetch the configuration, steps, and other relevant details of an incident workflow based on its unique identifier. it is particularly useful when you need to review or audit the structure of an existing workflow, or when you want to display the workflow details in a user interface. the endpoint returns comprehensive information about the workflow, which may include its name, description, steps, triggers, and associated incident types. it should be used when specific information about a known incident workflow is required, rather than for listing or searching workflows.
</Accordion>

<Accordion title="Retrieve postmortem by id">
  Retrieves the postmortem analysis for a specific post on a pagerduty status page. this endpoint allows users to access detailed information about an incident after it has been resolved, including root cause analysis, timeline of events, and lessons learned. it should be used when detailed information about the resolution of a specific incident is needed, particularly for review, documentation, or improvement purposes. the endpoint is valuable for teams conducting thorough post-incident reviews or for maintaining a knowledge base of past incidents and their resolutions. note that this endpoint only provides postmortem information and does not allow for modifications to the postmortem content.
</Accordion>

<Accordion title="Retrieve service status by id">
  Retrieves a list of services associated with a specific status page in pagerduty. this endpoint is used to fetch detailed information about the services that are being monitored and displayed on a particular status page. it's particularly useful when you need to review or update the services shown on a status page, or when integrating status page information with other systems. the endpoint returns service details such as names, current statuses, and any relevant metadata, allowing for comprehensive monitoring and management of services within the context of a status page.
</Accordion>

<Accordion title="Retrieve list of services">
  Retrieves a list of services configured in the pagerduty account. this endpoint allows you to fetch details about various services set up for incident management and alerting. it's particularly useful for getting an overview of all services, their configurations, and associated teams or escalation policies. the endpoint supports filtering, sorting, and pagination to manage large sets of services efficiently. use this when you need to audit existing services, prepare for bulk updates, or integrate service information into other systems. note that the response may not include full details of each service, and separate api calls might be necessary to fetch comprehensive information for individual services.
</Accordion>

<Accordion title="Retrieve service audit records by id">
  Retrieves the audit records for a specific pagerduty service. this endpoint allows you to fetch a historical log of all configuration changes made to the service, providing transparency and accountability in incident management processes. use this endpoint when you need to review modifications, track who made changes, or investigate the evolution of a service's configuration over time. the audit records are typically sorted by execution time from newest to oldest, offering a chronological view of alterations. while this endpoint is valuable for compliance and debugging purposes, it does not provide real-time incident data or current service configurations.
</Accordion>

<Accordion title="Retrieve schedule override by id">
  Retrieves the list of overrides for a specific schedule in pagerduty. this endpoint allows users to fetch temporary modifications to the regular on-call rotation, providing insight into any manual adjustments made to the schedule. it's particularly useful for auditing changes, understanding the current state of a schedule, or verifying that overrides have been correctly applied. the endpoint should be used when there's a need to review or analyze schedule modifications, especially in cases of incident management or when planning future on-call rotations. note that this endpoint only provides information about existing overrides and does not allow for creating, modifying, or deleting overrides.
</Accordion>

<Accordion title="Retrieve automation action invocation by id">
  Retrieves detailed information about a specific automation action invocation in pagerduty. this endpoint allows you to fetch the current state, results, and metadata of a previously executed automation action. it's particularly useful for tracking the progress of long-running automations, auditing past actions, or troubleshooting failed invocations. the endpoint should be used when you need to review the outcome of a specific automation run or gather data for reporting purposes. note that this endpoint only provides information about the invocation itself and does not allow modification of the automation action or re-running of the invocation.
</Accordion>

<Accordion title="Retrieve status dashboards information">
  Retrieves a list of status dashboards and their associated information from the pagerduty system. this endpoint provides a comprehensive overview of the current operational status, performance metrics, and health indicators across various systems or services monitored by pagerduty. it's particularly useful for obtaining a high-level view of system status without diving into specific incidents or alerts. the endpoint should be used when you need to quickly assess the overall health of your monitored systems, identify any ongoing issues or incidents, and get a snapshot of key performance indicators. it's ideal for regular system checks, creating status pages, or integrating system health information into other monitoring tools. while this endpoint offers a broad view of system status, it may not provide detailed information about specific incidents or historical data. for in-depth analysis of particular issues or long-term trends, you may need to use other specialized endpoints.
</Accordion>

<Accordion title="Retrieve status dashboard by slug">
  Retrieves detailed information about a specific pagerduty status dashboard using its url slug. this endpoint allows users to fetch the current state, components, and other relevant data associated with a particular status dashboard. it's useful for integrating pagerduty's status information into external monitoring systems or custom dashboards. the endpoint should be used when you need to programmatically access up-to-date information about a known status dashboard. note that this endpoint only provides information for existing dashboards and does not create or modify dashboard data.
</Accordion>

<Accordion title="Retrieve alert grouping settings by id">
  Retrieves the alert grouping settings for a specific configuration identified by its unique id in pagerduty. this endpoint allows users to access detailed information about how alerts are grouped for a particular service or team. it's useful for reviewing current grouping rules, understanding the logic behind incident correlation, and auditing alert management configurations. the endpoint should be used when you need to examine or verify the existing alert grouping settings, which can be crucial for optimizing incident response and reducing alert fatigue. it does not modify any settings and is intended for read-only operations.
</Accordion>

<Accordion title="Retrieve standards scores by resource type and id">
  Retrieves the standards scores for a specific resource in pagerduty. this endpoint allows users to fetch performance or compliance metrics for a given resource type (such as incidents, services, or teams) identified by its unique id. the scores provide insights into how well the resource is meeting predefined standards or best practices within the pagerduty platform. this tool is particularly useful for assessing the effectiveness of incident management processes, service performance, or team efficiency. it should be used when seeking to evaluate or benchmark the performance of specific pagerduty resources against established standards. note that the exact scoring criteria and scale may vary depending on the resource type and pagerduty's current scoring methodology.
</Accordion>

<Accordion title="Retrieve service status page">
  Retrieves detailed information about a specific service associated with a particular status page in pagerduty. this endpoint is used to fetch the current status, configuration, and other relevant details of a service displayed on a status page. it's particularly useful for monitoring the health and state of individual components within a larger system. the endpoint should be used when you need up-to-date information about a specific service's status or when integrating pagerduty's status information into other monitoring or reporting tools. note that this endpoint only provides information for services that are configured to be displayed on the specified status page.
</Accordion>

<Accordion title="Retrieve schedule audit records by id">
  Retrieves the audit records for a specific pagerduty schedule. this endpoint allows you to access a comprehensive log of all changes made to the specified schedule, including modifications to on-call rotations, time periods, and associated team members. it's particularly useful for compliance purposes, tracking historical changes, and understanding how the schedule has evolved over time. the returned data typically includes details such as the timestamp of each change, the user who made the modification, and the specific alterations made to the schedule.
</Accordion>

<Accordion title="Retrieve rule by service id">
  Retrieves a specific rule associated with a particular service in pagerduty. this endpoint allows you to access detailed information about a single rule, including its configuration and conditions, within the context of a specific service. it is useful for reviewing, auditing, or troubleshooting notification workflows. the endpoint should be used when you need to examine the settings of a particular rule for a given service, but it will not modify or create new rules. note that this endpoint only provides information for a single rule and does not return a list of all rules for the service.
</Accordion>

<Accordion title="Retrieve team details by id">
  Retrieves detailed information about a specific team in pagerduty based on the provided team id. this endpoint allows users to fetch comprehensive data about a team, including its members, roles, and configurations. it is particularly useful for applications that need to display or process team information, such as team management dashboards or reporting tools. the endpoint returns all available details about the specified team, providing a snapshot of its current state within the pagerduty system.
</Accordion>

<Accordion title="Retrieve ruleset list">
  Retrieves a list of rulesets from the pagerduty system. rulesets are collections of event rules that define how incidents are managed and alerts are configured. this endpoint allows you to view all available rulesets, which is crucial for understanding your incident management setup and making informed decisions about alert routing and event handling. use this endpoint when you need to audit your ruleset configurations, prepare for modifications to your incident management workflow, or simply need an overview of your current ruleset structure. the response will include details about each ruleset, such as its name, id, and potentially its associated rules, depending on the api version and configuration. this endpoint supports pagination to handle large numbers of rulesets efficiently.
</Accordion>

<Accordion title="Retrieve schedule by id">
  Retrieves detailed information about a specific schedule in pagerduty using its unique identifier. this endpoint is essential for viewing the configuration of an existing on-call schedule, including its name, time periods, rotation layers, and associated users or teams. use this when you need to inspect a schedule's current setup, verify on-call assignments, or gather data for schedule management tasks. the endpoint provides a comprehensive view of a single schedule but does not allow modifications; for updates, a separate put request would be required.
</Accordion>

<Accordion title="Retrieve team list">
  The listteams endpoint retrieves a list of teams within a pagerduty account. it provides an overview of all teams or a filtered subset based on the optional query parameter. this endpoint is useful for obtaining team information, such as team names and ids, which can be used in other api calls or for organizational purposes. the response typically includes basic details about each team, allowing for further actions or more detailed queries on specific teams. use this endpoint when you need to survey the teams in your pagerduty organization, prepare for team management tasks, or integrate team information into other systems. note that while it returns a list of teams, it may not provide exhaustive details for each team; for comprehensive information on a specific team, a separate api call might be necessary.
</Accordion>

<Accordion title="Retrieve tag by id">
  Retrieves detailed information about a specific tag in the pagerduty system using its unique identifier. this endpoint allows users to fetch the properties and metadata associated with a particular tag, which can be useful for incident management, reporting, and organization within pagerduty. it should be used when detailed information about a specific tag is needed, such as its name, description, or any custom attributes. the endpoint will not modify or create tags; it is purely for retrieval of existing tag data. note that the response will only include information for tags that the authenticated user has permission to view.
</Accordion>

<Accordion title="Retrieve incident workflow triggers">
  Retrieves a list of triggers associated with incident workflows in pagerduty. this endpoint allows you to fetch information about the conditions or events that initiate automated incident response processes. use this endpoint when you need to review, audit, or manage the triggers configured for your incident workflows. it provides valuable insights into what events can start an incident workflow, helping in the optimization of incident management strategies. the endpoint returns details about each trigger, which may include its configuration, associated workflow, and activation criteria. note that this endpoint only provides information about existing triggers and does not allow for the creation or modification of triggers.
</Accordion>

<Accordion title="Retrieve service by id">
  Retrieves detailed information about a specific pagerduty service using its unique identifier. this endpoint allows users to access configuration details, integration settings, and other relevant information for a particular service within their pagerduty account. it's essential for managing and monitoring the status of individual services, which are core components in pagerduty's incident management system. use this endpoint when you need to inspect or verify the configuration of a specific service, such as before making updates or troubleshooting issues related to that service. the endpoint provides a comprehensive view of the service but does not allow modifications; for updates, a separate put or patch endpoint would be required.
</Accordion>

<Accordion title="Retrieve user contact methods via id">
  Retrieves all contact methods associated with a specific user in pagerduty. this endpoint allows you to fetch the various ways a user can be contacted during an incident, such as email addresses, phone numbers, or push notifications to mobile devices. it's particularly useful when you need to review or update a user's notification preferences or ensure that the correct contact information is on file. the endpoint returns a list of contact methods, likely including details such as the type of contact method, the specific address or number, and possibly the status (e.g., verified, primary). it should be used when setting up new users, auditing user information, or integrating pagerduty with other communication systems. note that this endpoint only provides read access to contact methods and cannot be used to add, modify, or remove contact information.
</Accordion>

<Accordion title="Retrieve status pages status">
  Retrieves the current statuses for a specified pagerduty status page. this endpoint allows users to fetch real-time status information for a given status page, providing up-to-date details on service availability and any ongoing issues. it's particularly useful for monitoring the current state of services, especially during incident management processes. the endpoint should be used when there's a need to programmatically access the latest status information for a specific status page, enabling integration with other systems or dashboards for enhanced visibility of service health.
</Accordion>

<Accordion title="Retrieve maintenance windows">
  Retrieves a list of maintenance windows from the pagerduty incident management platform. maintenance windows are scheduled periods during which alerts and notifications for specified services are suppressed to allow for system maintenance or updates without triggering unnecessary incidents. this endpoint should be used to get an overview of all maintenance windows, their schedules, and affected services. it supports filtering by team, service, and search query, as well as pagination for handling large result sets. the endpoint is particularly useful for reviewing upcoming maintenance schedules, auditing past maintenance windows, or integrating maintenance information into external systems or dashboards.
</Accordion>

<Accordion title="Retrieve user notification rule">
  Retrieves a specific notification rule for a given user in pagerduty. this endpoint allows you to fetch detailed information about how and when a particular user receives alerts and notifications. it's useful for auditing user preferences, troubleshooting notification issues, or when you need to review or potentially update a user's notification settings. the endpoint returns the configuration of the specified rule, including contact methods, time-based restrictions, and urgency levels. it should be used when you need to examine or verify the settings of a particular notification rule for a user, but it won't provide an overview of all rules or allow modifications to the rule.
</Accordion>

<Accordion title="Retrieve service change events by id">
  Retrieves change events associated with a specific pagerduty service. this endpoint allows you to fetch informational updates about recent changes such as code deploys, system configuration modifications, and other significant alterations related to the specified service. it's particularly useful for tracking and auditing changes that might impact service performance or reliability. the endpoint should be used when you need to review the history of changes for a service, investigate potential causes of incidents, or maintain a log of service modifications for compliance purposes. note that this endpoint focuses solely on change events and does not provide real-time incident data or service configuration details.
</Accordion>

<Accordion title="Retrieve automation action runner teams">
  Retrieves detailed information about a specific team associated with an automation actions runner in pagerduty. this endpoint is used to get insights into the relationship between a runner and a particular team, which is crucial for understanding access permissions and management of automation tasks. it should be used when you need to confirm team associations, verify permissions, or gather team-specific details related to a runner. the endpoint does not modify any data and is primarily for information retrieval purposes. note that this endpoint focuses on a single team-runner relationship and does not provide a comprehensive list of all teams associated with a runner or vice versa.
</Accordion>

<Accordion title="Retrieve standards scores by resourcetype">
  Retrieves the standards scores for a specified resource type in pagerduty. this endpoint allows users to access performance metrics and evaluations based on predefined standards for different components of their incident management system. it's useful for assessing the effectiveness of various resources against established benchmarks, helping teams identify areas for improvement and maintain high-quality incident response processes. the endpoint should be used when seeking quantitative insights into the performance of specific pagerduty resource types against industry or internal standards.
</Accordion>

<Accordion title="Retrieve standards list">
  Retrieves the current set of standards defined in the pagerduty account. standards in pagerduty refer to the policies and best practices for incident response and alerting. this endpoint allows users to fetch the configured standards, which may include response time goals, escalation policies, and other operational guidelines. it's particularly useful for administrators and team leads who need to review or audit the current incident management standards across their organization. the endpoint does not allow for modification of standards; it's strictly for retrieval purposes. users should note that the response may include all standards across the account, which could be extensive for large organizations.
</Accordion>

<Accordion title="Retrieve user by id">
  Retrieves detailed information about a specific user in the pagerduty platform using their unique identifier. this endpoint is used to fetch user account details, such as contact information, role assignments, and notification rules. it's particularly useful when you need to access or verify a user's current information within your incident management workflow. the endpoint returns a comprehensive user profile, but it does not provide information about the user's current on-call status or incident history.
</Accordion>

<Accordion title="Retrieve user audit records by id">
  Retrieves the audit records for a specific user in the pagerduty system. this endpoint allows you to access a historical log of activities and changes associated with the user, providing valuable insights for compliance, security, and troubleshooting purposes. the audit records may include actions such as login attempts, configuration changes, and incident-related activities performed by or affecting the specified user. use this endpoint when you need to investigate user activities, track changes, or generate reports for auditing and compliance requirements. note that the response may be paginated, and additional query parameters might be available to filter or sort the results, although these are not explicitly defined in the given schema.
</Accordion>

<Accordion title="Snooze incident by duration">
  This endpoint allows you to snooze a specific incident in pagerduty for a defined duration. it temporarily pauses alerts and notifications for the incident, after which it automatically returns to an active state. use this when you need to temporarily suppress notifications for an incident that's being worked on or requires a planned delay in response. the snooze action is particularly useful for managing alert fatigue, handling false positives, or delaying responses during maintenance windows. note that snoozing an incident does not resolve it; it simply delays further notifications until the snooze period ends or is manually cleared.
</Accordion>

<Accordion title="Retrieve team audit records">
  Retrieves the audit records for a specific team in pagerduty. this endpoint allows users to access a detailed history of configuration changes made to the team, including modifications to team members, escalation policies, and other team-related settings. it's particularly useful for security auditing, compliance reporting, and tracking the evolution of team structures over time. the endpoint returns a list of audit records, each likely containing information such as the type of change, who made the change, and when it occurred. use this endpoint when you need to review or analyze the historical changes of a pagerduty team's configuration.
</Accordion>

<Accordion title="Set global priority threshold">
  Sets the global priority threshold for business services in pagerduty, determining which incidents can impact these services based on their priority level. this endpoint allows you to configure the minimum incident priority required to affect business services by specifying an 'id' and 'order' for the threshold. use this when you need to adjust how incidents of different priorities impact your business services. note that incidents below this threshold won't impact business services unless manually added using a separate endpoint. this configuration is crucial for managing service impacts and prioritizing incident responses effectively.
</Accordion>

<Accordion title="Retrieve user license information">
  Retrieves the license information for a specific user in the pagerduty system. this endpoint allows you to check the current licensing status, type, and any associated details for a given user. it should be used when you need to verify a user's license, such as during account management or when troubleshooting access issues. the endpoint will return details about the user's current license, but it does not provide information about other aspects of the user's account or permissions. keep in mind that access to this endpoint may be restricted to users with appropriate administrative privileges.
</Accordion>

<Accordion title="Retrieve rules for service id">
  Retrieves all rules associated with a specific pagerduty service. this endpoint allows users to fetch the set of rules that define when and how incidents are triggered for a particular service. it's essential for understanding the current automation and alert routing setup for a given service. use this endpoint when you need to audit, review, or programmatically access the rule configurations for a service. the endpoint returns rule details but does not provide information about ongoing incidents or service status. it's particularly useful for integrations that need to sync or analyze rule configurations across multiple services or external systems.
</Accordion>

<Accordion title="Retrieve user notification rules">
  Retrieves the notification rules for a specific user in pagerduty. this endpoint allows you to fetch all configured notification rules associated with a given user, providing insight into how and when the user receives alerts for incidents. it's particularly useful for auditing a user's notification setup, troubleshooting notification issues, or programmatically managing user preferences. the endpoint returns a list of notification rules, likely including details such as contact methods, time-based restrictions, and urgency levels for each rule. it should be used when you need to review or analyze a user's current notification configuration within your incident management workflow.
</Accordion>

<Accordion title="Retrieve technical service details">
  Retrieves detailed information about a specific technical service and its dependencies within the pagerduty incident management platform. this endpoint is used to fetch comprehensive data about a single technical service, including its relationships with other services, its role in the overall service dependency structure, and any associated metadata. it's particularly useful for understanding the impact and connections of a specific service within an organization's technical infrastructure. the endpoint should be used when detailed information about a particular technical service's dependencies and relationships is needed, such as during incident analysis, service mapping, or system architecture reviews. it does not modify any data and is safe for frequent use in monitoring or dashboard applications.
</Accordion>

<Accordion title="Retrieve webhook subscriptions">
  Retrieves a list of all webhook subscriptions associated with the authenticated pagerduty account. this endpoint allows users to view and manage their existing webhook configurations, which are used to receive real-time notifications about incidents, alerts, and other pagerduty events. it's particularly useful for auditing current integrations, troubleshooting notification issues, or preparing to update webhook settings. the response likely includes details such as webhook urls, event types they're subscribed to, and their current status. this endpoint should be used when you need an overview of all active webhook integrations but won't provide the actual event data sent to these webhooks.
</Accordion>

<Accordion title="Retrieve notes for incident">
  Retrieves all notes associated with a specific incident in pagerduty. this endpoint allows users to access the complete history of comments, updates, and additional information added to an incident throughout its lifecycle. it is particularly useful for reviewing the incident's progress, understanding the actions taken, and gathering context for post-incident analysis. the endpoint should be used when detailed information about an incident's communication trail is needed, such as during incident reviews or when compiling reports. it does not provide real-time updates and may not include the most recent notes if called immediately after a new note is added due to potential api caching.
</Accordion>

<Accordion title="Retrieve service impacts from status dashboards">
  Retrieves the service impacts associated with a specific status dashboard in pagerduty. this endpoint allows users to fetch detailed information about how incidents are affecting various services within the context of a particular status dashboard. it should be used when there's a need to assess the current operational status and impact of incidents on services for a given dashboard. the endpoint provides real-time insights into service disruptions, helping teams quickly identify and prioritize issues. note that this endpoint only returns data for a single status dashboard at a time and does not provide historical impact data.
</Accordion>

<Accordion title="Subscribe entities to business services">
  This endpoint allows you to subscribe users or teams to a specific business service in pagerduty. it enables you to add multiple subscribers in a single request, streamlining the process of setting up notification recipients for critical incidents. use this endpoint when you need to configure who receives alerts and updates for a particular business service. the endpoint is particularly useful for initial setup or bulk updates to subscriber lists. note that this operation adds new subscribers but does not remove existing ones; to remove subscribers, you would need to use a separate endpoint.
</Accordion>

<Accordion title="Subscribe entities to incident status updates">
  Subscribes specified users or teams to receive status updates for a particular incident in pagerduty. this endpoint allows you to add multiple subscribers at once, ensuring that relevant parties are kept informed about the incident's progress. it's particularly useful when you need to involve additional stakeholders or support teams during an ongoing incident. the endpoint requires the incident id and a list of subscribers, each defined by their unique id and type (user or team). use this when you want to expand the notification list for critical updates about an incident, but be mindful not to oversubscribe, as it may lead to notification fatigue.
</Accordion>

<Accordion title="Unsubscribe business service entity">
  This endpoint unsubscribes specified users or teams from receiving notifications for a particular business service in pagerduty. it allows bulk unsubscription of multiple entities in a single api call. the endpoint should be used when you need to remove one or more users or teams from the notification list of a specific business service, such as when reorganizing team responsibilities or updating notification preferences. it's important to note that this action is immediate and irreversible, so care should be taken to ensure the correct entities are being unsubscribed. the endpoint doesn't provide a way to confirm or preview the changes before they're applied, so it's recommended to double-check the subscriber information before making the api call.
</Accordion>

<Accordion title="Retrieve rules from ruleset by id">
  Retrieves a list of all rules associated with a specific ruleset in pagerduty. this endpoint is used to examine the configuration of event routing within a particular ruleset, allowing users to review and understand how incoming events are processed and handled. it's particularly useful for auditing, troubleshooting, or preparing to modify event handling logic. the endpoint returns details about each rule, likely including conditions, actions, and priorities, providing a comprehensive view of the ruleset's behavior. while it doesn't modify any data, it's an essential tool for managing and maintaining effective incident response workflows in pagerduty.
</Accordion>

<Accordion title="Retrieve user status update notification rule">
  Retrieves a specific status update notification rule for a given user in pagerduty. this endpoint allows you to fetch detailed information about how and when a particular user receives notifications for status updates on incidents. it's useful for auditing notification settings, troubleshooting notification issues, or programmatically managing user preferences. the endpoint should be used when you need to review or verify the configuration of a single notification rule for a specific user. it does not modify any settings and is read-only in nature.
</Accordion>

<Accordion title="Retrieve status page post">
  Retrieves all posts associated with a specific status page in pagerduty. this endpoint allows users to fetch updates, messages, and status information that have been posted to a particular status page. it's useful for monitoring the history of service status updates, incident communications, or maintenance notices for a given status page. the endpoint returns a list of posts, likely including details such as post content, timestamp, and author information. it should be used when you need to review or display the communication history related to service statuses or incidents tracked on a specific pagerduty status page. note that this endpoint only provides read access to existing posts and cannot be used to create, modify, or delete posts.
</Accordion>

<Accordion title="Unsubscribe from incident status updates">
  Unsubscribes specified users or teams from receiving status updates for a particular incident in pagerduty. this endpoint is used when certain entities no longer need to be notified about changes to an incident's status. it allows for bulk unsubscription of multiple users and/or teams in a single api call. the endpoint requires the incident id in the url path and a list of subscribers to unsubscribe in the request body. it's important to note that this action cannot be undone through the api, and re-subscription would require a separate api call if needed later.
</Accordion>

<Accordion title="Unsubscribe team notification subscriptions">
  Unsubscribes a team from notifications for specific incidents or business services in pagerduty. this endpoint is used to stop a team from receiving alerts and updates about particular entities. it's particularly useful for managing notification overload or when a team is no longer responsible for certain incidents or services. the endpoint requires a list of subscribables (entities to unsubscribe from), each identified by a unique id and type. at least one subscribable must be provided, and all items in the list must be unique. this operation cannot be undone through this endpoint, so use it cautiously.
</Accordion>

<Accordion title="Retrieve template fields">
  Retrieves the available fields for pagerduty templates. this endpoint provides a comprehensive list of all possible fields that can be used when creating or modifying templates within the pagerduty platform. it is particularly useful for developers and administrators who need to understand the structure and available options for template customization. the endpoint should be used when building interfaces for template management, automating template creation, or gathering information about the configurable aspects of pagerduty templates. it does not modify any existing templates or create new ones; it only provides information about the available fields.
</Accordion>

<Accordion title="Unsubscribe user notification subscriptions">
  This endpoint allows unsubscribing a user from notifications for specific incidents or business services in pagerduty. it's used to modify a user's notification preferences, removing them from receiving updates about particular entities. the endpoint accepts a list of subscribable entities, each identified by an id and type, and removes the user's subscription to these entities. this is particularly useful for managing notification overload or when a user no longer needs updates about certain incidents or services. the endpoint requires at least one subscribable entity and ensures that all entries in the request are unique.
</Accordion>

<Accordion title="Update automation runner info">
  This endpoint allows you to update an existing automation action runner in pagerduty. it is used to modify the properties of a runner, such as its name, description, and, for runbook runners, the runbook server connection details. the endpoint supports updating both sidecar and runbook type runners, distinguished by the 'runner type' discriminator. use this endpoint when you need to change the configuration of an existing runner, such as updating its name for better identification or modifying the runbook server details. note that while you can update most properties, you cannot change a runner's type (e.g., from sidecar to runbook) using this endpoint.
</Accordion>

<Accordion title="Update an incident type">
  Update an incident type. incident types are a feature which will allow customers to categorize incidents, such as a security incident, a major incident, or a fraud incident. \<!-- theme: warning --> > ### early access > this endpoint is in early access and may change at any time. you must pass in the x-early-access header to access it. for more information see the [api concepts document](../../api-reference/zg9joji3ndc5nzc-api-concepts#incident) scoped oauth requires: `incident types.write`
</Accordion>

<Accordion title="Send responder requests for incidents">
  This endpoint allows you to send responder requests for a specific incident in pagerduty. it is used to request additional help or notify specific users or escalation policies about an ongoing incident that requires attention. the endpoint creates a new responder request associated with the incident identified by the \{id} path parameter. it's particularly useful when you need to quickly engage additional resources or escalate an incident to ensure timely resolution. this tool should be used when there's a need to bring in more responders or escalate an incident beyond its current assigned team. it's important to note that this endpoint doesn't resolve the incident itself but facilitates the process of engaging additional help.
</Accordion>

<Accordion title="Update alert grouping settings byid">
  This endpoint allows you to update an existing alert grouping setting in pagerduty. alert grouping settings define how alerts are automatically grouped into incidents, helping to streamline incident management and reduce noise. you can modify various aspects of the grouping configuration, including the grouping type (content-based or intelligent), time window, and the fields used for grouping. this tool is particularly useful when you need to refine your alert grouping strategy to improve incident response efficiency. note that some features, such as intelligent grouping, may only be available on certain pagerduty plans. when using this endpoint, ensure that you provide all required fields in the request body, as partial updates are not supported.
</Accordion>

<Accordion title="Retrieve vendor by id">
  Retrieves detailed information about a specific vendor integrated with pagerduty. this endpoint allows users to access comprehensive data about a vendor, including its name, type of integration, capabilities, and current status within the pagerduty ecosystem. it's particularly useful when you need to verify vendor details, check integration status, or gather information for reporting and auditing purposes. the endpoint returns a single vendor object and should be used when specific vendor information is required, rather than for listing multiple vendors.
</Accordion>

<Accordion title="Retrieve status page severities by id">
  Retrieves the list of severities associated with a specific status page in pagerduty. this endpoint allows users to fetch the current severity levels configured for a particular status page, which is crucial for understanding the criticality of incidents or service statuses displayed on that page. it should be used when there's a need to programmatically access or display the severity information for a given status page, such as in monitoring dashboards or integrated incident management systems. the endpoint provides only the severity data and does not modify any existing configurations.
</Accordion>

<Accordion title="Update a field option for a custom field">
  Update a field option for a custom field. \<!-- theme: warning --> > ### early access > this endpoint is in early access and may change at any time. you must pass in the x-early-access header to access it. scoped oauth requires: `custom fields.write`
</Accordion>

<Accordion title="Set business service impact status">
  This endpoint updates the impact status of a specific incident on a particular business service in pagerduty. it allows you to either set a business service as impacted by an incident or remove the impact, which in turn affects the propagation of the impact to other supported services. use this endpoint when you need to manually adjust the impact of an incident on your business services, either to escalate its importance or to mark it as resolved for specific services. this tool is particularly useful for managing the scope and severity of incidents across your organization's service hierarchy. note that updating the impact status will have cascading effects on services supported by the targeted business service.
</Accordion>

<Accordion title="Retrieve users by schedule id">
  Retrieves a list of users associated with a specific pagerduty schedule. this endpoint is essential for managing on-call rotations and understanding who is responsible for incident response during different time periods. it should be used when you need to view all users assigned to a particular schedule, which is helpful for auditing, planning, or modifying on-call arrangements. the endpoint returns basic user information and does not provide detailed schedule timeslots or user availability. it's particularly useful for larger teams with complex rotation schedules to ensure proper coverage and fair distribution of on-call responsibilities.
</Accordion>

<Accordion title="Update alert in incident">
  Updates the status of a specific alert within an incident in pagerduty. this endpoint allows you to modify an alert's status, primarily to mark it as resolved. it's crucial for managing the lifecycle of alerts and incidents in pagerduty's incident management system. use this when you need to programmatically update the state of an alert, typically as part of an automated incident resolution process or when integrating external systems with pagerduty. note that while the endpoint accepts various fields in the request body, most are read-only, with the 'status' field being the primary modifiable attribute.
</Accordion>

<Accordion title="Update add on by id">
  Updates an existing add-on in pagerduty with new properties. this endpoint allows you to modify the type, name, and source url of a specific add-on identified by its unique id. it's used when you need to change the configuration or appearance of an add-on that's already integrated into your pagerduty instance. the endpoint updates only the mutable fields and returns the full updated add-on object, including read-only fields. note that this operation cannot modify the add-on's id or other system-generated fields like 'summary', 'self', or 'html url'.
</Accordion>

<Accordion title="Update a custom field for an incident type">
  Update a custom field for an incident type. custom fields (cf) are a feature which will allow customers to extend incidents with their own custom data, to provide additional context and support features such as customized filtering, search and analytics. custom fields can be applied to different incident types. \<!-- theme: warning --> > ### early access > this endpoint is in early access and may change at any time. you must pass in the x-early-access header to access it. scoped oauth requires: `custom fields.write`
</Accordion>

<Accordion title="Subscribe to user notifications">
  Creates notification subscriptions for a specific user in pagerduty. this endpoint allows you to subscribe a user to multiple incidents or business services in a single api call. it's particularly useful for setting up customized notification preferences for users, ensuring they receive alerts for specific entities they need to monitor. the endpoint supports bulk subscription, allowing you to subscribe a user to multiple entities simultaneously, improving efficiency in managing user notifications. note that this endpoint only creates subscriptions and does not modify or delete existing ones.
</Accordion>

<Accordion title="Retrieve status page subscription by id">
  Retrieves a list of subscriptions associated with a specific pagerduty status page. this endpoint allows users to fetch all current subscriptions for a given status page, enabling them to monitor who is receiving updates about the status page. it should be used when you need to review or audit the subscription list for a particular status page. the endpoint provides subscription details but does not allow for modification of subscriptions. note that the response may be paginated for status pages with a large number of subscriptions.
</Accordion>

<Accordion title="Retrieve unrouted event orchestration by id">
  Retrieves a list of unrouted events for a specific event orchestration in pagerduty. this endpoint is used to identify and review events that have not yet been assigned or processed within the designated event orchestration workflow. it's particularly useful for monitoring the efficiency of your incident management process and ensuring that no critical events are left unattended. the endpoint should be used when you need to audit your event handling, identify potential bottlenecks in your orchestration setup, or manually intervene with unprocessed events. note that this endpoint only provides information about unrouted events and does not allow for direct manipulation of these events.
</Accordion>

<Accordion title="Retrieve users list">
  Retrieves a list of users from the pagerduty system. this endpoint allows you to fetch information about multiple users in your pagerduty account, which can be useful for user management, generating reports, or integrating user data with other systems. the response typically includes basic information about each user, such as their id, name, email, and role. use query parameters to filter, paginate, or search for specific users. this endpoint is ideal for bulk operations or when you need an overview of your pagerduty user base. note that the results may be paginated, so multiple calls might be necessary to retrieve all users for large accounts.
</Accordion>

<Accordion title="Retrieve tags">
  Retrieves a list of all tags currently used within the pagerduty account. this endpoint provides a comprehensive view of the tags used for categorization and labeling of incidents across the system. it should be used when you need an overview of all available tags for incident management, reporting, or when setting up new incident routing rules. the endpoint returns all tags without any filtering, which may result in a large dataset for accounts with extensive tag usage. it does not provide information about which incidents or entities are associated with each tag.
</Accordion>

<Accordion title="Update business service by id">
  This endpoint allows you to update an existing business service in pagerduty. it is used to modify the details of a specific service, such as its name, description, point of contact, or the team responsible for it. this is particularly useful when service information changes or when reassigning responsibilities within your organization. the endpoint requires the unique identifier of the business service and accepts a json object with the updated information. it's important to note that you only need to include the fields you want to update; omitted fields will retain their current values.
</Accordion>

<Accordion title="Update log entry channel">
  Updates the channel information for a specific log entry in pagerduty. this endpoint allows you to modify the details of how notifications are delivered for a particular log entry, while maintaining the original channel type. it's useful for refining or correcting the notification settings of an existing log entry. the endpoint requires the log entry id in the url path and accepts a json payload with updated channel information. note that while you can update the channel details, you cannot change the channel type, which must match the existing value.
</Accordion>

<Accordion title="Update change event by id">
  Updates an existing change event in pagerduty. this endpoint allows you to modify certain attributes of a change event, such as its summary or custom details. it's used when you need to amend or add information to a previously created change event, perhaps due to new developments or corrections. the endpoint requires the change event's unique id and accepts an object with the fields to be updated. note that many fields (e.g., timestamp, services, integration) are read-only and cannot be modified through this endpoint. use this when you need to refine or expand upon the information in an existing change event, but be aware of its limitations in terms of which fields can be updated.
</Accordion>

<Accordion title="Update custom field option">
  Updates a specific field option for a custom field in pagerduty's incident management system. this endpoint allows you to modify the value of an existing field option, providing flexibility in managing and customizing incident fields. it's particularly useful when you need to rename or adjust the available options for a custom field in response to changing operational needs or terminology updates. the endpoint ensures that only mutable properties are updated while preserving system-managed attributes like creation timestamps. use this when you need to refine or correct the options available for incident classification or categorization within your pagerduty workflow.
</Accordion>

<Accordion title="Update incident by id">
  The updateincident endpoint allows you to modify various attributes of an existing incident in pagerduty's incident management system. this put operation enables users to update incident status, priority, assignments, escalation levels, and other key properties. it's particularly useful for reflecting the current state of an incident, reassigning responsibilities, or adjusting the incident's urgency and escalation path. the endpoint should be used when there are significant changes to an incident that need to be reflected in the system, such as acknowledging the incident, marking it as resolved, or changing its priority. it's important to note that this endpoint updates an existing incident and does not create new incidents. care should be taken when modifying critical fields like status or escalation policy, as these changes can significantly impact the incident management workflow.
</Accordion>

<Accordion title="Update event rule by id">
  This endpoint allows you to update an existing event rule within a specified ruleset in pagerduty. event rules define conditions for matching events and actions to take when those conditions are met. you can modify various aspects of the rule, including its active status, matching conditions, time frames, variables, position in the ruleset, and associated actions. this endpoint is particularly useful for fine-tuning your incident management workflow, adjusting how events are processed, and controlling alert behavior. it's important to note that changes made through this endpoint will immediately affect how incoming events are handled, so careful consideration should be given to the potential impact on your alerting system.
</Accordion>

<Accordion title="Update extension by id">
  Updates an existing extension in pagerduty. this endpoint allows you to modify the configuration of a previously created extension, such as a webhook or custom integration. you can update properties like the extension's name, endpoint url, associated objects, and custom configuration. this is useful for maintaining and adjusting integrations as your operational needs change. the endpoint requires the extension's id in the url path and accepts a json payload with the updated extension details. it's important to note that some fields, like the extension's id and type, are read-only and cannot be modified through this endpoint.
</Accordion>

<Accordion title="Update integration label">
  This endpoint updates the label (name) of an integration associated with a specific event orchestration in pagerduty. it allows users to rename integrations for better organization and clarity within their incident management workflow. the endpoint should be used when there's a need to change how an integration is identified within the pagerduty system, such as after a service rename or to improve naming conventions. it's important to note that this endpoint only updates the label of the integration and does not modify any other properties or configurations of the integration or event orchestration.
</Accordion>

<Accordion title="Update oncall handoff notification rule">
  This endpoint updates an existing on-call handoff notification rule for a specific user in pagerduty. it allows you to modify the notification delay, handoff type, and contact method for the rule. use this endpoint when you need to change how and when a user is notified about upcoming on-call shifts or when they are going off-call. the endpoint requires both the user id and the specific rule id in the url path. you can update the notification delay (in minutes), the type of handoff (both, oncall, or offcall), and the preferred contact method for the notification. this endpoint is particularly useful for adjusting notification preferences as team structures or individual availability changes.
</Accordion>

<Accordion title="Update a trigger">
  Update an existing incident workflow trigger scoped oauth requires: `incident workflows.write`
</Accordion>

<Accordion title="Update maintenance window by id">
  Updates an existing maintenance window in pagerduty's incident management system. this endpoint allows you to modify the details of a scheduled maintenance period, including its start and end times, affected services, and description. it's used to adjust planned maintenance activities, ensuring that incidents are not created for specified services during the defined timeframe. the endpoint requires the maintenance window's unique id and accepts a json object with the updated information. it's particularly useful for extending or shortening maintenance periods, changing the list of affected services, or updating the window's description in response to changing maintenance requirements.
</Accordion>

<Accordion title="Update escalation policy for team">
  This endpoint updates an existing escalation policy for a specific team in pagerduty. it modifies incident escalation rules within the team context, crucial for maintaining up-to-date response workflows. use this when changes to the team's escalation process are needed, such as adjusting notification rules or modifying escalation steps. note that it only updates the team-policy association, not the global policy configuration.
</Accordion>

<Accordion title="Update cache variable configuration or conditions">
  This endpoint updates a cache variable associated with a specific service in pagerduty's event orchestrations. it allows you to modify the cache variable's name, configuration, conditions, and disabled state. use this endpoint when you need to change how a cache variable behaves, such as updating its value extraction method or trigger event count settings. the endpoint is particularly useful for fine-tuning event processing rules and maintaining dynamic incident management workflows. note that some fields like id, creation date, and last update information are read-only and cannot be modified through this endpoint.
</Accordion>

<Accordion title="Update event orchestration cache variable">
  This endpoint allows you to update an existing cache variable within a specific event orchestration in pagerduty. cache variables are used to store and manipulate dynamic data extracted from events, enabling complex event routing and automation. you can modify the cache variable's name, configuration, conditions, and disabled state. the endpoint is particularly useful when you need to adjust how event data is processed or stored within your incident management workflows. it's important to note that this operation will overwrite the existing cache variable properties, so you should include all desired fields in your update request, not just the ones you want to change.
</Accordion>

<Accordion title="Update event rule for service">
  This endpoint allows you to update an existing event rule for a specific service in pagerduty. event rules are used to define how incoming events should be processed, including conditions for matching events and actions to take when a match occurs. you can modify various aspects of the rule, such as its conditions, time-based restrictions, variables for extraction, and actions to perform on matching events. this endpoint is particularly useful for fine-tuning event management processes, adjusting rule priorities, or temporarily disabling rules without removing them entirely. it provides granular control over event handling, allowing for sophisticated automation and incident management workflows.
</Accordion>

<Accordion title="Update incident alerts">
  This endpoint allows you to update the status of multiple alerts associated with a specific incident in pagerduty. it is particularly useful for bulk operations when you need to resolve or update the status of several alerts simultaneously within the context of a single incident. the endpoint accepts an array of alert objects, each containing the necessary information for the update. it's important to note that this endpoint modifies existing alerts and cannot be used to create new alerts or incidents. use this when you need to efficiently manage and update the state of multiple alerts tied to an ongoing incident.
</Accordion>

<Accordion title="Update escalation policy by id">
  Updates an existing escalation policy in pagerduty with new settings and rules. this endpoint allows you to modify various aspects of an escalation policy, including its name, description, escalation rules, associated services, and team. it's used when you need to change how incidents are escalated and handled within your organization. the updated policy details are provided in the request body, and the policy to be updated is identified by its id in the url path. this tool is essential for maintaining and adjusting incident response workflows in pagerduty to ensure optimal team responsiveness and incident management.
</Accordion>

<Accordion title="Update status page post postmortem">
  Updates or creates a postmortem for a specific post on a pagerduty status page. this endpoint allows users to add detailed analysis and insights about an incident after its resolution. it's primarily used for communicating the cause, impact, and lessons learned from an incident to stakeholders and subscribers. the postmortem can include rich text content for comprehensive explanations. users can control whether subscribers are notified about the postmortem update, making it flexible for both major updates and minor edits. this endpoint is crucial for maintaining transparency and improving incident management processes.
</Accordion>

<Accordion title="Update workflow integration connection">
  Update an existing workflow integration connection. scoped oauth requires: `workflow integrations:connections.write`
</Accordion>

<Accordion title="Update event orchestration by id">
  Updates an existing event orchestration in pagerduty. this endpoint allows you to modify the name, description, and team ownership of a specific orchestration identified by its id. it's used to refine and adjust your incident management workflow by updating the configuration of how events are processed and routed. this tool is particularly useful when you need to change the purpose, ownership, or details of an orchestration without creating a new one. note that certain properties like integrations, routing information, and timestamps are read-only and cannot be modified through this endpoint. use this when you need to update an orchestration's metadata or reassign it to a different team.
</Accordion>

<Accordion title="Update incident details">
  This endpoint allows for bulk updating of multiple pagerduty incidents in a single api call. it can be used to modify various attributes of incidents such as status, priority, assignments, and more. this is particularly useful for automating incident management processes, batch resolving or acknowledging incidents, or updating incident details en masse. the endpoint accepts an array of incident objects, each containing the necessary updates, allowing for efficient management of multiple incidents simultaneously. it's important to note that while many fields are optional, each incident object must include the 'id' and 'type' fields for proper identification and processing.
</Accordion>

<Accordion title="Update incident custom field values">
  This endpoint updates custom field values for a specific incident in pagerduty. it allows you to modify or add custom fields to provide additional context or information about the incident. the endpoint is particularly useful when you need to update incident metadata dynamically, such as changing the environment, priority, or any other custom attributes associated with the incident. it supports various data types for field values, including boolean, numeric, string, array, date-time, and uri formats, providing flexibility in storing different types of information. this operation is idempotent, meaning repeated identical requests will not create additional changes beyond the initial request. however, be cautious when updating fields, as this will overwrite existing values for the specified fields.
</Accordion>

<Accordion title="Update customfield displayname">
  This endpoint updates an existing custom field for incidents in pagerduty. it allows you to modify the display name, description, and default value of a custom field identified by its unique field id. use this endpoint when you need to change the properties of a custom field, such as renaming it, updating its description, or setting a new default value. the update maintains data integrity by enforcing specific constraints on field properties, ensuring consistency across the pagerduty incident management system. note that updating a custom field affects all incidents that use this field, so use this endpoint cautiously in production environments.
</Accordion>

<Accordion title="Update orchestration router details">
  Updates the configuration of an existing event orchestration router in pagerduty. this endpoint allows you to modify the rules and routing logic for incoming events, determining how they are directed to specific services. it's used to refine and adjust your incident management workflow by updating conditions, actions, and catch-all behavior for event routing. the update is comprehensive, meaning any omitted rules or details will be deleted from the existing configuration. use this endpoint when you need to make changes to your event routing strategy or when adding new services or conditions to your orchestration setup.
</Accordion>

<Accordion title="Update incident workflow">
  This endpoint updates an existing incident workflow in pagerduty by its unique identifier. it allows you to modify various aspects of the workflow, including its name, description, associated team, and the sequence of steps to be executed during an incident. the primary use case is to refine or adjust incident response processes by altering the workflow's configuration. this is particularly useful when incident management practices need to be updated based on new requirements or lessons learned from previous incidents. the endpoint provides granular control over each step in the workflow, allowing for precise tuning of automated actions and their inputs. however, it's important to note that modifying a workflow may impact ongoing or future incident responses, so changes should be made thoughtfully and tested thoroughly before implementation in a production environment.
</Accordion>

<Accordion title="Update response play by id">
  Updates an existing response play in pagerduty's incident management system. this endpoint allows you to modify various aspects of a response play, including its name, description, associated team, subscribers, responders, runnability, and conference details. use this when you need to alter the behavior or configuration of an existing response play to better suit your incident response processes. the update is performed by specifying the response play's unique identifier and providing the updated information in the request body. this endpoint is particularly useful for refining your incident management automation based on evolving team structures, communication preferences, or response strategies.
</Accordion>

<Accordion title="Update ruleset by id">
  Updates an existing ruleset in the pagerduty incident management system. this endpoint allows you to modify the name of a ruleset or change its team association. it's used when you need to adjust the configuration of a specific ruleset, such as renaming it for better clarity or reassigning it to a different team. the endpoint requires the ruleset's unique id and accepts updates to the name and team fields. it's important to note that other fields like routing keys, creation details, and update history are read-only and cannot be modified through this call. this endpoint is particularly useful for maintaining and organizing rulesets as your incident management needs evolve.
</Accordion>

<Accordion title="Update schedule by id">
  The updateschedule endpoint modifies an existing on-call schedule in pagerduty. it updates the schedule's name, time zone, description, and layers. each layer defines a rotation pattern for on-call duties. use this to adjust rotations, add/remove users, change time zones, or modify restrictions. note: this replaces the entire schedule configuration, so include all desired layers and settings, even if only changing part of the schedule.
</Accordion>

<Accordion title="Update service by id">
  Updates an existing service in pagerduty with the provided configuration. this endpoint allows you to modify various aspects of a service, such as its name, description, escalation policy, incident urgency rules, and alert grouping settings. use this when you need to change the behavior or properties of an existing service. the endpoint requires the service id and accepts a 'service' object containing the updated configuration. note that some properties (like 'id' and 'created at') are read-only and cannot be modified. certain advanced features, such as alert grouping and auto-pause notifications, may only be available on specific pagerduty plans.
</Accordion>

<Accordion title="Update service orchestration active status">
  This endpoint updates the active status of a specific service orchestration in pagerduty. it allows you to activate or deactivate a service orchestration by setting its 'active' status. use this endpoint when you need to change the operational state of a service orchestration, such as during maintenance periods or when adjusting your incident management workflow. the endpoint requires the service id in the url path and accepts a json body with the 'active' boolean parameter. it's important to note that changing the active status may affect how incidents are routed and managed for the associated service, so use this endpoint judiciously and in accordance with your organization's incident management policies.
</Accordion>

<Accordion title="Update standard by id">
  Updates an existing standard in the pagerduty incident management platform. this endpoint allows you to modify various attributes of a standard, including its active status, filtering criteria, description, and the technical services it applies to. use this when you need to adjust the scope or behavior of an existing standard, such as enabling or disabling it, refining its application using regex patterns, or updating the list of included or excluded services. the changes made through this endpoint will affect how the standard is applied to your incident management processes, potentially impacting alerting and response workflows for the associated services.
</Accordion>

<Accordion title="Update user role on team">
  Updates the role of a specific user within a pagerduty team. this endpoint allows you to modify a user's permissions and responsibilities by changing their role in the team structure. use this when you need to promote, demote, or adjust a team member's access level. the new role affects the user's ability to view, respond to, or manage incidents within the team context. note that this operation only changes the user's role for the specified team and does not affect their roles in other teams or their global account permissions.
</Accordion>

<Accordion title="Update status page post">
  Updates an existing post update on a pagerduty status page. this endpoint allows you to modify the details of a specific post update, including its message, status, severity, impacted services, and notification settings. use this when you need to provide new information about an ongoing incident, change the status or severity of an issue, or update the list of affected services. it's particularly useful for keeping your audience informed about the progress of incident resolution or service status changes. the endpoint requires a comprehensive 'post update' object that encapsulates all the update details, ensuring that all necessary information is provided in a structured manner.
</Accordion>

<Accordion title="Update integration by id and integration id">
  Updates an existing integration for a specific pagerduty service. this endpoint allows you to modify the configuration of an integration, including its type, name, and various settings related to email processing for email-based integrations. it's particularly useful for adjusting how incoming data (especially emails) is processed and turned into incidents. use this endpoint when you need to change the behavior of an existing integration, such as updating email parsing rules, changing incident creation criteria, or modifying email filters. the endpoint requires the service id and integration id in the url path, and expects a comprehensive integration object in the request body. note that some fields like 'id', 'created at', and 'html url' are read-only and cannot be modified through this endpoint.
</Accordion>

<Accordion title="Update unrouted orchestration rules">
  Updates the unrouted orchestration rules for a specific event orchestration in pagerduty. this endpoint allows you to define how events that don't match any service-specific rules should be handled. it's used to create a fallback mechanism for event routing and manipulation, ensuring that all incoming events are processed appropriately. the update is comprehensive, meaning any omitted rules or rule details from the request will be deleted from the existing configuration. use this endpoint when you need to modify the global handling of unrouted events, such as changing default severities, updating event summaries, or implementing new routing logic for unmatched events.
</Accordion>

<Accordion title="Update user information">
  This endpoint allows updating an existing user's information in pagerduty. it is used to modify various attributes of a user's profile, including their name, email, time zone, role, and other details. the endpoint requires the user's id in the url path and accepts a json object containing the updated user information in the request body. it's particularly useful for maintaining up-to-date user records, changing user roles, or updating contact information. note that some fields, such as teams and contact methods, are read-only and cannot be modified through this endpoint.
</Accordion>

<Accordion title="Update the service orchestration for a service">
  Update a service orchestration. a service orchestration allows you to create a set of event rules. the service orchestration evaluates events sent to this service against each of its rules, beginning with the rules in the "start" set. when a matching rule is found, it can modify and enhance the event and can route the event to another set of rules within this service orchestration for further processing. for more information see the [api concepts document](../../api-reference/zg9joji3ndc5nzc-api-concepts#event-orchestrations) scoped oauth requires: `services.write`
</Accordion>

<Accordion title="Update user notification rule by id">
  Updates a specific status update notification rule for a pagerduty user. this endpoint allows you to modify how a user receives notifications about incident status changes. it's used to change the contact method (e.g., email, phone, push notification, or sms) for a particular notification rule. this is useful for adjusting user preferences or updating contact information. the endpoint requires the user's id and the specific notification rule id in the url path, ensuring precise updates to the intended rule.
</Accordion>

<Accordion title="Update status page post resource">
  This endpoint allows you to update an existing status page post on a specific pagerduty status page. it is used to modify the details of a post, such as its title, type (incident or maintenance), and timing information. the endpoint is particularly useful for updating the status of ongoing incidents or adjusting the details of planned maintenance activities. when using this endpoint, ensure that all required fields are provided, including the post type, title, and associated status page information. note that the starts at and ends at fields are only applicable and required for maintenance-type posts; for incident posts, these should be set to null.
</Accordion>

<Accordion title="Update template by id">
  The updatetemplate endpoint allows you to modify an existing status update template in pagerduty. this tool is used to customize notification templates for incident status updates, enabling consistent and efficient communication during incident management. it supports updating various aspects of the template, including its name, description, and content for different notification channels such as email and sms. this endpoint is particularly useful when you need to refine or adjust your communication strategy for incident updates. note that while you can update multiple fields, you cannot change the template type from 'status update', as it's currently the only supported type.
</Accordion>

<Accordion title="Update team by id">
  This endpoint allows you to update an existing team's information in pagerduty. it is used to modify team properties such as name, description, and access permissions (public/private). the endpoint should be used when you need to change team details or adjust team visibility within the organization. it's important to note that this endpoint can only modify mutable fields; read-only properties like 'id', 'summary', 'self', and 'html url' cannot be changed. when updating a team, ensure you provide all required fields, even if they haven't changed, to avoid unintended modifications to the team structure.
</Accordion>

<Accordion title="Update the global orchestration for an event orchestration">
  Update the global orchestration for an event orchestration. global orchestration rules allows you to create a set of event rules. these rules evaluate against all events sent to an event orchestration. when a matching rule is found, it can modify and enhance the event and can route the event to another set of global rules within this orchestration for further processing. for more information see the [api concepts document](../../api-reference/zg9joji3ndc5nzc-api-concepts#event-orchestrations) scoped oauth requires: `event orchestrations.write`
</Accordion>


# Pandadoc
Source: https://docs.push.ai/integrations/pandadoc



PandaDoc offers document creation, e-signatures, and workflow automation, helping sales teams and businesses streamline proposals, contracts, and agreement processes

<Accordion title="Create Document from File Upload">
  Creates a new document in pandadoc by uploading a file (pdf, docx, etc.). this tool converts existing documents into pandadoc documents for processing, signing, and tracking through the pandadoc system.
</Accordion>

<Accordion title="Create Contact">
  This tool creates a new contact in pandadoc. it allows you to add a new contact with their personal and professional information to your pandadoc account. the tool is completely independent and doesn't require any external resource ids or dependencies.
</Accordion>

<Accordion title="Create Document Attachment">
  Creates and adds an attachment to a pandadoc document. this tool allows you to attach downloadable files such as supplemental materials, excel spreadsheets, or other content without embedding them directly into the document. attachments can be added only to documents in 'document.draft' status, with a maximum of 10 files per document and a size limit of 50mb per file.
</Accordion>

<Accordion title="Create Document Folder">
  Creates a new folder in pandadoc to organize documents. this action allows users to create a new folder with a specified name and optionally set a parent folder to create a nested folder structure.
</Accordion>

<Accordion title="Get Template Details">
  This tool retrieves detailed information about a specific template by its id. the endpoint returns comprehensive template details including metadata, content details, and sharing settings.
</Accordion>

<Accordion title="List Contacts">
  A tool to list and search contacts in pandadoc. it retrieves a list of contacts with various options including filtering by email, search query, pagination, and shared status. all parameters are optional and it supports flexible queries to get contacts.
</Accordion>

<Accordion title="List Document Folders">
  This tool retrieves a list of all document folders in pandadoc. it's a standalone action that doesn't require any external dependencies or resource ids. the tool will return a list of folders containing documents, with each folder containing information about its id, name, and parent folder relationship.
</Accordion>

<Accordion title="List Templates">
  This tool retrieves a list of all templates available in the pandadoc account. it supports parameters to filter templates by name, shared status, deleted status, pagination, and tag filtering, and returns detailed template information.
</Accordion>

<Accordion title="Move Document to Folder">
  This tool allows users to move a document to a specific folder within their pandadoc account. it performs a post request to move the document to the specified folder. both the document and the destination folder must exist.
</Accordion>

<Accordion title="Create or Update Contact">
  This tool creates a new contact or updates an existing one in pandadoc based on the email address. if a contact with the provided email exists, it will be updated; otherwise, a new contact will be created.
</Accordion>

<Accordion title="Create Template">
  This tool allows users to create a new template in pandadoc from a pdf file or from scratch. it handles file upload validation, parameter checks, proper error handling, and authentication with the pandadoc api. the template can be created either by uploading a pdf file or by providing a structured content object that defines the template layout and elements.
</Accordion>

<Accordion title="Delete Template">
  This tool deletes a specific template from pandadoc. once a template is deleted, it cannot be recovered. this action is permanent and should be used with caution.
</Accordion>

<Accordion title="Delete Contact">
  This tool allows you to delete a contact from your pandadoc account. the action is permanent and cannot be undone.
</Accordion>

<Accordion title="Create PandaDoc Webhook">
  Creates a new webhook subscription in pandadoc to receive notifications about specific events. this action allows you to set up webhook notifications for various document-related events such as status changes, recipient completions, and updates. the webhook will send http notifications to your specified endpoint when the configured events occur.
</Accordion>


# Peopledatalabs
Source: https://docs.push.ai/integrations/peopledatalabs



PeopleDataLabs provides B2B data enrichment and identity resolution, empowering organizations to build enriched user profiles and validate customer information

<Accordion title="Company Clean">
  Company clean is a utility designed to standardize and correct company information. it ensures that company names, websites, and social profiles are accurate and formatted consistently.
</Accordion>

<Accordion title="Enrich Skill Data">
  Enrich skill data is a tool that enriches skill data.
</Accordion>

<Accordion title="Enrich Person Data">
  Enrich person data is a comprehensive tool designed to enhance and augment person-related data by providing additional context and details, thereby enabling a more complete and informative dataset.
</Accordion>

<Accordion title="Get column details">
  Gets enum values for a specific column if it's an enum type, loading mappings lazily.
</Accordion>

<Accordion title="Clean Location Data">
  Clean location data is a utility designed to standardize and correct location information. it ensures that location names, coordinates, and other relevant details are accurate and formatted consistently.
</Accordion>

<Accordion title="Get Schema">
  Gets complete schema information for person or company entity.
</Accordion>

<Accordion title="Clean School Data">
  Clean school data is a utility designed to standardize and correct school information. it ensures that school names, websites, and social profiles are accurate and formatted consistently.
</Accordion>

<Accordion title="Natural Language Query">
  This action is used to query the people and company data using natural language.
</Accordion>

<Accordion title="Identify Person Data">
  Identify person data is a tool that identifies a person based on various fields.
</Accordion>

<Accordion title="People Search with Elasticsearch">
  Search person data is a tool that searches for person data based on a given sql query.
</Accordion>

<Accordion title="Enrich Company Data">
  Enrich company data is a comprehensive tool designed to enhance and augment company-related data by providing additional context and details, thereby enabling a more complete and informative dataset.
</Accordion>

<Accordion title="Enrich IP Data">
  Enrich ip data is a comprehensive tool designed to provide detailed enrichment for ip addresses by supplying additional context and associated data, thereby enabling a more complete understanding of the ip address in question.
</Accordion>

<Accordion title="Company Search with Elasticsearch">
  Search company data is a tool that searches for company data based on a given sql query.
</Accordion>

<Accordion title="Autocomplete Field Suggestions">
  Autocomplete is a tool that provides suggestions for fields based on a given seed text.
</Accordion>


# Perplexityai
Source: https://docs.push.ai/integrations/perplexityai



The Perplexity tool interfaces with Perplexity AI's search service, offering advanced natural language processing for sophisticated searches. The PerplexityAISearch action allows for:

* Query execution with AI models tailored to various search tasks.
* Search customization through parameters affecting content generation.
* Domain filtering to enhance search precision.
* Real-time response streaming for dynamic applications.

This action is highly configurable for a tailored search experience, suitable for a wide range of AI-driven applications.

<Accordion title="Perplexityai Perplexity Ai Search">
  Perplexity ai search interfaces with perplexity ai to perform search queries and return responses from a range of models. this action manages requests to perplexity ai and processes the resulting completions, which may include text, citations, and images based on selected models and settings. key features include: autoprompting to enhance and refine queries, choice of ai models for various content and performance requirements, temperature settings to manage response randomness, top k and top p filters to fine-tune response generation. beta features include citations and images in results, and response streaming for dynamic interaction. note: the parameters 'presence penalty' and 'frequency penalty' are mutually exclusive and cannot be used simultaneously.
</Accordion>


# Pipedrive
Source: https://docs.push.ai/integrations/pipedrive



Pipedrive is a sales management tool built around pipeline visualization, lead tracking, activity reminders, and automation to keep deals progressing

<Accordion title="Add an activity">
  New activity added. response includes `more activities scheduled in context` to show if more are planned with the same entity. see tutorial on adding activities [here](https://pipedrive.readme.io/docs/adding-an-activity).
</Accordion>

<Accordion title="Add an installment subscription">
  Adds a new installment subscription.
</Accordion>

<Accordion title="Add a follower to an organization">
  Adds a follower to an organization.
</Accordion>

<Accordion title="Add a comment to a note">
  Adds a new comment to a note.
</Accordion>

<Accordion title="Add a follower to a deal">
  Adds a follower to a deal.
</Accordion>

<Accordion title="Add an organization">
  Set up a new pipedrive organization using custom fields with unique key hashes. retrieve `organizationfields` for configuration. check the linked tutorial for guidance.
</Accordion>

<Accordion title="Add a follower to a person">
  Adds a follower to a person.
</Accordion>

<Accordion title="Add a deal">
  Add a new deal to pipedrive with any custom fields, which vary by account and are identified by long hash keys. check dealfields for existing custom fields. for details, visit the tutorial on adding a deal.
</Accordion>

<Accordion title="Add a channel">
  New messaging channel added; registration limited to admins. utilizes getconversations endpoint for data retrieval. requires messengers integration oauth scope and a prepared messaging app extension manifest.
</Accordion>

<Accordion title="Add a call log">
  Adds a new call log.
</Accordion>

<Accordion title="Add a follower to a product">
  Adds a follower to a product.
</Accordion>

<Accordion title="Add a lead label">
  Creates a lead label.
</Accordion>

<Accordion title="Add a new deal field">
  Adds a new deal field. for more information, see the tutorial for \<a href="[https://pipedrive.readme.io/docs/adding-a-new-custom-field](https://pipedrive.readme.io/docs/adding-a-new-custom-field)" target=" blank" rel="noopener noreferrer">adding a new custom field\</a>.
</Accordion>

<Accordion title="Add a lead">
  Pipedrive api lets you add leads linked to people or organizations and tags them with 'api' source. custom fields from deals apply to leads and appear in responses if set. details are in the tutorials for adding and updating leads.
</Accordion>

<Accordion title="Add a new filter">
  New filter creation returns an id. only one primary condition group with 'and' and two secondary groups (one 'and', one 'or') are supported. future syntax expansion possible. see tutorial for details.
</Accordion>

<Accordion title="Add a new person field">
  Adds a new person field. for more information, see the tutorial for \<a href="[https://pipedrive.readme.io/docs/adding-a-new-custom-field](https://pipedrive.readme.io/docs/adding-a-new-custom-field)" target=" blank" rel="noopener noreferrer">adding a new custom field\</a>.
</Accordion>

<Accordion title="Add a new organization field">
  Adds a new organization field. for more information, see the tutorial for \<a href="[https://pipedrive.readme.io/docs/adding-a-new-custom-field](https://pipedrive.readme.io/docs/adding-a-new-custom-field)" target=" blank" rel="noopener noreferrer">adding a new custom field\</a>.
</Accordion>

<Accordion title="Add a new goal">
  Adds a new goal. along with adding a new goal, a report is created to track the progress of your goal.
</Accordion>

<Accordion title="Add a new pipeline">
  Adds a new pipeline.
</Accordion>

<Accordion title="Add a new team">
  Adds a new team to the company and returns the created object.
</Accordion>

<Accordion title="Add a new product field">
  Adds a new product field. for more information, see the tutorial for \<a href="[https://pipedrive.readme.io/docs/adding-a-new-custom-field](https://pipedrive.readme.io/docs/adding-a-new-custom-field)" target=" blank" rel="noopener noreferrer">adding a new custom field\</a>.
</Accordion>

<Accordion title="Add a new user">
  Adds a new user to the company, returns the id upon success.
</Accordion>

<Accordion title="Add a note">
  Adds a new note.
</Accordion>

<Accordion title="Add a participant to a deal">
  Adds a participant to a deal.
</Accordion>

<Accordion title="Add a person">
  Add a new contact in pipedrive with optional custom fields unique to each account found using the `personfields` endpoint. the endpoint also handles `data.marketing status` for campaigns product users.
</Accordion>

<Accordion title="Add a new stage">
  Adds a new stage, returns the id upon success.
</Accordion>

<Accordion title="Add a product to a deal">
  Adds a product to a deal, creating a new item called a deal-product.
</Accordion>

<Accordion title="Add a project">
  Adds a new project. note that you can supply additional custom fields along with the request that are not described here. these custom fields are different for each pipedrive account and can be recognized by long hashes as keys.
</Accordion>

<Accordion title="Add a product">
  Adds a new product to the products inventory. for more information, see the tutorial for \<a href="[https://pipedrive.readme.io/docs/adding-a-product](https://pipedrive.readme.io/docs/adding-a-product)" target=" blank" rel="noopener noreferrer">adding a product\</a>.
</Accordion>

<Accordion title="Add a role">
  Adds a new role.
</Accordion>

<Accordion title="Delete a deal">
  Marks a deal as deleted. after 30 days, the deal will be permanently deleted.
</Accordion>

<Accordion title="Create a new webhook">
  Creates and returns details of a new webhook. trigger events combine `event action` and `event object`, like `*.*` for all events or `added.deal`, `deleted.persons` for specific actions. more info in the webhooks guide.
</Accordion>

<Accordion title="Attach an audio file to the call log">
  Adds an audio recording to the call log. that audio can be played by those who have access to the call log object.
</Accordion>

<Accordion title="Add users to a team">
  Adds users to an existing team.
</Accordion>

<Accordion title="Cancel a recurring subscription">
  Cancels a recurring subscription.
</Accordion>

<Accordion title="Add or update role setting">
  Adds or updates the visibility setting for a role.
</Accordion>

<Accordion title="Add a task">
  Adds a new task.
</Accordion>

<Accordion title="Add a recurring subscription">
  Adds a new recurring subscription.
</Accordion>

<Accordion title="Create a remote file and link it to an item">
  Creates an empty file on google drive linked to an item. for details, refer to the pipedrive remote file adding tutorial.
</Accordion>

<Accordion title="Archive a project">
  Archives a project.
</Accordion>

<Accordion title="Delete a person">
  Marks a person as deleted. after 30 days, the person will be permanently deleted.
</Accordion>

<Accordion title="Delete a deal field">
  Marks a field as deleted. for more information, see the tutorial for \<a href="[https://pipedrive.readme.io/docs/deleting-a-custom-field](https://pipedrive.readme.io/docs/deleting-a-custom-field)" target=" blank" rel="noopener noreferrer">deleting a custom field\</a>.
</Accordion>

<Accordion title="Delete a file">
  Marks a file as deleted. after 30 days, the file will be permanently deleted.
</Accordion>

<Accordion title="Create an organization relationship">
  Creates and returns an organization relationship.
</Accordion>

<Accordion title="Add new activity type">
  Adds a new activity type.
</Accordion>

<Accordion title="Add person picture">
  This service allows adding a photo to a person's profile, replacing any existing one. images must be square with a minimum size of 128 pixels and in gif, jpg, or png formats. they will be resized to 128 and 512 pixels.
</Accordion>

<Accordion title="Delete a pipeline">
  Marks a pipeline as deleted.
</Accordion>

<Accordion title="Delete an activity">
  Marks an activity as deleted. after 30 days, the activity will be permanently deleted.
</Accordion>

<Accordion title="Delete users from a team">
  Deletes users from an existing team.
</Accordion>

<Accordion title="Enumerate accessible users for lead">
  Lists the users permitted to access a lead.
</Accordion>

<Accordion title="Delete a task">
  Marks a task as deleted. if the task has subtasks then those will also be deleted.
</Accordion>

<Accordion title="Delete person picture">
  Deletes a person’s picture.
</Accordion>

<Accordion title="Delete multiple filters in bulk">
  Marks multiple filters as deleted.
</Accordion>

<Accordion title="Add file">
  Upload and link files to deals, people, organizations, activities, products, or leads in pipedrive. see the "adding a file" tutorial for details.
</Accordion>

<Accordion title="Download one file">
  Initializes a file download.
</Accordion>

<Accordion title="Delete a person field">
  Marks a field as deleted. for more information, see the tutorial for \<a href="[https://pipedrive.readme.io/docs/deleting-a-custom-field](https://pipedrive.readme.io/docs/deleting-a-custom-field)" target=" blank" rel="noopener noreferrer">deleting a custom field\</a>.
</Accordion>

<Accordion title="Delete a product">
  Marks a product as deleted. after 30 days, the product will be permanently deleted.
</Accordion>

<Accordion title="Duplicate deal">
  Duplicates a deal.
</Accordion>

<Accordion title="Delete multiple organizations in bulk">
  Marks multiple organizations as deleted. after 30 days, the organizations will be permanently deleted.
</Accordion>

<Accordion title="Delete existing goal">
  Marks a goal as deleted.
</Accordion>

<Accordion title="Delete multiple organization fields in bulk">
  Marks multiple fields as deleted.
</Accordion>

<Accordion title="Delete existing webhook">
  Deletes the specified webhook.
</Accordion>

<Accordion title="Get all activity fields">
  Returns all activity fields.
</Accordion>

<Accordion title="Get all activity types">
  Returns all activity types.
</Accordion>

<Accordion title="Get all activities beta">
  This beta cursor-paginated endpoint returns all activities, accessible only to global admins, not regular users who get a 403 error. refer to pipedrive's documentation for pagination and global permissions.
</Accordion>

<Accordion title="Delete a filter">
  Marks a filter as deleted.
</Accordion>

<Accordion title="Get all call logs assigned to a particular user">
  Returns all call logs assigned to a particular user.
</Accordion>

<Accordion title="Delete a product field">
  Marks a product field as deleted. for more information, see the tutorial for \<a href="[https://pipedrive.readme.io/docs/deleting-a-custom-field](https://pipedrive.readme.io/docs/deleting-a-custom-field)" target=" blank" rel="noopener noreferrer">deleting a custom field\</a>.
</Accordion>

<Accordion title="Get all lead labels">
  Returns details of all lead labels. this endpoint does not support pagination and all labels are always returned.
</Accordion>

<Accordion title="Delete mail thread">
  Marks a mail thread as deleted.
</Accordion>

<Accordion title="Get all filter helpers">
  The text provides links to documentation for adding or updating filters, and information on all supported filter helpers in an api. it encourages consulting a tutorial for more details on adding a filter.
</Accordion>

<Accordion title="Get all files">
  Returns data about all files.
</Accordion>

<Accordion title="Get all comments for a note">
  Returns all comments associated with a note.
</Accordion>

<Accordion title="Get all add ons for a single company">
  Returns the add-ons for a single company.
</Accordion>

<Accordion title="Delete an activity type">
  Marks an activity type as deleted.
</Accordion>

<Accordion title="Get all filters">
  Returns data about all filters.
</Accordion>

<Accordion title="Get all deals">
  Returns all deals. for more information, see the tutorial for \<a href="[https://pipedrive.readme.io/docs/getting-all-deals](https://pipedrive.readme.io/docs/getting-all-deals)" target=" blank" rel="noopener noreferrer">getting all deals\</a>.
</Accordion>

<Accordion title="Delete a follower from an organization">
  Deletes a follower from an organization. you can retrieve the `follower id` from the \<a href="[https://developers.pipedrive.com/docs/api/v1/organizations#getorganizationfollowers"\&gt;list](https://developers.pipedrive.com/docs/api/v1/organizations#getorganizationfollowers"\&gt;list) followers of an organization\</a> endpoint.
</Accordion>

<Accordion title="Delete multiple activities in bulk">
  Marks multiple activities as deleted. after 30 days, the activities will be permanently deleted.
</Accordion>

<Accordion title="Get all leads">
  The api returns sorted leads by creation time, supporting pagination via `limit` and `start`. custom field values are included if set, mimicking the `deals` endpoint structure; unset fields are omitted. leads share custom fields with deals.
</Accordion>

<Accordion title="Delete an attached product from a deal">
  Deletes a product attachment from a deal, using the `product attachment id`.
</Accordion>

<Accordion title="Find goals">
  Query goal data by appending `\{searchfield\}=\{searchvalue\}` to the url with dot-notation fields and values. include `is active` to filter by goal status and specify both `period.start` and `period.end` for time-based searches.
</Accordion>

<Accordion title="Get all mail messages of mail thread">
  Returns all the mail messages inside a specified mail thread.
</Accordion>

<Accordion title="Delete multiple persons in bulk">
  Marks multiple persons as deleted. after 30 days, the persons will be permanently deleted.
</Accordion>

<Accordion title="Get all lead sources">
  Returns all lead sources. please note that the list of lead sources is fixed, it cannot be modified. all leads created through the pipedrive api will have a lead source `api` assigned.
</Accordion>

<Accordion title="Delete a follower from a deal">
  Deletes a follower from a deal.
</Accordion>

<Accordion title="Get all payments of a subscription">
  Returns all payments of an installment or recurring subscription.
</Accordion>

<Accordion title="Get all organizations">
  Returns all organizations.
</Accordion>

<Accordion title="Get all organizations beta">
  This beta api endpoint lists all organizations with cursor pagination. only global admins have access; others get a 403 error. see docs for pagination and global permissions.
</Accordion>

<Accordion title="Get all organization fields">
  Returns data about all organization fields.
</Accordion>

<Accordion title="Get all deals beta">
  This endpoint returns all deals with cursor pagination (in beta). only global admins can access it; others get a 403 error. more info on pagination and permissions is available online.
</Accordion>

<Accordion title="Delete a project">
  Marks a project as deleted.
</Accordion>

<Accordion title="Delete multiple person fields in bulk">
  Marks multiple fields as deleted.
</Accordion>

<Accordion title="Delete multiple activity types in bulk">
  Marks multiple activity types as deleted.
</Accordion>

<Accordion title="Get all persons">
  Returns all persons.
</Accordion>

<Accordion title="Delete a follower from a person">
  Deletes a follower from a person.
</Accordion>

<Accordion title="Get all deal fields">
  Returns data about all deal fields.
</Accordion>

<Accordion title="Get all persons beta">
  This beta endpoint returns all persons, using cursor pagination. only global admins have access; others get a 403 error. info on pagination and permissions is in the linked docs.
</Accordion>

<Accordion title="Delete a role">
  Marks a role as deleted.
</Accordion>

<Accordion title="Get all product fields">
  Returns data about all product fields.
</Accordion>

<Accordion title="Delete multiple product fields in bulk">
  Marks multiple fields as deleted.
</Accordion>

<Accordion title="Get all permission sets">
  Returns data about all permission sets.
</Accordion>

<Accordion title="Get all person fields">
  Returns data about all person fields.

  if a company uses the [campaigns product](https://pipedrive.readme.io/docs/campaigns-in-pipedrive-api), then this endpoint will also return the `data.marketing status` field.
</Accordion>

<Accordion title="Get all pipelines">
  Returns data about all pipelines.
</Accordion>

<Accordion title="Get all products">
  Returns data about all products.
</Accordion>

<Accordion title="Delete a role assignment">
  Removes the assigned user from a role and adds to the default role.
</Accordion>

<Accordion title="Delete multiple deals in bulk">
  Marks multiple deals as deleted. after 30 days, the deals will be permanently deleted.
</Accordion>

<Accordion title="Delete multiple stages in bulk">
  Marks multiple stages as deleted.
</Accordion>

<Accordion title="Delete a stage">
  Marks a stage as deleted.
</Accordion>

<Accordion title="Delete a lead">
  Deletes a specific lead.
</Accordion>

<Accordion title="Add role assignment">
  Assigns a user to a role.
</Accordion>

<Accordion title="Delete a lead label">
  Deletes a specific lead label.
</Accordion>

<Accordion title="Get all notes">
  Returns all notes.
</Accordion>

<Accordion title="Find users by name">
  Finds users by their name.
</Accordion>

<Accordion title="Delete a subscription">
  Marks an installment or a recurring subscription as deleted.
</Accordion>

<Accordion title="Delete multiple deal fields in bulk">
  Marks multiple deal fields as deleted.
</Accordion>

<Accordion title="Delete an organization field">
  Marks a field as deleted. for more information, see the tutorial for \<a href="[https://pipedrive.readme.io/docs/deleting-a-custom-field](https://pipedrive.readme.io/docs/deleting-a-custom-field)" target=" blank" rel="noopener noreferrer">deleting a custom field\</a>.
</Accordion>

<Accordion title="Delete a channel">
  The endpoint removes a messenger channel along with conversations and messages. requires messengers integration oauth and messaging app extension manifest.
</Accordion>

<Accordion title="Delete an organization relationship">
  Deletes an organization relationship and returns the deleted id.
</Accordion>

<Accordion title="Get all activities assigned to a particular user">
  Returns all activities assigned to a particular user.
</Accordion>

<Accordion title="Delete a comment related to a note">
  Deletes a comment.
</Accordion>

<Accordion title="Find subscription by deal">
  Returns details of an installment or a recurring subscription by the deal id.
</Accordion>

<Accordion title="Delete a note">
  Deletes a specific note.
</Accordion>

<Accordion title="Delete a participant from a deal">
  Deletes a participant from a deal.
</Accordion>

<Accordion title="Get all note fields">
  Returns data about all note fields.
</Accordion>

<Accordion title="Delete an organization">
  Marks an organization as deleted. after 30 days, the organization will be permanently deleted.
</Accordion>

<Accordion title="Delete a call log">
  Deletes a call log. if there is an audio recording attached to it, it will also be deleted. the related activity will not be removed by this request. if you want to remove the related activities, please use the endpoint which is specific for activities.
</Accordion>

<Accordion title="Delete a conversation">
  Deletes an existing conversation. to use the endpoint, you need to have **messengers integration** oauth scope enabled and the messaging manifest ready for the [messaging app extension](https://pipedrive.readme.io/docs/messaging-app-extension).
</Accordion>

<Accordion title="Delete a follower from a product">
  Deletes a follower from a product.
</Accordion>

<Accordion title="Get all users">
  Returns data about all users within the company.
</Accordion>

<Accordion title="Get all supported currencies">
  Returns all supported currencies in given account which should be used when saving monetary values with other objects. the `code` parameter of the returning objects is the currency code according to iso 4217 for all non-custom currencies.
</Accordion>

<Accordion title="Get all tasks">
  Returns all tasks. this is a cursor-paginated endpoint. for more information, please refer to our documentation on \<a href="[https://pipedrive.readme.io/docs/core-api-concepts-pagination](https://pipedrive.readme.io/docs/core-api-concepts-pagination)" target=" blank" rel="noopener noreferrer">pagination\</a>.
</Accordion>

<Accordion title="Get all projects">
  Returns all projects. this is a cursor-paginated endpoint. for more information, please refer to our documentation on \<a href="[https://pipedrive.readme.io/docs/core-api-concepts-pagination](https://pipedrive.readme.io/docs/core-api-concepts-pagination)" target=" blank" rel="noopener noreferrer">pagination\</a>.
</Accordion>

<Accordion title="Get all relationships for organization">
  Gets all of the relationships for a supplied organization id.
</Accordion>

<Accordion title="Get all project templates">
  The endpoint retrieves all non-deleted project templates with cursor-based pagination. refer to the provided documentation link for more details on pagination.
</Accordion>

<Accordion title="Get details of a phase">
  Returns the details of a specific project phase.
</Accordion>

<Accordion title="Get one file">
  Returns data about a specific file.
</Accordion>

<Accordion title="Get details of a deal">
  Fetches specific deal details, including exclusive fields like deal age and pipeline stage duration. custom fields show up as hashes, which can be matched using the 'key' from dealfields. see the deal details tutorial for more.
</Accordion>

<Accordion title="Get a single team">
  Returns data about a specific team.
</Accordion>

<Accordion title="Get all stages">
  Returns data about all stages.
</Accordion>

<Accordion title="Get current user data">
  Returns data about an authorized user within the company with bound company data: company id, company name, and domain. note that the `locale` property means 'date/number format' in the pipedrive account settings, not the chosen language.
</Accordion>

<Accordion title="Get deals timeline">
  Returns opened and won deals in time-based groups according to a specified dealfield, with examples of deals grouped by month over a 3-month period starting january 2012.
</Accordion>

<Accordion title="Get all project boards">
  Returns all projects boards that are not deleted.
</Accordion>

<Accordion title="Get details of a person">
  The text describes an api endpoint that returns detailed person information, including extra fields and custom fields as hashes. it also provides `data.marketing status` if the campaigns product is used.
</Accordion>

<Accordion title="Get details of a project">
  Returns the details of a specific project. also note that custom fields appear as long hashes in the resulting data. these hashes can be mapped against the `key` value of project fields.
</Accordion>

<Accordion title="Get all teams of a user">
  Returns data about all teams which have the specified user as a member.
</Accordion>

<Accordion title="Get all roles">
  Returns all the roles within the company.
</Accordion>

<Accordion title="Get all users in a team">
  Returns a list of all user ids within a team.
</Accordion>

<Accordion title="Get one organization field">
  Returns data about a specific organization field.
</Accordion>

<Accordion title="Get one filter">
  Returns data about a specific filter. note that this also returns the condition lines of the filter.
</Accordion>

<Accordion title="Get all user connections">
  Returns data about all connections for the authorized user.
</Accordion>

<Accordion title="Get one product field">
  Returns data about a specific product field.
</Accordion>

<Accordion title="Get one role">
  Returns the details of a specific role.
</Accordion>

<Accordion title="Get one product">
  Returns data about a specific product.
</Accordion>

<Accordion title="Get one deal field">
  Returns data about a specific deal field.
</Accordion>

<Accordion title="Get one lead">
  Api returns specific lead details with custom field values in the deals format. unset custom fields are omitted. leads share custom fields with deals, not having a unique set.
</Accordion>

<Accordion title="Get one stage">
  Returns data about a specific stage.
</Accordion>

<Accordion title="Get result of a goal">
  Gets the progress of a goal for the specified period.
</Accordion>

<Accordion title="Get one user">
  Returns data about a specific user within the company.
</Accordion>

<Accordion title="Get all webhooks">
  Returns data about all the webhooks of a company.
</Accordion>

<Accordion title="Get one organization relationship">
  Finds and returns an organization relationship from its id.
</Accordion>

<Accordion title="Get one note">
  Returns details about a specific note.
</Accordion>

<Accordion title="Get one pipeline">
  Returns data about a specific pipeline. also returns the summary of the deals in this pipeline across its stages.
</Accordion>

<Accordion title="Get details of a subscription">
  Returns details of an installment or a recurring subscription.
</Accordion>

<Accordion title="Link a remote file to an item">
  Links an existing remote file (`googledrive`) to the item you supply. for more information, see the tutorial for \<a href="[https://pipedrive.readme.io/docs/adding-a-remote-file](https://pipedrive.readme.io/docs/adding-a-remote-file)" target=" blank" rel="noopener noreferrer">adding a remote file\</a>.
</Accordion>

<Accordion title="List all persons associated with a deal">
  The endpoint lists every person linked to a deal, including primary contacts and participants, and provides a `data.marketing status` field for users of the campaigns product.
</Accordion>

<Accordion title="List activities associated with a deal">
  Lists activities associated with a deal.
</Accordion>

<Accordion title="Get one mail message">
  Returns data about a specific mail message.
</Accordion>

<Accordion title="Get project phases">
  Returns all active project phases under a specific board.
</Accordion>

<Accordion title="Get deals conversion rates in pipeline">
  Returns all stage-to-stage conversion and pipeline-to-close rates for the given time period.
</Accordion>

<Accordion title="Get recents">
  Returns data about all recent changes occurred after the given timestamp.
</Accordion>

<Accordion title="List activities associated with a person">
  Lists activities associated with a person.
</Accordion>

<Accordion title="List followers of an organization">
  Lists the followers of an organization.
</Accordion>

<Accordion title="List deals associated with an organization">
  Lists deals associated with an organization.
</Accordion>

<Accordion title="List files attached to a deal">
  Lists files associated with a deal.
</Accordion>

<Accordion title="List followers of a person">
  Lists the followers of a person.
</Accordion>

<Accordion title="List files attached to a person">
  Lists files associated with a person.
</Accordion>

<Accordion title="Get all teams">
  Returns data about teams within the company.
</Accordion>

<Accordion title="Get deals in a pipeline">
  Lists deals in a specific pipeline across all its stages.
</Accordion>

<Accordion title="Get one mail thread">
  Returns a specific mail thread.
</Accordion>

<Accordion title="List files attached to a product">
  Lists files associated with a product.
</Accordion>

<Accordion title="List activities associated with an organization">
  Lists activities associated with an organization.
</Accordion>

<Accordion title="List followers of a deal">
  Lists the followers of a deal.
</Accordion>

<Accordion title="Get details of a task">
  Returns the details of a specific task.
</Accordion>

<Accordion title="Get one permission set">
  Returns data about a specific permission set.
</Accordion>

<Accordion title="Get deals movements in pipeline">
  Returns statistics for deals movements for the given time period.
</Accordion>

<Accordion title="Link a user with the installed video call integration">
  A video calling provider must call this endpoint after a user has installed the video calling app so that the new user's information is sent.
</Accordion>

<Accordion title="Get one person field">
  Returns data about a specific person field.
</Accordion>

<Accordion title="Get mail threads">
  Returns mail threads in a specified folder ordered by the most recent message within.
</Accordion>

<Accordion title="List deals associated with a person">
  Lists deals associated with a person.
</Accordion>

<Accordion title="Get deals in a stage">
  Lists deals in a specific stage.
</Accordion>

<Accordion title="Get details of an activity">
  Returns the details of a specific activity.
</Accordion>

<Accordion title="Get details of a call log">
  Returns details of a specific call log.
</Accordion>

<Accordion title="Get details of a template">
  Returns the details of a specific project template.
</Accordion>

<Accordion title="Get one comment">
  Returns the details of a comment.
</Accordion>

<Accordion title="Get details of an organization">
  Provides detailed information about an organization, including additional fields not shown when listing all organizations, and maps custom fields as long hashes to the 'key' value in organizationfields.
</Accordion>

<Accordion title="Get deals summary">
  Returns a summary of all the deals.
</Accordion>

<Accordion title="Get details of a board">
  Returns the details of a specific project board.
</Accordion>

<Accordion title="List mail messages associated with a deal">
  Lists mail messages associated with a deal.
</Accordion>

<Accordion title="List mail messages associated with a person">
  Lists mail messages associated with a person.
</Accordion>

<Accordion title="List permitted users">
  Lists the users permitted to access a deal.
</Accordion>

<Accordion title="List mail messages associated with an organization">
  Lists mail messages associated with an organization.
</Accordion>

<Accordion title="List followers of a user">
  Lists the followers of a specific user.
</Accordion>

<Accordion title="Get deals where a product is attached to">
  Returns data about deals that have a product attached to it.
</Accordion>

<Accordion title="List followers of a product">
  Lists the followers of a product.
</Accordion>

<Accordion title="List files attached to an organization">
  Lists files associated with an organization.
</Accordion>

<Accordion title="List participants of a deal">
  Lists the participants associated with a deal.

  if a company uses the [campaigns product](https://pipedrive.readme.io/docs/campaigns-in-pipedrive-api), then this endpoint will also return the `data.marketing status` field.
</Accordion>

<Accordion title="List role assignments lists role assignments for a user">
  Lists role assignments for a user.
</Accordion>

<Accordion title="List settings of an authorized user">
  Lists the settings of an authorized user. example response contains a shortened list of settings.
</Accordion>

<Accordion title="List permitted users list users permitted to access a person">
  List users permitted to access a person.
</Accordion>

<Accordion title="List permitted users lists users permitted to access a product">
  Lists users permitted to access a product.
</Accordion>

<Accordion title="List persons of an organization">
  Lists persons associated with an organization.

  if a company uses the [campaigns product](https://pipedrive.readme.io/docs/campaigns-in-pipedrive-api), then this endpoint will also return the `data.marketing status` field.
</Accordion>

<Accordion title="List role assignments">
  Returns all users assigned to a role.
</Accordion>

<Accordion title="List permission set assignments">
  Returns the list of assignments for a permission set.
</Accordion>

<Accordion title="List pipeline visibility for a role">
  Returns a list of visible or hidden pipeline ids by role. see the "visibility groups article" for details on pipeline visibility.
</Accordion>

<Accordion title="List updates about a person">
  Lists updates about a person.

  if a company uses the [campaigns product](https://pipedrive.readme.io/docs/campaigns-in-pipedrive-api), then this endpoint's response will also include updates for the `marketing status` field.
</Accordion>

<Accordion title="List updates about a deal">
  Lists updates about a deal.
</Accordion>

<Accordion title="Merge two organizations">
  Merges an organization with another organization. for more information, see the tutorial for \<a href="[https://pipedrive.readme.io/docs/merging-two-organizations](https://pipedrive.readme.io/docs/merging-two-organizations)" target=" blank" rel="noopener noreferrer">merging two organizations\</a>.
</Accordion>

<Accordion title="Merge two deals">
  Merges a deal with another deal. for more information, see the tutorial for \<a href="[https://pipedrive.readme.io/docs/merging-two-deals](https://pipedrive.readme.io/docs/merging-two-deals)" target=" blank" rel="noopener noreferrer">merging two deals\</a>.
</Accordion>

<Accordion title="List user role settings">
  Lists the settings of user's assigned role.
</Accordion>

<Accordion title="List role settings">
  Returns the visibility settings of a specific role.
</Accordion>

<Accordion title="List updates about participants of a deal">
  This endpoint provides cursor-paginated updates on deal participants. for pagination details, see the pipedrive documentation.
</Accordion>

<Accordion title="List updates about an organization">
  Lists updates about an organization.
</Accordion>

<Accordion title="List user permissions">
  Lists aggregated permissions over all assigned permission sets for a user.
</Accordion>

<Accordion title="List products associated with a person">
  Lists products associated with a person.
</Accordion>

<Accordion title="Organization accessible user list">
  List users permitted to access an organization.
</Accordion>

<Accordion title="Merge two persons">
  Merges a person with another person. for more information, see the tutorial for \<a href="[https://pipedrive.readme.io/docs/merging-two-persons](https://pipedrive.readme.io/docs/merging-two-persons)" target=" blank" rel="noopener noreferrer">merging two persons\</a>.
</Accordion>

<Accordion title="Perform a search from multiple item types">
  Performs a search from your choice of item types and fields.
</Accordion>

<Accordion title="List products attached to a deal">
  Lists products attached to a deal.
</Accordion>

<Accordion title="Perform a search using a specific field from an item type">
  Performs a search from the values of a specific field. results can either be the distinct values of the field (useful for searching autocomplete field values), or the ids of actual items (deals, leads, persons, organizations or products).
</Accordion>

<Accordion title="Returns project groups">
  Returns all active groups under a specific project.
</Accordion>

<Accordion title="Receives an incoming message">
  Adds a message to a conversation. to use the endpoint, you need to have **messengers integration** oauth scope enabled and the messaging manifest ready for the [messaging app extension](https://pipedrive.readme.io/docs/messaging-app-extension).
</Accordion>

<Accordion title="Refreshing the tokens">
  Access tokens expire after the time specified in `expires in`. to continue accessing the api, use the `refresh token` to obtain a new access token.
</Accordion>

<Accordion title="Update an installment subscription">
  Updates an installment subscription.
</Accordion>

<Accordion title="Update stage details">
  Updates the properties of a stage.
</Accordion>

<Accordion title="Returns project activities">
  Returns activities linked to a specific project.
</Accordion>

<Accordion title="Returns project plan">
  Returns information about items in a project plan. items consists of tasks and activities and are linked to specific project phase and group.
</Accordion>

<Accordion title="Update a lead label">
  Updates one or more properties of a lead label. only properties included in the request will be updated.
</Accordion>

<Accordion title="Update an organization">
  Updates the properties of an organization.
</Accordion>

<Accordion title="Update a recurring subscription">
  Updates a recurring subscription.
</Accordion>

<Accordion title="Requesting authorization">
  Authorize a user by redirecting them to the pipedrive oauth authorization page and request their permissions to act on their behalf. this step is necessary to implement only when you allow app installation outside of the marketplace.
</Accordion>

<Accordion title="Update a note">
  Updates a note.
</Accordion>

<Accordion title="Returns project tasks">
  Returns tasks linked to a specific project.
</Accordion>

<Accordion title="Search deals">
  This api endpoint searches deals by title, notes, and custom fields, filters results by person or organization id, and is a specific use case of /v1/itemsearch with limited oauth scope.
</Accordion>

<Accordion title="Update task in project plan">
  Updates a task phase or group in a project.
</Accordion>

<Accordion title="Update a person">
  Modifies a person’s details in pipedrive. see the linked tutorial for guidance. if utilizing campaigns, the endpoint also handles `data.marketing status`.
</Accordion>

<Accordion title="Update a team">
  Updates an existing team and returns the updated object.
</Accordion>

<Accordion title="Update a task">
  Updates a task.
</Accordion>

<Accordion title="Search leads">
  Endpoint searches leads by title, notes, custom fields, with options to filter by person and organization ids, and is a more specific use of the /v1/itemsearch with limited oauth scope.
</Accordion>

<Accordion title="Update an activity type">
  Updates an activity type.
</Accordion>

<Accordion title="Update an organization field">
  Updates an organization field. for more information, see the tutorial for \<a href=" [https://pipedrive.readme.io/docs/updating-custom-field-value](https://pipedrive.readme.io/docs/updating-custom-field-value) " target=" blank" rel="noopener noreferrer">updating custom fields' values\</a>.
</Accordion>

<Accordion title="Search organizations">
  Searches all organizations by name, address, notes and/or custom fields. this endpoint is a wrapper of \<a href="[https://developers.pipedrive.com/docs/api/v1/itemsearch#searchitem"\&gt;/v1/itemsearch\&lt;/a](https://developers.pipedrive.com/docs/api/v1/itemsearch#searchitem"\&gt;/v1/itemsearch\&lt;/a)> with a narrower oauth scope.
</Accordion>

<Accordion title="Update an organization relationship">
  Updates and returns an organization relationship.
</Accordion>

<Accordion title="Search persons">
  This endpoint searches for individuals by various identifiers and is a specific use case of /v1/itemsearch with limited oauth scope, allowing results filtering by organization id.
</Accordion>

<Accordion title="Update the product attached to a deal">
  Updates the details of the product that has been attached to a deal.
</Accordion>

<Accordion title="Update a pipeline">
  Updates the properties of a pipeline.
</Accordion>

<Accordion title="Update a person field">
  Updates a person field. for more information, see the tutorial for \<a href=" [https://pipedrive.readme.io/docs/updating-custom-field-value](https://pipedrive.readme.io/docs/updating-custom-field-value) " target=" blank" rel="noopener noreferrer">updating custom fields' values\</a>.
</Accordion>

<Accordion title="Update existing goal">
  Updates an existing goal.
</Accordion>

<Accordion title="Search products">
  Searches all products by name, code and/or custom fields. this endpoint is a wrapper of \<a href="[https://developers.pipedrive.com/docs/api/v1/itemsearch#searchitem"\&gt;/v1/itemsearch\&lt;/a](https://developers.pipedrive.com/docs/api/v1/itemsearch#searchitem"\&gt;/v1/itemsearch\&lt;/a)> with a narrower oauth scope.
</Accordion>

<Accordion title="Update a comment related to a note">
  Updates a comment related to a note.
</Accordion>

<Accordion title="Update a product">
  Updates product data.
</Accordion>

<Accordion title="Update file details">
  Updates the properties of a file.
</Accordion>

<Accordion title="Pipedrive Unlink User From Video Call Integration">
  A video calling provider must call this endpoint to remove the link between a user and the installed video calling app.
</Accordion>

<Accordion title="Update a deal">
  Updates the properties of a deal. for more information, see the tutorial for \<a href="[https://pipedrive.readme.io/docs/updating-a-deal](https://pipedrive.readme.io/docs/updating-a-deal)" target=" blank" rel="noopener noreferrer">updating a deal\</a>.
</Accordion>

<Accordion title="Update filter">
  Updates an existing filter.
</Accordion>

<Accordion title="Update activity in project plan">
  Updates an activity phase or group in a project.
</Accordion>

<Accordion title="Update an activity">
  Updates an activity. includes `more activities scheduled in context` property in response's `additional data` which indicates whether there are more undone activities scheduled with the same deal, person or organization (depending on the supplied data).
</Accordion>

<Accordion title="Update pipeline visibility for a role">
  Updates pipeline visibility settings for different roles. for details, see the pipedrive visibility groups article.
</Accordion>

<Accordion title="Update mail thread details">
  Updates the properties of a mail thread.
</Accordion>

<Accordion title="Update a deal field">
  Updates a deal field. for more information, see the tutorial for \<a href=" [https://pipedrive.readme.io/docs/updating-custom-field-value](https://pipedrive.readme.io/docs/updating-custom-field-value) " target=" blank" rel="noopener noreferrer">updating custom fields' values\</a>.
</Accordion>

<Accordion title="Update a project">
  Updates a project.
</Accordion>

<Accordion title="Update role details">
  Updates the parent role and/or the name of a specific role.
</Accordion>

<Accordion title="Update user details">
  Updates the properties of a user. currently, only `active flag` can be updated.
</Accordion>

<Accordion title="Update a lead">
  Updating lead properties modifies only specified fields; use `null` to unset. custom field data matches `deals`. unset fields are omitted. leads share deals' custom fields. for examples, refer to the tutorial.
</Accordion>

<Accordion title="Update a product field">
  Updates a product field. for more information, see the tutorial for \<a href=" [https://pipedrive.readme.io/docs/updating-custom-field-value](https://pipedrive.readme.io/docs/updating-custom-field-value) " target=" blank" rel="noopener noreferrer">updating custom fields' values\</a>.
</Accordion>


# Placekey
Source: https://docs.push.ai/integrations/placekey



Placekey standardizes location data by assigning unique IDs to physical addresses, simplifying address matching and enabling data sharing across platforms

<Accordion title="Get Geocode From Address">
  This tool retrieves geocode information (latitude and longitude) for a given address using the placekey api. it accepts address components (street address, city, region, postal code, iso country code) and returns geocode data including the unique placekey identifier and location details.
</Accordion>

<Accordion title="Get placekey from coordinates">
  Get a placekey (unique identifier) for a given pair of latitude and longitude coordinates. this is the most basic and independent operation in placekey's api that requires minimal input parameters. the tool returns a "where" part of the placekey, which represents the physical location.
</Accordion>

<Accordion title="Get placekey from address">
  Convert a physical address into a unique placekey identifier. the placekey is a universal standard identifier for any physical place that helps in location matching, enrichment, and deduplication.
</Accordion>


# Posthog
Source: https://docs.push.ai/integrations/posthog



PostHog is an open-source product analytics platform tracking user interactions and behaviors to help teams refine features, improve funnels, and reduce churn

<Accordion title="Assign feature flag role based access">
  Set up role-based access for a feature flag using `project id` and `feature flag id`. submit access info in json or form format, with `feature flag:write` rights. success returns new details with a 201 code.
</Accordion>

<Accordion title="Add project specific member roles">
  Add members with specific roles to a project by providing their user uuid and level (member or admin). requires project id in the url. supports json, form-data, and form-urlencoded input. returns the newly created membership data upon success.
</Accordion>

<Accordion title="Check project s demo data generation status">
  Projects for the current organization.
</Accordion>

<Accordion title="Cohort duplication to static">
  This endpoint duplicates a specified cohort as a static one within a project. path parameters include `project id` (string) and cohort `id` (integer). successful requests return cohort details.
</Accordion>

<Accordion title="Bookmark project activity notification">
  Create a bookmark for an activity notification in a project's activity log. requires a `project id` and json payload with activity details. supports verification status, impersonation flags, and system activity distinction.
</Accordion>

<Accordion title="Bulk create organization invites">
  Post /api/organizations/\{organization id}/invites/bulk/: bulk-create organization invites with customizable levels, sender details, and validation checks. supports email automation and private project access settings.
</Accordion>

<Accordion title="Create dashboard from template in project">
  Create a new dashboard for a specified project from a template. accepts project id in the path and a json payload with various dashboard object parameters. returns a dashboard instance on success.
</Accordion>

<Accordion title="Create domain with saml for organization">
  Create a domain for a specific organization by post to `/api/organizations/\{id\}/domains` with json/form data. requires domain, saml setup, and write permissions. returns new domain data with status 201.
</Accordion>

<Accordion title="Create experiment exposure cohort">
  Create a new exposure cohort for an experiment in a project by sending a post request with experiment details and feature flag data. requires experiment id and project id in the path.
</Accordion>

<Accordion title="Create a notebook in a project">
  The api for interacting with notebooks. this feature is in early access and the api can have breaking changes without announcement.
</Accordion>

<Accordion title="Create feature flags for project">
  Manage feature flags by creating, reading, updating, and deleting them using posthog's javascript library or api endpoint. details in the provided documentation.
</Accordion>

<Accordion title="Create feature flag dashboard">
  Manage feature flags by creating, reading, updating, and deleting them. utilize javascript library or endpoint for user-specific flag status. refer to documentation for details.
</Accordion>

<Accordion title="Create organization invite with role and email">
  Send invites with roles (member, admin, owner) via email to join an organization by id. use json, form data, or multipart with a personal api key for security. successful invites return a 201 status.
</Accordion>

<Accordion title="Cancel insights for a project">
  The "/api/projects/\{project id}/insights/cancel/" endpoint allows users to cancel insights for a project by providing a project id and insight details in json or csv, and confirms cancellation in the response.
</Accordion>

<Accordion title="Create org proxy record with domain and status">
  Create a proxy record for an org by sending org id in url and json/form/multipart data with domain, target cname, and status. requires personalapikeyauth and org write access; returns record details.
</Accordion>

<Accordion title="Create frontend app pipeline config">
  Create a config for pipeline frontend apps within a specified project. requires project id and payload with object properties such as plugin, enabled status, order, etc. returns newly created config details.
</Accordion>

<Accordion title="Create plugin job configuration">
  Create a job-related configuration for a specific plugin by providing plugin and project ids. accepts json, form data, and returns config details on success. use carefully; requires mandatory fields.
</Accordion>

<Accordion title="Create project dashboard">
  The post endpoint creates a dashboard within a project using a `project id`, accepting details in json/form formats. it uses 'personalapikeyauth' for security and returns http 201 with dashboard details on success.
</Accordion>

<Accordion title="Check pipeline destination updates">
  Get the newest updates and plugin info for a pipeline destination by organization and destination id via get request to /api/.../\{id}/check for updates.
</Accordion>

<Accordion title="Create person funnel correlation">
  This endpoint is for reading and deleting persons. use the capture api, `$set`/`$unset` properties, or sdks to create or update them.
</Accordion>

<Accordion title="Create project pipeline app configs">
  Create pipeline app configurations for a specified project via post, requiring a project id and json, form, or multipart payload. supports configs, plugins, and app details. returns 201 on success. auth required.
</Accordion>

<Accordion title="Create organization role with feature flag levels">
  Create a new role for the specified organization by supplying role details. requires organization id (uuid) and role data in json. returns the created role on success with a 201 status code. security: personalapikeyauth.
</Accordion>

<Accordion title="Create person path with format option">
  This api endpoint is for reading and deleting users. use the capture api, `$set`/`$unset` properties, or sdks for creating/updating users.
</Accordion>

<Accordion title="Create project pipeline frontend app job">
  Create a job for a pipeline frontend app config in a project. requires `project id` and config `id`, accepting json/form-data. returns the created job's details.
</Accordion>

<Accordion title="Create project actions with optional csv json format">
  This post endpoint creates actions for a project, accepts various data types, requires project id and action data, optionally outputs in csv/json, and needs personalapikeyauth, returning a 201 with action details.
</Accordion>

<Accordion title="Create project pipeline transformation config">
  Create a pipeline transformation config within a specific project by posting json, form, or multipart data. include plugin id, order, and enabled status. ensure project id is in the path. authentication required.
</Accordion>

<Accordion title="Create funnel analysis for project persons">
  This endpoint handles reading and deleting persons. for creation or updates, use the capture api, `$set` or `$unset` properties, or sdks.
</Accordion>

<Accordion title="Create pipeline destination config">
  Create pipeline destination configurations for a specific project by submitting plugin and order details, among other configuration info, with required project id. authentication needed. responds with 201 on success.
</Accordion>

<Accordion title="Create project insights with customizable parameters">
  The post endpoint enables creating insights for projects using a project id and supports json/csv. it offers detailed parameters for customizing insights and returns structured data with personalapikeyauth for security.
</Accordion>

<Accordion title="Check pipeline import app updates">
  Retrieve the latest update information for a specific pipeline import app by its id within an organization. this endpoint returns details such as plugin type, name, description, and version data. requires 'id' and 'organization id' as path parameters.
</Accordion>

<Accordion title="Create project subscription with delivery options">
  Create a subscription for a given project by providing required details such as delivery method, frequency, and starting date. requires a project id and supports various content types. returns the newly created subscription. security: personalapikeyauth.
</Accordion>

<Accordion title="Create project cohorts">
  Create cohorts for a specified project by posting json-form data to "/api/projects/\{project id}/cohorts/". provide project id in url and the necessary payload, adhering to json schema constraints. authentication required. returns 201 upon success.
</Accordion>

<Accordion title="Create project plugin configuration">
  Create a new plugin configuration for a specified project by post to /api/projects/\{project id}/plugin configs/. requires project id and json payload with plugin details; must authenticate with personalapikeyauth.
</Accordion>

<Accordion title="Create project timing insights">
  Create timing insights for a project by post to /api/projects/\{project id}/insights/timing, supporting csv or json. it returns a 200 status with content in the chosen format.
</Accordion>

<Accordion title="Check pipeline plugin update status">
  Get update status for a specific pipeline transformation plugin by its unique id within an organization. this endpoint requires the 'organization id' and 'plugin' ids and returns details like plugin type, name, and update information.
</Accordion>

<Accordion title="Create query in project by id">
  The `/api/projects/\{project id\}/query/` post endpoint allows users to submit queries for a specific project by providing the project id in the url and the query details in json or form data. authentication is required and it returns query results.
</Accordion>

<Accordion title="Create project insights with format option">
  Create project insights with optional csv/json format parameter. requires `project id` in the path and a json body with project insight details. supports personal api key authentication. successful requests return a 201 status code with insight data.
</Accordion>

<Accordion title="Create project surveys with questions and targets">
  Create surveys in a project by providing a project id and details like type, questions, and targets in json, form-data, or urlencoded format. use personalapikeyauth for security. get a survey object on success.
</Accordion>

<Accordion title="Create pipeline destination config job">
  Create a job for a pipeline destination config with a specific id within the specified project. requires project id & config id in the path, and a json payload with plugin and order info.
</Accordion>

<Accordion title="Custom project funnel analytics with advanced options">
  The `/api/projects/\{project id\}/insights/funnel/` endpoint generates customizable funnel insights for a project in either csv or json, offering filtering, exclusion, and ordering features with cachable results. specify output with the `format` query.
</Accordion>

<Accordion title="Create new organization with configurable access">
  Post /api/organizations/ - create a new organization with details like name, membership level, and features access. requires organization:write permission. returns organization info on success.
</Accordion>

<Accordion title="Create session recording in playlist">
  The post endpoint generates a project's session recording, needing 'project id', 'short id', and 'session recording id' in the url, and accepts various content formats for recording details.
</Accordion>

<Accordion title="Create session recording playlists">
  Create playlists of session recordings for a specified project. requires 'project id' path parameter and personal api key with write access. supports json, form-encoded, or multipart data. returns 201 on success with playlist details.
</Accordion>

<Accordion title="Crud operations for project annotations">
  Create, read, update and delete annotations. [see docs](https://posthog.com/docs/user-guides/annotations) for more information on annotations.
</Accordion>

<Accordion title="Create retrieve retention insights for project">
  Create and retrieve retention insights for a project using its id, allowing csv/json outputs. requires an api key with `insight:read` permissions and supports query node json strings and old dashboard ids.
</Accordion>

<Accordion title="Create static cohort for feature flag">
  Manage feature flags for apps with create, read, update, and delete operations using posthog's javascript library or dedicated endpoint. more info in the docs.
</Accordion>

<Accordion title="Create session recording summary">
  Summarize a session recording by providing the project id and the recording's uuid. get details like duration, activities, and user info.
</Accordion>

<Accordion title="Create new project experiment">
  Create a new experiment in a specific project using json, form, or multipart data. requires project id and experiment details, secured with personalapikeyauth. generates a 201 response with experiment info.
</Accordion>

<Accordion title="Create pipeline import apps config job">
  A job imports app settings into a project pipeline using project id and plugin config id, accepting json/form/multipart, and specifies plugin details, enabling status, and order for pipeline import apps configs.
</Accordion>

<Accordion title="Add dashboard collaborators with access level">
  Add collaborators to a specific project dashboard. requires 'project id' and 'dashboard id'. supports json, form-urlencoded, and multipart data. returns added collaborator details. auth: 'personalapikeyauth'.
</Accordion>

<Accordion title="Add member to organization role">
  Add a member to an organization role by submitting their details and uuid in json/form, using organization and role ids. requires personalapikeyauth. success gives a 201 status.
</Accordion>

<Accordion title="Posthog List Organization Plugins With Pagination">
  Retrieve the list of plugins for a specified organization. supports pagination through 'limit' and 'offset' query parameters. requires a valid organization uuid and personalapikeyauth for access. returns plugin details including types and status.
</Accordion>

<Accordion title="Delete survey by id">
  Delete a survey by providing its uuid and the associated project id. requires 'survey:write' permission. returns no content with a 204 status on success.
</Accordion>

<Accordion title="Posthog Fetch Pipeline Destination Details">
  Use a get request to '/api/projects/\{project id}/pipeline destination configs/\{id}/activity/' to get details, status, config, and metrics for a pipeline destination by id, returning json.
</Accordion>

<Accordion title="Delete organization project">
  Projects for the current organization.
</Accordion>

<Accordion title="Fetch frontend app config status">
  Retrieve activity details for a specific pipeline frontend app config by id within a project. requires both `project id` and config `id` in the path. returns json with app config details like plugin info, enablement, order, and error status.
</Accordion>

<Accordion title="List dashboard sharing configs">
  Retrieve a list of dashboard sharing configurations for a specified project and dashboard. requires dashboard id, project id, and sharing read permission via personalapikeyauth. returns json array of sharing settings.
</Accordion>

<Accordion title="List batch export runs with pagination and ordering">
  List runs for a batch export by `batch export id` within a project. supports pagination & ordering of the results. requires `batch export:read` permission. returns status, errors, counts, and timestamps for each run.
</Accordion>

<Accordion title="Fetch batch export details via uuid">
  Retrieve logs for a specific batch export within a project by its uuid. endpoint requires project id and export id (uuid). supports json responses detailing export properties, run statuses, and error info.
</Accordion>

<Accordion title="List organization s batch exports with pagination">
  Retrieve paginated batch exports for an organization, with filters and optional limits. includes team, interval, and status details. access requires personalapikeyauth with batch export:read rights.
</Accordion>

<Accordion title="Delete person and optionally associated events">
  This endpoint is used to read and delete user data. use the capture api, `$set`/`$unset` commands, or sdks for creating/updating persons.
</Accordion>

<Accordion title="Fetch export unsubscribe settings">
  Retrieve pipeline transformation export unsubscribe configurations for a specified organization by its uuid. returns details including id, plugin type, and configuration schema in json format.
</Accordion>

<Accordion title="List organization roles with pagination">
  Fetch a paginated list of roles in an organization using its uuid. supports query parameters for limits and offsets. access needs personalapikeyauth. returns details like id, name, and creator info.
</Accordion>

<Accordion title="List and manage project feature flags">
  Manage feature flags with creation, reading, updating, and deletion capabilities. utilize javascript library or an endpoint for application integration. more details in the docs.
</Accordion>

<Accordion title="Fetch project survey activity log">
  Retrieve the activity log of surveys within a specific project by using the project id. this endpoint requires a personalapikeyauth with 'activity log:read' permission and returns survey details including types, flags, questions, and metadata.
</Accordion>

<Accordion title="Delete organization by uuid">
  Delete an organization by its uuid. requires a 'personalapikeyauth' with 'organization:write' permission. on success, returns a 204 status code with no response body.
</Accordion>

<Accordion title="List organization members with pagination">
  Retrieve members list from an organization with 'limit' and 'offset' options using personalapikeyauth and organization id. access requires organization member:read permission. returns members' details and statuses.
</Accordion>

<Accordion title="Fetch session recording playlist details">
  Retrieve session recording playlist details for a specific project by project id and playlist short id. requires personalapikeyauth with read access. returns playlist metadata including creation and modification info.
</Accordion>

<Accordion title="Posthog List Role Memberships Paginated">
  Retrieve a paginated list of role memberships for a specific role within an organization, including membership details. optional query parameters ‘limit’ and ‘offset’ control pagination; ‘organization id’ and ‘role id’ are path parameters.
</Accordion>

<Accordion title="List organization s paginated proxy records">
  Retrieve a paginated list of an organization's proxy records by id, with 'limit' and 'offset' options. 'organization id' and 'personalapikeyauth' are necessary. includes status, domain, and counts.
</Accordion>

<Accordion title="List organization s pipeline frontend apps">
  Retrieve a paginated list of pipeline apps for an organization using 'plugin:read' personalapikeyauth. requires organization id (uuid) and supports limit and offset parameters. includes app types and statuses.
</Accordion>

<Accordion title="Fetch organization details by uuid">
  Retrieve organization details by uuid. endpoint requires 'organization:read' access. response includes name, slug, timestamps, membership, plugins access level, and team structure.
</Accordion>

<Accordion title="Fetch organization pipeline app repositories">
  Retrieve details of pipeline import app repositories for a specific organization by its uuid. returns json with properties like plugin type, name, and url. supports 'local', 'custom', 'repository', 'source', 'inline' types.
</Accordion>

<Accordion title="Flag annotation as deleted">
  Hard delete of this model is not allowed. use a patch api call to set "deleted" to true
</Accordion>

<Accordion title="Generate project funnel correlation insight">
  The /api/projects/\{project id}/insights/funnel/correlation endpoint generates a correlation insight for funnel analysis in a project, accepting json/csv and needing 'project id' and insight details.
</Accordion>

<Accordion title="List project subscriptions with pagination">
  Retrieve a paginated list of subscriptions for a given project by its id. optional query params include 'limit' for results per page and 'offset' for results starting index. authentication is required. returns subscription details and navigation links.
</Accordion>

<Accordion title="List project configuration plugin logs">
  Retrieve logs for a specific plugin configuration within a project. supports pagination with limit and offset query parameters. requires project and plugin configuration ids. auth: personalapikeyauth with plugin:read scope.
</Accordion>

<Accordion title="List project batch exports with pagination">
  Retrieve an indexed list of batch exports for a specified project with optional pagination. view export details, statuses, and pagination links. requires project id and supports personalapikeyauth.
</Accordion>

<Accordion title="List organization s pipeline destinations">
  Retrieve a paginated list of an organization's pipeline destinations by id, with optional count and offset parameters. requires personalapikeyauth (plugin:read). returns details like id, type, and organization info.
</Accordion>

<Accordion title="List project experiments with pagination">
  Get a paginated list of experiments within a project using 'limit' and 'offset' parameters. need a valid project id and 'experiment:read' permission. returns details like features and metrics.
</Accordion>

<Accordion title="List project export items with pagination">
  Retrieve a paginated list of export items for a specific project by id with optional 'limit' and 'offset' query parameters. requires personalapikeyauth for export:read permission. supports multiple export formats.
</Accordion>

<Accordion title="Enable project early access feature">
  Enables a new early access feature for a project using project id, payload with details, and personalapikeyauth. returns a 201 status on success.
</Accordion>

<Accordion title="List pipeline destination configs with pagination">
  List pipeline destination configurations for a given project by id, with optional pagination through 'limit' and 'offset' query parameters. returns details such as plugin info and delivery rates. authentication required.
</Accordion>

<Accordion title="List session recording sharing configs">
  Retrieve a list of sharing configurations for a specific session recording in a project, including creation timestamps and access tokens. requires project and recording ids.
</Accordion>

<Accordion title="List specific type groups with pagination">
  List all groups of a specific group type. you must pass ?group type index= in the url. to get a list of valid group types, call /api/:project id/groups types/
</Accordion>

<Accordion title="List unused organization pipeline transformations">
  Retrieve a list of unused pipeline transformations for a specified organization, identified by uuid. includes details like name, plugin type, and configuration. supports json response format.
</Accordion>

<Accordion title="List project dashboards with pagination">
  Get paginated dashboards for a project by id, using 'limit' and 'offset'. must authenticate with personalapikeyauth. includes count, pagination, and dashboard details.
</Accordion>

<Accordion title="List feature flag role access details">
  This get endpoint returns role access details for a feature flag in a project, needs 'project id' & 'feature flag id', and offers optional 'limit' & 'offset' for pagination.
</Accordion>

<Accordion title="List project group types by id">
  Retrieve a list of group types within a specific project by providing the project id. this endpoint requires authentication with a personalapikey and grants read access to group data.
</Accordion>

<Accordion title="Initiate domain verification with saml config">
  Post /api/organizations/\{organization id}/domains/\{id}/verify/: initiates verification for a domain within an organization using its uuid, updating its verification status and related saml configuration attributes. supports json and form data formats.
</Accordion>

<Accordion title="List users with staff filter and pagination">
  Api endpoint fetches a user list with staff filter, pagination (limit, offset), and requires a personal api key. data includes uuids, emails, and organizational details.
</Accordion>

<Accordion title="Manage project feature flags for local evaluation">
  Utilize feature flags to manage application features with creation, reading, updating, and deletion. consult posthog's docs or use their js library or endpoint for user-specific flag checks.
</Accordion>

<Accordion title="List pipeline frontend app configs">
  Retrieve paginated configurations for pipeline frontend apps associated with a specified project. query parameters 'limit' and 'offset' control pagination. requires a project id and personalapikeyauth for access. supports json responses.
</Accordion>

<Accordion title="Manage project feature flags">
  Learn to manage feature flags: create, read, update, delete, and check their status using the javascript library or an endpoint. consult the linked docs for details.
</Accordion>

<Accordion title="List project dashboard collaborators">
  Get dashboard collaborators list in a project using project string id and dashboard integer id. requires personalapikeyauth and `dashboard:read` permission. returns details like access level and timestamps.
</Accordion>

<Accordion title="Delete session recording by uuid">
  Delete a session recording by providing the session's uuid and the associated project id. requires `session recording:write` permission. returns no content on successful deletion.
</Accordion>

<Accordion title="List project membership details">
  Retrieve a list of project membership details for a specified project by id. members and their roles, such as member or admin, are included along with their join and update timestamps.
</Accordion>

<Accordion title="Manage feature flag enrichment for usage dashboard">
  Learn to manage feature flags (creation, access, modification, removal) using posthog's docs, with options to use a javascript library or a dedicated endpoint for user-specific flag status.
</Accordion>

<Accordion title="Mark dashboard template as deleted">
  Hard delete of this model is not allowed. use a patch api call to set "deleted" to true
</Accordion>

<Accordion title="List project dashboard templates">
  "retrieve a paginated list of dashboard templates for a specified project. use 'limit' and 'offset' query parameters to control result pagination. requires project's id in the path and supports personalapikeyauth for security."
</Accordion>

<Accordion title="Manage user feature flags">
  Manage feature flags in your app with create, read, update, and delete options. use posthog's javascript library or endpoint to verify user access. see documentation for details.
</Accordion>

<Accordion title="List notebooks with filters and pagination">
  The api for interacting with notebooks. this feature is in early access and the api can have breaking changes without announcement.
</Accordion>

<Accordion title="Modify org info via uuid">
  Put /api/organizations/\{id}/: update organization details by providing a uuid as 'id'. supports json, form-urlencoded, multipart/form-data. requires 'organization:write' permission. returns updated organization data.
</Accordion>

<Accordion title="List project pipeline configurations">
  Fetch paginated pipeline configuration list for a project by its id, utilizing optional `limit` and `offset`. endpoint returns json data.
</Accordion>

<Accordion title="Partially update project property definition">
  Patch /api/projects/\{project id}/property definitions/\{id}/: partially update a specific property definition by uuid in a project. requires property definition:write auth. no response body.
</Accordion>

<Accordion title="Initiate pipeline transformation job">
  Create a pipeline transformation job for a specified plugin config in a project by posting to `/api/projects/\{project id\}/pipeline transformation configs/\{id\}/job/`. requires project id and plugin config id.
</Accordion>

<Accordion title="Move dashboard tile">
  Endpoint to move a tile within a dashboard by `id`. requires `project id`, accepts json/form-data (e.g., `name`, `pinned`), and returns updated dashboard info.
</Accordion>

<Accordion title="List projects in organization with pagination">
  Projects for the current organization.
</Accordion>

<Accordion title="List of project s session recording playlists">
  Retrieve a list of session recording playlists for a specific project. filter by creator, paginate with limit and offset, and identify playlists with project id and optional short id. requires 'session recording playlist:read' permission.
</Accordion>

<Accordion title="Partially update project plugin config">
  Update plugin configuration partially for a specified project using patch on '/api/projects/\{project id}/plugin configs/\{id}'. requires plugin write authority. accepts json, form data, and multipart. returns updated plugin config details.
</Accordion>

<Accordion title="List project early access features">
  Retrieve a paginated list of a project's early access features by id with 'limit' and 'offset' parameters. an api key is needed. includes feature info like creation date, stage, and documentation link.
</Accordion>

<Accordion title="Mark insight as viewed with configurable format">
  The post endpoint marks an insight as viewed for a specified project, requires `project id` and `id`, supports `csv` or `json` formats, and returns fast-loading serialized data.
</Accordion>

<Accordion title="Partial experiment update in project">
  Endpoint enables partial updates to an experiment in a project using patch, needing `project id`, `experiment id`, and various payload types. returns updated details. authentication is mandatory.
</Accordion>

<Accordion title="List and filter project events">
  This endpoint for listing/filtering events is deprecated and maintained only for compatibility. users are discouraged from using it and should use the query endpoint for ad-hoc lists/aggregations or cdp/batch exports for bulk exports.
</Accordion>

<Accordion title="Posthog List Project Pipeline Import Configs">
  List pipeline import app configurations for a specified project, with pagination options 'limit' and 'offset'. requires a project id and supports personalapikeyauth for security. responds with json objects including configuration details.
</Accordion>

<Accordion title="Partial pipeline frontend app config update">
  Patch method to partially update config of a pipeline frontend app for a project by id. requires write permission on plugin. accepts json, form-data; returns updated config details.
</Accordion>

<Accordion title="Fetch pipeline transformation details">
  Retrieve details of pipeline transformations from a specified organization's repository. requires `organization id` (uuid). returns json with properties like id, plugin type, and name. supports filtering by types like local, custom, repository, etc.
</Accordion>

<Accordion title="Partial update of a project s feature flag">
  Learn to manage feature flags (create, read, update, delete) using posthog's docs, with options for javascript library use or dedicated endpoints for user flag status.
</Accordion>

<Accordion title="Partial update of a project insight">
  The patch endpoint supports partial insight updates in a project, allows format specification (csv/json), and requires `personalapikeyauth` and `insight:write` scope for access.
</Accordion>

<Accordion title="List project actions with pagination and filters">
  Get paginated project actions with filters by format. query params: limit, offset. needs personalapikeyauth for read. includes id, name, description, metadata.
</Accordion>

<Accordion title="Prevent hard delete notebook by flagging">
  Hard delete of this model is not allowed. use a patch api call to set "deleted" to true
</Accordion>

<Accordion title="List organization invites with pagination">
  Retrieve a paginated list of invites for a specific organization, identified by `organization id`, with optional `limit` and `offset` query params for result customization. requires `organization member:read` permission.
</Accordion>

<Accordion title="List organization domains with pagination">
  Fetch a list of an organization's domains with pagination using `limit` and `offset`. access requires `organization id` and a personalapikeyauth. optional parameters available. provides domain info, verification, and saml setup.
</Accordion>

<Accordion title="List and manage project annotations">
  Create, read, update and delete annotations. [see docs](https://posthog.com/docs/user-guides/annotations) for more information on annotations.
</Accordion>

<Accordion title="List project plugin configurations">
  Retrieve a paginated list of plugin configurations for a specific project by project id. supports optional 'limit' & 'offset' query params for result batching. requires 'personalapikeyauth' for 'plugin:read' access.
</Accordion>

<Accordion title="Persist session recording data by uuid">
  Post `/api/projects/\{project id\}/session recordings/\{id\}/persist`: endpoint for persisting session recording data identified by uuid. requires `project id` and accepts json containing various read-only session metrics. responds with session data.
</Accordion>

<Accordion title="Person partial update via project id">
  This endpoint allows reading and deleting individuals. for creation or updates, use the capture api, `$set`/`$unset` properties, or sdks.
</Accordion>

<Accordion title="List organization s pipeline import apps">
  Retrieve a paginated list of pipeline import applications for a specified organization by id. supports optional 'limit' and 'offset' query parameters for result pagination. requires an organization uuid and a personal api key for authentication.
</Accordion>

<Accordion title="Post project trends in various formats with optional filters">
  The `/api/projects/\{project id\}/insights/trend/` endpoint provides project trends in csv/json, requires `project id` and optional parameters, and needs 'personalapikeyauth'. it outputs event data and cache status.
</Accordion>

<Accordion title="Rearrange pipeline transformation configs">
  Endpoint `/api/projects/\{project id\}/pipeline transformation configs/rearrange/` allows for partial updates to the arrangement of pipeline configurations for a given project. accepts patch requests with necessary parameters and the project id in the path.
</Accordion>

<Accordion title="Person property deletion endpoint">
  This endpoint is for reading and deleting user data. use the capture api, `$set`/`$unset`, or sdks for creating/updating users.
</Accordion>

<Accordion title="Rearrange frontend app pipeline configs">
  Patch /api/projects/\{project id}/pipeline frontend apps configs/rearrange/: rearrange the config of frontend apps in a project's pipeline. requires project id in the path and a json object in the request body. responds with updated config details.
</Accordion>

<Accordion title="Partial update of project notebook">
  The api for interacting with notebooks. this feature is in early access and the api can have breaking changes without announcement.
</Accordion>

<Accordion title="Remove explicit project member by uuid">
  Delete a specific user (by uuid) from the explicit members of a given project. requires 'project id' and member's 'parent membership  user  uuid'. returns 204 on success with no response body.
</Accordion>

<Accordion title="List project session recordings">
  Retrieve a paginated list of session recordings for a specific project, including viewing times and user interactions. specify `project id`, and use optional `limit` and `offset` query parameters to control result set size and starting point.
</Accordion>

<Accordion title="Remove domain by uuid from organization">
  Delete a specific domain by its uuid within an organization, given valid organization and domain ids. requires 'organization:write' permission; no response body on success (204).
</Accordion>

<Accordion title="Remove early access feature from project">
  Delete an early access feature by id from a specified project. requires a uuid for the feature and the project's id. authentication via personalapikeyauth is necessary. no response body upon success.
</Accordion>

<Accordion title="Remove member from organization by uuid">
  Delete /api/organizations/\{org id}/members/\{user uuid}: removes a specific member from an organization using uuids for both entities. requires 'organization member:write' permission; returns 204 with no content on success.
</Accordion>

<Accordion title="Fetch project experiment secondary data">
  Fetch secondary experiment data in a project by its unique id, using project and experiment ids as path parameters. authenticated by personalapikeyauth, it returns a json with experiment info, features, and metrics.
</Accordion>

<Accordion title="Reconfigure plugin order and status in project">
  Patch endpoint to reconfigure the order of plugins within a project by project id. supports json, form, and multipart bodies to update plugin order and status.
</Accordion>

<Accordion title="List organization s pipeline transformations">
  Retrieve paginated pipeline transformation lists for an organization using `limit` and `offset`, requiring a uuid and personalapikeyauth. supports filtering and detailed views.
</Accordion>

<Accordion title="Mark session recording playlist deleted">
  Hard delete of this model is not allowed. use a patch api call to set "deleted" to true
</Accordion>

<Accordion title="Remove feature flag role access by id">
  Delete /api/projects/\{project id}/feature flags/\{feature flag id}/role access/\{id}: remove role access from a feature flag in a project by id, requiring authorization. expect no response body upon success (204).
</Accordion>

<Accordion title="Partial update project annotation">
  Create, read, update and delete annotations. [see docs](https://posthog.com/docs/user-guides/annotations) for more information on annotations.
</Accordion>

<Accordion title="Mark project action as deleted">
  Hard delete of this model is not allowed. use a patch api call to set "deleted" to true
</Accordion>

<Accordion title="Partial update of a project s dashboard">
  Endpoint patch /api/projects/\{project id}/dashboards/\{id}: allows partial update of a project's dashboard with specified id. accepts json, form data, and provides a detailed response schema based on user license. requires dashboard write access.
</Accordion>

<Accordion title="List paginated surveys for a project">
  Get paginated surveys for a project with its id, using 'limit' and 'offset'. needs personalapikeyauth ('survey:read'). json output includes survey info, links, and metadata.
</Accordion>

<Accordion title="Rearrange project pipeline destination configs">
  "patch /api/projects/\{project id}/pipeline destination configs/rearrange/": adjust order and settings of pipeline destinations for a project by project id. requires json body with plugin, enabled state, etc. returns updated configuration.
</Accordion>

<Accordion title="Rearrange project import app configurations">
  Rearrange app import settings in a project using patch /api/projects/\{project id}/... by updating plug-in order and status. requires `project id` and a json with configurations.
</Accordion>

<Accordion title="List or delete persons with optional filters">
  This endpoint is for reading/deleting persons. for creating/updating, use the capture api, set/unset properties, or sdks.
</Accordion>

<Accordion title="Mark subscription as deleted by id">
  Hard delete of this model is not allowed. use a patch api call to set "deleted" to true
</Accordion>

<Accordion title="Remove pipeline transformation config by id">
  Delete a specific pipeline transformation configuration by id within a project. requires the project id and configuration id. secured by personalapikeyauth with plugin:write access. no response body upon success (204).
</Accordion>

<Accordion title="Remove organization pipeline transformation">
  Delete a specific pipeline transformation plugin for an organization by id. requires a uuid for the organization and an integer for the plugin. auth: personalapikey with write access. no response body on success (204).
</Accordion>

<Accordion title="Retrieve app metrics error details">
  Retrieves detailed error information for a specific app metric by id within a project. requires project id and metric's integer id as path parameters. no response body for a successful query.
</Accordion>

<Accordion title="Remove organization proxy record">
  Delete a proxy record by id for a specific organization. requires an authenticated user with 'organization:write' permission. on success, it responds with a 204 status and no content.
</Accordion>

<Accordion title="Remove property definition by uuid">
  Delete a property definition by providing its uuid and the associated project id. requires 'property definition:write' permission. on success, no response body is returned (204).
</Accordion>

<Accordion title="Remove pipeline import app config">
  Delete a specific pipeline import app configuration using its id within a project. requires project id and config id, and auth via personalapikeyauth with plugin write access. no response body on success (204).
</Accordion>

<Accordion title="Retrieve cohort person details">
  Retrieve details of persons within a cohort by its unique id in the specified project. the endpoint supports json and csv formats and requires authorization. project and cohort ids must be provided.
</Accordion>

<Accordion title="Retrieve dashboard template schema">
  Retrieve the json schema for dashboard templates of a specific project. pass the project id in the path and receive details such as template name, description, filters, and more. supports get requests.
</Accordion>

<Accordion title="Retrieve feature flags evaluation reasons">
  Manage feature flags—create, read, update, delete—using the posthog javascript library or endpoint for user-specific flag status. (more in docs).
</Accordion>

<Accordion title="Remove pipeline frontend app by id">
  Delete a specific pipeline frontend app by its id within an organization. requires the organization id (uuid) and the app's integer id. auth: personalapikeyauth with plugin:write scope. no response body on success (204).
</Accordion>

<Accordion title="Remove organization role by id">
  Delete a role with a specific uuid in an organization. requires 'organization:write' permission. no response body on success (204). path parameters include 'id' and 'organization id'.
</Accordion>

<Accordion title="Retrieve feature flag activity details">
  Manage feature flags (creation, reading, updating, and deleting) using posthog's guides or via javascript library/endpoint for user-specific flag status. [details](https://posthog.com/docs/user-guides/feature-flags)
</Accordion>

<Accordion title="Remove org pipeline import app by id">
  Delete a specific pipeline import app plugin associated with an organization by id. requires a personal api key with write permissions for plugins. responds with no content on success (204).
</Accordion>

<Accordion title="Remove organization batch export by uuid">
  Delete a specific batch export by its uuid in an organization. requires personalapikeyauth with batch export:write permission. returns 204 on success with no response body.
</Accordion>

<Accordion title="Retrieve async query status by id">
  (experimental)
</Accordion>

<Accordion title="Remove organization pipeline destination">
  Delete a specific pipeline destination in an organization by id. requires an integer 'id' of the destination, and the organization's 'uuid'. auth: personalapikey with plugin:write. no return body on success (204).
</Accordion>

<Accordion title="Remove organization plugin by id">
  Delete a specific plugin (by its integer id) from the organization (identified by uuid) with no response body on success. requires plugin:write authorization via personalapikeyauth.
</Accordion>

<Accordion title="Retrieve or delete person retention data">
  This endpoint is for reading and deleting person data; use the capture api, `$set`/`$unset` properties, or sdks for creation and updates.
</Accordion>

<Accordion title="Retrieve dashboard template details by uuid">
  Fetch specific dashboard template details by uuid in a project with 'dashboard template:read' rights using a personalapikeyauth. returns name, description, filters, and creation info.
</Accordion>

<Accordion title="Retrieve organization pipeline unsubscribe configs">
  Retrieve unsubscribe config details for an organization's pipeline frontend apps. requires an organization id (uuid). returns json with config data including plugin types and more.
</Accordion>

<Accordion title="Retrieve historical app metrics export">
  Retrieve historical export data for app metrics by supplying the `project id` and `plugin config id`. requires `plugin:read` permission. no response body provided upon a successful request.
</Accordion>

<Accordion title="Retrieve organization s pipeline repository details">
  Retrieve details for repository pipeline destinations within a specific organization by its uuid. returns objects like id, name, and urls with support for various plugin types (local, custom, etc.).
</Accordion>

<Accordion title="Retrieve organization plugin activity">
  Retrieve activity details for plugins in a specified organization by id. supports various plugin types, including local, custom, and repository. response includes plugin's id, name, type, and relevant metrics. requires a valid uuid for 'organization id'.
</Accordion>

<Accordion title="Remove rolemembership by uuid">
  Delete /api/organizations/\{org id}/roles/\{role id}/role memberships/\{id}: removes a role membership from an organization using a specific uuid. requires write access. returns 204 on success.
</Accordion>

<Accordion title="Retrieve important project activity log">
  Retrieve a log of important changes for a specified project. requires a `project id` and returns details about the change, including user info, read status, and timestamps. use `/api/projects/\{project id\}` to obtain project ids.
</Accordion>

<Accordion title="Retrieve paginated organization list">
  Retrieve a paginated list of organizations with optional 'limit' and 'offset' query parameters. the response includes organization details like id, name, and membership level, with secure access controlled via personalapikeyauth.
</Accordion>

<Accordion title="Retrieve organization pipeline frontend app details">
  Retrieve pipeline frontend app details for an organization using its 'organization id' (uuid). response includes id, plugin type, name, url in json format, covering various plugin types.
</Accordion>

<Accordion title="Retrieve last viewed insights for user">
  Returns basic details about the last 5 insights viewed by this user. most recently viewed first.
</Accordion>

<Accordion title="Retrieve feature flags activity log">
  Learn to manage feature flags by creating, reading, updating, and deleting them. use posthog's javascript library or endpoint for application integration. details in the [docs](https://posthog.com/docs/user-guides/feature-flags).
</Accordion>

<Accordion title="Retrieve event definitions by project id">
  Retrieve definitions for events within a specified project by providing the unique project id. requires personalapikeyauth privileges for event definition:read. no response body provided upon a successful call.
</Accordion>

<Accordion title="Remove session recording from playlist">
  Delete a session recording from a playlist using its id within a specified project. requires project id, short id, and session recording id in the path. returns no content on success (204).
</Accordion>

<Accordion title="Remove project dashboard collaborator">
  Remove a collaborator from a project dashboard. provide the project id, dashboard id, and user's uuid. requires 'dashboard:write' permissions. expect no response body on success (204). project id guidance at '/api/projects/'.
</Accordion>

<Accordion title="Retrieve insight sharing configurations">
  Retrieve sharing configurations for a specific insight within a project, requiring project and insight ids. validates access via personalapikeyauth. returns data such as creation time and access tokens.
</Accordion>

<Accordion title="Remove pipeline destination config">
  Delete a pipeline destination configuration by specifying a unique integer id within a project. requires 'plugin:write' permission via personalapikeyauth. no response body on success (204). project id is mandatory.
</Accordion>

<Accordion title="Retrieve organization s unused pipeline apps">
  Retrieve unused pipeline import apps for a specified organization. endpoint requires an organization id (uuid) and returns details like plugin type, name, description, and more in json format.
</Accordion>

<Accordion title="Retrieve persons funnel correlation data">
  This endpoint is for reading and deleting persons. use the capture api, `$set` and `$unset` properties, or sdks for creating or updating persons.
</Accordion>

<Accordion title="Remove pipeline frontend app config">
  Delete a pipeline frontend app configuration for a specific project. requires 'project id' and config 'id' in the path and 'plugin:write' permissions. responds with 204 on success without a body.
</Accordion>

<Accordion title="Retrieve batch export details">
  Retrieve details of a specific batch export by its uuid in a project. requires project id and batch export id. supports personalapikeyauth and responds with export details including destination, interval, and status.
</Accordion>

<Accordion title="Retrieve org pipeline transformation activity">
  Retrieve pipeline transformation activity details for a specific organization using its uuid. returns data such as plugin type, name, description, and related metrics. requires 'organization id' in url path.
</Accordion>

<Accordion title="Retrieve pipeline destination details">
  Fetch a pipeline destination's details by id and organization uuid, using a personalapikeyauth with read access to plugins. returns json with plugin info.
</Accordion>

<Accordion title="Retrieve or delete project persons funnel data">
  This api endpoint is for reading and deleting user data. use the capture api, `$set` and `$unset` properties, or sdks for creating/updating users.
</Accordion>

<Accordion title="Retrieve person details by id">
  This endpoint is used to read and delete persons. for creating or updating, use the capture api, `$set` and `$unset` properties, or sdks.
</Accordion>

<Accordion title="Retrieve person details by project">
  This endpoint allows reading and deleting persons; for creation or updates, use the capture api, the `$set` and `$unset` properties, or sdks.
</Accordion>

<Accordion title="Retrieve pipeline destination activity">
  Retrieve activity details for pipeline destinations within an organization. required: uuid-formatted `organization id`. outputs application/json with attributes: id, latest tag, etc. supports `get` requests.
</Accordion>

<Accordion title="Remove specific project query">
  (experimental)
</Accordion>

<Accordion title="Remove project event definition">
  Delete an event definition by providing its uuid and the associated project id. requires `event definition:write` permission. successful deletion returns no content (204 status).
</Accordion>

<Accordion title="Retrieve batch export logs by uuid">
  Retrieve logs for a specific batch export given by uuid within an organization. essential for tracking export status, errors, and configurations. supports json responses detailing export properties and history.
</Accordion>

<Accordion title="Retrieve pipeline destination plugin details">
  Retrieve details of a specific pipeline destination plugin within an organization by its unique id. the response includes various properties like name, description, url, and plugin type for the given organization uuid.
</Accordion>

<Accordion title="Remove specific project batch export">
  Delete a specific batch export by providing the uuid and project id. requires a personal api key with 'batch export:write' permissions. responds with no body upon successful deletion (http 204).
</Accordion>

<Accordion title="Retrieve person lifecycle details">
  This endpoint is for reading and deleting persons. use the capture api, property methods, or sdks for creating or updating persons.
</Accordion>

<Accordion title="Remove project experiment by id">
  Delete a specific experiment by its unique integer id within a project. requires a project id and personal api key with experiment write permission. no response body upon success.
</Accordion>

<Accordion title="Retrieve pipeline frontend app details">
  Retrieves details of a specified pipeline frontend app within an organization. requires plugin read access and organization id (uuid), and app id (integer) as path parameters. returns json with app information.
</Accordion>

<Accordion title="Retrieve matching events for session recording">
  Retrieves event ids matching a filter with one session id and at least one event/action criterion. intended for internal use and may have sudden changes.
</Accordion>

<Accordion title="Retrieve pipeline frontend app activity">
  Retrieve activity details for pipeline front-end apps within a specified organization by organization id. returns json object with app properties such as id, type, name, and configuration. uuid path parameter required.
</Accordion>

<Accordion title="Retrieve notebook activity for project">
  The api for interacting with notebooks. this feature is in early access and the api can have breaking changes without announcement.
</Accordion>

<Accordion title="Retrieve organization plugin details">
  Retrieve a specific plugin's details for an organization. requires the plugin's integer id and the organization's uuid. only returns plugin info if authenticated with 'plugin:read' permission. responds with plugin data in json format.
</Accordion>

<Accordion title="Retrieve pipeline frontend app source details">
  Retrieve details for a specific pipeline frontend app's source by its id within an organization. requires an integer id of the app and uuid of the organization. returns json object with app properties.
</Accordion>

<Accordion title="Retrieve pipeline frontend plugin config">
  Retrieve the frontend configuration for a specific plugin in a project's pipeline. requires project and config ids and returns details like plugin info, status, and creation timestamps.
</Accordion>

<Accordion title="Retrieve notebook activity log">
  The api for interacting with notebooks. this feature is in early access and the api can have breaking changes without announcement.
</Accordion>

<Accordion title="Retrieve event definition by uuid">
  Retrieve an event definition by its uuid within a specified project. requires a project id and an event definition id, with access secured by personalapikeyauth. (get /api/projects/\{project id}/event definitions/\{id})
</Accordion>

<Accordion title="Retrieve pipeline destination frontend config">
  Retrieve configuration details for a specific pipeline destination in a project by getting the frontend data of the config with a given id. this endpoint requires the 'project id' and 'id' of the config.
</Accordion>

<Accordion title="Retrieve organization plugin repository details">
  Retrieve plugin repository details for a specific organization by its uuid, including plugin type, name, url, and more. accessible via get request to '/api/organizations/\{organization id}/plugins/repository/'.
</Accordion>

<Accordion title="Retrieve pipeline import app source details">
  Retrieves source details of a pipeline import app by its id within a specified organization. expects `organization id` (uuid) and `id` (integer) as path parameters. returns app properties including type, name, and related info.
</Accordion>

<Accordion title="Retrieve batch export run logs">
  Retrieve logs for a specific batch export run within a project. requires `project id`, `batch export id`, and `id` (all uuids). the endpoint returns run status, error info, record count, and timestamps.
</Accordion>

<Accordion title="Retrieve pipeline import app details">
  Access specific pipeline import app details in an organization using its id and a valid organization uuid. requires 'personalapikeyauth' with 'plugin:read' access. outputs app properties in json format.
</Accordion>

<Accordion title="Retrieve pipeline import apps activity">
  Retrieve activity details of pipeline import apps for a given organization. requires 'organization id' (uuid). returns app id, type, name, url, and other metadata. supports 'local', 'custom', 'repository', 'source', and 'inline' plugin types.
</Accordion>

<Accordion title="Retrieve notebook details">
  The api for interacting with notebooks. this feature is in early access and the api can have breaking changes without announcement.
</Accordion>

<Accordion title="Retrieve experiments requiring flag implementation">
  Retrieve details for experiments that require feature flag implementation in a specific project. requires a valid 'project id' and user must have 'experiment:read' permission. returns information like experiment names, dates, flags, and creation data.
</Accordion>

<Accordion title="Retrieve and delete project person trends">
  This endpoint is for reading and deleting persons. use the capture api, `$set`/`$unset` properties, or sdks for creating/updating persons.
</Accordion>

<Accordion title="Retrieve pipeline plugin details by id">
  Retrieve pipeline transformation plugin details by id for a specified organization. requires authentication and provides information like plugin type, name, and configuration for authorized users. supports json response.
</Accordion>

<Accordion title="Retrieve pipeline transformation config">
  Retrieve the configuration for a specific pipeline transformation plugin in a project by its id using a get request. requires project id and plugin config id in the path and 'plugin:read' permission.
</Accordion>

<Accordion title="Retrieve pipeline transformation frontend config">
  Retrieve the frontend configuration details for a specific pipeline transformation by id within a given project. this endpoint requires the project id and transformation config id in the path.
</Accordion>

<Accordion title="Retrieve organization plugin unsubscribe configs">
  Retrieve plugin export unsubscribe configurations for a specified organization by organization id. supports local, custom, repository, source, and inline plugin types, providing details like name, description, url, and icon.
</Accordion>

<Accordion title="Remove project plugin configuration">
  Delete /api/projects/\{project id}/plugin configs/\{id}/: removes a specific plugin configuration by id from a given project. requires 'plugin:write' permissions and project id. returns 204 with no body on success.
</Accordion>

<Accordion title="Retrieve plugin source details">
  Retrieve plugin source details by organization and plugin id. requires integer 'id' for the plugin and 'organization id' as uuid. responds with plugin attributes including type, name, and url.
</Accordion>

<Accordion title="Retrieve plugin config details">
  Retrieve the configuration details of a specific plugin by its id for a given project. this endpoint requires a project id and plugin config id, with read permission, and returns an object containing config settings and status.
</Accordion>

<Accordion title="Retrieve app metrics by ids">
  Retrieve app-specific metrics for a given project by providing the project id and app metric id. requires a personal api key with plugin:read access. no response body provided upon success (200).
</Accordion>

<Accordion title="Retrieve plugin config frontend">
  Retrieve the frontend configuration of an app's pipeline import by id within a specified project. requires `project id` and `id` of the plugin config. returns json object with config details.
</Accordion>

<Accordion title="Retrieve plugin frontend config">
  Retrieve the frontend configuration of a specific plugin for a given project. requires the project id and plugin config id. provides details including plugin state, order, and related info.
</Accordion>

<Accordion title="Retrieve experiment details by ids">
  Access detailed experiment info within a project using unique `experiment id` & `project id`, with 'experiment:read' rights. response includes dates, feature flag key, metrics, creator details.
</Accordion>

<Accordion title="Retrieve pipeline destination config details">
  Retrieve details of a specific pipeline destination config for a project by its id. requires project id and destination config id. supports personalapikeyauth for read access. responds with config details including plugin info, status, and timestamps.
</Accordion>

<Accordion title="Retrieve plugin source details for pipeline transformation">
  Retrieve the source details of a pipeline transformation for a specific plugin by id within an organization. access plugin metadata, like its type, url, and config, relevant to organizing and managing pipeline operations.
</Accordion>

<Accordion title="Retrieve plugin config activity details">
  Retrieve activity details for a specific plugin configuration within a project. requires `project id` and unique `id` of the plugin config. responds with plugin info, status, and activity metrics.
</Accordion>

<Accordion title="Retrieve organization project details">
  Projects for the current organization.
</Accordion>

<Accordion title="Retrieve plugin config activity">
  Retrieve activity details for a specific plugin config within a project's pipeline import apps. requires 'project id' and plugin config 'id' within the api path.
</Accordion>

<Accordion title="Retrieve person values by project">
  This endpoint is for reading and deleting persons. for creation or updates, use the [capture api](https://posthog.com/docs/api/capture), `$set`/`$unset`, or sdks.
</Accordion>

<Accordion title="Retrieve feature flag role access details">
  Retrieve details for a specific role's access to a feature flag within a project. requires 'feature flag id', 'id' for role access, and 'project id'. returns a json object with access details.
</Accordion>

<Accordion title="Retrieve hedgehog configuration by uuid">
  Retrieve user's hedgehog configuration details by their uuid. this endpoint requires the user's uuid as a path parameter and returns various user-related settings such as email, team info, timezone, and more in json format. supports get requests.
</Accordion>

<Accordion title="Retrieve group property definitions by project id">
  Retrieve property definitions for a group within a project by providing the project id. this endpoint returns details like group type index, key, and creation time in json format.
</Accordion>

<Accordion title="Retrieve organization role details">
  Retrieve the details of a specific role within an organization using its uuid. requires the organization's uuid and role's uuid in the path and is protected by personalapikeyauth with 'organization:read' scope. returns role data in json.
</Accordion>

<Accordion title="Retrieve plugin update info">
  This endpoint retrieves update information for a specific plugin within an organization's pipeline frontend app by its integer id and the organization's uuid. it returns details such as plugin type, name, and latest version.
</Accordion>

<Accordion title="Retrieve filtered project property definitions">
  Get property definitions for a project using project id, with filters for event names, property types, exclusions, and numerical or feature flags. also, view properties relevant to specific events.
</Accordion>

<Accordion title="Retrieve feature flag details">
  This guide details how to manage (create, read, update, delete) feature flags in applications using posthog's javascript library or endpoint. for more info, visit the provided documentation.
</Accordion>

<Accordion title="Retrieve person s activity and delete options">
  This endpoint is for reading and deleting persons; for creating/updating, use the capture api, `$set`/`$unset` properties, or sdks.
</Accordion>

<Accordion title="Retrieve cohort activity details">
  Retrieve activity details for a specific cohort within a project. requires a project id and cohort id, returning status, filters, query, and creator data. auth: personalapikeyauth with 'activity log:read' scope.
</Accordion>

<Accordion title="Retrieve person properties timeline">
  This endpoint allows reading and deleting individuals. use the capture api, `$set` and `$unset` properties, or sdks for creating or updating persons.
</Accordion>

<Accordion title="Retrieve group property values by index and key">
  Retrieve property values by 'group type index' and 'key' within a 'project id'. parameters must be provided. output is a json with property details and creation timestamp.
</Accordion>

<Accordion title="Retrieve export unsubscribe configs">
  Retrieve the configuration for unsubscribing from exports in the pipeline import apps for a specific organization. requires an organization uuid in the path. returns various properties including ids, plugin types, and metadata as a json object.
</Accordion>

<Accordion title="Retrieve funnel insights in project">
  Gain insights from funnel analysis of a specific project by providing its id and having 'insight:read' permission. supports json/csv formats and offers detailed info like creation, modification, and dashboards quickly.
</Accordion>

<Accordion title="Retrieve pipeline transformation activity">
  Retrieve the activity details of a specific pipeline transformation configuration in a project using its unique integer id. requires project id. returns json including config, plugin info, and activity data.
</Accordion>

<Accordion title="Retrieve project cohorts with pagination">
  Retrieve a paginated list of cohorts for a specific project using `project id`. supports `limit` and `offset` query params to customize the response. requires `personalapikeyauth` with `cohort:read` permissions.
</Accordion>

<Accordion title="Retrieve project insights with pagination">
  The get `/api/projects/\{project id\}/insights/` endpoint retrieves a paginated list of insights for a specified project. filter by creator, response format (csv/json), and use limit/offset for result batching. requires `insight:read` permission.
</Accordion>

<Accordion title="Retrieve plugin update status">
  Retrieve the latest update status for a specific plugin, identified by its integer id, within an organization specified by uuid. check compatibility and change logs.
</Accordion>

<Accordion title="Retrieve proxy record details">
  Retrieve a specific proxy record's details by id within an organization. requires path parameters 'organization id' and 'id'. returns json data including domain, status, and timestamps. auth: personalapikeyauth with 'organization:read'.
</Accordion>

<Accordion title="Retrieve project action details by id">
  Get details on a project action by id. supports json/csv format via query. needs 'project id' and 'id' path parameters. secured by personalapikeyauth.
</Accordion>

<Accordion title="Retrieve session property definitions">
  Retrieve property definitions for a specific project by providing the project's id. access this get endpoint at `/api/projects/\{project id\}/sessions/property definitions/`. project id is mandatory. no response body is returned upon a successful call.
</Accordion>

<Accordion title="Posthog Retrieve Retention Insights">
  Retrieve retention insights for a specified project. options to output in csv or json format. requires a project id and supports query customization. authenticated access with 'insight:read' permission necessary.
</Accordion>

<Accordion title="Retrieve project activity insights">
  Retrieve activity insights for a specific project by project id, supporting csv or json formats. requires an api key with activity log:read permission. limited to essential data to enhance response time for large datasets.
</Accordion>

<Accordion title="Retrieve project insights details">
  Retrieve detailed insights for a specific project using its id. queries can be made in csv or json format. requires 'insight:read' permission. results include various metadata like creation, last refresh, and associated dashboard info.
</Accordion>

<Accordion title="Retrieve project activity details">
  Projects for the current organization.
</Accordion>

<Accordion title="Retrieve project cohort details">
  Retrieve detailed information about a specific cohort within a project using its id. requires project id and cohort id; returns cohort details including name, creator info, and status. auth: personalapikeyauth with cohort:read permission.
</Accordion>

<Accordion title="Retrieve project activity log with pagination">
  Access a project's activity log using pagination and cursor-based navigation. requires project id and personalapikeyauth. outputs activity list with user data and timestamps.
</Accordion>

<Accordion title="Retrieve project cohorts activity log">
  Retrieve activity log for a specific project's cohorts. requires a project id and personalapikeyauth with activity log:read permission. response includes cohort details and creator info.
</Accordion>

<Accordion title="Retrieve project early access feature details">
  Retrieve details of a specific early access feature in a project by id. requires project id and feature uuid. must have 'early access feature:read' permission. returns feature details including status, flag info, and timestamps.
</Accordion>

<Accordion title="Retrieve related project groups">
  Retrieve related groups for a specific project and user. requires 'project id' (path), 'group type index', and user 'id' (query). returns group details with type, key, and creation date.
</Accordion>

<Accordion title="Retrieve project insight activity data">
  Retrieve insights activity for a specific project and insight id, offering data in json or csv format. requires project id and insight id in the path, with optional data format query. secure access via personalapikeyauth.
</Accordion>

<Accordion title="Retrieve project pipeline plugin config">
  Retrieve configuration details of a specific plugin for a given project pipeline by id. requires a valid project id and plugin config id. supports personalapikeyauth for 'plugin:read' access. responds with json containing configuration data.
</Accordion>

<Accordion title="Retrieve survey responses count by project id">
  Retrieve the count of survey responses for a specific project by its id. it requires the project id parameter and returns details like the survey type, linked flags, and creator info.
</Accordion>

<Accordion title="Retrieve unsubscribed pipeline configs">
  Retrieve config details for unsubscribed pipeline destinations in an organization. requires 'organization id' (uuid). returns plugin info, name, description, and more in json format.
</Accordion>

<Accordion title="Retrieve project annotation details">
  Create, read, update and delete annotations. [see docs](https://posthog.com/docs/user-guides/annotations) for more information on annotations.
</Accordion>

<Accordion title="Retrieve project draft sql query">
  Retrieve the draft sql query for a specific project using its project id. ensure to obtain the project id by calling /api/projects/. note: this endpoint does not return a response body.
</Accordion>

<Accordion title="Retrieve unused organization pipeline frontend apps">
  Retrieve unused pipeline frontend apps for a specific organization by its uuid. returns details like app ids, types, names, descriptions, and other metadata in json format. requires organization id in path.
</Accordion>

<Accordion title="Update organization member details">
  Update member details in an organization by id and user uuid. requires org member write permission. accepts json, form, or multipart. responses reflect member info, including roles and security settings.
</Accordion>

<Accordion title="Update event definition by uuid">
  Update an event definition by sending a put request to '/api/projects/\{project id}/event definitions/\{id}/' using the uuid and project id, provided you have 'event definition:write' authorization.
</Accordion>

<Accordion title="Soft delete feature flag by setting status">
  Hard delete of this model is not allowed. use a patch api call to set "deleted" to true
</Accordion>

<Accordion title="Update organization domain properties">
  Updates selected properties of a domain in an organization via patch request, supports various data formats but saml fields are immutable. authentication needed.
</Accordion>

<Accordion title="Soft delete a specific cohort by id">
  Hard delete of this model is not allowed. use a patch api call to set "deleted" to true
</Accordion>

<Accordion title="Retrieve project session values">
  Retrieve session values for a specified project. pass the project id in the url path to obtain the information. only the project's id is required as a parameter. no response body for the 200 ok status code.
</Accordion>

<Accordion title="Retrieve unused organization plugins">
  Retrieve a list of unused plugins for a specified organization by its uuid. the response includes plugin details such as type, name, and configuration. access restricted to the specified organization's context.
</Accordion>

<Accordion title="Retrieve specific domain details">
  Retrieve details of a specific domain within an organization using its uuid. authorized users can check domain verification status and saml configuration. requires the `personalapikeyauth` with `organization:read` scope.
</Accordion>

<Accordion title="Update organization s proxy record domain">
  Update a proxy record's domain details for a specified organization and proxy record id using put. requires organization and record ids, supports json, form, and multipart data. responses include status and timestamps. auth required.
</Accordion>

<Accordion title="Posthog Retrieve Unused Pipeline Destinations">
  Retrieve unused pipeline destinations for a specified organization by id. this get endpoint returns a json object with details like destination id, plugin type, and url, among other attributes. (uuid for organization id is required.)
</Accordion>

<Accordion title="Update organization member by uuids">
  Patch '/api/organizations/\{id}/members/\{uuid}': updates org member with user and org uuids. supports json/form/multipart. returns member data. secured by personalapikeyauth.
</Accordion>

<Accordion title="Retrieve project event details by id">
  Retrieve details for a specific event by id within a project. supports csv or json format. requires project id in path and adheres to personalapikeyauth for security.
</Accordion>

<Accordion title="Update partial role details in organization">
  Patch /api/organizations/\{organization id}/roles/\{id}/: update partial details of a role by id within an organization, including name and feature flag access level. requires uuids for both organization and role. supports json, form, and multipart data.
</Accordion>

<Accordion title="Retrieve project subscription details">
  Retrieve a specific subscription for a project, identified by 'project id' and 'id'. requires valid api key with read access. supports get method, returns subscription details including frequency, type, and creator info.
</Accordion>

<Accordion title="Retrieve user details for initiating 2fa setup">
  The endpoint `get /api/users/\{uuid\}/start 2fa setup/` fetches details for initiating 2fa setup for a user, providing information like email status, password presence, and more. fields are mostly read-only.
</Accordion>

<Accordion title="Retrieve project insight details">
  Retrieve details for a specific project insight by id, with options to format as json/csv, request refresh, and specify dashboard context. supports personalapikeyauth with insight read access. responses include metadata, results, and caching info.
</Accordion>

<Accordion title="Update experiment details">
  Update an experiment by sending a put request with `project id` and `id`, including new details as json/form data. changes to name, description, dates, etc., allowed. `experiment:write` permission needed.
</Accordion>

<Accordion title="Soft delete project dashboard">
  Hard delete of this model is not allowed. use a patch api call to set "deleted" to true
</Accordion>

<Accordion title="Update partial project cohort details">
  Update partial cohort details for a specific project. requires a cohort id and project id, supports json, form data, and accepts patch changes like name or description. returns updated cohort data. auth required.
</Accordion>

<Accordion title="Update person property endpoint">
  This endpoint allows for reading and deleting individuals. use the capture api, `$set` and `$unset` properties, or sdks for creating or updating persons.
</Accordion>

<Accordion title="Retrieve specific exported asset content">
  Retrieve the content of a specific exported asset by id within a project. requires 'export:read' permission. supports fetching details like creation time, format (png, pdf, csv, excel), etc.
</Accordion>

<Accordion title="Update pipeline destination config">
  Update the configuration for a pipeline destination in a project. accepts a json, form-urlencoded, or multipart data payload to modify plugin settings by providing project and config ids. requires plugin:write authority. responds with updated data.
</Accordion>

<Accordion title="Update partial subscription details">
  Patch /api/projects/\{project id}/subscriptions/\{id}/: update partial details of a specific project subscription by id. modify target, frequency, and more. requires subscription:write permission.
</Accordion>

<Accordion title="Update person properties">
  Request data's "properties" will be updated on a person using "\$set" event, affecting only listed properties without deletion or other changes. for property removal, use 'delete property' endpoint.
</Accordion>

<Accordion title="Update partial survey details">
  Update partial survey details by patch to /api/projects/\{project id}/surveys/\{id}/ with uuid. edit attributes like name, type, questions, targeting, and flags. needs personalapikeyauth for write access.
</Accordion>

<Accordion title="Retrieve user profile and team details">
  Fetch user info like profile, team, org, and notifications via uuid using personalapikeyauth ('user:read'). returns json with name, email, teams, and status.
</Accordion>

<Accordion title="Retrieve project member details by uuid">
  Retrieve detailed information about a specific user's membership level and status within a project by their uuid. access project members' data, roles, and timestamps. (get /api/projects/\{project id}/explicit members/\{uuid})
</Accordion>

<Accordion title="Retrieve project trend insights">
  Retrieve trend insights for a specific project, supporting csv or json formats. mandatory project id required. provides details on insight cache status, creator, and associated dashboards. auth: personalapikeyauth.
</Accordion>

<Accordion title="Update pipeline frontend app config">
  Update configuration for a specific pipeline frontend app by providing its id and the project id. configure details like activation, order, and optional parameters via json or form data. authentication required.
</Accordion>

<Accordion title="Update plugin config for project">
  Update a plugin config's partial details in a project by its id using patch. requires project id, config id. accepts json/form data. authenticated with personalapikeyauth. returns updated config.
</Accordion>

<Accordion title="Split person entities in project">
  This endpoint allows reading and deleting persons; for creation or updates, use the capture api, `$set`/`$unset` properties, or sdks.
</Accordion>

<Accordion title="Update pipeline plugin config">
  Update a project-specific pipeline plugin configuration by supplying the project id and config id. this put request expects details like plugin state, order, and more in json, form data, or url-encoded format. authentication is required.
</Accordion>

<Accordion title="Update pipeline transformation config">
  Update a pipeline transformation configuration for a specific project and config id. requires project id and config id in the path and json payload. supports plugin activation and order changes.
</Accordion>

<Accordion title="Update feature flag configuration">
  Manage feature flags for your app with creation, reading, updating, and deletion options. utilize posthog's js library or endpoint for flag status. more info in docs.
</Accordion>

<Accordion title="Update project early access feature">
  Update a specific early access feature of a project by providing the `project id` and feature `id` (uuid). requires a json body with feature details and responds with the updated status. authentication via personalapikeyauth is mandatory.
</Accordion>

<Accordion title="Update project action by id">
  Put endpoint '/api/projects/\{project id}/actions/\{id}/' updates actions in a project by id, accepts json/form data, supports 'format' query, and needs 'action:write' authentication.
</Accordion>

<Accordion title="Retrieve project event values">
  Retrieve event values for a specific project by id. supports querying in csv or json format. requires a project id and personal api key with query:read permission. responds with event details such as id, distinct id, properties, etc.
</Accordion>

<Accordion title="Retrieve project person activity">
  This endpoint allows reading and deleting individuals. for creating or updating, use the capture api, `$set`/`$unset` properties, or sdks.
</Accordion>

<Accordion title="Update project event definition">
  Update an existing event definition for a specified project using its uuid. requires a project id and event definition write permissions. responds without a body on success.
</Accordion>

<Accordion title="Retrieve session recording details">
  Retrieve detailed information about a specific session recording by providing the session's uuid and associated project id. the response includes metrics such as duration, activity, timestamps, and user data. authentication is required.
</Accordion>

<Accordion title="Revoke organization invite">
  Delete an organization invite by its uuid. requires a valid personalapikeyauth with organization member write permission. no response body returned on success (http 204).
</Accordion>

<Accordion title="Update project cohort details">
  Update cohort details of a specific project by id. requires project and cohort id in the path and a json, form-encoded, or multipart form body. permissions: cohort:write. returns updated cohort data.
</Accordion>

<Accordion title="Update project action with partial data">
  Update an action within a project with a specified id. supports partial updates. accepts json, form-data, and query parameters including 'project id' and 'id'. formats response in csv or json. requires 'action:write' permission.
</Accordion>

<Accordion title="Update project dashboard details">
  Endpoint to update an existing dashboard within a project. provide `project id` and `dashboard id` in path, send json or form data with dashboard details. requires `dashboard:write` permission; responds with updated dashboard data.
</Accordion>

<Accordion title="Trigger project export with format option">
  The `/api/projects/\{project id\}/exports/` endpoint triggers a project export, requiring `project id` and `export format`. it accepts json, form-encoded, and multipart data, responding with a 201 code and export information.
</Accordion>

<Accordion title="Retrieve specific historical plugin export">
  Retrieve historical export data for a specific plugin configuration within a project. requires project, plugin config, and export item ids. auth via personalapikeyauth. no body in 200 response.
</Accordion>

<Accordion title="Update project group type metadata">
  Patch /api/projects/\{project id}/groups types/update metadata: update group type metadata for a specific project using its project id. can modify name singular and name plural fields up to 400 characters each.
</Accordion>

<Accordion title="Update organization details by uuid">
  Update specific details of an organization using its uuid. allows patch requests with json, form data, or multipart. requires `organization:write` permission. returns updated organization info.
</Accordion>

<Accordion title="Update project notebook details">
  The api for interacting with notebooks. this feature is in early access and the api can have breaking changes without announcement.
</Accordion>

<Accordion title="Update project member role by uuid">
  Update a project member's role using their uuid in a specific project. accepts partial data to modify membership details such as role level, provided the member's uuid and project id.
</Accordion>

<Accordion title="Set insight deletion flag">
  Hard delete of this model is not allowed. use a patch api call to set "deleted" to true
</Accordion>

<Accordion title="Retrieve project experiment results">
  Retrieve experiment results within a project by project and experiment id. requires project id and experiment id in the path. returns experiment details in json, with authentication via personalapikeyauth.
</Accordion>

<Accordion title="Update project member s role by uuid">
  Update explicit project membership using uuids. this put endpoint modifies a project member's role, where '1' stands for member and '8' for administrator. requires `project id` and `parent membership  user  uuid`.
</Accordion>

<Accordion title="Retrieve session recording error clusters">
  Retrieve error clusters from session recordings for a specified project. this endpoint provides details on user interactions, console logs, and activity times in json format, requiring the project id in the path.
</Accordion>

<Accordion title="Retrieve properties and events association">
  Allows a caller to provide a list of event names and a single property name returns a map of the event names to a boolean representing whether that property has ever been seen with that event name
</Accordion>

<Accordion title="Retrieve property definition details">
  Retrieve details of a specific property definition by uuid within a project. requires project id and property definition id. security: personalapikeyauth with read access. no response body provided.
</Accordion>

<Accordion title="Update project insight details">
  Endpoint "/api/projects/\{project id}/insights/\{id}/" allows for updating an insight's details for a given project and insight id, supporting json and csv formats, with fields like name, query, and various timestamps. requires insight write permission.
</Accordion>

<Accordion title="Update project pipeline transformation config">
  Update a specific pipeline transformation configuration for a project by providing a `project id` and configuration `id`. this patch request can modify properties like `plugin`, `enabled`, and `order`. authentication via a personal api key is required.
</Accordion>

<Accordion title="Retrieve session recording playlist details">
  Retrieve session recording playlists for a specified project and playlist short id. returns details like name, creator info, and recordings. access by making a get request to `/api/projects/\{project id\}/session recording playlists/\{short id\}/recordings/`.
</Accordion>

<Accordion title="Update project plugin configuration">
  Update project plugin config using its integer id and project string id; accepts json, url-encoded, or form-data. requires authentication; returns the updated config.
</Accordion>

<Accordion title="Update project pipeline destination config">
  Update a project's pipeline destination config by id via patch api request. supports json/form requests, with fields like plugin & order. requires personalapikeyauth.
</Accordion>

<Accordion title="Posthog Retrieve Specific Pipeline Frontend App Config">
  Retrieve the configuration details of a specific pipeline frontend app by providing its unique id and the associated project id. permissions: 'plugin:read'. response includes plugin config info like enabled state and creation timestamp.
</Accordion>

<Accordion title="Update annotation details">
  Create, read, update and delete annotations. [see docs](https://posthog.com/docs/user-guides/annotations) for more information on annotations.
</Accordion>

<Accordion title="Retrieve project person stickiness">
  This endpoint allows for reading and deleting persons. for creations or updates, use the capture api, set/unset properties, or sdks.
</Accordion>

<Accordion title="Retrieve session recording properties by project id">
  Retrieve properties of session recordings for a given project by id, including activity metrics, timestamps, and participant details. requires project id in the path. returns json data with recording details.
</Accordion>

<Accordion title="Retrieve project export details">
  Retrieve detailed info on a specific export of a project using its unique id. requires project id and supports various export formats like png, pdf, csv, and xlsx. auth: personalapikeyauth with export:read scope.
</Accordion>

<Accordion title="Retrieve project funnel correlation insights">
  Retrieve insights about funnel correlations for a specific project by id, offering results in json or csv. supports querying and output formatting, with a focus on fast loading of large datasets.
</Accordion>

<Accordion title="Update early access project feature">
  This patch endpoint updates a specific early access project feature. it requires `project id` and `id` (uuid) as path parameters. the body can include feature details like `name`, `description`, and `stage`. security: `personalapikeyauth`.
</Accordion>

<Accordion title="Retrieve similar session recordings">
  Retrieve similar session recordings for a given session by uuid within a project. details include session activity data, user info, and timestamps. requires `project id` and session `id`.
</Accordion>

<Accordion title="Retrieve specific project dashboard details">
  Retrieve details of a specific dashboard within a project. requires a dashboard id & project id, and returns information such as dashboard properties, owner, and access levels. auth: personalapikeyauth\[dashboard:read].
</Accordion>

<Accordion title="Retrieve project person cohorts">
  This endpoint allows reading and deletion of persons; for creation or updates, use the capture api, `$set`/`$unset` properties, or sdks.
</Accordion>

<Accordion title="Update organization domain info and saml config">
  Update a domain's info for a specific organization by id, including verification status and saml configuration. requires uuid path params and supports json, form-data content types.
</Accordion>

<Accordion title="Retrieve survey details with uuid and project id">
  Retrieve survey details using survey uuid and associated project id. supports secure access with 'personalapikeyauth'. returns survey name, type, linking, targeting flags, creator info, and questions with branching logic descriptions.
</Accordion>

<Accordion title="Retrieve project group details by key and type">
  Retrieves specified group details within a project by group key and type index. requires 'group key', 'group type index', and 'project id'. responds with group details, including creation timestamp.
</Accordion>

<Accordion title="Retrieve specific batch export run details">
  Retrieve details for a specific batch export run within a project by id. requires a uuid for batch export id and run id. provides run status, record count, timestamps, latest error, and intervals. security: personalapikeyauth.
</Accordion>

<Accordion title="Retrieve survey activity logs">
  Retrieve activity logs for specific survey in a project, identified by uuids. requires valid api key with 'activity log:read' permissions. supports json response detailing survey's properties, types, and creator info.
</Accordion>

<Accordion title="Retrieve session recording snapshots">
  Snapshots for a session can be loaded from s3 (if old) or redis (if recent). clients call the api without a source to get supported sources, then per source for snapshots. api v1 is deprecated; clickhouse support removed.
</Accordion>

<Accordion title="Retrieve specific batch export details">
  Retrieve details of a specific batch export for an organization by its uuid. requires a personalapikeyauth with 'batch export:read' permission. responses include export details like name, model, destination, interval, and more.
</Accordion>

<Accordion title="Update project property definition">
  Update a property definition in a project by its uuid. requires a project id and definition id, both as path parameters. security: personalapikeyauth with write access. no body in the response.
</Accordion>

<Accordion title="Update role details in organization">
  Update an organization role by submitting its uuid and organization id in uuid format. role details must be in json or form-data. only users with 'organization:write' can do this. returns updated role data.
</Accordion>

<Accordion title="Update project subscription details">
  Update a subscription for a specific project. provide project id and subscription id in the path and use mime types like application/json with fields like frequency, target type, etc. requires `subscription:write` permission.
</Accordion>

<Accordion title="Update specific proxy record fields">
  Patch `/api/organizations/\{organization id\}/proxy records/\{id\}/`: update specific fields of a proxy record by id within an organization. supports json, form data, and multipart. requires `organization:write` permission. returns updated proxy record.
</Accordion>

<Accordion title="Update project session recording playlist">
  Update an existing session recording playlist for a project with the specified project id and playlist short id. requires json or form data input to modify the playlist's properties like name, description, and status.
</Accordion>

<Accordion title="Update project survey details">
  The `/api/projects/\{project id\}/surveys/\{id\}/` put endpoint updates survey details in a project using survey uuid and project id, accepts json/form/multipart data, needs `survey:write` permission, and returns the updated survey.
</Accordion>

<Accordion title="Update session recording playlist partially">
  Update session recording playlists using patch on the endpoint with `project id` and `short id`. accepts json and forms data for detail amendments. partial updates allowed. `personalapikeyauth` needed.
</Accordion>


# Quickbooks
Source: https://docs.push.ai/integrations/quickbooks



Quickbooks is a cloud-based accounting software that helps you manage your finances, track your income and expenses, and get insights into your business

<Accordion title="Create Customer">
  Create a new customer in quickbooks with the given parameters.
</Accordion>

<Accordion title="Read Customer">
  Read a customer in quickbooks with the given customer id.
</Accordion>

<Accordion title="Customer Balance Report">
  Generate a balance report for a customer in quickbooks with the given customer id.
</Accordion>

<Accordion title="Read Account">
  Read an account in quickbooks with the given account id.
</Accordion>

<Accordion title="Query Account">
  Query an account in quickbooks with the given parameters.
</Accordion>

<Accordion title="Create Employee">
  Create a new employee in quickbooks.
</Accordion>

<Accordion title="Read Vendor">
  Read a vendor in quickbooks with the given vendor id.
</Accordion>

<Accordion title="Read Employee">
  Read an employee's details in quickbooks with the given employee id.
</Accordion>

<Accordion title="Create Vendor">
  Create a new vendor in quickbooks with the given details.
</Accordion>

<Accordion title="Create Account">
  Create a new account in quickbooks with the given parameters.
</Accordion>

<Accordion title="Vendor Balance Detail">
  Generate a balance detail report for a vendor in quickbooks with the given vendor id.
</Accordion>

<Accordion title="Customer Balance Detail">
  Generate a balance detail report for a customer in quickbooks with the given customer id.
</Accordion>

<Accordion title="Vendor Balance Report">
  Get the balance report of a vendor in quickbooks with the given vendor id.
</Accordion>


# Ramp
Source: https://docs.push.ai/integrations/ramp



Ramp is a comprehensive finance platform designed to help you manage
your finances, track your income and expenses, and get insights into
your business. The Ramp API provides developers with the tools to
interact with the platform programmatically.

<Accordion title="Options for Custom Accounting Field">
  Tool for listing options for a given accounting field.
</Accordion>

<Accordion title="Update Accounting Field Option">
  Tool for updating an option for a given accounting field.
</Accordion>

<Accordion title="Fetch Custom Accounting Field">
  Tool for fetching a custom accounting field.
</Accordion>

<Accordion title="Upload New Options for Custom Accounting Field">
  Tool for uploading new options for a given accounting field.
</Accordion>

<Accordion title="Create New Custom Accounting Field">
  Tool for creating a new custom accounting field.
</Accordion>

<Accordion title="Delete Custom Accounting Field">
  Tool for deleting a custom accounting field.
</Accordion>

<Accordion title="Accounting Sync">
  Tool for syncing accounting data.
</Accordion>

<Accordion title="Delete Custom Accounting Field Option">
  Tool for deleting an option for a given accounting field.
</Accordion>


# Recallai
Source: https://docs.push.ai/integrations/recallai



Recall.ai provides a single API for meeting bots on every platform like Zoom, Google Meet, Microsoft Teams and more.

<Accordion title="Delete bot">
  Get list of chat messages read by the bot in the meeting(excluding messages sent by the bot itself).
</Accordion>

<Accordion title="List bots">
  List all bots
</Accordion>

<Accordion title="Remove bot from call">
  Removes the bot from the meeting. this is irreversable.
</Accordion>

<Accordion title="List chat messages">
  Get list of chat messages read by the bot in the meeting(excluding messages sent by the bot itself).
</Accordion>

<Accordion title="Stop recording">
  Instructs the bot to end the current recording.
</Accordion>

<Accordion title="Retrieve bot">
  Get a bot instance.
</Accordion>

<Accordion title="Create bot">
  Create a new bot.
</Accordion>

<Accordion title="Start recording">
  Instructs the bot to start recording the meeting. this will restart the current recording if one is already in progress.
</Accordion>


# Reddit
Source: https://docs.push.ai/integrations/reddit



Connect to Reddit to post and comment.

<Accordion title="Create a Post">
  Submit a new post to a subreddit. note: use reddit get user flair action to get the flair id for the subreddit.
</Accordion>

<Accordion title="Delete Comment">
  Delete a comment.
</Accordion>

<Accordion title="Delete Post">
  Delete a post.
</Accordion>

<Accordion title="Edit Comment">
  Edit an existing comment or self-post.
</Accordion>

<Accordion title="Retrieve Posts from subreddit">
  Fetch top posts in a subreddit with optional size limit.
</Accordion>

<Accordion title="Retrieve Specific Comment or Post">
  Fetch information about a specific comment or post.
</Accordion>

<Accordion title="Create Comment">
  Post a new comment or reply to an existing comment.
</Accordion>

<Accordion title="Get User Flair">
  Get flairs available for a subreddit. this action will be used to create a post.
</Accordion>

<Accordion title="Search across subreddits">
  Search for content across subreddits.
</Accordion>


# Resend
Source: https://docs.push.ai/integrations/resend



Connect to Resend to send emails.

<Accordion title="Create Contact">
  Create a contact in resend.
</Accordion>

<Accordion title="List Domains">
  List all domains.
</Accordion>

<Accordion title="Create Audience">
  Create a list of contacts.
</Accordion>

<Accordion title="Cancel Email">
  Cancel a scheduled email.
</Accordion>

<Accordion title="Delete Audience">
  Remove an existing audience.
</Accordion>

<Accordion title="Create Domain">
  Create a domain through the resend email api.
</Accordion>

<Accordion title="Retrieve Contact">
  Retrieve a contact in resend.
</Accordion>

<Accordion title="Verify Domain">
  Verify a domain through the resend email api.
</Accordion>

<Accordion title="Retrieve Audience">
  Retrieve a single audience.
</Accordion>

<Accordion title="Delete Contact">
  Delete a contact in resend.
</Accordion>

<Accordion title="Retrieve Domain">
  Retrieve a single domain.
</Accordion>

<Accordion title="Delete Domain">
  Delete a domain through the resend email api.
</Accordion>

<Accordion title="Retrieve Email">
  Retrieve a single email.
</Accordion>

<Accordion title="Update Domain">
  Update an existing domain.
</Accordion>

<Accordion title="Send Email">
  Send an email using resend.
</Accordion>

<Accordion title="List Audiences">
  List all audiences.
</Accordion>

<Accordion title="Update Email">
  Update a scheduled email.
</Accordion>

<Accordion title="List Contacts">
  List contacts in resend.
</Accordion>


# Retellai
Source: https://docs.push.ai/integrations/retellai



RetellAI captures calls and transcripts, enabling businesses to analyze conversations, extract insights, and enhance customer interactions in one centralized platform

<Accordion title="Retrieve call details">
  The /v2/list-calls endpoint retrieves call records with filters (agent id, timestamps), offers sorting, pagination, and handles different responses (success, bad request, unauthorized, server error) in json format.
</Accordion>

<Accordion title="Retrieve details of a specific phone number">
  Fetches the details of a given phone number in e.164 format.
</Accordion>

<Accordion title="List all phone numbers">
  Retrieves a list of all phone numbers associated with the account.
</Accordion>

<Accordion title="Delete phone number">
  Deletes an existing phone number identified by its e.164 format.
</Accordion>

<Accordion title="Buy a new phone number  bind agents">
  This endpoint allows purchasing a new phone number with a specified area code and binding it to designated agents for inbound and outbound calls. it requires json with agent ids and area code. responses indicate the creation status or errors.
</Accordion>

<Accordion title="Retrieve call details by id">
  Retrieve call details by id for web/phone calls, including type, agent id, status, timestamps, and web access token; covering responses from success to server errors.
</Accordion>

<Accordion title="Create a new outbound phone call">
  Initiate an outbound call by post to '/v2/create-phone-call'. requires 'from number' and 'to number' in e.164 format. optional overrides and metadata supported. on success, returns call details including type, status, and ids.
</Accordion>

<Accordion title="Retrieve details of a specific voice">
  "access specific voice details including its name, provider, accent, gender, and a preview audio url using the unique voice id. parameters required."
</Accordion>

<Accordion title="Update phone number">
  Updates the agent bound to a purchased phone number.
</Accordion>

<Accordion title="Create a new web call">
  The /v2/create-web-call endpoint creates a web call with a unique agent id, returning call details like type, token, call id, and status in json format, with a 201 response. optional metadata and variables can be included.
</Accordion>


# Rocketlane
Source: https://docs.push.ai/integrations/rocketlane



Rocketlane specializes in customer onboarding and project delivery, providing shared workspaces, milestones, and status tracking to streamline implementations

<Accordion title="Retrieve home endpoint">
  Retrieves the home page or dashboard data for the authenticated user in the rocketlane application. this endpoint provides an overview of the user's current projects, tasks, and important notifications related to client onboarding and project management. it's typically used when a user first logs in or navigates to the home screen of the rocketlane platform. the response likely includes a summary of ongoing projects, upcoming deadlines, recent activities, and key performance indicators relevant to the user's role. this endpoint does not accept any parameters and returns a standardized set of information tailored to the authenticated user's profile and permissions.
</Accordion>

<Accordion title="Rocketlane Retrieve Tasks For Project">
  Retrieves a list of tasks associated with a specific project in rocketlane. this endpoint is crucial for project managers and team members to get an overview of all tasks within a particular project, supporting efficient project management and client onboarding processes. it should be used when you need to fetch the complete task list for a given project, such as for progress tracking, task assignment, or reporting purposes. the endpoint focuses solely on task retrieval and does not provide functionalities for task creation, updating, or deletion. keep in mind that the response may include all tasks regardless of their status (e.g., pending, in progress, completed), so additional filtering might be necessary client-side depending on specific requirements.
</Accordion>

<Accordion title="Get Project List">
  Retrieves a list of projects from rocketlane.
</Accordion>

<Accordion title="Retrieve subscription details">
  Retrieves detailed information about the current subscription associated with the authenticated user or organization in rocketlane. this endpoint provides essential data related to the subscription plan, including the current plan type, billing cycle, usage limits, and subscription status. it should be used when you need to access up-to-date subscription information for account management, billing inquiries, or to determine the features and limitations of the current plan. the endpoint does not allow for modifying subscription details; it is strictly for retrieval purposes. note that the specific fields returned may vary based on the subscription type and the user's access level within the organization.
</Accordion>

<Accordion title="Retrieve project details by id">
  Retrieves detailed information about a specific project in rocketlane. this endpoint allows users to fetch comprehensive data related to a project, including its settings, status, and other relevant details essential for project management and client onboarding. it should be used when detailed information about a particular project is needed, such as during project review, updates, or when syncing project data with other systems. the endpoint returns a complete snapshot of the project's current state but does not provide historical data or real-time updates.
</Accordion>

<Accordion title="Create task with assignee and dates">
  Creates a new task within a specified project in rocketlane. this endpoint allows project managers or team members to add detailed tasks to their project workflow, including task information, assignments, and deadlines. use this when you need to create a new actionable item within a project, assign responsibilities, and set timelines. the endpoint is crucial for maintaining an organized and transparent project management process, enabling effective collaboration and progress tracking in rocketlane's client onboarding and project management platform.
</Accordion>


# Rootly
Source: https://docs.push.ai/integrations/rootly



Template description for rootly

<Accordion title="Delete Action Item">
  This tool allows for the deletion of a specific action item in rootly. it complements the existing rootly list action items functionality by providing the ability to remove individual action items from the system.
</Accordion>

<Accordion title="Get Action Item Details">
  This tool retrieves a single action item by its id from rootly using a get request to [https://api.rootly.com/v1/action](https://api.rootly.com/v1/action) items/\{id}. it provides detailed information about an action item including summary, description, kind, assigned to, priority, status, due date, and more. it complements other action item management tools.
</Accordion>

<Accordion title="List Action Items">
  This tool retrieves a list of all action items for an organization in rootly. action items are tasks or follow-up items that need to be completed during or after an incident, helping to track and manage incident-related tasks effectively.
</Accordion>


# Salesforce
Source: https://docs.push.ai/integrations/salesforce



Salesforce is a leading CRM platform integrating sales, service, marketing, and analytics to build customer relationships and drive business growth

<Accordion title="Create campaign record via post">
  Create a new campaign record by posting json data to '/sobjects/campaign'. must include 'content-type' header. possible responses include success (201) and various errors like 400, 401, 403, 404, 405, 415, 500, 503 with descriptive info.
</Accordion>

<Accordion title="Fetch account details by id with conditional queries">
  Retrieve account details by id, with optional fields and conditional headers. responds with account data or error statuses. supports if-modified/unmodified for data freshness.
</Accordion>

<Accordion title="Fetch modified or unmodified sobjects">
  Retrieve a list of modified sobjects by using "if-modified-since" header or unmodified with "if-unmodified-since". supports common response codes like 200, 304, and error codes 400, 401, 403, 404, 405, 412, 500, 503.
</Accordion>

<Accordion title="Create note record with content type header">
  Create a note record by posting json data to `/sobjects/note`. requires `content-type` header and handles various http statuses (201, 400, 401, 403, 404, 500, 405, 503, 415) signaling success or different error scenarios.
</Accordion>

<Accordion title="Delete a lead object by its id">
  Delete a lead object by id. errors handled for missing auth, access rights, nonexistent object, and server issues. returns no content on success (204). required: `id` path parameter.
</Accordion>

<Accordion title="Create lead with specified content type">
  Create a new lead via post, specifying content type in the header. accepts a json lead object. possible response status codes include 201 (created), 400, 401, 403, 404, 405, 415, 500, 503, along with corresponding error info.
</Accordion>

<Accordion title="Account creation with content type option">
  Endpoint for creating accounts via post; accepts json with 'content-type' header. status codes: 201 (created), 400, 401, 403-405, 415, 500, 503.
</Accordion>

<Accordion title="Remove account by unique identifier">
  Delete /sobjects/account/\{id}: removes an account using a unique identifier. requires the 'id' path parameter. possible responses include 400, 401, 403, 404, 500, 405, 503 (errors) and 204 (success).
</Accordion>

<Accordion title="Create new contact with json header">
  The post /sobjects/contact endpoint creates a new contact using json; it requires a content-type header. success and error responses range from status codes 201 to 503.
</Accordion>

<Accordion title="Remove a specific contact by id">
  Delete a contact object by id. handles errors: bad request (400), unauthorized (401), forbidden (403), not found (404), internal server error (500), method not allowed (405), service unavailable (503), and unsupported media type (415).
</Accordion>

<Accordion title="Retrieve account data and error responses">
  Retrieve account data with response codes for success and various errors (not modified, bad request, unauthorized, forbidden, not found, method not allowed, server error, service unavailable). returns sobjectrootinfo on success.
</Accordion>

<Accordion title="Remove note object by id">
  Delete a note object by id. supports error handling for common http response statuses including 400, 401, 403, 404, 500, 405, 503, and 415; 204 for success. required parameter: 'id' in path.
</Accordion>

<Accordion title="Remove opportunity by id">
  Delete an opportunity object using its unique id, handling responses for success and common http errors like bad request, unauthorized access, forbidden, not found, and server errors.
</Accordion>

<Accordion title="Remove campaign object by id">
  Delete `/sobjects/campaign/\{id\}`: removes a campaign object given an `id`. responds with 204 on success or returns error codes 400, 401, 403, 404, 405, 415, 500, 503 with details if any issues arise. the `id` path parameter is required.
</Accordion>

<Accordion title="Retrieve campaign data with error handling">
  Get /sobjects/campaign: retrieves campaign data with responses for success and various errors like missing authorization, not found, and server issues.
</Accordion>

<Accordion title="Retrieve contact info with standard responses">
  Get /sobjects/contact: retrieves contact info with standard response codes, including successful fetch (200) and various errors (304, 400, 401, 403, 404, 405, 412, 500, 503). json format expected.
</Accordion>

<Accordion title="Create opportunity record">
  Create 'opportunity' records with required 'content type' header (json/xml). successfully created records return a 201 status code. errors trigger status codes 400, 401, 403, 404, 405, 415, 500, or 503 with details. ensure fields used are available based on the organization's salesforce configuration.
</Accordion>

<Accordion title="Query Report">
  Post returns report data without saving changes to an existing report or creating a new one.
</Accordion>

<Accordion title="Retrieve specific campaign object details">
  Retrieve details of a specific campaign object using its id. optional query/header params allow for field selection and date-based filtering. expect standard http response codes, such as 200 ok or 404 not found, for outcomes.
</Accordion>

<Accordion title="Retrieve lead data with various responses">
  Retrieve lead data with potential responses: 200 (success), 304 (not modified), 400 (bad request), 401 (unauthorized), 403 (forbidden), 404 (not found), 405 (method not allowed), 412 (precondition failed), 500 (server error), 503 (service unavailable).
</Accordion>

<Accordion title="Retrieve note by id with optional fields and time conditions">
  Retrieve a specific note object by id with optional field selection and conditional retrieval based on modification time. supports standard http response codes to indicate success or issues with the request.
</Accordion>

<Accordion title="Retrieve lead details by id with conditional support">
  Retrieve details of a lead by id, with optional field selection and conditional retrieval based on modification dates. supports responses for success, various client or server errors, and change detection statuses.
</Accordion>

<Accordion title="Retrieve opportunities data">
  Retrieve opportunities data. supports http 200 for success; errors return 304, 400, 401, 403, 404, 405, 412, 500, or 503 statuses with respective descriptions. response in json.
</Accordion>

<Accordion title="Update account object by id">
  Patch endpoint '/sobjects/account/\{id}' updates an account object by its id, using 'application/json'. requires 'content-type' header and may return status codes 400, 401, 403, 404, 500, 405, 503, 204, or 415.
</Accordion>

<Accordion title="Retrieve opportunity by id with optional fields">
  Retrieve opportunity details by id using get. optional fields and modified-since query supported. responses range from 200 (ok) to 503 (service unavailable), including various client/server errors.
</Accordion>

<Accordion title="Update specific note by id">
  Patch /sobjects/note/\{id}: update a specific note object using its id. requires 'content-type' header and json body with the note's new content. responses: 204 on success, 400-415, 500, or 503 for errors.
</Accordion>

<Accordion title="Update opportunity by id">
  This patch endpoint allows updates to an existing opportunity object by id, accepts json payloads, and supports multiple response statuses, including 400, 401, 403, 404, 500, 405, 503, 204, and 415, indicating various error conditions or success.
</Accordion>

<Accordion title="Retrieve note object information">
  Access notes with `/sobjects/note`. possible responses range from 200 (ok) to 503 (service unavailable) and return json data.
</Accordion>

<Accordion title="Retrieve specific contact by id">
  This endpoint retrieves a specific contact by id. it supports optional field selection and conditional retrieval based on modification timestamp. responses cover a range of http status codes from success to various client and server errors.
</Accordion>

<Accordion title="Update lead by id with json payload">
  Patch endpoint updates lead by id with json body per leadsobject schema, needs content-type header; responses vary from 204 to error codes 400, 401, 403, 404, 415, 500, 503 with error info.
</Accordion>

<Accordion title="Update campaign by id with json">
  Update a campaign object by id with json support. requires 'id' path parameter and 'content-type' header. potential responses: 200 ok, 400, 401, 403, 404, 405, 415, 500, 503 errors, and 204 no content.
</Accordion>

<Accordion title="Update contact by id">
  Patch /sobjects/contact/\{id}: update specified contact using its id. requires 'content-type' header and json request body. possible responses: 204 (success), 400, 401, 403, 404, 405, 415, 500, 503 (errors).
</Accordion>


# Semanticscholar
Source: https://docs.push.ai/integrations/semanticscholar



Semantic Scholar is an AI-powered academic search engine that helps researchers discover and understand scientific literature

<Accordion title="Details about a paper s authors">
  Retrieves the list of authors for a specific paper identified by its unique paper id in the semantic scholar database. this endpoint is useful when you need detailed information about the contributors to a particular academic publication. it provides access to the author data associated with the paper, which may include names, affiliations, and potentially other metadata. this tool should be used when users require author information for a known paper, such as when exploring collaborations or tracking an author's body of work. it does not provide the full paper content or other paper metadata beyond author information.
</Accordion>

<Accordion title="Details about a paper">
  Examples: \<ul> \<li>\<code>[https://api.semanticscholar.org/graph/v1/paper/649def34f8be52c8b66281af98ae884c09aef38b\&lt;/code\&gt;\&lt;/li](https://api.semanticscholar.org/graph/v1/paper/649def34f8be52c8b66281af98ae884c09aef38b\&lt;/code\&gt;\&lt;/li)> \<ul> \<li>returns a paper with its paperid and title. \</li> \</ul> \<li>\<code>[https://api.semanticscholar.org/graph/v1/paper/649def34f8be52c8b66281af98ae884c09aef38b?fields=url,year,authors\&lt;/code\&gt;\&lt;/li](https://api.semanticscholar.org/graph/v1/paper/649def34f8be52c8b66281af98ae884c09aef38b?fields=url,year,authors\&lt;/code\&gt;\&lt;/li)> \<ul> \<li>returns the paper's paperid, url, year, and list of authors. \</li> \<li>each author has authorid and name.\</li> \</ul> \<li>\<code>[https://api.semanticscholar.org/graph/v1/paper/649def34f8be52c8b66281af98ae884c09aef38b?fields=citations.authors\&lt;/code\&gt;\&lt;/li](https://api.semanticscholar.org/graph/v1/paper/649def34f8be52c8b66281af98ae884c09aef38b?fields=citations.authors\&lt;/code\&gt;\&lt;/li)> \<ul> \<li>returns the paper's paperid and list of citations. \</li> \<li>each citation has its paperid plus its list of authors.\</li> \<li>each author has their 2 always included fields of authorid and name.\</li> \</ul>

  limitations: \<ul> \<li>can only return up to 10 mb of data at a time.\</li> \</ul> \</ul>
</Accordion>

<Accordion title="Text snippet search">
  Return the text snippets that most closely match the query. text snippets are excerpts of approximately 500 words, drawn from a paper's title, abstract, and body text, but excluding figure captions and the bibliography. it will return the highest ranked snippet first, as well as some basic data about the paper it was found in. examples: \<ul> \<li>\<code>[https://api.semanticscholar.org/graph/v1/snippet/search?query=the](https://api.semanticscholar.org/graph/v1/snippet/search?query=the) literature graph is a property graph with directed edges\&limit=1\</code>\</li> \<ul> \<li>returns a single snippet that is the highest ranked match.\</li> \<li>each snippet has text, snippetkind, section, annotation data, and score. as well as the following data about the paper it comes from: corpusid, title, authors, and openaccessinfo.\</li> \</ul> \</ul>

  limitations: \<ul> \<li>you must include a query.\</li> \<li>if you don't set a limit, it will automatically return 10 results.\</li> \<li>the max limit allowed is 1000.\</li> \</ul> \</ul>
</Accordion>

<Accordion title="Details about a paper s citations">
  Retrieves a list of citations for a specific academic paper using its unique semantic scholar paper id. this endpoint is useful for researchers and developers who want to explore the impact and connections of a particular academic work within the broader scientific literature. it provides information about other papers that have cited the specified paper, allowing users to trace the influence of research and discover related works. the endpoint should be used when analyzing the reception and impact of a specific paper, building citation networks, or conducting bibliometric studies. it does not provide the full text of citing papers or detailed information about the citations beyond basic metadata.
</Accordion>

<Accordion title="Details about a paper s references">
  Retrieves the list of references cited by a specific paper in the semantic scholar database. this endpoint allows users to explore the scholarly context of a publication by accessing its bibliography. it's particularly useful for understanding the foundation of a paper's research, tracing the development of ideas, or conducting literature reviews. the tool returns details about the cited papers, which may include their titles, authors, publication dates, and semantic scholar ids. it should be used when analyzing a paper's sources or investigating the connections between different academic works. note that this endpoint only provides outgoing references (papers cited by the specified paper) and not incoming citations (papers that cite the specified paper).
</Accordion>

<Accordion title="Get details for multiple authors at once">
  Retrieves detailed information for multiple authors from semantic scholar in a single api call. this endpoint allows users to efficiently fetch data for a batch of authors by providing their unique semantic scholar ids. it's particularly useful for applications that need to gather information on multiple authors simultaneously, reducing the number of individual api calls required. the endpoint accepts a list of author ids and returns comprehensive details for each author, which may include their publications, citations, and other relevant academic information. while the exact response structure is not specified in the given schema, users can expect rich metadata about the requested authors.
</Accordion>

<Accordion title="Details about an author">
  Examples: \<ul> \<li>\<code>[https://api.semanticscholar.org/graph/v1/author/1741101\&lt;/code\&gt;\&lt;/li](https://api.semanticscholar.org/graph/v1/author/1741101\&lt;/code\&gt;\&lt;/li)> \<ul> \<li>returns the author's authorid and name.\</li> \</ul> \<li>\<code>[https://api.semanticscholar.org/graph/v1/author/1741101?fields=url,papers\&lt;/code\&gt;\&lt;/li](https://api.semanticscholar.org/graph/v1/author/1741101?fields=url,papers\&lt;/code\&gt;\&lt;/li)> \<ul> \<li>returns the author's authorid, url, and list of papers. \</li> \<li>each paper has its paperid plus its title.\</li> \</ul> \<li>\<code>[https://api.semanticscholar.org/graph/v1/author/1741101?fields=url,papers.abstract,papers.authors\&lt;/code\&gt;\&lt;/li](https://api.semanticscholar.org/graph/v1/author/1741101?fields=url,papers.abstract,papers.authors\&lt;/code\&gt;\&lt;/li)> \<ul> \<li>returns the author's authorid, url, and list of papers. \</li> \<li>each paper has its paperid, abstract, and list of authors.\</li> \<li>in that list of authors, each author has their authorid and name.\</li> \</ul>

  limitations: \<ul> \<li>can only return up to 10 mb of data at a time.\</li> \</ul> \</ul>
</Accordion>

<Accordion title="Details about an author s papers">
  Retrieves a list of papers authored by a specific researcher identified by their unique semantic scholar author id. this endpoint is particularly useful for conducting literature reviews, analyzing an author's body of work, or tracking a researcher's publications over time. it provides a comprehensive view of an author's contributions to their field of study. the endpoint returns only the papers associated with the specified author and does not include co-authored works where the specified author is not listed as a primary author. note that the response may be paginated for authors with a large number of publications, and additional api calls might be necessary to retrieve the complete list of papers.
</Accordion>

<Accordion title="Get details for multiple papers at once">
  The semanticscholar paper batch endpoint allows users to retrieve data for multiple academic papers in a single api call. this endpoint is particularly useful when you need to fetch information for a batch of papers efficiently, reducing the number of individual api requests. it accepts an array of paper ids and returns the corresponding data for each paper. use this endpoint when you have a list of known paper ids and want to retrieve their details simultaneously. keep in mind that while there's no specified limit on the number of ids you can send, very large batches may be subject to api rate limiting or response size restrictions.
</Accordion>

<Accordion title="Paper bulk search">
  Behaves similarly to \<code>/paper/search\</code>, but is intended for bulk retrieval of basic paper data without search relevance: \<ul> \<li>text query is optional and supports boolean logic for document matching.\</li> \<li>papers can be filtered using various criteria.\</li> \<li>up to 1,000 papers will be returned in each call.\</li> \<li>if there are more matching papers, a continuation "token" will be present.\</li> \<li>the query can be repeated with the token param added to efficiently continue fetching matching papers.\</li> \</ul>

  returns a structure with an estimated total matches, batch of matching papers, and a continuation token if more results are available.

  limitations: \<ul> \<li>nested paper data, such as citations, references, etc, is not available via this method.\</li> \<li>up to 10,000,000 papers can be fetched via this method. for larger needs, please use the \<a href="datasets/">datasets api\</a> to retrieve full copies of the corpus.\</li> \</ul>
</Accordion>

<Accordion title="Search for authors by name">
  The authorsearch endpoint allows users to search for authors within the semantic scholar database. it provides a way to find academic authors based on their names or other identifying information. this endpoint is particularly useful when you need to retrieve author metadata, such as their publications, affiliations, or research areas. the search functionality supports partial name matches and is case-insensitive, making it flexible for various search scenarios. use this endpoint when you want to discover authors or verify author information in the context of academic research. note that the search results may be limited and paginated, so multiple requests might be necessary for comprehensive results.
</Accordion>

<Accordion title="Suggest paper query completions">
  To support interactive query-completion, return minimal information about papers matching a partial query example: \<code>[https://api.semanticscholar.org/graph/v1/paper/autocomplete?query=semanti\&lt;/code](https://api.semanticscholar.org/graph/v1/paper/autocomplete?query=semanti\&lt;/code)>
</Accordion>

<Accordion title="Paper title search">
  Behaves similarly to \<code>/paper/search\</code>, but is intended for retrieval of a single paper based on closest title match to given query. examples: \<ul> \<li>\<code>[https://api.semanticscholar.org/graph/v1/paper/search/match?query=construction](https://api.semanticscholar.org/graph/v1/paper/search/match?query=construction) of the literature graph in semantic scholar\</code>\</li> \<ul> \<li>returns a single paper that is the closest title match.\</li> \<li>each paper has its paperid, title, and matchscore as well as any other requested fields.\</li> \</ul> \<li>\<code>[https://api.semanticscholar.org/graph/v1/paper/search/match?query=totalgarbagenonsense\&lt;/code\&gt;\&lt;/li](https://api.semanticscholar.org/graph/v1/paper/search/match?query=totalgarbagenonsense\&lt;/code\&gt;\&lt;/li)> \<ul> \<li>returns with a 404 error and a "title match not found" message.\</li> \</ul> \</ul>

  limitations: \<ul> \<li>will only return the single highest match result.\</li> \</ul> \</ul>
</Accordion>

<Accordion title="Paper relevance search">
  The searchpapers endpoint allows users to search for academic papers within the semantic scholar database. it provides a powerful way to discover relevant scientific literature based on user-defined search criteria. this endpoint should be used when researchers, students, or developers need to find papers related to specific topics, authors, or time periods. the search functionality supports various query parameters to refine and customize the search results, making it suitable for both broad exploratory searches and targeted inquiries. however, users should be aware that the search is limited to papers indexed by semantic scholar, and very recent publications might not be immediately available. the endpoint returns a list of papers matching the search criteria, along with selected metadata fields, facilitating efficient literature review and analysis.
</Accordion>


# Semrush
Source: https://docs.push.ai/integrations/semrush



Semrush is a popular SEO tool suite that specializes in keyword research, competitor analysis, and Google Ad campaign optimization.

<Accordion title="Categories profile">
  This report returns a list of categories that the referring domains of the queried domain belong to. when you run a query for a domain, in each line, you get a category and the number of domains in that category with at least one link pointing to the queried domain. the results are sorted by the number of referring domains in descending order. this report is generated based on the first 10,000 referring domains for the queried domain.
</Accordion>

<Accordion title="Domain paid search keywords">
  This report lists keywords that bring users to a domain via google's paid search results.
</Accordion>

<Accordion title="Historical data">
  This report returns only monthly historical trends of multiple backlinks and referring domains for the queried domain. when you run a query for a domain, in return, in each line, you receive a date (unix timestamp) and the number of backlinks and referring domains the queried domain had at that time. results are sorted by date from the most recent to the oldest.
</Accordion>

<Accordion title="Indexed pages">
  This report shows indexed pages of the queried domain.
</Accordion>

<Accordion title="Domain vs domain">
  This report allows users to compare up to five domains by common keywords, unique keywords, all keywords, or search terms that are unique to the first domain.
</Accordion>

<Accordion title="Paid results">
  This report lists domains ranking in google's paid search results with a requested keyword.
</Accordion>

<Accordion title="Phrase questions">
  The report lists phrase questions relevant to a queried term in a chosen database.
</Accordion>

<Accordion title="Keywords ads history">
  This report shows domains that have bid on a requested keyword in the last 12 months and their positions in paid search results.
</Accordion>

<Accordion title="Tld distribution">
  This report shows the referring domain distribution depending on the top-level domain (tld) type.
</Accordion>

<Accordion title="Related keywords">
  This report provides an extended list of related keywords, synonyms, and variations relevant to a queried term in a chosen database.
</Accordion>

<Accordion title="Keyword difficulty">
  This report provides keyword difficulty, an index that helps to estimate how difficult it would be to seize competitors' positions in organic search within google's top 10 with a queried search term.
</Accordion>

<Accordion title="Semrush Competitors">
  This report shows indexed pages of the queried domain.
</Accordion>

<Accordion title="Keyword overview all databases">
  This report provides a keyword summary, including its volume, cpc, competition level, and the number of results in all regional databases.
</Accordion>

<Accordion title="Competitors in organic search">
  This report lists a domain's competitors in organic search results.
</Accordion>

<Accordion title="Domain pla search keywords">
  Retrieves pla search keywords data for a given target domain from semrush's api. this endpoint provides detailed information about the pla search keywords for the specified target. it is useful for ppc analysis and understanding the performance of a domain in pla search engine results.
</Accordion>

<Accordion title="Keyword overview one database">
  This report provides a keyword summary, including its volume, cpc, competition level, and the number of results in a chosen regional database.
</Accordion>

<Accordion title="Competitors in paid search">
  This report lists a domain's competitors in paid search results.
</Accordion>

<Accordion title="Ads copies">
  This report shows unique ad copies semrush noticed when the domain ranked in google's paid search results for keywords from our databases.
</Accordion>

<Accordion title="Pla competitors">
  This report lists domains the requested domain is competing against in google's paid search results with product listing ads (pla).
</Accordion>

<Accordion title="Organic results">
  This report lists domains ranking in google's top 100 organic search results with a requested keyword.
</Accordion>

<Accordion title="Domain ad history">
  This report shows keywords a domain has bid on in the last 12 months and its positions in paid search results.
</Accordion>

<Accordion title="Referring domains by country">
  This report shows the referring domain distribution by country. the ip address of a domain is used to define a country.
</Accordion>

<Accordion title="Authority score profile">
  This report returns the distribution of referring domains by authority score. when you run a query for a domain, in return, for each authority score value from 0 to 100, you receive a number of domains with at least one link pointing to the queried domain.
</Accordion>

<Accordion title="Semrush Anchors">
  This report lists anchor texts used in backlinks leading to the queried domain, root domain, or url. it also includes the number of backlinks and referring domains per anchor.
</Accordion>

<Accordion title="Referring i ps">
  This report lists ip addresses where backlinks to a domain, root domain, or url are coming from.
</Accordion>

<Accordion title="Referring domains">
  This report lists domains pointing to the queried domain, root domain, or url.
</Accordion>

<Accordion title="Domain organic pages">
  This report shows unique pages of the analyzed domain ranking in google's top 100 organic search results.
</Accordion>

<Accordion title="Domain organic search keywords">
  This report lists keywords that bring users to a domain via google's top 100 organic search results. you can get monthly rankings from as far back as 2012–2016, depending on the database, or daily rankings for the last 31 days (with display daily).
</Accordion>

<Accordion title="Batch keyword overview">
  This report provides a summary of up to 100 keywords, including their volume, cpc, competition level, and the number of results in a chosen regional database.
</Accordion>

<Accordion title="Backlinks overview">
  This report provides a summary of backlinks, including their type, referring domains, and ip addresses for a domain, root domain, or url.
</Accordion>

<Accordion title="Semrush Backlinks">
  This report lists backlinks for a domain, root domain, or url.
</Accordion>

<Accordion title="Domain organic subdomains">
  This report shows subdomains of the analyzed domain ranking in google's top 100 organic search results.
</Accordion>

<Accordion title="Batch comparison">
  Compare your backlink profile and link-building progress with those of your competitors.
</Accordion>

<Accordion title="Pla copies">
  This report shows product listing ad (pla) copies semrush noticed when the domain ranked in google's paid search results for keywords from our databases.
</Accordion>

<Accordion title="Broad match keyword">
  The report lists broad matches and alternate search queries, including particular keywords or keyword expressions.
</Accordion>

<Accordion title="Semrush Categories">
  This report returns a list of categories that the queried domain belongs to. when you run a query for a domain, in each line, you get a category and a rating. the rating reflects the level of confidence that this domain belongs to this category (ranging from 0 to 1). the results are sorted by the rating.
</Accordion>


# Sendgrid
Source: https://docs.push.ai/integrations/sendgrid



SendGrid is a cloud-based email delivery platform providing transactional and marketing email services, with APIs for integration, analytics, and scalability

<Accordion title="Activate a transactional template version">
  **this endpoint allows you to activate a version of one of your templates.**
</Accordion>

<Accordion title="Add an ip to an authenticated domain">
  **this endpoint allows you to add an ip address to an authenticated domain.**
</Accordion>

<Accordion title="Add a batch of ips to an ip pool">
  This operation appends a batch of ips to an ip pool. this operation requires all ip assignments to succeed. if any ip assignments fail, this endpoint will return an error.
</Accordion>

<Accordion title="Add an ip address to a pool">
  Add an ip address to a pool with this endpoint. activation in sendgrid needed first. it takes up to 60 seconds. possible to add to multiple pools. retrieve ips via a specific endpoint.
</Accordion>

<Accordion title="Add a single recipient to a list">
  **this endpoint allows you to add a single recipient to a list.**
</Accordion>

<Accordion title="Add ips">
  **this endpoint is for adding a(n) ip address(es) to your account.**
</Accordion>

<Accordion title="Approve access request">
  **this endpoint allows you to approve an access attempt.** **note:** only teammate admins may approve another teammate’s access request.
</Accordion>

<Accordion title="Add a twilio sendgrid ip address">
  This operation adds a twilio sendgrid ip address to your account. you can also assign up to 100 subusers to the ip address at creation.
</Accordion>

<Accordion title="Add suppressions to a suppression group">
  **this endpoint allows you to add email addresses to an unsubscribe group.** if you attempt to add suppressions to a group that has been deleted or does not exist, the suppressions will be added to the global suppressions list.
</Accordion>

<Accordion title="Add one or more ips to the allow list">
  This endpoint adds allowed ip addresses to a list, which then assigns each ip an id for future removal; ids can be retrieved via a specific retrieval endpoint.
</Accordion>

<Accordion title="Assign a batch of subusers to an ip">
  This operation appends a batch of subusers to a specified ip address. this endpoint requires all subuser assignments to succeed. if a subuser assignment fails, this endpoint will return an error.
</Accordion>

<Accordion title="Associate a branded link with a subuser">
  Parent accounts can create and validate branded links, then assign them to subusers through the api or twilio sendgrid app, enabling subusers to use the branded links for mail.
</Accordion>

<Accordion title="Authenticate an account with single sign on">
  Authenticates and logs in a user to twilio sendgrid as a specific admin identity configured for sso by partner. any additional teammates or subusers will need to log in directly via app.sendgrid.com
</Accordion>

<Accordion title="Associate an authenticated domain with a given user">
  Associate authenticated domains with subusers under a parent account to enable email sending using the parent's domain. authentication by the parent is required. multiple domains can be linked using the specified endpoint.
</Accordion>

<Accordion title="Add or update a contact">
  The endpoint can handle 30k contacts or 6mb, reports queuing/errors, needs extra steps to confirm changes and retrieve ids. custom fields must pre-exist and exact identifiers are required for updates; email addresses are auto-lowered in case.
</Accordion>

<Accordion title="Authenticate a domain">
  The endpoint enables domain authentication for users or subusers, offering two methods—'username' parameter for visibility and modification, or the association workflow for a fixed, non-editable domain assignment.
</Accordion>

<Accordion title="Add recipient addresses to the global suppression group">
  **this endpoint allows you to add one or more email addresses to the global suppressions group.**
</Accordion>

<Accordion title="Cancel or pause a scheduled send">
  This api endpoint allows users to cancel or pause a scheduled email by providing its `batch id`. to change or remove this status, specific endpoints must be used; exceeding limits or duplicating actions will trigger a `400` error.
</Accordion>

<Accordion title="Bulk delete single sends">
  This api endpoint enables the deletion of multiple single sends by providing their ids. retrieve ids with a get request to `/marketing/singlensends`. deletions are irreversible.
</Accordion>

<Accordion title="Bind authenticated domains to user">
  This endpoint enables linking up to five authenticated domains from a parent account to a subuser, giving them permission to send emails with the parent's domain. domains are prioritized when sending emails.
</Accordion>

<Accordion title="Create an ip pool">
  Create an ip pool by activating an ip in sendgrid: log in, go to settings > ip addresses, edit selected ip, check to allow sending, and save.
</Accordion>

<Accordion title="Create an ip pool with a name and ip assignments">
  Creating an ip pool associates specified ips with it. all ips must be successfully assigned, or creation fails with an error. a pool can have up to 100 ips.
</Accordion>

<Accordion title="Create an sso certificate">
  **this endpoint allows you to create an sso certificate.**
</Accordion>

<Accordion title="Create a batch id">
  Create a new mail batch id to group email sends, allowing pause or cancel actions via the scheduled sends api.
</Accordion>

<Accordion title="Create an sso integration">
  **this endpoint allows you to create an sso integration.**
</Accordion>

<Accordion title="Completed steps">
  This api endpoint checks if a sendgrid account has completed domain authentication (`domain verified`) and single sender verification (`sender verified`), returning boolean values for each.
</Accordion>

<Accordion title="Create an account">
  Creates a new account, with specified offering, under the organization.
</Accordion>

<Accordion title="Create a campaign">
  This endpoint enables campaign creation, requiring a subject, sender id, content (html and text suggested), and a list or segment id for sending or scheduling, but not for initial creation.
</Accordion>

<Accordion title="Create a list">
  **this endpoint allows you to create a list for your recipients.**
</Accordion>

<Accordion title="Create a branded link">
  Create a new branded link by specifying the root domain, which must align with your from email, and an optional unique subdomain. subusers can request using the `on-behalf-of` header.
</Accordion>

<Accordion title="Create a custom field">
  **this endpoint allows you to create a custom field.** **you can create up to 120 custom fields.**
</Accordion>

<Accordion title="Create api keys">
  Use sendgrid app to create an initial api key; then manage others via api. json with 'name' required; 100 key limit. keys have unique ids, default 'full access' unless scopes specified. update scopes with 'update api keys' endpoint.
</Accordion>

<Accordion title="Create an sso teammate">
  Create an sso teammate with email as username. assign roles using `is admin`, `scopes`, or `persona`. admins have full rights, personas have predefined permissions, and scopes are specific rights. teammates can manage subusers with potential limitations.
</Accordion>

<Accordion title="Create a new alert">
  **this endpoint allows you to create a new alert.**
</Accordion>

<Accordion title="Create a new suppression group">
  **this endpoint allows you to create a new suppression group.** to add an email address to the suppression group, [create a suppression](https://docs.sendgrid.com/api-reference/suppressions-suppressions/add-suppressions-to-a-suppression-group).
</Accordion>

<Accordion title="Create a new event webhook">
  Set up an event webhook by providing a url, choosing events for post requests, and receive a unique id. after creation, you can add names, oauth, and signature verification.
</Accordion>

<Accordion title="Create a segment">
  New segment endpoint created: supports various operators for date, text, number, and email fields. values must be strings, can specify campaign for email actions. conditions combinable via "and"/"or".
</Accordion>

<Accordion title="Create a new transactional template version">
  **this endpoint allows you to create a new version of a template.**
</Accordion>

<Accordion title="Sendgrid Create Integration">
  This endpoint creates an integration for email event forwarding. each integration has a maximum number of allowed integration instances per user. for example, users can create up to 10 segment integrations.
</Accordion>

<Accordion title="Create a sender identity">
  **this endpoint allows you to create a new sender identity.** you may create up to 100 unique sender identities.
</Accordion>

<Accordion title="Create design">
  Create new designs via `/designs` by submitting html content. consider email client limitations and see the guide for best practices. convert html to editable modules in the design library, or use preferred tools/migrate existing designs.
</Accordion>

<Accordion title="Create a parse setting">
  Create a new inbound parse setting with a twilio sendgrid authenticated `hostname` and a public `url` to receive parsed messages via http post. complete domain authentication and mx record setup as instructed in sendgrid documentation.
</Accordion>

<Accordion title="Create a transactional template">
  **this endpoint allows you to create a transactional template.**
</Accordion>

<Accordion title="Delete an account">
  To delete an organization's account by id: it revokes api keys/sso, removes sendgrid resources like dedicated ips, and stops billing immediately. this action is irreversible.
</Accordion>

<Accordion title="Delete ip pool">
  This operation deletes an ip pool and unassigns all ip addresses associated with the pool. ip addresses associated with the deleted pool will remain in your account.
</Accordion>

<Accordion title="Delete a single event webhook by id">
  Delete a specific event webhook by id with this endpoint. unlike other endpoints which default to the oldest webhook, this requires an id, else it errors to prevent accidental deletions. to disable, not delete, use `enabled` property to `false`.
</Accordion>

<Accordion title="Delete a campaign">
  **this endpoint allows you to delete a specific campaign.**
</Accordion>

<Accordion title="Delete a sender identity">
  **this endpoint allows you to delete one of your sender identities.**
</Accordion>

<Accordion title="Delete a cancellation or pause from a scheduled send">
  **this endpoint allows you to delete the cancellation/pause of a scheduled send.** scheduled sends cancelled less than 10 minutes before the scheduled time are not guaranteed to be cancelled.
</Accordion>

<Accordion title="Delete a single recipient from a single list">
  **this endpoint allows you to delete a single recipient from a list.**
</Accordion>

<Accordion title="Create a sender">
  This api endpoint is for creating new senders, with a limit of 100. verification is mandatory, either automatic upon domain authentication or via a confirmation email sent to the sender's address.
</Accordion>

<Accordion title="Create subuser">
  **this endpoint allows you to create a new subuser.**
</Accordion>

<Accordion title="Create verified sender request">
  This endpoint creates a new sender identity via `post`, sends a verification email to `from email`, and requires email verification. to resend, use `/resend/\{id\}`. for domain authentication, refer to the domain authentication api.
</Accordion>

<Accordion title="Deny access request">
  **this endpoint allows you to deny an attempt to access your account.** **note:** only teammate admins may delete a teammate's access request.
</Accordion>

<Accordion title="Delete blocks">
  This endpoint enables clearing blocked emails either by deleting all with `delete all`=true or by specifying addresses in the `emails` array.
</Accordion>

<Accordion title="Delete bounces">
  This api endpoint lets users delete bounced emails: either all by setting `delete all` to true, or specific ones by listing them in `emails`. do not use both options together.
</Accordion>

<Accordion title="Delete invalid emails">
  This endpoint lets you delete email addresses from your invalid list; delete all by setting `delete all` to true, or specify individual addresses to remove.
</Accordion>

<Accordion title="Delete teammate">
  **this endpoint allows you to delete a teammate.** **only the parent user or an admin teammate can delete another teammate.**
</Accordion>

<Accordion title="Edit a transactional template">
  This endpoint lets you change the name of a transactional template. for template modifications, create a new version using the provided link.
</Accordion>

<Accordion title="Delete an alert">
  **this endpoint allows you to delete an alert.**
</Accordion>

<Accordion title="Delete verified sender">
  Use this endpoint with a sender identity's `id` to remove it from your account. find sender identity ids through the "get all verified senders" endpoint.
</Accordion>

<Accordion title="Disassociate an authenticated domain from a given user">
  This endpoint removes an authenticated domain from a subuser that was previously assigned by a parent account, used for sending emails under the parent's domain.
</Accordion>

<Accordion title="Duplicate sendgrid pre built design">
  The endpoint lets you duplicate twilio sendgrid pre-built designs without data. if unnamed, "duplicate:" precedes the original name. the copy gets a unique id, modifiable upon creation. use "list sendgrid pre-built designs" for ids.
</Accordion>

<Accordion title="Create list">
  This endpoint enables the creation of a new contacts list, which can automate email sending when new contacts are added. a link to the new list is provided in ` metadata`.
</Accordion>

<Accordion title="Duplicate single send">
  This endpoint duplicates single sends using an id for easy creation, allowing edits via patch. duplicates are named as "copy of" the original, with a 100-character limit for names.
</Accordion>

<Accordion title="Duplicate design">
  This endpoint duplicates existing designs without requiring data in the request body. if you don't specify a `name`, it's labeled "duplicate:" plus the original's name, but you can set a new name upon creation. each copy gets a unique id.
</Accordion>

<Accordion title="Delete an authenticated domain">
  **this endpoint allows you to delete an authenticated domain.**
</Accordion>

<Accordion title="Create custom field definition">
  Create unique case-insensitive custom fields with alphanumeric/underscore names starting with a letter/underscore. save the id for edits/deletes. limited to 500 fields of type date, text, or number. avoid starting with numbers to prevent campaign issues.
</Accordion>

<Accordion title="Delete a transactional template version">
  **this endpoint allows you to delete a transactional template version.**
</Accordion>

<Accordion title="Disassociate a branded link from a subuser">
  The endpoint permits parent accounts to remove a branded link from a subuser, with successful disassociations confirmed by a 204 status code response.
</Accordion>

<Accordion title="Delete a contact identifier">
  This endpoint asynchronously deletes an identifier (not the entire contact) from a contact, failing if it's their only one. allowed identifier types are email, phonenumberid, externalid, or anonymousid.
</Accordion>

<Accordion title="Edit a transactional template version">
  **this endpoint allows you to edit the content of your template version.**
</Accordion>

<Accordion title="Export contacts">
  Use the endpoint to export contact lists or segments by email, with notifications, or download as csvs using an 'id'. specify the data by id and choose json or csv output with a max file size option.
</Accordion>

<Accordion title="Delete a specific block">
  **this endpoint allows you to delete a specific email address from your blocks list.**
</Accordion>

<Accordion title="Sendgrid Delete Bulk Integration">
  This endpoint deletes integrations.
</Accordion>

<Accordion title="Erase recipients email data">
  Sendgrid's delete recipients' email data operation removes personal data of up to 5,000 unique email recipients or a 256kb payload per request. invalid emails return an error, and deletions are account-specific, not affecting subusers.
</Accordion>

<Accordion title="Domain warn list">
  The endpoint provides a list of domains with dmarc, divided by how they fail (hard or soft). hard failures prevent mail delivery using those domains as sender identities. for more on dmarc, visit sendgrid's guide.
</Accordion>

<Accordion title="Delete a custom field">
  **this endpoint allows you to delete a custom field by id.**
</Accordion>

<Accordion title="Email dns records to a co worker">
  Use sendgrid for domain validation and branding by sharing dns records—cname for automated security, or txt/mx otherwise. include `link id` for link branding and `domain id` for domain auth.
</Accordion>

<Accordion title="Edit an sso teammate">
  This endpoint allows admin or parent users to adjust sso teammate permissions using 'is admin', 'scopes', or 'persona', and to control subuser access, including restrictions.
</Accordion>

<Accordion title="Export single send stats">
  This endpoint exports single send stats in .csv format, allowing specification of multiple single sends by separating their ids with commas in the `ids` parameter.
</Accordion>

<Accordion title="Delete contacts">
  Use this endpoint to bulk delete contacts with `ids` as a list of ids or `delete all contacts` set to `"true"` for all. deletions are asynchronous. regularly export contacts as a backup.
</Accordion>

<Accordion title="Filter messages by message id">
  Get all of the details about the specified message.
</Accordion>

<Accordion title="Enable disable website access for a subuser">
  Enable/disable website access for a subuser, while still preserving email send functionality.
</Accordion>

<Accordion title="Delete an ip pool">
  **this endpoint allows you to delete an ip pool.**
</Accordion>

<Accordion title="Delete an sso certificate">
  **this endpoint allows you to delete an sso certificate.** you can retrieve a certificate's id from the response provided by the "get all sso integrations" endpoint.
</Accordion>

<Accordion title="Enable disable a subuser">
  **this endpoint allows you to enable or disable a subuser.**
</Accordion>

<Accordion title="Delete a specific spam report">
  This endpoint removes a spam report for an email, lifting suppression and allowing email to be sent to that address. use with caution and recipient consent, or use bypass filters for exceptions.
</Accordion>

<Accordion title="Delete a specific invalid email">
  **this endpoint allows you to remove a specific email address from the invalid email address list.**
</Accordion>

<Accordion title="Get all automation stats">
  Retrieve all your automation stats by default or specify with 'automation ids'. results are paginated with customizable 'page size' (1-50, default 25) and 'page token' for specific pages.
</Accordion>

<Accordion title="Filter all messages">
  Summarize email activity filtering: use url-encoded queries in the format `query=\{type\}="\{content\}"` to search email activity. example: filter by email with `query=to email%3d"example@example.com"`. reference more at sendgrid query reference.
</Accordion>

<Accordion title="Delete segment">
  **this endpoint allows you to delete a segment by id.**
</Accordion>

<Accordion title="Sendgrid Filter Segments By Parent Ids">
  Retrieve segments using `parent list ids` as a filter. an empty or unmatched query returns an empty result with a 200 code. filters combine `parent list ids` and the absence or presence of `no parent list id` with segment ids.
</Accordion>

<Accordion title="Delete a global suppression">
  This endpoint removes an email from suppressions, allowing future emails to be sent to it. use with consent or bypass filters for one-off emails.
</Accordion>

<Accordion title="Get all field definitions">
  **this endpoint retrieves all defined custom fields and reserved fields.**
</Accordion>

<Accordion title="Delete custom field definition">
  **this endpoint deletes a defined custom field.** you can delete only custom fields; reserved fields cannot be deleted.
</Accordion>

<Accordion title="Get all accounts">
  Retrieves all accounts under the organization.
</Accordion>

<Accordion title="Delete an sso integration">
  **this endpoint allows you to delete an idp configuration by id.** you can retrieve the ids for your configurations from the response provided by the "get all sso integrations" endpoint.
</Accordion>

<Accordion title="Delete pending teammate">
  **this endpoint allows you to delete a pending teammate invite.**
</Accordion>

<Accordion title="Get all available offerings">
  Retrieves offerings available under the organization.
</Accordion>

<Accordion title="Get account offerings">
  Retrieves offering information about the specified account.
</Accordion>

<Accordion title="Get all categories">
  **this endpoint allows you to retrieve all the categories associated with your single sends.** this endpoint will return your latest 1,000 categories.
</Accordion>

<Accordion title="Get all ip pools that have associated ips">
  The function lists your ip pools and samples up to 10 ips from each. for more ips per pool, use "get ips assigned to an ip pool." max of 100 ip pools per user.
</Accordion>

<Accordion title="Get all existing exports">
  This endpoint provides an array with details on active or completed export jobs. each object includes `export type`, `status`, and downloadable `urls` for ready exports. useful when export ids are unknown.
</Accordion>

<Accordion title="Get all sender identities">
  **this endpoint allows you to retrieve a list of all sender identities that have been created for your account.**
</Accordion>

<Accordion title="Delete a list">
  **this endpoint allows you to delete a specific recipient list with the given id.**
</Accordion>

<Accordion title="Get all lists">
  **this endpoint returns an array of all of your contact lists.**
</Accordion>

<Accordion title="Get all single sends">
  Retrieve a list of your single sends with brief details, including their ids. for in-depth information on a specific single send, use its id at the `/marketing/singlesends/\{id\}` endpoint.
</Accordion>

<Accordion title="Delete single send by id">
  This endpoint lets you delete a single send with its id, which you can obtain by a get request to `/marketing/singlensends`. note: deletion is irreversible.
</Accordion>

<Accordion title="Edit verified sender">
  Update a sender identity by sending a `patch` request with the `id` and json-formatted changes. unchanged fields will stay the same. retrieve ids via `get` to `/verified senders`.
</Accordion>

<Accordion title="Get all single sends stats">
  Retrieve single sends stats with options for filtering by ids, pagination, and custom page sizes from 1-50. default response batch is 25.
</Accordion>

<Accordion title="Delete design">
  **this endpoint allows you to delete a single design**. be sure to check the id of the design you intend to delete before making this request; deleting a design is a permanent action.
</Accordion>

<Accordion title="Get all sso integrations">
  **this endpoint allows you to retrieve all sso integrations tied to your twilio sendgrid account.** the ids returned by this endpoint can be used by the apis additional endpoints to modify your sso integrations.
</Accordion>

<Accordion title="Get all sso certificates by integration">
  **this endpoint allows you to retrieve all your idp configurations by configuration id.** the `integration id` expected by this endpoint is the `id` returned in the response by the "get all sso integrations" endpoint.
</Accordion>

<Accordion title="Download csv">
  **this endpoint will return a presigned url that can be used to download the csv that was requested from the "request a csv" endpoint.**
</Accordion>

<Accordion title="Delete a recipient">
  **this endpoint allows you to delete a single recipient with the given id from your contact database.** > use this to permanently delete your recipients from all of your contact lists and all segments if required by applicable law.
</Accordion>

<Accordion title="Delete api keys">
  **this endpoint allows you to revoke an existing api key using an `api key id`** authentications using a revoked api key will fail after after some small propogation delay. if the api key id does not exist, a `404` status will be returned.
</Accordion>

<Accordion title="Delete single send schedule">
  Cancel a scheduled single send by making a delete request with its id to the endpoint. this action doesn't delete the single send content, only stops the send-out.
</Accordion>

<Accordion title="Export contacts status">
  Use this endpoint with an `id` from "export contacts" to check the status and get `urls` for downloading your csv contact export files. regular exports are recommended for backups.
</Accordion>

<Accordion title="Delete a reverse dns record">
  This endpoint deletes a reverse dns record, returning a 204 code on success. retrieve record ids using the "retrieve all reverse dns records" endpoint.
</Accordion>

<Accordion title="Delete a subuser">
  **this endpoint allows you to delete a subuser.** this is a permanent action. once deleted, a subuser cannot be retrieved.
</Accordion>

<Accordion title="Duplicate a transactional template">
  **this endpoint allows you to duplicate a transactional template.**
</Accordion>

<Accordion title="Delete a batch of ips from an ip pool">
  This operation removes a batch of ips from an ip pool. all ips associated with the pool will be unassigned from the deleted pool. however, this operation does not remove the ips from your account.
</Accordion>

<Accordion title="Delete a bounce">
  **this endpoint allows you to remove an email address from your bounce list.**
</Accordion>

<Accordion title="Delete spam reports">
  This endpoint lets users delete spam reports, lifting email suppression for specified addresses. it's advised only when recipients want to resume emails. two deletion methods: 'delete all' or listing emails. use 'bypass filters' for exceptions.
</Accordion>

<Accordion title="Delete a batch of subusers from an ip">
  This operation removes a batch of subusers from a specified ip address.
</Accordion>

<Accordion title="Delete a parse setting">
  **this endpoint allows you to delete a specific inbound parse setting by hostname.** you can retrieve all your inbound parse settings and their associated host names with the "retrieve all parse settings" endpoint.
</Accordion>

<Accordion title="Delete a segment">
  **this endpoint allows you to delete a segment from your recipients database.** you also have the option to delete all the contacts from your marketing campaigns recipient database who were in this segment.
</Accordion>

<Accordion title="Delete a suppression from a suppression group">
  This endpoint removes an email from a suppression group, re-enabling email delivery unless specified otherwise, and should only be used when recipients opt back in.
</Accordion>

<Accordion title="Get all verified senders">
  Retrieve all sender identities (verified/unverified) for an account via an endpoint. customize results using `limit`, `lastseenid`, and `id` parameters to define the results scope.
</Accordion>

<Accordion title="Delete a branded link">
  Delete a branded link using this endpoint; successful deletion returns a 204 status. record link details beforehand as they're not provided. subuser deletions are possible with their id in the header.
</Accordion>

<Accordion title="Delete a template">
  **this endpoint allows you to delete a transactional template.**
</Accordion>

<Accordion title="Create segment">
  Segment `name` has to be unique. a user can not create a new segment with an existing segment name.
</Accordion>

<Accordion title="Delete a sender">
  **this endpoint allows you to delete an existing sender.**
</Accordion>

<Accordion title="Create single send">
  The endpoint lets you create a single send draft without needing a template id; it now uses `email config`. a set `send at` doesn't schedule it; it must be done through another endpoint or ui.
</Accordion>

<Accordion title="Delete a suppression group">
  This api endpoint deletes email suppression groups. deleted group members get globally suppressed if they unsubscribe. use with caution, only if recipients want to resubscribe. bypass filters available for exceptions.
</Accordion>

<Accordion title="Get an sso certificate">
  **this endpoint allows you to retrieve an individual sso certificate.**
</Accordion>

<Accordion title="Get an account s state">
  Retrieve the state of the specified account.
</Accordion>

<Accordion title="Get a contact by id">
  **this endpoint returns the full details and all fields for the specified contact**. the "get contacts by identifier" endpoint can be used to get the id of a contact.
</Accordion>

<Accordion title="Remove list and optional contacts">
  **this endpoint allows you to deletes a specific list.** optionally, you can also delete contacts associated to the list. the query parameter, `delete contacts=true`, will delete the list and start an asynchronous job to delete associated contacts.
</Accordion>

<Accordion title="List sendgrid pre built designs">
  The `designs/pre-builts` endpoint fetches a list of twilio sendgrid's ready-made designs, not user-specific ones, with 100 results per request by default, adjustable with `page size`. useful for duplicating and editing design ids.
</Accordion>

<Accordion title="Get single sends search">
  Search for single sends by specifying `name`, `status`, and `categories` in the request body. example provided for drafts or scheduled items related to "shoes".
</Accordion>

<Accordion title="Get a list of subusers assigned to an ip">
  The api lists subuser ids with a specific ip, retrieves up to 100 per request, and iterates with `after key` for more. use [subusers api](https://docs.sendgrid.com/api-reference/subusers-api/list-all-subusers) for details.
</Accordion>

<Accordion title="Get a list of all senders">
  **this endpoint allows you to get a list of all your senders.**
</Accordion>

<Accordion title="Get automation click tracking stats by id">
  **this endpoint lets you retrieve click-tracking stats for a single automation**. the stats returned list the urls embedded in your automation and the number of clicks each one received.
</Accordion>

<Accordion title="Get automation stats by id">
  Retrieve detailed stats for a specific automation by id, with optional date and aggregation filters, or use another endpoint to get stats for multiple automations.
</Accordion>

<Accordion title="Get information on a single suppression group">
  **this endpoint allows you to retrieve a single suppression group.**
</Accordion>

<Accordion title="Get an sso integration">
  **this endpoint allows you to retrieve an sso integration by id.** you can retrieve the ids for your configurations from the response provided by the "get all sso integrations" endpoint.
</Accordion>

<Accordion title="Sendgrid Get Integration">
  This endpoint returns the data for a specific integration.
</Accordion>

<Accordion title="Sendgrid List Integration">
  This endpoint returns all the integrations for the user making this call.
</Accordion>

<Accordion title="List the authenticated domain associated with the given user">
  Parent accounts can link validated domains to subusers through an endpoint, allowing subusers to email from those domains. the api supports multiple domain associations and listings.
</Accordion>

<Accordion title="Get total contact count">
  **this endpoint returns the total number of contacts you have stored.** twilio sendgrid recommends exporting your contacts regularly as a backup to avoid issues or lost data.
</Accordion>

<Accordion title="Get signed event webhook s public key">
  Retrieve a webhook's public key using its id via this endpoint; if no id is given, the oldest key is returned. useful for signature verification and toggling signature settings. multiple ids can be found using the "get all event webhooks" endpoint.
</Accordion>

<Accordion title="Remove one or more ips from the allow list">
  This endpoint lets you remove ips from your allowed list by sending an array of their ids, obtained from another endpoint. carefully select ips to avoid blocking your account access. if blocked, submit a support ticket.
</Accordion>

<Accordion title="Get a specific sender">
  **this endpoint allows you to get the details for a specific sender by `id`.**
</Accordion>

<Accordion title="Rename an ip pool">
  **this endpoint allows you to update the name of an ip pool.**
</Accordion>

<Accordion title="Get single send by id">
  **this endpoint allows you to retrieve details about one single send using a single send id.** you can retrieve all of your single sends by making a get request to the `/marketing/singlesends` endpoint.
</Accordion>

<Accordion title="Remove segment without affecting contacts">
  This endpoint permits the deletion of a segment using `segment id`, but associated contacts remain in the overall list and any other segments they're part of.
</Accordion>

<Accordion title="Request csv">
  Initiating a backend process creates a csv file of up to 1 million events from the last 30 days, emailed to the user with a 3-day expiry link. limited to one request per 12 hours, it's similar to the get single message but for csv downloads.
</Accordion>

<Accordion title="Get ips assigned to an ip pool">
  This operation returns the ip addresses that are assigned to the specified ip pool.
</Accordion>

<Accordion title="Get single send click tracking stats by id">
  **this endpoint lets you retrieve click-tracking stats for one single send**. the stats returned list the urls embedded in the specified single send and the number of clicks each one received.
</Accordion>

<Accordion title="Get a list by id">
  This endpoint fetches detailed information on a list. using `contact sample=true` includes up to 50 recent contacts and the total contact count in the response.
</Accordion>

<Accordion title="Resend a sender verification">
  **this endpoint allows you to resend the verification request for a specific sender.**
</Accordion>

<Accordion title="Manually refresh a segment">
  Manually refresh a segment by segment id.
</Accordion>

<Accordion title="Import contacts">
  The endpoint permits async csv uploads for up to 1m contacts or 5gb with specified identifiers and file type, supports gzip, field mappings, uses job id for tracking, and recommends regular backups.
</Accordion>

<Accordion title="Retrieve all assigned ips">
  This api endpoint retrieves assigned ip addresses used to send emails for various domains, where the ip's reputation is influenced by the collective performance of all sending users.
</Accordion>

<Accordion title="Retrieve address whitelist mail settings">
  This endpoint lets you access settings for whitelisting specific emails or domains to prevent email suppression due to bounces, blocks, or unsubscribes.
</Accordion>

<Accordion title="Import contacts status">
  Check the status of contact import jobs using `job id` via this endpoint. it shows if the job is pending, completed, errored, or failed. for errors, download the `errors url` file. regular contact exports are advised for backup.
</Accordion>

<Accordion title="Retrieve all api keys belonging to the authenticated user">
  Retrieve user's api key names and ids with this endpoint; keys themself cannot be retrieved for security. lost keys require recreation. use 'api key id' to manage keys.
</Accordion>

<Accordion title="Resend sender identity verification">
  **this endpoint allows you to resend a sender identity verification email.**
</Accordion>

<Accordion title="Presigned url  headers for bulk email validation">
  Get a presigned url and headers to upload an email list for verification. ensure the 'content-type' matches 'file type' in the 'put' request. visit the bulk validation overview page for format and sample request.
</Accordion>

<Accordion title="Retrieve all ips currently in warmup">
  **this endpoint allows you to retrieve all of your ip addresses that are currently warming up.**
</Accordion>

<Accordion title="Resend teammate invite">
  **this endpoint allows you to resend a teammate invitation.** teammate invitations will expire after 7 days. resending an invitation will reset the expiration date.
</Accordion>

<Accordion title="Retrieve all custom fields">
  **this endpoint allows you to retrieve all custom fields.**
</Accordion>

<Accordion title="Retrieve all blocks">
  Retrieve a paginated list of blocked emails using this endpoint, with adjustable page sizes via the 'limit' parameter and starting points with 'offset' for multiple requests.
</Accordion>

<Accordion title="Retrieve all invalid emails">
  Retrieve paginated lists of invalid emails with 'limit' for page size and 'offset' to start from a specific position for lists exceeding the limit.
</Accordion>

<Accordion title="Retrieve all global suppressions">
  Retrieve paginated lists of globally suppressed emails using `limit` for page size and `offset` to start from a specific list position. multiple requests may be needed for large lists.
</Accordion>

<Accordion title="Retrieve all categories">
  This endpoint provides a paginated list of user categories, with adjustable page size using the `limit` and pagination control using `offset`. multiple requests are needed for large lists.
</Accordion>

<Accordion title="Remove an ip address from a pool">
  **this endpoint allows you to remove an ip address from an ip pool.**
</Accordion>

<Accordion title="Retrieve all ip pools an ip address belongs to">
  This endpoint checks which ip pools contain a specific ip, which may be shared across multiple ip pools and affect the ip's reputation based on collective usage for email sending.
</Accordion>

<Accordion title="Invite teammate">
  Invite teammates to your account through email with this endpoint, assigning initial permissions via the `scopes` array. invites expire after 7 days but can be resent.
</Accordion>

<Accordion title="Get list contact count">
  **this endpoint returns the number of contacts on a specific list.**
</Accordion>

<Accordion title="Retrieve all ip pools">
  **this endpoint allows you to get all of your ip pools.**
</Accordion>

<Accordion title="Retrieve all ip addresses">
  Retrieve a paginated list of assigned/unassigned ips with warmup status, pools, subusers, and dns info. ip reputation is based on email traffic. use `limit` and `offset` parameters to control pagination.
</Accordion>

<Accordion title="Resend verified sender request">
  This endpoint resends a verification email to a sender identity's 'from address' by using the 'id' of the sender. useful if the original email is lost or needs to be resent. retrieve ids via "get all verified senders" endpoint.
</Accordion>

<Accordion title="Get single send stats by id">
  Retrieve individual single send stats using its id. for multiple ids, use "get all single sends stats". filter results by date or refine with `group by` and `aggregated by` parameters.
</Accordion>

<Accordion title="Retrieve all bounces">
  This endpoint retrieves a paginated list of all your bounces, allowing customization of page size with `limit` and starting position with `offset` for multiple requests.
</Accordion>

<Accordion title="Retrieve all lists">
  **this endpoint allows you to retrieve all of your recipient lists. if you don't have any lists, an empty array will be returned.**
</Accordion>

<Accordion title="Get subusers engagement quality scores">
  Retrieve seq scores for sendgrid subusers/accounts on a specific date; expect ‘200’ with scores or ‘202’ if unavailable yet, possibly accessible later. scores range from 1-5, with higher numbers indicating better engagement.
</Accordion>

<Accordion title="Retrieve all of your event webhooks">
  The endpoint fetches all event webhooks as objects in an array, showing each webhook's configuration and id, used to update, delete, or manage signature verification and oauth settings.
</Accordion>

<Accordion title="Retrieve all mail settings">
  Retrieve a paginated list of mail settings with their `enabled` status and descriptions. control page size with `limit` and list position with `offset` for multiple requests.
</Accordion>

<Accordion title="Get list of segments">
  The api endpoint retrieves segments, using `parent list ids` to filter results. if no matches are found, a 200 code with an empty array is returned. filters include list ids, absence of parent ids, or specific segment ids.
</Accordion>

<Accordion title="Remove an ip from an authenticated domain">
  **this endpoint allows you to remove an ip address from that domain's authentication.**
</Accordion>

<Accordion title="List all authenticated domains">
  Retrieve authenticated domain lists in pages using the `limit` parameter for page size and `offset` to start from specific list positions. multiple requests handle large lists.
</Accordion>

<Accordion title="Retrieves inbound parse webhook statistics">
  Sendgrid's inbound parse webhook parses incoming emails, up to 30mb, and posts to a specified url, with available integrations listed in their library index.
</Accordion>

<Accordion title="Retrieve all branded links">
  **this endpoint allows you to retrieve all branded links**. you can submit this request as one of your subusers if you include their id in the `on-behalf-of` header in the request.
</Accordion>

<Accordion title="Retrieve all pending teammates">
  **this endpoint allows you to retrieve a list of all pending teammate invitations.** each teammate invitation is valid for 7 days. users may resend the invitation to refresh the expiration date.
</Accordion>

<Accordion title="Retrieve all parse settings">
  **this endpoint allows you to retrieve all of your current inbound parse settings.**
</Accordion>

<Accordion title="Get a user s account information">
  **this endpoint allows you to retrieve your user account details.** your user's account information includes the user's account type and reputation.
</Accordion>

<Accordion title="Get teammate subuser access">
  Retrieve subusers accessible to a specified teammate, with available scopes. admin teammates get access to all subusers.
</Accordion>

<Accordion title="Get open tracking settings">
  The endpoint retrieves settings for tracking email opens using an invisible image. it logs open events when images load, with data available in sendgrid's statistics portal and event webhook.
</Accordion>

<Accordion title="Retrieve all reverse dns records">
  The endpoint provides a paginated list of reverse dns records, with optional ip prefix search and adjustable page size using 'limit' and 'offset' parameters.
</Accordion>

<Accordion title="Retrieve all recent access attempts">
  **this endpoint allows you to retrieve a list of all of the ip addresses that recently attempted to access your account either through the user interface or the api.**
</Accordion>

<Accordion title="Retrieve all recipients on a list">
  **this endpoint allows you to retrieve all recipients on the list with the given id.**
</Accordion>

<Accordion title="Retrieve all segments">
  **this endpoint allows you to retrieve all of your segments.**
</Accordion>

<Accordion title="Retrieve all scheduled sends">
  The endpoint provides details of cancelled or paused scheduled sends but only if they have a `batch id`. sends scheduled without a `batch id` via `/mail/send` won't be listed and can't be paused or cancelled later through this endpoint.
</Accordion>

<Accordion title="Retrieve all suppressions">
  **this endpoint allows you to retrieve a list of all suppressions.**
</Accordion>

<Accordion title="Get a user s profile">
  **this endpoint allows you to retrieve your current profile details.**
</Accordion>

<Accordion title="Retrieve all spam reports">
  Retrieve spam reports in pages using `limit` for page size and `offset` to continue from a specific list position. multiple requests handle larger lists.
</Accordion>

<Accordion title="Get the credits for a subuser">
  **this endpoint allows you to retrieve a credits overview for a subuser.**
</Accordion>

<Accordion title="Remove a specific ip from the allowed list">
  This endpoint lets you delete an allowed ip address using its id, obtainable via the "retrieve allowed ips" endpoint.
</Accordion>

<Accordion title="Retrieve access requests">
  Retrieve a list of recent access requests using pagination with `limit` for page size and `offset` to control the start position for additional items.
</Accordion>

<Accordion title="Retrieve all suppressions for a suppression group">
  **this endpoint allows you to retrieve all suppressed email addresses belonging to the given group.**
</Accordion>

<Accordion title="Get recipient upload status">
  **this endpoint allows you to check the upload status of a marketing campaigns recipient.**
</Accordion>

<Accordion title="Retrieve all campaigns">
  Retrieve a paginated list of campaigns in reverse creation order with the api endpoint. if none exist, get an empty array. adjust page size with `limit`, and fetch more with `offset`.
</Accordion>

<Accordion title="Retrieve all suppression groups associated with the user">
  This endpoint provides a list of user-created suppression groups and can return info for multiple groups when their ids are added to the request with `?id=123456`.
</Accordion>

<Accordion title="Get remaining ips count">
  **this endpoint gets amount of ip addresses that can still be created during a given period and the price of those ips.**
</Accordion>

<Accordion title="Retrieve all suppression groups for an email address">
  **this endpoint returns a list of all groups from which the given email address has been unsubscribed.**
</Accordion>

<Accordion title="Retrieve all teammates">
  Retrieve a paginated list of teammates with the `limit` parameter to set page size and `offset` to specify the starting point for additional items. make multiple requests if needed.
</Accordion>

<Accordion title="Remove contacts from a list">
  **this endpoint allows you to remove contacts from a given list.** the contacts will not be deleted. only their list membership will be changed.
</Accordion>

<Accordion title="Get batched contacts by ids">
  This endpoint fetches multiple contacts using their ids, allowing up to 100 ids per request for efficiency over single `get` requests. regular export of contacts is advised for backup.
</Accordion>

<Accordion title="Get sample contacts">
  The endpoint returns the latest 50 contacts, sorted by email, with the total count included. pagination is deprecated; regular export of contacts is advised.
</Accordion>

<Accordion title="Get details for an ip address">
  The operation provides details for an ip address, such as its parent account status, warm-up settings, associated pools, add/modify dates, lease status, and enablement, excluding subuser info, which requires a different endpoint.
</Accordion>

<Accordion title="Get contacts by identifiers">
  Use the endpoint to fetch up to 100 contacts by identifiers (email, phone number, etc.). successful queries return 200, no results return 404, and errors return 400. regular backups are advised.
</Accordion>

<Accordion title="Get the default authentication">
  This endpoint fetches the default domain authentication, used for sending all mail unless overridden by a 'from' address match. it provides domain details if a default is set; otherwise, it gives general authentication info.
</Accordion>

<Accordion title="Get contacts by emails">
  Endpoint retrieves up to 100 contacts by email, ignoring case/space; simpler than sgql's search. success returns `200`, `404` for no match, `400` for invalid emails. regular contact backups recommended.
</Accordion>

<Accordion title="Get sendgrid pre built design">
  The endpoint `/designs/pre-builts/\{id\}` is used to fetch details about a particular pre-built design for duplication and modification.
</Accordion>

<Accordion title="List Bulk Email Validation Jobs">
  **this endpoint returns a list of all of a user's bulk email validation jobs.**
</Accordion>

<Accordion title="Get the settings for a single event webhook">
  Retrieve an event webhook by id to get settings, event types, and url details. without id, the oldest is returned. signatures and oauth webhooks have extra properties. use another endpoint for multiple webhook ids.
</Accordion>

<Accordion title="Get a list of all ip addresses on your account">
  Fetches your account's ip addresses with details such as pool association and warm-up status. 'is parent assigned' and 'pool' must be exclusive. pagination needs 'limit' and 'before key' or 'after key'.
</Accordion>

<Accordion title="Get engagement quality scores">
  Retrieve your sendgrid engagement quality (seq) scores via api for a chosen date range. get a `200` response for available scores, or a `202` if scores haven't been calculated yet. scores range from 1 to 5, higher indicating better engagement.
</Accordion>

<Accordion title="Get details for an ip pool">
  This operation retrieves details of an ip pool, such as name, id, some sample ips (up to 10), and the total ip count. for more ips, use "get ips assigned to an ip pool."
</Accordion>

<Accordion title="List all subusers">
  Retrieve a paginated list of subusers with filtering options. use `username` to filter, `limit` to set page size, and `offset` to navigate through the list.
</Accordion>

<Accordion title="Get design">
  Access a specific design's details in your design library with a get request to `/designs/\{id\}`. this endpoint is useful for obtaining info to update via patch request.
</Accordion>

<Accordion title="List designs">
  The `/designs` endpoint fetches a list of user's stored designs, restricted to 100 per request by default but adjustable with `page size`. pre-built designs are at `/designs/pre-builts`.
</Accordion>

<Accordion title="Get segment by id">
  Get marketing campaigns segment by id
</Accordion>

<Accordion title="Retrieve click track settings">
  This endpoint retrieves your click tracking settings in sendgrid which tracks user engagement by redirecting and monitoring clicks on up to 1000 links per email.
</Accordion>

<Accordion title="Retrieve a count of recipients">
  **this endpoint allows you to retrieve the total number of marketing campaigns recipients.**
</Accordion>

<Accordion title="Retrieve a specific alert">
  **this endpoint allows you to retrieve a specific alert.**
</Accordion>

<Accordion title="Retrieve forward spam mail settings">
  This endpoint retrieves current forward spam settings, listing specified email addresses receiving spam reports and showing if the feature is active.
</Accordion>

<Accordion title="Retrieve a bounce">
  **this endpoint allows you to retrieve a specific bounce by email address.**
</Accordion>

<Accordion title="Retrieve a list of currently allowed ips">
  This endpoint provides a list of authorized ip addresses for your account, each with creation, update dates, and a unique id for potential removal.
</Accordion>

<Accordion title="Retrieve a global suppression">
  This endpoint retrieves global email suppressions and confirms if an email is suppressed. if suppressed, the email is returned in the response; if not, an empty json object is returned.
</Accordion>

<Accordion title="Retrieve all the ips in a specified pool">
  **this endpoint allows you to get all of the ip addresses that are in a specific ip pool.**
</Accordion>

<Accordion title="Retrieve current enforced tls settings">
  This endpoint retrieves enforced tls settings that mandate recipients to support tls 1.1+ or have a valid certificate. if not met, messages are dropped with a "tls required but not supported" block event.
</Accordion>

<Accordion title="Retrieve a reverse dns record">
  **this endpoint allows you to retrieve a reverse dns record.** you can retrieve the ids associated with all your reverse dns records using the "retrieve all reverse dns records" endpoint.
</Accordion>

<Accordion title="Retrieve a custom field">
  **this endpoint allows you to retrieve a custom field by id.**
</Accordion>

<Accordion title="Retrieve an authenticated domain">
  **this endpoint allows you to retrieve a specific authenticated domain.**
</Accordion>

<Accordion title="Retrieve an existing api key">
  Retrieve an api key's details with its id via this endpoint. nonexistent keys yield a 404 error. key scopes can be modified later. refer to the documentation for scope details.
</Accordion>

<Accordion title="Retrieve a segment">
  **this endpoint allows you to retrieve a single segment with the given id.**
</Accordion>

<Accordion title="Retrieve global email statistics">
  Retrieve your global email stats within a specific date range, with parent accounts viewing their own or a subuser's aggregated data via the `on-behalf-of` header, while subusers see only their stats.
</Accordion>

<Accordion title="Retrieve a single transactional template">
  **this endpoint allows you to retrieve a single transactional template.**
</Accordion>

<Accordion title="Retrieve a list of scopes for which this user has access">
  This api endpoint lists all accessible scopes for the user's api key, with permissions determining endpoint access. visit sendgrid documentation for more on api key permissions.
</Accordion>

<Accordion title="Retrieve a single campaign">
  **this endpoint allows you to retrieve a specific campaign.**
</Accordion>

<Accordion title="Retrieve email statistics by browser">
  Retrieve email stats by browser with advanced stats api, storing 7 days of data, and defaulting to 500 items per request. segment by location, device, and more. visit provided link for details.
</Accordion>

<Accordion title="Retrieve google analytics settings">
  Retrieve your google analytics settings, which are set to google's recommended defaults, to understand user site activity. for details, use google's guides and best practices links.
</Accordion>

<Accordion title="Retrieve legacy template mail settings">
  The endpoint retrieves settings for original email templates, with a guide for using and migrating from legacy to newer dynamic transactional templates.
</Accordion>

<Accordion title="Retrieve a specific block">
  **this endpoint allows you to retrieve a specific email address from your blocks list.**
</Accordion>

<Accordion title="Retrieve your account email address">
  **this endpoint allows you to retrieve the email address currently on file for your account.**
</Accordion>

<Accordion title="Retrieve recipients">
  Retrieve all marketing campaign recipients via this endpoint. use batch deletion carefully, as it may lead to empty pages. continue iterating pages until a 404 error occurs to ensure complete retrieval.
</Accordion>

<Accordion title="Retrieve paged transactional templates">
  **this endpoint allows you to retrieve all transactional templates.**
</Accordion>

<Accordion title="Retrieve user s authenticated domains">
  The api endpoint allows subusers to fetch up to five domains verified by the main account for sending emails, with a defined order of domain selection.
</Accordion>

<Accordion title="Retrieve a single list">
  **this endpoint allows you to retrieve a single recipient list.**
</Accordion>

<Accordion title="Retrieve monthly stats for all subusers">
  Retrieve monthly subuser email stats for a date range but can't sort by metrics like bounce drops, deferred, invalid emails, processed, spam reports, or unsubscribe drops.
</Accordion>

<Accordion title="Retrieve subuser reputations">
  This endpoint provides sender reputation scores for subusers, reflecting their email performance based on recipient responses and negative actions like bounces or spam reports.
</Accordion>

<Accordion title="Retrieve email statistics by client type">
  Retrieve email stats by client type with endpoint; stats stored for 7 days, 500 items per request. advanced stats offer detailed insights, segmentable by location, device, and more. visit the provided link for details.
</Accordion>

<Accordion title="Retrieve the count of billable recipients">
  This endpoint provides the billable count of recipients for marketing campaigns, based on the highest number reached in your account.
</Accordion>

<Accordion title="Retrieve a specific allowed ip">
  This endpoint retrieves an allowed ip for your account using its id, with ids obtainable from the endpoint listing currently allowed ips.
</Accordion>

<Accordion title="Retrieve sums of email stats for each category">
  **this endpoint allows you to retrieve the total sum of each email statistic for every category over the given date range.** if you do not define any query parameters, this endpoint will return a sum for each category in groups of 10.
</Accordion>

<Accordion title="Retrieve the default branded link">
  The endpoint retrieves the default branded link for message sending, prioritizing user-set default, legacy, or sendgrid's default links. subuser requests are possible with id in the header.
</Accordion>

<Accordion title="Retrieve recipients on a segment">
  **this endpoint allows you to retrieve all of the recipients in a segment with the given id.**
</Accordion>

<Accordion title="Send a campaign">
  **this endpoint allows you to immediately send an existing campaign.** normally a post request would have a body, but since this endpoint is telling us to send a resource that is already created, a request body is not needed.
</Accordion>

<Accordion title="Retrieve your username">
  **this endpoint allows you to retrieve your current account username.**
</Accordion>

<Accordion title="Retrieve your credit balance">
  This endpoint checks an account's base email sending credit balance, which affects per-email charges. more details at sendgrid's billing documentation.
</Accordion>

<Accordion title="Search recipients">
  This endpoint searches marketing campaigns recipients. variable 'field name' represents custom text fields (url-encoded) or date fields (by unix timestamp) and auto-converts epoch time for 'reserved' date fields to a full day range.
</Accordion>

<Accordion title="Segment json data by specific criteria">
  Search json data for segments by specifying criteria for dates, text, and campaign ids using operators and boolean logic. optional list ids can refine results. used for email metrics.
</Accordion>

<Accordion title="Search for suppressions within a group">
  **this endpoint allows you to search a suppression group for multiple suppressions.** when given a list of email addresses and a group id, this endpoint will only return the email addresses that have been unsubscribed from the given group.
</Accordion>

<Accordion title="Retrieve a branded link">
  **this endpoint allows you to retrieve a specific branded link by providing its id.** you can submit this request as one of your subusers if you include their id in the `on-behalf-of` header in the request.
</Accordion>

<Accordion title="Retrieve a single recipient">
  **this endpoint allows you to retrieve a single recipient by id from your contact database.**
</Accordion>

<Accordion title="Singlesend csv stats retrieval">
  Export single send stats in .csv format by specifying one or multiple single send ids in the `ids` query string, separated by commas. data is returned as plain text in .csv for flexible use or saving.
</Accordion>

<Accordion title="Set up reverse dns">
  **this endpoint allows you to set up reverse dns.**
</Accordion>

<Accordion title="Send a test campaign">
  **this endpoint allows you to send a test campaign.** to send to multiple addresses, use an array for the json "to" value \["one\@address","two\@address"]
</Accordion>

<Accordion title="Retrieve a specific invalid email">
  **this endpoint allows you to retrieve a specific invalid email addresses.**
</Accordion>

<Accordion title="Retrieve reserved fields">
  **this endpoint allows you to list all fields that are reserved and can't be used for custom field names.**
</Accordion>

<Accordion title="Retrieve email statistics by country and state province">
  This api endpoint offers detailed email stats by location, with up to 7 days of data stored and 500 items returned per request. more segmentation options are available. see the user guide for details.
</Accordion>

<Accordion title="Returns a list of all partner settings">
  Retrieve a paginated list of partner settings using the `limit` to set page size and `offset` to specify the starting point for additional items. multiple requests may be needed for long lists.
</Accordion>

<Accordion title="Retrieve the lists that a recipient is on">
  **this endpoint allows you to retrieve the lists that a given recipient belongs to.** each recipient can be on many lists. this endpoint gives you all of the lists that any one recipient has been added to.
</Accordion>

<Accordion title="Retrieve scheduled send">
  **this endpoint allows you to retrieve the cancel/paused scheduled send information for a specific `batch id`.**
</Accordion>

<Accordion title="Send a test marketing email">
  Use the endpoint to test marketing emails with a `template id` and up to 10 contacts. requires a `from address` or `sender id`. supports only dynamic transactional templates. manage with sendgrid app or api.
</Accordion>

<Accordion title="Stop warming up an ip address">
  This endpoint removes an ip from warmup mode, returning a 204 code if successful. for warmup status details prior to removal, use the "retrieve warmup status" endpoint.
</Accordion>

<Accordion title="Start warming up an ip address">
  **this endpoint allows you to put an ip address into warmup mode.**
</Accordion>

<Accordion title="Schedule a campaign">
  This endpoint schedules campaign emails for a specific time, recommending off-peak times like 10:53 instead of on the hour to minimize server deferrals and enhance delivery rates.
</Accordion>

<Accordion title="Retrieve the monthly email statistics for a single subuser">
  Retrieve monthly email stats for subusers with `sort by metric`, excluding sorts by `bounce drops`, `deferred`, `invalid emails`, `processed`, `spam report drops`, `spam reports`, `unsubscribe drops`.
</Accordion>

<Accordion title="Toggle signature verification for a single event webhook by id">
  Toggle signature verification for event webhooks via an endpoint. defaults to the oldest webhook if no id is provided. use boolean 'enabled' to set. returns a public key if enabled. retrieve webhook ids and public keys through specific endpoints.
</Accordion>

<Accordion title="This request returns a single bulk email validation job">
  **this endpoint returns a specific bulk email validation job. you can use this endpoint to check on the progress of a job.**
</Accordion>

<Accordion title="Update account offerings">
  Updates an account's package and attaches optional add-ons like marketing campaigns, dedicated ips, and expert services. note: accounts are limited to one package.
</Accordion>

<Accordion title="Update address whitelist mail settings">
  Update email whitelist settings by toggling `enabled`. use `list` to replace entries - include all desired. exclude generic domains for can-spam compliance; whitelist bypasses bounces/unsubscribes for included contacts.
</Accordion>

<Accordion title="Update an authenticated domain">
  **this endpoint allows you to update the settings for an authenticated domain.**
</Accordion>

<Accordion title="Retrieve single segment endpoint">
  **this endpoint allows you to retrieve a single segment by id.**
</Accordion>

<Accordion title="Update an alert">
  **this endpoint allows you to update an alert.**
</Accordion>

<Accordion title="Retrieve email statistics by device type">
  Retrieve email stats by device type with a 7-day data retention limit. the advanced stats api returns 500 items per request. device types include desktop, webmail, phone, tablet, and other. more analytics available at sendgrid's statistics overview.
</Accordion>

<Accordion title="Unlink subuser domain">
  The endpoint enables removal of an authenticated domain from subusers, each limited to five domains, to allow mail sending under a parent domain.
</Accordion>

<Accordion title="Retrieve the warmup status for a specific ip address">
  **this endpoint allows you to retrieve the warmup status for a specific ip address.** you can retrieve all of your warming ips using the "retrieve all ips currently in warmup" endpoint.
</Accordion>

<Accordion title="Sendgrid Sum Email Stats For Subusers">
  **this endpoint allows you to retrieve the total sums of each email statistic metric for all subusers over the given date range.**
</Accordion>

<Accordion title="Update an ip pool name">
  This operation will rename an ip pool. an ip pool name cannot start with a dot/period (.) or space.
</Accordion>

<Accordion title="Update api key name">
  **this endpoint allows you to update the name of an existing api key.** you must pass this endpoint a json request body with a `name` property, which will be used to rename the key associated with the `api key id` passed in the url.
</Accordion>

<Accordion title="Update a branded link">
  **this endpoint allows you to update a specific branded link. you can use this endpoint to change a branded link's default status.** you can submit this request as one of your subusers if you include their id in the `on-behalf-of` header in the request.
</Accordion>

<Accordion title="Update a list">
  **this endpoint allows you to update the name of one of your recipient lists.**
</Accordion>

<Accordion title="Update a campaign">
  **this endpoint allows you to update a specific campaign.** this is especially useful if you only set up the campaign using post /campaigns, but didn't set many of the parameters.
</Accordion>

<Accordion title="Update a parse setting">
  **this endpoint allows you to update a specific inbound parse setting by hostname.** you can retrieve all your inbound parse settings and their associated host names with the "retrieve all parse settings" endpoint.
</Accordion>

<Accordion title="Retrieve tracking settings">
  **this endpoint allows you to retrieve a list of all tracking settings on your account.**
</Accordion>

<Accordion title="Retrieve a specific parse setting">
  **this endpoint allows you to retrieve a specific inbound parse setting by hostname.** you can retrieve all your inbound parse settings and their associated host names with the "retrieve all parse settings" endpoint.
</Accordion>

<Accordion title="Retrieve specific teammate">
  **this endpoint allows you to retrieve a specific teammate by username.** you can retrieve the username's for each of your teammates using the "retrieve all teammates" endpoint.
</Accordion>

<Accordion title="Send email with twilio sendgrid">
  The mail send operation uses sendgrid's v3 api to send emails. visit the provided link for an overview, features, limitations, quickstarts, and helper libraries.
</Accordion>

<Accordion title="Retrieve email statistics by mailbox provider">
  Retrieve email stats by provider with advanced stats api, displaying details like location and device. only 7 days of data stored, 500 items per request. more info at sendgrid's statistics overview.
</Accordion>

<Accordion title="Update api key name and scopes">
  Update an api key's name and/or scopes using json with a `name` field and `scopes` array. to change only scopes, reuse the existing name. for just a name update, use another endpoint. see the permissions list for scope options. ([https://docs.sendgrid.com](https://docs.sendgrid.com))
</Accordion>

<Accordion title="Unschedule a scheduled campaign">
  **this endpoint allows you to unschedule a campaign that has already been scheduled to be sent.** a successful unschedule will return a 204. if the specified campaign is in the process of being sent, the only option is to cancel (a different method).
</Accordion>

<Accordion title="Update an sso integration">
  **this endpoint allows you to modify an exisiting sso integration.** you can retrieve the ids for your configurations from the response provided by the "get all sso integrations" endpoint.
</Accordion>

<Accordion title="Update a scheduled send">
  Use this endpoint to change the status of a scheduled send by batch id. status updates fail with a 400 error if previously set with the cancel/pause endpoint.
</Accordion>

<Accordion title="Update a scheduled campaign">
  **this endpoint allows to you change the scheduled time and date for a campaign to be sent.**
</Accordion>

<Accordion title="Test an event webhook s settings">
  The endpoint tests event webhooks by sending a fake event to your url. it has unique retry logic and requires specific oauth properties to test oauth configurations. saved credentials can be retrieved except for `oauth client secret`.
</Accordion>

<Accordion title="Retrieve a specific spam report">
  **this endpoint allows you to retrieve a specific spam report by email address.**
</Accordion>

<Accordion title="Retrieve a subuser s branded link">
  Retrieve a subuser's branded link, created and validated by the parent account, available through the api or twilio sendgrid's subuser management page.
</Accordion>

<Accordion title="Retrieve bounce purge mail settings">
  Retrieve and manage your bounce/purge settings for soft/hard bounce suppression lists with twilio sendgrid, either automatically or manually via the app/api.
</Accordion>

<Accordion title="Retrieve forward bounce mail settings">
  This endpoint fetches the current email forwarding settings for bounce messages, including the recipient email and whether the feature is active.
</Accordion>

<Accordion title="Retrieve footer mail settings">
  Retrieve and customize your footer settings for email bodies via this endpoint, directly or through twilio sendgrid's mail settings menu.
</Accordion>

<Accordion title="Retrieve email statistics for categories">
  **this endpoint allows you to retrieve all of your email statistics for each of your categories.** if you do not define any query parameters, this endpoint will return a sum for each category in groups of 10.
</Accordion>

<Accordion title="Retrieve a specific transactional template version">
  **this endpoint allows you to retrieve a specific version of a template.**
</Accordion>

<Accordion title="Retrieve subscription tracking settings">
  **this endpoint allows you to retrieve your current settings for subscription tracking.** subscription tracking adds links to the bottom of your emails that allows your recipients to subscribe to, or unsubscribe from, your emails.
</Accordion>

<Accordion title="Retrieve stats by a specific client type">
  Use advanced stats api to get email statistics by client type (e.g., phone, desktop), offering location and device details. data storage is limited to 7 days with up to 500 items per request. see statistics overview for further information.
</Accordion>

<Accordion title="Schedule single send">
  Use this endpoint to send a message right away by setting `send at` to `now`, or schedule it by specifying a future time in iso 8601 format (`yyyy-mm-ddthh:mm:ssz`).
</Accordion>

<Accordion title="Retrieve bounce classification totals">
  This endpoint will return the total number of bounces by classification in descending order for each day. you can retrieve the bounce classification totals in csv format by specifying `"text/csv"` in the accept header.
</Accordion>

<Accordion title="Update an account s state">
  Update the state of the specified account.
</Accordion>

<Accordion title="Search contacts">
  Find contacts using this endpoint with a body containing a `query` in sgql. searches must use lowercase, and only the first 50 matches are returned. queries over 20s will timeout. dates are in iso format, not unix timestamps.
</Accordion>

<Accordion title="Retrieve email statistics for your subusers">
  **this endpoint allows you to retrieve the email statistics for the given subusers.** you may retrieve statistics for up to 10 different subusers by including an additional  subusers  parameter for each additional subuser.
</Accordion>

<Accordion title="Retrieve bounce classification over time by domain stats">
  This endpoint will return the number of bounces for the classification specified in descending order for each day. you can retrieve the bounce classification totals in csv format by specifying `"text/csv"` in the accept header.
</Accordion>

<Accordion title="Update custom field definition">
  **this endpoint allows you to update a defined custom field.** only your custom fields can be modified; reserved fields cannot be updated.
</Accordion>

<Accordion title="Update click tracking settings">
  This endpoint configures click tracking for emails, redirecting links through sendgrid or branded domains for engagement analysis, with a limit of 1000 links per email.
</Accordion>

<Accordion title="Update a sender identity">
  This api endpoint enables updates to sender identities. changing `from.email` necessitates re-verification. partial updates are valid, but "required" fields must not be empty in patch requests.
</Accordion>

<Accordion title="Validate a reverse dns record">
  Endpoint checks reverse dns record validity via `valid` in `validation results.a record`. if `false`, it's undetermined, not necessarily invalid. check `reason` for explanation. retrieve ids with "retrieve all reverse dns records" endpoint.
</Accordion>

<Accordion title="Validate a branded link">
  **this endpoint allows you to validate a branded link.** you can submit this request as one of your subusers if you include their id in the `on-behalf-of` header in the request.
</Accordion>

<Accordion title="Update a suppression group">
  **this endpoint allows you to update or change a suppression group.**
</Accordion>

<Accordion title="Validate a batch id">
  Validate a mail batch id to get a `200` status code for a valid one, or a `400` code for an invalid. a valid id simply means it's created, not necessarily assigned to a send.
</Accordion>

<Accordion title="Update a sender">
  This endpoint updates an existing sender. changes to `from.email` need re-verification. if domain authenticated, new senders auto verify; else, verification email sent. partial updates can be made, but "required" fields in a `patch` must not be empty.
</Accordion>

<Accordion title="Update a user s profile">
  **this endpoint allows you to update your current profile details.** any one or more of the parameters can be updated via the patch `/user/profile` endpoint. you must include at least one when you patch.
</Accordion>

<Accordion title="Update bounce purge mail settings">
  Update your bounce settings with twilio sendgrid to automatically delete contacts from suppression lists based on a set schedule in full days for both soft and hard email bounces. manage settings via their app or api.
</Accordion>

<Accordion title="Update a segment">
  **this endpoint allows you to update a segment.**
</Accordion>

<Accordion title="Update design">
  The design api enables partial design updates using patch requests, changing only specified fields, like the 'name' field, with no impact on other data.
</Accordion>

<Accordion title="Update sso certificate">
  **this endpoint allows you to update an existing certificate by id.** you can retrieve a certificate's id from the response provided by the "get all sso integrations" endpoint.
</Accordion>

<Accordion title="Update details for an ip address">
  The operation modifies an ip address's settings, such as auto warm-up status, parent account assignment, and active status. the request must have one of `is auto warmup`, `is parent assigned`, or `is enabled`.
</Accordion>

<Accordion title="Validate a domain authentication">
  **this endpoint allows you to validate an authenticated domain. if it fails, it will return an error message describing why the domain could not be validated.**
</Accordion>

<Accordion title="Update a single event webhook by id">
  Update event webhooks by id with this endpoint or without id to update the oldest one. enable or disable, set url, choose event types, give friendly names, and configure oauth. for signature verification, use a different endpoint.
</Accordion>

<Accordion title="Update subscription tracking settings">
  **this endpoint allows you to update your current settings for subscription tracking.** subscription tracking adds links to the bottom of your emails that allows your recipients to subscribe to, or unsubscribe from, your emails.
</Accordion>

<Accordion title="Verify sender request">
  **this endpoint allows you to verify a sender requests.** the token is generated by sendgrid and included in a verification email delivered to the address that's pending verification.
</Accordion>

<Accordion title="View a sender identity">
  **this endpoint allows you to retrieve a specific sender identity.**
</Accordion>

<Accordion title="View scheduled time of a campaign">
  **this endpoint allows you to retrieve the date and time that a campaign has been scheduled to be sent.**
</Accordion>

<Accordion title="Update teammate s permissions">
  This endpoint updates teammate permissions: set `is admin` to `true` for admin rights, otherwise to `false` with relevant scopes. only parent users or admins can modify these settings, and admin users are limited to permission changes.
</Accordion>

<Accordion title="Update template mail settings">
  The endpoint updates legacy email templates, replaced by more advanced dynamic transactional templates. legacy templates are html-wrapped email content useful for marketing. guidance is available for using and migrating from legacy templates.
</Accordion>

<Accordion title="Update the credits for a subuser">
  **this endpoint allows you to update the credits for a subuser.**
</Accordion>

<Accordion title="Update the remaining credits for a subuser">
  **this endpoint allows you to update the remaining credits for a subuser.**
</Accordion>

<Accordion title="Update your account email address">
  **this endpoint allows you to update the email address currently on file for your account.**
</Accordion>

<Accordion title="Update your password">
  **this endpoint allows you to update your password.**
</Accordion>

<Accordion title="Update your username">
  **this endpoint allows you to update the username for your account.**
</Accordion>

<Accordion title="Update footer mail settings">
  This endpoint updates your email footer settings, enabling a custom footer addition in text/html emails. edit directly or via the twilio sendgrid app.
</Accordion>

<Accordion title="Update enforced tls settings">
  Update tls settings through the endpoint by setting 'require tls' to 'true' for compulsory tls 1.1+ and valid certificates with recipients. messages without tls are blocked with a specific event notice.
</Accordion>

<Accordion title="Validate an email">
  **this endpoint allows you to validate an email address.**
</Accordion>

<Accordion title="Update forward spam mail settings">
  Activate forward spam to send spam reports to specified emails; supports multiple addresses and authenticating domains to receive abuse/postmaster mails. configure via twilio sendgrid app.
</Accordion>

<Accordion title="Update forward bounce mail settings">
  This endpoint updates bounce forwarding mail settings, allowing users to set an email for bounce report forwards and configure spam mail forwarding in twilio sendgrid app.
</Accordion>

<Accordion title="Update google analytics settings">
  Update your google analytics settings to track user activity on your site more effectively; defaults follow google's recommendations. for guidance, visit google's url builder and campaign building best practices.
</Accordion>

<Accordion title="Sendgrid Update Integration">
  This endpoint updates an existing integration.
</Accordion>

<Accordion title="Update open tracking settings">
  Update your email settings to enable open tracking with sendgrid, which uses an invisible image to log email opens in various reports if the recipient allows images.
</Accordion>

<Accordion title="Update segment">
  Segment `name` has to be unique. a user can not create a new segment with an existing segment name.
</Accordion>

<Accordion title="Update list">
  **this endpoint updates the name of a list.**
</Accordion>

<Accordion title="Update single send">
  Update single send drafts using its id via this endpoint; only changed properties are affected. the 'send at' property sets a date but doesn't schedule it; use schedule single send endpoint or ui to schedule.
</Accordion>


# Sentry
Source: https://docs.push.ai/integrations/sentry



Integrate Sentry to manage your error tracking and monitoring.

<Accordion title="Create external user for organization">
  Link a user from an external provider to a sentry user.
</Accordion>

<Accordion title="Delete dsyms for project">
  Delete a debug information file for a given project.
</Accordion>

<Accordion title="Create project key with optional rate limiting">
  Create a new client key bound to a project. the key's secret and public key are generated by the server.
</Accordion>

<Accordion title="Create organization team">
  Create a new team bound to an organization. requires at least one of the `name` or `slug` body params to be set.
</Accordion>

<Accordion title="Create dashboard with widgets">
  Create a new dashboard for the given organization
</Accordion>

<Accordion title="Delete organization dashboard">
  Delete an organization's custom dashboard, or tombstone a pre-built dashboard which effectively deletes it.
</Accordion>

<Accordion title="Create organization alert rule">
  Create a new metric alert rule for the given organization. a metric alert rule defines conditions for triggering alerts based on metrics like error count, latency, or failure rate. it specifies the metric type, function, time interval, and thresholds that determine when to trigger alerts. this helps proactively identify and address issues in your project.
</Accordion>

<Accordion title="Create organization monitor">
  Create a new monitor.
</Accordion>

<Accordion title="Access project information">
  Return details on an individual project.
</Accordion>

<Accordion title="Create user for saml integration">
  Create a new organization member via a scim users post request. note that this api does not support setting secondary emails.
</Accordion>

<Accordion title="Delete organization release">
  Permanently remove a release and all of its files.
</Accordion>

<Accordion title="Create project rule for alerts">
  Create a new issue alert rule for the given project. an issue alert rule triggers whenever a new event is received for any issue in a project that matches the specified alert conditions. these conditions can include a resolved issue re-appearing or an issue affecting many users. alert conditions have three parts: - triggers: specify what type of activity you'd like monitored or when an alert should be triggered. - filters: help control noise by triggering an alert only if the issue matches the specified criteria. - actions: specify what should happen when the trigger conditions are met and the filters match.
</Accordion>

<Accordion title="Delete organization discover query">
  Delete a saved query.
</Accordion>

<Accordion title="Delete external issue by uuid">
  Delete an external issue.
</Accordion>

<Accordion title="Delete project by id">
  Schedules a project for deletion. deletion happens asynchronously and therefore is not immediate. however once deletion has begun the state of a project changes and will be hidden from most public views.
</Accordion>

<Accordion title="Delete project hook">
  Remove a service hook.
</Accordion>

<Accordion title="Delete project key">
  Delete a client key for a given project.
</Accordion>

<Accordion title="Delete external team by id">
  Delete the link between a team from an external provider and a sentry team.
</Accordion>

<Accordion title="Add organization member via email">
  Add or invite a member to an organization.
</Accordion>

<Accordion title="Delete org notification action">
  Deletes a spike protection notification action. notification actions notify a set of members when an action has been triggered through a notification service such as slack or sentry. for example, organization owners and managers can receive an email when a spike occurs.
</Accordion>

<Accordion title="Create project webhook subscription">
  Register a new service hook on a project. events include: - event.alert: an alert is generated for an event (via rules). - event.created: a new event has been processed. this endpoint requires the 'servicehooks' feature to be enabled for your project.
</Accordion>

<Accordion title="Delete team by organization or team slug">
  Schedules a team for deletion. **note:** deletion happens asynchronously and therefore is not immediate. teams will have their slug released while waiting for deletion.
</Accordion>

<Accordion title="Add remove user email by id">
  Add a secondary email address to account
</Accordion>

<Accordion title="Delete project issues">
  Permanently remove the given issues. the list of issues to modify is given through the `id` query parameter. it is repeated for each issue that should be removed. only queries by 'id' are accepted. if any ids are out of scope this operation will succeed without any data mutation.
</Accordion>

<Accordion title="Delete external user from organization">
  Delete the link between a user from an external provider and a sentry user.
</Accordion>

<Accordion title="Delete release file">
  Delete a file for a given release.
</Accordion>

<Accordion title="Delete project team association">
  Revoke a team's access to a project. note that team admins can only revoke access to teams they are admins of.
</Accordion>

<Accordion title="Delete team from org scim v2">
  Delete a team with a scim group delete request.
</Accordion>

<Accordion title="Delete member from team">
  Delete an organization member from a team.
</Accordion>

<Accordion title="Delete release file by id">
  Delete a file for a given release.
</Accordion>

<Accordion title="Fetch issue event by id">
  Retrieves the details of an issue event.
</Accordion>

<Accordion title="Delete user from org">
  Delete an organization member with a scim user delete request.
</Accordion>

<Accordion title="Delete user emails by id">
  Removes an email associated with the user account
</Accordion>

<Accordion title="Delete project monitor">
  Delete a monitor or monitor environments.
</Accordion>

<Accordion title="Add team member in organization">
  Add an organization member to a team.
</Accordion>

<Accordion title="Delete organization integration">
  Organizationintegrationbaseendpoints expect both integration and organizationintegration db entries to exist for a given organization and integration id.
</Accordion>

<Accordion title="Add team to project">
  Give a team access to a project.
</Accordion>

<Accordion title="Fetch organization replay count">
  Return a count of replays for the given issue or transaction id.
</Accordion>

<Accordion title="Delete organization alert rule">
  Delete a specific metric alert rule. a metric alert rule is a configuration that defines the conditions for triggering an alert. it specifies the metric type, function, time interval, and threshold values that determine when an alert should be triggered. metric alert rules are used to monitor and notify you when certain metrics, like error count, latency, or failure rate, cross a predefined threshold. these rules help you proactively identify and address issues in your project.
</Accordion>

<Accordion title="Fetch project environment details">
  Return details on a project environment.
</Accordion>

<Accordion title="Fetch organization release threshold statuses">
  **`[warning]`**: this api is an experimental alpha feature and is subject to change! list all derived statuses of releases that fall within the provided start/end datetimes. constructs a response key'd off \{`release version`}-\{`project slug`} that lists thresholds with their status for *specified* projects. each returned enriched threshold will contain the full serialized `release threshold` instance as well as it's derived health statuses.
</Accordion>

<Accordion title="Fetch project release files">
  Return a list of files for a given release.
</Accordion>

<Accordion title="Fetch replay recording segment">
  Return a replay recording segment.
</Accordion>

<Accordion title="Create release deploy for org">
  Create a deploy.
</Accordion>

<Accordion title="Fetch tag values for issue">
  Returns a list of values associated with this key for an issue. returns at most 1000 values when paginated.
</Accordion>

<Accordion title="Get activation of alert rule for organization">
  Return a list of activations for a metric alert rule. an activation represents a single instance of an activated alert rule being triggered. it contains a date added field which represents the time the alert was triggered. activations can be filtered by start and end parameters to return activations with date added that falls within the specified time window.
</Accordion>

<Accordion title="Delete project rule">
  Delete a specific issue alert rule.
</Accordion>

<Accordion title="Get integration details by org">
  Organizationintegrationbaseendpoints expect both integration and organizationintegration db entries to exist for a given organization and integration id.
</Accordion>

<Accordion title="Delete project replay">
  Delete a replay.
</Accordion>

<Accordion title="Fetch organization alert rules">
  Return a list of active metric alert rules bound to an organization. a metric alert rule is a configuration that defines the conditions for triggering an alert. it specifies the metric type, function, time interval, and threshold values that determine when an alert should be triggered. metric alert rules are used to monitor and notify you when certain metrics, like error count, latency, or failure rate, cross a predefined threshold. these rules help you proactively identify and address issues in your project.
</Accordion>

<Accordion title="Fetch project ownership details">
  Returns details on a project's ownership configuration.
</Accordion>

<Accordion title="Fetch organization replay selectors">
  Return a list of selectors for a given organization.
</Accordion>

<Accordion title="Create sentry external issue link">
  Create or update an external issue from an integration platform integration.
</Accordion>

<Accordion title="Create team project for organization">
  Create a new project bound to a team.
</Accordion>

<Accordion title="Delete organization monitor">
  Delete a monitor or monitor environments.
</Accordion>

<Accordion title="Delete project symbol sources">
  Delete a custom symbol source from a project.
</Accordion>

<Accordion title="Fetch organization replay details">
  Return details on an individual replay.
</Accordion>

<Accordion title="Create release for organization">
  Create a new release for the given organization. releases are used by sentry to improve its error reporting abilities by correlating first seen events with the release that might have introduced the problem. releases are also necessary for source maps and other debug features that require manual upload for functioning well.
</Accordion>

<Accordion title="Fetch project replay clicks">
  Retrieve a collection of rrweb dom node-ids and the timestamp they were clicked.
</Accordion>

<Accordion title="Delete organization member">
  Remove an organization member.
</Accordion>

<Accordion title="Delete organization issue">
  Removes an individual issue.
</Accordion>

<Accordion title="Create scim group for organization">
  Create a new team bound to an organization via a scim groups post request. the slug will have a normalization of uppercases/spaces to lowercases and dashes. note that teams are always created with an empty member set.
</Accordion>

<Accordion title="Get organization monitor by id or slug">
  Retrieves details for a monitor.
</Accordion>

<Accordion title="Get organization environments">
  Lists an organization's environments.
</Accordion>

<Accordion title="Get organization details">
  Return a list of organizations available to the authenticated session in a region. this is particularly useful for requests with a user bound context. for api key-based requests this will only return the organization that belongs to the key.
</Accordion>

<Accordion title="List organization user teams">
  Returns a list of teams the user has access to in the specified organization. note that this endpoint is restricted to [user auth tokens](https://docs.sentry.io/account/auth-tokens/#user-auth-tokens).
</Accordion>

<Accordion title="Get organization release version">
  Return details on an individual release.
</Accordion>

<Accordion title="Get project list">
  Return a list of projects available to the authenticated session.
</Accordion>

<Accordion title="Get project events">
  Return a list of events bound to a project.
</Accordion>

<Accordion title="Get organization by id or slug">
  Return details on an individual organization, including various details such as membership access and teams.
</Accordion>

<Accordion title="Get organization issue details">
  Return details on an individual issue. this returns the basic stats for the issue (title, last seen, first seen), some overall numbers (number of comments, user reports) as well as the summarized event data.
</Accordion>

<Accordion title="Retrieve monitor checkins">
  Retrieve a list of check-ins for a monitor
</Accordion>

<Accordion title="Retrieve notification action by org id">
  Returns a serialized spike protection notification action object. notification actions notify a set of members when an action has been triggered through a notification service such as slack or sentry. for example, organization owners and managers can receive an email when a spike occurs.
</Accordion>

<Accordion title="Retrieve issue tag details">
  Return a list of values associated with this key for an issue. when paginated can return at most 1000 values.
</Accordion>

<Accordion title="Retrieve monitor checkins by org">
  Retrieve a list of check-ins for a monitor
</Accordion>

<Accordion title="Retrieve issue events by id">
  Return a list of error events bound to an issue
</Accordion>

<Accordion title="Patch user active status in organization">
  Update an organization member's attributes with a scim patch request.
</Accordion>

<Accordion title="Get project monitor by id">
  Retrieves details for a monitor.
</Accordion>

<Accordion title="Retrieve issue hashes for organization">
  This endpoint lists an issue's hashes, which are the generated checksums used to aggregate individual events.
</Accordion>

<Accordion title="Retrieve organization relay usage">
  Return a list of trusted relays bound to an organization. if the organization doesn't have relay usage enabled it returns a 404.
</Accordion>

<Accordion title="Retrieve project event by id">
  Return details on an individual event.
</Accordion>

<Accordion title="List project users">
  Return a list of users seen within this project.
</Accordion>

<Accordion title="Retrieve organization release commits">
  List an organization release's commits.
</Accordion>

<Accordion title="Retrieve project release file details">
  Retrieve a file for a given release.
</Accordion>

<Accordion title="Get scim group by team id">
  Query an individual team with a scim group get request. - note that the members field will only contain up to 10000 members.
</Accordion>

<Accordion title="Retrieve project hooks">
  Return a list of service hooks bound to a project.
</Accordion>

<Accordion title="List teams in organization">
  Returns a list of teams bound to a organization.
</Accordion>

<Accordion title="Retrieve project filter data">
  Retrieve a list of filters for a given project. `active` will be either a boolean or a list for the legacy browser filters.
</Accordion>

<Accordion title="Post project symbol sources">
  Add a custom symbol source to a project.
</Accordion>

<Accordion title="Retrieve project members list">
  Returns a list of active organization members that belong to any team assigned to the project.
</Accordion>

<Accordion title="Retrieve project keys by org and project">
  Return a list of client keys bound to a project.
</Accordion>

<Accordion title="Retrieve organization dashboard">
  Return details about an organization's custom dashboard.
</Accordion>

<Accordion title="Get project rule details">
  Return details on an individual issue alert rule. an issue alert rule triggers whenever a new event is received for any issue in a project that matches the specified alert conditions. these conditions can include a resolved issue re-appearing or an issue affecting many users. alert conditions have three parts: - triggers - specify what type of activity you'd like monitored or when an alert should be triggered. - filters - help control noise by triggering an alert only if the issue matches the specified criteria. - actions - specify what should happen when the trigger conditions are met and the filters match.
</Accordion>

<Accordion title="Retrieve project key details">
  Return a client key bound to a project.
</Accordion>

<Accordion title="List scim v2 organization users">
  Returns a paginated list of members bound to a organization with a scim users get request.
</Accordion>

<Accordion title="Retrieve project issues list">
  Return a list of issues (groups) bound to a project. all parameters are supplied as query string parameters. a default query of `is:unresolved` is applied. to return results with other statuses send an new query value (i.e. `?query=` for all results). the `statsperiod` parameter can be used to select the timeline stats which should be present. possible values are: `""` (disable),`"24h"` (default), `"14d"` user feedback items from the [user feedback widget](https://docs.sentry.io/product/user-feedback/#user-feedback-widget) are built off the issue platform, so to return a list of user feedback items for a specific project, filter for `issue.category:feedback`.
</Accordion>

<Accordion title="Retrieve project rules by org and project id">
  Return a list of active issue alert rules bound to a project. an issue alert rule triggers whenever a new event is received for any issue in a project that matches the specified alert conditions. these conditions can include a resolved issue re-appearing or an issue affecting many users. alert conditions have three parts: - triggers: specify what type of activity you'd like monitored or when an alert should be triggered. - filters: help control noise by triggering an alert only if the issue matches the specified criteria. - actions: specify what should happen when the trigger conditions are met and the filters match.
</Accordion>

<Accordion title="Get Project Event Stats">
  Return a set of points representing a normalized timestamp and the number of events seen in the period. query ranges are limited to sentry's configured time-series resolutions.
</Accordion>

<Accordion title="Get organization sessions">
  Returns a time series of release health session statistics for projects bound to an organization. the interval and date range are subject to certain restrictions and rounding rules. the date range is rounded to align with the interval, and is rounded to at least one hour. the interval can at most be one day and at least one hour currently. it has to cleanly divide one day, for rounding reasons. because of technical limitations, this endpoint returns at most 10000 data points. for example, if you select a 90 day window grouped by releases, you will see at most `floor(10k / (90 + 1)) = 109` releases. to get more results, reduce the `statsperiod`.
</Accordion>

<Accordion title="Retrieve project tag values">
  Return a list of values associated with this key. the `query` parameter can be used to perform a "contains" match on values. when [paginated](/api/pagination) can return at most 1000 values.
</Accordion>

<Accordion title="Retrieve organization events">
  Retrieves discover (also known as events) data for a given organization.
</Accordion>

<Accordion title="Post spike protection for organization">
  Enables spike protection feature for some of the projects within the organization.
</Accordion>

<Accordion title="Get team members by id or slug">
  List all members on a team. the response will not include members with pending invites.
</Accordion>

<Accordion title="Retrieve saved discover query for organization">
  Retrieve a saved query.
</Accordion>

<Accordion title="Get who viewed replay by project">
  Return a list of users who have viewed a replay.
</Accordion>

<Accordion title="Retrieve saved discover queries">
  Retrieve a list of saved queries that are associated with the given organization.
</Accordion>

<Accordion title="Retrieve replay recording segments">
  Return a collection of replay recording segments.
</Accordion>

<Accordion title="Retrieve project symbol sources">
  List custom symbol sources configured for a project.
</Accordion>

<Accordion title="Retrieve alert rule details">
  Return details on an individual metric alert rule. a metric alert rule is a configuration that defines the conditions for triggering an alert. it specifies the metric type, function, time interval, and threshold values that determine when an alert should be triggered. metric alert rules are used to monitor and notify you when certain metrics, like error count, latency, or failure rate, cross a predefined threshold. these rules help you proactively identify and address issues in your project.
</Accordion>

<Accordion title="Retrieve release deployments">
  Return a list of deploys for a given release.
</Accordion>

<Accordion title="Get sentry app installations for organization">
  Return a list of integration platform installations for a given organization.
</Accordion>

<Accordion title="Retrieve release file by id">
  Retrieve a file for a given release.
</Accordion>

<Accordion title="Retrieve commits for organization repo">
  Return a list of commits for a given repository.
</Accordion>

<Accordion title="Retrieve source map debug event">
  Return a list of source map errors for a given event.
</Accordion>

<Accordion title="Retrieve project teams">
  Return a list of teams that have access to this project.
</Accordion>

<Accordion title="Retrieve commit files for release">
  Retrieve files changed in a release's commits
</Accordion>

<Accordion title="Retrieve short id for organization">
  This resolves a short id to the project slug and internal issue id.
</Accordion>

<Accordion title="Get project hook">
  Return a service hook bound to a project.
</Accordion>

<Accordion title="List organization dashboards">
  Retrieve a list of custom dashboards that are associated with the given organization.
</Accordion>

<Accordion title="Retrieve organization integrations list">
  Lists all the available integrations for an organization.
</Accordion>

<Accordion title="Retrieve user email information">
  Returns a list of emails. primary email will have `isprimary: true`
</Accordion>

<Accordion title="Retrieve team projects">
  Return a list of projects bound to a team.
</Accordion>

<Accordion title="List organization members">
  List all organization members. response includes pending invites that are approved by organization owners or managers but waiting to be accepted by the invitee.
</Accordion>

<Accordion title="Switch team role for member">
  The relevant organization member must already be a part of the team. note that for organization admins, managers, and owners, they are automatically granted a minimum team role of `admin` on all teams they are part of. read more about [team roles](https://docs.sentry.io/product/teams/roles/).
</Accordion>

<Accordion title="Toggle project filter status">
  Update various inbound data filters for a project.
</Accordion>

<Accordion title="Manage team external integrations">
  Link a team from an external provider to a sentry team.
</Accordion>

<Accordion title="Update environment visibility">
  Update the visibility for a project environment.
</Accordion>

<Accordion title="Save organization discover query">
  Create a new saved query for the given organization.
</Accordion>

<Accordion title="Retrieve user feedback for project">
  Return a list of user feedback items within this project. *this list does not include submissions from the [user feedback widget](https://docs.sentry.io/product/user-feedback/#user-feedback-widget). this is because it is based on an older format called user reports - read more [here](https://develop.sentry.dev/application/feedback-architecture/#user-reports). to return a list of user feedback items from the widget, please use the [issue api](https://docs.sentry.io/api/events/list-a-projects-issues/)* with the filter `issue.category:feedback`.\*
</Accordion>

<Accordion title="Update external user for organization">
  Update a user in an external provider that is currently linked to a sentry user.
</Accordion>

<Accordion title="Update external team integration">
  Update a team in an external provider that is currently linked to a sentry team.
</Accordion>

<Accordion title="Retrieve user via scim api">
  Query an individual organization member with a scim user get request. - the `name` object will contain fields `firstname` and `lastname` with the values of `n/a`. sentry's scim api does not currently support these fields but returns them for compatibility purposes.
</Accordion>

<Accordion title="List organization releases">
  Return a list of releases for a given organization.
</Accordion>

<Accordion title="Retrieve release commits">
  List a project release's commits.
</Accordion>

<Accordion title="Retrieve organization replays">
  Return a list of replays belonging to an organization.
</Accordion>

<Accordion title="Retrieve team info via organization id or slug">
  Return details on an individual team.
</Accordion>

<Accordion title="Submit notification action api data">
  Creates a new notification action for spike protection. notification actions notify a set of members when an action has been triggered through a notification service such as slack or sentry. for example, organization owners and managers can receive an email when a spike occurs.
</Accordion>

<Accordion title="Submit project user feedback">
  *this endpoint is deprecated. we document it here for older sdks and users who are still migrating to the [user feedback widget](https://docs.sentry.io/product/user-feedback/#user-feedback-widget) or [api](https://docs.sentry.io/platforms/javascript/user-feedback/#user-feedback-api)(multi-platform). if you are a new user, do not use this endpoint - unless you don't have a js frontend, and your platform's sdk does not offer a feedback api.* feedback must be received by the server no more than 30 minutes after the event was saved. additionally, within 5 minutes of submitting feedback it may also be overwritten. this is useful in situations where you may need to retry sending a request due to network failures. if feedback is rejected due to a mutability threshold, a 409 status code will be returned. note: feedback may be submitted with dsn authentication (see auth documentation).
</Accordion>

<Accordion title="Retrieve organization member">
  Retrieve an organization member's details. response will be a pending invite if it has been approved by organization owners or managers but is waiting to be accepted by the invitee.
</Accordion>

<Accordion title="Update issue attributes in organization">
  Updates an individual issue's attributes. only the attributes submitted are modified.
</Accordion>

<Accordion title="Update project details">
  Update various attributes and configurable settings for the given project. note that solely having the **`project:read`** scope restricts updatable settings to `isbookmarked`.
</Accordion>

<Accordion title="Update organization member role">
  Update a member's [organization-level](https://docs.sentry.io/organization/membership/#organization-level-roles) and [team-level](https://docs.sentry.io/organization/membership/#team-level-roles) roles. note that for changing organization-roles, this endpoint is restricted to [user auth tokens](https://docs.sentry.io/account/auth-tokens/#user-auth-tokens). additionally, both the original and desired organization role must have the same or lower permissions than the role of the organization user making the request for example, an organization manager may change someone's role from member to manager, but not to owner.
</Accordion>

<Accordion title="Modify organization notification action">
  Updates a spike protection notification action. notification actions notify a set of members when an action has been triggered through a notification service such as slack or sentry. for example, organization owners and managers can receive an email when a spike occurs.
</Accordion>

<Accordion title="Retrieve dsym files for project">
  Retrieve a list of debug information files for a given project.
</Accordion>

<Accordion title="List organization repositories">
  Return a list of version control repositories for a given organization.
</Accordion>

<Accordion title="Modify organization monitor data">
  Update a monitor.
</Accordion>

<Accordion title="Update organization alert rules">
  Updates a metric alert rule. see **metric alert rule types** under [create a metric alert rule for an organization](/api/alerts/create-a-metric-alert-rule-for-an-organization/#metric-alert-rule-types) to see valid request body configurations for different types of metric alert rule types. > warning: calling this endpoint fully overwrites the specified metric alert. a metric alert rule is a configuration that defines the conditions for triggering an alert. it specifies the metric type, function, time interval, and threshold values that determine when an alert should be triggered. metric alert rules are used to monitor and notify you when certain metrics, like error count, latency, or failure rate, cross a predefined threshold. these rules help you proactively identify and address issues in your project.
</Accordion>

<Accordion title="Update project key configuration">
  Update various settings for a client key.
</Accordion>

<Accordion title="Patch scim group operations">
  Update a team's attributes with a scim group patch request.
</Accordion>

<Accordion title="Retrieve files for release">
  Return a list of files for a given release.
</Accordion>

<Accordion title="Get organization stats summary">
  Query summarized event counts by project for your organization. also see [https://docs.sentry.io/api/organizations/retrieve-event-counts-for-an-organization-v2/](https://docs.sentry.io/api/organizations/retrieve-event-counts-for-an-organization-v2/) for reference.
</Accordion>

<Accordion title="Update project issue status and details">
  Bulk mutate various attributes on issues. the list of issues to modify is given through the `id` query parameter. it is repeated for each issue that should be modified. - for non-status updates, the `id` query parameter is required. - for status updates, the `id` query parameter may be omitted for a batch "update all" query. - an optional `status` query parameter may be used to restrict mutations to only events with the given status. the following attributes can be modified and are supplied as json object in the body: if any ids are out of scope this operation will succeed without any data mutation.
</Accordion>

<Accordion title="Update organization dashboard">
  Edit an organization's custom dashboard as well as any bulk edits on widgets that may have been made. (for example, widgets that have been rearranged, updated queries and fields, specific display types, and so on.)
</Accordion>

<Accordion title="Retrieve org integration config">
  Get integration provider information about all available integrations for an organization.
</Accordion>

<Accordion title="Retrieve event id for organization">
  This resolves an event id to the project slug and internal issue id and internal event id.
</Accordion>

<Accordion title="Modify release file attributes">
  Update an organization release file.
</Accordion>

<Accordion title="Retrieve organization monitors">
  Lists monitors, including nested monitor environments. may be filtered to a project or environment.
</Accordion>

<Accordion title="Retrieve organization scim groups">
  Returns a paginated list of teams bound to a organization with a scim groups get request. note that the members field will only contain up to 10,000 members.
</Accordion>

<Accordion title="Retrieve project environments">
  Lists a project's environments.
</Accordion>

<Accordion title="Retrieve organization stats v2">
  Query event counts for your organization. select a field, define a date range, and group or filter by columns.
</Accordion>

<Accordion title="Retrieve organization projects">
  Return a list of projects bound to a organization.
</Accordion>

<Accordion title="Modify organization settings">
  Update various attributes and configurable settings for the given organization.
</Accordion>

<Accordion title="Update webhook configuration xp">
  Update a service hook.
</Accordion>

<Accordion title="Update project rule by id">
  Updates an issue alert rule. > warning: calling this endpoint fully overwrites the specified issue alert. an issue alert rule triggers whenever a new event is received for any issue in a project that matches the specified alert conditions. these conditions can include a resolved issue re-appearing or an issue affecting many users. alert conditions have three parts: - triggers - specify what type of activity you'd like monitored or when an alert should be triggered. - filters - help control noise by triggering an alert only if the issue matches the specified criteria. - actions - specify what should happen when the trigger conditions are met and the filters match.
</Accordion>

<Accordion title="Update project release file details">
  Update a project release file.
</Accordion>

<Accordion title="Update saved query for organization">
  Modify a saved query.
</Accordion>

<Accordion title="Upload file to project release">
  Upload a new file for the given release. unlike other api requests, files must be uploaded using the traditional multipart/form-data content-type. requests to this endpoint should use the region-specific domain eg. `us.sentry.io` or `de.sentry.io` the optional 'name' attribute should reflect the absolute path that this file will be referenced as. for example, in the case of javascript you might specify the full web uri.
</Accordion>

<Accordion title="Update project ownership settings">
  Updates ownership configurations for a project. note that only the attributes submitted are modified.
</Accordion>

<Accordion title="Update release details for organization">
  Update a release. this can change some metadata associated with the release (the ref, url, and dates).
</Accordion>

<Accordion title="Update project monitor">
  Update a monitor.
</Accordion>

<Accordion title="Update team information by organization id">
  Update various attributes and configurable settings for the given team.
</Accordion>

<Accordion title="Update user email">
  Update a primary email address
</Accordion>

<Accordion title="Upload release file to organization">
  Upload a new file for the given release. unlike other api requests, files must be uploaded using the traditional multipart/form-data content-type. requests to this endpoint should use the region-specific domain eg. `us.sentry.io` or `de.sentry.io`. the optional 'name' attribute should reflect the absolute path that this file will be referenced as. for example, in the case of javascript you might specify the full web uri.
</Accordion>

<Accordion title="Upload dsyms file to project">
  Upload a new debug information file for the given release. unlike other api requests, files must be uploaded using the traditional multipart/form-data content-type. requests to this endpoint should use the region-specific domain eg. `us.sentry.io` or `de.sentry.io`. the file uploaded is a zip archive of an apple .dsym folder which contains the individual debug images. uploading through this endpoint will create different files for the contained images.
</Accordion>

<Accordion title="Update symbol source settings">
  Update a custom symbol source in a project.
</Accordion>

<Accordion title="View organization notification actions">
  Returns all spike protection notification actions for an organization. notification actions notify a set of members when an action has been triggered through a notification service such as slack or sentry. for example, organization owners and managers can receive an email when a spike occurs. you can use either the `project` or `projectslug` query parameter to filter for certain projects. note that if both are present, `projectslug` takes priority.
</Accordion>


# Serpapi
Source: https://docs.push.ai/integrations/serpapi



SerpApi provides a real-time API for structured search engine results, allowing developers to scrape, parse, and analyze SERP data for SEO and research

<Accordion title="Google Events Search">
  The eventsearch class allows you to scrape serp results from a google events search query. it performs an event search using the serp api, fetching event-related information such as concerts, festivals, and other happenings based on the input query.
</Accordion>

<Accordion title="SERP API Finance Search">
  The financesearch class performs a financial search using the serp api, to target financial data and stock information. it uses the google finance search engine through the serp api to fetch relevant financial information based on the input query.
</Accordion>

<Accordion title="DuckDuckGo Search">
  Duckduckgo api allows you to scrape serp results from a duckduckgo search query. the duckduckgosearch class performs a search using the serp api, targeting web information and details. it uses the duckduckgo search engine through the serp api to fetch relevant web information based on the input query.
</Accordion>

<Accordion title="SERP API Search">
  Perform a google search using the serp api.
</Accordion>

<Accordion title="SERP API Trends Search">
  The trendssearch class performs a trend search using the serp api, to target trend data and information. it uses the google trends search engine through the serp api to fetch relevant trend information based on the input query.
</Accordion>

<Accordion title="SERP API Shopping Search">
  The shoppingsearch class performs a product search using the serp api.it specifically target shopping results related to the given query. by utilizing the google shopping search engine through the serp api, it fetches the most relevant product listings based on the input query. the `shoppingsearch` class is particularly useful for applications that need to retrieve and display the latest product listings and shopping results for a specific item. it leverages the powerful search capabilities of google's shopping search engine, ensuring that the returned results are current and relevant.
</Accordion>

<Accordion title="SERP API Image Search">
  The imagesearch class performs an image search using the serp api, to target image data and information. it uses the google images search engine through the serp api to fetch relevant image information based on the input query.
</Accordion>

<Accordion title="SERP API Scholar Search">
  Scholar api allows you to scrape serp results from a google scholar search query. the scholarsearch class performs an academic search using the serp api, academic papers and scholarly articles. it uses the google scholar search engine through the serp api to fetch relevant academic information based on the input query.
</Accordion>

<Accordion title="SERP API Google Maps Search">
  The googlemapssearch class performs a location-specific search using the serp api. this class extends the functionality of the base action class to specifically target locations related to the given query. by utilizing the google maps search engine through the serp api, it fetches the most relevant location data based on the input query. the `googlemapssearch` class is particularly useful for applications that need to retrieve and display location information about a specific area. it leverages the powerful search capabilities of google's maps search engine, ensuring that the returned results are accurate and relevant.
</Accordion>

<Accordion title="SERP API News Search">
  The newssearch class performs a news-specific search using the serp api. this class extends the functionality of the base action class to specifically target news articles related to the given query. by utilizing the google news search engine through the serp api, it fetches the most relevant news articles based on the input query. the `newssearch` class is particularly useful for applications that need to retrieve and display the latest news articles about a specific topic. it leverages the powerful search capabilities of google's news search engine, ensuring that the returned results are current and relevant.
</Accordion>


# Servicenow
Source: https://docs.push.ai/integrations/servicenow



Servicenow provides IT Service Management Transform service management to boost productivity and maximize ROI

<Accordion title="Create a record">
  Creates a new record in a specified servicenow table. this endpoint allows you to create a new record with the provided data in the specified table.
</Accordion>

<Accordion title="Delete a record">
  Deletes a record from a specified servicenow table. this endpoint allows you to delete a record with the provided id from the specified table.
</Accordion>

<Accordion title="Find file">
  Finds a file in a specified servicenow table. this endpoint allows you to find a file with the provided name in the specified table.
</Accordion>

<Accordion title="Get records">
  Retrieves a record from a specified servicenow table. this endpoint allows you to retrieve a record with the provided id from the specified table.
</Accordion>

<Accordion title="Attach file to record">
  Attaches a file to a specified record in a servicenow table. this endpoint allows you to attach a file with the provided details to the specified record.
</Accordion>


# Share point
Source: https://docs.push.ai/integrations/share_point



SharePoint is a Microsoft platform for document management and intranets, enabling teams to collaborate, store, and organize content securely and effectively

<Accordion title="Create SharePoint Folder">
  Creates a new folder in sharepoint using the rest api.
</Accordion>

<Accordion title="Create SharePoint List">
  Creates a new list in sharepoint using the rest api.
</Accordion>

<Accordion title="Find SharePoint User">
  Finds a user in both microsoft graph and sharepoint to verify their existence and status.
</Accordion>

<Accordion title="Create SharePoint User">
  Creates a new user in sharepoint.
</Accordion>

<Accordion title="Remove SharePoint User">
  Removes a user from sharepoint. will not fail if user doesn't exist.
</Accordion>

<Accordion title="Create SharePoint List Item">
  Creates a new item in a sharepoint list.
</Accordion>


# Shopify
Source: https://docs.push.ai/integrations/shopify



A leading global commerce platform that allows anyone to sell online
and in person.

<Accordion title="Create Custom Collection">
  Creates a custom collection in shopify.
</Accordion>

<Accordion title="Get Collects Count">
  Retrieves the count of collects from shopify.
</Accordion>

<Accordion title="Get Collects">
  Retrieves a list of collects from shopify.
</Accordion>

<Accordion title="Count Product Images">
  Gets a count of all product images from shopify.
</Accordion>

<Accordion title="Add Product to Collection">
  Adds a product to a custom collection in shopify.
</Accordion>

<Accordion title="Get Customer Orders">
  Retrieves a complete list of orders associated with a specific customer from shopify. this action makes a get request to shopify's api to fetch all orders placed by a customer, identified by their customer id. the response includes full order details such as order items, shipping information, payment status, etc. returns: getcustomerordersresponse containing the raw json response from shopify's api
</Accordion>

<Accordion title="Get Custom Collections">
  Retrieves a list of custom collections from shopify.
</Accordion>

<Accordion title="Create Order">
  Creates an order on shopify.
</Accordion>

<Accordion title="Get Custom Collections Count">
  Retrieves the count of custom collections from shopify.
</Accordion>

<Accordion title="Get Customer">
  Retrieves a customer from shopify by customer id.
</Accordion>

<Accordion title="Get Orders by id">
  Gets a list of all orders from shopify.
</Accordion>

<Accordion title="Get Product Images">
  Gets a list of all product images from shopify.
</Accordion>

<Accordion title="Get Order List">
  Gets a list of all orders from shopify.
</Accordion>

<Accordion title="Get Shop Details">
  Gets the details of a shop in shopify.
</Accordion>

<Accordion title="Get Product">
  Retrieves a single product from shopify.
</Accordion>

<Accordion title="Create Product">
  Creates a product on shopify.
</Accordion>

<Accordion title="Update Order">
  Updates an order on shopify.
</Accordion>

<Accordion title="Delete Custom Collection">
  Deletes a custom collection in shopify.
</Accordion>

<Accordion title="Get Products">
  Retrieves a list of products from shopify.
</Accordion>

<Accordion title="Delete Product">
  Deletes a product from shopify.
</Accordion>

<Accordion title="Delete Product Image">
  Deletes a product image from shopify.
</Accordion>

<Accordion title="Get Products Count">
  Retrieves the count of products from shopify.
</Accordion>

<Accordion title="Get Products In Collection">
  Retrieves a list of products belonging to a specific collection from shopify.
</Accordion>

<Accordion title="Get All Customers">
  Retrieves all customers or specified customers from shopify.
</Accordion>

<Accordion title="Get Product Image">
  Gets a single product image from shopify.
</Accordion>

<Accordion title="Get Collect By ID">
  Retrieves a specific collect by its id from shopify.
</Accordion>


# Shortcut
Source: https://docs.push.ai/integrations/shortcut



Shortcut aligns product development work with company objectives so teams can execute with a shared purpose.

<Accordion title="Create label">
  Create label allows you to create a new label in shortcut.
</Accordion>

<Accordion title="Create epic comment comment">
  This endpoint allows you to create a nested comment reply to an existing epic comment.
</Accordion>

<Accordion title="Create group">
  Creates a new group in the shortcut system with customizable properties. this endpoint allows you to set up a group with a unique mention name, display name, optional description, and various customization options. use this when you need to establish a new team, department, or any other collective within your shortcut workspace. the created group can include members, associated workflows, and visual customizations like color and icon. this endpoint is particularly useful for organizing your shortcut workspace structure, facilitating team collaboration, and streamlining workflow management. note that while member and workflow associations can be set during creation, they can also be modified later using separate endpoints.
</Accordion>

<Accordion title="Create iteration">
  The createiteration endpoint allows you to create a new iteration in shortcut, which represents a time-boxed period for completing a set of stories or tasks. this endpoint is crucial for teams using agile methodologies, enabling them to plan and track progress over specific time periods. use this endpoint when setting up sprint cycles, planning releases, or organizing work into manageable timeframes. the endpoint requires essential information such as the iteration's name and date range, while also offering options to add followers, associate groups, and attach labels for better organization and tracking. it's important to note that while multiple groups can be added via the api, the current web ui only displays one group association. this endpoint should not be used for modifying existing iterations; instead, use the dedicated update endpoint for such changes.
</Accordion>

<Accordion title="Create milestone">
  (deprecated: use 'create objective') create milestone allows you to create a new milestone in shortcut.
</Accordion>

<Accordion title="Create epic comment">
  This endpoint allows you to create a threaded comment on an epic.
</Accordion>

<Accordion title="Create linked file">
  Create linked file allows you to create a new linked file in shortcut.
</Accordion>

<Accordion title="Create story comment">
  Create comment allows you to create a comment on any story.
</Accordion>

<Accordion title="Create story reaction">
  Create a reaction to a story comment.
</Accordion>

<Accordion title="Delete category">
  Delete category can be used to delete any category.
</Accordion>

<Accordion title="Create task">
  Create task is used to create a new task in a story.
</Accordion>

<Accordion title="Create story link">
  Story links (called story relationships in the ui) allow you create semantic relationships between two stories. the parameters read like an active voice grammatical sentence: subject -> verb -> object. the subject story acts on the object story; the object story is the direct object of the sentence. the subject story "blocks", "duplicates", or "relates to" the object story. examples: - "story 5 blocks story 6” -- story 6 is now "blocked" until story 5 is moved to a done workflow state. - "story 2 duplicates story 1” -- story 2 represents the same body of work as story 1 (and should probably be archived). - "story 7 relates to story 3”
</Accordion>

<Accordion title="Delete epic">
  Delete epic can be used to delete the epic. the only required parameter is epic id.
</Accordion>

<Accordion title="Delete custom field">
  Deletes a specific custom field from the shortcut system using its unique public identifier. this endpoint should be used when you need to permanently remove a custom field that is no longer required in your workflows or project structure. it's important to note that this operation is irreversible, and once a custom field is deleted, all data associated with it will be lost. use this endpoint with caution, ensuring that the custom field is no longer needed and that its deletion won't negatively impact any existing processes or data integrity within your shortcut instance.
</Accordion>

<Accordion title="Delete epic comment">
  This endpoint allows you to delete a comment from an epic.
</Accordion>

<Accordion title="Delete entity template">
  Deletes a specific entity template from the shortcut api. this endpoint should be used when you need to permanently remove a template that is no longer needed or is obsolete. it's important to note that this operation cannot be undone, so it should be used with caution. the deletion is performed on a single template identified by its public id, adhering to the best practice of controlling deletion on a per-resource basis. this endpoint is part of the api v3, which may include enhanced features or changes compared to previous versions.
</Accordion>

<Accordion title="Create category">
  Create category allows you to create a new category in shortcut.
</Accordion>

<Accordion title="Delete file">
  Delete file deletes a previously uploaded file.
</Accordion>

<Accordion title="Delete label">
  Delete label can be used to delete any label.
</Accordion>

<Accordion title="Delete linked file">
  Delete linked file can be used to delete any previously attached linked-file.
</Accordion>

<Accordion title="Delete iteration">
  Deletes a specific iteration from the shortcut project management system. this endpoint should be used when you need to permanently remove an iteration and all its associated data from your project workflow. it's particularly useful for cleaning up completed or cancelled iterations that are no longer needed. be cautious when using this endpoint, as the deletion is irreversible and will remove all data associated with the specified iteration. ensure you have the correct iteration id before proceeding with the deletion to avoid unintended data loss.
</Accordion>

<Accordion title="Create story">
  Create story is used to add a new story to your shortcut workspace. this endpoint requires that either **workflow state id** or **project id** be provided, but will reject the request if both or neither are specified. the workflow state id has been marked as required and is the recommended field to specify because we are in the process of sunsetting projects in shortcut.
</Accordion>

<Accordion title="Delete milestone">
  (deprecated: use 'delete objective') delete milestone can be used to delete any milestone.
</Accordion>

<Accordion title="Create multiple stories">
  Create multiple stories allows you to create multiple stories in a single request using the same syntax as [create story](https://developer.shortcut.com/api/rest/v3#create-story).
</Accordion>

<Accordion title="Delete multiple stories">
  Delete multiple stories allows you to delete multiple archived stories at once.
</Accordion>

<Accordion title="Delete story">
  Delete story can be used to delete any story.
</Accordion>

<Accordion title="Create story from template">
  Create story from template is used to add a new story derived from a template to your shortcut workspace.
</Accordion>

<Accordion title="Delete objective">
  Delete objective can be used to delete any objective.
</Accordion>

<Accordion title="Delete story comment">
  Delete a comment from any story.
</Accordion>

<Accordion title="Delete project">
  Delete project can be used to delete a project. projects can only be deleted if all associated stories are moved or deleted. in the case that the project cannot be deleted, you will receive a 422 response.
</Accordion>

<Accordion title="Delete story link">
  Removes the relationship between the stories for the given story link.
</Accordion>

<Accordion title="Create objective">
  Create objective allows you to create a new objective in shortcut.
</Accordion>

<Accordion title="Delete story reaction">
  Delete a reaction from any story comment.
</Accordion>

<Accordion title="Disable story templates">
  Disables the story template feature for the workspace.
</Accordion>

<Accordion title="Delete task">
  Delete task can be used to delete any previously created task on a story.
</Accordion>

<Accordion title="Disable iterations">
  Disables iterations for the current workspace
</Accordion>

<Accordion title="Create project">
  Create project is used to create a new shortcut project.
</Accordion>

<Accordion title="Create entity template">
  Create a new entity template for the workspace.
</Accordion>

<Accordion title="Create epic">
  Create epic allows you to create a new epic in shortcut.
</Accordion>

<Accordion title="Get category">
  Get category returns information about the selected category.
</Accordion>

<Accordion title="Get custom field">
  Retrieves detailed information about a specific custom field in shortcut using its unique public identifier. this endpoint allows developers to fetch the properties and configuration of a custom field, which can include its name, type, possible values, and any other associated metadata. it's particularly useful when you need to inspect or validate a custom field's settings programmatically, or when integrating custom field data into external systems. the endpoint should be used when detailed information about a single custom field is required, rather than for bulk operations or listing all custom fields. note that this endpoint only provides read access to custom field data and cannot be used to modify the custom field.
</Accordion>

<Accordion title="Get current member info">
  Returns information about the authenticated member.
</Accordion>

<Accordion title="Enable iterations">
  Enables iterations for the current workspace
</Accordion>

<Accordion title="Enable story templates">
  Enables the story template feature for the workspace.
</Accordion>

<Accordion title="List epics">
  List epics returns a list of all epics and their attributes.
</Accordion>

<Accordion title="Get epic">
  Get epic returns information about the selected epic.
</Accordion>

<Accordion title="List repositories">
  List repositories returns a list of all repositories and their attributes.
</Accordion>

<Accordion title="List epic comments">
  Get a list of all comments on an epic.
</Accordion>

<Accordion title="Get repository">
  Get repository returns information about the selected repository.
</Accordion>

<Accordion title="Get project">
  Get project returns information about the selected project.
</Accordion>

<Accordion title="Get objective">
  Get objective returns information about a chosen objective.
</Accordion>

<Accordion title="List label stories">
  List all of the stories with the label.
</Accordion>

<Accordion title="Update category">
  Update category allows you to replace a category name with another name. if you try to name a category something that already exists, you will receive a 422 response.
</Accordion>

<Accordion title="Unlink productboard from epic">
  This endpoint allows you to unlink a productboard epic.
</Accordion>

<Accordion title="Get entity template">
  Get entity template returns information about a given entity template.
</Accordion>

<Accordion title="Search milestones">
  Search milestones lets you search milestones based on desired parameters. since ordering of results can change over time (due to search ranking decay, new milestones being created), the `next` value from the previous response can be used as the path and query string for the next page to ensure stable ordering.
</Accordion>

<Accordion title="List epic stories">
  Get a list of all stories in an epic.
</Accordion>

<Accordion title="Get epic workflow">
  Returns the epic workflow for the workspace.
</Accordion>

<Accordion title="Update multiple stories">
  Update multiple stories allows you to make changes to numerous stories at once.
</Accordion>

<Accordion title="List linked files">
  List linked files returns a list of all linked-files and their attributes.
</Accordion>

<Accordion title="Update story link">
  Updates the stories and/or the relationship for the given story link.
</Accordion>

<Accordion title="Update custom field">
  Update custom field can be used to update the definition of a custom field. the order of items in the 'values' collection is interpreted to be their ascending sort order.to delete an existing enum value, simply omit it from the 'values' collection. new enum values may be created inline by including an object in the 'values' collection having a 'value' entry with no 'id' (eg. \{'value': 'mynewvalue', 'color key': 'green'}).
</Accordion>

<Accordion title="Update group">
  Updates an existing group in the shortcut workspace. this endpoint allows you to modify various properties of a group, including its name, description, color, members, and associated workflows. use this when you need to change group details, add or remove members, or update the group's visual representation. it's particularly useful for team reorganizations, project changes, or general maintenance of your shortcut workspace structure. note that while many fields are optional, you should include any fields you wish to modify; omitted fields will retain their current values.
</Accordion>

<Accordion title="Get epic comment">
  This endpoint returns information about the selected epic comment.
</Accordion>

<Accordion title="Update entity template">
  Update an entity template's name or its contents.
</Accordion>

<Accordion title="Get external link stories">
  Get stories which have a given external link associated with them.
</Accordion>

<Accordion title="Update objective">
  Update objective can be used to update objective properties.
</Accordion>

<Accordion title="Update story comment">
  Update comment replaces the text of the existing comment.
</Accordion>

<Accordion title="List stories">
  List stories returns a list of all stories in a selected project and their attributes.
</Accordion>

<Accordion title="List story comment">
  Lists comments associated with a story
</Accordion>

<Accordion title="Update project">
  Update project can be used to change properties of a project.
</Accordion>

<Accordion title="Update milestone">
  (deprecated: use 'update objective') update milestone can be used to update milestone properties.
</Accordion>

<Accordion title="Get story">
  Get story returns information about a chosen story.
</Accordion>

<Accordion title="Upload files">
  Upload files uploads one or many files and optionally associates them with a story. use the multipart/form-data content-type to upload. each `file` key should contain a separate file. each uploadedfile's name comes from the content-disposition header "filename" directive for that field.
</Accordion>

<Accordion title="Get file">
  Get file returns information about the selected uploadedfile.
</Accordion>

<Accordion title="List workflows">
  Returns a list of all workflows in the workspace.
</Accordion>

<Accordion title="Update task">
  Update task can be used to update task properties.
</Accordion>

<Accordion title="List members">
  Returns information about members of the workspace.
</Accordion>

<Accordion title="List files">
  List files returns a list of all uploadedfiles in the workspace.
</Accordion>

<Accordion title="Get story comment">
  Get comment is used to get comment information.
</Accordion>

<Accordion title="Update story">
  Update story can be used to update story properties.
</Accordion>

<Accordion title="Update epic">
  Update epic can be used to update numerous fields in the epic. the only required parameter is epic id, which can be found in the shortcut ui.
</Accordion>

<Accordion title="Get group">
  Retrieves detailed information about a specific group in the shortcut workspace using its unique public identifier. this endpoint allows developers to fetch comprehensive data about a group, including its name, type, and associated metadata. it's particularly useful when you need to access or verify group details programmatically, such as during workflow automations or when building integrations that involve group management. the endpoint provides more granular control and information compared to what's available through the web application, making it valuable for advanced group-related operations and data analysis within your shortcut projects.
</Accordion>

<Accordion title="Search objectives">
  Search objectives lets you search objectives based on desired parameters. since ordering of results can change over time (due to search ranking decay, new objectives being created), the `next` value from the previous response can be used as the path and query string for the next page to ensure stable ordering.
</Accordion>

<Accordion title="Update epic comment">
  This endpoint allows you to update a threaded comment on an epic.
</Accordion>

<Accordion title="Shortcut Search">
  Search lets you search epics and stories based on desired parameters. since ordering of the results can change over time (due to search ranking decay, new epics and stories being created), the `next` value from the previous response can be used as the path and query string for the next page to ensure stable ordering.
</Accordion>

<Accordion title="Search epics">
  Search epics lets you search epics based on desired parameters. since ordering of stories can change over time (due to search ranking decay, new epics being created), the `next` value from the previous response can be used as the path and query string for the next page to ensure stable ordering.
</Accordion>

<Accordion title="Get story link">
  Returns the stories and their relationship for the given story link.
</Accordion>

<Accordion title="Update iteration">
  This endpoint allows you to update an existing iteration in shortcut. it provides comprehensive control over various aspects of an iteration, including its metadata, associated members and groups, labels, and timeframe. use this endpoint when you need to modify any details of an ongoing or upcoming iteration, such as adjusting dates, adding followers, or updating labels. the endpoint is particularly useful for project managers or team leads who need to refine iteration details as the project progresses. note that while you can update multiple aspects of an iteration in a single call, only the fields you include in the request will be modified; omitted fields will retain their current values.
</Accordion>

<Accordion title="List groups">
  A group in our api maps to a "team" within the shortcut product. a team is a collection of users that can be associated to stories, epics, and iterations within shortcut.
</Accordion>

<Accordion title="Get iteration">
  Retrieves detailed information about a specific iteration in the shortcut project management system. this endpoint allows users to fetch comprehensive data about a single iteration, including its name, status, start and end dates, associated stories, and progress metrics. it should be used when detailed information about a particular iteration is needed, such as during sprint planning, progress tracking, or retrospective analysis. the endpoint provides a snapshot of the iteration at the time of the request and does not include real-time updates. it's particularly useful for project managers, scrum masters, and team members who need to review or report on iteration-specific data. note that this endpoint only retrieves information and does not allow for modification of the iteration details.
</Accordion>

<Accordion title="Get task">
  Returns information about a chosen task.
</Accordion>

<Accordion title="Get key result">
  Get key result returns information about a chosen key result.
</Accordion>

<Accordion title="Search iterations">
  Search iterations lets you search iterations based on desired parameters. since ordering of results can change over time (due to search ranking decay, new iterations being created), the `next` value from the previous response can be used as the path and query string for the next page to ensure stable ordering.
</Accordion>

<Accordion title="Update key result">
  Update key result allows updating a key result's name or initial, observed, or target values.
</Accordion>

<Accordion title="List milestones">
  (deprecated: use 'list objectives') list milestones returns a list of all milestones and their attributes.
</Accordion>

<Accordion title="Update label">
  Update label allows you to replace a label name with another name. if you try to name a label something that already exists, you will receive a 422 response.
</Accordion>

<Accordion title="Get workflow">
  Get workflow returns information about a chosen workflow.
</Accordion>

<Accordion title="List milestone epics">
  (deprecated: use 'list objective epics') list all of the epics within the milestone.
</Accordion>

<Accordion title="List iteration stories">
  Get a list of all stories in an iteration.
</Accordion>

<Accordion title="List labels">
  List labels returns a list of all labels and their attributes.
</Accordion>

<Accordion title="List label epics">
  List all of the epics with the label.
</Accordion>

<Accordion title="List group stories">
  List the stories assigned to the group. (by default, limited to 1,000).
</Accordion>

<Accordion title="Get label">
  Get label returns information about the selected label.
</Accordion>

<Accordion title="List categories">
  List categories returns a list of all categories and their attributes.
</Accordion>

<Accordion title="Search stories">
  Search stories lets you search stories based on desired parameters. since ordering of stories can change over time (due to search ranking decay, new stories being created), the `next` value from the previous response can be used as the path and query string for the next page to ensure stable ordering.
</Accordion>

<Accordion title="List iterations">
  Retrieves a list of all iterations in the shortcut project management system. iterations represent specific time periods for planning and tracking work, allowing teams to organize their development cycles. this endpoint provides comprehensive information about each iteration, including its name, start and end dates, status, and associated stories or tasks. use this endpoint when you need an overview of all iterations for project planning, progress tracking, or reporting purposes. it's particularly useful for analyzing past performance, planning future sprints, or getting a high-level view of the project timeline. note that the response may be paginated for projects with a large number of iterations, and you might need to make multiple requests to retrieve the full dataset.
</Accordion>

<Accordion title="Update linked file">
  Updated linked file allows you to update properties of a previously attached linked-file.
</Accordion>

<Accordion title="List objectives">
  List objectives returns a list of all objectives and their attributes.
</Accordion>

<Accordion title="Story history">
  Retrieves the complete history of changes for a specific story in the shortcut project management system. this endpoint allows users to track all modifications, updates, and revisions made to a story over time, providing a comprehensive timeline of its evolution. it's particularly useful for project managers, team members, and stakeholders who need to understand how a story has changed, who made the changes, and when they occurred. the endpoint returns a chronological list of all events and modifications associated with the specified story, helping teams maintain transparency and accountability in their project workflows. note that this endpoint focuses solely on the history of a single story and does not provide information about related stories or overall project status.
</Accordion>

<Accordion title="List projects">
  List projects returns a list of all projects and their attributes.
</Accordion>

<Accordion title="Get linked file">
  Get file returns information about the selected linked file.
</Accordion>

<Accordion title="List category milestones">
  List category milestones returns a list of all milestones with the category.
</Accordion>

<Accordion title="List category objectives">
  Returns a list of all objectives with the category.
</Accordion>

<Accordion title="List objective epics">
  List all of the epics within the objective.
</Accordion>

<Accordion title="Unlink comment thread from slack">
  Unlinks a comment from its linked slack thread (comment replies and slack replies will no longer be synced)
</Accordion>

<Accordion title="Update file">
  Update file updates the properties of an uploadedfile (but not its content).
</Accordion>

<Accordion title="Get milestone">
  (deprecated: use 'get objective') get milestone returns information about a chosen milestone.
</Accordion>

<Accordion title="List custom fields">
  Retrieves a list of all custom fields defined in the shortcut api. this endpoint allows developers to fetch information about user-defined fields that have been added to extend the functionality of standard fields in integrations. it's particularly useful when you need to understand the structure and types of custom data being used across the system. the endpoint returns details about each custom field, which may include their identifiers, names, types, and any associated metadata. use this endpoint when you need to inventory existing custom fields, prepare for data migrations, or dynamically adjust your application's data model to accommodate custom fields. note that this endpoint does not create, modify, or delete custom fields; it's purely for retrieval of existing custom field definitions.
</Accordion>

<Accordion title="Search stories old">
  Search stories lets you search stories based on desired parameters.
</Accordion>

<Accordion title="Get member">
  Returns information about a member.
</Accordion>

<Accordion title="List entity templates">
  List all the entity templates for the workspace.
</Accordion>


# Simplesat
Source: https://docs.push.ai/integrations/simplesat



Simplesat captures customer feedback and CSAT scores through surveys, integrating directly with helpdesk systems for real-time performance insights

<Accordion title="Create or Update Customer">
  This tool creates or updates a customer in simplesat. if a customer with the provided email address already exists, their information is updated; otherwise, a new customer is created.
</Accordion>

<Accordion title="Create or Update Team Member">
  This tool creates a new team member or updates an existing one if a team member with the same email address is found. it is an independent action that requires only basic team member information (email, first name, last name, and optionally title and phone) and does not depend on any other resource ids.
</Accordion>


# Slack
Source: https://docs.push.ai/integrations/slack



Slack is a channel-based messaging platform. With Slack, people can work together more effectively, connect all their software tools and services, and find the information they need to do their best work — all within a secure, enterprise-grade environment.

<Accordion title="Set snooze duration via minutes">
  Sets a temporary "do not disturb" (dnd) snooze period for the authenticated user in slack. this endpoint allows you to programmatically pause notifications for a specified duration, helping users maintain focus without interruptions. the snooze period starts immediately upon successful api call and lasts for the number of minutes specified. this is particularly useful for integrations that manage user availability or for creating custom dnd controls within your slack-connected applications. note that this will override any existing dnd settings for the user.
</Accordion>

<Accordion title="Add emoji alias">
  This endpoint allows slack workspace administrators to create an alias for an existing emoji within an enterprise grid organization. it's used to give alternative names to emojis, making them easier to find or use. this is particularly useful for creating shortcuts to frequently used emojis or standardizing emoji names across teams. the alias will function identically to the original emoji. note that this endpoint is only available for enterprise grid customers and requires administrative privileges. it does not create new emojis, but rather creates new ways to reference existing ones.
</Accordion>

<Accordion title="Approve invite request for team">
  The admin.inviterequests.approve endpoint allows workspace administrators to approve pending invite requests for their slack workspace. this method is used to grant access to individuals who have requested to join the workspace. it's particularly useful for managing access in controlled or private workspaces where new member additions require explicit approval. the endpoint should be used when an administrator has reviewed and decided to accept an invite request. it's important to note that this action is irreversible, and once approved, the invited user will gain access to the workspace. this endpoint is not for creating new invite requests or for bulk approvals; it processes one invite request at a time.
</Accordion>

<Accordion title="Restrict access by group in private channel">
  This endpoint adds an identity provider (idp) group to a private channel's allowlist in slack, restricting access to only members of the specified group. it's designed for enterprise grid workspaces to enhance security and access control. use this when you need to limit channel access to specific groups within your organization. the endpoint is particularly useful for creating secure communication spaces for teams or projects with sensitive information. note that this operation only applies to private channels and requires administrative privileges.
</Accordion>

<Accordion title="Approve admin apps request">
  The admin.apps.approve endpoint is used to approve an app installation request in a slack workspace or across an entire enterprise. this method allows administrators to grant permission for a specific app to be installed or used within their slack environment. it is primarily used in enterprise grid workspaces where app installations require admin approval for security and compliance reasons. the endpoint should be used when an administrator needs to review and approve a pending app installation request, either for a single workspace or organization-wide. it requires admin-level permissions and can only be executed by users with appropriate administrative access. this method is crucial for maintaining control over the apps used within a slack organization and ensuring that only approved apps are allowed to integrate with the workspace.
</Accordion>

<Accordion title="Add star to channel message">
  The 'stars.add' endpoint allows users to add a star to various items within slack, including channels, files, file comments, or specific messages. this method is used to mark items for later reference or to indicate importance. it's particularly useful for creating personal bookmarks or highlighting significant content within the slack workspace. the endpoint is flexible, allowing users to star different types of content by specifying the appropriate parameters. however, users should be aware that only one type of item (channel, file, file comment, or message) can be starred per api call. this endpoint should be used when users want to programmatically add stars to slack items, which can be helpful for integrations or automating workspace organization.
</Accordion>

<Accordion title="Add channels to usergroup">
  Adds default channels to a specified user group in a slack workspace. this endpoint allows administrators to automatically include members of a user group in designated channels, streamlining onboarding and ensuring consistent access to relevant information. it's particularly useful for setting up standard channel memberships for different roles or departments within an organization. the endpoint should be used when configuring or updating user group settings, especially after creating a new user group or when organizational changes require adjustments to default channel memberships. note that this operation adds to, rather than replaces, any existing default channels for the user group.
</Accordion>

<Accordion title="Add reaction to message">
  Adds a reaction (emoji) to a specific message in a slack channel. this endpoint allows users to interact with messages by adding emojis as reactions, enhancing engagement and communication within slack. it should be used when a user wants to express a quick response or sentiment to a message without sending a new message. the endpoint requires specifying the target channel, the emoji name, and the timestamp of the message to react to. it's important to note that the user must have access to the specified channel and message, and the emoji must be available in the slack workspace. this endpoint does not support removing reactions or retrieving existing reactions on a message.
</Accordion>

<Accordion title="Assign user to workspace">
  This endpoint assigns a user to a specific slack workspace with customizable access levels. it allows administrators to add a user to a workspace as a regular member, a guest (restricted), or a single-channel guest (ultra-restricted). the endpoint also provides the option to automatically add the user to specific channels upon assignment. use this when you need to programmatically add users to a workspace with precise control over their access rights and initial channel memberships. it's particularly useful for large-scale user management or when integrating slack with external user management systems. note that this endpoint requires appropriate admin permissions to execute successfully.
</Accordion>

<Accordion title="Add remote file with authentication token">
  The 'files.remote.add' endpoint allows you to add a remote file to slack, making it accessible and shareable within the platform. this method is used when you want to integrate external files into slack conversations without uploading the actual file content to slack's servers. it's particularly useful for large files, frequently updated documents, or content that needs to remain hosted externally. the endpoint creates a reference to the external file, allowing slack users to view and interact with it as if it were a native slack file. note that this method only creates a link to the file; it does not duplicate or store the file content on slack's infrastructure.
</Accordion>

<Accordion title="Add admin emoji">
  Adds a custom emoji to a slack workspace. this endpoint allows workspace administrators to upload new emojis that can be used by all members in messages and reactions. it requires specifying a unique name for the emoji and providing a url to the image file. the function is useful for personalizing a workspace with brand-specific or team-specific emojis. note that there may be limits on the total number of custom emojis allowed in a workspace, and overuse can impact performance. use this endpoint when you need to programmatically add new emojis to enhance team communication and expression.
</Accordion>

<Accordion title="Archive conversations channel">
  The admin.conversations.archive endpoint allows workspace administrators to archive a specific slack channel. this action preserves the channel's content in a read-only state, preventing further messages from being posted while retaining historical data. use this endpoint when you need to close a channel that is no longer active or relevant, but want to keep its contents accessible for reference. it's important to note that archiving a channel is reversible; archived channels can be unarchived if needed. however, exercise caution when using this endpoint, as it affects all members of the channel and may impact ongoing conversations or workflows.
</Accordion>

<Accordion title="List permissions scopes for apps">
  Retrieves a list of oauth scopes associated with the authenticated slack app. this endpoint allows developers to view the current permissions granted to their app within a slack workspace. it's particularly useful for auditing app permissions, verifying the app's access levels, or preparing for permission changes. the endpoint returns all scopes the app has been granted, which can include both bot and user token scopes. it should be used when you need to review or confirm the current set of permissions for your slack app. note that this endpoint does not modify any permissions; it only provides a read-only view of the existing scopes.\<\<DEPRECATED use list\_app\_permissions\_scopes\_on\_a\_team>>
</Accordion>

<Accordion title="Archive conversation endpoint">
  The 'conversations.archive' endpoint archives a specified slack conversation, making it unavailable for new messages while preserving its history. this method can be used for both public and private channels, but not all types of conversations can be archived. use this endpoint when you need to remove a conversation from active use without deleting its content. it's particularly useful for maintaining a clean workspace by archiving inactive or completed project channels. note that archiving a conversation may affect integrations or workflows that depend on it, so use with caution. certain types of conversations, such as general channels or those required by app installations, cannot be archived.
</Accordion>

<Accordion title="Get app permissions info">
  Retrieves detailed information about the permissions granted to a slack application. this endpoint is used to audit and review the current set of permissions associated with an app, helping developers and administrators understand the app's capabilities within a slack workspace. it provides a comprehensive list of all permissions the app has been granted, which is crucial for security audits, troubleshooting, or when preparing to request additional scopes. the endpoint does not modify any permissions; it only returns the current state. note that the permissions returned are specific to the app associated with the authentication token used in the request.\<\<DEPRECATED use list\_app\_permissions\_on\_a\_team>>
</Accordion>

<Accordion title="Add teams to usergroup">
  This endpoint adds one or more teams (workspaces) to a specified user group within a slack organization. it's used to extend the reach of a user group across multiple workspaces, facilitating organization-wide management of user groups. the endpoint is particularly useful for administrators managing large, multi-workspace organizations who need to ensure consistent group membership across teams. it supports auto-provisioning of accounts for external idp group members, streamlining the process of integrating external users into slack workspaces. note that this operation requires admin-level permissions and can only be performed on teams within the same organization as the api token.
</Accordion>

<Accordion title="Api test endpoint">
  The api.test endpoint is a simple method used to test the functionality of the slack api. it allows developers to verify that their authentication credentials are working correctly and that they can successfully connect to the slack platform. this endpoint doesn't perform any specific actions within a slack workspace but instead returns a basic response to confirm that the api is operational. it's particularly useful during initial setup, when troubleshooting connectivity issues, or as part of automated health checks to ensure ongoing api availability. the endpoint requires no parameters and typically returns a minimal json response indicating a successful connection.
</Accordion>

<Accordion title="Auth test api endpoint">
  The auth.test endpoint is used to validate and test the authentication token provided in the request. it verifies the token's validity and returns information about the authenticated user or bot. this endpoint is particularly useful for checking if a token is still valid, identifying the associated user or bot, and determining the scopes granted to the token. it should be used when you need to confirm the authentication status or retrieve basic information about the authenticated entity without making changes to any data. the endpoint does not modify any data or perform any actions beyond authentication verification.
</Accordion>

<Accordion title="Create user group with unique name">
  Creates a new user group in slack, allowing for organized team communication and management. this endpoint is used to set up a group with a unique name, optional description, default channels, and a mention handle. it's particularly useful for creating functional teams, project groups, or department-wide communication channels. the endpoint allows for immediate configuration of the group's default channels and provides options for including member count information. it should be used when setting up new team structures or reorganizing existing communication channels within slack.
</Accordion>

<Accordion title="Add reminder for user">
  The 'reminders.add' endpoint allows you to create new reminders in slack. it's designed to help users set notifications for future tasks, events, or any information they need to remember. this tool is particularly useful for managing personal tasks, setting team reminders, or scheduling follow-ups within slack's collaborative environment. the endpoint offers flexibility in timing, supporting one-time reminders as well as recurring ones through natural language input. while it focuses on creating reminders, it does not provide functionality for listing, modifying, or deleting existing reminders. note that if no specific user is designated, the reminder defaults to the creator, making it versatile for both personal and team use.
</Accordion>

<Accordion title="Create new admin team">
  Creates a new team within a slack enterprise grid workspace. this endpoint allows administrators to set up a new organizational unit, specifying its domain, name, description, and discoverability settings. it's particularly useful for large organizations that need to create separate teams for different departments, projects, or subsidiaries. the endpoint should be used when expanding the workspace structure or setting up new collaborative spaces within the enterprise grid. note that this operation requires administrative privileges and should be used judiciously to maintain a coherent organizational structure.
</Accordion>

<Accordion title="Convert channel to private">
  Converts a specified public slack channel to a private channel. this endpoint allows slack workspace administrators to change the visibility and accessibility of a channel from public to private. once converted, the channel will only be visible and accessible to invited members, enhancing privacy and control over sensitive conversations. this action is irreversible and should be used cautiously, as it may impact team communication and workflows. it's particularly useful for situations where a previously public channel needs to be restricted due to changes in project scope, team structure, or information sensitivity.
</Accordion>

<Accordion title="Post message to channel">
  The chat.postmessage endpoint allows you to send a message to a slack channel or user. this versatile tool can be used to post simple text messages, create rich interactive messages with blocks or attachments, initiate or reply to threads, and customize the appearance of bot messages. it's ideal for sending notifications, updates, or interactive content to slack users or channels programmatically. the endpoint supports extensive customization of message content and appearance, making it suitable for a wide range of use cases from simple notifications to complex interactive workflows. however, it's important to note that the message structure and appearance may vary depending on the slack client and the parameters used.\<\<DEPRECATED use sends\_a\_message\_to\_a\_slack\_channel>>
</Accordion>

<Accordion title="Create public or private channel">
  Creates a new public or private channel (conversation) in a slack workspace or organization. this endpoint allows administrators to programmatically set up channels, specifying whether they should be private or public, team-specific or organization-wide. it's particularly useful for automating workspace setup, creating standardized channels across teams, or implementing custom onboarding processes. the endpoint requires specifying the channel name and privacy setting, with options to add a description and determine the channel's scope within the organization.
</Accordion>

<Accordion title="Modify message unfurl behavior">
  The 'chat.unfurl' endpoint allows you to customize the unfurling behavior for urls within a specific slack message. unfurling expands urls into rich content previews, enhancing message readability and context. use this endpoint when you want to add custom previews for urls in a message or initiate a user authentication flow for certain unfurls. it's particularly useful for integrating external services or providing additional context for shared links. the endpoint requires specifying the target message using channel id and timestamp, and offers options for custom unfurl content and user authentication processes. note that this endpoint modifies existing messages and should be used judiciously to maintain conversation clarity.
</Accordion>

<Accordion title="Close conversation channel">
  The 'conversations.close' endpoint allows you to close a conversation in slack. this method is specifically used to close direct messages (dms) or multi-person direct messages (mpdms). when invoked, it removes the specified conversation from the user's sidebar in the slack client, effectively 'closing' it from their view. this endpoint is particularly useful for decluttering a user's slack workspace by removing inactive or less relevant conversations from immediate view. it's important to note that closing a conversation does not delete it; the conversation history is preserved and can be reopened later if needed. this method should be used judiciously, especially in shared channels or group conversations, as it only affects the view for the user making the api call.
</Accordion>

<Accordion title="Retrieve conversation history">
  Retrieves the message history of a specified slack conversation or channel. this endpoint allows you to fetch a chronological list of messages and events that have occurred within a channel, group, or direct message conversation. it's particularly useful for applications that need to analyze conversation patterns, create chat archives, or display message history to users. the endpoint supports pagination for handling large message histories and allows filtering by time range. it returns detailed message objects including sender information, timestamps, and message content, making it a powerful tool for building slack integrations that require access to conversation data.\<\<DEPRECATED use fetch\_conversation\_history>>
</Accordion>

<Accordion title="Get conversation info">
  The conversations.info endpoint retrieves detailed information about a specific conversation in slack. it provides comprehensive data about channels, direct messages, or multi-person direct messages, including their properties, members, and settings. this endpoint is particularly useful when you need to access metadata about a conversation, such as its name, purpose, creation date, or membership details. it should be used when detailed information about a specific slack conversation is required, rather than for listing multiple conversations or accessing message content. note that while this endpoint provides extensive metadata, it does not return the actual messages within the conversation; for that, you would need to use a separate endpoint like conversations.history.\<\<DEPRECATED use retrieve\_conversation\_information>>
</Accordion>

<Accordion title="List conversations endpoint">
  Retrieves a list of all conversations in a slack workspace, including public channels, private channels, multi-person direct messages (mpim), and direct messages (im). this endpoint is essential for obtaining an overview of all available conversations, which can be used for workspace analysis, channel management, or as a precursor to performing actions on specific conversations. the method supports filtering by conversation types, exclusion of archived channels, and pagination for handling large workspaces efficiently. use this endpoint when you need to display available channels to users, perform workspace-wide operations, or gather data about the structure of a slack workspace. note that the returned list may be affected by the permissions of the authenticated user, and some conversations might be excluded if the user doesn't have access to them.\<\<DEPRECATED use list\_all\_slack\_team\_channels\_with\_various\_filters>>
</Accordion>

<Accordion title="Delete chat message by timestamp">
  Deletes a specific message from a slack conversation. this endpoint should be used when you need to remove a message from a channel, group, or direct message conversation. it's particularly useful for cleaning up bot messages, correcting mistakes, or managing conversation history. the deletion is permanent and cannot be undone, so use with caution. this method requires either 'chat:write:user' or 'chat:write:bot' scope, depending on whether you're deleting as a user or a bot. note that you can only delete messages that were posted by the authenticated user or bot – you cannot delete other users' messages.
</Accordion>

<Accordion title="Delete reminder by id">
  The 'reminders.delete' endpoint allows you to remove a specific reminder from a user's list of reminders in slack. this method is used when you need to cancel a previously set reminder, either because the task has been completed or is no longer relevant. it requires the unique id of the reminder to be deleted, which must be obtained from a previous 'reminders.list' or 'reminders.add' operation. the endpoint is particularly useful for maintaining an up-to-date and clutter-free list of reminders for slack users. note that once a reminder is deleted, it cannot be recovered, so use this endpoint with caution.
</Accordion>

<Accordion title="Delete scheduled chat message">
  This endpoint allows you to delete a scheduled message from slack before it is sent. it is used to remove a message that has been queued for future delivery but is no longer needed or contains errors. the endpoint requires the channel id where the message was scheduled and the unique scheduled message id. you can optionally specify whether to delete the message as an authenticated user or a bot. this method is particularly useful for managing and updating automated message schedules or correcting mistakes in scheduled announcements.
</Accordion>

<Accordion title="Oauth v2 access endpoint">
  Exchanges a temporary oauth authorization code for an access token. this endpoint is a crucial part of the oauth 2.0 flow, allowing your application to obtain long-lived access tokens for making authenticated api calls to slack. it should be called immediately after receiving the temporary code from the user authorization step. the endpoint returns an access token along with other relevant information such as the authorized scopes and team details. this exchange should happen server-side to keep your client secret secure. note that the temporary code can only be used once and expires quickly, so make the exchange promptly after receiving it.
</Accordion>

<Accordion title="Disconnect shared conversations">
  The admin.conversations.disconnectshared endpoint is used to disconnect a shared slack channel from one or more workspaces. this api method is specifically designed for enterprise grid workspaces and allows administrators to manage slack connect channels and direct messages (dms). it should be used when you need to remove a workspace's access to a shared channel, typically for security, compliance, or organizational restructuring purposes. the endpoint requires administrative permissions and can only disconnect channels that are already shared across workspaces. it's important to note that this action may affect communication and collaboration between teams, so it should be used judiciously and in accordance with your organization's policies.
</Accordion>

<Accordion title="Get bots information">
  The 'bots.info' endpoint retrieves detailed information about a specific bot user in a slack workspace. it allows developers to fetch metadata and current status of a bot, which is useful for managing bot integrations or verifying bot properties. this endpoint should be used when you need to access up-to-date information about a bot, such as its name, icons, or other custom fields. it's particularly helpful for applications that manage multiple bots or need to display bot information to users. note that this endpoint only provides information about bots and not regular user accounts or other types of integrations.
</Accordion>

<Accordion title="Delete file comment">
  This endpoint allows you to delete a specific comment on a file in a slack workspace. it is used when you need to remove a comment from a file, either for moderation purposes or to clean up outdated or irrelevant feedback. the endpoint requires both the file identifier and the comment identifier to ensure precise targeting of the comment to be deleted. it's important to note that this action is irreversible, so it should be used with caution. this endpoint is particularly useful for maintaining a clean and relevant discussion around shared files in slack.
</Accordion>

<Accordion title="Enable user group via id">
  Enables a previously disabled user group in slack, making it active and usable within the workspace. this endpoint is used to reactivate a user group that was previously deactivated, allowing it to be used for mentions, permissions, and other group-based features in slack. it's particularly useful when you need to temporarily disable a group and then re-enable it later. the endpoint requires the unique identifier of the user group and optionally can return the current number of members in the group. it should not be used to create new user groups or modify existing ones beyond their enabled/disabled status.
</Accordion>

<Accordion title="Leave conversation channel">
  The 'conversations.leave' endpoint allows a user to exit a slack conversation, which can be a public channel, private channel, direct message, or group direct message. this method is useful when a user no longer wishes to participate in a specific conversation or needs to remove themselves from a channel. it should be used cautiously, as leaving a conversation may result in missing important team communications. the endpoint will fail if the user is not currently a member of the specified conversation or if they are the last member of a private channel (which would effectively archive the channel). note that this method cannot be used to leave shared channels across organizations.
</Accordion>

<Accordion title="End dnd mode">
  Ends the "do not disturb" (dnd) status for the authenticated user in slack. this endpoint should be used when a user wants to make themselves available for notifications and messages after a period of uninterrupted focus time. it immediately disables the dnd mode, allowing incoming notifications to be received. this method is particularly useful for integrations that manage a user's availability status automatically based on external factors or schedules. note that this endpoint only affects the dnd status and does not modify other user status settings or preferences in slack.
</Accordion>

<Accordion title="Oauth access endpoint">
  The oauth.access endpoint is used to exchange a temporary authorization code for an access token in the slack oauth 2.0 flow. this endpoint should be called after your application has received the authorization code from slack, typically as part of the redirect process after a user has approved your app's requested permissions. the obtained access token is crucial for making authenticated requests to other slack api endpoints on behalf of the user or workspace. this endpoint is a one-time use per authorization code and should be called server-side to keep your client secret secure. it's important to note that this endpoint does not require authentication itself, as it's part of the process to obtain authentication credentials.
</Accordion>

<Accordion title="End call with duration">
  The 'calls.end' endpoint is used to terminate an ongoing call in slack. this method is part of the slack calls api and allows developers to programmatically end a call that was previously initiated and registered using the 'calls.add' method. it's particularly useful for integrations that manage call workflows or need to automate call termination based on certain conditions. the endpoint requires the unique call id to identify which call to end, and optionally allows specifying the call duration for record-keeping purposes. it should be used when a call needs to be ended programmatically, such as in scheduled meetings or when integrating with external systems that manage call lifecycles.
</Accordion>

<Accordion title="Retrieve reminders details">
  Retrieves detailed information about a specific reminder in slack. this endpoint allows you to fetch the complete details of a reminder, including its content, creator, time, and status. use this method when you need to access or verify the information of an existing reminder. it's particularly useful for applications that manage or display reminders, allowing them to show up-to-date information about a specific reminder. the endpoint returns a comprehensive set of data about the reminder but does not modify or interact with the reminder in any way. note that this method only retrieves information for reminders that are accessible to the authenticated user in their slack workspace.
</Accordion>

<Accordion title="Deny invite request for workspace">
  This endpoint allows workspace administrators to deny an invite request to join a slack workspace. it is used when an administrator wants to reject a pending invitation request, preventing the requester from joining the workspace. the endpoint should be called when reviewing and managing incoming invite requests, particularly when the request does not meet the criteria for approval. it's important to note that this action is irreversible, so administrators should use it carefully. this endpoint does not provide any information about the invite request itself or the reason for denial; it simply processes the denial action.
</Accordion>

<Accordion title="Delete user photo">
  The users.deletephoto endpoint allows users to remove their current profile picture on slack. this method is used when a user wants to revert to the default profile image or before uploading a new photo. it's a simple operation that requires no additional parameters beyond authentication. keep in mind that this action is irreversible - once deleted, the previous profile photo cannot be restored. if you need to change the profile photo, consider using the users.setphoto method instead of deleting and re-uploading.
</Accordion>

<Accordion title="Delete file by id">
  The 'files.delete' endpoint allows you to permanently remove a file from a slack workspace. this method is used when you need to delete a file that is no longer needed or to manage storage space in your slack environment. it's important to note that this action is irreversible - once a file is deleted, it cannot be recovered. this endpoint should be used cautiously, ensuring that the file is no longer required before deletion. it's particularly useful for maintaining data hygiene, complying with data retention policies, or removing sensitive information from the workspace. the endpoint requires the id of the file to be deleted and will remove the file along with any associated comments or shares within slack.
</Accordion>

<Accordion title="Retrieve oauth token">
  Exchanges a temporary authorization code for an access token in the slack oauth 2.0 flow. this endpoint is used after a user has granted permission to your application, and you've received an authorization code. the returned access token allows your application to make api calls on behalf of the user. this endpoint should be called immediately after receiving the authorization code, as codes typically expire quickly. it's a crucial step in setting up api access for your slack integration.
</Accordion>

<Accordion title="List approved admin apps">
  Retrieves a list of approved apps for a slack workspace or enterprise grid organization. this endpoint is designed for administrators to view and manage the apps that have been approved for use within their slack environment. it can be used to audit the current set of approved apps, verify recent approvals, or gather information for reporting purposes. the endpoint supports pagination for handling large lists of approved apps and can be scoped to a specific workspace within an enterprise grid organization if needed.
</Accordion>

<Accordion title="List admin emojis">
  Retrieves a list of all custom emojis within a slack enterprise grid organization. this endpoint is specifically designed for administrators to manage and oversee custom emoji usage across the entire organization. it provides a comprehensive view of all user-created emojis, which can be useful for monitoring appropriate usage, identifying popular custom emojis, or managing emoji-related policies. the endpoint does not list standard slack emojis, focusing solely on custom additions. use this when you need to audit, report on, or manage custom emojis at an organizational level. note that this endpoint requires admin-level permissions and is part of the slack admin api, making it suitable for administrative tools and dashboards rather than end-user applications.
</Accordion>

<Accordion title="List app permissions resources">
  Retrieves a list of resources that the authenticated slack app has permission to access within the workspace. this endpoint is used to get an overview of the app's current access levels and the specific slack resources it can interact with, such as channels, users, or messages. it's particularly useful for app developers to audit their app's permissions or to dynamically adjust the app's behavior based on its current access rights. the endpoint does not modify any permissions; it only provides a read-only view of the current state. note that the response will be limited to the resources accessible under the current authentication scope, so it may not represent all possible resources in a slack workspace.
</Accordion>

<Accordion title="List denied invite requests">
  Retrieves a list of denied workspace invite requests for a slack workspace. this endpoint is used to review and manage invite requests that have been previously denied. it's particularly useful for administrators who need to audit access control or reconsider denied requests. the endpoint supports pagination to handle large numbers of denied requests efficiently. it should be used when there's a need to review the history of denied invitations, potentially for security audits or to reconsider specific denials. note that this endpoint only provides information about denied requests and does not include details about approved or pending invitations.
</Accordion>

<Accordion title="List approved admin invite requests">
  Retrieves a list of approved invite requests for a slack workspace. this endpoint allows administrators to view and manage successful invitations, providing insights into workspace growth and user onboarding. it's particularly useful for large organizations or those using slack enterprise grid to monitor approved invitations across multiple workspaces. the endpoint supports pagination for efficient handling of large datasets and can be used to audit the invitation process or gather statistics on workspace expansion.
</Accordion>

<Accordion title="Retrieve team access logs">
  Retrieves access logs for users on a slack workspace, providing detailed information about user logins and activity. this endpoint is crucial for security monitoring, compliance auditing, and tracking user access patterns. it returns a chronological list of access events, including user identifiers, ip addresses, and geographical data. use this endpoint when you need to investigate suspicious activity, perform regular security audits, or generate reports on workspace access. note that this endpoint may have rate limits and is typically restricted to workspace administrators or security personnel with appropriate permissions.
</Accordion>

<Accordion title="End dnd snooze">
  The dnd.endsnooze endpoint immediately ends the current user's do not disturb (dnd) session in slack, effectively canceling the snooze mode. this method should be used when a user wants to resume receiving notifications before their scheduled dnd period ends. it's particularly useful for situations where a user's focus period has concluded earlier than anticipated or when urgent communication is required. the endpoint doesn't require any parameters and operates on the authenticated user's account. it's important to note that this action cannot be undone, and users will need to manually re-enable dnd if needed after using this endpoint.
</Accordion>

<Accordion title="Retrieve user presence">
  Retrieves the current presence status of a specified slack user. this endpoint allows you to check whether a user is currently active or away on the slack platform. it's useful for applications that need to track user availability or trigger actions based on a user's presence. the endpoint returns the user's current status (active or away), whether they're online, and potentially the timestamp of their last activity. it should be used when you need real-time information about a user's availability in slack. note that this endpoint doesn't provide detailed information about the user's activities or the reason for their current status.
</Accordion>

<Accordion title="List remote files">
  Retrieves a list of remote files that have been added to your slack workspace. this endpoint is useful for tracking and managing external files that have been shared or referenced within slack conversations. it allows you to fetch metadata about these remote files, such as their names, types, and sharing information. use this endpoint when you need to audit remote file usage, compile reports on external content, or build integrations that interact with shared remote files. the endpoint supports pagination for handling large sets of results and offers filtering options based on timestamps and channel-specific queries. note that this endpoint only returns metadata about the remote files and does not provide access to the actual file contents.
</Accordion>

<Accordion title="List admin invite requests">
  The admin.inviterequests.list endpoint retrieves a list of pending or active invite requests for a specified slack workspace. this tool is designed for workspace administrators to review and manage incoming invitation requests, providing crucial control over workspace access and growth. it supports pagination for efficient handling of large datasets, allowing administrators to iterate through all invite requests in manageable chunks. the endpoint is particularly useful for monitoring workspace expansion, ensuring compliance with company policies, and maintaining security by overseeing who is being invited to join the workspace.
</Accordion>

<Accordion title="Handle step failure notification">
  Retrieves information about a failed step in a slack workflow. this endpoint is used to get details on why a specific step in a workflow execution failed, providing crucial information for debugging and error resolution. it should be called when a workflow step fails and you need to understand the cause of the failure. the endpoint returns data about the failed step, which may include an error message, the step id, and potentially the workflow context at the time of failure. this tool is essential for maintaining and troubleshooting automated processes within slack, ensuring smooth operation of custom workflows. note that this endpoint does not retry or fix the failed step; it only provides information about the failure.
</Accordion>

<Accordion title="Delete conversation channel">
  The admin.conversations.delete endpoint allows workspace administrators to permanently delete a channel from a slack enterprise grid organization. this powerful function should be used when a channel is no longer needed and all its contents can be permanently removed. it's important to note that this action is irreversible and will delete all messages and files within the channel. this endpoint is only available for enterprise grid workspaces and requires admin-level permissions. it should be used with caution and typically as part of a careful channel management strategy or data cleanup process.
</Accordion>

<Accordion title="List user permissions">
  Retrieves a list of user permissions within a slack workspace. this endpoint allows administrators or authorized apps to fetch the permissions assigned to users, providing insight into access levels and capabilities of individual users within the slack environment. it's particularly useful for auditing user access, managing permissions at scale, or integrating with external user management systems. the endpoint returns comprehensive information about user permissions, which may include details such as oauth scopes, custom function access, and any specific role-based permissions. note that this endpoint does not modify permissions; it's purely for information retrieval purposes.
</Accordion>

<Accordion title="List permissions scopes for apps">
  Retrieves a list of oauth scopes associated with the authenticated slack app. this endpoint allows developers to view the current permissions granted to their app within a slack workspace. it's particularly useful for auditing app permissions, verifying the app's access levels, or preparing for permission changes. the endpoint returns all scopes the app has been granted, which can include both bot and user token scopes. it should be used when you need to review or confirm the current set of permissions for your slack app. note that this endpoint does not modify any permissions; it only provides a read-only view of the existing scopes.
</Accordion>

<Accordion title="Get app permissions info">
  Retrieves detailed information about the permissions granted to a slack application. this endpoint is used to audit and review the current set of permissions associated with an app, helping developers and administrators understand the app's capabilities within a slack workspace. it provides a comprehensive list of all permissions the app has been granted, which is crucial for security audits, troubleshooting, or when preparing to request additional scopes. the endpoint does not modify any permissions; it only returns the current state. note that the permissions returned are specific to the app associated with the authentication token used in the request.
</Accordion>

<Accordion title="List original connected channel info">
  Retrieves a list of original connected channel information for enterprise key management (ekm) enabled channels in a slack workspace. this endpoint is specifically designed for administrators managing ekm in slack, allowing them to obtain crucial information about encrypted channels, particularly those that have been frozen. it's essential for maintaining security and compliance in organizations using ekm to protect sensitive data in slack. the endpoint should be used when auditing ekm-enabled channels or preparing to revoke encryption keys for frozen channels. it does not modify any data and is intended for informational purposes only. note that this endpoint requires admin-level permissions and is only applicable to workspaces with ekm enabled.
</Accordion>

<Accordion title="List event authorizations for apps">
  Retrieves a list of authorizations for a specific event context in slack. this endpoint allows developers to determine which app installations are visible and have the necessary permissions to access or respond to a particular event. it's essential for understanding the scope of an app's visibility and capabilities across different slack workspaces and events. the endpoint supports pagination for handling large sets of authorizations, making it suitable for apps installed in numerous workspaces or with complex permission structures.
</Accordion>

<Accordion title="List restricted apps for admin">
  Retrieves a list of all apps that are restricted from installation on a slack workspace or across an entire enterprise grid organization. this endpoint is essential for enterprise grid administrators to manage and review app restrictions, ensuring compliance with organizational policies. it provides detailed information about each restricted app, including its id, name, and developer type (internal, third-party, or slack-built). use this endpoint when you need to audit your organization's app restrictions or verify the current status of app installation policies. note that this method only works for enterprise grid workspaces and requires appropriate admin-level permissions to access.
</Accordion>

<Accordion title="List emoji items">
  The emoji.list endpoint retrieves a comprehensive list of custom emojis available in the slack workspace. this get method allows developers to access the names and corresponding image urls of all custom emojis that have been added to the workspace. it's particularly useful for applications or bots that need to display, use, or manage custom emojis within slack integrations. the endpoint returns both standard slack emojis and any custom emojis uploaded by workspace members. however, it does not provide usage statistics or creation dates for the emojis. use this endpoint when you need to synchronize emoji data with an external system or when building features that involve emoji selection or display within your slack integration.
</Accordion>

<Accordion title="List admin app requests">
  Retrieves a list of app installation requests for a slack workspace or enterprise grid organization. this endpoint allows administrators to view pending requests from users who want to install new slack apps. it's essential for maintaining control over the apps used within your slack environment and ensuring compliance with organizational policies. the endpoint supports pagination for handling large numbers of requests efficiently. use this when you need to review, approve, or deny app installation requests across your slack workspace or organization.
</Accordion>

<Accordion title="List admin users">
  The admin.users.list method retrieves a paginated list of users with administrative privileges in a slack workspace. it allows workspace owners and admins to view and manage the administrative user base efficiently. this endpoint is particularly useful for auditing admin access, reviewing admin assignments, or gathering data for reporting purposes. the method returns basic information about each admin user, such as their user id, name, and email. it does not provide detailed information about user permissions or roles beyond their admin status.
</Accordion>

<Accordion title="List scheduled chat messages">
  The chat.scheduledmessages.list endpoint retrieves a list of scheduled messages for a slack workspace or specific channel. it allows users to view pending messages that have been scheduled for future delivery, providing details such as the message content, scheduled time, and target channel. this endpoint is particularly useful for managing and reviewing upcoming automated communications or delayed announcements within a slack environment. the endpoint supports pagination and filtering options, enabling efficient retrieval of large sets of scheduled messages or focusing on specific time ranges and channels. it's important to note that this endpoint only returns messages that have not yet been sent and are still pending delivery. developers should use this endpoint when building applications that need to monitor, manage, or display scheduled message queues, such as dashboard tools for content calendars or automation systems that need to track pending notifications.
</Accordion>

<Accordion title="List admin team owners">
  Retrieves a list of owners for a specified slack workspace within an enterprise grid organization. this endpoint allows administrators to view all users with owner privileges in a particular team. it's useful for auditing ownership, managing permissions, or when transitioning team responsibilities. the endpoint supports pagination for efficiently handling workspaces with a large number of owners. note that this endpoint is exclusive to enterprise grid customers and cannot be used with standard slack workspaces.
</Accordion>

<Accordion title="Set user presence">
  Manually sets a user's presence status in slack. this endpoint allows you to override the automatic presence detection and explicitly set a user's status to either 'auto' (letting slack determine presence based on activity) or 'away'. use this when you need to programmatically update a user's availability, such as when integrating with external systems or custom workflows. note that setting presence to 'auto' doesn't guarantee an 'active' status; it simply reverts to slack's default presence behavior. this change persists between connections but can be overridden by user actions or slack's auto-away feature after 10 minutes of inactivity.
</Accordion>

<Accordion title="Complete workflow step event">
  The 'workflows.stepcompleted' endpoint is used to mark a specific step within a slack workflow as completed. this get request is crucial for tracking the progress of automated workflows and potentially triggering subsequent actions. it should be called when a custom step in a workflow has finished its execution successfully. this endpoint helps in maintaining the state of complex workflows, especially those involving custom functions or integrations with external services. it's important to note that this endpoint doesn't execute the step itself but rather updates its status to completed. use this endpoint in conjunction with workflow creation and management to build sophisticated automation sequences within slack.
</Accordion>

<Accordion title="Disable usergroup">
  Disables a specified user group in slack. this endpoint is used to deactivate an existing user group, setting its 'date delete' parameter to a non-zero value. it's particularly useful for archiving or temporarily deactivating groups that are no longer needed. the endpoint requires the id of the user group to be disabled and optionally can return the count of users in the group. use this when you need to manage team structures or clean up inactive groups. note that disabling a user group does not delete it permanently, and it can be re-enabled later if needed.
</Accordion>

<Accordion title="Get list of user groups">
  Retrieves a list of all user groups in a slack workspace. this endpoint is used to get an overview of the organizational structure within a slack team, including details about each user group such as their names, handles, descriptions, and member counts. it's particularly useful for administrators or integrations that need to manage or audit user groups across the workspace. the endpoint returns information about both user-created groups and default groups provided by slack. note that while this endpoint doesn't require any parameters, the response may be paginated for workspaces with a large number of user groups, and additional api calls might be necessary to retrieve the complete list.
</Accordion>

<Accordion title="Migration exchange overview">
  The migration.exchange endpoint facilitates the conversion of local slack user ids to global user ids for enterprise grid organizations. this tool is essential during the migration process when transitioning from a standard slack workspace to an enterprise grid deployment. it allows administrators and developers to maintain user identity consistency across the organization by mapping local, workspace-specific user ids to universal, enterprise grid-compatible global user ids. the endpoint should be used when preparing for or executing a migration to enterprise grid, or when integrating systems that need to work with both local and global user ids. it's important to note that this endpoint does not perform the actual migration but provides the necessary id mapping for the process.
</Accordion>

<Accordion title="List restricted access groups">
  Retrieves a list of identity provider (idp) groups that have been granted access to a specific private channel or conversation in a slack workspace. this endpoint is designed for slack workspace administrators to manage and review access control settings for conversations. it should be used when auditing or modifying access restrictions on private channels. the tool provides visibility into which external groups (managed by an identity provider) have permission to access certain conversations, enhancing security and compliance management. note that this endpoint does not modify any permissions; it only lists the current access configuration.
</Accordion>

<Accordion title="Open views endpoint">
  The views.open endpoint allows you to open a modal view in a slack workspace. this method is used to create interactive, customized interfaces for users within slack, such as forms, detailed information displays, or multi-step workflows. it's particularly useful when you need to collect information from users or display complex data in a structured format. the view appears as a pop-up window, providing a focused environment for user interaction. keep in mind that views have a limited lifespan and should be used for immediate user interactions rather than long-term display of information.
</Accordion>

<Accordion title="Promote user to workspace owner">
  The admin.users.setowner endpoint promotes an existing user to the role of workspace owner within a slack enterprise grid organization. this powerful administrative function should be used when you need to grant full ownership privileges to a user, typically for management restructuring or when the current owner is leaving the organization. it's crucial to use this endpoint carefully, as workspace owners have extensive control over the slack environment. this method only works for enterprise grid workspaces and requires appropriate administrative permissions. note that this action cannot be undone through the api, and changing ownership may have significant implications for workspace management and security.
</Accordion>

<Accordion title="List files">
  The 'files.list' endpoint allows you to retrieve a list of files within a slack workspace. it provides a comprehensive view of files shared across channels, enabling efficient file management and content discovery. use this endpoint when you need to fetch file metadata, such as names, types, and sharing information, without downloading the actual file contents. the endpoint supports various filtering options, allowing you to narrow down results by channel, time range, or file type. it's particularly useful for applications that need to audit file usage, create file indexes, or build custom file management interfaces within slack. note that this endpoint returns metadata only and does not provide direct file downloads; for that, you would need to use a separate file retrieval endpoint.
</Accordion>

<Accordion title="Share file public url">
  Creates a public url for sharing a file in slack. this endpoint enables users to generate a publicly accessible link for a specific file, allowing it to be shared with people outside the slack workspace. it's useful when you need to provide file access to external collaborators or for public distribution. note that this action may have security implications, so use it cautiously and only for files that are appropriate for public sharing. the endpoint doesn't create a new file; it simply generates a public url for an existing file in the workspace.
</Accordion>

<Accordion title="Set user as admin in workspace">
  This endpoint allows you to designate a user as an admin within a specific slack workspace. it is used when you need to promote a regular user to an admin role, granting them additional permissions and control over workspace settings. the operation requires both the workspace id and the user id of the person being promoted. this action should be used carefully, as admins have significant control over workspace configurations and user management. note that this endpoint only sets the admin status and does not provide any feedback on the success of the operation or the current status of the user.
</Accordion>

<Accordion title="View push interface">
  The views.push endpoint adds a new view to the top of the existing view stack in a slack modal. it's used for creating dynamic, multi-step interactions within a single modal session. this method allows apps to respond to user actions by presenting new content or forms without closing the current modal. it's particularly useful for workflows that require multiple stages or for displaying additional information based on user input. the endpoint requires a valid trigger id from a recent interaction and must be called within 3 seconds of that interaction. it's important to note that there's a limit to the number of views that can be pushed onto a single modal stack, typically around 3 views.
</Accordion>

<Accordion title="Add reminder for user">
  The 'reminders.add' endpoint allows you to create new reminders in slack. it's designed to help users set notifications for future tasks, events, or any information they need to remember. this tool is particularly useful for managing personal tasks, setting team reminders, or scheduling follow-ups within slack's collaborative environment. the endpoint offers flexibility in timing, supporting one-time reminders as well as recurring ones through natural language input. while it focuses on creating reminders, it does not provide functionality for listing, modifying, or deleting existing reminders. note that if no specific user is designated, the reminder defaults to the creator, making it versatile for both personal and team use.\<\<DEPRECATED use create\_a\_reminder>>
</Accordion>

<Accordion title="Add participants to call">
  Adds one or more participants to an ongoing slack call. this endpoint should be used when you need to include additional users in an existing call, such as when inviting late joiners or expanding the call's participants. it requires the unique identifier of the call and a list of user ids to be added. the endpoint is particularly useful for managing dynamic call participation in collaborative environments. note that this method can only add participants to calls that have already been initiated using the 'calls.add' method.
</Accordion>

<Accordion title="Publish views endpoint">
  The views.publish endpoint is used to publish or update a home tab view for a specific user in a slack workspace. this method allows you to create or modify the custom interface that appears in the home tab of the slack client for a particular user. it's primarily used for displaying personalized, dynamic content or interactive elements specific to your slack app. the endpoint should be used when you want to update a user's home tab with new information, metrics, or interactive components. it's particularly useful for creating dashboard-like interfaces or providing user-specific controls and information. note that this endpoint specifically targets the home tab view and should not be used for creating or updating modals or messages in channels.
</Accordion>

<Accordion title="Remove star from channel file or comment">
  Removes a star from an item (message, file, file comment, channel, private group, or direct message) on behalf of the authenticated user. this endpoint is used when a user wants to unstar content in slack. it requires at least one parameter to identify the item to be unstarred. the method broadcasts a 'star removed' event through the rtm api for the calling user. use this endpoint to programmatically manage starred items in a user's slack workspace.
</Accordion>

<Accordion title="Remove user from conversation">
  The conversations.kick endpoint removes a specified user from a slack conversation (channel). this method is used when you need to forcibly remove a member from a channel, which can be useful for moderation or managing channel membership. it requires the necessary permissions based on the type of channel being used. the endpoint should be used judiciously, as kicking a user may impact team dynamics. note that this method cannot be used to remove oneself from a channel; for that purpose, use the conversations.leave method instead. be aware that the kicked user will be able to rejoin the channel if it's a public channel unless further restrictions are put in place.
</Accordion>

<Accordion title="Remove remote file">
  Removes a remote file from slack. this endpoint is used to delete the reference to an external file that was previously added to slack using the remote files api. it's particularly useful for maintaining consistency between your external file system and slack, allowing you to remove files that are no longer relevant or have been deleted from the source. the removal can be performed using either the creator-defined external id or slack's internal file id. this operation only removes the file reference from slack and does not affect the original file in its external location.
</Accordion>

<Accordion title="Add call to slack">
  The 'calls.add' endpoint registers a new call in slack, integrating third-party call services with slack's interface. it allows you to create a call with specific details such as title, start time, and participants, providing urls for joining the call through slack or directly through desktop applications. this endpoint is particularly useful for setting up team meetings, conference calls, or any voice/video communication within slack channels. it supports both immediate and scheduled calls, offering flexibility in call management and participant organization. use this when you need to programmatically create and manage calls within your slack workspace, especially when integrating external calling services.
</Accordion>

<Accordion title="Set user active status">
  The users.setactive endpoint marks a user as active in a slack workspace. this method is used to update the user's status, indicating that they are currently available and engaged with slack. it's particularly useful for automatically updating a user's status when they return from being away or inactive. the endpoint doesn't require any specific parameters in the request body. however, it's important to note that this method should be called with appropriate authentication, typically using a user token or bot token with necessary permissions. while it sets a user's status to active, it doesn't provide any additional information about the user or their previous status.
</Accordion>

<Accordion title="List user group channels">
  Retrieves a list of channels associated with a specific user group in a slack workspace. this endpoint is particularly useful for administrators who need to audit or manage channel access for user groups. it provides visibility into which channels a user group has been added to, helping in access control and organization of the slack workspace. the endpoint should be used when you need to review or verify channel associations for a particular user group, but it will not modify any existing settings or permissions.
</Accordion>

<Accordion title="Remove emoji using admin api">
  Removes a custom emoji from a slack enterprise grid organization. this endpoint allows administrators to delete a specific custom emoji, making it unavailable across all workspaces within the organization. it should be used when you need to remove inappropriate, outdated, or unused custom emojis. the removal is permanent and affects all users in the enterprise grid. this tool does not provide a way to backup or archive the removed emoji, so use it cautiously.
</Accordion>

<Accordion title="Remove idp group from channel">
  This endpoint removes an identity provider (idp) group from the access list of a private slack channel. it's used to revoke access for all members of the specified idp group to a particular private channel. this action is part of slack's advanced access management features, allowing administrators to fine-tune channel access based on organizational structure. use this endpoint when you need to adjust access permissions for large groups of users simultaneously, based on their idp group membership. it's particularly useful for maintaining security and information compartmentalization in enterprise environments. note that this endpoint only affects private channels and requires admin-level permissions to execute.
</Accordion>

<Accordion title="Mark reminder as complete">
  The 'reminders.complete' endpoint marks a specific slack reminder as complete. it should be used when a user wants to indicate that a task associated with a reminder has been finished. this endpoint is particularly useful for integrations that manage tasks or to-do lists within slack. however, it's important to note that this endpoint has been deprecated since march 2023, which means it may not be reliable for new applications and could stop working in the future. as an alternative, consider using other reminder management methods or consult slack's latest documentation for recommended approaches to handle reminders.
</Accordion>

<Accordion title="Remove participants from call">
  This endpoint removes specified participants from an ongoing slack call. it should be used when you need to programmatically remove one or more users from a call, such as when a participant needs to be ejected or when automating call management. the endpoint requires the call id and a list of users to remove. it's important to note that this action is irreversible, and removed users will need to be re-added if they should rejoin the call. this method will not end the call even if all participants are removed. be cautious when using this endpoint, as it directly affects user participation in ongoing communications.
</Accordion>

<Accordion title="Retrieve conversation history">
  Retrieves the message history of a specified slack conversation or channel. this endpoint allows you to fetch a chronological list of messages and events that have occurred within a channel, group, or direct message conversation. it's particularly useful for applications that need to analyze conversation patterns, create chat archives, or display message history to users. the endpoint supports pagination for handling large message histories and allows filtering by time range. it returns detailed message objects including sender information, timestamps, and message content, making it a powerful tool for building slack integrations that require access to conversation data.
</Accordion>

<Accordion title="Remove channels from usergroup">
  Removes specified channels from a designated user group in slack. this endpoint allows administrators to disassociate multiple channels from a user group simultaneously, which can be useful for managing access control and organization within a slack workspace. it should be used when you need to update the channel associations for a user group, such as when reorganizing team structures or adjusting access permissions. note that this operation only removes the association between the channels and the user group; it does not delete the channels or the user group itself. be cautious when using this endpoint, as it may impact users' access to channels they previously had through the user group membership.
</Accordion>

<Accordion title="Retrieve team information">
  Retrieves detailed information about a slack team. this endpoint provides comprehensive data about the team's configuration, including its id, name, domain, email domain, and icon settings. if the team is part of an enterprise grid, it also returns the enterprise id and name. use this method when you need to access or verify team-specific details, such as during initial setup, user onboarding, or for administrative purposes. the endpoint is particularly useful for applications that interact with multiple slack teams and need to maintain accurate team information. note that while this method provides extensive team data, it does not include information about individual team members or channels.
</Accordion>

<Accordion title="Remove user from workspace">
  The admin.users.remove endpoint allows workspace administrators to remove a specific user from a slack workspace. this action permanently deletes the user's access to the workspace and all associated channels. it should be used when an employee leaves the organization or when their access needs to be revoked for security reasons. the endpoint requires both the workspace id and the user id to ensure precise user removal. it's important to note that this action is irreversible, so it should be used with caution. this endpoint does not handle transferring the user's data or files before removal, so any necessary data preservation should be done separately before calling this endpoint.
</Accordion>

<Accordion title="Invite users to channel">
  Invites specified users to a slack channel. this endpoint allows administrators to add multiple users to a public or private channel simultaneously. it's particularly useful for onboarding new team members or reorganizing channel memberships. the method can handle up to 1000 user invitations at once, making it efficient for bulk operations. however, it's important to note that this endpoint is only available for enterprise grid workspaces, indicating its use is restricted to more advanced slack environments. the calling user must have appropriate permissions and be a member of the target channel.
</Accordion>

<Accordion title="Retrieve dnd team information">
  Retrieves the do not disturb (dnd) status information for members of a slack team. this endpoint allows you to check the dnd settings for multiple users within a team simultaneously. it's particularly useful for team coordination, scheduling, or creating automation that respects users' dnd preferences. the endpoint returns current dnd statuses and any scheduled dnd sessions for the specified users or the entire team. note that this endpoint does not modify any dnd settings; it's read-only and meant for informational purposes.
</Accordion>

<Accordion title="List admin team admins">
  Retrieves a list of administrators for a specified slack team (workspace) within an enterprise grid organization. this endpoint is designed for org owners and admins to manage and audit administrative access across their enterprise grid workspaces. it provides information about users who have administrative privileges for a given team, helping in access control and compliance monitoring. the endpoint supports pagination for efficient handling of large admin lists. use this when you need to review or manage the administrative structure of a specific workspace in your enterprise grid.
</Accordion>

<Accordion title="List reminders">
  Retrieves a list of all reminders for the authenticated user in their slack workspace. this endpoint is useful for applications that need to manage or display upcoming reminders, such as task management tools or personal assistants. it provides an overview of all scheduled reminders, including their details like content, due date, and status. the endpoint should be used when you need to fetch all reminders at once, rather than querying for individual reminders. note that this endpoint may have rate limits and pagination for workspaces with a large number of reminders, although these details are not specified in the given schema.
</Accordion>

<Accordion title="List stars">
  Retrieves a list of all starred items for the authenticated user in a slack workspace. this endpoint allows you to fetch items that a user has marked as favorites, including messages, files, and channels. it's useful for applications that need to display or manage a user's starred content within slack. the endpoint returns a comprehensive list of starred items without any filtering options, so it's best used when you need a complete overview of a user's favorites. note that the response may include various types of items, so your application should be prepared to handle different data structures for messages, files, and channels.
</Accordion>

<Accordion title="Fetch reaction details">
  The 'reactions.get' endpoint retrieves a list of all reactions for a specific item in slack, such as a message, file, or file comment. it allows developers to fetch detailed information about how users have reacted to content within slack. this endpoint is particularly useful for applications that need to analyze engagement, track popular content, or display reaction data outside of the slack interface. the method returns information about the reactions, including the types of reactions (emojis) used and, optionally, details about the users who reacted. while it provides comprehensive reaction data, it does not modify any reactions or return the content of the item itself.
</Accordion>

<Accordion title="List reactions">
  The reactions.list endpoint retrieves a list of all reactions for items within a specified slack channel or conversation. it allows you to fetch reaction data, which can include emojis or custom reactions added to messages or files. this endpoint is particularly useful for analyzing user engagement, tracking popular content, or building analytics tools that monitor interaction patterns within slack workspaces. the method supports pagination for handling large sets of reaction data and can provide detailed information about each reaction when requested. it's important to note that this endpoint focuses solely on reaction data and does not return the content of messages or files themselves.
</Accordion>

<Accordion title="Remove reactions from message">
  The reactions.remove endpoint allows you to remove a specific reaction (emoji) from a message, file, or file comment in slack. this method is useful for undoing reactions or cleaning up emoji responses on various items within slack channels. to use this endpoint, you must specify the reaction name and the item (message, file, or file comment) from which to remove the reaction. for messages, both the channel and timestamp are required. for files or file comments, you need to provide the respective file or file comment id. this endpoint is particularly helpful for moderation purposes or when managing automated reactions in integrated applications.
</Accordion>

<Accordion title="Open dialog">
  Opens an interactive dialog in slack, allowing your app to collect information from users through a modal interface. this method is essential for creating custom forms, gathering user input, or displaying complex information within the slack workspace. use this endpoint when you need to prompt users for multiple pieces of information or when you want to present a structured interface for data entry. the dialog appears as a modal window, providing a focused interaction experience. note that dialogs can only be opened in response to a user action, such as clicking a button, and require a valid trigger id. the dialog's appearance and behavior are highly customizable, but they must adhere to slack's design guidelines and size limitations.
</Accordion>

<Accordion title="Invalidate user session">
  The admin.users.session.invalidate endpoint allows slack workspace administrators to forcibly terminate a specific user's active session. this tool is primarily used for security purposes, such as when an admin needs to immediately revoke access for a compromised account or ensure a user is logged out across all devices. it requires both the team id and the specific session id to target the correct session for invalidation. this endpoint should be used cautiously and only when necessary, as it will disrupt the user's current slack session, forcing them to log in again. it's particularly useful in scenarios where simply changing a user's password may not be sufficient to ensure immediate session termination.
</Accordion>

<Accordion title="Rename admin emoji">
  Renames a custom emoji in a slack workspace. this endpoint allows administrators to change the name of an existing custom emoji, which can be useful for organizing emojis or correcting naming errors. the function requires admin-level permissions and should be used when there's a need to update emoji names without removing and re-adding them. it's important to note that this action will affect all instances of the emoji across the workspace, so it should be used with caution to avoid disrupting existing communications that may reference the emoji by its old name.
</Accordion>

<Accordion title="Retrieve conversation replies">
  The 'conversations.replies' endpoint retrieves a thread of messages within a slack conversation. it allows you to fetch replies to a specific message, providing a paginated list of messages in the thread. this endpoint is crucial for applications that need to display or process threaded conversations in slack channels, including public channels, private channels, and direct messages. use this when you need to access the full context of a discussion or when building features that involve message threads. note that the endpoint requires appropriate authentication scopes and may have rate limits for frequent requests.
</Accordion>

<Accordion title="Get admin teams settings info">
  Retrieves detailed information about the settings of a specific slack team (workspace) within an enterprise grid organization. this endpoint is crucial for administrators to view and manage workspace configurations across multiple teams. it provides comprehensive data about team settings, including but not limited to, the team's name, description, domain, icon, and other customizable options. use this endpoint when you need to audit, review, or prepare for modifications to a team's settings. note that this endpoint only fetches information and does not modify any settings; separate endpoints are required for making changes.
</Accordion>

<Accordion title="Get list of pins">
  The 'pins.list' endpoint retrieves a list of items that have been pinned to a specified slack channel. it allows developers to access important or frequently referenced messages or files that team members have marked as significant. this endpoint is particularly useful for creating custom pin management tools, archiving important information, or integrating pinned content into other applications. the endpoint supports pagination for efficiently handling channels with a large number of pinned items.
</Accordion>

<Accordion title="List admin teams">
  Retrieves a list of all teams within a slack enterprise grid organization. this endpoint is part of the admin api and is designed for administrators to get an overview of the teams in their organization. it should be used when you need to audit, manage, or report on the teams across your entire slack instance. the endpoint returns basic information about each team, which may include team ids, names, and other relevant metadata. note that this endpoint requires admin-level permissions and is only available for enterprise grid organizations. it does not provide detailed information about team members or channel structures; for such data, you would need to use additional api calls.
</Accordion>

<Accordion title="List users endpoint">
  The 'users.list' endpoint retrieves a comprehensive list of users within a slack workspace. it provides detailed information about each user, including their profile data, account settings, and team memberships. this endpoint is particularly useful for applications that need to synchronize user data, manage user permissions, or perform bulk operations on user accounts. the response includes both active and deactivated users, allowing for a complete overview of the workspace's user base. however, it's important to note that the endpoint may not return real-time data, and there might be a slight delay in reflecting recent changes to user accounts.
</Accordion>

<Accordion title="Get admin conversations teams">
  Retrieves the list of teams associated with a specific slack conversation. this endpoint is designed for slack workspace administrators or organization owners to manage multi-workspace channels. it allows admins to identify which teams (workspaces) have access to a particular conversation, which is crucial for maintaining proper access control and understanding the scope of shared channels. the endpoint should be used when auditing channel access, managing cross-workspace collaborations, or troubleshooting team-related issues in shared channels. note that this endpoint only provides team information and does not allow for modifying team associations.
</Accordion>

<Accordion title="Retrieve conversation preferences">
  The admin.conversations.getconversationprefs endpoint retrieves the current preferences and settings for a specific conversation (channel or direct message) in a slack workspace. it allows administrators to view important configuration details such as posting permissions, thread response settings, and potentially retention policies. this endpoint is crucial for auditing and managing conversation settings across an organization, especially in enterprise grid workspaces. it should be used when administrators need to review or verify the current configuration of a conversation before making any changes. note that this endpoint likely requires admin-level permissions and appropriate oauth scopes to access.
</Accordion>

<Accordion title="List users in user group">
  Retrieves a list of users belonging to a specified usergroup in slack. this endpoint is particularly useful for administrators and developers who need to manage usergroup memberships, audit access control, or synchronize user data with external systems. it provides a comprehensive view of the usergroup's composition, including options to include disabled users and paginate through large usergroups. the endpoint should be used when you need to obtain detailed information about usergroup membership, but it does not provide capabilities to modify the usergroup or user attributes directly.
</Accordion>

<Accordion title="Get team billable info">
  Retrieves billable information for members of a slack team or workspace. this endpoint provides details about which team members are considered billable users, which is crucial for understanding the billing structure and costs associated with your slack workspace. use this endpoint when you need to audit your team's billable members, prepare for billing cycles, or manage your workspace's user allocation. the endpoint returns information about all billable members, but it does not provide detailed billing amounts or invoke any changes to the billing status. it's important to note that this endpoint may have rate limits and should be used judiciously, typically for administrative or reporting purposes rather than real-time operations.
</Accordion>

<Accordion title="Add pin to channel">
  The 'pins.add' endpoint allows you to pin a specific message within a slack channel. this function is used to highlight important information, making it easily accessible to channel members. when invoked, it adds a pin to the specified message, causing it to appear in the channel's pinned items section. this is particularly useful for marking crucial announcements, decisions, or reference information that team members need to access frequently. the endpoint requires specifying the target channel and ideally the exact timestamp of the message to be pinned. it's important to note that this action may be subject to user permissions within the slack workspace.
</Accordion>

<Accordion title="Fetch team integration logs">
  Retrieves the integration activity logs for a specified slack team. this endpoint provides detailed information about changes to integrations within the team, including when integrations are added, removed, enabled, disabled, or updated. it's particularly useful for team administrators and security personnel who need to monitor and audit integration-related activities. the logs include information such as the type of change, the service affected, the user who made the change, and the timestamp of the activity. this tool should be used when there's a need to track integration changes, investigate security concerns, or maintain compliance records related to third-party app usage within a slack workspace. it does not provide real-time monitoring and may have some delay in reflecting the most recent activities.
</Accordion>

<Accordion title="Invite user to channels in workspace">
  The admin.users.invite endpoint allows slack workspace administrators to invite new users to their workspace. this powerful tool streamlines the process of adding members, setting up guest accounts, and managing initial channel access. use this endpoint when you need to programmatically invite users, especially in bulk or as part of an automated onboarding process. it's particularly useful for large organizations or when integrating slack with other systems. the endpoint provides flexibility in setting user roles, specifying channel access, and managing guest account expirations. however, it should be used cautiously, as it directly affects workspace membership and access rights. note that while you can set initial parameters, users may still need to complete the signup process and might have the ability to modify some settings upon joining.
</Accordion>

<Accordion title="Lookup users by email">
  The users.lookupbyemail endpoint retrieves detailed information about a single slack user by searching for their registered email address. this method is particularly useful when you need to find a user's slack profile details but only have their email address available. the endpoint returns a comprehensive user object containing various fields such as user id, display name, and other profile information if the user is active. however, it will return a 'users not found' error if the user has been deactivated or if no user with the specified email exists in the workspace. this method requires the 'users:read.email' scope for authentication and should be used judiciously to respect user privacy.
</Accordion>

<Accordion title="Invite users to channel">
  The conversations.invite endpoint allows you to invite one or multiple users to a specific slack channel. this powerful tool streamlines the process of adding members to your conversations, enhancing team collaboration. use this endpoint when you need to quickly add users to a channel, especially for onboarding new team members or creating project-specific groups. it supports both public and private channels, providing flexibility in managing your slack workspace. the endpoint can handle bulk invitations of up to 1000 users in a single request, making it efficient for large-scale channel population. however, be mindful of your slack plan's limitations and ensure all user ids are valid to avoid errors.
</Accordion>

<Accordion title="Open conversations endpoint">
  The conversations.open endpoint opens or resumes a direct message (dm) or multi-person direct message (mpim) conversation in slack. it allows users to start new conversations or continue existing ones by providing either a conversation id or a list of user ids. this method is essential for initiating private communications between two or more users within a slack workspace. it's particularly useful for integrations that need to create or access private conversations programmatically. the endpoint supports both 1:1 and group conversations, making it versatile for various communication needs. when using this endpoint, it's important to note that you must provide either a 'channel' id for existing conversations or a list of 'users' for new or existing conversations, but not both simultaneously.
</Accordion>

<Accordion title="Conversations create channel">
  Creates a new conversation (channel) in slack, either public or private. this endpoint should be used when you need to programmatically create channels for team communication, project management, or automated workflows. it allows for the creation of organized spaces within a slack workspace for specific topics, teams, or projects. the created channel will be empty initially, and members will need to be invited separately. note that channel names must be unique within a workspace, and there may be limitations on the number of channels that can be created based on the workspace's plan.
</Accordion>

<Accordion title="Rename conversation channel">
  This endpoint renames an existing conversation (channel) in slack. it should be used when you need to update the name of a channel, either for rebranding, clarifying its purpose, or organizing workspace structure. the endpoint requires the unique channel id and the desired new name. only authorized users (such as the channel creator, workspace admins, or channel managers) can perform this action. the new name must comply with slack's naming conventions, and the api will automatically adjust it if necessary. note that renaming a channel may affect existing integrations or saved references to the channel name.
</Accordion>

<Accordion title="Retrieve user conversations">
  Retrieves a list of conversations (channels, direct messages, and group messages) that a specified user or the authenticated user is a member of in a slack workspace. this endpoint is useful for applications that need to analyze user participation, manage channel memberships, or provide custom navigation within a slack integration. it supports pagination for handling large numbers of conversations and allows filtering by conversation types. use this endpoint when you need to gather information about a user's conversation memberships or when building user-specific views of slack workspaces. note that the results are limited to conversations the authenticated token has access to view.
</Accordion>

<Accordion title="List conversations endpoint">
  Retrieves a list of all conversations in a slack workspace, including public channels, private channels, multi-person direct messages (mpim), and direct messages (im). this endpoint is essential for obtaining an overview of all available conversations, which can be used for workspace analysis, channel management, or as a precursor to performing actions on specific conversations. the method supports filtering by conversation types, exclusion of archived channels, and pagination for handling large workspaces efficiently. use this endpoint when you need to display available channels to users, perform workspace-wide operations, or gather data about the structure of a slack workspace. note that the returned list may be affected by the permissions of the authenticated user, and some conversations might be excluded if the user doesn't have access to them.
</Accordion>

<Accordion title="Join conversation by channel id">
  Joins the authenticated user to a slack conversation (channel). this endpoint allows you to add yourself to an existing public or private channel, or a multi-person direct message. use this when you need to participate in a conversation that you're not currently a member of. it's particularly useful for bots or integrations that need to join specific channels to listen for messages or post updates. note that this endpoint doesn't create new conversations; it only allows joining existing ones. also, be aware that joining private channels may require additional permissions or invitations, depending on your workspace settings and the user's role.
</Accordion>

<Accordion title="Request app permissions">
  The 'apps.permissions.request' endpoint allows slack app developers to request additional permissions for their application. this method is used when an app needs to expand its capabilities and requires new scopes to access additional slack workspace features or data. it initiates the process of requesting new permissions, which typically involves notifying workspace administrators for approval. this endpoint should be used cautiously and only when necessary, as frequent permission changes may impact user trust. it's important to note that calling this endpoint does not automatically grant new permissions; it only starts the request process.
</Accordion>

<Accordion title="Rename admin conversation channel">
  Renames a public or private channel in a slack workspace. this endpoint should be used when an admin or authorized user needs to change the name of an existing channel. it's particularly useful for keeping channel names up-to-date with team or project changes. the endpoint only modifies the channel name and does not affect its members, purpose, or any other attributes. note that this action is only available to workspace admins or users with the channel manager role in enterprise grid workspaces.
</Accordion>

<Accordion title="Restrict app access">
  Restricts a specified app within a slack workspace, limiting its access or functionality. this endpoint should be used by workspace administrators when they need to prevent or control the use of a particular app due to security concerns, compliance requirements, or organizational policies. it allows for granular control over app permissions and usage within the team. the restriction is applied based on the provided app id, request id, and team id, ensuring precise targeting of the restriction action. this tool is essential for maintaining workspace security and enforcing app usage policies but should be used judiciously to avoid disrupting workflow integrations.
</Accordion>

<Accordion title="Get conversation members">
  Retrieves a list of members in a specific slack conversation. this endpoint is part of the conversations api and can be used to fetch member information for public channels, private channels, direct messages, and group direct messages. it's particularly useful for analyzing conversation participants, managing large channels, or integrating member information into external systems. the endpoint supports pagination for efficiently handling conversations with a large number of members. note that the api may not return members who have left the conversation or workspace, focusing only on current active members.
</Accordion>

<Accordion title="Retrieve dnd information">
  Retrieves information about a user's current do not disturb (dnd) status in slack. this endpoint allows you to check if a user has dnd enabled, and if so, it likely provides details such as when the dnd period started and when it's scheduled to end. use this endpoint when you need to determine a user's availability or to respect their notification preferences before sending messages. it's particularly useful for applications that need to manage communication timing or display user status. note that this endpoint does not modify the dnd status; it's for information retrieval only.
</Accordion>

<Accordion title="Set team icon using url">
  Sets the icon for a specific slack workspace within an enterprise grid organization. this endpoint allows administrators to update the visual identity of a workspace by providing a new icon image url. it's particularly useful for maintaining brand consistency across multiple workspaces or updating the appearance of a specific team's workspace. this method is exclusive to enterprise grid workspaces and requires appropriate administrative permissions. use this endpoint when you need to programmatically update workspace icons, such as during workspace setup automation or brand refresh initiatives.
</Accordion>

<Accordion title="Schedule message in chat">
  The chat.schedulemessage endpoint allows you to schedule a message for future delivery in a slack channel, direct message, or private group. this powerful feature enables automated, time-based communication within your slack workspace. use this endpoint when you need to send messages at specific times, such as reminders, announcements, or recurring updates. the scheduled message can include rich formatting using attachments or blocks, and supports various customization options like threading and link unfurling. keep in mind that scheduled messages are typically limited to 120 days in the future, and the scheduling user must have the necessary permissions in the target channel.
</Accordion>

<Accordion title="Set user account expiration timestamp">
  Sets an expiration date for a guest user account in a slack workspace. this endpoint allows workspace administrators to automatically disable guest access after a specified time, enhancing security and access control. it should be used when granting temporary access to external collaborators or for time-limited projects. the expiration is set using a unix timestamp, allowing precise control over when the guest account will be disabled. this method only applies to guest accounts and cannot be used to set expirations for regular workspace members or multi-channel guests.
</Accordion>

<Accordion title="Retrieve call information">
  The calls.info endpoint retrieves detailed information about a specific call in a slack workspace. it allows developers to access comprehensive data about a call, including its participants, duration, status, and any associated metadata. this endpoint is particularly useful for applications that need to track or analyze call activity within slack, such as reporting tools or integration with other communication platforms. it should be used when detailed information about a specific call is required, rather than for listing multiple calls or initiating new calls. the endpoint returns a snapshot of the call data at the time of the request and does not provide real-time updates or streaming capabilities.
</Accordion>

<Accordion title="Set conversation read cursor">
  The 'conversations.mark' endpoint sets the read cursor in a slack channel or conversation, marking a specific message as the last one read by the user. this function is essential for managing unread message indicators and tracking user engagement within slack conversations. use this endpoint when you need to programmatically update a user's read position, such as when implementing custom slack clients or managing user interactions in integrated applications. the endpoint is particularly useful for maintaining accurate scroll-back history in busy channels or for synchronizing read status across multiple devices. note that this action only affects the calling user's read cursor and does not impact other members of the conversation.
</Accordion>

<Accordion title="Set workspace name">
  The admin.teams.settings.setname endpoint allows workspace owners or administrators to change the name of a slack workspace. this operation updates the workspace name displayed in menus, headings, and other areas throughout the slack interface. use this endpoint when you need to rebrand a workspace, reflect organizational changes, or simply update the workspace name for clarity. the new name will be visible to all members of the workspace immediately after the change. note that this action may affect integrations or scripts that rely on the workspace name, so it should be used cautiously and communicated to team members in advance. this endpoint requires administrative privileges and should only be used by authorized personnel with the appropriate permissions.
</Accordion>

<Accordion title="Update remote file metadata">
  The 'files.remote.update' endpoint allows you to update the metadata and content of remote files that have been shared in slack. this tool is useful for keeping shared file information up-to-date, such as modifying titles, updating urls, or refreshing preview images. it can be used when file details change externally or when you need to enhance the file's representation within slack. the endpoint doesn't upload new files but rather updates existing remote file references. note that while you can update various attributes, you cannot change the fundamental nature of the file (e.g., converting from one file type to another) through this endpoint.
</Accordion>

<Accordion title="Update views endpoint">
  The views.update method is used to update an existing modal view in slack. it allows you to dynamically modify the content and structure of a modal that is already open for a user. this method is particularly useful for updating interactive components within a modal based on user actions or external events. to use this method, you must provide either the view id or external id to identify the specific view to be updated, along with a new view definition object. the optional hash parameter can be used to prevent race conditions when updating views asynchronously.
</Accordion>

<Accordion title="Retrieve users profile information">
  The users.profile.get endpoint retrieves the profile information of a slack user. it allows you to fetch details such as display name, status, profile picture, and custom fields associated with a user's profile. this endpoint is particularly useful when you need to access up-to-date information about a specific user or the authenticated user. the retrieved data can be used for various purposes, such as populating user information in integrated applications or displaying user details in custom interfaces. note that while the endpoint provides comprehensive profile information, it does not include data about the user's participation in channels or their message history.\<\<DEPRECATED use retrieve\_user\_profile\_information>>
</Accordion>

<Accordion title="Get user identity">
  The users.identity endpoint retrieves the identity of a slack user associated with the provided token. it allows applications to verify and access basic information about the authenticated user. this endpoint is particularly useful when you need to confirm the identity of a user interacting with your slack app or integration. it should be used when you require up-to-date user information or need to validate a user's identity within your application's workflow. the endpoint returns basic user details but does not provide extensive profile information or team-wide data. note that the specific user information returned may depend on the scopes granted to your application during the oauth process.
</Accordion>

<Accordion title="Reset user session">
  The admin.users.session.reset endpoint is used to invalidate all active sessions for a specified user in slack. this powerful administrative tool forces the user to log in again by wiping out their current sessions across all devices. it's particularly useful for security purposes, such as when a user's credentials may have been compromised, or when enforcing new security policies. the endpoint allows for selective session resets, targeting either mobile or web sessions, or both. it should be used cautiously as it can disrupt user access and ongoing work. this method requires administrative privileges and should only be employed when necessary for security or compliance reasons.
</Accordion>

<Accordion title="Revoke file public url">
  The 'files.revokepublicurl' endpoint revokes public and external sharing access for a specific file in slack. use this endpoint when you need to disable public sharing of a previously shared file, enhancing privacy and control over sensitive information. this method is particularly useful for situations where a file was accidentally made public or when the sharing period needs to end. the endpoint returns a file object containing updated sharing information, allowing you to confirm the revocation was successful. note that this action is irreversible, and you'll need to create a new public url if sharing is required again in the future.
</Accordion>

<Accordion title="Update user group details">
  The usergroups.update endpoint allows you to modify an existing user group within a slack workspace. it enables updating various properties of a user group, including its name, description, mention handle, and default channels. this endpoint is particularly useful when you need to adjust user group details to reflect changes in team structure, communication needs, or organizational shifts. use it to keep user groups current and relevant, ensuring efficient team management and targeted communication. the endpoint requires the user group id and allows optional updates to other properties, providing flexibility in managing group characteristics without recreating the entire group.
</Accordion>

<Accordion title="Send custom message to channel">
  The chat.memessage endpoint allows you to send a "me message" to a specified slack channel. a "me message" is a special type of message that appears as an action performed by the user, typically used for status updates or to describe actions in the third person. this endpoint is useful when you want to share status updates, mood, or actions in a more expressive and visual way than a standard message. it should be used when you want to simulate irc-style /me messages in slack. note that while this endpoint provides a unique way to communicate, it doesn't support rich text formatting or attachments like standard messages do.
</Accordion>

<Accordion title="Update slack chat message attributes">
  The chat.update endpoint allows you to modify an existing message in a slack channel. it's used when you need to update the content, attachments, or formatting of a previously sent message. this can be particularly useful for updating dynamic content, correcting errors, or providing real-time updates to information. the endpoint requires specifying both the channel and the timestamp of the message to be updated. it offers flexible options for updating the message text, attachments, and blocks, allowing for rich formatting and interactive elements. however, it's important to note that this endpoint can't be used to update messages sent by other users or apps, and there may be time limitations on how long after a message is sent that it can be updated.
</Accordion>

<Accordion title="Share remote files">
  Shares a previously added remote file into one or more slack channels or conversations. this endpoint allows you to make a remote file visible in specific slack channels without re-uploading the file. it's useful for sharing files that are stored in external services but need to be accessible within slack conversations. the file must have been added to slack beforehand using the 'files.remote.add' method. this endpoint should be used when you want to distribute a remote file to multiple channels or threads efficiently. it does not support sharing files that were directly uploaded to slack.
</Accordion>

<Accordion title="Unarchive admin channel conversations">
  Unarchives a previously archived slack channel, making it active and accessible to users again. this endpoint should be used when an administrator needs to restore a channel that was previously archived, allowing team members to resume conversations and access shared content. it's particularly useful for reactivating seasonal or project-based channels that may have been temporarily archived. note that this action is only available to administrators in enterprise grid or business+ organizations and requires specific administrative permissions. the endpoint does not provide information about the channel's content or members; it simply changes the channel's status from archived to active.
</Accordion>

<Accordion title="Set user profile key">
  The users.profile.set endpoint allows updating a user's profile information in slack. it can be used to modify both default profile fields (such as first name, last name, and email) and custom profile fields. this endpoint offers flexibility in updating either multiple fields at once or a single field, making it suitable for various profile management scenarios. team administrators on paid slack teams can use this endpoint to update profiles of other team members by specifying the 'user' parameter. the endpoint is particularly useful for keeping user information up-to-date, managing custom fields, and automating profile updates in integrated workflows. however, it's important to note the limitation of updating a maximum of 50 fields at once, and each field name is restricted to 255 characters.
</Accordion>

<Accordion title="Update call information">
  The 'calls.update' endpoint allows you to modify the details of an existing call in slack. this method is used to update call information such as the title, join url, and desktop app join url. it's particularly useful for keeping call information current, especially when call details change after initial creation. the endpoint requires the unique call id and allows optional updates to the call's title and access urls. this method is essential for maintaining accurate and up-to-date call information within slack, enhancing user experience and ensuring smooth integration with third-party call services. note that this endpoint only updates the specified fields and doesn't affect other call properties not included in the request.
</Accordion>

<Accordion title="Request app permissions for user">
  The apps.permissions.users.request endpoint initiates a request for additional user-level permissions for a slack app. this method is used when an app needs to expand its access to user data or actions within a slack workspace. it's particularly useful for apps that require dynamic permission scaling based on user interactions or evolving feature sets. the endpoint likely triggers a permission request prompt for the user, allowing them to grant or deny the additional permissions. note that this endpoint doesn't directly grant permissions; it only starts the request process. the actual permission changes would occur after user approval through the oauth flow. use this endpoint cautiously and only when absolutely necessary to maintain user trust and adhere to privacy best practices.
</Accordion>

<Accordion title="Lookup users by email">
  The users.lookupbyemail endpoint retrieves detailed information about a single slack user by searching for their registered email address. this method is particularly useful when you need to find a user's slack profile details but only have their email address available. the endpoint returns a comprehensive user object containing various fields such as user id, display name, and other profile information if the user is active. however, it will return a 'users not found' error if the user has been deactivated or if no user with the specified email exists in the workspace. this method requires the 'users:read.email' scope for authentication and should be used judiciously to respect user privacy.\<\<DEPRECATED use find\_user\_by\_email\_address>>
</Accordion>

<Accordion title="Establish real time messaging connection">
  The rtm.connect endpoint initiates a websocket-based real-time messaging (rtm) session with slack. it provides a websocket url and initial workspace metadata, allowing applications to establish a real-time connection for receiving events and sending messages. this endpoint should be used when implementing real-time features such as live updates or instant messaging within a slack integration. the connection is single-use and valid for only 30 seconds, so applications must act quickly to establish the websocket connection. it's important to note that this method doesn't support passing a presence value, unlike its counterpart rtm.start.
</Accordion>

<Accordion title="Update user group users">
  Updates the list of users in a slack user group. this endpoint allows you to completely replace the existing list of users in a specified user group with a new set of users. it's useful for bulk updates to group membership, such as when syncing with an external user management system or reorganizing teams. the endpoint requires the user group id and a full list of user ids to be included in the group. optionally, you can request a count of users in the group after the update. note that this operation will overwrite the existing user list, so ensure you include all desired users in the update.
</Accordion>

<Accordion title="Uninstall app">
  The apps.uninstall endpoint allows you to remove a slack app from a workspace or an entire enterprise organization. this method revokes all tokens associated with a single installation of an app, effectively uninstalling it. use this endpoint when you need to programmatically remove a slack app, either due to user request, compliance reasons, or as part of app lifecycle management. it's particularly useful for administrators and app developers who need to manage app installations across multiple workspaces. note that uninstalling an app will immediately terminate its access and functionality within the slack environment, so use this method with caution.
</Accordion>

<Accordion title="Unpin message from channel">
  The 'pins.remove' endpoint allows you to remove a pinned message from a specified slack channel. this function is useful for decluttering important information in a channel or removing outdated pinned content. it requires specifying the channel where the pinned item is located and optionally, the timestamp of the specific message to be un-pinned. if the timestamp is not provided, the behavior may default to removing the most recently pinned item. use this endpoint when you need to programmatically manage pinned content in slack channels, such as in automation workflows or when maintaining channel organization. note that this action cannot be undone, so use it cautiously.
</Accordion>

<Accordion title="Update workflow step">
  The workflows.updatestep method allows you to update the configuration of an existing workflow step in slack's workflow builder. this endpoint is essential for dynamically modifying workflow steps, enabling you to adjust inputs, outputs, and other properties of a step based on changing requirements or user interactions. it's particularly useful for maintaining and evolving complex workflows without rebuilding them from scratch. this method should be used when you need to programmatically update a workflow step's configuration, such as changing input fields, modifying output data structures, or updating the step's visual representation in the workflow builder. note that this endpoint is only available for org-ready apps with proper event subscriptions set up, and it replaces the deprecated "legacy steps from apps" feature.
</Accordion>

<Accordion title="Retrieve chat permalink">
  Retrieves a permalink url for a specific message in a slack channel. this endpoint is used when you need to generate a shareable link to a particular message, allowing easy reference and access to the message content. the permalink can be used to quickly navigate to the exact message within the slack interface, even if it's part of a thread or in a private channel (provided the user has appropriate permissions). this method is particularly useful for creating links to important messages, sharing context in discussions, or integrating slack message references into other tools or documentation. note that the generated permalink respects slack's privacy settings, so users will only be able to access the message if they have the necessary permissions in the slack workspace.
</Accordion>

<Accordion title="Get user information">
  The users.info endpoint retrieves detailed information about a specific user in a slack workspace. it returns comprehensive profile data including the user's name, email, role, status, and other relevant details. this endpoint is particularly useful when you need to fetch up-to-date information about a user, such as checking their current status, verifying their role, or accessing their contact information. it should be used when detailed user data is required for user management, profile display, or integration with other systems. note that while this endpoint provides extensive user information, it does not return data about the user's message history or channel memberships.
</Accordion>

<Accordion title="Retrieve file information">
  The files.info endpoint retrieves detailed metadata about a specific file in slack. it allows you to fetch comprehensive information about a file, including its properties, sharing status, and associated data. this endpoint is particularly useful when you need to access or display detailed file information within your application or integration. the method returns a file object containing various attributes such as file type, size, creation date, and sharing details. it's important to note that this endpoint only provides metadata and does not download the actual file content.
</Accordion>

<Accordion title="Upload file to specific channels">
  The files.upload endpoint allows you to upload files to slack channels. use this tool to share various content types, including documents and images, within slack conversations. it supports both direct content uploads and multipart form data, enabling text-based and binary file uploads. you can provide context like title, initial comment, and target channels. authentication with 'files:write:user' scope is required.
</Accordion>

<Accordion title="Get file remote info">
  Retrieves detailed information about a remote file that has been added to slack. this endpoint is used when you need to access metadata and current status of a file that exists externally but has been registered with slack. it's particularly useful for tracking the sharing status, permissions, and other slack-specific attributes of the remote file. the endpoint doesn't download or modify the file itself; it only provides information about how the file is represented within slack. use this when you need to verify the file's current state in slack or before performing operations like updating or sharing the remote file.
</Accordion>

<Accordion title="Retrieve team profile">
  Retrieves the profile information for a slack team, including both custom and default profile fields. this endpoint is useful for obtaining comprehensive details about a team's profile structure, such as field definitions, labels, and visibility settings. it can be used to gather information for team management, integration purposes, or to populate user interfaces with team-specific data. the endpoint does not modify any team data and is read-only, making it safe for frequent calls to keep local data in sync with slack's servers.
</Accordion>

<Accordion title="Unarchive conversation">
  The 'conversations.unarchive' endpoint allows you to restore an archived conversation (channel) in slack, making it active and accessible again. this method is useful when you need to reactivate a previously archived channel for continued use. it's particularly handy for teams that temporarily archive channels for organizational purposes or to reduce clutter, but later decide to resume activities in that conversation. the endpoint requires specifying the exact channel id to be unarchived. note that this operation can only be performed on channels that are currently in an archived state; attempting to unarchive an active channel will result in an error. also, be aware that unarchiving a channel may affect channel limits for your slack workspace, depending on your current plan and usage.
</Accordion>

<Accordion title="Retrieve users profile information">
  The users.profile.get endpoint retrieves the profile information of a slack user. it allows you to fetch details such as display name, status, profile picture, and custom fields associated with a user's profile. this endpoint is particularly useful when you need to access up-to-date information about a specific user or the authenticated user. the retrieved data can be used for various purposes, such as populating user information in integrated applications or displaying user details in custom interfaces. note that while the endpoint provides comprehensive profile information, it does not include data about the user's participation in channels or their message history.
</Accordion>

<Accordion title="Revoke authentication token">
  Revokes an access token, effectively invalidating it for future use. this endpoint should be called when an application needs to programmatically revoke a token, such as during user logout or when a token is compromised. it's a crucial security measure for managing token lifecycles. the revocation is immediate and permanent; once revoked, the token cannot be reactivated. this endpoint doesn't return the revoked token or any user information for security reasons.
</Accordion>

<Accordion title="Search messages endpoint">
  The search.messages endpoint allows you to search for messages across all channels, direct messages, and private groups in a slack workspace. it provides powerful search capabilities to find specific content within conversations. this endpoint is particularly useful for retrieving historical information, locating important discussions, or building search functionality into slack-integrated applications. the search results include message content, associated metadata, and can be refined using various parameters for sorting, highlighting, and pagination. keep in mind that the search may not include very recent messages due to indexing delays, and there may be rate limits on the number of requests you can make in a given time period.\<\<DEPRECATED use search\_for\_messages\_with\_query>>
</Accordion>

<Accordion title="Set user photo with cropping">
  The users.setphoto endpoint allows users to upload and set their profile photo in slack. this method accepts an image file via multipart/form-data and provides optional cropping functionality. use this endpoint when a user wants to change their profile picture or when an application needs to programmatically update a user's photo. the endpoint supports various image formats and automatically resizes large images. if cropping is desired, all three cropping parameters (crop x, crop y, crop w) must be provided together for precise photo customization.
</Accordion>

<Accordion title="Set regular user in team">
  This endpoint converts a user's role to a regular user within a specific slack enterprise grid workspace. it can be used to downgrade the permissions of guests, admins, or owners to standard user privileges. the endpoint is specifically designed for enterprise grid organizations and should be used when there's a need to adjust user roles for organizational management purposes. it's important to note that this action can have significant impacts on user permissions and should be used carefully. the endpoint doesn't provide information about the user's previous role or confirm the success of the role change in the response.
</Accordion>

<Accordion title="Set team description">
  Sets a new description for a specified slack workspace. this endpoint allows workspace administrators to update the team's description, which is typically visible to all members and helps convey the purpose or focus of the workspace. use this when you need to modify the existing workspace description or set an initial description for a newly created workspace. the endpoint is particularly useful for maintaining up-to-date information about the workspace, especially after organizational changes or shifts in team focus. note that this operation will overwrite any existing description, so ensure you have the full desired text ready before making the api call.
</Accordion>

<Accordion title="Post ephemeral message to user">
  The 'chat.postephemeral' endpoint allows you to send an ephemeral message to a specific user within a slack channel. ephemeral messages are temporary and only visible to the specified user, making them ideal for personalized notifications, alerts, or responses that don't need to be seen by the entire channel. this endpoint is particularly useful for interactive workflows, providing user-specific information, or sending sensitive data that shouldn't be visible to all channel members. the message can be customized with various formatting options, including attachments and block kit elements, allowing for rich, interactive content. keep in mind that ephemeral messages are not permanently stored and cannot be retrieved once they disappear, so they should not be used for critical information that needs to be referenced later.
</Accordion>

<Accordion title="Set default team channels">
  Sets default channels for a specified slack workspace. this endpoint allows workspace administrators to define which public channels new members will automatically join when they are added to the workspace. it's useful for ensuring new members have immediate access to important company-wide information channels. the endpoint should be used when updating onboarding processes or reorganizing workspace structure. note that only public channels can be set as default, and this action requires administrative privileges.
</Accordion>

<Accordion title="Manage channel workspaces settings">
  The admin.conversations.setteams endpoint allows slack enterprise grid administrators to manage the workspace associations of a specific channel. it enables sharing a channel across multiple workspaces or converting it to an org-wide channel visible to the entire enterprise grid organization. this endpoint is crucial for facilitating cross-workspace collaboration and centralizing important channels. it should be used when there's a need to expand a channel's reach beyond its original workspace or to streamline communication across the organization. however, it's important to note that this endpoint requires administrative privileges and should be used cautiously to maintain proper channel organization and access control.
</Accordion>

<Accordion title="Set team discoverability">
  Sets the discoverability setting for a specific slack workspace within an enterprise grid organization. this endpoint allows administrators to control the visibility and accessibility of a workspace to external users. it should be used when you need to change how a workspace can be discovered or joined by potential new members. the endpoint requires both the workspace id and the desired discoverability setting. it's important to note that this action can have significant implications for workspace access and should be used carefully, considering the organization's security and collaboration needs.
</Accordion>

<Accordion title="Set conversation preferences for channel">
  Sets or updates the preferences for a specific slack conversation (channel). this endpoint allows administrators to configure various settings for a channel, such as who can post messages, whether threads can be used, or if huddles are allowed. it's particularly useful for managing large workspaces or enforcing specific policies across different channels. the endpoint should be used when there's a need to programmatically adjust channel settings, especially in bulk operations or when integrating with other management tools. note that this endpoint requires administrative privileges and may not be available to all users or in all slack plans.
</Accordion>

<Accordion title="Get user information">
  The users.info endpoint retrieves detailed information about a specific user in a slack workspace. it returns comprehensive profile data including the user's name, email, role, status, and other relevant details. this endpoint is particularly useful when you need to fetch up-to-date information about a user, such as checking their current status, verifying their role, or accessing their contact information. it should be used when detailed user data is required for user management, profile display, or integration with other systems. note that while this endpoint provides extensive user information, it does not return data about the user's message history or channel memberships.\<\<DEPRECATED use retrieve\_detailed\_user\_information>>
</Accordion>

<Accordion title="List users endpoint">
  The 'users.list' endpoint retrieves a comprehensive list of users within a slack workspace. it provides detailed information about each user, including their profile data, account settings, and team memberships. this endpoint is particularly useful for applications that need to synchronize user data, manage user permissions, or perform bulk operations on user accounts. the response includes both active and deactivated users, allowing for a complete overview of the workspace's user base. however, it's important to note that the endpoint may not return real-time data, and there might be a slight delay in reflecting recent changes to user accounts.\<\<DEPRECATED use list\_all\_slack\_team\_users\_with\_pagination>>
</Accordion>

<Accordion title="Search admin conversations">
  The admin.conversations.search endpoint allows slack workspace administrators to search for conversations across their organization. it enables finding specific channels based on criteria like team membership, names, or topics. this tool is useful for managing large enterprises with multiple teams, helping admins organize their slack workspace effectively. it supports pagination and filtering, making it ideal for auditing channel usage or locating specific project-related channels.
</Accordion>

<Accordion title="Post message to channel">
  The chat.postmessage endpoint allows you to send a message to a slack channel or user. this versatile tool can be used to post simple text messages, create rich interactive messages with blocks or attachments, initiate or reply to threads, and customize the appearance of bot messages. it's ideal for sending notifications, updates, or interactive content to slack users or channels programmatically. the endpoint supports extensive customization of message content and appearance, making it suitable for a wide range of use cases from simple notifications to complex interactive workflows. however, it's important to note that the message structure and appearance may vary depending on the slack client and the parameters used.
</Accordion>

<Accordion title="Get conversation info">
  The conversations.info endpoint retrieves detailed information about a specific conversation in slack. it provides comprehensive data about channels, direct messages, or multi-person direct messages, including their properties, members, and settings. this endpoint is particularly useful when you need to access metadata about a conversation, such as its name, purpose, creation date, or membership details. it should be used when detailed information about a specific slack conversation is required, rather than for listing multiple conversations or accessing message content. note that while this endpoint provides extensive metadata, it does not return the actual messages within the conversation; for that, you would need to use a separate endpoint like conversations.history.
</Accordion>

<Accordion title="Set conversation topic">
  Sets or updates the topic for a specified slack conversation. this endpoint allows you to change the topic of any type of slack conversation, including public channels, private channels, direct messages, and group conversations. the topic is a brief description or subject line that appears at the top of the conversation, helping team members understand its purpose or current focus. use this when you need to programmatically update or set a conversation's topic. note that the new topic does not support any text formatting or automatic link creation (linkification). the authenticated user must have the necessary permissions to modify the topic in the specified conversation.
</Accordion>

<Accordion title="Set conversation purpose">
  The 'conversations.setpurpose' endpoint allows you to set or update the purpose (description) of a slack conversation. this function is useful for providing context and clarity about the intended use of a channel, group, or direct message. use this endpoint when you need to establish or modify the purpose of a conversation, which can help team members understand its focus and relevance. the endpoint requires specifying the conversation id and the new purpose text. it's important to note that the calling user must be a member of the conversation to set its purpose, and the new purpose is subject to slack's character limit restrictions.
</Accordion>


# Slack   user
Source: https://docs.push.ai/integrations/slack___user



Search Slack messages, private and public channels for important business context on any Query

<Accordion title="Search messages endpoint">
  The search.messages endpoint allows you to search for messages across all channels, direct messages, and private groups in a slack workspace. it provides powerful search capabilities to find specific content within conversations. this endpoint is particularly useful for retrieving historical information, locating important discussions, or building search functionality into slack-integrated applications. the search results include message content, associated metadata, and can be refined using various parameters for sorting, highlighting, and pagination. keep in mind that the search may not include very recent messages due to indexing delays, and there may be rate limits on the number of requests you can make in a given time period.
</Accordion>

<Accordion title="Search messages">
  Search public channels, private channels and direct messages you are part of for a given query
</Accordion>

<Accordion title="List users">
  The 'users.list' endpoint retrieves a comprehensive list of users within a slack workspace. it provides detailed information about each user, including their profile data, account settings, and team memberships. this endpoint is particularly useful for applications that need to synchronize user data, manage user permissions, or perform bulk operations on user accounts. the response includes both active and deactivated users, allowing for a complete overview of the workspace's user base. however, it's important to note that the endpoint may not return real-time data, and there might be a slight delay in reflecting recent changes to user accounts.
</Accordion>


# Slackbot
Source: https://docs.push.ai/integrations/slackbot



Slackbot automates responses and reminders within Slack, assisting with tasks like onboarding, FAQs, and notifications to streamline team productivity

<Accordion title="Add remote file with authentication token">
  The 'files.remote.add' endpoint allows you to add a remote file to slack, making it accessible and shareable within the platform. this method is used when you want to integrate external files into slack conversations without uploading the actual file content to slack's servers. it's particularly useful for large files, frequently updated documents, or content that needs to remain hosted externally. the endpoint creates a reference to the external file, allowing slack users to view and interact with it as if it were a native slack file. note that this method only creates a link to the file; it does not duplicate or store the file content on slack's infrastructure.
</Accordion>

<Accordion title="Set snooze duration via minutes">
  Sets a temporary "do not disturb" (dnd) snooze period for the authenticated user in slack. this endpoint allows you to programmatically pause notifications for a specified duration, helping users maintain focus without interruptions. the snooze period starts immediately upon successful api call and lasts for the number of minutes specified. this is particularly useful for integrations that manage user availability or for creating custom dnd controls within your slack-connected applications. note that this will override any existing dnd settings for the user.
</Accordion>

<Accordion title="Assign user to workspace">
  This endpoint assigns a user to a specific slack workspace with customizable access levels. it allows administrators to add a user to a workspace as a regular member, a guest (restricted), or a single-channel guest (ultra-restricted). the endpoint also provides the option to automatically add the user to specific channels upon assignment. use this when you need to programmatically add users to a workspace with precise control over their access rights and initial channel memberships. it's particularly useful for large-scale user management or when integrating slack with external user management systems. note that this endpoint requires appropriate admin permissions to execute successfully.
</Accordion>

<Accordion title="Add star to channel message">
  The 'stars.add' endpoint allows users to add a star to various items within slack, including channels, files, file comments, or specific messages. this method is used to mark items for later reference or to indicate importance. it's particularly useful for creating personal bookmarks or highlighting significant content within the slack workspace. the endpoint is flexible, allowing users to star different types of content by specifying the appropriate parameters. however, users should be aware that only one type of item (channel, file, file comment, or message) can be starred per api call. this endpoint should be used when users want to programmatically add stars to slack items, which can be helpful for integrations or automating workspace organization.
</Accordion>

<Accordion title="Add emoji alias">
  This endpoint allows slack workspace administrators to create an alias for an existing emoji within an enterprise grid organization. it's used to give alternative names to emojis, making them easier to find or use. this is particularly useful for creating shortcuts to frequently used emojis or standardizing emoji names across teams. the alias will function identically to the original emoji. note that this endpoint is only available for enterprise grid customers and requires administrative privileges. it does not create new emojis, but rather creates new ways to reference existing ones.
</Accordion>

<Accordion title="Add admin emoji">
  Adds a custom emoji to a slack workspace. this endpoint allows workspace administrators to upload new emojis that can be used by all members in messages and reactions. it requires specifying a unique name for the emoji and providing a url to the image file. the function is useful for personalizing a workspace with brand-specific or team-specific emojis. note that there may be limits on the total number of custom emojis allowed in a workspace, and overuse can impact performance. use this endpoint when you need to programmatically add new emojis to enhance team communication and expression.
</Accordion>

<Accordion title="Add channels to usergroup">
  Adds default channels to a specified user group in a slack workspace. this endpoint allows administrators to automatically include members of a user group in designated channels, streamlining onboarding and ensuring consistent access to relevant information. it's particularly useful for setting up standard channel memberships for different roles or departments within an organization. the endpoint should be used when configuring or updating user group settings, especially after creating a new user group or when organizational changes require adjustments to default channel memberships. note that this operation adds to, rather than replaces, any existing default channels for the user group.
</Accordion>

<Accordion title="Add reaction to message">
  Adds a reaction (emoji) to a specific message in a slack channel. this endpoint allows users to interact with messages by adding emojis as reactions, enhancing engagement and communication within slack. it should be used when a user wants to express a quick response or sentiment to a message without sending a new message. the endpoint requires specifying the target channel, the emoji name, and the timestamp of the message to react to. it's important to note that the user must have access to the specified channel and message, and the emoji must be available in the slack workspace. this endpoint does not support removing reactions or retrieving existing reactions on a message.
</Accordion>

<Accordion title="Archive conversations channel">
  The admin.conversations.archive endpoint allows workspace administrators to archive a specific slack channel. this action preserves the channel's content in a read-only state, preventing further messages from being posted while retaining historical data. use this endpoint when you need to close a channel that is no longer active or relevant, but want to keep its contents accessible for reference. it's important to note that archiving a channel is reversible; archived channels can be unarchived if needed. however, exercise caution when using this endpoint, as it affects all members of the channel and may impact ongoing conversations or workflows.
</Accordion>

<Accordion title="Approve admin apps request">
  The admin.apps.approve endpoint is used to approve an app installation request in a slack workspace or across an entire enterprise. this method allows administrators to grant permission for a specific app to be installed or used within their slack environment. it is primarily used in enterprise grid workspaces where app installations require admin approval for security and compliance reasons. the endpoint should be used when an administrator needs to review and approve a pending app installation request, either for a single workspace or organization-wide. it requires admin-level permissions and can only be executed by users with appropriate administrative access. this method is crucial for maintaining control over the apps used within a slack organization and ensuring that only approved apps are allowed to integrate with the workspace.
</Accordion>

<Accordion title="Archive conversation endpoint">
  The 'conversations.archive' endpoint archives a specified slack conversation, making it unavailable for new messages while preserving its history. this method can be used for both public and private channels, but not all types of conversations can be archived. use this endpoint when you need to remove a conversation from active use without deleting its content. it's particularly useful for maintaining a clean workspace by archiving inactive or completed project channels. note that archiving a conversation may affect integrations or workflows that depend on it, so use with caution. certain types of conversations, such as general channels or those required by app installations, cannot be archived.
</Accordion>

<Accordion title="Restrict access by group in private channel">
  This endpoint adds an identity provider (idp) group to a private channel's allowlist in slack, restricting access to only members of the specified group. it's designed for enterprise grid workspaces to enhance security and access control. use this when you need to limit channel access to specific groups within your organization. the endpoint is particularly useful for creating secure communication spaces for teams or projects with sensitive information. note that this operation only applies to private channels and requires administrative privileges.
</Accordion>

<Accordion title="List permissions scopes for apps">
  Retrieves a list of oauth scopes associated with the authenticated slack app. this endpoint allows developers to view the current permissions granted to their app within a slack workspace. it's particularly useful for auditing app permissions, verifying the app's access levels, or preparing for permission changes. the endpoint returns all scopes the app has been granted, which can include both bot and user token scopes. it should be used when you need to review or confirm the current set of permissions for your slack app. note that this endpoint does not modify any permissions; it only provides a read-only view of the existing scopes.\<\<DEPRECATED use list\_app\_permissions\_scopes\_on\_a\_team>>
</Accordion>

<Accordion title="Approve invite request for team">
  The admin.inviterequests.approve endpoint allows workspace administrators to approve pending invite requests for their slack workspace. this method is used to grant access to individuals who have requested to join the workspace. it's particularly useful for managing access in controlled or private workspaces where new member additions require explicit approval. the endpoint should be used when an administrator has reviewed and decided to accept an invite request. it's important to note that this action is irreversible, and once approved, the invited user will gain access to the workspace. this endpoint is not for creating new invite requests or for bulk approvals; it processes one invite request at a time.
</Accordion>

<Accordion title="Get app permissions info">
  Retrieves detailed information about the permissions granted to a slack application. this endpoint is used to audit and review the current set of permissions associated with an app, helping developers and administrators understand the app's capabilities within a slack workspace. it provides a comprehensive list of all permissions the app has been granted, which is crucial for security audits, troubleshooting, or when preparing to request additional scopes. the endpoint does not modify any permissions; it only returns the current state. note that the permissions returned are specific to the app associated with the authentication token used in the request.\<\<DEPRECATED use list\_app\_permissions\_on\_a\_team>>
</Accordion>

<Accordion title="Auth test api endpoint">
  The auth.test endpoint is used to validate and test the authentication token provided in the request. it verifies the token's validity and returns information about the authenticated user or bot. this endpoint is particularly useful for checking if a token is still valid, identifying the associated user or bot, and determining the scopes granted to the token. it should be used when you need to confirm the authentication status or retrieve basic information about the authenticated entity without making changes to any data. the endpoint does not modify any data or perform any actions beyond authentication verification.
</Accordion>

<Accordion title="Api test endpoint">
  The api.test endpoint is a simple method used to test the functionality of the slack api. it allows developers to verify that their authentication credentials are working correctly and that they can successfully connect to the slack platform. this endpoint doesn't perform any specific actions within a slack workspace but instead returns a basic response to confirm that the api is operational. it's particularly useful during initial setup, when troubleshooting connectivity issues, or as part of automated health checks to ensure ongoing api availability. the endpoint requires no parameters and typically returns a minimal json response indicating a successful connection.
</Accordion>

<Accordion title="Convert channel to private">
  Converts a specified public slack channel to a private channel. this endpoint allows slack workspace administrators to change the visibility and accessibility of a channel from public to private. once converted, the channel will only be visible and accessible to invited members, enhancing privacy and control over sensitive conversations. this action is irreversible and should be used cautiously, as it may impact team communication and workflows. it's particularly useful for situations where a previously public channel needs to be restricted due to changes in project scope, team structure, or information sensitivity.
</Accordion>

<Accordion title="Delete file comment">
  This endpoint allows you to delete a specific comment on a file in a slack workspace. it is used when you need to remove a comment from a file, either for moderation purposes or to clean up outdated or irrelevant feedback. the endpoint requires both the file identifier and the comment identifier to ensure precise targeting of the comment to be deleted. it's important to note that this action is irreversible, so it should be used with caution. this endpoint is particularly useful for maintaining a clean and relevant discussion around shared files in slack.
</Accordion>

<Accordion title="Add teams to usergroup">
  This endpoint adds one or more teams (workspaces) to a specified user group within a slack organization. it's used to extend the reach of a user group across multiple workspaces, facilitating organization-wide management of user groups. the endpoint is particularly useful for administrators managing large, multi-workspace organizations who need to ensure consistent group membership across teams. it supports auto-provisioning of accounts for external idp group members, streamlining the process of integrating external users into slack workspaces. note that this operation requires admin-level permissions and can only be performed on teams within the same organization as the api token.
</Accordion>

<Accordion title="End call with duration">
  The 'calls.end' endpoint is used to terminate an ongoing call in slack. this method is part of the slack calls api and allows developers to programmatically end a call that was previously initiated and registered using the 'calls.add' method. it's particularly useful for integrations that manage call workflows or need to automate call termination based on certain conditions. the endpoint requires the unique call id to identify which call to end, and optionally allows specifying the call duration for record-keeping purposes. it should be used when a call needs to be ended programmatically, such as in scheduled meetings or when integrating with external systems that manage call lifecycles.
</Accordion>

<Accordion title="Delete conversation channel">
  The admin.conversations.delete endpoint allows workspace administrators to permanently delete a channel from a slack enterprise grid organization. this powerful function should be used when a channel is no longer needed and all its contents can be permanently removed. it's important to note that this action is irreversible and will delete all messages and files within the channel. this endpoint is only available for enterprise grid workspaces and requires admin-level permissions. it should be used with caution and typically as part of a careful channel management strategy or data cleanup process.
</Accordion>

<Accordion title="End dnd mode">
  Ends the "do not disturb" (dnd) status for the authenticated user in slack. this endpoint should be used when a user wants to make themselves available for notifications and messages after a period of uninterrupted focus time. it immediately disables the dnd mode, allowing incoming notifications to be received. this method is particularly useful for integrations that manage a user's availability status automatically based on external factors or schedules. note that this endpoint only affects the dnd status and does not modify other user status settings or preferences in slack.
</Accordion>

<Accordion title="Close conversation channel">
  The 'conversations.close' endpoint allows you to close a conversation in slack. this method is specifically used to close direct messages (dms) or multi-person direct messages (mpdms). when invoked, it removes the specified conversation from the user's sidebar in the slack client, effectively 'closing' it from their view. this endpoint is particularly useful for decluttering a user's slack workspace by removing inactive or less relevant conversations from immediate view. it's important to note that closing a conversation does not delete it; the conversation history is preserved and can be reopened later if needed. this method should be used judiciously, especially in shared channels or group conversations, as it only affects the view for the user making the api call.
</Accordion>

<Accordion title="Create public or private channel">
  Creates a new public or private channel (conversation) in a slack workspace or organization. this endpoint allows administrators to programmatically set up channels, specifying whether they should be private or public, team-specific or organization-wide. it's particularly useful for automating workspace setup, creating standardized channels across teams, or implementing custom onboarding processes. the endpoint requires specifying the channel name and privacy setting, with options to add a description and determine the channel's scope within the organization.
</Accordion>

<Accordion title="Create new admin team">
  Creates a new team within a slack enterprise grid workspace. this endpoint allows administrators to set up a new organizational unit, specifying its domain, name, description, and discoverability settings. it's particularly useful for large organizations that need to create separate teams for different departments, projects, or subsidiaries. the endpoint should be used when expanding the workspace structure or setting up new collaborative spaces within the enterprise grid. note that this operation requires administrative privileges and should be used judiciously to maintain a coherent organizational structure.
</Accordion>

<Accordion title="End dnd snooze">
  The dnd.endsnooze endpoint immediately ends the current user's do not disturb (dnd) session in slack, effectively canceling the snooze mode. this method should be used when a user wants to resume receiving notifications before their scheduled dnd period ends. it's particularly useful for situations where a user's focus period has concluded earlier than anticipated or when urgent communication is required. the endpoint doesn't require any parameters and operates on the authenticated user's account. it's important to note that this action cannot be undone, and users will need to manually re-enable dnd if needed after using this endpoint.
</Accordion>

<Accordion title="Delete scheduled chat message">
  This endpoint allows you to delete a scheduled message from slack before it is sent. it is used to remove a message that has been queued for future delivery but is no longer needed or contains errors. the endpoint requires the channel id where the message was scheduled and the unique scheduled message id. you can optionally specify whether to delete the message as an authenticated user or a bot. this method is particularly useful for managing and updating automated message schedules or correcting mistakes in scheduled announcements.
</Accordion>

<Accordion title="Enable user group via id">
  Enables a previously disabled user group in slack, making it active and usable within the workspace. this endpoint is used to reactivate a user group that was previously deactivated, allowing it to be used for mentions, permissions, and other group-based features in slack. it's particularly useful when you need to temporarily disable a group and then re-enable it later. the endpoint requires the unique identifier of the user group and optionally can return the current number of members in the group. it should not be used to create new user groups or modify existing ones beyond their enabled/disabled status.
</Accordion>

<Accordion title="Modify message unfurl behavior">
  The 'chat.unfurl' endpoint allows you to customize the unfurling behavior for urls within a specific slack message. unfurling expands urls into rich content previews, enhancing message readability and context. use this endpoint when you want to add custom previews for urls in a message or initiate a user authentication flow for certain unfurls. it's particularly useful for integrating external services or providing additional context for shared links. the endpoint requires specifying the target message using channel id and timestamp, and offers options for custom unfurl content and user authentication processes. note that this endpoint modifies existing messages and should be used judiciously to maintain conversation clarity.
</Accordion>

<Accordion title="Delete file by id">
  The 'files.delete' endpoint allows you to permanently remove a file from a slack workspace. this method is used when you need to delete a file that is no longer needed or to manage storage space in your slack environment. it's important to note that this action is irreversible - once a file is deleted, it cannot be recovered. this endpoint should be used cautiously, ensuring that the file is no longer required before deletion. it's particularly useful for maintaining data hygiene, complying with data retention policies, or removing sensitive information from the workspace. the endpoint requires the id of the file to be deleted and will remove the file along with any associated comments or shares within slack.
</Accordion>

<Accordion title="Share file public url">
  Creates a public url for sharing a file in slack. this endpoint enables users to generate a publicly accessible link for a specific file, allowing it to be shared with people outside the slack workspace. it's useful when you need to provide file access to external collaborators or for public distribution. note that this action may have security implications, so use it cautiously and only for files that are appropriate for public sharing. the endpoint doesn't create a new file; it simply generates a public url for an existing file in the workspace.
</Accordion>

<Accordion title="Oauth access endpoint">
  The oauth.access endpoint is used to exchange a temporary authorization code for an access token in the slack oauth 2.0 flow. this endpoint should be called after your application has received the authorization code from slack, typically as part of the redirect process after a user has approved your app's requested permissions. the obtained access token is crucial for making authenticated requests to other slack api endpoints on behalf of the user or workspace. this endpoint is a one-time use per authorization code and should be called server-side to keep your client secret secure. it's important to note that this endpoint does not require authentication itself, as it's part of the process to obtain authentication credentials.
</Accordion>

<Accordion title="Get admin conversations teams">
  Retrieves the list of teams associated with a specific slack conversation. this endpoint is designed for slack workspace administrators or organization owners to manage multi-workspace channels. it allows admins to identify which teams (workspaces) have access to a particular conversation, which is crucial for maintaining proper access control and understanding the scope of shared channels. the endpoint should be used when auditing channel access, managing cross-workspace collaborations, or troubleshooting team-related issues in shared channels. note that this endpoint only provides team information and does not allow for modifying team associations.
</Accordion>

<Accordion title="Retrieve oauth token">
  Exchanges a temporary authorization code for an access token in the slack oauth 2.0 flow. this endpoint is used after a user has granted permission to your application, and you've received an authorization code. the returned access token allows your application to make api calls on behalf of the user. this endpoint should be called immediately after receiving the authorization code, as codes typically expire quickly. it's a crucial step in setting up api access for your slack integration.
</Accordion>

<Accordion title="Deny invite request for workspace">
  This endpoint allows workspace administrators to deny an invite request to join a slack workspace. it is used when an administrator wants to reject a pending invitation request, preventing the requester from joining the workspace. the endpoint should be called when reviewing and managing incoming invite requests, particularly when the request does not meet the criteria for approval. it's important to note that this action is irreversible, so administrators should use it carefully. this endpoint does not provide any information about the invite request itself or the reason for denial; it simply processes the denial action.
</Accordion>

<Accordion title="Delete chat message by timestamp">
  Deletes a specific message from a slack conversation. this endpoint should be used when you need to remove a message from a channel, group, or direct message conversation. it's particularly useful for cleaning up bot messages, correcting mistakes, or managing conversation history. the deletion is permanent and cannot be undone, so use with caution. this method requires either 'chat:write:user' or 'chat:write:bot' scope, depending on whether you're deleting as a user or a bot. note that you can only delete messages that were posted by the authenticated user or bot – you cannot delete other users' messages.
</Accordion>

<Accordion title="Invite users to channel">
  Invites specified users to a slack channel. this endpoint allows administrators to add multiple users to a public or private channel simultaneously. it's particularly useful for onboarding new team members or reorganizing channel memberships. the method can handle up to 1000 user invitations at once, making it efficient for bulk operations. however, it's important to note that this endpoint is only available for enterprise grid workspaces, indicating its use is restricted to more advanced slack environments. the calling user must have appropriate permissions and be a member of the target channel.
</Accordion>

<Accordion title="Get team billable info">
  Retrieves billable information for members of a slack team or workspace. this endpoint provides details about which team members are considered billable users, which is crucial for understanding the billing structure and costs associated with your slack workspace. use this endpoint when you need to audit your team's billable members, prepare for billing cycles, or manage your workspace's user allocation. the endpoint returns information about all billable members, but it does not provide detailed billing amounts or invoke any changes to the billing status. it's important to note that this endpoint may have rate limits and should be used judiciously, typically for administrative or reporting purposes rather than real-time operations.
</Accordion>

<Accordion title="Get admin teams settings info">
  Retrieves detailed information about the settings of a specific slack team (workspace) within an enterprise grid organization. this endpoint is crucial for administrators to view and manage workspace configurations across multiple teams. it provides comprehensive data about team settings, including but not limited to, the team's name, description, domain, icon, and other customizable options. use this endpoint when you need to audit, review, or prepare for modifications to a team's settings. note that this endpoint only fetches information and does not modify any settings; separate endpoints are required for making changes.
</Accordion>

<Accordion title="Delete reminder by id">
  The 'reminders.delete' endpoint allows you to remove a specific reminder from a user's list of reminders in slack. this method is used when you need to cancel a previously set reminder, either because the task has been completed or is no longer relevant. it requires the unique id of the reminder to be deleted, which must be obtained from a previous 'reminders.list' or 'reminders.add' operation. the endpoint is particularly useful for maintaining an up-to-date and clutter-free list of reminders for slack users. note that once a reminder is deleted, it cannot be recovered, so use this endpoint with caution.
</Accordion>

<Accordion title="Leave conversation channel">
  The 'conversations.leave' endpoint allows a user to exit a slack conversation, which can be a public channel, private channel, direct message, or group direct message. this method is useful when a user no longer wishes to participate in a specific conversation or needs to remove themselves from a channel. it should be used cautiously, as leaving a conversation may result in missing important team communications. the endpoint will fail if the user is not currently a member of the specified conversation or if they are the last member of a private channel (which would effectively archive the channel). note that this method cannot be used to leave shared channels across organizations.
</Accordion>

<Accordion title="Disable usergroup">
  Disables a specified user group in slack. this endpoint is used to deactivate an existing user group, setting its 'date delete' parameter to a non-zero value. it's particularly useful for archiving or temporarily deactivating groups that are no longer needed. the endpoint requires the id of the user group to be disabled and optionally can return the count of users in the group. use this when you need to manage team structures or clean up inactive groups. note that disabling a user group does not delete it permanently, and it can be re-enabled later if needed.
</Accordion>

<Accordion title="Disconnect shared conversations">
  The admin.conversations.disconnectshared endpoint is used to disconnect a shared slack channel from one or more workspaces. this api method is specifically designed for enterprise grid workspaces and allows administrators to manage slack connect channels and direct messages (dms). it should be used when you need to remove a workspace's access to a shared channel, typically for security, compliance, or organizational restructuring purposes. the endpoint requires administrative permissions and can only disconnect channels that are already shared across workspaces. it's important to note that this action may affect communication and collaboration between teams, so it should be used judiciously and in accordance with your organization's policies.
</Accordion>

<Accordion title="List admin teams">
  Retrieves a list of all teams within a slack enterprise grid organization. this endpoint is part of the admin api and is designed for administrators to get an overview of the teams in their organization. it should be used when you need to audit, manage, or report on the teams across your entire slack instance. the endpoint returns basic information about each team, which may include team ids, names, and other relevant metadata. note that this endpoint requires admin-level permissions and is only available for enterprise grid organizations. it does not provide detailed information about team members or channel structures; for such data, you would need to use additional api calls.
</Accordion>

<Accordion title="Delete user photo">
  The users.deletephoto endpoint allows users to remove their current profile picture on slack. this method is used when a user wants to revert to the default profile image or before uploading a new photo. it's a simple operation that requires no additional parameters beyond authentication. keep in mind that this action is irreversible - once deleted, the previous profile photo cannot be restored. if you need to change the profile photo, consider using the users.setphoto method instead of deleting and re-uploading.
</Accordion>

<Accordion title="Retrieve conversation preferences">
  The admin.conversations.getconversationprefs endpoint retrieves the current preferences and settings for a specific conversation (channel or direct message) in a slack workspace. it allows administrators to view important configuration details such as posting permissions, thread response settings, and potentially retention policies. this endpoint is crucial for auditing and managing conversation settings across an organization, especially in enterprise grid workspaces. it should be used when administrators need to review or verify the current configuration of a conversation before making any changes. note that this endpoint likely requires admin-level permissions and appropriate oauth scopes to access.
</Accordion>

<Accordion title="Invite user to channels in workspace">
  The admin.users.invite endpoint allows slack workspace administrators to invite new users to their workspace. this powerful tool streamlines the process of adding members, setting up guest accounts, and managing initial channel access. use this endpoint when you need to programmatically invite users, especially in bulk or as part of an automated onboarding process. it's particularly useful for large organizations or when integrating slack with other systems. the endpoint provides flexibility in setting user roles, specifying channel access, and managing guest account expirations. however, it should be used cautiously, as it directly affects workspace membership and access rights. note that while you can set initial parameters, users may still need to complete the signup process and might have the ability to modify some settings upon joining.
</Accordion>

<Accordion title="Post message to channel">
  The chat.postmessage endpoint allows you to send a message to a slack channel or user. this versatile tool can be used to post simple text messages, create rich interactive messages with blocks or attachments, initiate or reply to threads, and customize the appearance of bot messages. it's ideal for sending notifications, updates, or interactive content to slack users or channels programmatically. the endpoint supports extensive customization of message content and appearance, making it suitable for a wide range of use cases from simple notifications to complex interactive workflows. however, it's important to note that the message structure and appearance may vary depending on the slack client and the parameters used.\<\<DEPRECATED use sends\_a\_message\_to\_a\_slack\_channel>>
</Accordion>

<Accordion title="Add reminder for user">
  The 'reminders.add' endpoint allows you to create new reminders in slack. it's designed to help users set notifications for future tasks, events, or any information they need to remember. this tool is particularly useful for managing personal tasks, setting team reminders, or scheduling follow-ups within slack's collaborative environment. the endpoint offers flexibility in timing, supporting one-time reminders as well as recurring ones through natural language input. while it focuses on creating reminders, it does not provide functionality for listing, modifying, or deleting existing reminders. note that if no specific user is designated, the reminder defaults to the creator, making it versatile for both personal and team use.
</Accordion>

<Accordion title="List users in user group">
  Retrieves a list of users belonging to a specified usergroup in slack. this endpoint is particularly useful for administrators and developers who need to manage usergroup memberships, audit access control, or synchronize user data with external systems. it provides a comprehensive view of the usergroup's composition, including options to include disabled users and paginate through large usergroups. the endpoint should be used when you need to obtain detailed information about usergroup membership, but it does not provide capabilities to modify the usergroup or user attributes directly.
</Accordion>

<Accordion title="Create user group with unique name">
  Creates a new user group in slack, allowing for organized team communication and management. this endpoint is used to set up a group with a unique name, optional description, default channels, and a mention handle. it's particularly useful for creating functional teams, project groups, or department-wide communication channels. the endpoint allows for immediate configuration of the group's default channels and provides options for including member count information. it should be used when setting up new team structures or reorganizing existing communication channels within slack.
</Accordion>

<Accordion title="List approved admin apps">
  Retrieves a list of approved apps for a slack workspace or enterprise grid organization. this endpoint is designed for administrators to view and manage the apps that have been approved for use within their slack environment. it can be used to audit the current set of approved apps, verify recent approvals, or gather information for reporting purposes. the endpoint supports pagination for handling large lists of approved apps and can be scoped to a specific workspace within an enterprise grid organization if needed.
</Accordion>

<Accordion title="List approved admin invite requests">
  Retrieves a list of approved invite requests for a slack workspace. this endpoint allows administrators to view and manage successful invitations, providing insights into workspace growth and user onboarding. it's particularly useful for large organizations or those using slack enterprise grid to monitor approved invitations across multiple workspaces. the endpoint supports pagination for efficient handling of large datasets and can be used to audit the invitation process or gather statistics on workspace expansion.
</Accordion>

<Accordion title="List denied invite requests">
  Retrieves a list of denied workspace invite requests for a slack workspace. this endpoint is used to review and manage invite requests that have been previously denied. it's particularly useful for administrators who need to audit access control or reconsider denied requests. the endpoint supports pagination to handle large numbers of denied requests efficiently. it should be used when there's a need to review the history of denied invitations, potentially for security audits or to reconsider specific denials. note that this endpoint only provides information about denied requests and does not include details about approved or pending invitations.
</Accordion>

<Accordion title="List restricted access groups">
  Retrieves a list of identity provider (idp) groups that have been granted access to a specific private channel or conversation in a slack workspace. this endpoint is designed for slack workspace administrators to manage and review access control settings for conversations. it should be used when auditing or modifying access restrictions on private channels. the tool provides visibility into which external groups (managed by an identity provider) have permission to access certain conversations, enhancing security and compliance management. note that this endpoint does not modify any permissions; it only lists the current access configuration.
</Accordion>

<Accordion title="List restricted apps for admin">
  Retrieves a list of all apps that are restricted from installation on a slack workspace or across an entire enterprise grid organization. this endpoint is essential for enterprise grid administrators to manage and review app restrictions, ensuring compliance with organizational policies. it provides detailed information about each restricted app, including its id, name, and developer type (internal, third-party, or slack-built). use this endpoint when you need to audit your organization's app restrictions or verify the current status of app installation policies. note that this method only works for enterprise grid workspaces and requires appropriate admin-level permissions to access.
</Accordion>

<Accordion title="List admin invite requests">
  The admin.inviterequests.list endpoint retrieves a list of pending or active invite requests for a specified slack workspace. this tool is designed for workspace administrators to review and manage incoming invitation requests, providing crucial control over workspace access and growth. it supports pagination for efficient handling of large datasets, allowing administrators to iterate through all invite requests in manageable chunks. the endpoint is particularly useful for monitoring workspace expansion, ensuring compliance with company policies, and maintaining security by overseeing who is being invited to join the workspace.
</Accordion>

<Accordion title="List original connected channel info">
  Retrieves a list of original connected channel information for enterprise key management (ekm) enabled channels in a slack workspace. this endpoint is specifically designed for administrators managing ekm in slack, allowing them to obtain crucial information about encrypted channels, particularly those that have been frozen. it's essential for maintaining security and compliance in organizations using ekm to protect sensitive data in slack. the endpoint should be used when auditing ekm-enabled channels or preparing to revoke encryption keys for frozen channels. it does not modify any data and is intended for informational purposes only. note that this endpoint requires admin-level permissions and is only applicable to workspaces with ekm enabled.
</Accordion>

<Accordion title="List app permissions resources">
  Retrieves a list of resources that the authenticated slack app has permission to access within the workspace. this endpoint is used to get an overview of the app's current access levels and the specific slack resources it can interact with, such as channels, users, or messages. it's particularly useful for app developers to audit their app's permissions or to dynamically adjust the app's behavior based on its current access rights. the endpoint does not modify any permissions; it only provides a read-only view of the current state. note that the response will be limited to the resources accessible under the current authentication scope, so it may not represent all possible resources in a slack workspace.
</Accordion>

<Accordion title="List user group channels">
  Retrieves a list of channels associated with a specific user group in a slack workspace. this endpoint is particularly useful for administrators who need to audit or manage channel access for user groups. it provides visibility into which channels a user group has been added to, helping in access control and organization of the slack workspace. the endpoint should be used when you need to review or verify channel associations for a particular user group, but it will not modify any existing settings or permissions.
</Accordion>

<Accordion title="List event authorizations for apps">
  Retrieves a list of authorizations for a specific event context in slack. this endpoint allows developers to determine which app installations are visible and have the necessary permissions to access or respond to a particular event. it's essential for understanding the scope of an app's visibility and capabilities across different slack workspaces and events. the endpoint supports pagination for handling large sets of authorizations, making it suitable for apps installed in numerous workspaces or with complex permission structures.
</Accordion>

<Accordion title="Get app permissions info">
  Retrieves detailed information about the permissions granted to a slack application. this endpoint is used to audit and review the current set of permissions associated with an app, helping developers and administrators understand the app's capabilities within a slack workspace. it provides a comprehensive list of all permissions the app has been granted, which is crucial for security audits, troubleshooting, or when preparing to request additional scopes. the endpoint does not modify any permissions; it only returns the current state. note that the permissions returned are specific to the app associated with the authentication token used in the request.
</Accordion>

<Accordion title="List admin emojis">
  Retrieves a list of all custom emojis within a slack enterprise grid organization. this endpoint is specifically designed for administrators to manage and oversee custom emoji usage across the entire organization. it provides a comprehensive view of all user-created emojis, which can be useful for monitoring appropriate usage, identifying popular custom emojis, or managing emoji-related policies. the endpoint does not list standard slack emojis, focusing solely on custom additions. use this when you need to audit, report on, or manage custom emojis at an organizational level. note that this endpoint requires admin-level permissions and is part of the slack admin api, making it suitable for administrative tools and dashboards rather than end-user applications.
</Accordion>

<Accordion title="List permissions scopes for apps">
  Retrieves a list of oauth scopes associated with the authenticated slack app. this endpoint allows developers to view the current permissions granted to their app within a slack workspace. it's particularly useful for auditing app permissions, verifying the app's access levels, or preparing for permission changes. the endpoint returns all scopes the app has been granted, which can include both bot and user token scopes. it should be used when you need to review or confirm the current set of permissions for your slack app. note that this endpoint does not modify any permissions; it only provides a read-only view of the existing scopes.
</Accordion>

<Accordion title="Retrieve conversation history">
  Retrieves the message history of a specified slack conversation or channel. this endpoint allows you to fetch a chronological list of messages and events that have occurred within a channel, group, or direct message conversation. it's particularly useful for applications that need to analyze conversation patterns, create chat archives, or display message history to users. the endpoint supports pagination for handling large message histories and allows filtering by time range. it returns detailed message objects including sender information, timestamps, and message content, making it a powerful tool for building slack integrations that require access to conversation data.\<\<DEPRECATED use fetch\_conversation\_history>>
</Accordion>

<Accordion title="Oauth v2 access endpoint">
  Exchanges a temporary oauth authorization code for an access token. this endpoint is a crucial part of the oauth 2.0 flow, allowing your application to obtain long-lived access tokens for making authenticated api calls to slack. it should be called immediately after receiving the temporary code from the user authorization step. the endpoint returns an access token along with other relevant information such as the authorized scopes and team details. this exchange should happen server-side to keep your client secret secure. note that the temporary code can only be used once and expires quickly, so make the exchange promptly after receiving it.
</Accordion>

<Accordion title="List user permissions">
  Retrieves a list of user permissions within a slack workspace. this endpoint allows administrators or authorized apps to fetch the permissions assigned to users, providing insight into access levels and capabilities of individual users within the slack environment. it's particularly useful for auditing user access, managing permissions at scale, or integrating with external user management systems. the endpoint returns comprehensive information about user permissions, which may include details such as oauth scopes, custom function access, and any specific role-based permissions. note that this endpoint does not modify permissions; it's purely for information retrieval purposes.
</Accordion>

<Accordion title="List emoji items">
  The emoji.list endpoint retrieves a comprehensive list of custom emojis available in the slack workspace. this get method allows developers to access the names and corresponding image urls of all custom emojis that have been added to the workspace. it's particularly useful for applications or bots that need to display, use, or manage custom emojis within slack integrations. the endpoint returns both standard slack emojis and any custom emojis uploaded by workspace members. however, it does not provide usage statistics or creation dates for the emojis. use this endpoint when you need to synchronize emoji data with an external system or when building features that involve emoji selection or display within your slack integration.
</Accordion>

<Accordion title="List scheduled chat messages">
  The chat.scheduledmessages.list endpoint retrieves a list of scheduled messages for a slack workspace or specific channel. it allows users to view pending messages that have been scheduled for future delivery, providing details such as the message content, scheduled time, and target channel. this endpoint is particularly useful for managing and reviewing upcoming automated communications or delayed announcements within a slack environment. the endpoint supports pagination and filtering options, enabling efficient retrieval of large sets of scheduled messages or focusing on specific time ranges and channels. it's important to note that this endpoint only returns messages that have not yet been sent and are still pending delivery. developers should use this endpoint when building applications that need to monitor, manage, or display scheduled message queues, such as dashboard tools for content calendars or automation systems that need to track pending notifications.
</Accordion>

<Accordion title="List admin app requests">
  Retrieves a list of app installation requests for a slack workspace or enterprise grid organization. this endpoint allows administrators to view pending requests from users who want to install new slack apps. it's essential for maintaining control over the apps used within your slack environment and ensuring compliance with organizational policies. the endpoint supports pagination for handling large numbers of requests efficiently. use this when you need to review, approve, or deny app installation requests across your slack workspace or organization.
</Accordion>

<Accordion title="Lookup users by email">
  The users.lookupbyemail endpoint retrieves detailed information about a single slack user by searching for their registered email address. this method is particularly useful when you need to find a user's slack profile details but only have their email address available. the endpoint returns a comprehensive user object containing various fields such as user id, display name, and other profile information if the user is active. however, it will return a 'users not found' error if the user has been deactivated or if no user with the specified email exists in the workspace. this method requires the 'users:read.email' scope for authentication and should be used judiciously to respect user privacy.
</Accordion>

<Accordion title="List admin team admins">
  Retrieves a list of administrators for a specified slack team (workspace) within an enterprise grid organization. this endpoint is designed for org owners and admins to manage and audit administrative access across their enterprise grid workspaces. it provides information about users who have administrative privileges for a given team, helping in access control and compliance monitoring. the endpoint supports pagination for efficient handling of large admin lists. use this when you need to review or manage the administrative structure of a specific workspace in your enterprise grid.
</Accordion>

<Accordion title="List reminders">
  Retrieves a list of all reminders for the authenticated user in their slack workspace. this endpoint is useful for applications that need to manage or display upcoming reminders, such as task management tools or personal assistants. it provides an overview of all scheduled reminders, including their details like content, due date, and status. the endpoint should be used when you need to fetch all reminders at once, rather than querying for individual reminders. note that this endpoint may have rate limits and pagination for workspaces with a large number of reminders, although these details are not specified in the given schema.
</Accordion>

<Accordion title="Get bots information">
  The 'bots.info' endpoint retrieves detailed information about a specific bot user in a slack workspace. it allows developers to fetch metadata and current status of a bot, which is useful for managing bot integrations or verifying bot properties. this endpoint should be used when you need to access up-to-date information about a bot, such as its name, icons, or other custom fields. it's particularly helpful for applications that manage multiple bots or need to display bot information to users. note that this endpoint only provides information about bots and not regular user accounts or other types of integrations.
</Accordion>

<Accordion title="List remote files">
  Retrieves a list of remote files that have been added to your slack workspace. this endpoint is useful for tracking and managing external files that have been shared or referenced within slack conversations. it allows you to fetch metadata about these remote files, such as their names, types, and sharing information. use this endpoint when you need to audit remote file usage, compile reports on external content, or build integrations that interact with shared remote files. the endpoint supports pagination for handling large sets of results and offers filtering options based on timestamps and channel-specific queries. note that this endpoint only returns metadata about the remote files and does not provide access to the actual file contents.
</Accordion>

<Accordion title="Get list of user groups">
  Retrieves a list of all user groups in a slack workspace. this endpoint is used to get an overview of the organizational structure within a slack team, including details about each user group such as their names, handles, descriptions, and member counts. it's particularly useful for administrators or integrations that need to manage or audit user groups across the workspace. the endpoint returns information about both user-created groups and default groups provided by slack. note that while this endpoint doesn't require any parameters, the response may be paginated for workspaces with a large number of user groups, and additional api calls might be necessary to retrieve the complete list.
</Accordion>

<Accordion title="List admin team owners">
  Retrieves a list of owners for a specified slack workspace within an enterprise grid organization. this endpoint allows administrators to view all users with owner privileges in a particular team. it's useful for auditing ownership, managing permissions, or when transitioning team responsibilities. the endpoint supports pagination for efficiently handling workspaces with a large number of owners. note that this endpoint is exclusive to enterprise grid customers and cannot be used with standard slack workspaces.
</Accordion>

<Accordion title="Set user presence">
  Manually sets a user's presence status in slack. this endpoint allows you to override the automatic presence detection and explicitly set a user's status to either 'auto' (letting slack determine presence based on activity) or 'away'. use this when you need to programmatically update a user's availability, such as when integrating with external systems or custom workflows. note that setting presence to 'auto' doesn't guarantee an 'active' status; it simply reverts to slack's default presence behavior. this change persists between connections but can be overridden by user actions or slack's auto-away feature after 10 minutes of inactivity.
</Accordion>

<Accordion title="Migration exchange overview">
  The migration.exchange endpoint facilitates the conversion of local slack user ids to global user ids for enterprise grid organizations. this tool is essential during the migration process when transitioning from a standard slack workspace to an enterprise grid deployment. it allows administrators and developers to maintain user identity consistency across the organization by mapping local, workspace-specific user ids to universal, enterprise grid-compatible global user ids. the endpoint should be used when preparing for or executing a migration to enterprise grid, or when integrating systems that need to work with both local and global user ids. it's important to note that this endpoint does not perform the actual migration but provides the necessary id mapping for the process.
</Accordion>

<Accordion title="List admin users">
  The admin.users.list method retrieves a paginated list of users with administrative privileges in a slack workspace. it allows workspace owners and admins to view and manage the administrative user base efficiently. this endpoint is particularly useful for auditing admin access, reviewing admin assignments, or gathering data for reporting purposes. the method returns basic information about each admin user, such as their user id, name, and email. it does not provide detailed information about user permissions or roles beyond their admin status.
</Accordion>

<Accordion title="Set user active status">
  The users.setactive endpoint marks a user as active in a slack workspace. this method is used to update the user's status, indicating that they are currently available and engaged with slack. it's particularly useful for automatically updating a user's status when they return from being away or inactive. the endpoint doesn't require any specific parameters in the request body. however, it's important to note that this method should be called with appropriate authentication, typically using a user token or bot token with necessary permissions. while it sets a user's status to active, it doesn't provide any additional information about the user or their previous status.
</Accordion>

<Accordion title="List files">
  The 'files.list' endpoint allows you to retrieve a list of files within a slack workspace. it provides a comprehensive view of files shared across channels, enabling efficient file management and content discovery. use this endpoint when you need to fetch file metadata, such as names, types, and sharing information, without downloading the actual file contents. the endpoint supports various filtering options, allowing you to narrow down results by channel, time range, or file type. it's particularly useful for applications that need to audit file usage, create file indexes, or build custom file management interfaces within slack. note that this endpoint returns metadata only and does not provide direct file downloads; for that, you would need to use a separate file retrieval endpoint.
</Accordion>

<Accordion title="Complete workflow step event">
  The 'workflows.stepcompleted' endpoint is used to mark a specific step within a slack workflow as completed. this get request is crucial for tracking the progress of automated workflows and potentially triggering subsequent actions. it should be called when a custom step in a workflow has finished its execution successfully. this endpoint helps in maintaining the state of complex workflows, especially those involving custom functions or integrations with external services. it's important to note that this endpoint doesn't execute the step itself but rather updates its status to completed. use this endpoint in conjunction with workflow creation and management to build sophisticated automation sequences within slack.
</Accordion>

<Accordion title="Open views endpoint">
  The views.open endpoint allows you to open a modal view in a slack workspace. this method is used to create interactive, customized interfaces for users within slack, such as forms, detailed information displays, or multi-step workflows. it's particularly useful when you need to collect information from users or display complex data in a structured format. the view appears as a pop-up window, providing a focused environment for user interaction. keep in mind that views have a limited lifespan and should be used for immediate user interactions rather than long-term display of information.
</Accordion>

<Accordion title="Mark reminder as complete">
  The 'reminders.complete' endpoint marks a specific slack reminder as complete. it should be used when a user wants to indicate that a task associated with a reminder has been finished. this endpoint is particularly useful for integrations that manage tasks or to-do lists within slack. however, it's important to note that this endpoint has been deprecated since march 2023, which means it may not be reliable for new applications and could stop working in the future. as an alternative, consider using other reminder management methods or consult slack's latest documentation for recommended approaches to handle reminders.
</Accordion>

<Accordion title="Set user as admin in workspace">
  This endpoint allows you to designate a user as an admin within a specific slack workspace. it is used when you need to promote a regular user to an admin role, granting them additional permissions and control over workspace settings. the operation requires both the workspace id and the user id of the person being promoted. this action should be used carefully, as admins have significant control over workspace configurations and user management. note that this endpoint only sets the admin status and does not provide any feedback on the success of the operation or the current status of the user.
</Accordion>

<Accordion title="Retrieve dnd team information">
  Retrieves the do not disturb (dnd) status information for members of a slack team. this endpoint allows you to check the dnd settings for multiple users within a team simultaneously. it's particularly useful for team coordination, scheduling, or creating automation that respects users' dnd preferences. the endpoint returns current dnd statuses and any scheduled dnd sessions for the specified users or the entire team. note that this endpoint does not modify any dnd settings; it's read-only and meant for informational purposes.
</Accordion>

<Accordion title="Add pin to channel">
  The 'pins.add' endpoint allows you to pin a specific message within a slack channel. this function is used to highlight important information, making it easily accessible to channel members. when invoked, it adds a pin to the specified message, causing it to appear in the channel's pinned items section. this is particularly useful for marking crucial announcements, decisions, or reference information that team members need to access frequently. the endpoint requires specifying the target channel and ideally the exact timestamp of the message to be pinned. it's important to note that this action may be subject to user permissions within the slack workspace.
</Accordion>

<Accordion title="Publish views endpoint">
  The views.publish endpoint is used to publish or update a home tab view for a specific user in a slack workspace. this method allows you to create or modify the custom interface that appears in the home tab of the slack client for a particular user. it's primarily used for displaying personalized, dynamic content or interactive elements specific to your slack app. the endpoint should be used when you want to update a user's home tab with new information, metrics, or interactive components. it's particularly useful for creating dashboard-like interfaces or providing user-specific controls and information. note that this endpoint specifically targets the home tab view and should not be used for creating or updating modals or messages in channels.
</Accordion>

<Accordion title="Retrieve team information">
  Retrieves detailed information about a slack team. this endpoint provides comprehensive data about the team's configuration, including its id, name, domain, email domain, and icon settings. if the team is part of an enterprise grid, it also returns the enterprise id and name. use this method when you need to access or verify team-specific details, such as during initial setup, user onboarding, or for administrative purposes. the endpoint is particularly useful for applications that interact with multiple slack teams and need to maintain accurate team information. note that while this method provides extensive team data, it does not include information about individual team members or channels.
</Accordion>

<Accordion title="Open dialog">
  Opens an interactive dialog in slack, allowing your app to collect information from users through a modal interface. this method is essential for creating custom forms, gathering user input, or displaying complex information within the slack workspace. use this endpoint when you need to prompt users for multiple pieces of information or when you want to present a structured interface for data entry. the dialog appears as a modal window, providing a focused interaction experience. note that dialogs can only be opened in response to a user action, such as clicking a button, and require a valid trigger id. the dialog's appearance and behavior are highly customizable, but they must adhere to slack's design guidelines and size limitations.
</Accordion>

<Accordion title="Promote user to workspace owner">
  The admin.users.setowner endpoint promotes an existing user to the role of workspace owner within a slack enterprise grid organization. this powerful administrative function should be used when you need to grant full ownership privileges to a user, typically for management restructuring or when the current owner is leaving the organization. it's crucial to use this endpoint carefully, as workspace owners have extensive control over the slack environment. this method only works for enterprise grid workspaces and requires appropriate administrative permissions. note that this action cannot be undone through the api, and changing ownership may have significant implications for workspace management and security.
</Accordion>

<Accordion title="Retrieve conversation history">
  Retrieves the message history of a specified slack conversation or channel. this endpoint allows you to fetch a chronological list of messages and events that have occurred within a channel, group, or direct message conversation. it's particularly useful for applications that need to analyze conversation patterns, create chat archives, or display message history to users. the endpoint supports pagination for handling large message histories and allows filtering by time range. it returns detailed message objects including sender information, timestamps, and message content, making it a powerful tool for building slack integrations that require access to conversation data.
</Accordion>

<Accordion title="Get list of pins">
  The 'pins.list' endpoint retrieves a list of items that have been pinned to a specified slack channel. it allows developers to access important or frequently referenced messages or files that team members have marked as significant. this endpoint is particularly useful for creating custom pin management tools, archiving important information, or integrating pinned content into other applications. the endpoint supports pagination for efficiently handling channels with a large number of pinned items.
</Accordion>

<Accordion title="List reactions">
  The reactions.list endpoint retrieves a list of all reactions for items within a specified slack channel or conversation. it allows you to fetch reaction data, which can include emojis or custom reactions added to messages or files. this endpoint is particularly useful for analyzing user engagement, tracking popular content, or building analytics tools that monitor interaction patterns within slack workspaces. the method supports pagination for handling large sets of reaction data and can provide detailed information about each reaction when requested. it's important to note that this endpoint focuses solely on reaction data and does not return the content of messages or files themselves.
</Accordion>

<Accordion title="View push interface">
  The views.push endpoint adds a new view to the top of the existing view stack in a slack modal. it's used for creating dynamic, multi-step interactions within a single modal session. this method allows apps to respond to user actions by presenting new content or forms without closing the current modal. it's particularly useful for workflows that require multiple stages or for displaying additional information based on user input. the endpoint requires a valid trigger id from a recent interaction and must be called within 3 seconds of that interaction. it's important to note that there's a limit to the number of views that can be pushed onto a single modal stack, typically around 3 views.
</Accordion>

<Accordion title="Retrieve user presence">
  Retrieves the current presence status of a specified slack user. this endpoint allows you to check whether a user is currently active or away on the slack platform. it's useful for applications that need to track user availability or trigger actions based on a user's presence. the endpoint returns the user's current status (active or away), whether they're online, and potentially the timestamp of their last activity. it should be used when you need real-time information about a user's availability in slack. note that this endpoint doesn't provide detailed information about the user's activities or the reason for their current status.
</Accordion>

<Accordion title="Fetch team integration logs">
  Retrieves the integration activity logs for a specified slack team. this endpoint provides detailed information about changes to integrations within the team, including when integrations are added, removed, enabled, disabled, or updated. it's particularly useful for team administrators and security personnel who need to monitor and audit integration-related activities. the logs include information such as the type of change, the service affected, the user who made the change, and the timestamp of the activity. this tool should be used when there's a need to track integration changes, investigate security concerns, or maintain compliance records related to third-party app usage within a slack workspace. it does not provide real-time monitoring and may have some delay in reflecting the most recent activities.
</Accordion>

<Accordion title="Retrieve team access logs">
  Retrieves access logs for users on a slack workspace, providing detailed information about user logins and activity. this endpoint is crucial for security monitoring, compliance auditing, and tracking user access patterns. it returns a chronological list of access events, including user identifiers, ip addresses, and geographical data. use this endpoint when you need to investigate suspicious activity, perform regular security audits, or generate reports on workspace access. note that this endpoint may have rate limits and is typically restricted to workspace administrators or security personnel with appropriate permissions.
</Accordion>

<Accordion title="Handle step failure notification">
  Retrieves information about a failed step in a slack workflow. this endpoint is used to get details on why a specific step in a workflow execution failed, providing crucial information for debugging and error resolution. it should be called when a workflow step fails and you need to understand the cause of the failure. the endpoint returns data about the failed step, which may include an error message, the step id, and potentially the workflow context at the time of failure. this tool is essential for maintaining and troubleshooting automated processes within slack, ensuring smooth operation of custom workflows. note that this endpoint does not retry or fix the failed step; it only provides information about the failure.
</Accordion>

<Accordion title="Retrieve reminders details">
  Retrieves detailed information about a specific reminder in slack. this endpoint allows you to fetch the complete details of a reminder, including its content, creator, time, and status. use this method when you need to access or verify the information of an existing reminder. it's particularly useful for applications that manage or display reminders, allowing them to show up-to-date information about a specific reminder. the endpoint returns a comprehensive set of data about the reminder but does not modify or interact with the reminder in any way. note that this method only retrieves information for reminders that are accessible to the authenticated user in their slack workspace.
</Accordion>

<Accordion title="Fetch reaction details">
  The 'reactions.get' endpoint retrieves a list of all reactions for a specific item in slack, such as a message, file, or file comment. it allows developers to fetch detailed information about how users have reacted to content within slack. this endpoint is particularly useful for applications that need to analyze engagement, track popular content, or display reaction data outside of the slack interface. the method returns information about the reactions, including the types of reactions (emojis) used and, optionally, details about the users who reacted. while it provides comprehensive reaction data, it does not modify any reactions or return the content of the item itself.
</Accordion>

<Accordion title="Invalidate user session">
  The admin.users.session.invalidate endpoint allows slack workspace administrators to forcibly terminate a specific user's active session. this tool is primarily used for security purposes, such as when an admin needs to immediately revoke access for a compromised account or ensure a user is logged out across all devices. it requires both the team id and the specific session id to target the correct session for invalidation. this endpoint should be used cautiously and only when necessary, as it will disrupt the user's current slack session, forcing them to log in again. it's particularly useful in scenarios where simply changing a user's password may not be sufficient to ensure immediate session termination.
</Accordion>

<Accordion title="Retrieve conversation replies">
  The 'conversations.replies' endpoint retrieves a thread of messages within a slack conversation. it allows you to fetch replies to a specific message, providing a paginated list of messages in the thread. this endpoint is crucial for applications that need to display or process threaded conversations in slack channels, including public channels, private channels, and direct messages. use this when you need to access the full context of a discussion or when building features that involve message threads. note that the endpoint requires appropriate authentication scopes and may have rate limits for frequent requests.
</Accordion>

<Accordion title="List users endpoint">
  The 'users.list' endpoint retrieves a comprehensive list of users within a slack workspace. it provides detailed information about each user, including their profile data, account settings, and team memberships. this endpoint is particularly useful for applications that need to synchronize user data, manage user permissions, or perform bulk operations on user accounts. the response includes both active and deactivated users, allowing for a complete overview of the workspace's user base. however, it's important to note that the endpoint may not return real-time data, and there might be a slight delay in reflecting recent changes to user accounts.
</Accordion>

<Accordion title="List stars">
  Retrieves a list of all starred items for the authenticated user in a slack workspace. this endpoint allows you to fetch items that a user has marked as favorites, including messages, files, and channels. it's useful for applications that need to display or manage a user's starred content within slack. the endpoint returns a comprehensive list of starred items without any filtering options, so it's best used when you need a complete overview of a user's favorites. note that the response may include various types of items, so your application should be prepared to handle different data structures for messages, files, and channels.
</Accordion>

<Accordion title="Conversations create channel">
  Creates a new conversation (channel) in slack, either public or private. this endpoint should be used when you need to programmatically create channels for team communication, project management, or automated workflows. it allows for the creation of organized spaces within a slack workspace for specific topics, teams, or projects. the created channel will be empty initially, and members will need to be invited separately. note that channel names must be unique within a workspace, and there may be limitations on the number of channels that can be created based on the workspace's plan.
</Accordion>

<Accordion title="List conversations endpoint">
  Retrieves a list of all conversations in a slack workspace, including public channels, private channels, multi-person direct messages (mpim), and direct messages (im). this endpoint is essential for obtaining an overview of all available conversations, which can be used for workspace analysis, channel management, or as a precursor to performing actions on specific conversations. the method supports filtering by conversation types, exclusion of archived channels, and pagination for handling large workspaces efficiently. use this endpoint when you need to display available channels to users, perform workspace-wide operations, or gather data about the structure of a slack workspace. note that the returned list may be affected by the permissions of the authenticated user, and some conversations might be excluded if the user doesn't have access to them.\<\<DEPRECATED use list\_all\_slack\_team\_channels\_with\_various\_filters>>
</Accordion>

<Accordion title="Retrieve user conversations">
  Retrieves a list of conversations (channels, direct messages, and group messages) that a specified user or the authenticated user is a member of in a slack workspace. this endpoint is useful for applications that need to analyze user participation, manage channel memberships, or provide custom navigation within a slack integration. it supports pagination for handling large numbers of conversations and allows filtering by conversation types. use this endpoint when you need to gather information about a user's conversation memberships or when building user-specific views of slack workspaces. note that the results are limited to conversations the authenticated token has access to view.
</Accordion>

<Accordion title="Invite users to channel">
  The conversations.invite endpoint allows you to invite one or multiple users to a specific slack channel. this powerful tool streamlines the process of adding members to your conversations, enhancing team collaboration. use this endpoint when you need to quickly add users to a channel, especially for onboarding new team members or creating project-specific groups. it supports both public and private channels, providing flexibility in managing your slack workspace. the endpoint can handle bulk invitations of up to 1000 users in a single request, making it efficient for large-scale channel population. however, be mindful of your slack plan's limitations and ensure all user ids are valid to avoid errors.
</Accordion>

<Accordion title="Join conversation by channel id">
  Joins the authenticated user to a slack conversation (channel). this endpoint allows you to add yourself to an existing public or private channel, or a multi-person direct message. use this when you need to participate in a conversation that you're not currently a member of. it's particularly useful for bots or integrations that need to join specific channels to listen for messages or post updates. note that this endpoint doesn't create new conversations; it only allows joining existing ones. also, be aware that joining private channels may require additional permissions or invitations, depending on your workspace settings and the user's role.
</Accordion>

<Accordion title="List conversations endpoint">
  Retrieves a list of all conversations in a slack workspace, including public channels, private channels, multi-person direct messages (mpim), and direct messages (im). this endpoint is essential for obtaining an overview of all available conversations, which can be used for workspace analysis, channel management, or as a precursor to performing actions on specific conversations. the method supports filtering by conversation types, exclusion of archived channels, and pagination for handling large workspaces efficiently. use this endpoint when you need to display available channels to users, perform workspace-wide operations, or gather data about the structure of a slack workspace. note that the returned list may be affected by the permissions of the authenticated user, and some conversations might be excluded if the user doesn't have access to them.
</Accordion>

<Accordion title="Get conversation info">
  The conversations.info endpoint retrieves detailed information about a specific conversation in slack. it provides comprehensive data about channels, direct messages, or multi-person direct messages, including their properties, members, and settings. this endpoint is particularly useful when you need to access metadata about a conversation, such as its name, purpose, creation date, or membership details. it should be used when detailed information about a specific slack conversation is required, rather than for listing multiple conversations or accessing message content. note that while this endpoint provides extensive metadata, it does not return the actual messages within the conversation; for that, you would need to use a separate endpoint like conversations.history.\<\<DEPRECATED use retrieve\_conversation\_information>>
</Accordion>

<Accordion title="Open conversations endpoint">
  The conversations.open endpoint opens or resumes a direct message (dm) or multi-person direct message (mpim) conversation in slack. it allows users to start new conversations or continue existing ones by providing either a conversation id or a list of user ids. this method is essential for initiating private communications between two or more users within a slack workspace. it's particularly useful for integrations that need to create or access private conversations programmatically. the endpoint supports both 1:1 and group conversations, making it versatile for various communication needs. when using this endpoint, it's important to note that you must provide either a 'channel' id for existing conversations or a list of 'users' for new or existing conversations, but not both simultaneously.
</Accordion>

<Accordion title="Add participants to call">
  Adds one or more participants to an ongoing slack call. this endpoint should be used when you need to include additional users in an existing call, such as when inviting late joiners or expanding the call's participants. it requires the unique identifier of the call and a list of user ids to be added. the endpoint is particularly useful for managing dynamic call participation in collaborative environments. note that this method can only add participants to calls that have already been initiated using the 'calls.add' method.
</Accordion>

<Accordion title="Add call to slack">
  The 'calls.add' endpoint registers a new call in slack, integrating third-party call services with slack's interface. it allows you to create a call with specific details such as title, start time, and participants, providing urls for joining the call through slack or directly through desktop applications. this endpoint is particularly useful for setting up team meetings, conference calls, or any voice/video communication within slack channels. it supports both immediate and scheduled calls, offering flexibility in call management and participant organization. use this when you need to programmatically create and manage calls within your slack workspace, especially when integrating external calling services.
</Accordion>

<Accordion title="Add reminder for user">
  The 'reminders.add' endpoint allows you to create new reminders in slack. it's designed to help users set notifications for future tasks, events, or any information they need to remember. this tool is particularly useful for managing personal tasks, setting team reminders, or scheduling follow-ups within slack's collaborative environment. the endpoint offers flexibility in timing, supporting one-time reminders as well as recurring ones through natural language input. while it focuses on creating reminders, it does not provide functionality for listing, modifying, or deleting existing reminders. note that if no specific user is designated, the reminder defaults to the creator, making it versatile for both personal and team use.\<\<DEPRECATED use create\_a\_reminder>>
</Accordion>

<Accordion title="Rename admin conversation channel">
  Renames a public or private channel in a slack workspace. this endpoint should be used when an admin or authorized user needs to change the name of an existing channel. it's particularly useful for keeping channel names up-to-date with team or project changes. the endpoint only modifies the channel name and does not affect its members, purpose, or any other attributes. note that this action is only available to workspace admins or users with the channel manager role in enterprise grid workspaces.
</Accordion>

<Accordion title="Remove participants from call">
  This endpoint removes specified participants from an ongoing slack call. it should be used when you need to programmatically remove one or more users from a call, such as when a participant needs to be ejected or when automating call management. the endpoint requires the call id and a list of users to remove. it's important to note that this action is irreversible, and removed users will need to be re-added if they should rejoin the call. this method will not end the call even if all participants are removed. be cautious when using this endpoint, as it directly affects user participation in ongoing communications.
</Accordion>

<Accordion title="Search messages endpoint">
  The search.messages endpoint allows you to search for messages across all channels, direct messages, and private groups in a slack workspace. it provides powerful search capabilities to find specific content within conversations. this endpoint is particularly useful for retrieving historical information, locating important discussions, or building search functionality into slack-integrated applications. the search results include message content, associated metadata, and can be refined using various parameters for sorting, highlighting, and pagination. keep in mind that the search may not include very recent messages due to indexing delays, and there may be rate limits on the number of requests you can make in a given time period.\<\<DEPRECATED use search\_for\_messages\_with\_query>>
</Accordion>

<Accordion title="Remove idp group from channel">
  This endpoint removes an identity provider (idp) group from the access list of a private slack channel. it's used to revoke access for all members of the specified idp group to a particular private channel. this action is part of slack's advanced access management features, allowing administrators to fine-tune channel access based on organizational structure. use this endpoint when you need to adjust access permissions for large groups of users simultaneously, based on their idp group membership. it's particularly useful for maintaining security and information compartmentalization in enterprise environments. note that this endpoint only affects private channels and requires admin-level permissions to execute.
</Accordion>

<Accordion title="Remove reactions from message">
  The reactions.remove endpoint allows you to remove a specific reaction (emoji) from a message, file, or file comment in slack. this method is useful for undoing reactions or cleaning up emoji responses on various items within slack channels. to use this endpoint, you must specify the reaction name and the item (message, file, or file comment) from which to remove the reaction. for messages, both the channel and timestamp are required. for files or file comments, you need to provide the respective file or file comment id. this endpoint is particularly helpful for moderation purposes or when managing automated reactions in integrated applications.
</Accordion>

<Accordion title="Rename admin emoji">
  Renames a custom emoji in a slack workspace. this endpoint allows administrators to change the name of an existing custom emoji, which can be useful for organizing emojis or correcting naming errors. the function requires admin-level permissions and should be used when there's a need to update emoji names without removing and re-adding them. it's important to note that this action will affect all instances of the emoji across the workspace, so it should be used with caution to avoid disrupting existing communications that may reference the emoji by its old name.
</Accordion>

<Accordion title="Remove star from channel file or comment">
  Removes a star from an item (message, file, file comment, channel, private group, or direct message) on behalf of the authenticated user. this endpoint is used when a user wants to unstar content in slack. it requires at least one parameter to identify the item to be unstarred. the method broadcasts a 'star removed' event through the rtm api for the calling user. use this endpoint to programmatically manage starred items in a user's slack workspace.
</Accordion>

<Accordion title="Remove remote file">
  Removes a remote file from slack. this endpoint is used to delete the reference to an external file that was previously added to slack using the remote files api. it's particularly useful for maintaining consistency between your external file system and slack, allowing you to remove files that are no longer relevant or have been deleted from the source. the removal can be performed using either the creator-defined external id or slack's internal file id. this operation only removes the file reference from slack and does not affect the original file in its external location.
</Accordion>

<Accordion title="Post ephemeral message to user">
  The 'chat.postephemeral' endpoint allows you to send an ephemeral message to a specific user within a slack channel. ephemeral messages are temporary and only visible to the specified user, making them ideal for personalized notifications, alerts, or responses that don't need to be seen by the entire channel. this endpoint is particularly useful for interactive workflows, providing user-specific information, or sending sensitive data that shouldn't be visible to all channel members. the message can be customized with various formatting options, including attachments and block kit elements, allowing for rich, interactive content. keep in mind that ephemeral messages are not permanently stored and cannot be retrieved once they disappear, so they should not be used for critical information that needs to be referenced later.
</Accordion>

<Accordion title="Retrieve dnd information">
  Retrieves information about a user's current do not disturb (dnd) status in slack. this endpoint allows you to check if a user has dnd enabled, and if so, it likely provides details such as when the dnd period started and when it's scheduled to end. use this endpoint when you need to determine a user's availability or to respect their notification preferences before sending messages. it's particularly useful for applications that need to manage communication timing or display user status. note that this endpoint does not modify the dnd status; it's for information retrieval only.
</Accordion>

<Accordion title="Retrieve chat permalink">
  Retrieves a permalink url for a specific message in a slack channel. this endpoint is used when you need to generate a shareable link to a particular message, allowing easy reference and access to the message content. the permalink can be used to quickly navigate to the exact message within the slack interface, even if it's part of a thread or in a private channel (provided the user has appropriate permissions). this method is particularly useful for creating links to important messages, sharing context in discussions, or integrating slack message references into other tools or documentation. note that the generated permalink respects slack's privacy settings, so users will only be able to access the message if they have the necessary permissions in the slack workspace.
</Accordion>

<Accordion title="Get file remote info">
  Retrieves detailed information about a remote file that has been added to slack. this endpoint is used when you need to access metadata and current status of a file that exists externally but has been registered with slack. it's particularly useful for tracking the sharing status, permissions, and other slack-specific attributes of the remote file. the endpoint doesn't download or modify the file itself; it only provides information about how the file is represented within slack. use this when you need to verify the file's current state in slack or before performing operations like updating or sharing the remote file.
</Accordion>

<Accordion title="Retrieve file information">
  The files.info endpoint retrieves detailed metadata about a specific file in slack. it allows you to fetch comprehensive information about a file, including its properties, sharing status, and associated data. this endpoint is particularly useful when you need to access or display detailed file information within your application or integration. the method returns a file object containing various attributes such as file type, size, creation date, and sharing details. it's important to note that this endpoint only provides metadata and does not download the actual file content.
</Accordion>

<Accordion title="Remove user from conversation">
  The conversations.kick endpoint removes a specified user from a slack conversation (channel). this method is used when you need to forcibly remove a member from a channel, which can be useful for moderation or managing channel membership. it requires the necessary permissions based on the type of channel being used. the endpoint should be used judiciously, as kicking a user may impact team dynamics. note that this method cannot be used to remove oneself from a channel; for that purpose, use the conversations.leave method instead. be aware that the kicked user will be able to rejoin the channel if it's a public channel unless further restrictions are put in place.
</Accordion>

<Accordion title="Set default team channels">
  Sets default channels for a specified slack workspace. this endpoint allows workspace administrators to define which public channels new members will automatically join when they are added to the workspace. it's useful for ensuring new members have immediate access to important company-wide information channels. the endpoint should be used when updating onboarding processes or reorganizing workspace structure. note that only public channels can be set as default, and this action requires administrative privileges.
</Accordion>

<Accordion title="Set conversation preferences for channel">
  Sets or updates the preferences for a specific slack conversation (channel). this endpoint allows administrators to configure various settings for a channel, such as who can post messages, whether threads can be used, or if huddles are allowed. it's particularly useful for managing large workspaces or enforcing specific policies across different channels. the endpoint should be used when there's a need to programmatically adjust channel settings, especially in bulk operations or when integrating with other management tools. note that this endpoint requires administrative privileges and may not be available to all users or in all slack plans.
</Accordion>

<Accordion title="Get user information">
  The users.info endpoint retrieves detailed information about a specific user in a slack workspace. it returns comprehensive profile data including the user's name, email, role, status, and other relevant details. this endpoint is particularly useful when you need to fetch up-to-date information about a user, such as checking their current status, verifying their role, or accessing their contact information. it should be used when detailed user data is required for user management, profile display, or integration with other systems. note that while this endpoint provides extensive user information, it does not return data about the user's message history or channel memberships.
</Accordion>

<Accordion title="Request app permissions">
  The 'apps.permissions.request' endpoint allows slack app developers to request additional permissions for their application. this method is used when an app needs to expand its capabilities and requires new scopes to access additional slack workspace features or data. it initiates the process of requesting new permissions, which typically involves notifying workspace administrators for approval. this endpoint should be used cautiously and only when necessary, as frequent permission changes may impact user trust. it's important to note that calling this endpoint does not automatically grant new permissions; it only starts the request process.
</Accordion>

<Accordion title="Set user account expiration timestamp">
  Sets an expiration date for a guest user account in a slack workspace. this endpoint allows workspace administrators to automatically disable guest access after a specified time, enhancing security and access control. it should be used when granting temporary access to external collaborators or for time-limited projects. the expiration is set using a unix timestamp, allowing precise control over when the guest account will be disabled. this method only applies to guest accounts and cannot be used to set expirations for regular workspace members or multi-channel guests.
</Accordion>

<Accordion title="Restrict app access">
  Restricts a specified app within a slack workspace, limiting its access or functionality. this endpoint should be used by workspace administrators when they need to prevent or control the use of a particular app due to security concerns, compliance requirements, or organizational policies. it allows for granular control over app permissions and usage within the team. the restriction is applied based on the provided app id, request id, and team id, ensuring precise targeting of the restriction action. this tool is essential for maintaining workspace security and enforcing app usage policies but should be used judiciously to avoid disrupting workflow integrations.
</Accordion>

<Accordion title="Set team description">
  Sets a new description for a specified slack workspace. this endpoint allows workspace administrators to update the team's description, which is typically visible to all members and helps convey the purpose or focus of the workspace. use this when you need to modify the existing workspace description or set an initial description for a newly created workspace. the endpoint is particularly useful for maintaining up-to-date information about the workspace, especially after organizational changes or shifts in team focus. note that this operation will overwrite any existing description, so ensure you have the full desired text ready before making the api call.
</Accordion>

<Accordion title="Set team discoverability">
  Sets the discoverability setting for a specific slack workspace within an enterprise grid organization. this endpoint allows administrators to control the visibility and accessibility of a workspace to external users. it should be used when you need to change how a workspace can be discovered or joined by potential new members. the endpoint requires both the workspace id and the desired discoverability setting. it's important to note that this action can have significant implications for workspace access and should be used carefully, considering the organization's security and collaboration needs.
</Accordion>

<Accordion title="Remove user from workspace">
  The admin.users.remove endpoint allows workspace administrators to remove a specific user from a slack workspace. this action permanently deletes the user's access to the workspace and all associated channels. it should be used when an employee leaves the organization or when their access needs to be revoked for security reasons. the endpoint requires both the workspace id and the user id to ensure precise user removal. it's important to note that this action is irreversible, so it should be used with caution. this endpoint does not handle transferring the user's data or files before removal, so any necessary data preservation should be done separately before calling this endpoint.
</Accordion>

<Accordion title="Set conversation read cursor">
  The 'conversations.mark' endpoint sets the read cursor in a slack channel or conversation, marking a specific message as the last one read by the user. this function is essential for managing unread message indicators and tracking user engagement within slack conversations. use this endpoint when you need to programmatically update a user's read position, such as when implementing custom slack clients or managing user interactions in integrated applications. the endpoint is particularly useful for maintaining accurate scroll-back history in busy channels or for synchronizing read status across multiple devices. note that this action only affects the calling user's read cursor and does not impact other members of the conversation.
</Accordion>

<Accordion title="Retrieve call information">
  The calls.info endpoint retrieves detailed information about a specific call in a slack workspace. it allows developers to access comprehensive data about a call, including its participants, duration, status, and any associated metadata. this endpoint is particularly useful for applications that need to track or analyze call activity within slack, such as reporting tools or integration with other communication platforms. it should be used when detailed information about a specific call is required, rather than for listing multiple calls or initiating new calls. the endpoint returns a snapshot of the call data at the time of the request and does not provide real-time updates or streaming capabilities.
</Accordion>

<Accordion title="Set team icon using url">
  Sets the icon for a specific slack workspace within an enterprise grid organization. this endpoint allows administrators to update the visual identity of a workspace by providing a new icon image url. it's particularly useful for maintaining brand consistency across multiple workspaces or updating the appearance of a specific team's workspace. this method is exclusive to enterprise grid workspaces and requires appropriate administrative permissions. use this endpoint when you need to programmatically update workspace icons, such as during workspace setup automation or brand refresh initiatives.
</Accordion>

<Accordion title="Share remote files">
  Shares a previously added remote file into one or more slack channels or conversations. this endpoint allows you to make a remote file visible in specific slack channels without re-uploading the file. it's useful for sharing files that are stored in external services but need to be accessible within slack conversations. the file must have been added to slack beforehand using the 'files.remote.add' method. this endpoint should be used when you want to distribute a remote file to multiple channels or threads efficiently. it does not support sharing files that were directly uploaded to slack.
</Accordion>

<Accordion title="Set user profile key">
  The users.profile.set endpoint allows updating a user's profile information in slack. it can be used to modify both default profile fields (such as first name, last name, and email) and custom profile fields. this endpoint offers flexibility in updating either multiple fields at once or a single field, making it suitable for various profile management scenarios. team administrators on paid slack teams can use this endpoint to update profiles of other team members by specifying the 'user' parameter. the endpoint is particularly useful for keeping user information up-to-date, managing custom fields, and automating profile updates in integrated workflows. however, it's important to note the limitation of updating a maximum of 50 fields at once, and each field name is restricted to 255 characters.
</Accordion>

<Accordion title="Request app permissions for user">
  The apps.permissions.users.request endpoint initiates a request for additional user-level permissions for a slack app. this method is used when an app needs to expand its access to user data or actions within a slack workspace. it's particularly useful for apps that require dynamic permission scaling based on user interactions or evolving feature sets. the endpoint likely triggers a permission request prompt for the user, allowing them to grant or deny the additional permissions. note that this endpoint doesn't directly grant permissions; it only starts the request process. the actual permission changes would occur after user approval through the oauth flow. use this endpoint cautiously and only when absolutely necessary to maintain user trust and adhere to privacy best practices.
</Accordion>

<Accordion title="Set workspace name">
  The admin.teams.settings.setname endpoint allows workspace owners or administrators to change the name of a slack workspace. this operation updates the workspace name displayed in menus, headings, and other areas throughout the slack interface. use this endpoint when you need to rebrand a workspace, reflect organizational changes, or simply update the workspace name for clarity. the new name will be visible to all members of the workspace immediately after the change. note that this action may affect integrations or scripts that rely on the workspace name, so it should be used cautiously and communicated to team members in advance. this endpoint requires administrative privileges and should only be used by authorized personnel with the appropriate permissions.
</Accordion>

<Accordion title="Get user identity">
  The users.identity endpoint retrieves the identity of a slack user associated with the provided token. it allows applications to verify and access basic information about the authenticated user. this endpoint is particularly useful when you need to confirm the identity of a user interacting with your slack app or integration. it should be used when you require up-to-date user information or need to validate a user's identity within your application's workflow. the endpoint returns basic user details but does not provide extensive profile information or team-wide data. note that the specific user information returned may depend on the scopes granted to your application during the oauth process.
</Accordion>

<Accordion title="Send custom message to channel">
  The chat.memessage endpoint allows you to send a "me message" to a specified slack channel. a "me message" is a special type of message that appears as an action performed by the user, typically used for status updates or to describe actions in the third person. this endpoint is useful when you want to share status updates, mood, or actions in a more expressive and visual way than a standard message. it should be used when you want to simulate irc-style /me messages in slack. note that while this endpoint provides a unique way to communicate, it doesn't support rich text formatting or attachments like standard messages do.
</Accordion>

<Accordion title="Establish real time messaging connection">
  The rtm.connect endpoint initiates a websocket-based real-time messaging (rtm) session with slack. it provides a websocket url and initial workspace metadata, allowing applications to establish a real-time connection for receiving events and sending messages. this endpoint should be used when implementing real-time features such as live updates or instant messaging within a slack integration. the connection is single-use and valid for only 30 seconds, so applications must act quickly to establish the websocket connection. it's important to note that this method doesn't support passing a presence value, unlike its counterpart rtm.start.
</Accordion>

<Accordion title="Unarchive admin channel conversations">
  Unarchives a previously archived slack channel, making it active and accessible to users again. this endpoint should be used when an administrator needs to restore a channel that was previously archived, allowing team members to resume conversations and access shared content. it's particularly useful for reactivating seasonal or project-based channels that may have been temporarily archived. note that this action is only available to administrators in enterprise grid or business+ organizations and requires specific administrative permissions. the endpoint does not provide information about the channel's content or members; it simply changes the channel's status from archived to active.
</Accordion>

<Accordion title="Post message to channel">
  The chat.postmessage endpoint allows you to send a message to a slack channel or user. this versatile tool can be used to post simple text messages, create rich interactive messages with blocks or attachments, initiate or reply to threads, and customize the appearance of bot messages. it's ideal for sending notifications, updates, or interactive content to slack users or channels programmatically. the endpoint supports extensive customization of message content and appearance, making it suitable for a wide range of use cases from simple notifications to complex interactive workflows. however, it's important to note that the message structure and appearance may vary depending on the slack client and the parameters used.
</Accordion>

<Accordion title="Retrieve users profile information">
  The users.profile.get endpoint retrieves the profile information of a slack user. it allows you to fetch details such as display name, status, profile picture, and custom fields associated with a user's profile. this endpoint is particularly useful when you need to access up-to-date information about a specific user or the authenticated user. the retrieved data can be used for various purposes, such as populating user information in integrated applications or displaying user details in custom interfaces. note that while the endpoint provides comprehensive profile information, it does not include data about the user's participation in channels or their message history.
</Accordion>

<Accordion title="Update user group users">
  Updates the list of users in a slack user group. this endpoint allows you to completely replace the existing list of users in a specified user group with a new set of users. it's useful for bulk updates to group membership, such as when syncing with an external user management system or reorganizing teams. the endpoint requires the user group id and a full list of user ids to be included in the group. optionally, you can request a count of users in the group after the update. note that this operation will overwrite the existing user list, so ensure you include all desired users in the update.
</Accordion>

<Accordion title="Update views endpoint">
  The views.update method is used to update an existing modal view in slack. it allows you to dynamically modify the content and structure of a modal that is already open for a user. this method is particularly useful for updating interactive components within a modal based on user actions or external events. to use this method, you must provide either the view id or external id to identify the specific view to be updated, along with a new view definition object. the optional hash parameter can be used to prevent race conditions when updating views asynchronously.
</Accordion>

<Accordion title="Unarchive conversation">
  The 'conversations.unarchive' endpoint allows you to restore an archived conversation (channel) in slack, making it active and accessible again. this method is useful when you need to reactivate a previously archived channel for continued use. it's particularly handy for teams that temporarily archive channels for organizational purposes or to reduce clutter, but later decide to resume activities in that conversation. the endpoint requires specifying the exact channel id to be unarchived. note that this operation can only be performed on channels that are currently in an archived state; attempting to unarchive an active channel will result in an error. also, be aware that unarchiving a channel may affect channel limits for your slack workspace, depending on your current plan and usage.
</Accordion>

<Accordion title="Remove emoji using admin api">
  Removes a custom emoji from a slack enterprise grid organization. this endpoint allows administrators to delete a specific custom emoji, making it unavailable across all workspaces within the organization. it should be used when you need to remove inappropriate, outdated, or unused custom emojis. the removal is permanent and affects all users in the enterprise grid. this tool does not provide a way to backup or archive the removed emoji, so use it cautiously.
</Accordion>

<Accordion title="Revoke file public url">
  The 'files.revokepublicurl' endpoint revokes public and external sharing access for a specific file in slack. use this endpoint when you need to disable public sharing of a previously shared file, enhancing privacy and control over sensitive information. this method is particularly useful for situations where a file was accidentally made public or when the sharing period needs to end. the endpoint returns a file object containing updated sharing information, allowing you to confirm the revocation was successful. note that this action is irreversible, and you'll need to create a new public url if sharing is required again in the future.
</Accordion>

<Accordion title="Revoke authentication token">
  Revokes an access token, effectively invalidating it for future use. this endpoint should be called when an application needs to programmatically revoke a token, such as during user logout or when a token is compromised. it's a crucial security measure for managing token lifecycles. the revocation is immediate and permanent; once revoked, the token cannot be reactivated. this endpoint doesn't return the revoked token or any user information for security reasons.
</Accordion>

<Accordion title="Update call information">
  The 'calls.update' endpoint allows you to modify the details of an existing call in slack. this method is used to update call information such as the title, join url, and desktop app join url. it's particularly useful for keeping call information current, especially when call details change after initial creation. the endpoint requires the unique call id and allows optional updates to the call's title and access urls. this method is essential for maintaining accurate and up-to-date call information within slack, enhancing user experience and ensuring smooth integration with third-party call services. note that this endpoint only updates the specified fields and doesn't affect other call properties not included in the request.
</Accordion>

<Accordion title="Retrieve team profile">
  Retrieves the profile information for a slack team, including both custom and default profile fields. this endpoint is useful for obtaining comprehensive details about a team's profile structure, such as field definitions, labels, and visibility settings. it can be used to gather information for team management, integration purposes, or to populate user interfaces with team-specific data. the endpoint does not modify any team data and is read-only, making it safe for frequent calls to keep local data in sync with slack's servers.
</Accordion>

<Accordion title="Uninstall app">
  The apps.uninstall endpoint allows you to remove a slack app from a workspace or an entire enterprise organization. this method revokes all tokens associated with a single installation of an app, effectively uninstalling it. use this endpoint when you need to programmatically remove a slack app, either due to user request, compliance reasons, or as part of app lifecycle management. it's particularly useful for administrators and app developers who need to manage app installations across multiple workspaces. note that uninstalling an app will immediately terminate its access and functionality within the slack environment, so use this method with caution.
</Accordion>

<Accordion title="Upload file to specific channels">
  The files.upload endpoint allows you to upload files to slack channels. use this tool to share various content types, including documents and images, within slack conversations. it supports both direct content uploads and multipart form data, enabling text-based and binary file uploads. you can provide context like title, initial comment, and target channels. authentication with 'files:write:user' scope is required.
</Accordion>

<Accordion title="Update workflow step">
  The workflows.updatestep method allows you to update the configuration of an existing workflow step in slack's workflow builder. this endpoint is essential for dynamically modifying workflow steps, enabling you to adjust inputs, outputs, and other properties of a step based on changing requirements or user interactions. it's particularly useful for maintaining and evolving complex workflows without rebuilding them from scratch. this method should be used when you need to programmatically update a workflow step's configuration, such as changing input fields, modifying output data structures, or updating the step's visual representation in the workflow builder. note that this endpoint is only available for org-ready apps with proper event subscriptions set up, and it replaces the deprecated "legacy steps from apps" feature.
</Accordion>

<Accordion title="Get user information">
  The users.info endpoint retrieves detailed information about a specific user in a slack workspace. it returns comprehensive profile data including the user's name, email, role, status, and other relevant details. this endpoint is particularly useful when you need to fetch up-to-date information about a user, such as checking their current status, verifying their role, or accessing their contact information. it should be used when detailed user data is required for user management, profile display, or integration with other systems. note that while this endpoint provides extensive user information, it does not return data about the user's message history or channel memberships.\<\<DEPRECATED use retrieve\_detailed\_user\_information>>
</Accordion>

<Accordion title="Reset user session">
  The admin.users.session.reset endpoint is used to invalidate all active sessions for a specified user in slack. this powerful administrative tool forces the user to log in again by wiping out their current sessions across all devices. it's particularly useful for security purposes, such as when a user's credentials may have been compromised, or when enforcing new security policies. the endpoint allows for selective session resets, targeting either mobile or web sessions, or both. it should be used cautiously as it can disrupt user access and ongoing work. this method requires administrative privileges and should only be employed when necessary for security or compliance reasons.
</Accordion>

<Accordion title="Unpin message from channel">
  The 'pins.remove' endpoint allows you to remove a pinned message from a specified slack channel. this function is useful for decluttering important information in a channel or removing outdated pinned content. it requires specifying the channel where the pinned item is located and optionally, the timestamp of the specific message to be un-pinned. if the timestamp is not provided, the behavior may default to removing the most recently pinned item. use this endpoint when you need to programmatically manage pinned content in slack channels, such as in automation workflows or when maintaining channel organization. note that this action cannot be undone, so use it cautiously.
</Accordion>

<Accordion title="Update user group details">
  The usergroups.update endpoint allows you to modify an existing user group within a slack workspace. it enables updating various properties of a user group, including its name, description, mention handle, and default channels. this endpoint is particularly useful when you need to adjust user group details to reflect changes in team structure, communication needs, or organizational shifts. use it to keep user groups current and relevant, ensuring efficient team management and targeted communication. the endpoint requires the user group id and allows optional updates to other properties, providing flexibility in managing group characteristics without recreating the entire group.
</Accordion>

<Accordion title="Update slack chat message attributes">
  The chat.update endpoint allows you to modify an existing message in a slack channel. it's used when you need to update the content, attachments, or formatting of a previously sent message. this can be particularly useful for updating dynamic content, correcting errors, or providing real-time updates to information. the endpoint requires specifying both the channel and the timestamp of the message to be updated. it offers flexible options for updating the message text, attachments, and blocks, allowing for rich formatting and interactive elements. however, it's important to note that this endpoint can't be used to update messages sent by other users or apps, and there may be time limitations on how long after a message is sent that it can be updated.
</Accordion>

<Accordion title="Update remote file metadata">
  The 'files.remote.update' endpoint allows you to update the metadata and content of remote files that have been shared in slack. this tool is useful for keeping shared file information up-to-date, such as modifying titles, updating urls, or refreshing preview images. it can be used when file details change externally or when you need to enhance the file's representation within slack. the endpoint doesn't upload new files but rather updates existing remote file references. note that while you can update various attributes, you cannot change the fundamental nature of the file (e.g., converting from one file type to another) through this endpoint.
</Accordion>

<Accordion title="Schedule message in chat">
  The chat.schedulemessage endpoint allows you to schedule a message for future delivery in a slack channel, direct message, or private group. this powerful feature enables automated, time-based communication within your slack workspace. use this endpoint when you need to send messages at specific times, such as reminders, announcements, or recurring updates. the scheduled message can include rich formatting using attachments or blocks, and supports various customization options like threading and link unfurling. keep in mind that scheduled messages are typically limited to 120 days in the future, and the scheduling user must have the necessary permissions in the target channel.
</Accordion>

<Accordion title="Retrieve users profile information">
  The users.profile.get endpoint retrieves the profile information of a slack user. it allows you to fetch details such as display name, status, profile picture, and custom fields associated with a user's profile. this endpoint is particularly useful when you need to access up-to-date information about a specific user or the authenticated user. the retrieved data can be used for various purposes, such as populating user information in integrated applications or displaying user details in custom interfaces. note that while the endpoint provides comprehensive profile information, it does not include data about the user's participation in channels or their message history.\<\<DEPRECATED use retrieve\_user\_profile\_information>>
</Accordion>

<Accordion title="Search messages endpoint">
  The search.messages endpoint allows you to search for messages across all channels, direct messages, and private groups in a slack workspace. it provides powerful search capabilities to find specific content within conversations. this endpoint is particularly useful for retrieving historical information, locating important discussions, or building search functionality into slack-integrated applications. the search results include message content, associated metadata, and can be refined using various parameters for sorting, highlighting, and pagination. keep in mind that the search may not include very recent messages due to indexing delays, and there may be rate limits on the number of requests you can make in a given time period.
</Accordion>

<Accordion title="Lookup users by email">
  The users.lookupbyemail endpoint retrieves detailed information about a single slack user by searching for their registered email address. this method is particularly useful when you need to find a user's slack profile details but only have their email address available. the endpoint returns a comprehensive user object containing various fields such as user id, display name, and other profile information if the user is active. however, it will return a 'users not found' error if the user has been deactivated or if no user with the specified email exists in the workspace. this method requires the 'users:read.email' scope for authentication and should be used judiciously to respect user privacy.\<\<DEPRECATED use find\_user\_by\_email\_address>>
</Accordion>

<Accordion title="List users endpoint">
  The 'users.list' endpoint retrieves a comprehensive list of users within a slack workspace. it provides detailed information about each user, including their profile data, account settings, and team memberships. this endpoint is particularly useful for applications that need to synchronize user data, manage user permissions, or perform bulk operations on user accounts. the response includes both active and deactivated users, allowing for a complete overview of the workspace's user base. however, it's important to note that the endpoint may not return real-time data, and there might be a slight delay in reflecting recent changes to user accounts.\<\<DEPRECATED use list\_all\_slack\_team\_users\_with\_pagination>>
</Accordion>

<Accordion title="Search admin conversations">
  The admin.conversations.search endpoint allows slack workspace administrators to search for conversations across their organization. it enables finding specific channels based on criteria like team membership, names, or topics. this tool is useful for managing large enterprises with multiple teams, helping admins organize their slack workspace effectively. it supports pagination and filtering, making it ideal for auditing channel usage or locating specific project-related channels.
</Accordion>

<Accordion title="Set regular user in team">
  This endpoint converts a user's role to a regular user within a specific slack enterprise grid workspace. it can be used to downgrade the permissions of guests, admins, or owners to standard user privileges. the endpoint is specifically designed for enterprise grid organizations and should be used when there's a need to adjust user roles for organizational management purposes. it's important to note that this action can have significant impacts on user permissions and should be used carefully. the endpoint doesn't provide information about the user's previous role or confirm the success of the role change in the response.
</Accordion>

<Accordion title="Set user photo with cropping">
  The users.setphoto endpoint allows users to upload and set their profile photo in slack. this method accepts an image file via multipart/form-data and provides optional cropping functionality. use this endpoint when a user wants to change their profile picture or when an application needs to programmatically update a user's photo. the endpoint supports various image formats and automatically resizes large images. if cropping is desired, all three cropping parameters (crop x, crop y, crop w) must be provided together for precise photo customization.
</Accordion>

<Accordion title="Manage channel workspaces settings">
  The admin.conversations.setteams endpoint allows slack enterprise grid administrators to manage the workspace associations of a specific channel. it enables sharing a channel across multiple workspaces or converting it to an org-wide channel visible to the entire enterprise grid organization. this endpoint is crucial for facilitating cross-workspace collaboration and centralizing important channels. it should be used when there's a need to expand a channel's reach beyond its original workspace or to streamline communication across the organization. however, it's important to note that this endpoint requires administrative privileges and should be used cautiously to maintain proper channel organization and access control.
</Accordion>

<Accordion title="Get conversation members">
  Retrieves a list of members in a specific slack conversation. this endpoint is part of the conversations api and can be used to fetch member information for public channels, private channels, direct messages, and group direct messages. it's particularly useful for analyzing conversation participants, managing large channels, or integrating member information into external systems. the endpoint supports pagination for efficiently handling conversations with a large number of members. note that the api may not return members who have left the conversation or workspace, focusing only on current active members.
</Accordion>

<Accordion title="Remove channels from usergroup">
  Removes specified channels from a designated user group in slack. this endpoint allows administrators to disassociate multiple channels from a user group simultaneously, which can be useful for managing access control and organization within a slack workspace. it should be used when you need to update the channel associations for a user group, such as when reorganizing team structures or adjusting access permissions. note that this operation only removes the association between the channels and the user group; it does not delete the channels or the user group itself. be cautious when using this endpoint, as it may impact users' access to channels they previously had through the user group membership.
</Accordion>

<Accordion title="Rename conversation channel">
  This endpoint renames an existing conversation (channel) in slack. it should be used when you need to update the name of a channel, either for rebranding, clarifying its purpose, or organizing workspace structure. the endpoint requires the unique channel id and the desired new name. only authorized users (such as the channel creator, workspace admins, or channel managers) can perform this action. the new name must comply with slack's naming conventions, and the api will automatically adjust it if necessary. note that renaming a channel may affect existing integrations or saved references to the channel name.
</Accordion>

<Accordion title="Set conversation purpose">
  The 'conversations.setpurpose' endpoint allows you to set or update the purpose (description) of a slack conversation. this function is useful for providing context and clarity about the intended use of a channel, group, or direct message. use this endpoint when you need to establish or modify the purpose of a conversation, which can help team members understand its focus and relevance. the endpoint requires specifying the conversation id and the new purpose text. it's important to note that the calling user must be a member of the conversation to set its purpose, and the new purpose is subject to slack's character limit restrictions.
</Accordion>

<Accordion title="Get conversation info">
  The conversations.info endpoint retrieves detailed information about a specific conversation in slack. it provides comprehensive data about channels, direct messages, or multi-person direct messages, including their properties, members, and settings. this endpoint is particularly useful when you need to access metadata about a conversation, such as its name, purpose, creation date, or membership details. it should be used when detailed information about a specific slack conversation is required, rather than for listing multiple conversations or accessing message content. note that while this endpoint provides extensive metadata, it does not return the actual messages within the conversation; for that, you would need to use a separate endpoint like conversations.history.
</Accordion>

<Accordion title="Set conversation topic">
  Sets or updates the topic for a specified slack conversation. this endpoint allows you to change the topic of any type of slack conversation, including public channels, private channels, direct messages, and group conversations. the topic is a brief description or subject line that appears at the top of the conversation, helping team members understand its purpose or current focus. use this when you need to programmatically update or set a conversation's topic. note that the new topic does not support any text formatting or automatic link creation (linkification). the authenticated user must have the necessary permissions to modify the topic in the specified conversation.
</Accordion>


# Snowflake
Source: https://docs.push.ai/integrations/snowflake



Connect to Snowflake to run queries.

<Accordion title="Explore Columns">
  Explore columns in a table in snowflake. this action provides distinct values of columns in a table.
</Accordion>

<Accordion title="Describe Table">
  Describe a table in snowflake. this action provides information about the columns in the table like their data types, nullability, primary key, unique key and default values.
</Accordion>

<Accordion title="Run Query">
  Execute a sql query in snowflake.
</Accordion>

<Accordion title="Show Tables">
  Show tables in a snowflake schema.
</Accordion>


# Stripe
Source: https://docs.push.ai/integrations/stripe



Stripe is a payment processor that allows you to accept payments online.

<Accordion title="Create Customer">
  Creates a new customer record in stripe.
</Accordion>

<Accordion title="Create Invoice">
  Creates a draft invoice for a given customer in stripe.
</Accordion>

<Accordion title="Create Product">
  Creates a new product in stripe.
</Accordion>

<Accordion title="List Charges">
  Retrieves a list of charges from stripe, optionally filtered by various parameters.
</Accordion>

<Accordion title="Create Price">
  Creates a new price for a product in stripe, handling both flat and nested fields.
</Accordion>

<Accordion title="List Customers">
  Retrieves a list of customers from stripe, optionally filtered by various parameters.
</Accordion>

<Accordion title="List Invoices">
  Retrieves a list of invoices from stripe, optionally filtered by various parameters.
</Accordion>

<Accordion title="List PaymentIntents">
  Retrieves a list of paymentintents from stripe, optionally filtered by various parameters.
</Accordion>

<Accordion title="List Products">
  Retrieves a list of products from stripe, optionally filtered by various parameters.
</Accordion>

<Accordion title="List Subscriptions">
  Retrieves a list of subscriptions from stripe, optionally filtered by various parameters.
</Accordion>

<Accordion title="Retrieve Customer">
  Retrieves an existing customer's information from stripe.
</Accordion>

<Accordion title="Update Subscription">
  Updates an existing subscription in stripe with bracket-notation flattening.
</Accordion>

<Accordion title="Retrieve Balance">
  Retrieves the current account balance in stripe based on the authentication used for the request.
</Accordion>

<Accordion title="Retrieve Subscription">
  Retrieves a subscription from stripe using the given subscription id.
</Accordion>

<Accordion title="Create Payment Intent">
  Creates a paymentintent in stripe to initiate a payment.
</Accordion>

<Accordion title="Update Customer">
  Updates an existing customer's information in stripe with bracket-notation flattening.
</Accordion>

<Accordion title="Create Subscription">
  Creates a new detailed subscription for an existing customer in stripe.
</Accordion>

<Accordion title="Cancel Subscription">
  Cancels a customer's subscription in stripe immediately or at the end of the billing period.
</Accordion>

<Accordion title="Confirm PaymentIntent">
  Confirms a paymentintent in stripe, initiating payment with the current or provided payment method.
</Accordion>


# Supabase
Source: https://docs.push.ai/integrations/supabase



Supabase is an open-source backend-as-a-service providing a Postgres database, authentication, storage, and real-time subscription APIs for building modern applications

<Accordion title="Create project api key">
  Creates a new api key for a supabase project. this endpoint allows you to generate either a publishable or secret api key, which can be used to authenticate and authorize access to your supabase project's resources. use this when you need to create new access credentials for your application or when rotating keys for security purposes. the endpoint provides options to add a description to the key and customize jwt templates for secret keys, enhancing key management and security.
</Accordion>

<Accordion title="Delete api key from project">
  Deletes a specific api key associated with a supabase project. this endpoint is used to revoke access for a particular api key, enhancing security by removing unused or potentially compromised keys. it should be used when you need to invalidate an api key, such as when an employee leaves the organization or when you suspect a key has been exposed. the operation is irreversible, so use it with caution. once deleted, any applications or services using this api key will lose access to the supabase project resources.
</Accordion>

<Accordion title="Get third party auth config">
  Retrieves the configuration details for a specific third-party authentication provider associated with a supabase project. this endpoint allows developers to inspect and manage the settings of external authentication services integrated with their supabase application. use this when you need to view or verify the current configuration of a particular third-party auth provider, such as client ids, redirect uris, or other provider-specific settings. this tool is particularly useful for debugging authentication issues, auditing security configurations, or preparing to update third-party auth settings. note that this endpoint only retrieves the configuration and does not modify any settings.
</Accordion>

<Accordion title="Activate vanity subdomain for project">
  Activates a custom vanity subdomain for a specific supabase project. this endpoint allows you to set up a personalized url for your project, replacing the default supabase-provided domain. use this when you want to improve branding, enhance user trust, or create a more professional appearance for your application. the activation process associates your custom subdomain with the specified project, enabling access to your supabase resources through this new url. note that dns configuration on your domain registrar's side may be required for the vanity subdomain to work correctly.
</Accordion>

<Accordion title="Get third party auth config for project">
  Retrieves the current third-party authentication configuration for a specific supabase project. this endpoint allows developers to fetch details about which third-party authentication providers (such as google, facebook, or github) are currently set up and configured for the project. it's useful when you need to review or verify the existing third-party auth settings, especially before making changes or troubleshooting authentication issues. the endpoint returns read-only information and doesn't modify any settings. use this when you need to audit your project's authentication setup or when integrating third-party login options into your application.
</Accordion>

<Accordion title="Activate custom hostname for project">
  Activates a previously configured custom hostname for a specific supabase project. this endpoint should be used when you want to make your custom domain active and accessible for your project after setting it up. it finalizes the process of associating your custom domain with your supabase project, allowing users to access your project via the custom url instead of the default supabase-provided url. this action is typically performed once the dns settings have been properly configured and verified. note that this endpoint only activates the hostname; it does not handle the initial setup or dns configuration.
</Accordion>

<Accordion title="Authorize oauth access">
  Initiates the oauth 2.0 authorization process for supabase. this endpoint is used to start the authorization flow, allowing third-party applications to request permission from users to access their supabase resources. when called, it typically redirects the user to a supabase-hosted login page where they can grant or deny access to the requesting application. after authorization, the user is redirected back to the application with an authorization code, which can be exchanged for an access token. this endpoint should be used when implementing oauth 2.0 authentication flow in client applications that need to integrate with supabase services. it's important to note that this is just the first step in the oauth process and additional steps will be required to complete the authentication.
</Accordion>

<Accordion title="Delete vanity subdomain for project">
  Deletes the vanity subdomain associated with a specific supabase project. this endpoint should be used when you want to remove a custom domain name that was previously set up for your project. it's important to note that this action is irreversible and will immediately affect how users access your project. after deletion, the project will revert to its default supabase-provided url. use this endpoint with caution, as it may disrupt existing integrations or user access if not properly managed. this operation does not affect the project's data or functionality, only its custom access url.
</Accordion>

<Accordion title="Check vanity subdomain availability">
  Checks the availability of a vanity subdomain for a supabase project. this endpoint allows developers to verify if a desired custom subdomain is available for use with their project's api. it should be used when setting up a new project or when wanting to customize the url for an existing project. the tool will return information about whether the requested subdomain is available or already in use. it's important to note that this endpoint only checks availability and does not reserve or assign the subdomain; a separate action would be required to actually set the vanity subdomain for the project.
</Accordion>

<Accordion title="Delete custom hostname for project">
  Deletes the custom hostname associated with a specific supabase project. this endpoint should be used when you want to remove a previously configured custom domain from your project, reverting it back to the default supabase-provided hostname. it's important to note that this action will affect your project's accessibility and may require updates to your client code, oauth provider settings, and dns configurations. use this endpoint with caution, as it will immediately impact how users and services interact with your supabase project.
</Accordion>

<Accordion title="Delete third party auth config">
  Removes a specified third-party authentication provider from a supabase project's configuration. this endpoint should be used when you want to disable or remove a previously configured external authentication method, such as google, github, or other social login providers. it's particularly useful when updating your app's authentication options or when you no longer want to support a specific third-party login method. be cautious when using this endpoint, as it will immediately prevent users from logging in via the removed provider. ensure you have a migration plan for users who previously used this authentication method.
</Accordion>

<Accordion title="Patch api key description and role">
  Updates the properties of an existing api key for a specified supabase project. this endpoint allows you to modify the description and jwt template configuration of an api key, enabling fine-tuned control over authentication and authorization settings. use this when you need to change the purpose, role, or permissions associated with an existing api key. the endpoint is particularly useful for adjusting access levels or providing more context about the key's usage without creating a new key. note that updating an api key does not regenerate the key itself, but rather modifies its metadata and associated jwt configuration.
</Accordion>

<Accordion title="Fetch vanity subdomain by project reference">
  Retrieves the vanity subdomain associated with a specific supabase project. this endpoint allows developers to fetch the custom domain name assigned to their project, which can be used for branding and easier access to the project's api. use this endpoint when you need to confirm or display the current vanity subdomain for a given project. it's particularly useful for project management interfaces or when setting up integrations that require the project's custom url. the endpoint does not modify the subdomain; it only provides read access to the existing configuration.
</Accordion>

<Accordion title="Beta gets project s custom hostname config">
  Retrieves the custom hostname information for a specified supabase project. this endpoint allows users to get details about the custom domain configuration associated with their project. it is useful when you need to verify the current custom hostname settings, check the status of a custom domain setup, or gather information for troubleshooting domain-related issues. the endpoint should be used when managing project settings, particularly those related to custom domain configuration. it does not modify any settings and is intended for read-only access to the custom hostname data. note that this endpoint may only return information for projects on paid plans that have access to the custom hostname feature.
</Accordion>

<Accordion title="Enable project database webhooks">
  Enables database webhooks for a specified supabase project. this endpoint allows developers to activate real-time notifications for database events such as insert, update, or delete operations. once enabled, external systems can receive instant updates about changes in the project's database tables. this feature is particularly useful for maintaining data consistency across multiple systems or triggering actions based on database changes. it should be used when setting up integrations that require immediate reaction to database modifications. keep in mind that enabling webhooks may increase system load and network traffic, so it should be used judiciously and with appropriate error handling in place.
</Accordion>

<Accordion title="Fetch pgsodium settings">
  Retrieves the pgsodium configuration or status information for a specific supabase project. this endpoint allows developers to access details about the pgsodium extension, which provides advanced security features for postgresql databases within the project. use this endpoint when you need to check the current pgsodium settings, verify its activation status, or gather information about the security features it provides for your supabase project. the endpoint is particularly useful for monitoring and managing database security configurations, but it does not modify any settings directly.
</Accordion>

<Accordion title="Retrieve project network restrictions">
  Retrieves the current network restrictions configured for a specific supabase project. this endpoint allows developers to fetch and review the existing network access controls, such as ip whitelists or blacklists, that have been set up to enhance the project's security. use this endpoint when you need to audit or verify the current network security settings for a particular project. it's particularly useful for maintaining and monitoring the security posture of your supabase applications. the endpoint doesn't modify any settings; it only provides read access to the existing configuration.
</Accordion>

<Accordion title="Retrieve network ban for project">
  Retrieves the list of network bans for a specific supabase project. this endpoint allows project administrators to view all ip addresses or ranges that have been banned from accessing the project's resources. it should be used when monitoring network security, investigating potential security breaches, or managing access control for the project. the endpoint returns a list of banned ip addresses or ranges along with any associated metadata such as the reason for the ban and the timestamp of when it was implemented. it's important to note that this endpoint only retrieves existing bans and does not modify or create new bans.
</Accordion>

<Accordion title="Get project upgrade status">
  Retrieves the current upgrade status for a specified supabase project. this endpoint should be used to check the progress or result of an ongoing or recent project upgrade. it provides information about whether the upgrade is in progress, completed successfully, or encountered any issues. this tool is particularly useful for monitoring the state of your project during maintenance or version updates. it does not initiate upgrades or provide detailed logs of the upgrade process.
</Accordion>

<Accordion title="Request oauth token with credentials">
  Generates or refreshes an oauth token for authenticating api requests to supabase. this endpoint supports two grant types: 'authorization code' for obtaining a new token, and 'refresh token' for refreshing an existing token. it should be used to acquire the necessary credentials for accessing protected supabase resources. the endpoint requires client authentication and expects form-encoded data. it's crucial for implementing secure api access in applications using supabase, but should not be called directly by end-users. instead, it should be part of a secure oauth flow handled by your application's backend.
</Accordion>

<Accordion title="Update database pooler config">
  Updates the database pooler configuration for a specific supabase project. this endpoint allows you to modify the connection pool settings, which can significantly impact your application's database performance and scalability. use this when you need to optimize database connection management based on your application's requirements. the primary focus is on adjusting the default pool size to balance between performance and resource utilization. note that while the pool mode parameter is present in the schema, it is deprecated and ignored in the request.
</Accordion>

<Accordion title="Update postgresql database configurations">
  Updates the postgresql configuration settings for a specific supabase project. this endpoint allows fine-tuning of various database parameters to optimize performance, resource utilization, and behavior of the postgresql instance. it should be used when you need to adjust database settings to meet specific application requirements or improve overall database performance. exercise caution when modifying these settings, as improper configurations can significantly impact database functionality and performance. it's recommended to test changes in a non-production environment before applying them to a live system. note that some changes may require a database restart to take effect.
</Accordion>

<Accordion title="Get function details by slug and reference">
  Retrieves detailed information about a specific function within a supabase project. this endpoint allows developers to fetch metadata, configuration, and other relevant details about a serverless function or edge function deployed in their supabase project. it's useful for monitoring, debugging, or programmatically managing functions within your supabase infrastructure. the endpoint requires both the project reference and the function's unique identifier (slug) to pinpoint the exact function you're querying. use this when you need to inspect or verify the current state and configuration of a particular function in your project.
</Accordion>

<Accordion title="Retrieve project sslenforcement">
  Retrieves the current ssl enforcement status for a specified supabase project. this endpoint allows developers to check whether ssl connections are mandated for database access, enhancing security by ensuring data encryption in transit. use this endpoint when you need to verify the ssl settings for a project, particularly during security audits or when troubleshooting connection issues. the returned information helps in understanding the project's current security configuration regarding ssl usage.
</Accordion>

<Accordion title="Get organizations">
  Retrieves a list of organizations associated with the authenticated user's supabase account. this endpoint is part of supabase's management api and is used to get an overview of all organizations the user has access to. it's particularly useful for users who manage multiple organizations or need to switch between different organization contexts. the endpoint returns basic information about each organization, which may include details such as organization id, name, and other relevant metadata. this tool should be used when you need to display a list of organizations, select an organization for further operations, or verify organization membership. it does not provide detailed information about projects within organizations or allow for organization management operations.
</Accordion>

<Accordion title="Remove project read replica">
  Removes a specified read replica from a supabase project. this endpoint is used to manage the database replication setup by eliminating unnecessary or outdated read replicas. it should be used when you need to reduce the number of read replicas, perhaps to optimize resource usage or reduce costs. the operation is irreversible, so it should be used with caution. this tool does not provide information about the status of the removal process or the remaining read replicas; it only initiates the removal action.
</Accordion>

<Accordion title="Retrieve branch by id">
  Retrieves detailed information about a specific branch in a supabase project. this endpoint allows developers to fetch the current status, configuration, and other relevant details of a particular branch identified by its unique branch id. it's useful for monitoring the state of different development environments, verifying branch settings, or gathering information before performing operations on a branch. the endpoint should be used when you need up-to-date information about a single branch, such as checking if it's ready for merging or reviewing its current setup. note that this endpoint only provides read-only access to branch information and cannot be used to modify the branch.
</Accordion>

<Accordion title="Restore database backup by recovery time">
  Initiates a point-in-time recovery (pitr) operation to restore a supabase project's database to a specific moment in time. this endpoint should be used when you need to recover your database due to accidental data loss, corruption, or to revert unintended changes. it allows for precise recovery, reducing data loss to as little as two minutes before the incident. the restoration process may take some time depending on the size of your database and the specified recovery point. note that this operation will overwrite the current state of your database, so it should be used with caution and only when absolutely necessary.
</Accordion>

<Accordion title="Retrieve snippet by id">
  Retrieves a specific snippet from the supabase database based on its unique identifier. this endpoint should be used when you need to fetch the full details of a particular snippet, such as its content, metadata, or associated information. it's particularly useful for displaying individual snippet details or for retrieving snippet data for editing purposes. the endpoint returns a single snippet object and does not support retrieving multiple snippets in one call. note that this endpoint only retrieves existing snippets; it cannot be used to create, update, or delete snippets.
</Accordion>

<Accordion title="Retrieve api keys for project">
  Retrieves the list of api keys associated with a specific supabase project. this endpoint allows developers to fetch all the api keys that have been generated for a particular project, which is crucial for managing access to the project's resources and services. use this endpoint when you need to view, audit, or manage the api keys for a given project. it's particularly useful for security audits, key rotation, or when setting up new environments that require existing api keys. the endpoint does not create new keys or modify existing ones; it only provides a read-only view of the current api keys for the specified project.
</Accordion>

<Accordion title="Delete project network bans">
  Removes specified ipv4 addresses from the network ban list of a supabase project. this endpoint allows project administrators to lift restrictions on previously banned ip addresses, restoring their access to the project's resources. use this when you need to unblock specific ip addresses that were previously banned, either due to a mistake, a resolved security issue, or a change in access requirements. it's important to note that this action immediately restores access for the specified ip addresses, so it should be used cautiously and only when you're certain that the ip addresses are safe to unban.
</Accordion>

<Accordion title="Get project list">
  Retrieves a list of all projects associated with the authenticated user's supabase account. this endpoint provides an overview of the projects created and managed by the user, allowing for easy access to project information and management. it should be used when you need to fetch details about multiple projects at once, such as for displaying a project dashboard or selecting a project to work on. the endpoint returns basic information about each project, which may include project ids, names, and other relevant metadata. it does not provide detailed statistics or real-time data about project usage or performance.
</Accordion>

<Accordion title="Patch function details">
  Updates an existing edge function within a specified supabase project. this endpoint allows you to modify various properties of an edge function, including its name, source code, and jwt verification settings. it's particularly useful for iterating on function development, implementing bug fixes, or adjusting security settings without creating a new function. the endpoint supports both json and deno-specific eszip formats, making it versatile for different development workflows. use this when you need to make changes to an existing function's configuration or code without altering its fundamental identity within your project structure.
</Accordion>

<Accordion title="Fetch project sso provider config">
  Retrieves the configuration details for a specific single sign-on (sso) provider associated with a supabase project. this endpoint allows developers to fetch the current settings and parameters for a particular sso integration, such as google, github, or azure active directory. use this when you need to review or verify the configuration of an sso provider for your project, for example, before making changes or troubleshooting authentication issues. the endpoint returns the provider's configuration but does not modify any settings. it's particularly useful for auditing your project's sso setup or preparing for updates to the sso configuration.
</Accordion>

<Accordion title="Get organization by slug">
  Retrieves detailed information about a specific organization in supabase using its unique slug identifier. this endpoint is part of the management api and allows you to fetch organization-level data, which may include details such as the organization's name, created date, owner information, and associated projects. it's useful when you need to access or verify organization details programmatically, especially in scenarios involving multi-project management or organization-wide settings. the endpoint returns read-only data and does not modify any organization information.
</Accordion>

<Accordion title="Update branch details by id">
  Updates the configuration and properties of a specific branch in a supabase project. this endpoint allows modifications to branch settings such as its name, associated git branch, reset behavior, persistence, and current status. it's used for managing branch-specific configurations, synchronizing with version control, and tracking the deployment state of database migrations and serverless functions. this tool is particularly useful when adjusting branch settings during development workflows, ci/cd processes, or when troubleshooting deployment issues. note that while most fields are user-updateable, the 'status' field might be system-controlled in many cases and may not always reflect immediate changes.
</Accordion>

<Accordion title="Update sso provider configuration">
  Updates the configuration of a single sign-on (sso) provider for a specific supabase project. this endpoint allows you to modify various aspects of the sso setup, including metadata, allowed domains, and attribute mapping. use this when you need to change the sso provider's settings, such as updating the identity provider's metadata, adjusting allowed domains, or modifying how user attributes are mapped from the sso provider to supabase. this tool is crucial for maintaining and adapting your project's sso integration as your authentication needs evolve or when the identity provider's configuration changes.
</Accordion>

<Accordion title="Get project as readonly">
  Retrieves the read-only status of a specific supabase project. this endpoint allows users to check whether a project is currently in read-only mode, which may affect the ability to make changes to the project's database or settings. use this endpoint when you need to verify the current operational state of a project, especially before attempting to make modifications. the read-only status can be crucial for maintenance, troubleshooting, or ensuring data integrity during critical operations. note that this endpoint only provides the status and does not allow changing the read-only state of the project.
</Accordion>

<Accordion title="Get project database pgbouncer config">
  Retrieves the pgbouncer configuration settings for a specified supabase project. this endpoint allows developers to view the current connection pooling settings, which are crucial for optimizing database performance and resource utilization. use this when you need to inspect or audit the pgbouncer configuration, such as before making changes or troubleshooting connection issues. the response will include details like pool size, connection timeouts, and other pgbouncer-specific parameters. note that this endpoint only provides read access to the configuration and does not allow modifications.
</Accordion>

<Accordion title="Retrieve function body by reference and slug">
  Retrieves the body (source code) of a specific serverless function within a supabase project. this endpoint allows developers to fetch the current implementation of a function, which can be useful for auditing, debugging, or programmatically managing function code. it should be used when you need to view or analyze the code of an existing serverless function in your project. the endpoint does not modify the function; it only provides read access to the function's body. note that this tool does not execute the function or provide information about its runtime behavior or logs.
</Accordion>

<Accordion title="Check project upgrade eligibility">
  Checks the upgrade eligibility status for a specific supabase project. this endpoint allows developers to determine whether a project can be upgraded to a newer version or plan. it should be used before initiating an upgrade process to ensure the project meets the necessary criteria for an upgrade. the tool returns the eligibility status, which can help in making informed decisions about project maintenance and feature adoption. it does not perform the actual upgrade; it only provides information about the possibility of an upgrade.
</Accordion>

<Accordion title="Setup read replica for project">
  Sets up a read replica for a specified supabase project in a chosen aws region. this endpoint is used to enhance database performance and reduce latency by creating a read-only copy of the primary database in a different geographical location. it's particularly useful for applications with a global user base or those requiring improved read performance. the setup process involves specifying the desired region for the read replica, which should be chosen based on the geographical distribution of your users. this endpoint should be used when scaling your application to handle increased read traffic or to improve response times for users in different parts of the world. note that while read replicas improve read performance, they do not directly affect write operations, which are still handled by the primary database.
</Accordion>

<Accordion title="Execute project database query">
  Executes a custom sql query on a specified supabase project's database. this endpoint allows direct interaction with the postgresql database, enabling complex data operations beyond basic crud functionalities. use this when you need to perform advanced queries, data manipulations, or when the standard supabase api endpoints don't suffice for your specific data requirements. be cautious when using this endpoint, as it provides raw sql execution capabilities, which can potentially modify or delete data if not used carefully. ensure proper input validation and consider using parameterized queries to prevent sql injection attacks.
</Accordion>

<Accordion title="List project database backups">
  Retrieves a list of database backups for a specified supabase project. this endpoint allows users to view the available backups for their project's database, which is crucial for data management and disaster recovery planning. it should be used when you need to check the status of your backups, verify backup completion, or prepare for a database restore operation. the endpoint provides information about existing backups but does not create new backups or perform restore operations. keep in mind that the availability and retention of backups may depend on your supabase plan and configuration.
</Accordion>

<Accordion title="Fetch project storage buckets">
  Retrieves a list of all storage buckets within a specified supabase project. this endpoint allows developers to get an overview of the storage organization for a particular project, including both public and private buckets. it's useful for managing and monitoring storage resources, especially when working with multiple buckets or when you need to verify the existence of specific buckets. the endpoint does not provide detailed information about the contents of the buckets or their access policies; it only returns a list of bucket names or identifiers. use this when you need to enumerate available storage containers or before performing operations that require knowing the existing bucket structure.
</Accordion>

<Accordion title="Get project auth config">
  Retrieves the current authentication configuration for a specified supabase project. this endpoint is used to fetch details about the project's authentication settings, which may include information about enabled authentication providers, single sign-on (sso) configurations, and other auth-related parameters. it's particularly useful when you need to review or audit the current authentication setup of a project. the endpoint does not modify any settings; it's purely for retrieving information. note that while this endpoint provides comprehensive auth configuration data, it does not return sensitive information like api keys or secrets.
</Accordion>

<Accordion title="Retrieve postgrest project data">
  Retrieves the postgrest configuration for a specified supabase project. this endpoint allows developers to fetch the current settings and parameters of the postgrest instance associated with their project. it's particularly useful when you need to review or debug the restful api layer built on top of your postgresql database. use this endpoint when you want to inspect how your project's api is configured, including any custom settings or optimizations. note that this endpoint only provides configuration information and does not allow for direct modification of the postgrest settings.
</Accordion>

<Accordion title="Initialize custom hostname">
  Initializes a custom hostname for a specific supabase project. this endpoint allows you to set up a unique domain name for your project, enabling you to use your own branded url instead of the default supabase-provided subdomain. this is particularly useful for production environments where you want to present a professional, branded interface to your users. the custom hostname must be properly configured with appropriate dns settings before initialization. this operation is typically performed once per project and may require additional steps for ssl certificate provisioning.
</Accordion>

<Accordion title="Fetch sso provider config for project">
  Retrieves the list of configured single sign-on (sso) providers for a specific supabase project. this endpoint allows developers to fetch the current sso configuration, including details about each configured provider such as type (e.g., google, facebook, github) and any associated settings. it's particularly useful when you need to review or audit the authentication options available for your project. the endpoint does not modify any configurations; it's a read-only operation intended for configuration review and management purposes.
</Accordion>

<Accordion title="Patch project postgrest configuration">
  Updates the postgrest configuration for a specific supabase project. this endpoint allows you to modify various postgrest settings, including the maximum number of rows returned, database connection pool size, additional search paths, and the primary database schema. use this endpoint when you need to fine-tune the performance and behavior of your postgrest api for a particular project. it's particularly useful for optimizing query results, managing database resources, and customizing schema configurations. note that changes made through this endpoint may affect the behavior and performance of your postgrest api, so use it cautiously and test thoroughly after making updates.
</Accordion>

<Accordion title="Retrieve postgresql config for project">
  Retrieves the postgresql database configuration for a specified supabase project. this endpoint allows developers to access detailed settings and parameters of their project's database, which can be crucial for understanding the current setup, troubleshooting, or planning optimizations. it should be used when you need to review or verify the database configuration, such as connection limits, memory allocations, or other postgresql-specific settings. the tool provides a snapshot of the current configuration and does not modify any settings. keep in mind that some advanced or security-sensitive configuration details might be omitted from the response.
</Accordion>

<Accordion title="Delete branch by id">
  Deletes a specific branch from the supabase project's version control system. this endpoint should be used when you want to permanently remove a branch and its associated data state from your project. it's particularly useful for cleaning up temporary or experimental branches that are no longer needed. be cautious when using this endpoint, as deleting a branch is irreversible and will remove all data and changes specific to that branch. ensure that any necessary data or changes have been merged or backed up before deletion. this operation does not affect the main branch or other existing branches in your project.
</Accordion>

<Accordion title="Temporary disable project readonly">
  Temporarily disables the read-only mode for a specified supabase project. this endpoint is used when you need to perform write operations on a project that is normally set to read-only. it's particularly useful for maintenance tasks, data updates, or temporary modifications to project settings. the disable duration is not specified in the schema, so it's advisable to re-enable read-only mode manually after completing the necessary operations. this endpoint should be used cautiously as it may affect data integrity if write operations are not carefully managed during the disabled period. it's important to note that this operation likely requires admin or owner-level permissions for the project.
</Accordion>

<Accordion title="Post project upgrade version">
  Upgrades a supabase project to a specified version through a chosen release channel. this endpoint allows developers to update their supabase project to a newer version, providing access to the latest features, improvements, and bug fixes. the upgrade process requires specifying both the release channel and the target version to ensure a controlled and predictable upgrade path. this tool should be used when a project needs to be updated to a specific version or when transitioning between different stages of stability (e.g., from beta to general availability). it's important to note that upgrading may impact existing functionality, so it's recommended to review release notes and test thoroughly before upgrading production environments.
</Accordion>

<Accordion title="Check project health status">
  Retrieves the current health status of a specified supabase project. this endpoint should be used to monitor the operational status and performance of your supabase project, ensuring it's functioning correctly. it provides a quick way to check if all components of your project (such as database, authentication, and storage) are operating as expected. this tool is particularly useful for implementing health checks in your application, setting up monitoring systems, or troubleshooting issues. note that while it gives an overview of project health, it may not provide detailed diagnostics or historical data.
</Accordion>

<Accordion title="Set project root key">
  Updates the pgsodium configuration for a specific supabase project by setting a new root encryption key. this endpoint is used to initialize or change the database encryption settings, enhancing the security of data stored in the project. it should be used when setting up a new project's security features or when rotating encryption keys for security best practices. this operation is critical and should be performed with caution, as it affects the encryption of all data in the project's database.
</Accordion>

<Accordion title="Create project function with jwt verification">
  Creates a new edge function for a specified supabase project. edge functions are serverless functions that run on supabase's edge network, allowing for quick execution and low latency. this endpoint is used when you need to add new custom functionality to your supabase project, such as integrating with third-party apis or performing complex computations. the function can be written in javascript or typescript and will be deployed to supabase's infrastructure. it's important to note that the function's code ('body' parameter) should be thoroughly tested before deployment, as errors in edge functions can impact your application's performance and functionality.
</Accordion>

<Accordion title="Apply network restrictions to project">
  Applies network restrictions to a supabase project by specifying allowed ipv4 and ipv6 addresses for database access. this endpoint enhances database security by limiting connections to only authorized ip addresses. it should be used when setting up or updating network security policies for a supabase project. the function takes arrays of allowed ipv4 and ipv6 addresses or cidr ranges, applying these restrictions to control database access. it's particularly useful for securing production environments or implementing strict access controls. note that applying these restrictions may impact existing database connections from non-specified ip addresses.
</Accordion>

<Accordion title="Get project database pooler configuration">
  Retrieves the current database pooler configuration for a specified supabase project. this endpoint allows developers to fetch detailed settings related to the connection pooler, which manages and optimizes database connections for improved performance and resource utilization. use this endpoint when you need to review or troubleshoot the database connection management settings for your supabase project. the returned configuration likely includes information about pooling modes (transaction or session), connection limits, and other relevant pooler parameters. this tool is particularly useful for understanding how your project's database connections are being managed and can help in optimizing database performance.
</Accordion>

<Accordion title="Disables preview branching">
  Disables preview branching for the specified project
</Accordion>

<Accordion title="Configure ssl enforcement for project">
  Updates the ssl enforcement configuration for a specific supabase project's database connections. this endpoint allows you to enable or disable ssl enforcement, which is crucial for maintaining secure communications between clients and the database. use this when you need to modify the project's database security settings, particularly when changing the ssl requirements for database access. the change affects how clients connect to the database, so use with caution and ensure all client applications are prepared for any ssl enforcement changes.
</Accordion>

<Accordion title="Delete function by slug">
  Deletes a specific edge function from a supabase project. this endpoint should be used when you want to permanently remove a function that is no longer needed or has become obsolete. it's important to note that this action is irreversible, and once a function is deleted, it cannot be recovered. use this endpoint with caution, especially in production environments, to avoid unintended loss of functionality. this operation helps in maintaining a clean and efficient project structure by removing unused functions.
</Accordion>

<Accordion title="Configure third party authentication">
  Configures third-party authentication settings for a supabase project. this endpoint allows you to set up openid connect (oidc) and json web key set (jwks) parameters for integrating external identity providers. use this when you need to enable or update third-party authentication methods in your supabase application. the endpoint accepts either an oidc issuer url, a jwks url, or custom jwks data, providing flexibility in how you manage authentication keys and configurations. this is particularly useful for implementing single sign-on (sso) or integrating with enterprise identity solutions.
</Accordion>

<Accordion title="Fetch typescript project info">
  Retrieves typescript type definitions generated from the database schema of a specified supabase project. this endpoint is essential for developers working with typescript in their supabase projects, as it provides type-safe access to database tables and views. the generated types enhance code quality by enabling compile-time checks and autocompletion in ides. use this endpoint when setting up a new typescript project with supabase or after making changes to your database schema to ensure your types are up-to-date. note that this endpoint does not modify your database or project settings; it only retrieves the current type definitions based on your existing schema.
</Accordion>

<Accordion title="Create a database branch">
  Creates a database branch from the specified project.
</Accordion>

<Accordion title="Reverify custom hostname by project id">
  Re-verifies the custom hostname associated with a specific supabase project. this endpoint is used when there's a need to confirm or update the verification status of a previously set custom hostname for a project. it should be called after making changes to dns settings, updating ssl certificates, or when troubleshooting domain-related issues. the re-verification process ensures that the custom hostname is correctly configured and accessible. this tool is particularly useful for maintaining the proper functioning of custom domains in supabase projects, especially after domain configuration changes or when addressing connectivity problems.
</Accordion>

<Accordion title="Retrieve project secret by ref">
  Retrieves all secrets associated with a specific supabase project. this endpoint is used to fetch sensitive information such as api keys, tokens, or other confidential data that are crucial for the project's functionality but need to be kept secure. it should be used when you need to access or manage the secrets for a particular project, for example, during development, debugging, or when rotating credentials. the endpoint returns a list of secret objects, likely including details such as secret names, values (possibly masked), and any associated metadata. be cautious when using this endpoint, as it exposes sensitive information. ensure proper authentication and authorization measures are in place to protect the returned data.
</Accordion>

<Accordion title="List all database branches">
  Returns all database branches of the specified project.
</Accordion>

<Accordion title="Retrieve snippets list">
  Retrieves a collection of code snippets from the supabase backend. this endpoint allows developers to fetch pre-defined code fragments or templates that can be used in their supabase applications. it's particularly useful for accessing commonly used database queries, functions, or other reusable code components. the endpoint returns all available snippets or a filtered set based on default criteria. use this when you need to quickly access and integrate pre-written code into your supabase project, improving development efficiency and maintaining consistency across your application. note that this endpoint does not provide functionality for creating, updating, or deleting snippets.
</Accordion>

<Accordion title="Delete sso provider">
  Deletes a specific single sign-on (sso) provider configuration from a supabase project. this endpoint is used to remove an sso provider's settings when you no longer want to offer that authentication method for your application. it's particularly useful when updating your authentication strategy or removing unused sso options. be cautious when using this endpoint, as it will immediately disable the specified sso provider for all users, potentially affecting their ability to log in if they primarily use that method.
</Accordion>

<Accordion title="List project functions endpoint">
  Retrieves a list of edge functions associated with a specific supabase project. this endpoint allows developers to fetch all deployed functions within a project, enabling them to manage and monitor their serverless functions. use this endpoint when you need to review, audit, or programmatically interact with the functions in your supabase project. it provides an overview of the available functions but does not return the function code or execution details. this tool is particularly useful for devops tasks, ci/cd pipelines, or building custom management interfaces for supabase projects.
</Accordion>

<Accordion title="Create organization">
  Creates a new organization within supabase. this endpoint is used to establish a top-level entity that can manage multiple projects, handle access control, and centralize billing. organizations in supabase provide a way to group related projects and collaborate with team members efficiently. use this endpoint when setting up a new team, company, or project group in supabase. it's an essential first step for teams or companies that plan to work on multiple projects or need to manage access for various team members across different projects.
</Accordion>

<Accordion title="Create new project">
  Creates a new supabase project with specified configurations. this endpoint allows you to set up a new project within your organization, configuring essential parameters such as database credentials, project name, hosting region, and instance size. it's used when initializing a new supabase environment for your application. the endpoint handles the provisioning of necessary resources and sets up the project according to your specifications. note that some parameters like subscription plans are now managed at the organization level and are not part of this project creation process.
</Accordion>

<Accordion title="List organization members by slug">
  Retrieves a list of members for a specified organization within supabase. this endpoint is used to fetch details about users who are part of the organization, which is crucial for managing access control, permissions, and team collaboration. the endpoint returns information such as user ids, roles, and potentially other relevant details about each member. it should be used when you need to audit organization membership, manage team access, or display a roster of organization members. note that this endpoint only provides member information and does not allow for adding, removing, or modifying member details.
</Accordion>

<Accordion title="Reset branch by id">
  The resetbranch endpoint is used to reset a specific branch in supabase to a clean state. this operation reverts the database schema and data of the specified branch to its initial state, effectively undoing all changes made since the branch was created or last reset. it's particularly useful during development and testing phases when you need to start fresh or revert unwanted changes. the endpoint should be used cautiously as it will permanently delete all data and schema changes in the branch. it's recommended to use this endpoint only in non-production environments or when you're absolutely certain about resetting the branch. note that this operation cannot be undone, so it's crucial to have proper backups or snapshots before performing a reset.
</Accordion>

<Accordion title="Delete project by ref">
  Deletes a specific supabase project identified by its unique reference. this endpoint should be used when you want to permanently remove a project from your supabase account, including all its associated resources such as databases, authentication settings, and storage. it's important to note that this action is irreversible and will result in the loss of all data and configurations associated with the project. use this endpoint with caution, typically when a project is no longer needed or when cleaning up development or test environments. it does not provide any option for data backup before deletion, so ensure you have made necessary backups if required before calling this endpoint.
</Accordion>

<Accordion title="Create sso provider configuration">
  Creates a new single sign-on (sso) provider for a supabase project, specifically for saml 2.0 authentication. this endpoint allows you to configure and integrate an external identity provider with your supabase authentication system, enabling users to log in using their organizational credentials. use this when setting up enterprise-level authentication or when you need to support federated identity management. the endpoint requires detailed configuration of the saml provider, including metadata and attribute mapping, to ensure proper integration and user attribute synchronization.
</Accordion>


# Tavily
Source: https://docs.push.ai/integrations/tavily



Tavily provides advanced search capabilities with various options
including image inclusion, raw content, and domain filtering.

<Accordion title="Tavily Search">
  The tavilysearch class provides an interface to the tavily search api, enabling users to conduct searches across a wide array of content with various filtering options. it supports complex queries, including keyword and phrase searches, with additional parameters to refine the search results. this class allows for customization of the search experience by specifying the depth of the search, inclusion of images and direct answers, domain-specific filtering, and control over the number of results returned. it is designed to handle diverse search needs, from quick lookups to comprehensive research.
</Accordion>


# Text to pdf
Source: https://docs.push.ai/integrations/text_to_pdf



Convert text to PDF

<Accordion title="Convert text to pdf">
  Convert text to pdf
</Accordion>


# Textrazor
Source: https://docs.push.ai/integrations/textrazor



TextRazor is a natural language processing API that extracts meaning, entities, and relationships from text, powering advanced content analysis and sentiment detection

<Accordion title="Classify Text">
  This tool will classify text into predefined categories using textrazor's classification capabilities. it takes input text, optional cleanup mode and language, and returns a list of relevant categories with their confidence scores from the analysis. the tool supports various built-in classifiers including: - textrazor iab: iab qag segments - textrazor iab content taxonomy 3.0: iab content taxonomy v3.0 (2022) - textrazor mediatopics 2023q1: latest iptc media topics (march 2023) - and other versions of these taxonomies
</Accordion>

<Accordion title="Extract Entailments from Text">
  This tool extracts entailments from text using textrazor's api. it identifies words or phrases that can be logically inferred from the given text by analyzing logical implications and relationships.
</Accordion>

<Accordion title="Dictionary Manager">
  The textrazor dictionary manager tool allows users to create, update, and manage custom entity dictionaries in textrazor. it provides endpoints for creating/updating dictionaries, listing dictionaries, getting a specific dictionary, and deleting dictionaries, as well as managing the entries within these dictionaries (adding, retrieving, and deleting entries).
</Accordion>

<Accordion title="Analyze Dependency Trees">
  The dependencytreesaction analyzes the grammatical relationships between words in text by creating dependency trees. it provides detailed syntactic analysis by identifying the grammatical relationships between words and their parent words in a sentence. this tool is useful for: - understanding sentence structure - analyzing grammatical relationships - parsing complex sentences - supporting advanced linguistic analysis tasks
</Accordion>

<Accordion title="Get Account Information">
  This tool retrieves comprehensive information about a textrazor account, providing essential details about the account's status, usage, and limits. it returns an account object containing properties such as the current subscription plan, concurrent request limits, and daily usage among others, making it crucial for monitoring api usage, managing requests, and ensuring compliance with subscription limits.
</Accordion>

<Accordion title="Extract Word Senses">
  This tool performs word sense disambiguation on the input text by identifying the most likely meanings of words in context. it uses textrazor's 'senses' extractor to determine the semantic meaning and provides detailed data including word, sense, confidence score, part of speech, position, synset, and definition.
</Accordion>

<Accordion title="Extract Grammatical Relations from Text">
  This tool extracts grammatical relations between words in the text. it identifies the relationships between different parts of sentences, including subjects, objects, and predicates. the relations extractor provides detailed syntactic analysis of the text.
</Accordion>

<Accordion title="Spelling Correction">
  This tool performs spelling correction on the provided text using textrazor's deep spelling correction system. it analyzes the input text for spelling errors and provides context-based corrections.
</Accordion>

<Accordion title="Extract Topics from Text">
  A tool to extract topics from text using textrazor's topic extraction capabilities. topics represent the main themes and concepts discussed in the text, with relevance scores indicating their importance to the document.
</Accordion>

<Accordion title="Extract Named Entities from Text">
  Extract named entities (people, places, companies, etc.) from text using textrazor's entity extraction api. the tool will identify and classify named entities within the provided text, returning detailed information about each entity including its type, confidence score, and relevance score.
</Accordion>

<Accordion title="Extract Phrases from Text">
  The extractphrases action extracts meaningful phrases from input text using textrazor's phrase extraction capability. it analyzes text to identify important phrases and multi-word expressions that aid in tasks like content analysis, keyword extraction, and summarization.
</Accordion>

<Accordion title="Analyze Content with TextRazor">
  A comprehensive content analysis tool that combines multiple textrazor extractors to perform a complete analysis of the input text. this action allows users to analyze text content with multiple extractors in a single api call.
</Accordion>


# Tinyurl
Source: https://docs.push.ai/integrations/tinyurl



TinyURL provides APIs for shortening long URLs into compact, branded
links and tracking link analytics.

<Accordion title="Create short url">
  Creates a shortened url using tinyurl's api. this action takes a long url and returns a shortened version, with optional parameters for customization like domain, alias, tags, and expiration date.
</Accordion>


# Todoist
Source: https://docs.push.ai/integrations/todoist



Todoist is a productivity app that helps manage tasks and projects.

<Accordion title="Delete task">
  Delete a task from todoist. this action permanently removes the task and all its subtasks.
</Accordion>

<Accordion title="Create task">
  Create a new task in todoist. this action allows users to create tasks with various parameters including content, due dates, priority, and more. the task can be created in a specific project, section, or as a subtask of another task.
</Accordion>

<Accordion title="Get all labels">
  Get all personal labels from todoist. this action retrieves all personal labels from a user's todoist account. each label contains information like name, color, order and favorite status. api documentation: [https://developer.todoist.com/rest/v2/#get-all-personal-labels](https://developer.todoist.com/rest/v2/#get-all-personal-labels)
</Accordion>

<Accordion title="Get all projects">
  Get all projects from a user's todoist account. this tool retrieves all projects from the authenticated user's todoist account. the response includes details like project id, name, color, parent project, sharing status, and other metadata for each project.
</Accordion>


# Trello
Source: https://docs.push.ai/integrations/trello



A web-based, kanban-style, list-making application.

<Accordion title="Create new board with specified attributes">
  Creates a new trello board with customizable attributes and settings. this endpoint allows you to set up a board tailored to your project needs, including its name, description, organization affiliation, and various preferences. you can create a board from scratch or copy an existing one, making it versatile for different use cases. use this when setting up a new project, team workspace, or when you need to replicate an existing board structure. the endpoint offers extensive customization options, from basic details to advanced settings like permissions, power-ups, and visual preferences. note that while many parameters are optional, setting them during creation can save time in subsequent board setup and configuration.
</Accordion>

<Accordion title="Add a label to a board">
  Creates a new label on a specific trello board. this endpoint allows users to add a label with a specified color and/or name to organize and categorize cards on the board. the new label can be used to visually distinguish and group cards, enhancing the board's organization. use this when you need to introduce a new category or status for cards on a particular board. the color and name are both optional, allowing for flexible label creation based on user needs. note that while you can create a label with no color and no name, it's generally more useful to specify at least one of these attributes for meaningful organization.
</Accordion>

<Accordion title="Retrieve action s associated list">
  Retrieves information about the list associated with a specific trello action. this endpoint is useful when you need to determine which list was affected by a particular action, such as moving a card or updating a list's properties. it provides context for action events, helping to track changes across a trello board. use this endpoint when you want to get details about the list involved in a specific action, rather than querying all lists on a board. note that this endpoint focuses solely on the list associated with the action and does not provide information about the action itself or other related entities like cards or board details.\<\<DEPRECATED use get\_actions\_list\_by\_id\_action>>
</Accordion>

<Accordion title="Generate email key for board">
  Generates a new email key for a specific trello board. this endpoint is used to create or regenerate a unique email address associated with the board, enabling email-to-board functionality. when invoked, it will invalidate any previously existing email key for the specified board and return a new one. this tool is essential for setting up or updating email integration with a trello board, allowing users to add cards to the board by sending emails to the generated address. it should be used when initially configuring email-to-board features or when needing to reset the email integration for security reasons. note that generating a new key will immediately render the old email address non-functional for adding cards to the board.
</Accordion>

<Accordion title="Generate board calendar key">
  Generates or regenerates a calendar key for a specific trello board. this endpoint is used to create a unique identifier that allows integration between the trello board and external calendar services. the generated key can be used to set up synchronization of board events, due dates, and deadlines with calendar applications. this tool should be used when setting up new calendar integrations or when refreshing existing integrations for security purposes. it's important to note that generating a new key will invalidate any previous calendar key for the same board, potentially disrupting existing integrations until updated with the new key.
</Accordion>

<Accordion title="Add new list to board">
  Creates a new list within a specified trello board. this endpoint allows users to add a new organizational category to their board, enabling better task management and workflow organization. use this when you need to create a new stage in your project workflow or want to categorize tasks in a different way. the new list will appear on the specified board and can be populated with cards representing individual tasks or items. note that this endpoint only creates an empty list; you'll need to use separate endpoints to add cards to the newly created list.
</Accordion>

<Accordion title="Get board by action id">
  Retrieves the board associated with a specific trello action. this endpoint allows you to fetch detailed information about the board on which a particular action occurred. it's useful when you need to understand the context of an action, such as determining which board a card was moved to or where a comment was added. this tool is particularly helpful for tracking the flow of work across different boards or for auditing purposes. note that while it provides board details, it doesn't return information about the action itself or other board elements like lists or cards.\<\<DEPRECATED use get\_actions\_board\_by\_id\_action>>
</Accordion>

<Accordion title="Add board checklist">
  Creates a new checklist on a specified trello board. this endpoint allows you to add a named checklist to an existing board, providing a way to organize and track tasks or items within a board. use this when you need to create a new list of to-do items, track project milestones, or add any structured list of tasks to a trello board. the checklist will be empty upon creation; items can be added to it in subsequent operations. this operation is useful for setting up new project structures or preparing boards for upcoming tasks. note that while you can create multiple checklists on a board, each checklist is treated as a separate entity and will need to be managed individually.
</Accordion>

<Accordion title="Retrieve action by id">
  Retrieves detailed information about a specific action in trello. this endpoint allows you to fetch the complete data associated with a single action, such as creating a card, moving a list, or adding a comment. it's useful when you need to access the full context and details of a particular activity that occurred on a trello board. the endpoint should be used when you want to investigate or audit specific changes, or when building activity logs and timelines. note that this endpoint only provides information about a single action; for retrieving multiple actions or a feed of activities, a different endpoint would be more appropriate.\<\<DEPRECATED use get\_actions\_by\_id\_action>>
</Accordion>

<Accordion title="Add checklist to card via id">
  Adds a new checklist to a specified trello card. this endpoint allows you to create a new checklist from scratch, copy an existing checklist, or add an existing checklist to the card. it's useful for organizing tasks within a card, breaking down larger tasks into smaller, manageable steps. use this when you need to add a list of to-do items or a set of subtasks to a card. the checklist can be populated with items immediately by copying from an existing checklist, or it can be created empty for later population. this endpoint is particularly helpful for standardizing workflows or replicating common task lists across different cards.
</Accordion>

<Accordion title="Mark board as viewed">
  Marks a specific trello board as viewed by the current user. this endpoint is used to update the board's status, indicating that the user has seen the latest changes or updates on the board. it's particularly useful for managing notifications and keeping track of which boards have been recently accessed by the user. the endpoint should be called when a user views a board, typically after loading the board's content or when explicitly marking it as seen. this action may affect the board's position in the user's board list and the notification status for recent activities on the board. note that this endpoint only updates the viewed status and does not modify any other board properties or content.
</Accordion>

<Accordion title="Add card member by id">
  Adds a specified member to a trello card. this endpoint allows you to assign a team member or user to a specific card, which represents a task or project item. use this when you need to delegate responsibilities, track ownership of tasks, or involve specific team members in a card's activities. the operation requires the unique identifiers of both the card and the member to be added. this functionality is essential for managing team assignments and task distribution within trello boards. note that this endpoint only adds one member at a time; for bulk assignments, multiple calls may be necessary.
</Accordion>

<Accordion title="Add board power ups attributes">
  Adds a specified power-up to a trello board, enhancing its functionality. this endpoint allows users to enable built-in trello power-ups such as calendar view, card aging, activity recap, or voting features on a specific board. it should be used when you want to extend a board's capabilities with additional tools for improved project management and team collaboration. the endpoint is board-specific and only adds one power-up at a time. note that this endpoint does not handle custom or third-party power-ups, only the predefined trello power-ups listed in the 'value' parameter.
</Accordion>

<Accordion title="Add comment to card action">
  Adds a new comment to a specific trello card. this endpoint allows users to contribute to the conversation on a card by adding textual comments. it's useful for providing updates, asking questions, or engaging in discussions related to the card's content or progress. the comment can include mentions of other users and references to other trello elements. this endpoint should be used when you need to programmatically add comments to cards, such as for automated notifications or integrations with other systems. note that while this endpoint adds comments, it does not support attaching files directly - attachments would need to be handled separately.
</Accordion>

<Accordion title="Add card checklist check item">
  Adds a new check item to a specific checklist within a trello card. this endpoint allows users to create and append individual tasks or items to an existing checklist, helping to break down larger card tasks into smaller, manageable pieces. it's particularly useful for adding new steps or requirements to a card's workflow after the initial checklist has been created. the endpoint requires the card id and checklist id to ensure the new check item is added to the correct location. users can optionally specify the name of the check item and its position within the checklist for precise placement.
</Accordion>

<Accordion title="Mark associated card notifications as read">
  This endpoint marks all notifications associated with a specific trello card as read. it's useful for managing notification status programmatically, especially in scenarios where bulk actions on card notifications are needed. the endpoint should be used when you want to clear the unread status of all notifications linked to a particular card, such as after a user has viewed or processed the card's updates. this action is irreversible, so use it judiciously. note that this endpoint only affects the read status of notifications and does not delete or modify the notifications themselves.
</Accordion>

<Accordion title="Add label to card by id">
  Adds a specific label to a trello card. this endpoint allows you to associate an existing label with a particular card, enhancing the card's categorization and visual organization on the board. use this when you need to tag a card with a predefined label, such as for priority levels, project phases, or any custom categories your team uses. the endpoint requires the card's id in the url path and the label's id in the request body. it's important to note that this endpoint only adds existing labels; it cannot create new labels or modify label properties. ensure that both the card and the label exist before making this api call.
</Accordion>

<Accordion title="Add labels to card">
  This endpoint allows you to add a new label to a specific trello card. it provides options to set the label's color, name, and value, enabling better organization and visual categorization of cards on a trello board. use this endpoint when you need to add or update labels on a card to reflect its status, priority, or any other classification. the endpoint is particularly useful for automating label management or implementing custom labeling logic in your trello workflows. note that while you can specify both 'color' and 'value' parameters, 'value' takes precedence if both are provided. also, be aware that creating too many unique labels might clutter your board, so use this feature judiciously.
</Accordion>

<Accordion title="Add new card to list">
  Creates a new card in a specified trello list with customizable attributes. this endpoint allows you to add a card to an existing list, optionally copying properties from another card, setting due dates, assigning members, adding labels, and more. use this when you need to programmatically create new tasks or items in your trello workflow. the endpoint is versatile, supporting simple card creation with just a name and list id, as well as complex scenarios involving multiple attributes and attachments. note that while many parameters are optional, at minimum, you must specify the 'idlist' where the card will be added.
</Accordion>

<Accordion title="Add attachment to card">
  This endpoint adds an attachment to a specific trello card. it allows users to upload files directly or attach links to external resources, enhancing the card's information and context. use this when you need to include supporting documents, images, or relevant web links to a card. the attachment can be either a file upload or a url, providing flexibility in the types of resources that can be added. note that while the endpoint accepts various attachment types, there may be size limits or file type restrictions imposed by trello's system.
</Accordion>

<Accordion title="Add cards members voted">
  Adds a member's vote to a specific trello card. this endpoint allows you to record a 'yes' vote from a particular member on a given card. it's useful for tracking member opinions or decisions related to the card's content or status. the endpoint should be used when you need to programmatically add a member's approval or agreement to a card, which can be helpful in workflows that require voting or consensus. note that this endpoint only adds positive votes; there is no option to add a negative vote or remove a vote using this call. also, be aware that a member can only have one vote per card, so calling this endpoint multiple times for the same member on the same card will not result in multiple votes.
</Accordion>

<Accordion title="Add sticker to card">
  Adds a sticker to a specific trello card. this endpoint allows you to customize the appearance and position of a sticker on a card, enhancing visual organization and communication within your trello boards. use this when you want to highlight important information, categorize cards, or add visual cues to your trello workflow. the sticker's image, position, rotation, and stack order can be specified for precise placement. note that this endpoint only adds a single sticker per request; multiple calls are required to add multiple stickers to the same card.
</Accordion>

<Accordion title="Add checklist to card">
  Creates a new checklist in trello, either on a board or within a specific card. this endpoint allows you to add a customizable checklist to organize tasks and track progress. you can create an empty checklist or copy an existing one, specify its name, and set its position. use this when you need to add a new set of to-do items or a list of tasks to be completed. this is particularly useful for breaking down larger tasks into manageable steps or creating standardized processes across different cards or boards. note that while you can create the checklist structure with this endpoint, adding individual checklist items requires separate api calls.
</Accordion>

<Accordion title="Add checklist check items">
  This endpoint adds a new check item to an existing trello checklist. it allows users to create and position new tasks or items within a checklist, enhancing the organization and tracking of work items on a trello board. the endpoint should be used when adding new subtasks or items to a checklist, such as when breaking down a larger task into smaller, actionable steps. it provides flexibility in naming the item, setting its initial completion status, and positioning it within the checklist. however, it does not allow for adding multiple items at once or updating existing items - separate api calls would be needed for those operations. the checklist id must be known and provided in the url path when making this api call.
</Accordion>

<Accordion title="Retrieve action by id">
  Retrieves detailed information about a specific action in trello. this endpoint allows you to fetch the complete data associated with a single action, such as creating a card, moving a list, or adding a comment. it's useful when you need to access the full context and details of a particular activity that occurred on a trello board. the endpoint should be used when you want to investigate or audit specific changes, or when building activity logs and timelines. note that this endpoint only provides information about a single action; for retrieving multiple actions or a feed of activities, a different endpoint would be more appropriate.
</Accordion>

<Accordion title="Move all cards in list to board">
  Moves all cards from a specified trello list to a different board. this endpoint is useful for bulk transferring cards when reorganizing projects or merging boards. it allows users to quickly relocate an entire list's content to a new board without manually moving each card. the operation is irreversible, so it should be used with caution. note that this action only moves the cards; it does not copy them or affect the original list structure.
</Accordion>

<Accordion title="Update card list id">
  Updates the list assignment of a specific trello card. this endpoint allows you to move a card from one list to another within the same board. it's particularly useful for updating the status or progress of a task represented by the card. the operation is idempotent, meaning that moving a card to its current list will not cause any changes. this endpoint should be used when you need to programmatically update the position of a card in your trello workflow. it's important to note that this operation only changes the list assignment and does not modify any other attributes of the card.\<\<DEPRECATED use update\_cards\_id\_list\_by\_id\_card>>
</Accordion>

<Accordion title="Add cards to list with attributes">
  This endpoint allows you to add a new card to a specific list in trello. it's used to create a task or item within an existing list on a trello board. the endpoint provides options to set various attributes of the card, including its description, due date, assigned members, labels, and name. this is particularly useful for programmatically creating new tasks or items in your trello workflow. note that while all parameters for card creation are optional, it's recommended to at least provide a name for the card to easily identify it on the board. the list id (idlist) must be specified in the path to determine where the new card will be placed.
</Accordion>

<Accordion title="Add tokens webhook attributes">
  Creates a new webhook for a specific trello token, enabling real-time notifications for events on a specified trello model (such as a board, list, or card). this endpoint allows applications to set up automated triggers for changes in trello, facilitating seamless integration and synchronization with external systems. use this when you need to monitor and react to updates in trello in real-time. the webhook will send post requests to the specified callback url whenever relevant events occur on the monitored model. note that you must have appropriate permissions for the token and the model being monitored.
</Accordion>

<Accordion title="Get action field by id">
  Retrieves a specific field of a trello action identified by its unique id. this endpoint allows for targeted data retrieval, enabling users to fetch individual attributes of an action without retrieving the entire action object. it's particularly useful when you need a single piece of information about an action, such as its type, date, or associated member. the endpoint should be used when precise, field-level data about a trello action is required, reducing data transfer and processing overhead. however, it does not provide comprehensive action details in a single call, so multiple requests may be necessary if several fields are needed.
</Accordion>

<Accordion title="Delete organization by id">
  Permanently deletes a trello organization and all its associated data. this endpoint should be used when an organization is no longer needed and all its boards, lists, cards, and member associations should be removed. once an organization is deleted, the action cannot be undone, and all data will be lost. this operation requires appropriate permissions, typically limited to organization administrators. use this endpoint with caution as it will remove all resources linked to the organization, including shared boards and team data.
</Accordion>

<Accordion title="Add board star to member">
  Adds a board star for a specific trello member, allowing them to mark a board as a favorite or frequently accessed. this endpoint is used to create a new board star, specifying which board to star and where to position it in the member's list of starred boards. it's particularly useful for organizing and prioritizing boards for quick access. the endpoint should be used when a user wants to star a new board or adjust the position of an existing starred board. it does not provide functionality for removing board stars or retrieving a list of starred boards.
</Accordion>

<Accordion title="Delete card checklist">
  Deletes a specific checklist from a trello card. this endpoint allows users to remove a checklist entirely from a card, which can be useful for cleaning up completed or unnecessary checklists. the operation is irreversible, so it should be used with caution. this endpoint is particularly helpful when managing card content and simplifying the card's structure by removing outdated or completed checklists. it requires both the card's id and the checklist's id to ensure precise targeting of the checklist to be deleted.
</Accordion>

<Accordion title="Delete org invite restriction">
  This endpoint removes the invite restriction preferences for a specific trello organization. when invoked, it resets the organization's settings related to who can invite new members, effectively removing any custom restrictions that were previously in place. this action allows for more open member invitation policies within the organization. use this endpoint when you want to lift invite restrictions and allow all members to invite new people to the organization. it's particularly useful for organizations that previously had strict invite policies but now want to encourage growth and collaboration. note that this action may have security implications, as it potentially broadens who can add new members to the organization.
</Accordion>

<Accordion title="Delete card via id">
  The delete card endpoint permanently removes a specific card from a trello board. this operation is irreversible and should be used with caution when a task or item represented by the card is no longer needed or was created in error. it's important to note that while the schema doesn't specify, trello typically requires a card to be archived before it can be deleted. this endpoint is useful for cleaning up boards and removing obsolete information, but users should ensure they have the necessary permissions and have backed up any important data from the card before deletion. the operation returns a simple success or failure response without additional details about the deleted card.
</Accordion>

<Accordion title="Add member board background">
  Adds a new board background to a specific trello member's collection. this endpoint allows users to upload and configure custom background images for their trello boards, enhancing the visual customization of their workspace. the new background can be set with specific brightness levels and tiling options, providing flexibility in how the image is displayed on the board. this tool should be used when a user wants to expand their selection of available board backgrounds or when implementing features that allow for dynamic board customization. note that this endpoint only adds the background to the member's collection; to apply it to a specific board, an additional api call would be required.
</Accordion>

<Accordion title="Delete checklist check item">
  Deletes a specific check item from a checklist on a trello board. this endpoint is used to permanently remove an individual task or item from a checklist, helping to manage and organize the content of trello cards. it should be used when a task is no longer relevant, completed and needs to be cleared, or was added by mistake. the operation is irreversible, so caution should be exercised when using this endpoint. it's important to note that this endpoint only deletes the check item and not the entire checklist. if you need to delete the entire checklist, a separate api call would be required.
</Accordion>

<Accordion title="Add new label to board">
  Creates a new label on a specified trello board. this endpoint allows users to add a custom label with a specific color and name to organize and categorize cards more effectively. it should be used when setting up a new board, introducing a new category, or refining the existing labeling system. the created label can then be applied to cards across the board. note that this endpoint only creates the label; it does not automatically apply it to any cards. there's a limit to how many labels can be created on a single board, typically around 1000, but it's best to use labels judiciously for clarity.
</Accordion>

<Accordion title="Add new list to board">
  Creates a new list within a specified trello board. this endpoint allows users to add a custom list to their board, optionally copying from an existing list, setting its position, and defining its initial state. it's particularly useful for organizing tasks, creating new workflow stages, or expanding board structure. the new list can be created open or closed, and the creating user can choose to subscribe to it for notifications. this tool should be used when setting up new projects, restructuring workflows, or expanding existing boards. it doesn't modify existing lists or move cards between lists.
</Accordion>

<Accordion title="Create new board with specified attributes">
  Creates a new trello board with customizable attributes and settings. this endpoint allows you to set up a board tailored to your project needs, including its name, description, organization affiliation, and various preferences. you can create a board from scratch or copy an existing one, making it versatile for different use cases. use this when setting up a new project, team workspace, or when you need to replicate an existing board structure. the endpoint offers extensive customization options, from basic details to advanced settings like permissions, power-ups, and visual preferences. note that while many parameters are optional, setting them during creation can save time in subsequent board setup and configuration.\<\<DEPRECATED use add\_boards>>
</Accordion>

<Accordion title="Archive all cards in list">
  This endpoint archives all cards within a specified trello list. it provides a convenient way to bulk archive multiple cards simultaneously, helping users clean up and organize their trello boards efficiently. the operation is irreversible through this endpoint, so it should be used with caution. this tool is particularly useful when closing out completed projects, clearing inactive lists, or performing board-wide cleanups. note that while cards are archived, they are not deleted and can still be accessed or restored through trello's archive feature.
</Accordion>

<Accordion title="Retrieve organization action by field">
  This endpoint retrieves a specific field of the organization associated with a particular trello action. it allows you to fetch detailed information about the organization context in which an action occurred. use this endpoint when you need to access specific organization details related to a trello action, such as the organization's name or id. this can be particularly useful for tracking and analyzing actions across different organizations or teams within your trello workspace. note that this endpoint focuses on a single field of the organization and does not provide comprehensive information about the action or the entire organization object.
</Accordion>

<Accordion title="Fetch organization action by id">
  Retrieves the organization information associated with a specific trello action. this endpoint allows you to trace back an action to its parent organization, providing valuable context for auditing, reporting, or analysis purposes. use this when you need to identify which organization an action belongs to or when you want to gather more details about the organization context of a particular trello activity. the endpoint returns organization data such as name, id, and other relevant details. it's particularly useful for applications that need to track actions across different organizational boundaries or for maintaining a clear audit trail of activities within trello.
</Accordion>

<Accordion title="Upload members avatar">
  This endpoint allows you to update the avatar image for a specific trello member. it's used when you want to change or set a new profile picture for a user in trello. the endpoint accepts a base64-encoded image file and associates it with the specified member's profile. this is useful for personalizing user profiles or updating outdated avatars. note that this endpoint only changes the avatar and does not modify any other member information. ensure you have the necessary permissions to modify the specified member's profile before using this endpoint.
</Accordion>

<Accordion title="Display action by id">
  Retrieves the display information for a specific trello action. this endpoint is used to fetch formatted or user-friendly representations of action data, which can be helpful for presenting action details in a more readable or visually appealing manner. it's particularly useful when you need to show action information in a user interface or generate reports. the endpoint focuses solely on display-related data and does not provide full action details or modify the action in any way. use this when you need to present action information to users or need a simplified view of action data for display purposes.
</Accordion>

<Accordion title="Retrieve action card field">
  Retrieves a specific field of a card associated with a particular action in trello. this endpoint is useful when you need to access detailed information about how a card was affected by a specific action, without fetching the entire card object. it allows for granular data retrieval, which can be particularly beneficial for tracking changes, auditing, or gathering specific data points about card modifications. the endpoint should be used when you have an action id and need to know how that action affected a particular aspect of a card. it's important to note that this endpoint only provides information about the specified field and does not return the entire card object or details about the action itself.
</Accordion>

<Accordion title="Retrieve action s associated list">
  Retrieves information about the list associated with a specific trello action. this endpoint is useful when you need to determine which list was affected by a particular action, such as moving a card or updating a list's properties. it provides context for action events, helping to track changes across a trello board. use this endpoint when you want to get details about the list involved in a specific action, rather than querying all lists on a board. note that this endpoint focuses solely on the list associated with the action and does not provide information about the action itself or other related entities like cards or board details.
</Accordion>

<Accordion title="Retrieve action s member by id">
  Retrieves the member information associated with a specific action in trello. this endpoint is used to identify and fetch details about the user who performed a particular action on a trello board, such as moving a card or updating a list. it's particularly useful for tracking user activities and understanding who made certain changes within a board. the endpoint returns member data related to the action, which may include the user's id, username, and other relevant information. this tool should be used when you need to connect an action with its performer or when auditing board activities. note that it only provides information about the member in the context of the specified action and does not give a comprehensive view of the member's overall trello account or activities.
</Accordion>

<Accordion title="Update card position">
  Updates the position of a specific trello card within its current list. this endpoint allows you to move a card to the top, bottom, or a specific position in its list, helping to reorganize tasks and priorities. use this when you need to change the order of cards in a list without changing the list itself. the new position is specified using either keywords ('top', 'bottom') or a numeric value, providing flexibility in card arrangement. this operation is particularly useful for reordering tasks, adjusting priorities, or maintaining a specific workflow sequence within a trello board.\<\<DEPRECATED use update\_cards\_pos\_by\_id\_card>>
</Accordion>

<Accordion title="Convert checklist item to card">
  Converts a specific checklist item within a trello card into a new, separate card. this endpoint is useful for expanding a subtask or checklist item into a full-fledged card, allowing for more detailed tracking and management. it should be used when a checklist item requires more elaborate handling or when you want to create a hierarchical relationship between tasks. the newly created card will inherit information from the original checklist item, but the exact details of inheritance are not specified in the schema. this operation is irreversible through the api, so it should be used judiciously. note that this endpoint does not provide options for customizing the new card beyond the conversion process.
</Accordion>

<Accordion title="Add members custom emoji attributes">
  This endpoint allows you to add a custom emoji to a specific trello member's account. it enables personalization of the trello experience by letting members create and use their own unique emojis. the custom emoji can be used in various trello elements such as card descriptions, comments, or checklists. this endpoint should be used when a member wants to expand their emoji options beyond the standard set provided by trello. it's important to note that these custom emojis are specific to the member and are not shared across the entire trello workspace. be aware that there may be limitations on the number of custom emojis a member can add, although this is not specified in the schema.
</Accordion>

<Accordion title="Delete token by token id">
  Revokes and deletes a specific trello api token. this endpoint should be used when you want to invalidate an existing token, preventing it from being used for future api requests. it's particularly useful for enhancing security by removing access for unused or compromised tokens. the operation is irreversible, so use it with caution. after deletion, any applications or integrations using this token will lose access to the trello api and will need to re-authenticate to obtain a new token.
</Accordion>

<Accordion title="Retrieve card by action id">
  Retrieves detailed information about the card associated with a specific trello action. this endpoint is useful when you need to access the current state or details of a card that was affected by a particular action, such as a card being moved, edited, or commented on. it provides a way to trace the impact of an action on a card and gather its up-to-date information. use this endpoint when you want to follow up on an action notification or need to sync card data after a known action has occurred. note that this endpoint only returns information about the card itself and not about the action that led to querying this card.
</Accordion>

<Accordion title="Add members custom board backgrounds attributes">
  This endpoint allows you to add a custom board background for a specific trello member. it enables personalization of a member's trello boards by uploading and configuring a unique background image. use this endpoint when you want to enhance the visual appeal of a member's boards or create a distinct look for different projects or teams. the custom background can be adjusted for brightness and tiling to ensure optimal visibility of board content. note that this endpoint is member-specific and should be used judiciously to maintain a balance between personalization and consistent team experience.
</Accordion>

<Accordion title="Fetch list field by id action">
  Retrieves a specific field of the list associated with a given trello action. this endpoint is useful when you need to access particular information about the list where an action occurred, without fetching all list details. it can be used to confirm the list's name, check if it's closed, or get its board id after an action has been performed. this endpoint is particularly helpful for tracking changes or verifying the current state of a list following a specific action. note that it only returns a single field value, not the entire list object, making it efficient for targeted data retrieval.
</Accordion>

<Accordion title="Retrieve action member creator field">
  Retrieves a specific field of the member who created a particular action in trello. this endpoint allows you to access detailed information about the user who initiated an action, such as their username, full name, or avatar url. it's useful for tracking who performed certain actions on a trello board, which can be valuable for auditing, user activity analysis, or displaying user information in your application. the endpoint is read-only and does not modify any data in trello. note that you can only retrieve fields that are publicly available or that you have permission to access based on your authentication level.
</Accordion>

<Accordion title="Delete organization logo by id">
  This endpoint allows you to delete the logo associated with a specific trello organization. it removes the custom logo image that was previously uploaded and set for the organization, reverting it to the default trello logo or placeholder. this operation is permanent and cannot be undone, so it should be used with caution. it's particularly useful when rebranding an organization or removing outdated visual identities. note that this endpoint only deletes the logo and does not affect any other organization settings or data.
</Accordion>

<Accordion title="Retrieve action entity by id">
  Retrieves the entities associated with a specific trello action. this endpoint allows you to fetch detailed information about the entities (such as boards, lists, cards, or members) that are related to a particular action in trello. it's useful for obtaining context and additional data about actions that have occurred within a trello workspace. for example, if an action represents a card being moved, this endpoint could provide details about the card, the source list, the destination list, and the board involved. use this endpoint when you need to gather comprehensive information about the objects affected by or involved in a specific trello action.
</Accordion>

<Accordion title="Get batch endpoint">
  The batchrequest endpoint allows you to execute multiple trello api requests in a single http call. this powerful feature enables efficient bulk operations and reduces network overhead. use this endpoint when you need to perform multiple, potentially independent operations on trello resources (such as boards, lists, or cards) simultaneously. the batch request is particularly useful for complex workflows or when synchronizing data between trello and external systems. keep in mind that there may be rate limits or restrictions on the number of requests allowed in a single batch call. this endpoint does not support mixing different http methods within a single batch request.
</Accordion>

<Accordion title="Delete card label by id">
  This endpoint removes a specific label from a trello card. it's used to update the organization or categorization of a card by removing an associated label. the operation is performed by sending a delete request to the specified url with the card id and label id as path parameters. this action is irreversible and should be used when you want to disassociate a label from a card, such as when a task changes category or a tag is no longer relevant. it's important to note that this endpoint only removes the association between the card and the label; it does not delete the label itself from the trello board.
</Accordion>

<Accordion title="Retrieve board field for action">
  Retrieves a specific field of the trello board associated with a given action. this endpoint allows you to fetch targeted information about a board without retrieving the entire board object. it's particularly useful when you need to access a single piece of board data related to a specific action, such as the board's name or url. the endpoint should be used when you have an action id and want to know a particular attribute of the board where that action occurred. it will not provide information about the action itself or other board details beyond the requested field. keep in mind that the availability of certain fields may depend on the permissions of the authenticated user and the current state of the trello api.
</Accordion>

<Accordion title="Retrieve board stars by board id">
  Retrieves a list of board stars associated with a specific trello board. board stars represent boards that a user has marked as favorite or important, making them easier to access from their trello dashboard. this endpoint is useful for applications that need to display a user's starred boards or analyze which boards are frequently accessed by team members. it should be used when you need to fetch the star status of a particular board or list all starred boards for a user. note that this endpoint only provides information about the star status and does not allow for adding or removing stars from boards.
</Accordion>

<Accordion title="Retrieve member action field">
  This endpoint retrieves a specific field of the member associated with a particular action in trello. it allows you to fetch targeted information about the member who performed or is related to a specific action, without retrieving all member data. this can be useful for obtaining specific details like the member's username or avatar url in the context of an action. the endpoint is particularly helpful when you need to display or process only a single piece of member information related to an action, reducing data transfer and processing overhead. however, it's important to note that this endpoint is limited to retrieving only one field at a time; for multiple fields, separate api calls would be necessary.
</Accordion>

<Accordion title="Delete member from organization">
  Removes a member from a trello organization completely. this endpoint should be used when you want to revoke all of a member's access and permissions within an organization. it will remove the member from all boards, teams, and other resources associated with the organization. this action is permanent and cannot be undone through the api, so it should be used with caution. the endpoint is particularly useful for managing team changes, such as when an employee leaves a company or a project concludes. note that this does not delete the member's trello account, only their association with the specific organization.
</Accordion>

<Accordion title="Delete action by id">
  Deletes a specific trello action identified by its unique id. this endpoint should be used when you need to permanently remove an action from a trello board's history. it's particularly useful for cleaning up unwanted or erroneous actions, such as accidental card creations or comments. once an action is deleted, it cannot be recovered, so use this endpoint with caution. note that not all actions may be deletable, and attempting to delete certain system-generated actions might result in an error.
</Accordion>

<Accordion title="Get board labels by id">
  Retrieves all labels associated with a specific trello board. this endpoint allows users to fetch the complete set of labels used for categorizing cards within the specified board. it's particularly useful for getting an overview of the board's organization system or when preparing to add or update labels on cards. the endpoint returns label information such as names, colors, and ids, which can be used in other api calls for label management or card updates. note that this endpoint only provides label data and does not include information about which cards are using each label.
</Accordion>

<Accordion title="List cards by board id">
  Retrieves all cards associated with a specific trello board. this endpoint allows users to fetch a comprehensive list of cards, including their details such as names, descriptions, due dates, and other attributes, from a given board. it's particularly useful for getting an overview of all tasks or items within a project or workflow. the endpoint should be used when you need to gather information about multiple cards at once, rather than querying individual cards separately. note that this endpoint may have limitations on the number of cards returned in a single request for boards with a large number of cards, and pagination might be necessary for complete retrieval.
</Accordion>

<Accordion title="Remove member from card">
  Removes a specific member from a trello card. this endpoint is used when you need to unassign a user from a particular card, perhaps because they have completed their part of the task or are no longer involved in the work related to that card. the operation is irreversible through this endpoint alone, meaning that if you need to re-add the member to the card, you would need to use a separate api call. this endpoint is particularly useful for automating workflow management, such as when a task is completed or reassigned. note that removing a member from a card does not affect their overall board membership or permissions; it only changes their association with the specific card.
</Accordion>

<Accordion title="Delete org member by ids">
  This endpoint removes a specific member from a trello organization. it allows organization administrators to revoke a user's access to all boards, lists, and cards associated with the organization. use this endpoint when you need to remove a team member who no longer requires access to the organization's resources. the removal is permanent, and the member will lose all permissions and visibility to the organization's content. if the member needs to be re-added in the future, they will need to be invited again. note that this action does not delete the user's trello account; it only removes their association with the specific organization.
</Accordion>

<Accordion title="Retrieve board field info">
  Retrieves a specific field's value from a trello board. this endpoint allows you to fetch individual pieces of information about a board without retrieving the entire board object. it's particularly useful when you need quick access to a single attribute, such as the board's name, description, or url. this method should be used when you require only one specific piece of information about a board, rather than its complete details. note that the availability and naming of fields may depend on the current trello api specification, and some fields might have restricted access based on user permissions.
</Accordion>

<Accordion title="Get cards by filter from board">
  Retrieves a list of cards from a specified trello board, with optional filtering capabilities. this endpoint is essential for accessing and managing task information within a trello project. it allows users to fetch cards based on various criteria, enabling efficient organization and analysis of project tasks. the endpoint is particularly useful for integrations that need to sync trello data with other project management tools or for creating custom reports and dashboards. note that while this endpoint provides comprehensive card data, it does not modify any information on the board.
</Accordion>

<Accordion title="Fetch action member creator">
  Retrieves detailed information about the member who created a specific action in trello. this endpoint is useful for tracking who performed particular actions on trello boards, cards, or lists. it provides insights into user activity and can be valuable for audit trails or understanding the history of changes in a trello workspace. the endpoint returns information about the action creator, which may include their username, full name, avatar, and other relevant details. use this when you need to identify or get more information about the user responsible for a specific action in trello.
</Accordion>

<Accordion title="Retrieve actions for board id">
  Retrieves a list of actions (events or changes) associated with a specific trello board. this endpoint is useful for tracking the history of activities on a board, such as card creations, movements, comment additions, or member assignments. it provides a comprehensive audit trail of changes made to the board and its contents. use this endpoint when you need to monitor board activity, implement change tracking, or create activity logs for project management purposes. the actions returned may be limited in number and sorted by recency, so it may not provide a complete historical record if the board has a long history of activities.
</Accordion>

<Accordion title="Retrieve board deltas">
  Retrieves the deltas (changes or updates) for a specified trello board. this endpoint allows you to fetch recent modifications made to the board, including changes to lists, cards, and other board elements. it's particularly useful for synchronizing board data with external systems or monitoring board activity. the endpoint returns a list of changes since the last known state, enabling efficient tracking of board updates without fetching the entire board content. use this when you need to keep an external system up-to-date with trello board changes or when implementing real-time board activity monitoring.
</Accordion>

<Accordion title="Retrieve board by id">
  Retrieves detailed information about a specific trello board. this endpoint allows you to fetch comprehensive data about a board, including its name, description, members, lists, and other associated metadata. use this endpoint when you need to access or display the current state and configuration of a particular board. it's particularly useful for applications that need to sync board data, display board information, or perform operations based on the board's current state. note that this endpoint only provides a read-only view of the board; it cannot be used to modify the board's properties. the response will likely include all visible elements of the board, but may not include certain private or restricted information depending on the authentication level and permissions of the api key used.
</Accordion>

<Accordion title="Retrieve board label by id">
  Retrieves detailed information about a specific label on a trello board. this endpoint allows you to fetch the properties of a single label, such as its name, color, and any custom fields associated with it. use this when you need to access or verify the details of a particular label within the context of a specific board. it's particularly useful for applications that manage or display trello labels, or for automations that need to check label properties. the endpoint will not modify the label or provide information about which cards the label is attached to. note that you must have appropriate permissions to view the specified board and its labels.
</Accordion>

<Accordion title="Delete organization domain preference">
  Removes an associated domain from a trello organization's preferences. this endpoint is used to update the email domain restrictions for workspace membership by deleting a previously approved domain. it's particularly useful for enterprise admins who need to modify organization-wide settings to control access and membership. the operation is irreversible, so it should be used carefully when you want to stop allowing automatic membership for users with email addresses from a specific domain. this endpoint doesn't return the updated preferences; it only performs the deletion.
</Accordion>

<Accordion title="Retrieve board card details">
  Retrieves detailed information about a specific card on a particular trello board. this endpoint is used to fetch up-to-date data for a single card, including its title, description, due date, assigned members, labels, and other associated metadata. it's particularly useful when you need to access or display comprehensive information about a specific task or item within a trello workflow. this endpoint should be used when you have both the board id and card id and need the most current state of the card. it does not modify the card or board in any way, making it safe for frequent calls to keep local data in sync with trello's servers. however, it's important to note that this endpoint only returns data for a single card; for bulk operations or retrieving multiple cards, other endpoints would be more appropriate.
</Accordion>

<Accordion title="Delete card label by color">
  Removes a specific colored label from a trello card. this endpoint allows you to delete an existing label from a card, reducing its categorization or changing its status. it's useful for updating the organization of tasks when a particular classification no longer applies. the operation is permanent and cannot be undone through this endpoint. use this when you need to declutter a card's labels or when a task's category or status has changed. note that this endpoint only removes the association between the label and the card; it does not delete the label itself from the trello board.
</Accordion>

<Accordion title="Delete member from board">
  Removes a specified member from a trello board. this endpoint is used when you need to revoke a user's access to a particular board, effectively ending their ability to view, edit, or interact with the board's content. it's particularly useful for managing team changes, project completions, or access control. the operation is permanent and cannot be undone through the api, so it should be used with caution. note that removing a member does not delete their contributions to the board, but it does remove their access to any automations they may have created.
</Accordion>

<Accordion title="List board memberships">
  Retrieves a list of memberships for a specific trello board. this endpoint allows you to fetch detailed information about the users associated with the board, including their roles (e.g., member, admin, observer) and permissions. use this endpoint when you need to audit board access, manage team members, or gather information about the board's collaboration structure. it's particularly useful for large teams or when transitioning project ownership. note that this endpoint only provides membership data and does not include other board details or the actual content of the board.
</Accordion>

<Accordion title="Fetch board organization field">
  Retrieves a specific field from the organization associated with a trello board. this endpoint allows you to fetch targeted information about the organization that owns or is linked to a particular board, without retrieving all organization details. it's useful when you need a specific piece of organization data in the context of a board, such as the organization's name or description. this tool should be used when you need to quickly access a single organization attribute related to a board, rather than fetching and parsing full organization details. note that the available fields are limited to those defined in the trello api for organizations, and you must know the board's id to use this endpoint.
</Accordion>

<Accordion title="Retrieve invited board members">
  Retrieves information about members who have been invited to a specific trello board but have not yet joined. this endpoint is useful for tracking pending invitations and managing board access. it allows you to view details of invited members, such as their names, email addresses, and the status of their invitations. use this when you need to review or follow up on outstanding board invitations. note that this endpoint only provides information about invited members, not active board members or other board details.
</Accordion>

<Accordion title="Retrieve board members filtered">
  Retrieves a filtered list of members for a specific trello board. this endpoint allows you to fetch a subset of board members based on certain criteria, such as their role or status within the board. it's particularly useful for managing large boards, performing targeted actions on specific groups of members, or auditing board membership. the endpoint requires the board's unique identifier and a filter parameter to specify which members to return. it should be used when you need to analyze or manipulate board membership data programmatically. note that this endpoint only provides member information and does not allow for modifying member status or permissions directly.
</Accordion>

<Accordion title="Retrieve invited board member field">
  Retrieves a specific field of information about members invited to a particular trello board. this endpoint is useful when you need to access targeted details about invited members without fetching their full profiles. it can be used to gather information such as email addresses, usernames, or full names of invited members, depending on the specified field. the endpoint is particularly helpful for board administrators or integration tools that need to manage or review board invitations. note that this endpoint only provides information about invited members who have not yet joined the board, not current board members.
</Accordion>

<Accordion title="Get board checklists">
  Retrieves all checklists associated with a specified trello board. this endpoint allows you to fetch a comprehensive list of checklists that have been created within the given board, providing an overview of task breakdowns and subtasks. use this endpoint when you need to gather all checklist data for a particular board, such as for reporting, analysis, or syncing with external systems. it's particularly useful for project managers or team leads who want to review the structure and progress of tasks within a board. note that this endpoint only returns checklist metadata and does not include the status of individual checklist items; to get that level of detail, you would need to make additional api calls for each checklist or card.
</Accordion>

<Accordion title="Get board members by id">
  Retrieves a list of members associated with a specific trello board. this endpoint allows you to fetch all users who have access to the board, including their roles and permissions. use this when you need to get information about the team members working on a particular board, manage access, or sync member data with other systems. the endpoint returns member details such as usernames, full names, and member types, but does not provide in-depth information about their activities on the board.
</Accordion>

<Accordion title="Get board membership">
  Retrieves detailed information about a specific user's membership on a trello board. this endpoint allows you to fetch the membership details, including the member's role, permissions, and any custom fields associated with their membership on the specified board. it's particularly useful when you need to verify a user's access level or retrieve specific attributes of their membership. the endpoint should be used when you require in-depth information about a single membership, rather than a list of all memberships on a board. note that this endpoint only provides read access to membership data and cannot be used to modify the membership.
</Accordion>

<Accordion title="Get board organization by id">
  Retrieves detailed information about the organization (workspace) associated with a specific trello board. this endpoint allows you to fetch organizational data such as the workspace name, description, visibility settings, and other relevant details directly linked to the specified board. use this endpoint when you need to understand the broader context of a board within its organizational structure, such as determining workspace-level permissions or identifying other boards that might be part of the same workspace. this tool is particularly useful for applications that manage multiple trello boards across different organizations or for those that need to sync organizational data with external systems. note that this endpoint only provides information about the organization and does not return data about the board itself or its contents.
</Accordion>

<Accordion title="Retrieve lists by board id with filter">
  Retrieves lists associated with a specific trello board. this endpoint allows users to fetch all lists or filter them based on their status (open, closed, or all). it's particularly useful for getting an overview of a board's structure, preparing for task management, or syncing board data with external systems. the endpoint supports filtering to efficiently retrieve only the required lists, which is especially beneficial for boards with numerous lists. however, it does not provide detailed information about the cards within each list; separate api calls would be needed for that level of detail.
</Accordion>

<Accordion title="Fetch board lists">
  Retrieves all lists associated with a specific trello board. this endpoint allows you to fetch the complete set of lists that exist on a given board, providing an overview of the board's structure and organization. use this when you need to display or analyze the current layout of a board, such as when building a board overview or preparing for task management operations. the endpoint returns basic information about each list, typically including its id, name, and position on the board. note that this endpoint does not return the cards within the lists; to get that level of detail, you would need to make separate api calls for each list.
</Accordion>

<Accordion title="Retrieve board preferences">
  Retrieves the current user's preferences for a specific trello board. this endpoint allows users to fetch their personalized settings and configurations for a particular board, such as notification preferences, background preferences, or custom field settings. it's useful when you need to display or sync a user's board-specific preferences in your application. the endpoint returns only the preferences for the authenticated user and the specified board, not for other members or boards. use this when you want to tailor the user experience based on their individual board settings or when implementing features that require knowledge of user-specific board configurations.
</Accordion>

<Accordion title="Delete token webhook by id">
  Deletes a specific webhook associated with a trello token. this endpoint is used to remove a webhook from trello's system, effectively stopping any further notifications for the events that the webhook was monitoring. it's particularly useful when you no longer need to receive updates about certain changes in trello, such as modifications to a board, list, or card. the deletion is permanent, so use this endpoint with caution. if you need to reinstate notifications later, you'll have to create a new webhook.
</Accordion>

<Accordion title="Get actions for card by id">
  Retrieves a list of actions associated with a specific trello card. this endpoint allows users to fetch the history of changes and events that have occurred on a particular card, providing valuable insights into the card's lifecycle and team interactions. it can be used to track updates, comments, moves between lists, and other significant events related to the card. this tool is particularly useful for auditing purposes, understanding the progression of a task, or gathering data for project analytics. keep in mind that the number of actions returned may be limited, and very old actions might not be available through this endpoint.
</Accordion>

<Accordion title="Retrieve card attachment details">
  Retrieves all attachments associated with a specific trello card. this endpoint allows users to fetch a comprehensive list of files, documents, or other media that have been added to a particular card. it's useful for obtaining detailed information about the attachments, such as file names, urls, and metadata, without needing to access the card itself. this tool should be used when you need to review or analyze the attachments of a card programmatically, such as for reporting, backup purposes, or to display attachment information in an external system. note that this endpoint only provides attachment data and does not allow for adding, modifying, or deleting attachments.
</Accordion>

<Accordion title="Markallnotifications as read">
  This endpoint marks all notifications as read for the authenticated trello user. it is used to quickly clear the user's notification list, improving organization and reducing clutter in the trello interface. the operation is performed by sending a post request to /notifications/all/read. this tool should be used when a user wants to mark all their unread notifications as read in one action, typically after reviewing their notifications or when starting with a clean slate. it's important to note that this action cannot be undone, and all notifications will be marked as read regardless of their content or importance. the endpoint doesn't provide any filtering options, so it will affect all notifications across all boards the user has access to.
</Accordion>

<Accordion title="Delete power up from board">
  Removes a specified power-up from a trello board. this endpoint should be used when you want to disable or uninstall a particular power-up from a board, perhaps due to changes in workflow requirements or to streamline board functionality. it's important to note that removing a power-up may affect any data or configurations associated with that power-up on the board. before using this endpoint, ensure that you no longer need the power-up's functionality and that removing it won't disrupt ongoing work or integrations. this action cannot be undone through the api, so use it with caution.
</Accordion>

<Accordion title="Get member cards from board">
  Retrieves all cards assigned to a specific member on a particular trello board. this endpoint is useful for getting a comprehensive view of a team member's tasks within a project context. it can be used to track individual workload, assess task distribution, or gather data for productivity analysis. the endpoint returns only cards that are currently assigned to the specified member on the given board, and does not include cards from other boards or unassigned cards. it's particularly helpful for project managers or team leads who need to review or report on a team member's current responsibilities within a specific project or workflow.
</Accordion>

<Accordion title="Delete member vote from card">
  Removes a specific member's vote from a trello card. this endpoint is used when you need to undo a member's vote on a card, which can be useful for managing decision-making processes or cleaning up outdated votes. it should be called when a member wants to retract their vote or when an administrator needs to remove a vote on behalf of a member. the operation is irreversible, so it should be used with caution. this endpoint does not provide any information about the remaining votes on the card or confirm the previous existence of the vote; it simply attempts to remove the specified member's vote from the specified card.
</Accordion>

<Accordion title="Get board by action id">
  Retrieves the board associated with a specific trello action. this endpoint allows you to fetch detailed information about the board on which a particular action occurred. it's useful when you need to understand the context of an action, such as determining which board a card was moved to or where a comment was added. this tool is particularly helpful for tracking the flow of work across different boards or for auditing purposes. note that while it provides board details, it doesn't return information about the action itself or other board elements like lists or cards.
</Accordion>

<Accordion title="Get cards by filter from board">
  Retrieves a list of cards from a specified trello board, with optional filtering capabilities. this endpoint is essential for accessing and managing task information within a trello project. it allows users to fetch cards based on various criteria, enabling efficient organization and analysis of project tasks. the endpoint is particularly useful for integrations that need to sync trello data with other project management tools or for creating custom reports and dashboards. note that while this endpoint provides comprehensive card data, it does not modify any information on the board.\<\<DEPRECATED use get\_boards\_cards\_by\_id\_board\_by\_filter>>
</Accordion>

<Accordion title="Add organization logo">
  This endpoint allows you to upload a new logo for a specified trello organization. it's used to set or update the visual branding of an organization within trello. the endpoint accepts a file parameter in the request body, which should contain the logo image data. use this when you need to customize the appearance of a trello organization or update its existing logo. the uploaded logo will be displayed in various places where the organization is represented, such as the organization's page and associated boards. note that there may be size and format restrictions for the logo file, which are not specified in this schema but should be considered when preparing the upload.
</Accordion>

<Accordion title="Delete card attachment">
  Deletes a specific attachment from a trello card. this endpoint allows users to remove an attachment, such as a file or document, from a particular card on their trello board. it should be used when a user wants to permanently remove an attachment that is no longer needed or relevant to the card. the operation is irreversible, so it should be used with caution. this endpoint is particularly useful for managing card content and keeping information up-to-date by removing outdated or unnecessary attachments.
</Accordion>

<Accordion title="Delete webhook by id">
  Deletes a specific webhook from the trello system using its unique identifier. this endpoint is used to permanently remove a webhook that is no longer needed or has become obsolete. once deleted, the webhook will stop receiving notifications about changes to the associated trello resources. this operation is irreversible, so it should be used with caution. it's particularly useful for cleaning up webhooks that are no longer in use, reducing unnecessary api calls and maintaining a clean integration setup.
</Accordion>

<Accordion title="Add members one time messages dismissed">
  This endpoint allows dismissing a specific type of one-time message for a trello member. it's used to mark certain notifications or alerts as acknowledged or no longer relevant for the user. this is particularly useful for managing user preferences and reducing notification clutter. the endpoint should be called when a member interacts with a one-time message, choosing to dismiss it. it helps in personalizing the user experience by remembering which introductory or special messages the user has already seen and acknowledged.
</Accordion>

<Accordion title="Add member saved searches attributes">
  Creates a new saved search for a specified trello member. this endpoint allows users to store frequently used search queries for quick access and improved productivity. it's particularly useful for team members who regularly need to filter and find specific cards, boards, or other trello items. the saved search will be associated with the member's account and can be easily accessed and executed from the trello interface. this feature is typically available to paid subscribers and helps in personalizing the trello experience for individual users.
</Accordion>

<Accordion title="Delete card action comment">
  This endpoint deletes a specific comment from a trello card's action history. it allows users to remove unwanted or outdated comments associated with a particular card. the endpoint should be used when there's a need to clean up or manage the comment history of a card, such as removing inappropriate content or correcting mistakes. it's important to note that this action is irreversible, and once a comment is deleted, it cannot be recovered through the api. this endpoint only deletes comments and does not affect other types of card actions. users should exercise caution when using this endpoint, as it permanently removes information from the card's history.
</Accordion>

<Accordion title="List cards by board id">
  Retrieves all cards associated with a specific trello board. this endpoint allows users to fetch a comprehensive list of cards, including their details such as names, descriptions, due dates, and other attributes, from a given board. it's particularly useful for getting an overview of all tasks or items within a project or workflow. the endpoint should be used when you need to gather information about multiple cards at once, rather than querying individual cards separately. note that this endpoint may have limitations on the number of cards returned in a single request for boards with a large number of cards, and pagination might be necessary for complete retrieval.\<\<DEPRECATED use get\_boards\_cards\_by\_id\_board>>
</Accordion>

<Accordion title="Add organization attributes">
  Creates a new trello organization with customizable properties and preferences. this endpoint allows you to set up an organization structure, including its name, description, website, and various visibility and access settings. use this when you need to establish a new collaborative workspace for teams or projects in trello. the endpoint provides extensive options for configuring organization-wide preferences, such as board visibility restrictions, external member access, and google apps integration. it's particularly useful for setting up organizations with specific security and collaboration requirements.
</Accordion>

<Accordion title="Delete checklist by id">
  Deletes a specific checklist from a trello board. this endpoint should be used when you want to permanently remove a checklist and all its associated items from a card. it's particularly useful for cleaning up completed or obsolete checklists, or when restructuring card content. the operation is irreversible, so use it with caution. once deleted, the checklist and its items cannot be recovered. this endpoint does not return the deleted checklist data; it typically returns a success status code upon successful deletion.
</Accordion>

<Accordion title="Delete board star for member">
  Removes a specific board from a trello member's list of starred boards. this endpoint is used when a user wants to unstar a board, effectively removing it from their quick access list of favorite boards. it's particularly useful for decluttering a user's starred boards list or when a board is no longer frequently accessed. the operation is immediate and irreversible, but it does not affect the board itself or the user's membership on the board; it only removes the 'star' status for that member. this endpoint should be used cautiously as it directly affects the user's personal organization of boards.
</Accordion>

<Accordion title="Fetch board lists">
  Retrieves all lists associated with a specific trello board. this endpoint allows you to fetch the complete set of lists that exist on a given board, providing an overview of the board's structure and organization. use this when you need to display or analyze the current layout of a board, such as when building a board overview or preparing for task management operations. the endpoint returns basic information about each list, typically including its id, name, and position on the board. note that this endpoint does not return the cards within the lists; to get that level of detail, you would need to make separate api calls for each list.\<\<DEPRECATED use get\_boards\_lists\_by\_id\_board>>
</Accordion>

<Accordion title="Add new card to list">
  Creates a new card in a specified trello list with customizable attributes. this endpoint allows you to add a card to an existing list, optionally copying properties from another card, setting due dates, assigning members, adding labels, and more. use this when you need to programmatically create new tasks or items in your trello workflow. the endpoint is versatile, supporting simple card creation with just a name and list id, as well as complex scenarios involving multiple attributes and attachments. note that while many parameters are optional, at minimum, you must specify the 'idlist' where the card will be added.\<\<DEPRECATED use add\_cards>>
</Accordion>

<Accordion title="Retrieve card field by id">
  Retrieves a specific field of a trello card. this endpoint allows you to fetch individual attributes of a card without retrieving the entire card object, which can be useful for targeted data retrieval and improved performance. it should be used when you need to access a particular piece of information about a card, such as its name, description, due date, or any other supported field. this tool is particularly helpful for checking specific card details or for integrations that need to monitor or sync certain card attributes. note that this endpoint will only return the value of the requested field; if you need multiple fields or the complete card data, you should use a different endpoint that returns the full card object.\<\<DEPRECATED use get\_cards\_by\_id\_card\_by\_field>>
</Accordion>

<Accordion title="Delete card sticker">
  Deletes a specific sticker from a trello card. this endpoint allows you to remove a single sticker from a card by providing both the card's unique identifier and the sticker's unique identifier. it's useful for cleaning up or reorganizing visual elements on a card. the operation is permanent and cannot be undone, so use it with caution. this endpoint should be used when you need to programmatically remove stickers from cards, such as in automation workflows or when bulk-updating card appearances.
</Accordion>

<Accordion title="Update card attributes">
  Updates an existing trello card with new attributes or modifications. this endpoint allows you to change various properties of a card, including its status, description, due date, attachments, board and list placement, labels, and assigned members. use this when you need to modify a card's details, move it between lists or boards, or update its metadata. the endpoint is versatile, allowing for partial updates, so you can specify only the fields you want to change. it's particularly useful for automating workflows, syncing card data with external systems, or bulk updating cards based on certain criteria. note that some updates, like changing the board or list, may affect the card's visibility and accessibility to team members.\<\<DEPRECATED use update\_cards\_by\_id\_card>>
</Accordion>

<Accordion title="Add members custom stickers">
  Adds a custom sticker to a specific trello member's profile. this endpoint allows you to upload and associate a unique image as a custom sticker for the given member. custom stickers can be used to personalize cards and enhance visual communication within trello boards. use this endpoint when you want to programmatically add new custom stickers to a member's collection, which can then be applied to cards across their trello boards. note that there may be limitations on the number of custom stickers a member can have, and the file size and format of the sticker image may be restricted by trello's policies.
</Accordion>

<Accordion title="Delete label byid">
  Deletes a specific label from a trello board. this endpoint is used when you want to permanently remove a label that is no longer needed or relevant to your board's organization. it's particularly useful for cleaning up old or unused labels to maintain a streamlined and efficient labeling system. once deleted, the label will no longer be available for assigning to cards, and any cards previously tagged with this label will have the label removed. use this endpoint with caution, as the deletion is permanent and cannot be undone through the api.
</Accordion>

<Accordion title="Get card by id">
  Retrieves detailed information about a specific trello card using its unique identifier. this endpoint allows you to fetch comprehensive data about a single card, including its name, description, due date, members, labels, and other associated metadata. use this endpoint when you need to access or display the full details of a particular card within your application or workflow. it's particularly useful for scenarios where you need to show card details, update card information, or sync card data with external systems. note that this endpoint only provides read access to the card data and does not allow modifications.\<\<DEPRECATED use get\_cards\_by\_id\_card>>
</Accordion>

<Accordion title="Create new session">
  Creates a new session in trello, associating it with a specific board and setting the user's status. this endpoint is used to initialize a user's interaction with a trello board, enabling real-time updates and status tracking. it's particularly useful for applications that need to manage user presence and activity within trello boards. the created session allows trello to send appropriate notifications and updates based on the user's status. note that this endpoint doesn't handle authentication itself; ensure proper authentication is in place before calling this endpoint.
</Accordion>

<Accordion title="Delete member saved search">
  This endpoint deletes a specific saved search for a trello member. saved searches allow users to quickly access frequently used search terms and filters within trello. this operation permanently removes the saved search from the member's account, freeing up space and decluttering their saved searches list. use this endpoint when a user wants to remove an outdated or no longer needed saved search. it's important to note that this action cannot be undone, so confirmation from the user before deletion is recommended. the endpoint requires both the member's id and the specific saved search id to ensure precise targeting of the item to be deleted.
</Accordion>

<Accordion title="Delete member board background">
  This endpoint allows for the deletion of a specific custom board background associated with a trello member. it removes the background image from the member's available board backgrounds, making it no longer accessible for use on their boards. this operation is permanent and cannot be undone, so it should be used with caution. the endpoint is particularly useful for managing storage space or removing outdated or unwanted background options for a member. it requires both the member's id and the specific board background id to ensure precise targeting of the background to be deleted.
</Accordion>

<Accordion title="Retrieve board by id">
  Retrieves detailed information about a specific trello board. this endpoint allows you to fetch comprehensive data about a board, including its name, description, members, lists, and other associated metadata. use this endpoint when you need to access or display the current state and configuration of a particular board. it's particularly useful for applications that need to sync board data, display board information, or perform operations based on the board's current state. note that this endpoint only provides a read-only view of the board; it cannot be used to modify the board's properties. the response will likely include all visible elements of the board, but may not include certain private or restricted information depending on the authentication level and permissions of the api key used.\<\<DEPRECATED use get\_boards\_by\_id\_board>>
</Accordion>

<Accordion title="Delete member custom sticker">
  Deletes a specific custom sticker associated with a trello member. this endpoint is used to permanently remove a custom sticker from a member's collection, freeing up space in their custom sticker library. it should be used when a member no longer needs a particular custom sticker or wants to manage their sticker collection. once deleted, the custom sticker cannot be recovered, so use this endpoint with caution. this operation is only available for custom stickers within a paid trello workspace.
</Accordion>

<Accordion title="Get card check item states">
  Retrieves the check item states for a specific trello card. this endpoint allows you to fetch the current status (e.g., complete or incomplete) of all checklist items associated with the given card. it's useful for tracking the progress of tasks within a card or for syncing checklist data with external systems. the endpoint should be used when you need to monitor or update the completion status of checklist items for a particular card. note that this endpoint only provides the states of check items and does not return the full checklist or card details. to get comprehensive card information, you would need to use a separate endpoint.
</Accordion>

<Accordion title="Retrieve card list by id">
  Retrieves the list information for a specific card in trello. this endpoint allows you to determine which list a particular card belongs to on a trello board. it's useful for understanding the current status or position of a task within a workflow. the endpoint should be used when you need to know the organizational context of a specific card, such as its current stage in a process or its categorization. it provides a quick way to locate a card within the board's structure without having to fetch and search through all lists. note that this endpoint only returns information about the list containing the card and does not provide details about the card itself or other cards in the same list.
</Accordion>

<Accordion title="Retrieve member custom board backgrounds">
  Retrieves the list of custom board backgrounds associated with a specific trello member. this endpoint allows you to fetch all personalized background images that the member has uploaded or created for use on their trello boards. it's useful for applications that need to display or manage a member's custom board background options. the endpoint returns details about each custom background, which may include image urls, dimensions, and other relevant metadata. use this when you need to access a member's personal board customization options or integrate board background management into your application.
</Accordion>

<Accordion title="Fetch board for list id">
  Retrieves the board information associated with a specific trello list. this endpoint allows you to fetch details about the board to which a particular list belongs. it's useful when you need to understand the context or parent board of a list, especially in scenarios where you're working with list ids and need to know their associated boards. this can be helpful for navigation, organization, or when you need to perform operations that require board-level information. the endpoint returns board details, which may include the board's name, description, preferences, and other relevant metadata. use this when you have a list id and need to find out which board it's on, or when you need to access board-level information starting from a list.
</Accordion>

<Accordion title="Get card attachment by id">
  Retrieves a specific attachment from a trello card. this endpoint allows you to fetch detailed information about a single attachment associated with a particular card. it's useful when you need to access or download files, documents, or other resources that have been added to a trello card. the endpoint requires both the card's id and the attachment's id to pinpoint the exact resource you're looking for. use this when you need to retrieve or verify attachment details, such as file name, size, or download url, without fetching all attachments on the card.
</Accordion>

<Accordion title="List member board invitations">
  Retrieves a list of boards that a specific trello member has been invited to but may not have joined yet. this endpoint is useful for tracking pending board invitations for a user, allowing them to see which boards they have access to join. it can be used to display a list of available boards to a user, helping them manage their trello workspace connections. the endpoint does not provide information about boards the member is already part of, focusing solely on outstanding invitations. use this when you need to show a user their pending board invitations or to check if a specific invitation exists for a member.
</Accordion>

<Accordion title="Get member cards by id and filter">
  Retrieves a filtered list of cards associated with a specific trello member. this endpoint allows you to fetch cards based on their status (open, closed) or visibility to the member. it's particularly useful for getting an overview of a member's tasks or responsibilities across different boards. the endpoint can be used to gather data for personal task management, team progress tracking, or generating reports on member activities. note that the results are limited to cards the authenticated user has permission to view, and the response may be paginated for large sets of cards.
</Accordion>

<Accordion title="Retrieve actions for list by id">
  Retrieves a list of actions associated with a specific trello list. this endpoint allows you to fetch the activity history and changes made to a particular list, such as card movements, comments, or updates. use this endpoint when you need to track the timeline of events for a list or monitor recent activities. it's particularly useful for auditing purposes or creating activity logs. the endpoint returns actions in chronological order, with the most recent actions first. note that the number of actions returned may be limited, and pagination might be required for lists with extensive history.
</Accordion>

<Accordion title="Retrieve board field of card">
  Retrieves a specific field of the board associated with a given trello card. this endpoint is useful when you need to access board-level information starting from a particular card, without fetching the entire board object. it allows for efficient retrieval of single board attributes, such as the board's name, description, or url. this endpoint should be used when you have a card's id and need to quickly obtain a specific piece of information about its parent board. it's particularly helpful for applications that need to display or process board details in the context of card operations. note that this endpoint only provides read access to board fields and cannot be used to modify board information.
</Accordion>

<Accordion title="Get checklist board info">
  Retrieves the board associated with a specific checklist in trello. this endpoint allows you to fetch detailed information about the board that contains the specified checklist. it's useful when you need to understand the broader context of a checklist, such as which project or workflow it belongs to. the endpoint returns board details, which may include the board's name, description, members, and other relevant information. use this when you have a checklist id and need to know more about its parent board, particularly for tasks involving board-level operations or cross-referencing checklist data with board data.
</Accordion>

<Accordion title="Retrieve members board invites">
  Retrieves a specific field of information from all boards that a trello member has been invited to join. this endpoint is useful for gathering particular details about boards where the member has a pending invitation, without fetching all board data. it can be used to quickly check certain attributes across multiple invited boards, such as their names, ids, or last activity dates. this tool is particularly helpful when you need to analyze or display specific information about a member's board invitations efficiently. note that this endpoint only provides data for boards with pending invitations and does not include boards where the member is already active.
</Accordion>

<Accordion title="Retrieve card field by id">
  Retrieves a specific field of a trello card. this endpoint allows you to fetch individual attributes of a card without retrieving the entire card object, which can be useful for targeted data retrieval and improved performance. it should be used when you need to access a particular piece of information about a card, such as its name, description, due date, or any other supported field. this tool is particularly helpful for checking specific card details or for integrations that need to monitor or sync certain card attributes. note that this endpoint will only return the value of the requested field; if you need multiple fields or the complete card data, you should use a different endpoint that returns the full card object.
</Accordion>

<Accordion title="Get card by id">
  Retrieves detailed information about a specific trello card using its unique identifier. this endpoint allows you to fetch comprehensive data about a single card, including its name, description, due date, members, labels, and other associated metadata. use this endpoint when you need to access or display the full details of a particular card within your application or workflow. it's particularly useful for scenarios where you need to show card details, update card information, or sync card data with external systems. note that this endpoint only provides read access to the card data and does not allow modifications.
</Accordion>

<Accordion title="Fetch member custom emoji">
  Retrieves the custom emojis associated with a specific trello member. this endpoint allows you to fetch all custom emojis that a particular member has created or has access to within their trello account. custom emojis are special images that can be used in comments, card descriptions, and other text fields in trello. this endpoint is useful when you need to display or list the available custom emojis for a member, or when integrating custom emoji functionality into a third-party application. note that this endpoint only retrieves the custom emojis and does not provide information about standard emojis available to all trello users.
</Accordion>

<Accordion title="Retrieve card member information">
  Retrieves a list of members associated with a specific trello card. this endpoint allows you to fetch all users who are assigned to or involved with a particular card, providing valuable information for task management and collaboration. use this when you need to know who is responsible for or working on a specific card. the endpoint returns member details but does not modify any card information or memberships. it's particularly useful for tracking task assignments, generating reports on card participation, or displaying member avatars alongside card information in a user interface.
</Accordion>

<Accordion title="Fetch checklist board field">
  Retrieves a specific field from the board associated with a given checklist in trello. this endpoint allows users to access granular information about a board linked to a particular checklist, which can be useful for various integration and automation scenarios. it provides a way to fetch individual board attributes without retrieving the entire board object, potentially improving efficiency for targeted data retrieval. the endpoint should be used when you need to access specific board details in the context of a checklist, but it will not provide information about the checklist itself or other board fields not specified in the request.
</Accordion>

<Accordion title="Get board by card id">
  Retrieves the board information associated with a specific trello card. this endpoint allows you to fetch details about the parent board of a given card, providing context about where the card is located within your trello workspace. use this when you need to understand the broader organizational structure a card belongs to or when you want to access board-level information starting from a specific card. this is particularly useful for applications that need to navigate from card-level operations to board-level views or actions. note that this endpoint only returns information about the board and does not provide details about other cards or lists on that board.
</Accordion>

<Accordion title="Retrieve member organizations by filter">
  Retrieves a list of organizations associated with a specific trello member, filtered by the given criteria. this endpoint is useful for obtaining information about a user's organizational affiliations within trello, which can be valuable for user management, permissions setting, or displaying relevant workspaces. the filter parameter allows for narrowing down the results based on the member's relationship to the organizations. this endpoint should be used when you need to gather information about a user's organizational context within trello, but it will not provide detailed information about the organizations themselves beyond basic identifiers.
</Accordion>

<Accordion title="Get member saved search by id">
  Retrieves a specific saved search associated with a trello member. this endpoint allows you to fetch the details of a particular saved search by providing both the member's id and the saved search id. it's useful for applications that need to display or manage a user's saved searches within trello. the endpoint returns the full details of the saved search, which may include the search query, any filters applied, and other relevant metadata. use this endpoint when you need to access or display the specifics of a single saved search for a given trello user. note that this endpoint only retrieves the saved search information and does not execute the search itself.
</Accordion>

<Accordion title="Get list field value">
  Retrieves a specific field of a trello list. this endpoint allows you to fetch detailed information about a particular aspect of a list by providing the list's unique identifier and the name of the field you want to retrieve. it's useful when you need to access or verify a single piece of information about a list without retrieving all of its details. this endpoint should be used when you require quick access to a specific list attribute, such as its name, associated board id, or position. it's important to note that this endpoint returns only the requested field's value and not the entire list object. therefore, it's not suitable for retrieving multiple fields simultaneously or for getting a comprehensive view of the list.
</Accordion>

<Accordion title="Get member organizations by id">
  Retrieves a list of organizations associated with a specific trello member. this endpoint is useful for obtaining an overview of all the organizations a member belongs to, which can be helpful for managing user permissions, generating reports, or building user interfaces that display organization memberships. the endpoint returns basic information about each organization, likely including the organization's id, name, and possibly the member's role within it. it should be used when you need to gather information about a member's organizational affiliations within trello. note that this endpoint does not provide detailed information about the organizations themselves; for that, you would need to use a separate endpoint specific to organization details.
</Accordion>

<Accordion title="Retrieve member saved searches">
  Retrieves all saved searches for a specific trello member. this endpoint allows you to fetch the list of search queries that a member has saved for quick access within their trello account. it's useful for applications that need to display or manage a user's saved searches, enabling features like quick filtering of boards, cards, or other trello elements. the endpoint should be used when you need to access a member's search preferences or want to implement functionality that leverages their saved search history. note that this endpoint only retrieves the saved searches and does not execute them; to perform an actual search, you would need to use a separate search endpoint with the retrieved query parameters.
</Accordion>

<Accordion title="Fetch card list field">
  Retrieves a specific field of the list associated with a given trello card. this endpoint allows you to fetch targeted information about the list containing a particular card without retrieving the entire list object. it's useful when you need quick access to a single attribute of the list, such as its name or position on the board. this tool should be used when you have a card's id and want to know a specific detail about the list it's in. it's particularly efficient for scenarios where you don't need comprehensive list data. note that this endpoint only provides information about the list, not the card itself or other cards in the list.
</Accordion>

<Accordion title="Retrieve member tokens">
  Retrieves all tokens associated with a specific trello member. this endpoint allows you to fetch the authentication tokens that have been issued for a particular user, which can be useful for managing api access and auditing purposes. it returns a list of token objects, each representing an active token for the specified member. use this endpoint when you need to review or manage the api access granted to a user's account. note that this endpoint does not provide the actual token values for security reasons, but rather metadata about the tokens such as their id, creation date, and associated app information.
</Accordion>

<Accordion title="Retrieve member s invited organizations">
  Retrieves a list of organizations that a specific trello member has been invited to join but has not yet accepted or declined. this endpoint is useful for tracking pending organization invitations for a given user. it can be used to display a list of outstanding invitations, allowing the member to review and take action on them. the endpoint does not provide information about organizations the member has already joined or invitations that have been declined. use this endpoint when you need to fetch all pending organization invitations for a particular trello member, such as for notification purposes or to prompt the user to act on outstanding invitations.
</Accordion>

<Accordion title="Retrieve member invited organization">
  Retrieves a specific field of information about organizations that a trello member has been invited to join but has not yet accepted. this endpoint is useful for gathering detailed information about pending organization invitations for a user, allowing applications to display relevant data or make decisions based on the invited organizations' attributes. it provides a focused way to access organization data without fetching all details, which can be more efficient when only specific information is needed. the endpoint should be used when you need to access particular details about organizations a member has been invited to, rather than retrieving full organization objects or listing all invitations.
</Accordion>

<Accordion title="Retrieve board field from list">
  Retrieves a specific field of the trello board associated with a given list. this endpoint allows users to access board information through one of its lists, providing a way to navigate the trello hierarchy from list to board. it's particularly useful when you have a list id and need to fetch details about the board it belongs to without knowing the board id directly. the endpoint returns only the requested field of the board, making it efficient for targeted data retrieval. however, it's limited to one field per request, so multiple calls may be necessary to gather comprehensive board information.
</Accordion>

<Accordion title="Retrieve list by id">
  Retrieves detailed information about a specific trello list using its unique identifier. this endpoint allows you to fetch the properties and metadata of a single list, such as its name, associated board, position on the board, and whether it's archived. use this endpoint when you need to access or verify the current state and details of a particular list in your trello workflow. it's particularly useful for applications that need to display list information, check list status, or prepare for operations on the list. note that this endpoint only provides information about the list itself and does not return the cards contained within the list.
</Accordion>

<Accordion title="Retrieve member board background">
  Retrieves detailed information about a specific custom board background for a given trello member. this endpoint allows you to fetch the properties and metadata of a particular custom background that a member has associated with their account. it's useful when you need to display or verify the details of a custom background, such as its dimensions, file type, or any custom attributes trello might associate with it. the endpoint should be used when you have both the member's id and the specific board background id, typically in scenarios where you're managing or displaying user-specific board customizations. note that this endpoint only provides information about the background and does not return the actual image file itself.
</Accordion>

<Accordion title="Retrieve board notification field">
  This endpoint retrieves a specific field of the board associated with a given trello notification. it allows users to fetch targeted information about the board context of a notification without retrieving all board details. use this when you need a particular board attribute in the context of a specific notification. note that it only returns a single field, not the entire board object.
</Accordion>

<Accordion title="Retrieve member board backgrounds">
  Retrieves the custom board backgrounds associated with a specific trello member. this endpoint allows you to fetch all the personalized background images that a member has uploaded or selected for use on their trello boards. it's useful for applications that need to display or manage a user's board customization options. the endpoint returns an array of board background objects, likely including details such as image urls, colors, and other relevant attributes. use this when you need to access or display a member's available board backgrounds, for example, when allowing a user to choose a background for a new board or when syncing customization settings across devices.
</Accordion>

<Accordion title="Retrieve notification field details">
  Retrieves a specific field of a trello notification. this endpoint allows you to fetch targeted information about a notification without retrieving the entire notification object. it's useful when you need quick access to a particular attribute of a notification, such as its type, date, or associated data. the endpoint requires both the unique identifier of the notification and the name of the field you want to retrieve. it's ideal for scenarios where bandwidth is a concern or when only a specific piece of notification data is needed. note that the response will contain only the requested field's value, not the full notification object.
</Accordion>

<Accordion title="Retrieve checklist by id">
  Retrieves detailed information about a specific checklist in trello using its unique identifier. this endpoint allows users to fetch the complete data of a checklist, including its name, items, completion status, and any other associated metadata. it's particularly useful when you need to access or display the full contents of a checklist within your application. the endpoint should be used when you have the checklist's id and require its current state or details. it does not modify the checklist and is ideal for read-only operations or before performing updates to ensure you have the latest data.
</Accordion>

<Accordion title="Retrieve notification board by id">
  Retrieves the board associated with a specific trello notification. this endpoint allows you to fetch detailed information about the board where a notification-triggering action occurred. it's particularly useful when you need to provide context or additional details about a notification, such as the board's name, background, or other relevant attributes. use this endpoint when you want to quickly access the board related to a notification without having to make separate api calls. note that this endpoint only provides board information and does not include details about the notification itself or other board components like lists or cards.
</Accordion>

<Accordion title="Retrieve card members voted">
  Retrieves a list of members who have voted on a specific trello card. this endpoint is part of the voting power-up feature and is useful for tracking team preferences or decision-making processes within a project. it provides insight into which team members have participated in voting on a particular card, helping to gauge engagement and consensus. use this endpoint when you need to review voting participation for a card or analyze team involvement in decision-making processes. note that this endpoint only returns information about who voted, not the specific votes cast or voting results.
</Accordion>

<Accordion title="Get notification by id">
  Retrieves detailed information about a specific trello notification. this endpoint allows you to fetch the full details of a single notification based on its unique identifier. use this when you need to access comprehensive information about a particular notification, such as its type, related board or card, creation time, and any associated data. this is particularly useful for displaying notification details in your application or for processing specific notifications as part of your workflow automation. the endpoint will only return data for the specified notification and does not provide a way to fetch multiple notifications in a single request.
</Accordion>

<Accordion title="Get cards from list by id">
  Retrieves all cards within a specified trello list. this endpoint allows users to fetch detailed information about cards in a particular list, providing a comprehensive view of tasks or items within that list. it's particularly useful for applications that need to synchronize trello data, build custom views of trello boards, or perform bulk operations on cards within a specific list. the endpoint returns an array of card objects, each containing details such as the card's name, description, due date, and any custom fields. use this endpoint when you need to get an up-to-date snapshot of all cards in a list, but note that it doesn't provide real-time updates or webhook functionality for card changes.
</Accordion>

<Accordion title="Retrieve notification member field">
  Retrieves a specific field of a member associated with a given trello notification. this endpoint is useful when you need to access detailed information about the member involved in a particular notification, such as the member who triggered the notification or the member who received it. it allows for granular data retrieval, fetching only the specified field rather than all member information. this can be particularly helpful when you need to quickly access a specific piece of member data in the context of a notification, without the overhead of retrieving all member details. the endpoint should be used when you have a notification id and need to extract a particular attribute of the related member. it will not provide information about the notification itself or other members not associated with the specified notification.
</Accordion>

<Accordion title="Get checklists for cardid">
  Retrieves all checklists associated with a specific trello card. this endpoint is useful for obtaining detailed information about the tasks and subtasks within a card, allowing users to track progress and manage workflows effectively. it should be used when you need to fetch the complete set of checklists for a particular card, such as when displaying card details or syncing card information with another system. the endpoint returns an array of checklist objects, each containing items that represent individual tasks or steps. note that this endpoint only provides checklist data and does not include other card details like comments or attachments. it's particularly valuable for applications that need to monitor or update task progress within trello cards.
</Accordion>

<Accordion title="Retrieve checklist field">
  The getchecklistfield endpoint retrieves a specific attribute or field of a trello checklist. it allows users to fetch detailed information about a particular aspect of a checklist without retrieving the entire checklist object. this endpoint is useful when you need to access or verify a single piece of information about a checklist, such as its name, associated card id, or position. it should be used when you require only one specific detail about a checklist, rather than its complete data. note that this endpoint will not provide information about the check items within the checklist; it focuses solely on the checklist's properties.
</Accordion>

<Accordion title="Fetch member creator field">
  Retrieves a specific field of information about the member who created a particular notification in trello. this endpoint is useful when you need detailed information about the user responsible for generating a specific notification, without fetching their entire profile. it allows for efficient, targeted data retrieval, which can be particularly beneficial when building notification-centric features or conducting user activity analysis. the endpoint should be used when you have a notification id and need to access a specific attribute of its creator. it will not provide information about the notification itself or other members.
</Accordion>

<Accordion title="Retrieve card notification by id">
  Retrieves the card information associated with a specific trello notification. this endpoint is useful when you need to access details about the card that triggered a particular notification. it allows you to fetch comprehensive information about the card, such as its title, description, members, labels, and other relevant data. use this endpoint when you want to display or process card information in the context of a notification, for example, to show users more details about an action that occurred on a card they're watching. note that this endpoint only provides card data and does not include information about the notification itself or other related entities like boards or lists.
</Accordion>

<Accordion title="Get notification field by id">
  This endpoint retrieves a specific field from a list associated with a given trello notification. it allows users to access granular information about the list context of a notification, which can be useful for tracking changes or gathering specific details without fetching the entire list object. the endpoint should be used when you need to quickly access a particular attribute of a list that's linked to a notification, such as its name, id, or status. it's particularly efficient when you don't need the full list data and want to minimize data transfer. however, it's important to note that this endpoint is limited to retrieving a single field at a time, so multiple calls may be necessary if you need several fields from the same list.
</Accordion>

<Accordion title="Retrieve member creator from notification id">
  Retrieves information about the member who created a specific trello notification. this endpoint is useful for obtaining details about the user responsible for triggering a particular notification, providing context to the notification's origin. it should be used when you need to identify or get more information about the member behind a notification action. the endpoint focuses solely on the creator's details and does not provide information about the notification content itself or other related data. keep in mind that accessing this information may be subject to permission settings and the user's role within the trello board or organization.
</Accordion>

<Accordion title="Get card stickers by id">
  Retrieves all stickers associated with a specific trello card. this endpoint allows you to fetch the visual elements (stickers) that have been added to a card for categorization, emphasis, or decoration purposes. it's useful when you need to review or analyze the visual metadata of a card, such as identifying specific tags or markers represented by stickers. the endpoint returns an array of sticker objects, likely including details such as the sticker's id, image url, and position on the card. use this when you need to inventory or process the stickers on a particular card, but note that it doesn't modify the stickers or provide information about other card elements.
</Accordion>

<Accordion title="Get member board background">
  Retrieves a specific custom board background for a given trello member. this endpoint allows you to fetch detailed information about a particular board background associated with a member's account. it's useful when you need to display or use the properties of a specific custom background, such as its image url, dimensions, or any custom attributes. this endpoint should be used when you have both the member's id and the specific board background id. it will not provide information about other board backgrounds or modify the background in any way.
</Accordion>

<Accordion title="Get notification member by id">
  Retrieves the member information associated with a specific trello notification. this endpoint allows you to get details about the user who is related to a particular notification, such as the member who created a card that triggered the notification. use this endpoint when you need to identify or gather information about the member involved in a specific trello notification event. it's particularly useful for tracking user activities, auditing notification sources, or displaying member details alongside notification content in your application. note that this endpoint only provides member data directly linked to the specified notification and does not return the notification content itself or other board-wide member information.
</Accordion>

<Accordion title="Retrieve cards by filter from list">
  Retrieves a filtered set of cards from a specific trello list. this endpoint allows you to fetch cards based on a given list id and apply a filter to narrow down the results. it's particularly useful when you need to access a subset of cards within a list, such as all open cards or cards matching certain criteria. the endpoint should be used when you want to efficiently retrieve specific cards from a known list without fetching all cards and filtering them client-side. note that the exact filtering options available depend on the trello api's supported filters, which are not fully specified in the given schema.
</Accordion>

<Accordion title="Retrieve organization notification field">
  This endpoint retrieves a specific field of the organization associated with a given trello notification. it allows users to access detailed information about the organization context of a notification without fetching the entire organization object. this can be particularly useful when you need quick access to a single piece of organization data related to a notification, such as the organization's name or description. the endpoint should be used when you have a notification id and need to extract a particular organization detail linked to that notification. it's important to note that this endpoint will only return data for notifications that are associated with an organization; personal board notifications may not return any data.
</Accordion>

<Accordion title="Get notification organization">
  Retrieves the organization information associated with a specific trello notification. this endpoint allows you to fetch details about the organization context in which a particular notification was generated. it's useful when you need to understand the broader organizational scope of a notification, such as determining which workspace or team the notification is related to. the endpoint should be used when you have a notification id and need to retrieve the corresponding organization data. note that this endpoint only provides organization information and does not return details about the notification itself or other related entities like boards or cards.
</Accordion>

<Accordion title="Get member custom emoji by id">
  Retrieves a specific custom emoji associated with a trello member. this endpoint allows you to fetch detailed information about a particular custom emoji that a member has added to their trello account. it's useful when you need to access or display a specific custom emoji in your application, or when you want to verify the existence and details of a custom emoji for a given member. the endpoint requires both the member's id and the custom emoji's id to uniquely identify and retrieve the correct emoji. note that this endpoint only retrieves information about the emoji and does not modify or delete it.
</Accordion>

<Accordion title="Retrieve org field by id">
  Retrieves a specific field or attribute of a trello organization. this endpoint allows you to fetch targeted information about an organization without retrieving all of its details. it's useful when you need a particular piece of data, such as the organization's name, description, or website. the endpoint requires the organization's unique identifier and the name of the field you want to retrieve. it's efficient for quick lookups and can be used to verify or display specific organization information in integrations or automation workflows. however, it won't return multiple fields in a single call, so for comprehensive organization data, you might need to use a different endpoint.
</Accordion>

<Accordion title="Fetch org deltas by id">
  Retrieves the recent changes (deltas) for a specified trello organization. this endpoint is used to fetch updates or modifications made within the organization, such as changes to boards, lists, or cards. it's particularly useful for keeping external systems in sync with trello data or for auditing purposes. the endpoint returns delta information, which may include creation, updates, or deletion of various elements within the organization. note that the specific format and content of the delta information are not detailed in the provided schema.
</Accordion>

<Accordion title="Retrieve sticker by card id">
  Retrieves detailed information about a specific sticker on a particular trello card. this endpoint allows you to fetch the properties of a single sticker, such as its image, position on the card, and any other metadata associated with it. it's useful when you need to access or verify the details of a specific sticker, perhaps for display purposes or to confirm its current state. this tool should be used when precise information about an individual sticker is required, rather than for bulk retrieval of all stickers on a card. note that this endpoint does not modify the sticker; it only retrieves its current state.
</Accordion>

<Accordion title="List organization actions by id">
  Retrieves a list of actions performed within a specific trello organization. this endpoint allows you to fetch a comprehensive log of activities and changes made across all boards, lists, and cards within the organization. it's particularly useful for auditing purposes, tracking team productivity, or monitoring recent changes. the actions returned may include card creations, list movements, comment additions, and other significant events. use this endpoint when you need a detailed history of organizational activities or want to analyze patterns in team workflows. note that the response may be paginated for large organizations with extensive action histories, and you might need to make multiple requests to retrieve the complete set of actions.
</Accordion>

<Accordion title="Retrieve memberships for organization">
  Retrieves a list of all memberships for a specified trello organization. this endpoint allows you to fetch detailed information about users who are members of the organization, including their roles and permissions. it's particularly useful for organization administrators who need to manage team members, audit access levels, or gather data about the organization's composition. the endpoint returns membership details for all users associated with the organization, regardless of their specific role or active status. note that this endpoint does not provide information about board-specific memberships or detailed user profiles; it focuses solely on organizational-level memberships.
</Accordion>

<Accordion title="Get member board stars">
  Retrieves a list of boards that a specific trello member has starred. this endpoint allows you to fetch the favorite or most important boards for a given user, as indicated by their "star" status. it's particularly useful for applications that need to prioritize or highlight a user's preferred boards. the endpoint returns only the starred boards, not all boards the member has access to. use this when you need to quickly access a user's most relevant or frequently used boards without fetching their entire board list.
</Accordion>

<Accordion title="Retrieve membership details">
  Retrieves detailed information about a specific membership within a trello organization. this endpoint allows you to fetch the membership details of a particular user in a given organization, providing insights into their role, permissions, and other relevant information. it's useful for auditing organization members, verifying a user's status, or retrieving specific membership attributes. the endpoint requires both the organization id and the membership id to pinpoint the exact membership record. note that this endpoint only retrieves information and does not modify any data.
</Accordion>

<Accordion title="Retrieve cards from checklist">
  Retrieves all cards associated with a specific checklist in trello. this endpoint allows you to fetch the cards that contain the specified checklist, providing a way to see which tasks or items (represented by cards) are linked to a particular set of subtasks or criteria (represented by the checklist). it's useful for tracking progress on complex tasks or viewing all cards that share a common checklist. the endpoint returns an array of card objects, each containing details about the card such as its id, name, description, and other relevant metadata. use this when you need to find all cards related to a specific checklist, which can be helpful for project management, task organization, or generating reports on task dependencies.
</Accordion>

<Accordion title="Get organization members by filter">
  Retrieves a filtered list of members belonging to a specified trello organization. this endpoint allows you to fetch member information based on certain criteria, making it useful for managing team rosters, analyzing organization structure, or performing member-specific operations. the endpoint requires both the organization id and a filter parameter, enabling precise control over the returned member set. it's particularly valuable when you need to access specific subsets of an organization's membership, such as all active members or only administrators. however, it does not modify any data and should be used solely for retrieving member information. note that the exact filtering options and the structure of returned member objects are not specified in the schema, so refer to the latest trello api documentation for the most up-to-date details on available filters and response format.
</Accordion>

<Accordion title="Retrieve member actions by id">
  Retrieves a list of actions performed by a specific trello member. this endpoint allows you to fetch a chronological history of activities such as creating cards, moving items between lists, adding comments, and other interactions within trello boards and cards. it's useful for tracking a member's contributions, auditing changes, or building activity feeds. the actions returned may be limited based on the member's privacy settings and the permissions of the authenticated user making the request. note that this endpoint may not return all historical actions and might be subject to rate limiting for extensive action histories.
</Accordion>

<Accordion title="Get member custom stickers">
  Retrieves all custom stickers associated with a specific trello member. this endpoint allows you to fetch the unique, personalized stickers that a member has created or uploaded for use on their trello cards. it's particularly useful when you need to display or manage a member's custom sticker collection. the endpoint returns a list of custom stickers, including their images and metadata. note that this only retrieves custom stickers, not the standard trello stickers available to all users. use this endpoint when you need to access a member's personalized sticker set, such as for displaying in a sticker picker or for inventory management purposes.
</Accordion>

<Accordion title="Retrieve notification card field">
  Retrieves a specific field of a card associated with a given trello notification. this endpoint is useful when you need to access particular details of a card that triggered a notification, without fetching the entire card object. it can be used to quickly obtain relevant information for displaying in notification summaries or for processing notification-related actions. the endpoint is particularly valuable for applications that handle trello notifications and need to provide context about the associated cards. note that this endpoint only returns the requested field's value, not the entire card object, which makes it efficient for targeted data retrieval but limited if you need comprehensive card information.
</Accordion>

<Accordion title="Get organization boards">
  Retrieves all boards associated with a specific trello organization. this endpoint allows users to fetch a comprehensive list of boards within a given workspace, providing an overview of all projects and tasks managed by the organization. it's particularly useful for administrators or team leads who need to monitor or manage multiple boards across their organization. the endpoint returns basic information about each board, such as its name, url, and id, enabling further actions or queries on individual boards if needed. use this when you need a high-level view of an organization's project structure or when preparing to perform bulk operations on multiple boards within the same workspace.
</Accordion>

<Accordion title="Retrieve organization members by id">
  Retrieves a list of members belonging to a specific trello organization. this endpoint allows you to fetch detailed information about all users who are part of the organization, including their roles and permissions. it's particularly useful for organization administrators who need to manage team members, audit access, or gather information for reporting purposes. the endpoint returns member data such as usernames, full names, and membership status, but does not provide sensitive information like email addresses or personal account details. use this when you need a comprehensive overview of an organization's membership or when integrating member management features into your application.
</Accordion>

<Accordion title="Fetch member cards in organization">
  Retrieves all cards associated with a specific member within a trello organization. this endpoint allows you to fetch a comprehensive list of cards that a particular member is involved with in the context of a given organization. it's useful for getting an overview of a member's tasks or responsibilities across various boards within the organization. the endpoint returns card data without any sorting or filtering options, providing a complete picture of the member's card assignments. use this when you need to audit a member's workload, track their contributions, or gather data for reporting purposes within an organizational context.
</Accordion>

<Accordion title="Get cards by checklist id filter">
  Retrieves cards associated with a specific checklist in trello. this endpoint allows users to fetch cards that are linked to a particular checklist, providing a way to see all tasks or items related to a checklist across different cards or boards. the endpoint is useful for tracking progress on checklist items, identifying which cards are using a specific checklist, or gathering information for reporting purposes. it's particularly helpful when managing complex projects with interrelated tasks spread across multiple cards. the endpoint supports filtering to customize the returned set of cards, allowing for more precise data retrieval based on the user's needs.
</Accordion>

<Accordion title="Get invited organization members">
  Retrieves a list of members who have been invited to join a specific trello organization but have not yet accepted the invitation. this endpoint is useful for organization administrators to track pending invitations and manage membership. it provides information about invited users, which may include details such as their username, full name, and invitation status. use this endpoint when you need to review or audit the list of outstanding invitations for an organization. note that this endpoint only returns data about invited members; it does not include information about active members or provide functionality to send new invitations.
</Accordion>

<Accordion title="Get organization invited members">
  Retrieves a specific field of information for members who have been invited to join a trello organization. this endpoint is useful for getting targeted details about pending invitations without fetching all information about invited members. it can be used to check the status of invitations, gather contact information, or verify invitation details. the endpoint is particularly helpful when you need to audit or manage the invitation process for a trello organization. note that this endpoint only provides information about invited members who have not yet joined the organization; it does not include data about active members.
</Accordion>

<Accordion title="Retrieve token by id">
  Retrieves detailed information about a specific trello token. this endpoint allows you to fetch the properties and permissions associated with a given token, which is crucial for understanding the level of access granted to an application or user. use this endpoint when you need to verify token validity, check its permissions, or gather metadata about the token. it's particularly useful for auditing api access or troubleshooting authentication issues. note that this endpoint does not provide information about other tokens or allow modification of the token itself.
</Accordion>

<Accordion title="Search for members">
  Searches for trello members based on the provided query string. this endpoint allows you to find users by their name, username, or email address, making it useful for user discovery and member management within trello. the search is performed across all accessible trello members, with optional filters for specific boards or organizations. use this endpoint when you need to locate trello users, verify member existence, or gather member information for collaboration purposes. the search results are paginated and can be limited to control the response size.
</Accordion>

<Accordion title="Fetch boards for organization id">
  Retrieves a filtered list of boards associated with a specific trello organization. this endpoint allows users to fetch boards based on various criteria such as membership, status, visibility, and more. it's particularly useful for getting an overview of boards within an organizational context or for finding specific types of boards (e.g., public boards, starred boards). the endpoint supports customization through the filter parameter, enabling precise queries to match user requirements. note that the response will only include boards that the authenticated user has permission to view within the specified organization.
</Accordion>

<Accordion title="Display notification by id">
  Retrieves the display information for a specific trello notification. this endpoint allows you to fetch detailed data about how a notification should be presented to the user, including its content, associated card or board information, and any relevant formatting details. use this endpoint when you need to access the visual representation or formatted data of a particular notification, such as when building a custom notification display in your application or integrating trello notifications into another platform. the endpoint focuses solely on display-related data and does not modify the notification's read status or provide extensive metadata about the notification itself.
</Accordion>

<Accordion title="Get socket session">
  Establishes a websocket connection to receive real-time updates from trello. this endpoint allows clients to maintain an open connection for receiving push notifications about changes to boards, lists, cards, and other trello objects without the need for constant polling. it's particularly useful for applications that need to stay synchronized with trello in real-time. the connection provides a stream of events, which may include updates to boards, creation of new cards, or changes in list order. note that this endpoint doesn't accept any parameters, as it's primarily used to initiate the websocket handshake.
</Accordion>

<Accordion title="Retrieve token field by token id">
  Retrieves a specific field of information for a given trello authentication token. this endpoint allows developers to access granular details about a token, which can be useful for token management, verification, or debugging purposes. it provides a way to check individual attributes of a token without fetching all associated information. the endpoint should be used when specific token-related data is needed, rather than full token details. note that this endpoint does not modify the token in any way; it only retrieves information.
</Accordion>

<Accordion title="Get member custom sticker">
  Retrieves the details of a specific custom sticker associated with a trello member. this endpoint allows you to fetch information about a particular custom sticker, such as its image url, dimensions, and any other metadata associated with it. it's useful when you need to display or manipulate a specific custom sticker in your application. the endpoint requires both the member's id and the custom sticker's id to uniquely identify the requested resource. note that this endpoint only provides information about the sticker itself and does not include data about its usage on cards or boards.
</Accordion>

<Accordion title="Retrieve token member field">
  Retrieves a specific field of information for a trello member associated with the given api token. this endpoint allows for granular access to member data, enabling the retrieval of individual attributes rather than the entire member object. it's particularly useful when you need to quickly fetch a single piece of information about a member, such as their username or email, without the overhead of retrieving all member details. the endpoint should be used when precise, field-specific member information is required, and can help in reducing data transfer and processing when only particular member attributes are needed. note that the available fields and the information returned may depend on the permissions associated with the provided token and the privacy settings of the member in question.
</Accordion>

<Accordion title="Retrieve member board star">
  Retrieves detailed information about a specific board star for a given trello member. a board star represents a member's favorite or frequently accessed board. this endpoint allows you to fetch the properties of a particular board star, such as the associated board, its position in the member's star list, and when it was created or last modified. use this endpoint when you need to access or verify the details of a specific board star for a member, for example, to check if a board is still starred or to retrieve its current position in the member's favorites. this endpoint is read-only and does not modify any data.
</Accordion>

<Accordion title="List checklist items by id">
  Retrieves all checkitems associated with a specific checklist in trello. this endpoint allows you to fetch the complete list of items within a given checklist, providing details such as the item's name, state (complete or incomplete), and position within the checklist. use this endpoint when you need to review or process all tasks within a particular checklist, such as for progress tracking or task management. it's particularly useful for applications that need to sync or display trello checklist data. note that this endpoint only retrieves existing checkitems and does not create, update, or delete them.
</Accordion>

<Accordion title="Retrieve webhooks for token">
  Retrieves all webhooks associated with a specific trello api token. this endpoint allows developers to list and monitor active webhooks for a particular trello integration or application. it's useful for managing webhook subscriptions, verifying active notifications, and troubleshooting webhook-related issues. the endpoint returns details about each webhook, likely including their callback urls, target models, and current status. use this when you need to audit or manage the webhooks tied to a specific trello api token.
</Accordion>

<Accordion title="Get token member">
  Retrieves detailed information about the trello member associated with the provided api token. this endpoint allows you to access the profile data of the authenticated user, including their username, full name, initials, and other relevant account details. it's particularly useful when you need to verify the identity of the token owner or gather user-specific information for personalization purposes. the endpoint should be used when you need to retrieve up-to-date information about the authenticated trello user. note that this endpoint only provides information about the member linked to the given token and does not offer data about other trello users or board members.
</Accordion>

<Accordion title="Search endpoint">
  The searchtrello endpoint allows users to perform a comprehensive search across their trello workspace, including boards, cards, and lists. it's designed to help users quickly find specific items or information within their trello ecosystem. this endpoint is particularly useful when you need to locate content across multiple boards or when you're unsure which board contains the information you're seeking. the search functionality is versatile, matching keywords in titles, descriptions, and other text fields of trello objects. while it provides a powerful way to find information, it's important to note that the search results are limited to the user's accessible trello content and may not include recently created or modified items due to indexing delays.
</Accordion>

<Accordion title="Get webhook by token">
  Retrieves detailed information about a specific trello webhook associated with the given token. this endpoint allows developers to fetch the current state and configuration of a webhook, including its callback url, the model it's watching (e.g., board, list, or card), and its active status. it's particularly useful for verifying webhook settings, troubleshooting notification issues, or auditing webhook configurations. the endpoint should be used when you need to inspect or confirm the details of an existing webhook. it does not modify the webhook or create new ones, and it won't return information about other webhooks associated with the token.
</Accordion>

<Accordion title="Get webhook by id">
  Retrieves detailed information about a specific webhook in trello. this endpoint allows you to fetch the current configuration and status of a webhook, including its callback url, the model it's monitoring, and its active status. use this endpoint when you need to verify a webhook's settings, check its status, or gather information for webhook management. it's particularly useful for troubleshooting webhook issues or auditing your webhook configurations. the endpoint returns the full webhook object but does not provide information about past notifications sent through this webhook.
</Accordion>

<Accordion title="Get member boards by id">
  Retrieves all boards associated with a specific trello member. this endpoint allows you to fetch a comprehensive list of boards that the member has access to, including boards they own, are members of, or have been invited to. it's particularly useful for applications that need to display or work with a user's trello boards, such as for data synchronization, board management, or creating board-related features. the response typically includes details like board ids, names, and other metadata. use this endpoint when you need to get an overview of a member's trello workspace or when implementing board selection features in your application. note that it only provides board-level information and does not include details about lists or cards within the boards.
</Accordion>

<Accordion title="Retrieve notification entities by id">
  Retrieves the entities associated with a specific trello notification. this endpoint allows you to fetch detailed information about the objects (such as boards, lists, cards, or members) that are related to or affected by a particular notification. it's useful when you need to gather more context about a notification or update your application's state based on the notification details. the endpoint should be used when you have a notification id and need to know what trello entities are involved in that notification. it will not provide information about notifications themselves, only the related entities.
</Accordion>

<Accordion title="Retrieve checklist checkitem by id">
  Retrieves detailed information about a specific check item within a particular checklist in trello. this endpoint is used when you need to access the properties of an individual task or subtask represented by a check item, such as its name, completion status, or position within the checklist. it's particularly useful for applications that need to display or process individual checklist items, for example, to show task progress or to update task details in an external system. this operation only fetches data and does not modify the check item or checklist. note that you must have appropriate permissions to access the specified checklist and its items.
</Accordion>

<Accordion title="Retrieve notification list by id">
  Retrieves the list associated with a specific trello notification. this endpoint allows you to fetch details about the list that is linked to a particular notification, providing context for the notification event. use this endpoint when you need to access information about the list where an action triggering a notification occurred. it's particularly useful for understanding the broader context of a notification, such as which list a card was moved to or where a comment was added. the endpoint returns data specific to the list and does not provide the full notification details or board information. keep in mind that access to this data may depend on the user's permissions within the trello workspace.
</Accordion>

<Accordion title="Retrieve label by id">
  Retrieves detailed information about a specific trello label using its unique identifier. this endpoint allows you to fetch the properties of a label, such as its name, color, and associated board. use this when you need to access or verify the details of a particular label within your trello workflow. the endpoint returns only the data for the specified label and does not provide information about other labels or the board structure. it's particularly useful for applications that need to display or process individual label information.
</Accordion>

<Accordion title="Retrieve member notifications by id">
  Retrieves notifications for a specific trello member. this endpoint allows you to fetch all notifications associated with the given member, including alerts about new comments, card movements, mentions, and other board activities. use this endpoint when you need to display or process a member's recent notifications, such as for creating a notification center or syncing member activities across platforms. the endpoint returns notifications in reverse chronological order, with the most recent notifications first. note that this endpoint may be subject to rate limiting and pagination for members with a large number of notifications.
</Accordion>

<Accordion title="Get member field by id">
  The getmemberfield endpoint retrieves a specific attribute or property of a trello member. it allows you to fetch granular information about a user without retrieving their entire profile. this endpoint is particularly useful when you need only a single piece of information about a member, such as their full name, username, or a custom field value. it can be used to efficiently update or display specific member details in your application. however, it's important to note that this endpoint will only return the value of the requested field and not provide any additional context or related information about the member.
</Accordion>

<Accordion title="Retrieve board field by label id">
  Retrieves a specific field of a board associated with a given label in trello. this endpoint is useful when you need to access particular information about a board that is linked to a certain label, without fetching all board data. it can be used for quick lookups of board properties based on label associations, which is helpful for organizing and filtering board information. the endpoint is particularly efficient when you only need one piece of information about the board, rather than its entire data structure. however, it's important to note that this endpoint will only return data for boards that are actually associated with the specified label; if no such association exists, the response may be empty or return an error.
</Accordion>

<Accordion title="Get board from label id">
  Retrieves detailed information about the trello board associated with a specific label. this endpoint allows you to find out which board a particular label belongs to, which is useful for organizing and managing labels across multiple boards. use this when you need to trace a label back to its source board or when you want to understand the context of a label within the broader trello workspace. the endpoint returns comprehensive board data, including its name, url, members, and other relevant details. it's particularly helpful for applications that need to manage or analyze label usage across different boards in a trello workspace.
</Accordion>

<Accordion title="Get type by id">
  Retrieves detailed information about a specific trello type using its unique identifier. this endpoint allows developers to fetch the characteristics and properties of various trello object types, such as boards, lists, or cards. it's useful when you need to understand the structure or capabilities of a particular trello type, which can be essential for working with trello's data model or implementing type-specific features in your application. the endpoint returns only the type information and does not provide instance-specific data or content related to individual trello objects.
</Accordion>

<Accordion title="Get member notifications by id and filter">
  Retrieves filtered notifications for a specific trello member. this endpoint allows users to fetch notifications based on a specified filter, enabling targeted information retrieval about updates, changes, or activities relevant to the member. it's particularly useful for staying informed about specific aspects of trello boards, lists, or cards that the member is involved with. the endpoint should be used when needing to access a member's notifications with custom filtering, but it won't provide real-time updates or modify the notification status.
</Accordion>

<Accordion title="Get deltas for member id">
  Retrieves a list of all changes (deltas) made by a specific trello member. this endpoint allows you to track the history of updates and modifications a particular user has made across trello boards, lists, and cards they have access to. it's useful for auditing user activity, understanding workflow patterns, or syncing changes with external systems. the endpoint returns a chronological list of delta objects, each representing a distinct change made by the member. it should be used when you need a comprehensive view of a user's actions within trello. note that this endpoint may not provide real-time updates and there might be a slight delay in reflecting the most recent changes.
</Accordion>

<Accordion title="Get member boards with filter">
  Retrieves a filtered list of boards associated with a specific trello member. this endpoint allows you to fetch boards based on various criteria such as their status (open, closed), visibility (public), organizational association, or member's relationship to the board (starred, invited). it's particularly useful for applications that need to display or manage a subset of a member's boards, enabling more focused and efficient data retrieval. the endpoint requires the member's unique identifier and a filter parameter to customize the query. it should be used when you need to access or display a specific category of boards for a given trello user, rather than fetching all boards indiscriminately.
</Accordion>

<Accordion title="Retrieve cards by member id">
  Retrieves all cards associated with a specific trello member across all boards they have access to. this endpoint is useful for getting a comprehensive view of a member's tasks and responsibilities, regardless of which boards the cards are on. it can be used to create personal task lists, track workload, or analyze a member's contribution across multiple projects. the endpoint returns card details such as title, description, due dates, and board/list information, but does not include comments or attachments. use this when you need to aggregate all of a member's cards in one api call, rather than fetching cards board by board.
</Accordion>

<Accordion title="Get member by id">
  Retrieves detailed information about a specific trello member. this endpoint allows you to access a member's profile data, including their username, full name, initials, avatar, and other public information associated with their trello account. it's useful when you need to display member details in your application or verify a member's identity. the endpoint provides read-only access to member information and should be used when you require up-to-date data about a particular trello user. note that this endpoint may not return sensitive or private information, and the level of detail in the response may depend on the authentication and permissions of the requesting user.
</Accordion>

<Accordion title="Retrieve organization details by id">
  Retrieves detailed information about a specific trello organization. this endpoint allows you to fetch comprehensive data about an organization, including its name, description, members, boards, and other relevant attributes. use this endpoint when you need to access or display organization-level information within your application or workflow. it's particularly useful for scenarios where you need to verify organization details, list associated boards, or manage organization-wide settings. note that this endpoint only provides read access to the organization data and does not allow modifications.
</Accordion>

<Accordion title="Update board prefs permission level">
  Updates the permission level preference for a specific trello board. this endpoint allows you to change the visibility of a board between private and public settings. use this when you need to modify the access control of a board, either to restrict access to invited members only (private) or to make it visible to anyone with the link (public). this operation is particularly useful when the collaboration needs of a project change, requiring either increased privacy or broader visibility. note that changing a board to public may have significant implications for data visibility and should be done with caution.
</Accordion>

<Accordion title="Update purple label name">
  Updates the name of the purple label on a specific trello board. this endpoint allows you to customize the purple label's name to better fit your project's needs or organizational system. use this when you want to change how the purple label is displayed across all cards on a particular board. this action affects only the purple label and does not modify other color labels or any other board properties. the new label name will be immediately reflected on all cards using the purple label on the specified board.
</Accordion>

<Accordion title="Get cards from list by id">
  Retrieves all cards within a specified trello list. this endpoint allows users to fetch detailed information about cards in a particular list, providing a comprehensive view of tasks or items within that list. it's particularly useful for applications that need to synchronize trello data, build custom views of trello boards, or perform bulk operations on cards within a specific list. the endpoint returns an array of card objects, each containing details such as the card's name, description, due date, and any custom fields. use this endpoint when you need to get an up-to-date snapshot of all cards in a list, but note that it doesn't provide real-time updates or webhook functionality for card changes.\<\<DEPRECATED use get\_lists\_cards\_by\_id\_list>>
</Accordion>

<Accordion title="Get member boards with filter">
  Retrieves a filtered list of boards associated with a specific trello member. this endpoint allows you to fetch boards based on various criteria such as their status (open, closed), visibility (public), organizational association, or member's relationship to the board (starred, invited). it's particularly useful for applications that need to display or manage a subset of a member's boards, enabling more focused and efficient data retrieval. the endpoint requires the member's unique identifier and a filter parameter to customize the query. it should be used when you need to access or display a specific category of boards for a given trello user, rather than fetching all boards indiscriminately.\<\<DEPRECATED use get\_members\_boards\_by\_id\_member\_by\_filter>>
</Accordion>

<Accordion title="Update board prefs invitations">
  Updates the invitation preferences for a specific trello board. this endpoint allows you to control who can invite new members to the board by setting the 'value' parameter to either 'admins' or 'members'. use this when you need to restrict or expand invitation privileges on a board. for example, set it to 'admins' to limit invitations to board administrators only, or 'members' to allow all board members to invite others. this setting affects the entire board and may impact team collaboration dynamics.
</Accordion>

<Accordion title="Retrieve list by id">
  Retrieves detailed information about a specific trello list using its unique identifier. this endpoint allows you to fetch the properties and metadata of a single list, such as its name, associated board, position on the board, and whether it's archived. use this endpoint when you need to access or verify the current state and details of a particular list in your trello workflow. it's particularly useful for applications that need to display list information, check list status, or prepare for operations on the list. note that this endpoint only provides information about the list itself and does not return the cards contained within the list.\<\<DEPRECATED use get\_lists\_by\_id\_list>>
</Accordion>

<Accordion title="Add new list to board">
  Creates a new list within a specified trello board. this endpoint allows users to add a custom list to their board, optionally copying from an existing list, setting its position, and defining its initial state. it's particularly useful for organizing tasks, creating new workflow stages, or expanding board structure. the new list can be created open or closed, and the creating user can choose to subscribe to it for notifications. this tool should be used when setting up new projects, restructuring workflows, or expanding existing boards. it doesn't modify existing lists or move cards between lists.\<\<DEPRECATED use add\_lists>>
</Accordion>

<Accordion title="Delete checklist item">
  Deletes a specific check item from a checklist within a trello card. this endpoint allows for the removal of individual tasks or items from a checklist, helping to manage and organize the progress of a card. it should be used when a task is no longer relevant, has been completed and needs to be removed, or was added by mistake. the operation is permanent and cannot be undone through the api, so it should be used with caution. this endpoint is particularly useful for automating task management workflows or cleaning up completed items in a checklist.
</Accordion>

<Accordion title="Update card sticker attributes">
  Updates the attributes of a specific sticker on a trello card. this endpoint allows you to modify various properties of an existing sticker, including its image, position, rotation, and layer order. use this when you need to adjust the appearance or layout of stickers on a card, such as repositioning, changing the image, or altering the stacking order. the endpoint requires the unique identifiers for both the card and the sticker. it's important to note that while some parameters are typed as strings, they may represent numeric values (e.g., for positioning or rotation). this endpoint is particularly useful for fine-tuning the visual organization of card information in trello boards.
</Accordion>

<Accordion title="Update card subscribed status">
  This endpoint allows users to update the subscription status for a specific trello card. by subscribing to a card, users can receive notifications about any changes or updates made to that card, such as comments, attachments, or movements between lists. this is particularly useful for staying informed about important tasks or collaborating effectively with team members. the endpoint should be used when a user wants to start or stop receiving notifications for a particular card. it's important to note that this endpoint only toggles the subscription status and does not affect the card's content or position within a board or list.
</Accordion>

<Accordion title="Get member boards by id">
  Retrieves all boards associated with a specific trello member. this endpoint allows you to fetch a comprehensive list of boards that the member has access to, including boards they own, are members of, or have been invited to. it's particularly useful for applications that need to display or work with a user's trello boards, such as for data synchronization, board management, or creating board-related features. the response typically includes details like board ids, names, and other metadata. use this endpoint when you need to get an overview of a member's trello workspace or when implementing board selection features in your application. note that it only provides board-level information and does not include details about lists or cards within the boards.\<\<DEPRECATED use get\_members\_boards\_by\_id\_member>>
</Accordion>

<Accordion title="Update card position">
  Updates the position of a specific trello card within its current list. this endpoint allows you to move a card to the top, bottom, or a specific position in its list, helping to reorganize tasks and priorities. use this when you need to change the order of cards in a list without changing the list itself. the new position is specified using either keywords ('top', 'bottom') or a numeric value, providing flexibility in card arrangement. this operation is particularly useful for reordering tasks, adjusting priorities, or maintaining a specific workflow sequence within a trello board.
</Accordion>

<Accordion title="Fetch board for list id">
  Retrieves the board information associated with a specific trello list. this endpoint allows you to fetch details about the board to which a particular list belongs. it's useful when you need to understand the context or parent board of a list, especially in scenarios where you're working with list ids and need to know their associated boards. this can be helpful for navigation, organization, or when you need to perform operations that require board-level information. the endpoint returns board details, which may include the board's name, description, preferences, and other relevant metadata. use this when you have a list id and need to find out which board it's on, or when you need to access board-level information starting from a list.\<\<DEPRECATED use get\_lists\_board\_by\_id\_list>>
</Accordion>

<Accordion title="Update board label orange name">
  Updates the orange label name for a specific trello board. this endpoint allows you to customize the name of the orange label, which can be used to categorize and prioritize cards on the board. the new label name can be any string up to 16384 characters, including an empty string to remove the current name. use this when you need to modify the orange label's meaning or purpose for a particular board, enhancing your team's organization and workflow. note that this only updates the name of the orange label and does not affect any cards currently using this label.
</Accordion>

<Accordion title="Update board prefs self join">
  This endpoint allows you to update the "selfjoin" preference for a specific trello board. the "selfjoin" preference determines whether users can join the board on their own or if they need an invitation. when set to 'true', users can join the board without an invitation, while 'false' requires an invitation from a board admin. this is particularly useful for managing access control and collaboration settings on your trello boards. use this endpoint when you need to change the board's accessibility, either opening it up for self-joining or restricting access to invite-only.
</Accordion>

<Accordion title="Retrieve webhook field by id">
  Retrieves a specific field of a trello webhook. this endpoint allows you to fetch individual pieces of information about a webhook without retrieving its entire data structure. it's useful for quickly checking or verifying specific webhook properties, such as its callback url, associated model id, or active status. the endpoint should be used when you need to access or validate a particular attribute of a webhook without the overhead of fetching all of its details. note that this endpoint doesn't modify the webhook; it only retrieves information.
</Accordion>

<Accordion title="Update my prefs show sidebar board actions">
  Updates the "show sidebar board actions" preference for a specific trello board. this endpoint allows users to customize their board view by choosing whether to display or hide board actions in the sidebar. it's particularly useful for managing the visual clutter on a board, especially for boards with high activity. the preference is user-specific, meaning each board member can have their own setting without affecting others. use this endpoint when a user wants to change their personal view of the board's sidebar actions.
</Accordion>

<Accordion title="Update lists closed status">
  Updates the closed status of a specific trello list. this endpoint allows you to close or reopen a list within a trello board by setting its 'closed' attribute. use this when you need to archive a list (by closing it) or restore a previously closed list (by reopening it). this action helps in organizing and managing the visibility of lists on a trello board. note that closing a list doesn't delete it or its cards; it simply hides the list from the main board view. closed lists can be viewed in the board menu and can be reopened at any time.
</Accordion>

<Accordion title="Update list attributes">
  Updates the attributes of an existing trello list identified by its unique id. this endpoint allows for modifying various aspects of a list, including its name, position on the board, closed status, board association, and subscription status. it can also be used to copy content from another list. this tool is particularly useful for reorganizing boards, managing list visibility, and maintaining up-to-date list information. it provides granular control over list properties, allowing for partial updates where only specified attributes are modified.
</Accordion>

<Accordion title="Update checklist item position">
  Updates the position of a specific check item within a checklist on a trello card. this endpoint allows you to reorder check items by moving them to the top, bottom, or a specific position within the checklist. it's useful for prioritizing tasks or reorganizing workflow steps. the update is applied immediately, affecting the order of items as seen by all users with access to the card. use this when you need to change the order of tasks in a checklist without modifying their content or completion status.
</Accordion>

<Accordion title="Update list position">
  Updates the position of a specific trello list within its board. this endpoint allows you to reorder lists by moving them to the top, bottom, or a specific position on the board. it's useful for reorganizing workflows, prioritizing certain lists, or maintaining a specific order of task stages. the new position is specified using the 'value' parameter, which accepts 'top', 'bottom', or a positive number as a string. note that this endpoint only changes the list's position and does not modify any other attributes of the list or its contents.
</Accordion>

<Accordion title="Update list board id">
  This endpoint updates the board association and position of a specific trello list. it allows you to move a list from one board to another and set its position on the new board. this is particularly useful for reorganizing workflows, transferring task lists between projects, or restructuring boards. the endpoint requires the list id, the new board id, and optionally, the desired position on the new board. it's important to note that this operation can significantly impact the organization of tasks and should be used carefully, especially in collaborative environments.
</Accordion>

<Accordion title="Update my prefs sidebar visibility">
  Updates the user's preference for showing or hiding the sidebar on a specific trello board. this endpoint allows users to customize their board view by toggling the sidebar visibility. it should be used when a user wants to change their personal sidebar display preference for a particular board. the change only affects the current user's view and does not impact other team members' preferences. this tool is useful for users who want to maximize their workspace or prefer a cleaner board interface.
</Accordion>

<Accordion title="Update list name attribute">
  This endpoint allows you to update the name of a specific trello list. it's used when you need to rename a list, perhaps due to changes in project scope, team reorganization, or simply to correct a typo. the endpoint accepts the list's unique identifier and the new name as parameters. it's important to note that while this operation changes the list's name, it doesn't affect the cards within the list or its position on the board. use this endpoint when you need to quickly update a list's name without making any other changes to its contents or location.
</Accordion>

<Accordion title="Update card checklist item attributes">
  Updates a specific check item within a checklist on a trello card. this endpoint allows for modifying various attributes of a check item, including its name, position, completion state, and even moving it to a different checklist on the same card. it's useful for task management and progress tracking within trello cards. the endpoint requires the ids of the card, current checklist, and check item to be updated, which should be provided in the url path. only the attributes that need to be changed should be included in the request body, allowing for partial updates.
</Accordion>

<Accordion title="Update label attributes">
  This endpoint allows you to update the attributes of an existing trello label. it can be used to modify the color, name, or board association of a label. the endpoint is particularly useful when you need to reorganize your trello boards, refine your labeling system, or simply make changes to existing labels. you can update any combination of the label's color, name, or board association in a single request. note that all parameters are optional, allowing for partial updates. if a parameter is not included in the request, that attribute of the label will remain unchanged. this endpoint should not be used to create new labels or to delete existing ones, as separate endpoints exist for those operations.
</Accordion>

<Accordion title="Update cards board attributes">
  Updates the board of a trello card, effectively moving the card to a different board and list. this endpoint is used when you need to transfer a task or item (represented by a card) from one project or workflow (board) to another. it allows for reorganizing work across different contexts while maintaining the task's details. the operation requires specifying both the target board and the specific list within that board where the card should be placed. this ensures that the card is properly categorized in its new location. use this endpoint when you need to shift priorities, reassign tasks to different teams, or reorganize your workflow structure. note that moving a card to a new board may affect integrations or automations tied to the original board, so use with caution in automated workflows.
</Accordion>

<Accordion title="Update list subscribed attributes">
  Updates the subscription status of a specified trello list. this endpoint allows users to subscribe to or unsubscribe from a list, controlling whether they receive notifications about changes to that list. it's useful for managing notification preferences on a per-list basis, helping users stay informed about relevant updates while avoiding unnecessary notifications. the endpoint should be used when a user wants to change their subscription status for a specific list, either to start receiving updates or to stop receiving them.
</Accordion>

<Accordion title="Delete member custom board background">
  Deletes a specific custom board background for a trello member. this endpoint allows you to remove a personalized background image that a member has previously uploaded or set for their trello boards. use this when a member wants to remove a custom background from their available options. the deletion is permanent and cannot be undone, so it should be used with caution. this operation only affects the specified background for the given member and does not impact other members or default trello backgrounds.
</Accordion>

<Accordion title="Update board label name red">
  Updates the name or text associated with the red label on a specific trello board. this endpoint allows users to customize the red label's text to better categorize and organize cards on their board. it's particularly useful when you want to give more meaningful names to color-coded labels, enhancing visual organization and filtering capabilities. the update is applied immediately, affecting all cards that use the red label on the specified board. this endpoint should be used when you need to change the red label's text without altering its color or creating a new label. note that this operation only affects the red label and does not impact other color labels on the board.
</Accordion>

<Accordion title="Update card checkitem name">
  This endpoint updates the name of a specific check item within a checklist on a trello card. it allows users to rename individual tasks or items in their checklists, providing better organization and clarity for their project management. the endpoint requires the unique identifiers for the card, checklist, and check item, ensuring precise targeting of the item to be renamed. it's useful for maintaining up-to-date and accurate task descriptions within trello boards, especially when project requirements or task details change over time.
</Accordion>

<Accordion title="Update yellow label name on board">
  This endpoint updates the name of the yellow label on a specific trello board. it allows users to customize the yellow label's text to better categorize and organize their cards. the endpoint should be used when you need to change the display text for the yellow label on a particular board, either to give it a more meaningful name or to remove its current name. it's important to note that this operation only affects the yellow label and doesn't modify other color labels on the board. the new label name can be up to 16384 characters long, providing flexibility for detailed labeling, but it can also be set to an empty string to remove the current name.
</Accordion>

<Accordion title="Update card cover attachment id">
  Updates the cover image of a specific trello card using an existing attachment. this endpoint allows you to change the visual appearance of a card by setting one of its attachments as the cover or removing the cover entirely. use this when you want to highlight important information or make a card more visually distinctive within a trello board. the cover image can help team members quickly identify and prioritize cards. note that this operation only works with attachments that already exist on the card; it cannot add new attachments or use images not associated with the card.
</Accordion>

<Accordion title="Update member avatar source">
  Updates the avatar source for a specific trello member. this endpoint allows you to change how a member's avatar is displayed by specifying the source of the avatar image. it's useful for customizing a member's profile appearance or removing an existing avatar. the endpoint should be used when you need to programmatically manage a member's avatar settings, such as during user onboarding or profile updates. note that setting the value to 'upload' doesn't actually upload a new image; it only indicates that a custom upload should be used if available. to upload a new avatar image, you would need to use a separate endpoint (not specified in this schema).
</Accordion>

<Accordion title="Update member bio">
  Updates the bio of a specified trello member. this endpoint allows you to modify the personal or professional description associated with a member's profile. it's particularly useful for maintaining up-to-date information about team members within a trello workspace. the bio can be used to provide context about a member's role, expertise, or any other relevant information that helps in team collaboration. this endpoint should be used when there's a need to change or refresh a member's bio information. note that while the bio can be set to an empty string, it has a maximum length of 16,384 characters, allowing for quite detailed descriptions if needed.
</Accordion>

<Accordion title="Update members board stars id board">
  This endpoint updates the board associated with a specific board star for a trello member. it allows you to change which board a member has starred by providing a new board id. this is useful for reorganizing a member's starred boards or correcting mistakenly starred boards. the endpoint takes the member id and board star id as path parameters, and requires the new board id in the request body. use this when a user wants to move their star from one board to another without removing and re-adding the star. note that this operation doesn't create new board stars or affect the member's permissions on either the old or new board; it only updates the existing star's board association.
</Accordion>

<Accordion title="Get token member">
  Retrieves detailed information about the trello member associated with the provided api token. this endpoint allows you to access the profile data of the authenticated user, including their username, full name, initials, and other relevant account details. it's particularly useful when you need to verify the identity of the token owner or gather user-specific information for personalization purposes. the endpoint should be used when you need to retrieve up-to-date information about the authenticated trello user. note that this endpoint only provides information about the member linked to the given token and does not offer data about other trello users or board members.\<\<DEPRECATED use get\_tokens\_member\_by\_token>>
</Accordion>

<Accordion title="Update card member ids">
  Updates the members of a specific trello card by adding a new member. this endpoint allows you to assign a user to a card, which is essential for task allocation and team collaboration within trello boards. use this when you need to add a team member to a specific task or card in your trello workflow. the endpoint accepts a single member id at a time, so multiple calls may be necessary to add several members to the same card. note that this operation adds a member to the card's existing member list; it does not replace or remove other members already assigned to the card.
</Accordion>

<Accordion title="Update card list id">
  Updates the list assignment of a specific trello card. this endpoint allows you to move a card from one list to another within the same board. it's particularly useful for updating the status or progress of a task represented by the card. the operation is idempotent, meaning that moving a card to its current list will not cause any changes. this endpoint should be used when you need to programmatically update the position of a card in your trello workflow. it's important to note that this operation only changes the list assignment and does not modify any other attributes of the card.
</Accordion>

<Accordion title="Search endpoint">
  The searchtrello endpoint allows users to perform a comprehensive search across their trello workspace, including boards, cards, and lists. it's designed to help users quickly find specific items or information within their trello ecosystem. this endpoint is particularly useful when you need to locate content across multiple boards or when you're unsure which board contains the information you're seeking. the search functionality is versatile, matching keywords in titles, descriptions, and other text fields of trello objects. while it provides a powerful way to find information, it's important to note that the search results are limited to the user's accessible trello content and may not include recently created or modified items due to indexing delays.\<\<DEPRECATED use get\_search>>
</Accordion>

<Accordion title="Update members board star attributes">
  Updates the attributes of a specific board star for a trello member. this endpoint allows you to modify which board is starred or adjust the position of the star in the member's list of starred boards. use this when a user wants to change their board star preferences, such as re-ordering their starred boards or starring a different board in place of an existing star. the endpoint requires the member's id and the specific board star id to be updated. you can change the associated board by providing a new board id and adjust the star's position using the 'pos' parameter. this operation directly modifies the user's board star settings, so use it judiciously based on user intent.
</Accordion>

<Accordion title="Update label color by id">
  This endpoint allows you to update the color of a specific trello label. it is used when you need to change the visual appearance of a label on trello cards and boards. the endpoint takes the label id as a path parameter and accepts a json payload with the new color value. you can use this to categorize or prioritize cards more effectively by adjusting their label colors. it's important to note that setting the color to null will remove the color from the label, essentially making it a text-only label. this endpoint should be used for single label color updates; for bulk updates, consider using batch api calls if available.
</Accordion>

<Accordion title="Update member s board star position">
  Updates the position of a specific board star for a trello member. this endpoint allows you to change the order of starred boards in a member's list of favorites. use this when a member wants to reorganize their starred boards, prioritizing certain boards by moving them up or down in the list. the position can be set to predefined values like 'top' or 'bottom', or a specific numerical position. this operation only affects the order of starred boards for the specified member and does not impact the board itself or its visibility to other members.
</Accordion>

<Accordion title="Update member attributes by id">
  Updates the attributes of a specified trello member. this endpoint allows modification of various profile settings and preferences for a user, including their avatar source, biography, full name, initials, color blind mode, locale, notification frequency, and username. it's particularly useful for allowing users to customize their trello experience or for administrators to manage user profiles. the endpoint requires the member's id and accepts multiple optional parameters to update different aspects of the member's profile. note that some attributes, like username, have specific constraints and changing them may affect how the user interacts with or is identified within trello.
</Accordion>

<Accordion title="Put my prefs show sidebar members">
  Updates the user's preference for showing or hiding sidebar members on a specific trello board. this endpoint allows users to customize their view of the board by controlling the visibility of the member list in the sidebar. it should be used when a user wants to change their personal setting for displaying board members. this preference is specific to the authenticated user and does not affect other board members' views. the change takes effect immediately and persists across sessions until changed again.
</Accordion>

<Accordion title="Update board membership attributes">
  Updates the attributes of a specific membership for a trello board. this endpoint allows you to modify a user's role on a board or retrieve specific member information. it's particularly useful for changing a member's permissions or accessing detailed member data within the context of a board. the endpoint requires the board id and membership id to be specified in the url path. use this when you need to promote or demote a user's role on a board, or when you need to fetch customized member information. note that this endpoint doesn't add or remove members from a board; it only modifies existing memberships.
</Accordion>

<Accordion title="Update board name by id">
  Updates the name of a specific trello board. this endpoint allows you to change the title of an existing board, which is useful for renaming projects, updating team workspaces, or refining board organization. it should be used when you need to modify the name of a board without altering its content or structure. the endpoint requires the board's unique identifier (idboard) in the url path and accepts a new name value in the request body. note that this operation only affects the board's name and does not impact its members, lists, or cards.
</Accordion>

<Accordion title="Update member board backgrounds attributes">
  Updates the attributes of a specific board background for a trello member. this endpoint allows customization of a member's board background, including its brightness, image file, and tiling option. use this when a user wants to modify the visual appearance of their trello board background. the endpoint is particularly useful for enhancing the user experience by allowing personalized board aesthetics. note that this operation modifies an existing board background and does not create a new one. ensure that the member has the necessary permissions to modify board backgrounds before using this endpoint.
</Accordion>

<Accordion title="Update member initials">
  This endpoint allows you to update the initials of a specified trello member. it is used when you need to change or set a member's initials, which are often displayed as a visual representation of the user in various trello interfaces. the update is performed by sending a put request to the '/members/\{idmember}/initials' endpoint with the new initials value. this tool is particularly useful for maintaining accurate and up-to-date member information, especially after name changes or when customizing user representations. note that the new initials must adhere to specific formatting rules: they must be between 1 and 4 characters long and cannot start or end with a space.
</Accordion>

<Accordion title="Update board members attributes">
  Updates the attributes of a specific member on a trello board. this endpoint allows you to modify a member's email address, full name, and role (type) associated with a particular board. use this when you need to change a member's information or adjust their permissions on the board. it's particularly useful for administrative tasks such as updating contact information or changing a member's role. note that this endpoint only affects the member's attributes for the specified board and does not modify their global trello account settings. be cautious when changing member roles, as it directly impacts their access and capabilities on the board.
</Accordion>

<Accordion title="Update member full name by id">
  Updates the full name of a specified trello member. this endpoint allows you to change the display name of a user in the trello system. it should be used when a member's name needs to be corrected, updated due to a legal name change, or adjusted for any other valid reason. the endpoint requires the member's unique identifier and the new full name value. it's important to note that this operation only updates the full name and does not affect other profile information. be cautious when using this endpoint, as it directly modifies a user's identifying information.
</Accordion>

<Accordion title="Update label name">
  This endpoint allows you to update the name of a specific label in trello. it is used when you need to rename a label to better reflect its purpose or categorization. the endpoint requires the unique identifier of the label and the new name you want to assign to it. it's particularly useful for maintaining organized and descriptive labels across your trello boards. keep in mind that while you can set an empty name, this doesn't delete the label itself, only its text. this operation only affects the name attribute of the label and doesn't modify other properties like color or visibility.
</Accordion>

<Accordion title="Modify member prefs locale">
  Updates the locale preference for a specific trello member. this endpoint allows you to change the language and regional settings for a user's trello interface. use this when a member wants to switch their trello experience to a different language or adapt it to their local region. the change affects how dates, times, and other localized content are displayed for the user. note that this update only affects the user interface language and regional settings; it does not translate existing content within boards or cards.
</Accordion>

<Accordion title="Update card label attributes">
  Updates the attributes of labels on a specific trello card. this endpoint allows you to modify the color, name, and scope of labels associated with a card, enabling better organization and visual categorization of tasks. use this when you need to change the appearance or description of labels on a card, or when you want to update multiple labels at once. the endpoint is particularly useful for bulk updates or when synchronizing label information from external systems. note that this operation will override existing label attributes, so care should be taken to include all desired label information in the request.
</Accordion>

<Accordion title="Update member saved search attributes">
  Updates a specific saved search for a trello member. this endpoint allows you to modify the attributes of an existing saved search, including its name, position in the list of saved searches, and the actual query string. it's useful for refining search criteria, reorganizing saved searches, or updating search names to reflect changes in projects or workflows. the endpoint requires the member id and the saved search id to be specified in the url path. only the fields you want to update need to be included in the request body, allowing for partial updates. this tool should be used when a user needs to modify an existing saved search rather than creating a new one or when the search criteria or organization needs to be adjusted over time to match evolving project needs.
</Accordion>

<Accordion title="Update member prefs color blind">
  Updates the color blind preference for a specific trello member. this endpoint allows you to enable or disable the color blind mode, which adjusts the color scheme of trello boards and cards for better visibility for users with color vision deficiencies. use this endpoint when a member needs to change their accessibility settings for improved usability. the change takes effect immediately across all of the member's trello boards and interfaces. note that this preference is specific to the individual member and does not affect other users or the overall appearance of shared boards for other team members.
</Accordion>

<Accordion title="Update members saved searches position">
  This endpoint updates the position of a specific saved search within a trello member's list of saved searches. it allows for reordering saved searches to prioritize frequently used ones or organize them according to the member's preference. the endpoint should be used when a member wants to change the order of their saved searches, either by moving a search to the top or bottom of the list, or by specifying a numeric position. this operation is particularly useful for members who have multiple saved searches and want to optimize their workflow by having their most important or frequently used searches easily accessible. note that this endpoint only updates the position of the saved search and does not modify any other attributes of the search or the member's profile.
</Accordion>

<Accordion title="Update member minutes between summaries prefs">
  Updates a trello member's preference for the frequency of summary notifications. this endpoint allows you to modify how often a user receives summary updates from trello. it's particularly useful for customizing a member's notification settings to match their workflow and information needs. the tool should be used when a user wants to change their summary notification frequency or disable summaries altogether. it's important to note that this setting only affects summary notifications and does not impact other types of trello notifications.
</Accordion>

<Accordion title="Update board member attributes">
  Updates the attributes of a specific member on a trello board. this endpoint allows you to modify a member's email address, full name, and role type (admin, normal, or observer) associated with a particular board. use this when you need to change a member's information or permissions without removing and re-adding them to the board. the update is applied only to the specified board and doesn't affect the member's global trello account settings. note that you must have appropriate permissions (typically admin) on the board to make these changes. this endpoint is useful for managing team members, adjusting roles, or updating contact information within a specific trello board context.
</Accordion>

<Accordion title="Update member savedsearch name">
  This endpoint allows you to update the name of a specific saved search for a trello member. it's used when a user wants to rename one of their existing saved searches, making it easier to organize and identify their frequently used search queries. the endpoint requires the member's id and the id of the saved search to be updated, both of which should be provided in the url path. this tool is particularly useful for maintaining an organized workspace in trello, especially for users who rely heavily on saved searches to quickly access specific sets of cards or boards. note that this feature is typically available only to paid trello subscribers, and updating a saved search name doesn't affect the search criteria itself, only its identifier.
</Accordion>

<Accordion title="Update member username">
  Updates the username of a specific trello member. this endpoint allows you to change a member's username, which is used for identification and mentions within trello. the new username must comply with trello's naming conventions, including length and character restrictions. use this endpoint when a member needs to change their username, but be aware that the new username must be unique across all trello users. this operation may affect how the user appears in boards, cards, and notifications, so use it cautiously.
</Accordion>

<Accordion title="Update actions attributes by id">
  This endpoint allows you to update the attributes of a specific trello action, particularly its text content. it is used when you need to modify the description or details of an existing action, such as editing a comment or updating activity details. the endpoint accepts a put request with the action's unique identifier in the url and the new text content in the request body. it's important to note that this endpoint only updates the text of the action and cannot be used to change other properties or to create new actions. the updated text must adhere to the length constraints specified in the schema.
</Accordion>

<Accordion title="Modify cards name">
  Updates the name of a specific trello card. this endpoint allows you to modify the title of an existing card, which is useful for renaming tasks, updating project status, or refining card descriptions. use this when you need to change a card's name without altering its other attributes or position. the new name must be between 1 and 16384 characters long, providing flexibility for both short labels and detailed titles. note that this operation only affects the card's name; other properties like description, due date, or attachments remain unchanged.
</Accordion>

<Accordion title="Update notifications status by id">
  This endpoint updates the read status of a specific trello notification. it allows users to mark a notification as read or unread, which is essential for managing notification states and keeping track of important updates. the endpoint should be used when a user interacts with a notification, such as viewing it or deciding to keep it unread for later review. it's particularly useful for applications that need to sync notification states between trello and external systems. note that this endpoint only updates the 'unread' status and cannot modify other attributes of the notification.
</Accordion>

<Accordion title="Modify board email position preference">
  Updates the email position preference for a specific trello board. this endpoint allows you to set where new cards created via email integration will be placed within their designated list. use this when you want to change how email-generated cards are organized on your board. the setting affects all future email-to-board cards but does not reorganize existing cards. this tool is particularly useful for teams that frequently use email integration to create new tasks or items on their trello boards.
</Accordion>

<Accordion title="Update members board background attributes">
  Updates the attributes of a specific custom board background for a trello member. this endpoint allows for the modification of the background's brightness, file, and tiling options. it should be used when a member wants to change the appearance of their custom board background without creating a new one. this tool is particularly useful for personalizing the visual aspect of a trello board to suit individual preferences or improve visibility. note that this endpoint only modifies existing custom backgrounds and cannot be used to create new ones or apply changes across multiple boards.
</Accordion>

<Accordion title="Modify board prefs background">
  Updates the background preference for a specific trello board. this endpoint allows users to change the visual appearance of their board by setting a new background. the background can be either a standard option provided by trello or a custom background previously uploaded by the user. this tool is useful for personalizing the look of a board, which can help in organizing and categorizing different projects or workflows. it should be used when a user wants to refresh the appearance of their board or align it with a specific theme or branding. note that updating the background is a cosmetic change and does not affect the functionality or content of the board itself.
</Accordion>

<Accordion title="Get member by id">
  Retrieves detailed information about a specific trello member. this endpoint allows you to access a member's profile data, including their username, full name, initials, avatar, and other public information associated with their trello account. it's useful when you need to display member details in your application or verify a member's identity. the endpoint provides read-only access to member information and should be used when you require up-to-date data about a particular trello user. note that this endpoint may not return sensitive or private information, and the level of detail in the response may depend on the authentication and permissions of the requesting user.\<\<DEPRECATED use get\_members\_by\_id\_member>>
</Accordion>

<Accordion title="Modify notification read status">
  This endpoint allows you to update the unread status of a specific trello notification. it's used to programmatically mark a notification as read or unread, which can be helpful for managing notification states in integrations or automated workflows. the endpoint takes the notification's unique identifier and a boolean value to set its unread status. this tool is particularly useful for keeping trello notifications in sync with external systems or for bulk management of notification states. note that this endpoint only updates the unread status and does not modify any other attributes of the notification.
</Accordion>

<Accordion title="Update organization display name">
  Updates the display name of a specific trello organization. this endpoint allows you to change how an organization appears within trello, which is useful for rebranding, correcting typos, or updating the organization's name to reflect changes in the real world. the new name must be at least one character long and cannot start or end with a space. use this when you need to modify how an organization is presented across all trello boards and workspaces associated with it. note that this operation only affects the display name and does not alter any other organization attributes or its underlying structure.
</Accordion>

<Accordion title="Update board voting preferences">
  Updates the voting preferences for a specific trello board. this endpoint allows you to control who can vote on cards within the board by setting the voting permission level. use this when you need to change the board's voting access, such as restricting voting to members only or opening it up to the public. the change affects all cards on the board and can be useful for managing decision-making processes or gathering feedback from different groups. note that this endpoint only updates the voting preference and does not affect other board settings or permissions.
</Accordion>

<Accordion title="Update members saved searches query">
  Updates the query of a specific saved search for a trello member. this endpoint allows you to modify the search terms of an existing saved search without changing other attributes of the saved search. it's useful when you need to refine or adjust a frequently used search query. the endpoint requires the member's id and the saved search id as path parameters, and accepts a new query value in the request body. use this when a user wants to update their saved search criteria without creating a new saved search or altering other saved search properties.
</Accordion>

<Accordion title="Modify organization membership attributes">
  This endpoint updates the attributes of a user's membership within a trello organization. it allows for modifying specific member fields and changing the membership type, providing fine-grained control over user roles and information. use this endpoint when you need to adjust a member's details or permissions within an organization, such as promoting a user to admin status or updating their profile information. the endpoint requires the organization id and membership id to identify the specific membership to be updated. it's important to note that this endpoint only modifies existing memberships and cannot be used to create new ones or remove users from an organization.
</Accordion>

<Accordion title="Update card attributes">
  Updates an existing trello card with new attributes or modifications. this endpoint allows you to change various properties of a card, including its status, description, due date, attachments, board and list placement, labels, and assigned members. use this when you need to modify a card's details, move it between lists or boards, or update its metadata. the endpoint is versatile, allowing for partial updates, so you can specify only the fields you want to change. it's particularly useful for automating workflows, syncing card data with external systems, or bulk updating cards based on certain criteria. note that some updates, like changing the board or list, may affect the card's visibility and accessibility to team members.
</Accordion>

<Accordion title="Update board email list preference">
  Updates the email list preference for a specific trello board. this endpoint allows you to change the designated list where new cards created via email will be placed. use this when you want to modify the default location for email-generated cards on a particular board. the update affects the 'my prefs' settings of the board, specifically the 'id email list' attribute. this is particularly useful for managing workflow automation and ensuring that email-to-board integrations place new tasks in the desired list. note that this operation only changes the preference and does not affect existing cards or lists.
</Accordion>

<Accordion title="Update actions text value">
  Updates the text content of a specific trello action. this endpoint allows you to modify the text associated with an existing action, such as editing a comment or updating a description. it should be used when you need to correct, clarify, or expand upon the information in an action's text. the endpoint is particularly useful for maintaining accurate and up-to-date records of activities and communications within trello boards and cards. note that this operation only affects the text content and does not change other properties of the action or its relationships to cards, boards, or other trello elements.
</Accordion>

<Accordion title="Update board calendar feed enabled status">
  Updates the calendar feed enabled preference for a specific trello board. this endpoint allows you to enable or disable the calendar feed feature, which provides a calendar view of cards with due dates and allows for integration with external calendar applications. use this when you want to toggle the visibility of board tasks in calendar format or control the availability of the icalendar feed for the board. this operation is particularly useful for teams that rely on calendar views for project management or need to sync trello tasks with external calendar tools. note that enabling this feature may have privacy implications, as it potentially makes board data accessible through calendar feeds.
</Accordion>

<Accordion title="Update card checklist item state">
  Updates the state of a specific check item within a checklist on a trello card. this endpoint allows you to mark a check item as complete or incomplete, which is essential for tracking task progress within a card's checklist. use this when you need to update the status of a single task in a trello workflow. the endpoint is particularly useful for automating task updates or syncing task statuses with external systems. note that this operation only affects the state of the check item and does not modify other properties of the check item, checklist, or card.
</Accordion>

<Accordion title="Update organization attributes">
  This endpoint allows you to update various attributes and settings of a trello organization. use it to modify organization details, adjust visibility and permission settings, manage google apps integration, and control member access. the endpoint is particularly useful for organization administrators who need to fine-tune their trello workspace settings or update organization information. keep in mind that some changes, like modifying board visibility restrictions or disabling external members, can have significant impacts on collaboration within the organization. ensure you have the necessary permissions before making changes, as these updates can affect all members of the organization.
</Accordion>

<Accordion title="Update board subscription status">
  Updates the subscription status of a specific trello board for the authenticated user. this endpoint allows users to subscribe to or unsubscribe from a board, controlling whether they receive notifications for board activities. it's useful for managing notification preferences on a per-board basis, enabling users to stay informed about important boards while reducing noise from less relevant ones. the endpoint should be used when a user wants to change their subscription status for a particular board, either to start or stop receiving updates about board activities.
</Accordion>

<Accordion title="Update card action comment">
  This endpoint allows you to update the text of an existing comment on a specific trello card. it is used when you need to modify the content of a previously made comment, such as correcting information, adding details, or revising the message. the endpoint requires the unique identifiers for both the card and the specific comment (action) being updated, ensuring precise targeting of the comment to be changed. it's important to note that this endpoint only updates the text content of the comment and does not affect other attributes like timestamps or authorship. the updated text must adhere to trello's length restrictions for comments.
</Accordion>

<Accordion title="Update my prefs show list guide">
  Updates the "show list guide" preference for a specific trello board. this endpoint allows users to toggle the visibility of the list guide feature, which provides guidance and tips for using lists on the board. use this when you want to enable or disable the list guide for a particular board, helping to customize the board's appearance and user experience. the change applies immediately and affects all users who have access to the board. note that this preference is board-specific and does not affect other boards or global trello settings.
</Accordion>

<Accordion title="Update card closed status by id">
  This endpoint updates the closed status of a specific trello card. it allows you to mark a card as closed (completed) or open (active) by setting its 'closed' attribute. use this endpoint when you need to change the completion status of a task represented by a trello card. the operation is particularly useful for automating workflow processes, such as closing cards when tasks are finished or reopening them if further action is required. note that closing a card doesn't delete it or move it to the archive; it simply marks it as completed within its current list. this endpoint should be used judiciously as it directly affects the visible state of cards on trello boards.
</Accordion>

<Accordion title="Update board closed status">
  Updates the closed status of a specified trello board. this endpoint allows you to either close an active board or reopen a closed board by setting the 'value' parameter to 'true' or 'false' respectively. use this when you need to archive a completed project or bring back a previously closed board for further use. it's important to note that closing a board doesn't delete it, but rather makes it inactive and inaccessible for normal operations. this action can be reversed by using the same endpoint to reopen the board.
</Accordion>

<Accordion title="Update card description">
  Updates the description of a specific trello card. this endpoint allows you to modify or set the detailed text description of a card, providing more context or information about the task or item represented by the card. use this when you need to add, edit, or remove explanatory text for a card. the update replaces the entire existing description, so include all desired content in the request. this endpoint is particularly useful for automating workflows, synchronizing card details with external systems, or programmatically managing card information.
</Accordion>

<Accordion title="Update board card aging preferences">
  Updates the card aging preference for a specific trello board. this endpoint allows users to toggle between 'pirate' and 'regular' card aging modes, which visually represent card inactivity on the board. use this when you want to change how inactive cards are displayed, either for better visibility or to align with team preferences. the change affects all cards on the specified board. note that this endpoint only modifies the card aging setting and does not impact other board preferences or card contents.
</Accordion>

<Accordion title="Update checklist position by id">
  Updates the position of a specific checklist within a trello card. this endpoint allows you to reorder checklists by moving them to the top, bottom, or a specific position within the card. use this when you need to prioritize or reorganize checklists on a card. the new position is specified using either keywords ('top', 'bottom') or a numeric value, providing flexibility in organizing your workflow. note that this operation only changes the checklist's position and does not modify its contents or other attributes.
</Accordion>

<Accordion title="Modify board prefs card covers">
  This endpoint updates the card covers preference for a specific trello board. it allows you to enable or disable the display of card covers, which are visual elements (images or colors) shown on the front of trello cards. use this endpoint when you want to change the appearance of cards across an entire board, either to show more visual information at a glance or to create a more streamlined view. the change affects all users viewing the board. note that this update only controls the visibility of existing card covers; it does not add or remove cover images from individual cards.
</Accordion>

<Accordion title="Update organization description by id">
  Updates the description of a specified trello organization. this endpoint allows you to modify the textual description associated with an organization, providing more context or information about its purpose, goals, or any other relevant details. use this when you need to change or refresh the description of an organization to better reflect its current state or focus. the new description can be up to 16384 characters long, allowing for detailed information, but it can also be set to an empty string if no description is needed.
</Accordion>

<Accordion title="Update board description">
  Updates the description of a specified trello board. this endpoint allows you to modify the textual description of a board, providing context or information about its purpose and contents. use this when you need to add, change, or remove explanatory text for a board. the update is immediate and will be visible to all board members. keep in mind that while you can set an empty description, a well-crafted description can significantly improve board organization and team communication. this endpoint does not affect any other board properties or contents such as lists, cards, or members.
</Accordion>

<Accordion title="Update checklist attributes">
  Updates the attributes of an existing trello checklist. this endpoint allows you to modify various properties of a checklist, including its associated board, card, name, and position. you can also use it to copy items from another checklist. use this endpoint when you need to change the details of a checklist, move it to a different card or board, rename it, reorder it, or populate it with items from another checklist. this is particularly useful for reorganizing tasks, updating project structures, or duplicating checklists across different cards or boards. the endpoint requires the id of the checklist to be updated, which should be provided in the url path.
</Accordion>

<Accordion title="Update checklist name">
  Updates the name of a specific trello checklist. this endpoint allows you to modify the name of an existing checklist within a trello board or card. it's useful when you need to rename a checklist to better reflect its purpose or content. the endpoint requires the unique identifier of the checklist and the new name value. it should be used when a checklist's name needs to be changed without altering its items or other properties. note that this operation only affects the checklist's name and does not modify any other attributes or items within the checklist.
</Accordion>

<Accordion title="Update card due date">
  Updates the due date of a specific trello card. this endpoint allows you to set or modify the deadline for a task represented by a card. it's useful for managing timelines and priorities within your trello boards. the endpoint accepts a new date value or null to remove the due date. use this when you need to adjust task deadlines or remove time constraints from a card. note that this operation only affects the due date and does not modify other card attributes.
</Accordion>

<Accordion title="Update board organization id attributes">
  Updates the organization of a specified trello board. this endpoint allows you to move a board from one organization to another by changing its organization id. use this when you need to reorganize your trello workspace structure or when a project needs to be transferred to a different team or department. the operation requires the id of the board to be updated and the id of the new organization. it's important to note that this action may affect board visibility and access permissions, so ensure that the board members have appropriate access to the new organization before making the change. this endpoint doesn't return the updated board details, so you may need to fetch the board information separately to confirm the change.
</Accordion>

<Accordion title="Modify board label name green">
  Updates the name of the green label for a specific trello board. this endpoint allows you to customize the text associated with the green label, which can be used to categorize and filter cards on the board. use this when you want to change the meaning or purpose of the green label across the entire board. the update affects all existing and future cards using the green label. keep in mind that this change is board-wide and may impact existing workflows or filters based on the green label name. the endpoint does not allow changing the color of the label, only its textual representation.
</Accordion>

<Accordion title="Update board prefs comments">
  Updates the comment preferences for a specific trello board, controlling who can add comments to cards. this endpoint allows you to change the comment permissions, ranging from completely disabling comments to allowing public access. use this when you need to adjust the collaboration settings of a board, either to restrict or expand commenting abilities. the changes apply immediately to all current and future cards on the board. note that this endpoint only modifies comment preferences and does not affect other board settings or permissions.
</Accordion>

<Accordion title="Update board label name blue">
  Updates the name of the blue label on a specific trello board. this endpoint allows you to customize the blue label's name to better suit your project's needs and improve organization. use this when you want to change or set the name of the blue label on a particular board. the new name can be any string up to 16384 characters long, including an empty string to remove the current name. this operation only affects the blue label and does not modify any other labels or board properties. keep in mind that changes to label names are visible to all board members and may impact existing workflows or filters based on label names.
</Accordion>

<Accordion title="Update board attributes by id">
  This endpoint updates the attributes of an existing trello board. it allows you to modify various aspects of the board, including its name, description, visibility, organization affiliation, and numerous preferences. use this endpoint when you need to change board settings, update its status (e.g., open or closed), modify permissions, or enable/disable features like power-ups. the endpoint is flexible, allowing for partial updates by specifying only the attributes you wish to change. note that some changes, particularly to permission levels, can significantly affect who can access and interact with the board, so use with caution. this endpoint does not create new boards or manage board content (lists, cards) directly.
</Accordion>

<Accordion title="Update myprefsshowsidebaractivity">
  Updates the user's preference for showing or hiding sidebar activity on a specific trello board. this endpoint allows users to customize their board view by toggling the visibility of the sidebar activity feed. it's useful for personalizing the user experience on a per-board basis, allowing users to focus on the board content or stay informed about recent activities. the change only affects the view for the user making the api call and does not impact other board members' preferences.
</Accordion>

<Accordion title="Update checklists card id attributes">
  Updates the card associated with a specific checklist in trello. this endpoint allows you to move a checklist from one card to another, which is useful for reorganizing tasks or transferring checklists between different cards in your trello boards. it's particularly helpful when restructuring workflows or when a set of tasks (represented by the checklist) needs to be reassigned to a different card. the operation requires the id of the checklist to be moved and the id of the destination card. note that this action will remove the checklist from its current card and attach it to the specified new card.
</Accordion>

<Accordion title="Update org domain association">
  Updates the google apps domain associated with a specific trello organization. this endpoint allows administrators to link or change the google workspace domain connected to their trello organization, enabling integration features such as single sign-on (sso) and automatic user provisioning. use this when setting up or modifying the organization's integration with google workspace. the update affects organization-wide settings and should be used cautiously, as it may impact user access and authentication methods.
</Accordion>

<Accordion title="Update webhooks attributes">
  Updates an existing webhook in trello, allowing you to modify its attributes such as description, active status, callback url, and the model it's monitoring. this endpoint is used when you need to change the configuration of a webhook, such as activating or deactivating it, updating the url where notifications are sent, or changing which trello object it's tracking. it's particularly useful for maintaining and managing long-lived integrations between trello and external systems. the update is performed by sending a put request with the new webhook attributes in the request body.
</Accordion>

<Accordion title="Update webhook description">
  This endpoint updates the description of a specific trello webhook. it allows users to modify the textual description associated with a webhook, providing context about its purpose or any relevant notes. the endpoint should be used when there's a need to change or clarify the purpose of an existing webhook. it's important to note that this operation only affects the description and does not modify other attributes of the webhook such as its callback url or active state. the description can be set to any string, including an empty string to remove the existing description.
</Accordion>

<Accordion title="Update session attributes by id">
  The updatetrellosession endpoint allows you to update the attributes of a specific trello session. it is used to keep track of a user's current activity within the trello application, including which board they are viewing and their overall session status. this endpoint is crucial for maintaining real-time updates and user presence information across the trello platform. you should use this endpoint when a user switches to a different board or when their session status changes (e.g., becoming idle or disconnecting). it helps trello optimize performance by focusing updates on active boards and users. however, be aware that updating the session too frequently may impact system performance, so it's best to call this endpoint only when there are meaningful changes in the user's activity or board focus. note that this endpoint does not provide any information about the board or user beyond what is updated. it is solely for updating session attributes and does not return detailed board or user data.
</Accordion>

<Accordion title="Modify webhook idmodel attributes">
  Updates the model (board, list, or card) that a specific trello webhook is monitoring. this endpoint allows you to change the focus of an existing webhook to a different trello entity, enabling dynamic adjustment of webhook targets without creating new webhooks. use this when you need to redirect a webhook's notifications to a different board, list, or card, such as when project structures change or when implementing flexible monitoring systems. the endpoint requires the webhook's id and the new model's id to make the change. note that this operation only updates the monitored model; it does not affect other webhook properties like the callback url or description.
</Accordion>

<Accordion title="Update webhook active status">
  This endpoint allows you to update the active status of a specific trello webhook. it is used to either activate or deactivate a webhook, controlling whether it should receive notifications about changes to the associated trello model (board, list, or card). the endpoint is particularly useful when you need to temporarily pause notifications or re-enable a previously deactivated webhook without deleting and recreating it. note that this endpoint only modifies the active status; it does not alter other properties of the webhook such as the callback url or the model being monitored.
</Accordion>

<Accordion title="Update organization member attributes">
  Updates the attributes of a specific member within a trello organization. this endpoint allows you to modify a member's email address, full name, and role type (admin, normal, or observer) within the organization. use this when you need to change a member's information or adjust their permissions within the organization. it's particularly useful for onboarding, offboarding, or role changes within a team. note that this endpoint only updates the specified fields; any fields not included in the request will remain unchanged. ensure you have the necessary permissions within the organization to make these changes.
</Accordion>

<Accordion title="Update tokens webhooks attributes">
  Updates the attributes of an existing trello webhook associated with a specific token. this endpoint allows you to modify the webhook's description, callback url, or the trello model it monitors. use this when you need to change the configuration of a previously created webhook, such as updating the notification target or refining its monitoring scope. it's particularly useful for maintaining and adjusting your application's integration with trello as your needs evolve. note that this endpoint updates an existing webhook; it does not create a new one.
</Accordion>

<Accordion title="Update organization name by id">
  Updates the name of a specified trello organization. this endpoint allows you to change the unique identifier of an organization, which is used across the trello platform. it should be used when you need to rebrand or rename an organization. the new name must follow strict formatting rules to ensure consistency and avoid conflicts with other organizations. this operation is irreversible and will immediately affect all members and boards associated with the organization, so use it cautiously. note that this endpoint only updates the organization's name and does not modify any other attributes or settings of the organization.
</Accordion>

<Accordion title="Update board visibility restrict setting">
  This endpoint updates the board visibility restriction preferences for a specific trello organization. it allows administrators to control who can change the visibility settings of boards within the organization. use this endpoint when you need to modify the organization-wide policy for board visibility changes, such as restricting these changes to admins only or allowing all members to modify board visibility. the change affects all boards within the organization and may impact collaboration and security settings. note that this endpoint requires appropriate administrative permissions to execute successfully.
</Accordion>

<Accordion title="Update org member deactivation status">
  Updates the deactivation status of a specific member within a trello organization. this endpoint allows organization administrators to activate or deactivate a member's access to the organization's resources. use this when you need to temporarily remove a member's access without permanently deleting their account from the organization. the endpoint is particularly useful for managing team changes, offboarding processes, or controlling access during extended leaves. note that deactivation does not delete the member's data or remove them from the organization entirely; it simply suspends their access until reactivated.
</Accordion>

<Accordion title="Modify org invite restrict preference">
  This endpoint updates the invite restriction preferences for a trello organization. it allows administrators to control who can invite new members to the organization by specifying an email address, domain, or special value. use this endpoint when you need to change the organization's policy on member invitations, such as restricting invites to specific email domains or individuals. this tool is particularly useful for maintaining security and managing growth in large or sensitive trello organizations. note that this endpoint only updates the preference and does not directly add or remove members.
</Accordion>

<Accordion title="Update webhook attributes">
  This endpoint allows you to update the attributes of an existing webhook in trello. webhooks are used to receive real-time notifications about changes to specified trello models (boards, lists, or cards). by updating a webhook, you can modify its description, activate or deactivate it, change the callback url, or update the model it's monitoring. this is useful for maintaining and adjusting your integration's event listening capabilities without having to create new webhooks for each change. use this endpoint when you need to modify webhook settings, such as changing the notification destination or adjusting which trello model is being monitored.
</Accordion>

<Accordion title="Update organization member attributes">
  This endpoint allows you to update the attributes of existing members within a trello organization (workspace). it can be used to modify a member's email address, full name, or membership type, providing flexibility in managing user information and access levels within your organization. the endpoint is particularly useful for administrative tasks such as updating contact information or changing a member's role. note that you can update one or more attributes in a single request, but you must have the necessary permissions to make these changes. be cautious when modifying membership types, as this directly affects a user's access and capabilities within the organization.
</Accordion>

<Accordion title="Modify organization permission level">
  Updates the permission level preferences for a specified trello organization (workspace). this endpoint allows administrators to control the visibility and accessibility of the organization by setting it to either private or public. use this when you need to change the organization's privacy settings, such as making it more restricted or opening it up for broader access. the change affects all boards and workspaces within the organization, so it should be used carefully. note that this endpoint only modifies the permission level and does not alter other organization settings or board-specific permissions.
</Accordion>

<Accordion title="Update prefs external members disabled">
  Updates the 'externalmembersdisabled' preference for a specified trello organization. this endpoint allows you to control whether external members (users who are not part of the organization) can be added to the organization's boards. when set to 'true', only existing organization members can be added to boards, enhancing privacy and security. use this endpoint when you need to modify the organization's policy on external collaborators. it's particularly useful for managing access control in corporate or sensitive project environments. note that this setting applies organization-wide and may affect existing boards with external members.
</Accordion>

<Accordion title="Update session status by id">
  Updates the status of a specific trello session. this endpoint allows you to change the current state of a user's session, which can be useful for managing user activity, handling timeouts, or updating session information. use this when you need to reflect changes in a user's interaction state with trello, such as when a user becomes idle or reconnects after a disconnection. the endpoint is particularly useful for applications that need to maintain accurate session states or implement session management features. note that updating a session status does not create or authenticate a new session; it only modifies the state of an existing one.
</Accordion>

<Accordion title="Update webhooks callback url">
  This endpoint allows you to update the callback url for an existing trello webhook. use this when you need to change the destination where trello sends event notifications for a specific webhook. the new url must be valid and reachable with a head request to ensure it can receive webhook payloads. this operation is useful for maintaining the functionality of your trello integration, especially when your server infrastructure changes. note that only the callback url is updated; other webhook attributes remain unchanged. ensure your new endpoint is properly configured to handle trello's webhook requests before updating.
</Accordion>

<Accordion title="Update org prefs googleapps version">
  Updates the google apps version preference for a specific trello organization. this endpoint allows you to change the version of google apps integration used by the organization, which can affect how trello interacts with google apps services. use this when you need to upgrade or downgrade the google apps integration for an entire organization. the change affects all members and boards within the organization. note that this endpoint only supports versions 1 and 2 of the google apps integration, and changing this setting may impact existing integrations and workflows.
</Accordion>

<Accordion title="Update organization prefs board visibility restrict">
  This endpoint updates the visibility restriction preferences for private boards within a specific trello organization. it allows organization administrators to control who can change the visibility of private boards. use this endpoint when you need to modify the organization-wide policy for private board visibility changes. the endpoint is particularly useful for maintaining security and access control in enterprise environments where board visibility management is crucial. note that this setting only affects private boards and does not change the visibility of existing boards; it only restricts who can modify their visibility in the future.
</Accordion>

<Accordion title="Update organization website url">
  Updates the website url associated with a specific trello organization. this endpoint allows you to modify or remove the external website link for an organization, which can be useful for maintaining up-to-date references to team or company websites. use this when you need to change the url displayed on the organization's trello page or remove it entirely. the update is applied immediately, and all members of the organization will see the new website link (or its absence) upon the next page refresh. note that this endpoint only modifies the website url and does not affect any other organization attributes.
</Accordion>

<Accordion title="Update prefs board visibility restrict">
  This endpoint updates the board visibility restriction preferences for public boards within a trello organization. it allows organization administrators to control who can create or change boards to public visibility. this setting is crucial for managing the organization's data exposure and collaboration boundaries. use this endpoint when you need to modify the organization-wide policy for public board creation. it's particularly useful for enhancing security, managing workspace settings, or adjusting collaboration policies as the organization's needs evolve.
</Accordion>


# Twitter
Source: https://docs.push.ai/integrations/twitter



Twitter, Inc. was an American social media company based in San Francisco, California, which operated and was named for named for its flagship social media network prior to its rebrand as X.

<Accordion title="Add bookmark to user s tweet">
  Adds a specified tweet to the authenticated user's bookmarks. this endpoint allows users to save tweets for later reference or easy access. it should be used when a user wants to bookmark a tweet they find interesting or valuable. the endpoint requires the unique identifier of the tweet to be bookmarked. it's important to note that this action is user-specific and requires proper authentication. the endpoint does not provide information about existing bookmarks or the success status of the operation in the schema, so additional api calls may be necessary to confirm the bookmark was added successfully.
</Accordion>

<Accordion title="Add user to list by id">
  Adds a specified user to a twitter list. this endpoint allows you to include a user in a curated group of twitter accounts (list). it should be used when you want to expand the membership of a list you own or manage. the endpoint requires the list id and the user id of the account to be added. it's important to note that you can only add users to lists that you own or have management rights to. this tool doesn't provide information about the success of the operation or details about the list or user; it simply performs the addition. use this when you need to programmatically update list memberships, such as for maintaining topical groups or organizing followed accounts.
</Accordion>

<Accordion title="Post user likes by tweet id">
  Likes a specified tweet on behalf of the authenticated user. this endpoint allows a user to express appreciation or agreement with a particular tweet by adding it to their list of liked tweets. it should be used when a user wants to engage with content positively or save it for later reference. the action is reversible, and users can unlike a tweet using a separate endpoint. note that liking a tweet may increase its visibility to the user's followers and contribute to the tweet's overall engagement metrics. this endpoint does not return the updated like status or any other tweet information; it simply performs the action of liking the specified tweet.
</Accordion>

<Accordion title="Create retweet for user post">
  This endpoint allows a user to retweet a specific tweet. it should be used when a user wants to share another user's tweet on their own timeline. the action is performed by providing the unique identifier of the tweet to be retweeted. this endpoint is specifically for creating a retweet and does not handle undoing retweets or retrieving retweet information. keep in mind that retweeting may be subject to twitter's rate limiting and content policies.
</Accordion>

<Accordion title="Create compliance job request">
  Creates a new batch compliance job for checking the compliance status of tweets or users on twitter. this endpoint allows you to initiate large-scale compliance checks, which is crucial for content moderation and user management. use this when you need to verify the compliance status of a large number of tweets or user accounts. the job creation process is asynchronous, meaning you'll need to check the job status separately after creation. this endpoint is particularly useful for applications dealing with content moderation, safety, and policy enforcement on twitter.
</Accordion>

<Accordion title="Create list with description option">
  Creates a new twitter list for organizing and curating tweets. this endpoint allows users to create a personalized list with a specific name, optional description, and privacy setting. it's useful for grouping accounts or topics of interest, making it easier to follow specific content streams. the created list can be used to aggregate tweets from multiple accounts without necessarily following them individually. note that while the list is created empty, users will need to populate it with members separately using other api endpoints.
</Accordion>

<Accordion title="Add user to followed lists">
  Allows an authenticated user to follow a specific twitter list. this endpoint is used when a user wants to subscribe to a curated list of twitter accounts, enabling them to see tweets from those accounts in a dedicated timeline. it's particularly useful for following topic-specific or curated content streams. the endpoint requires the user's authentication and the unique identifier of the list they wish to follow. it should not be used to create new lists or modify existing ones. note that following a list does not automatically follow all accounts within that list.
</Accordion>

<Accordion title="Delete list by id">
  Deletes a specified twitter list associated with the authenticated user's account. this endpoint should be used when a user wants to permanently remove a list they've created, including all its members and followers. it's particularly useful for managing outdated or unnecessary lists, cleaning up a user's profile, or removing lists that no longer serve their intended purpose. once a list is deleted, it cannot be recovered, so use this endpoint with caution. this operation does not affect the accounts that were members of the list; it only removes the list itself from the platform.
</Accordion>

<Accordion title="Delete user retweet">
  Deletes a retweet of a specific tweet made by a user. this endpoint allows you to remove a user's retweet, effectively undoing the action of sharing another user's tweet on their own timeline. it should be used when a user wants to take back their retweet or when managing a user's content programmatically. the endpoint requires both the user's id and the id of the original tweet that was retweeted. it's important to note that this action only removes the retweet; it does not affect the original tweet or any other users' retweets of the same content. this endpoint is particularly useful for content management, user privacy controls, or correcting accidental retweets.
</Accordion>

<Accordion title="Delete user like by tweet id">
  Removes a like from a specific tweet for an authenticated user. this endpoint is used when a user wants to undo their previous action of liking a tweet. it allows for managing user engagement by removing positive interactions with content. the endpoint should be called when a user explicitly requests to unlike a tweet or as part of a feature that allows users to manage their liked tweets in bulk. it's important to note that this action is idempotent, meaning that unliking an already unliked tweet will not result in an error but will have no effect. the endpoint does not provide any information about the tweet or the like status after the operation.
</Accordion>

<Accordion title="Delete direct message event by id">
  Deletes a specific direct message event from a conversation on twitter. this endpoint should be used when a user wants to permanently remove a particular message from their direct message history. it's useful for managing conversations, removing sensitive or outdated information, or complying with privacy requests. the deletion is irreversible, so use with caution. note that this endpoint only deletes individual message events, not entire conversations. it may not be possible to delete certain system-generated events or messages sent by other users.
</Accordion>

<Accordion title="Follow a user">
  Initiates a follow request for the authenticated user to follow another twitter user. this endpoint should be used when a user wants to start following another account, receiving their tweets in their home timeline. it's particularly useful for building features that allow users to expand their network or for automated follow actions based on certain criteria. note that if the target user has protected tweets, this will send a follow request instead of immediately following. the endpoint does not provide information about the follow status or any details about the target user beyond the follow action.
</Accordion>

<Accordion title="Create group dm conversation">
  Creates a new group direct message (dm) conversation on twitter with specified participants and an initial message. this endpoint allows you to start a private group chat with multiple users, supporting both text and media content in the first message. use this when you need to initiate a private group discussion or share content with multiple twitter users simultaneously. the conversation is created immediately, and all specified participants are added to the group. note that this endpoint only creates group conversations; for one-on-one dms, a different endpoint should be used.
</Accordion>

<Accordion title="Retrieve tweet count statistics">
  Retrieves the count of tweets matching a specified query from twitter's full archive of public tweets. this endpoint allows users to analyze tweet volume over time, providing insights into trends, events, and public discourse. it's particularly useful for research, social media analysis, and understanding the temporal distribution of topics on twitter. the endpoint supports flexible time ranges and granularity options, enabling both broad historical analyses and detailed recent data examination. it's important to note that this endpoint is available only for academic research access and requires oauth 2.0 app-only authentication. while it provides comprehensive count data, it does not return the actual tweet content or user information.
</Accordion>

<Accordion title="Retrieve user pinned lists by id">
  Retrieves the pinned lists of a specified twitter user. this endpoint allows you to fetch the curated lists that a user has chosen to highlight on their profile. it's useful for understanding a user's interests or the content they want to emphasize. the endpoint returns only the pinned lists, not the content of those lists or other user information. use this when you need to know which lists a user considers most important or wants to showcase on their profile.
</Accordion>

<Accordion title="Get user followers by id">
  Retrieves a list of users who follow the specified twitter user. this endpoint allows you to fetch the followers of any public twitter account using their unique user id. it's particularly useful for analyzing a user's audience, tracking follower growth, or identifying potential connections. the endpoint returns a paginated list of follower details, which may include user ids, usernames, and other public profile information depending on the api version and authentication level. use this when you need to analyze a user's follower base or track changes in their audience over time. note that for users with a large number of followers, multiple api calls may be necessary to retrieve the complete list due to pagination limits.
</Accordion>

<Accordion title="Get list members by id">
  Retrieves the members of a specified twitter list. this endpoint allows you to fetch all users who are part of a given list, providing valuable information about the list's composition. it's particularly useful for analyzing audience demographics, finding influential users within a specific topic, or simply managing your lists. the tool returns user objects for each member, which may include details such as user id, screen name, and profile information. use this when you need to examine or export the membership of a twitter list. note that for private lists, authentication as the list owner is required. the response is typically paginated, so multiple calls may be necessary to retrieve all members of large lists.
</Accordion>

<Accordion title="Mute user by id">
  This endpoint allows a user to mute another user on twitter. when a user is muted, their tweets and retweets will no longer appear in the muting user's home timeline, although they will still be able to see the muted user's profile and tweets when visiting their profile directly. this feature is useful for managing unwanted content without the more severe step of blocking. the endpoint should be used when a user wants to reduce their exposure to another user's content without notifying that user or completely cutting off interaction. it's important to note that muting is a one-way action and does not prevent the muted user from seeing the muting user's tweets or interacting with them.
</Accordion>

<Accordion title="Get user list memberships by id">
  Retrieves all twitter lists that a specified user is a member of. this endpoint allows you to discover the curated collections of accounts (lists) that a particular user has been added to by other twitter users. it's useful for understanding a user's interests, networks, and how they are categorized by the twitter community. the endpoint returns details about each list, such as the list name, description, and owner. use this when you need to analyze a user's presence across various topical or community-based lists on twitter. note that this endpoint only returns public lists and private lists that the authenticated user has access to view.
</Accordion>

<Accordion title="Get user bookmarks by id">
  Retrieves the bookmarks saved by a specific twitter user. this endpoint allows you to fetch a list of tweets that the user has bookmarked for later reference. it's useful for applications that need to display or analyze a user's saved content. the endpoint returns the most recent bookmarks first and supports pagination for handling large sets of bookmarked tweets. it should be used when you need to access a user's curated list of interesting or important tweets. note that this endpoint only returns the bookmarks and does not provide functionality to add or remove bookmarks.
</Accordion>

<Accordion title="Get space buyers">
  Retrieves a list of users who have purchased tickets to a specific twitter space. this endpoint is useful for space creators or analysts to gather information about their audience and understand the reach of their paid spaces. it returns details about the buyers, which can be used for analytics, engagement tracking, or follow-up communications. the endpoint should be used after a space with ticketed entry has concluded or while it's ongoing. it will not provide real-time updates during the space, and it's limited to spaces that have implemented paid entry.
</Accordion>

<Accordion title="Post user pinned list by id">
  This endpoint allows a user to pin a specific list to their twitter profile. it's used to increase the visibility and quick access to a chosen list for the user and their profile visitors. the endpoint should be called when a user wants to highlight a particular list on their profile. it's important to note that there's a limit to how many lists can be pinned (typically up to 5), so this action may fail if the user has reached their maximum number of pinned lists. the endpoint doesn't provide information about currently pinned lists or remove other pinned lists automatically.
</Accordion>

<Accordion title="Delete user bookmark">
  Removes a specific tweet from a user's bookmarks on twitter. this endpoint allows you to delete a saved tweet from a user's bookmark list, effectively "un-bookmarking" the tweet. use this when a user wants to remove a previously bookmarked tweet from their saved items. the endpoint requires both the user's id and the specific tweet id to be removed. it's important to note that this action is irreversible, and once a bookmark is deleted, it cannot be restored through the api. this endpoint is useful for managing a user's bookmarks, especially when implementing features like "unsave" or "remove from bookmarks" in twitter client applications.
</Accordion>

<Accordion title="Fetch recent tweet counts">
  Retrieves the count of tweets matching a specified query over the last seven days. this endpoint is useful for analyzing tweet volume trends and patterns within a recent timeframe. it supports granular data retrieval (minute, hour, or day) and allows for precise time range specification within the seven-day limit. the endpoint is subject to rate limiting and requires proper authentication. it's ideal for real-time or near-real-time tweet volume analysis but not suitable for historical data beyond a week.
</Accordion>

<Accordion title="Get user owned lists">
  Retrieves all the lists owned by a specified twitter user. this endpoint allows you to fetch the curated collections of users or tweets that a particular user has created and manages on their twitter account. it's useful for understanding a user's interests, content curation, and network on the platform. the endpoint returns details about each list, likely including the list name, description, member count, and other relevant information. use this when you need to analyze a user's content organization or discover thematic groupings they've created. note that this endpoint only returns lists owned by the specified user and does not include lists they're subscribed to but don't own. the response may be paginated for users with a large number of owned lists.
</Accordion>

<Accordion title="Delete list member by id">
  Removes a specified user from a twitter list. this endpoint allows list owners to delete a member from their curated list, effectively unsubscribing the user from the list's content. use this when you need to manage list membership, such as removing inactive users or adjusting the list's focus. the endpoint requires both the list id and the user id of the member to be removed. it's important to note that this action can only be performed by the list owner or users with appropriate permissions. the endpoint doesn't return the updated list information, so a separate call may be needed to verify the change or retrieve the current list members.
</Accordion>

<Accordion title="Fetch openapi specifications">
  Retrieves the complete openapi specification for twitter's api v2 in json format. this endpoint should be used when developers need to access the full api documentation programmatically or when building tools that interact with the twitter api. the specification provides detailed information about all available endpoints, request/response structures, and authentication requirements. it is particularly useful for generating client libraries, setting up api testing environments, or creating interactive api documentation. note that this endpoint returns the raw openapi specification and does not provide any simplified or human-readable documentation; it's intended for machine consumption and developer tooling.
</Accordion>

<Accordion title="Search all tweets endpoint">
  The gettweetsfullarchivesearch endpoint allows users to search for tweets across the entire twitter archive, dating back to 2006. this powerful search functionality enables comprehensive historical data analysis, trend identification, and research on twitter content. the endpoint supports various search operators and parameters for refined searching and can return both tweet and user information based on the specified fields. it's ideal for applications requiring access to historical twitter data, sentiment analysis over time, or tracking long-term trends on specific topics or from particular users. note that this endpoint may have usage limitations or require specific access levels, and the volume of data returned can be substantial for broad queries over long time periods.
</Accordion>

<Accordion title="Post new tweet with media poll options">
  The createtweet endpoint allows users to post new tweets on twitter with various customization options. it supports creating standard tweets, replies, quotes, polls, and tweets with media attachments. this endpoint should be used when an application needs to post content on behalf of a user, such as for scheduling tweets, cross-posting from other platforms, or automated content distribution. it offers fine-grained control over tweet visibility, reply settings, and content types, making it versatile for different use cases. however, users should be aware of the mutual exclusivity between certain parameters and respect twitter's content policies and rate limits when using this endpoint.
</Accordion>

<Accordion title="Post dm messages with attachments">
  Sends a new direct message to a specific conversation on twitter. this endpoint allows you to post either a text message, media attachments, or both to an existing dm conversation. it's used when you need to programmatically send private messages to users within a conversation you're a part of. the endpoint requires either text content or at least one media attachment, making it versatile for various messaging needs. note that media must be uploaded separately and referenced by its media id. this tool doesn't handle media uploads directly, so ensure you have valid media ids before attaching media to messages.
</Accordion>

<Accordion title="Post dm conversation message">
  Sends a new direct message to a specific user in a twitter conversation. this endpoint allows for sending text messages, media attachments, or both. it should be used when initiating or continuing a private conversation with another twitter user. the function requires either a text message, attachments, or both to be provided. it does not support editing or deleting existing messages. note that media must be uploaded separately and referenced by its media id in the attachments array.
</Accordion>

<Accordion title="Delete user followed lists by list id">
  This endpoint allows a user to unfollow (stop following) a specific list on twitter. it removes the specified list from the user's followed lists. use this when a user no longer wants to see tweets from a particular list in their timeline or receive notifications about it. the operation is permanent but can be undone by following the list again using a separate api call. note that this endpoint only affects the user's relationship with the list and does not delete the list itself or affect other users following it.
</Accordion>

<Accordion title="Retrieve compliance jobs">
  Retrieves a list of recent compliance jobs from the twitter api. this endpoint allows you to monitor and manage compliance-related tasks, such as data processing for tweets or users. use this when you need to track the status of compliance jobs, retrieve information about recently created jobs, or filter jobs based on type or status. it's particularly useful for applications that need to ensure adherence to twitter's data policies or for managing large-scale data operations. the endpoint does not create new jobs or modify existing ones; it's purely for retrieval and monitoring purposes.
</Accordion>

<Accordion title="Search spaces endpoint">
  The searchspaces endpoint allows you to search for twitter spaces based on specified criteria. it's designed to help developers discover relevant live audio conversations or scheduled spaces on the platform. this endpoint is particularly useful for building discovery experiences, allowing users to find spaces of interest, or for monitoring conversations around specific topics or events. the endpoint supports various search parameters, including a query string, state filters, and the ability to specify which space fields to include in the response. it returns a list of space objects that match the search criteria, providing details such as the space id, title, state (live or scheduled), host information, and participant count. use this endpoint when you need to programmatically find spaces related to particular topics, hosted by specific users, or scheduled for certain times. it's ideal for applications that aggregate content, provide recommendations, or offer enhanced discovery features for twitter spaces.
</Accordion>

<Accordion title="Get users blocking status by id">
  Retrieves a list of users that have been blocked by the specified twitter user. this endpoint is useful for managing user interactions and reviewing a user's blocking history. it should be used when you need to access or analyze the list of accounts a particular user has chosen to block. the endpoint returns information about blocked users, which may include their user ids, usernames, and other public profile data. note that this endpoint only provides information about users blocked by the specified account and does not allow for blocking or unblocking actions directly.
</Accordion>

<Accordion title="Delete user muting relationship">
  This endpoint allows a user to remove a mute relationship with another user on twitter. when a user unmutes a previously muted account, they will once again see the unmuted user's tweets and notifications in their timeline and interactions. this endpoint should be used when a user decides to re-engage with content from a previously muted account. it's important to note that this action is reversible, and the user can always re-mute the target user if needed. the endpoint doesn't provide any information about the mute status before or after the operation, it simply performs the unmute action.
</Accordion>

<Accordion title="Delete user from following">
  Removes the follow relationship between two twitter users. this endpoint allows an authenticated user (source user id) to unfollow another user (target user id) on the platform. it should be used when a user wants to stop receiving tweets and updates from the target user in their home timeline. the operation is immediate and irreversible, although the user can choose to follow the target user again in the future if desired. this endpoint doesn't return any specific data about the unfollow action; it's primarily used for its side effect of updating the follow relationship. note that this action only affects the source user's following list and does not impact the target user's followers count until they refresh their profile.
</Accordion>

<Accordion title="Retrieve compliance job by id">
  Retrieves detailed information about a specific compliance job using its unique identifier. this endpoint is part of twitter's compliance api and is used to check the status and details of a previously created compliance job. it's particularly useful for tracking the progress of batch compliance checks on tweets or user ids. use this endpoint when you need to monitor the status of a compliance job, retrieve results of completed jobs, or gather information about job parameters and execution details. it's essential for maintaining large datasets in compliance with twitter's data policies. the endpoint returns comprehensive information about the job, which may include its current status (e.g., in progress, complete), creation time, job type (e.g., tweets or users), and potentially the results if the job has been completed. however, it does not allow modification of the job or creation of new jobs.
</Accordion>

<Accordion title="Delete user pinned list by id">
  Removes a specific list from a user's pinned lists on their twitter profile. this endpoint allows you to unpin a previously pinned list, effectively removing it from the user's profile page. use this when a user wants to declutter their profile or change their featured lists. the operation is permanent, but the list itself is not deleted, only unpinned. note that this action can only be performed on lists that are currently pinned by the specified user.
</Accordion>

<Accordion title="Update list attributes">
  Updates an existing twitter list's properties. this endpoint allows users to modify the description, name, or privacy setting of a specific list identified by its unique id. it's useful for maintaining and organizing curated collections of twitter accounts. the endpoint should be used when a user wants to change list details or adjust its visibility. note that this operation only updates the specified fields; any omitted fields will retain their current values.
</Accordion>

<Accordion title="Retrieve spaces information">
  Retrieves detailed information about one or more twitter spaces. this endpoint allows developers to fetch real-time data about live audio conversations, including metadata such as host information, participant count, and current status. it's particularly useful for applications that need to display or analyze active spaces, track engagement, or provide users with up-to-date information about ongoing audio discussions. the endpoint supports querying multiple spaces in a single request, making it efficient for batch retrieval. however, it doesn't provide functionality to create, modify, or end spaces - it's purely for data retrieval.
</Accordion>

<Accordion title="Fetch tweets from list by id">
  Retrieves the most recent tweets from a specified twitter list. this endpoint allows developers to fetch tweets posted by members of a particular list, providing a curated stream of content based on the list's theme or purpose. it's useful for monitoring discussions, tracking industry trends, or aggregating content from a specific group of users. the endpoint returns tweet data in chronological order, typically including tweet text, author information, engagement metrics, and timestamps. it should be used when you need to access the latest content from a pre-defined group of twitter users. note that this endpoint may have rate limits and will only return tweets from public accounts or private accounts that the authenticated user has permission to view.
</Accordion>

<Accordion title="Get users following list">
  Retrieves a list of users that the specified twitter user is following. this endpoint allows you to explore a user's social connections and interests by examining who they choose to follow on the platform. it's particularly useful for social graph analysis, influencer research, or understanding a user's preferences. the endpoint supports pagination for retrieving large sets of following data and allows customization of the user information returned through field selection. note that this endpoint may be subject to rate limiting, and the number of users returned per request is capped, requiring multiple calls for users with a large following list.
</Accordion>

<Accordion title="Get muted users by id">
  Retrieves a list of users that the specified user has muted on twitter. this endpoint allows you to fetch the accounts that a particular user has chosen to mute, effectively hiding their tweets from their timeline. it's useful for understanding a user's content preferences and moderation choices. the endpoint should be used when you need to analyze or display a user's muting behavior, such as in user management tools or content moderation systems. note that this endpoint only provides information about users who are muted; it does not allow muting or unmuting actions directly. the response likely includes paginated results, so multiple calls may be necessary to retrieve the complete list of muted users.
</Accordion>

<Accordion title="Fetch dm event by id">
  Retrieves a specific direct message (dm) event from twitter using its unique identifier. this endpoint allows you to fetch detailed information about a single dm event, including its content, participants, and metadata. it's useful for applications that need to display or analyze individual messages within a dm conversation. the endpoint is part of twitter's api v2 and requires appropriate authentication to access a user's private messages. use this when you need to retrieve or display the contents of a specific direct message, or when tracking changes in a dm conversation. note that this endpoint only retrieves a single event at a time; for fetching multiple events or entire conversations, you would need to use a different endpoint.
</Accordion>

<Accordion title="Retrieve tweets label stream">
  The get /2/tweets/label/stream endpoint enables real-time streaming of labeled tweets from twitter. this tool is designed for applications that require immediate access to labeled tweets as they are posted, allowing for real-time monitoring and analysis. it's particularly useful for sentiment analysis, brand monitoring, and trend detection. use this endpoint when you need to process large volumes of labeled tweets in real-time or react immediately to specific tweet categories. note that rate limiting may apply, and the stream may not include all tweets, only those matching labeling criteria.
</Accordion>

<Accordion title="Delete tweet">
  Deletes a specific tweet from the authenticated user's timeline on twitter. this endpoint should be used when a user wants to permanently remove one of their own tweets from the platform. it's particularly useful for managing content, retracting statements, or maintaining privacy. the deletion is irreversible, so use with caution. this endpoint cannot be used to delete tweets from other users' accounts. be aware that while the tweet will be removed from twitter, it may still exist in third-party applications or services that have previously cached or stored the tweet data.
</Accordion>

<Accordion title="Retrieve space details">
  Retrieves detailed information about a specific twitter space using its unique identifier. this endpoint allows developers to fetch metadata and current status of a space, including its title, creator, host ids, scheduled start time (if applicable), current state (live, scheduled, or ended), and participant count. it's useful for applications that need to display or analyze information about particular spaces, such as third-party twitter clients or social media analytics tools. the endpoint provides a snapshot of the space at the time of the request and does not provide real-time updates or streaming capabilities. note that this endpoint can only retrieve information for public spaces or those the authenticated user has access to.
</Accordion>

<Accordion title="Fetch recent tweets">
  The searchrecenttweets endpoint allows you to search for tweets posted within the last 7 days that match your specified criteria. this powerful tool is ideal for real-time analysis, trend monitoring, and gathering recent public opinions on various topics. it supports a wide range of search operators, enabling precise and targeted searches across twitter's vast database of recent tweets. use this endpoint when you need up-to-date information or want to track emerging discussions. keep in mind that this endpoint only searches recent tweets; for historical data beyond 7 days, you would need to use a different endpoint. the search is limited to a subset of all tweets and may not return every single tweet matching your query due to twitter's indexing and data availability policies.
</Accordion>

<Accordion title="Retrieve spaces by creator ids">
  Retrieves information about twitter spaces created by specified users. this endpoint allows you to fetch details of active, scheduled, or ended spaces associated with given creator ids. it's particularly useful for monitoring space activities of specific twitter users or for aggregating space data from multiple creators. the endpoint returns space objects containing various attributes such as their current state, title, start time, and more, depending on the fields requested. use this when you need to track or analyze spaces created by known twitter users. note that the endpoint may have rate limits and might not return spaces that have been deleted or are no longer available.
</Accordion>

<Accordion title="Retrieve user by username">
  Retrieves detailed information about a twitter user based on their username. this endpoint allows developers to fetch public profile data for a specific user, which can be useful for displaying user information, verifying user existence, or gathering data for analysis. the endpoint should be used when you need to access a user's profile details, such as their display name, bio, follower count, or other public information associated with their account. it's important to note that this endpoint only provides publicly available information and does not grant access to private user data or direct messages. the tool is particularly useful for applications that need to display user profiles, verify user identities, or analyze public twitter user data.
</Accordion>

<Accordion title="Fetch tweet usage data">
  Retrieves usage statistics related to tweets for the authenticated user or application. this endpoint provides aggregated data on tweet activity, which may include metrics such as the number of tweets posted, engagement rates, or api call volume related to tweet actions. it's particularly useful for monitoring and analyzing the twitter api usage patterns, ensuring compliance with rate limits, and understanding the overall tweet activity associated with your account or application. the data returned likely covers a specific time period, possibly the last 24 hours or up to the last 90 days, depending on twitter's data retention policies. this endpoint should be used for general usage monitoring and does not provide real-time data or detailed information about individual tweets.
</Accordion>

<Accordion title="Retrieve direct message events by conversation id">
  Retrieves direct message (dm) events from a specific conversation on twitter. this endpoint allows you to fetch various types of dm events, including messagecreate, participantsjoin, and participantsleave, providing a comprehensive view of the conversation's history and participant interactions. use this endpoint when you need to analyze or display the contents and activity of a particular dm conversation. it's particularly useful for applications that manage customer service, chatbots, or social media analytics on twitter. note that this endpoint only retrieves events from a single conversation at a time and may be subject to rate limiting or pagination for conversations with a large number of events.
</Accordion>

<Accordion title="Retrieve user by id">
  Retrieves detailed information about a specific twitter user using their unique user id. this endpoint is part of the twitter api v2 and provides access to various attributes of a user's profile. it should be used when you need comprehensive details about a particular twitter account, such as the user's name, username, profile description, follower count, and other public information. the endpoint is useful for applications that require up-to-date user data, such as social media management tools, analytics platforms, or user verification systems. note that this endpoint only returns publicly available information and does not provide access to private user data or tweet content.
</Accordion>

<Accordion title="Fetch tweets for space by id">
  Retrieves tweets associated with a specific twitter space. this endpoint allows developers to fetch all tweets that are related to or were posted during a particular space, identified by its unique id. it's useful for analyzing discussions, engagement, and content shared within a space after it has ended or while it's ongoing. the endpoint should be used when you need to collect or analyze the tweets from a specific space, such as for content curation, sentiment analysis, or engagement metrics. it does not provide real-time streaming of tweets during a space; instead, it offers a way to retrieve tweets in batches. the response likely includes tweet text, author information, timestamps, and possibly engagement metrics, but the exact details of the response structure are not specified in the given schema.
</Accordion>

<Accordion title="Retrieve user list">
  The getusers endpoint retrieves detailed information about twitter users. it fetches user profiles by ids or usernames, supporting up to 100 users per request. use this endpoint to gather profile details, metrics, and optionally, pinned tweets. it's ideal for user lookup or displaying profile information, but doesn't provide real-time updates or streaming.
</Accordion>

<Accordion title="Retrieve tweet by id">
  Retrieves detailed information about a specific tweet using its unique identifier. this endpoint allows developers to fetch the content, metadata, and possibly engagement metrics of a single tweet. it's particularly useful when you need comprehensive data about a known tweet, such as for analysis, display purposes, or tracking specific content. the endpoint returns the most up-to-date information available for the specified tweet. note that this tool does not provide real-time updates or streaming capabilities; it returns a snapshot of the tweet's data at the time of the request. keep in mind that tweets may be deleted or become unavailable, in which case the endpoint will return an appropriate error response.
</Accordion>

<Accordion title="Retrieve authenticated user information">
  Retrieves the profile information of the currently authenticated user on twitter. this endpoint is part of the twitter api v2 and provides access to the user's public profile data, such as username, display name, bio, and other relevant information. it should be used when an application needs to fetch the most up-to-date information about the authenticated user, such as during profile management or user session initialization. the endpoint does not require any additional parameters beyond authentication, making it a simple and direct way to access user data. note that the specific fields returned may depend on the application's access level and the user's privacy settings.
</Accordion>

<Accordion title="Set tweet visibility">
  This endpoint allows you to hide or unhide a specific tweet identified by its tweet id. it's part of twitter's content moderation features, enabling users or moderators to control the visibility of tweets in conversations. use this endpoint when you need to manage tweet visibility, either to hide potentially inappropriate content or to restore visibility to previously hidden tweets. the action affects the tweet's visibility in the conversation thread and search results, but does not delete the tweet. note that this action can only be performed on tweets that the authenticated user has permission to modify.
</Accordion>

<Accordion title="Retrieve dm events by participant id">
  Retrieves direct message (dm) events from a conversation with a specific participant on twitter. this endpoint allows you to fetch various types of dm events, such as message creations, participant joins, and participant leaves, for a one-on-one conversation. it's particularly useful when you need to access the history or recent activity of a direct message thread with a particular user. the endpoint returns events in chronological order, providing a comprehensive view of the conversation's timeline. note that this endpoint is limited to retrieving events from conversations between two participants and does not support group dm conversations.
</Accordion>

<Accordion title="Get user reverse chronological timeline">
  Retrieves the reverse chronological timeline for a specified twitter user. this endpoint returns the most recent tweets and retweets posted by the user, ordered from newest to oldest. it's particularly useful for applications that need to display a user's latest activity or monitor real-time updates from a specific account. the endpoint should be used when you need to fetch the latest tweets for a user without any algorithmic sorting or filtering. it does not include replies or mentions unless they are self-threads or retweets. keep in mind that the number of tweets returned may be limited by twitter's api constraints, and pagination might be necessary for a complete timeline.
</Accordion>

<Accordion title="Retrieve list followers">
  Retrieves a list of users who are followers of a specified twitter list. this endpoint allows you to fetch the users who have chosen to follow and receive updates from a particular curated list on twitter. it's useful for understanding the audience and reach of a list, as well as for analyzing user interests and network connections. the endpoint returns user information for the list's followers, which can be used for various purposes such as audience analysis, engagement strategies, or finding potential users to interact with based on shared interests. note that this endpoint only provides information about the followers of the list, not the members or contents of the list itself.
</Accordion>

<Accordion title="Fetch users liking specific tweet">
  Retrieves a list of users who have liked a specific tweet on twitter. this endpoint allows you to fetch information about the users who have engaged with a particular tweet by liking it. it's useful for analyzing tweet popularity, identifying influential users, and understanding audience engagement patterns. the endpoint returns user data for a single tweet and does not provide aggregated like counts or information about other forms of engagement such as retweets or replies.
</Accordion>

<Accordion title="Fetch users by usernames">
  The getusersbyusernames endpoint retrieves detailed information about multiple twitter users based on their usernames. it allows for efficient bulk lookup of user data, supporting up to 100 usernames in a single request. this endpoint is particularly useful for applications that need to fetch user profiles, verify user existence, or gather public metrics for multiple users simultaneously. the response can be customized to include various user fields and even expand pinned tweet information, providing flexibility in the data returned. it's important to note that this endpoint has rate limits, typically allowing 300 requests per 15-minute window for app-only auth and 900 requests per 15-minute window for user auth. use this endpoint when you need to retrieve user information for known twitter handles, but avoid it for user search functionality.
</Accordion>

<Accordion title="Get tweet retweets by id">
  Retrieves a list of retweets for a specified tweet. this endpoint allows you to fetch information about users who have retweeted a particular tweet, providing insights into the tweet's spread and engagement. use this when you need to analyze the reach of a tweet or identify users who have shared it. the endpoint returns data about the retweets themselves, not the full content of the original tweet. note that there may be limits on the number of retweets returned, and the results may not include retweets from protected accounts or users who have blocked the authenticating user.
</Accordion>

<Accordion title="Get list by id">
  Retrieves detailed information about a specific twitter list using its unique identifier. this endpoint allows developers to fetch metadata and properties of a particular list, such as its name, description, member count, and follower count. it's useful when you need to display or update information about a known list in your application. the endpoint provides a snapshot of the list's current state and does not include information about the list's members or subscribers. use this when you have a list id and need to access its properties or verify its existence.
</Accordion>

<Accordion title="Get followed lists by user id">
  Retrieves a collection of lists that are followed by a specified twitter user. this endpoint allows developers to access information about the curated content a user has chosen to follow, providing insights into their interests and preferences on the platform. it's particularly useful for applications that aim to analyze user behavior, provide personalized recommendations, or aggregate content based on followed lists. the endpoint returns list metadata, not the actual content of the lists or their tweets. use this when you need to understand a user's content consumption patterns or when building features that leverage a user's followed lists for content discovery or social graph analysis.
</Accordion>

<Accordion title="Get direct message events">
  Retrieves direct message events from the authenticated user's twitter account. this endpoint allows you to fetch various types of events related to direct messages, such as new messages, participants joining or leaving conversations. it's particularly useful for applications that need to monitor or analyze private communications on twitter. the endpoint supports pagination for handling large volumes of events and allows filtering by event type and specific conversations. use this endpoint when you need to access the user's private message history, track changes in direct message conversations, or build messaging-related features in your application. note that this endpoint only returns events the authenticated user has permission to view and may be subject to rate limiting.
</Accordion>

<Accordion title="Get tweet data">
  The get /2/tweets endpoint retrieves detailed information about one or more specified tweets. it allows you to fetch comprehensive data for up to 100 tweets in a single request by providing their unique tweet ids. this endpoint is ideal for obtaining the full content, associated metadata, and engagement metrics of specific tweets. it's particularly useful for analyzing individual tweets, tracking conversation threads, or gathering data for specific content you're interested in. the endpoint offers extensive customization through various field parameters, allowing you to tailor the response to include only the data you need, such as author information, media attachments, polls, and metrics. however, it does not provide functionality for searching or streaming tweets; it's specifically for retrieving known tweet ids.
</Accordion>

<Accordion title="Get users who retweeted tweet by id">
  Retrieves a list of users who have retweeted a specific tweet. this endpoint allows you to gather information about the users who have shared a particular tweet on their own timeline. it's useful for analyzing the reach and engagement of a tweet, as well as identifying influential users who have helped spread the content. the endpoint returns user data for public retweets only and does not include information about quote tweets or private retweets. use this when you need to track the spread of a tweet or understand its impact across the twitter network. note that the number of results may be limited and paginated, so multiple requests might be necessary for highly retweeted content.
</Accordion>

<Accordion title="Get quote tweets by id">
  This endpoint retrieves quote tweets for a specified tweet. it allows developers to fetch tweets that have quoted (shared with comment) a particular tweet, providing insights into how content is being shared and discussed on the platform. use this endpoint when you need to analyze the reach and impact of a specific tweet by examining who has quoted it and what they've added to the conversation. the endpoint returns a list of quote tweets, likely including information such as the quoting user, the quote tweet's content, and relevant metadata. note that this endpoint focuses solely on quote tweets and does not return other types of engagement such as replies or retweets without comments.
</Accordion>

<Accordion title="Retrieve liked tweets by user id">
  Retrieves a list of tweets liked by a specified user. this endpoint allows you to fetch the most recent tweets liked by a user, providing insights into their preferences and interactions on the platform. it's useful for analyzing user engagement, understanding content popularity, or building features that showcase a user's liked content. the endpoint returns a paginated list of tweet objects, with options to expand and customize the returned data fields. note that this endpoint is subject to twitter's rate limits and the project-level tweet cap, which may affect the number of results you can retrieve in a given time frame.
</Accordion>


# Twitter media
Source: https://docs.push.ai/integrations/twitter_media



Twitter Media focuses on multimedia tools and features within Twitter, allowing brands to leverage rich content for marketing campaigns

<Accordion title="Upload media">
  Upload media to twitter
</Accordion>


# Typefully
Source: https://docs.push.ai/integrations/typefully



Integrate Typefully to streamline and manage your AI-powered content creation.

<Accordion title="Get Notifications">
  Get notifications from typefully. can be filtered by kind (inbox or activity).
</Accordion>

<Accordion title="Create Draft">
  Creates a draft in typefully.
</Accordion>

<Accordion title="Get Recently Scheduled Drafts">
  Get recently scheduled drafts from typefully.
</Accordion>

<Accordion title="Get Recently Published">
  Get recently published drafts from typefully.
</Accordion>

<Accordion title="Mark Notifications Read">
  Mark notifications as read in typefully. can be filtered by kind and account id.
</Accordion>


# Weathermap
Source: https://docs.push.ai/integrations/weathermap



WeatherMap provides visual weather data, forecasts, and mappings, helping users understand climate patterns or track severe weather conditions

<Accordion title="Weather Info">
  Tool for querying the openweathermap api.
</Accordion>


# Webflow
Source: https://docs.push.ai/integrations/webflow



Webflow is a no-code website design and hosting platform, letting users build responsive sites, launch online stores, and maintain content without coding

<Accordion title="Get Collection Item">
  This tool retrieves a specific item from a webflow collection. it allows users to fetch detailed information about a single collection item using its unique identifier. the tool is used to get an item's details such as its id, timestamps (lastpublished, lastupdated, createdon), archive/draft status, fielddata, and cmslocaleid. this tool requires appropriate 'cms:read' authentication scope.
</Accordion>

<Accordion title="Delete Webflow Collection Item">
  This tool allows you to delete a specific item from a collection in webflow. it permanently removes the item from the specified collection and complements existing collection management tools. the tool requires a collection id to identify the collection and an item id to identify the item, with an optional cms locale id parameter for handling multi-language content.
</Accordion>

<Accordion title="Get Collection Details">
  Retrieves a specific collection by its id from a webflow site. this endpoint returns detailed information about the collection, including its name, slug, and schema. it requires a valid collection id as a parameter and complements the webflow list collections tool for accessing specific collection details. this tool requires the 'cms:read' authentication scope.
</Accordion>

<Accordion title="Upload Asset to Webflow">
  This tool allows users to upload assets (files, images, etc.) to a webflow site. it involves a two-step process: first, generating a pre-signed amazon s3 upload url by calling the webflow api, and second, uploading the file to that s3 url. the tool requires parameters such as site id, file name, file content, md5, and optionally asset folder id to correctly upload and manage assets for the specified webflow site.
</Accordion>

<Accordion title="Update Order">
  This tool allows updating specific fields of an existing order in webflow. it's particularly useful for managing order fulfillment details and adding internal notes.
</Accordion>

<Accordion title="Get Webflow Site Information">
  This tool retrieves detailed information about a specific webflow site. it includes site id, workspaceid, creation and update dates, display names, and other settings like previewurl, timezone, customdomains, and locale settings. it requires a valid 'site id' and appropriate 'sites:read' authentication scope.
</Accordion>

<Accordion title="Get Item Inventory">
  This tool retrieves the current inventory levels for a specific item in a webflow collection. it provides information about the item's inventory quantity and type (finite or infinite) and complements the webflow update item inventory action by allowing users to check inventory levels before making any updates.
</Accordion>

<Accordion title="List Webflow Collections">
  This tool retrieves a list of all collections for a given webflow site. it uses the site id (obtained from webflow list webflow sites) to return a list of collections, each with properties such as id, name, slug, singularname, lastupdated, and fields. this tool is fundamental for working with webflow's cms and requires appropriate 'cms:read' authentication scope.
</Accordion>

<Accordion title="Create Webflow Collection Item">
  This tool creates a new item in a specified webflow collection. it requires the collection id and field data parameters (including required name and slug) and optionally accepts an is draft flag. authentication is assumed to be provided, and the collection id can be obtained by using the webflow list collections tool.
</Accordion>

<Accordion title="Fulfill Order">
  This tool allows you to mark an order as fulfilled in webflow's e-commerce system. it's essential for managing order fulfillment in webflow stores.
</Accordion>

<Accordion title="Publish Webflow Site">
  This tool publishes a webflow site, making all staged changes live. it uses the post /sites/\{site id}/publish api endpoint and requires a valid site id, with an optional domains array to specify custom domains. it is essential for deploying updates made to site content, design, or structure.
</Accordion>

<Accordion title="List Form Submissions">
  This tool retrieves a list of form submissions for a specific webflow site. it allows users to fetch form submission data with pagination support and optional filtering by form element id.
</Accordion>

<Accordion title="Refund Order">
  This tool allows you to refund a webflow e-commerce order. when executed, it reverses the stripe charge and sets the order's status to 'refunded'. it handles customer returns or order cancellations.
</Accordion>

<Accordion title="Unfulfill Order">
  This tool allows you to mark a previously fulfilled order as unfulfilled in webflow. it is useful for reversing a fulfillment action when an order was mistakenly marked as fulfilled or if there are issues with shipment.
</Accordion>

<Accordion title="List Webflow Sites">
  This tool retrieves a list of all webflow sites accessible to the authenticated user. it is a fundamental and independent action which only requires an authentication token and returns details for each site including site id, name, shortname, lastpublished, previewurl, timezone, and status.
</Accordion>

<Accordion title="List Collection Items">
  This tool retrieves a list of items from a specified collection in webflow. it supports pagination and filtering, and is essential for fetching multiple items from a collection, such as blog posts, products, or any content stored in collections.
</Accordion>

<Accordion title="Update Item Inventory">
  This tool allows you to update the inventory levels of a specific sku item in your webflow e-commerce site by either setting the inventory quantity directly or updating it incrementally. it updates the inventory status using the patch /collections/:collection id/items/:item id/inventory endpoint and requires the 'ecommerce:write' scope.
</Accordion>

<Accordion title="Update Webflow Collection Item">
  This tool allows updating an existing item in a webflow collection using the patch /collections/\{collection id}/items/\{item id} endpoint. it accepts required parameters such as collection id, item id, and fields, and optional 'live' flag and cms locale id. the update operation modifies any fields available in the collection's schema and returns the updated item along with metadata.
</Accordion>

<Accordion title="List Webflow Orders">
  This tool retrieves a list of all orders for a specified webflow site using the get /sites/\{site id}/orders endpoint. it accepts a required site id parameter and optional parameters such as status (to filter orders by their status), offset (for pagination), and limit (specifies the number of items per request). the response includes order details like order id, created on, customer info, status, total, items, shipping address, billing address, and payment info. this functionality supports ecommerce workflow management and requires the scope ecommerce:read.
</Accordion>

<Accordion title="List Pages">
  This tool retrieves a list of all pages for a specified webflow site. it can access both static and cms-driven pages and provides information such as the page's unique identifier, name, url slug, creation and update timestamps, and publication status. it is useful for auditing site structure, building site maps, and monitoring page updates.
</Accordion>

<Accordion title="Get Order Details">
  This tool retrieves detailed information about a specific order in webflow. it allows users to fetch comprehensive order details including customer information, items purchased, payment status, and shipping details. the response includes order status, customer details, billing and shipping information, items purchased, payment details, order total, timestamps, fulfillment status, and additional comments or tracking information.
</Accordion>


# Whatsapp
Source: https://docs.push.ai/integrations/whatsapp



Enables interaction with customers through the WhatsApp Business API for messaging and automation.

<Accordion title="Send contacts">
  Send contacts whatsapp number. note: the message will be delivered to the recipient only if they have initiated a conversation first.
</Accordion>

<Accordion title="Send location">
  Send a location message to a whatsapp number. note: the location will be shared with the recipient only if they have texted first.
</Accordion>

<Accordion title="Send media">
  Send a media message to a whatsapp number. note: the media will be delivered to the recipient only if they have texted first.
</Accordion>

<Accordion title="Send message">
  Send a text message to a whatsapp number. note: the message will reflect on the recipient's phone number only if they have texted first.
</Accordion>

<Accordion title="Send template message">
  Send a template message to a whatsapp number.
</Accordion>


# Workiom
Source: https://docs.push.ai/integrations/workiom



Workiom provides APIs for automating workflows, integrating with
various tools, and building custom applications.

<Accordion title="Create record">
  Creates a new record in a specified workiom list. this tool creates a record with basic field types like text, numbers, dates, and static list items. the record data should be provided as a json object where each key is a field id and the value matches the expected data type for that field.
</Accordion>

<Accordion title="Get all lists">
  Get all lists from a workiom workspace. this action fetches all available lists in a workiom workspace. it's a fundamental tool that serves as a prerequisite for most other operations (like creating records, which require a list id). the action supports pagination and can optionally include field definitions for each list.
</Accordion>

<Accordion title="Get records">
  Retrieves records from a specified list in workiom. this tool fetches records from a specified list with optional filtering, sorting, and pagination capabilities. the response includes the records along with summary information and total count.
</Accordion>


# Wrike
Source: https://docs.push.ai/integrations/wrike



Wrike is a project management and collaboration tool offering customizable workflows, Gantt charts, reporting, and resource management to boost team productivity

<Accordion title="List Folder Blueprints">
  Lists account-level folder blueprints tree in wrike.
</Accordion>

<Accordion title="Create new group with json payload">
  Creates a new group within the wrike collaborative work management platform. this endpoint allows you to set up a group with a specified title, members, parent group, avatar, and custom metadata. use this when you need to organize team members into a new group, create sub-groups within an existing structure, or add a new project team. the created group can be used for task assignments, access control, and organization within wrike. note that while creating an empty group is possible, it's generally more useful to include members during creation. the endpoint does not provide group deletion or updating functionality, which would require separate api calls.
</Accordion>

<Accordion title="List Space Task Blueprints">
  Lists space-level task blueprints in wrike.
</Accordion>

<Accordion title="Create subfolder within a folder">
  Creates a new subfolder within an existing folder in wrike. this endpoint allows for detailed customization of the new subfolder, including its title, description, sharing settings, custom fields, and project-specific attributes. it's particularly useful for organizing work, creating new projects, or setting up collaborative spaces within an existing folder structure. the endpoint offers flexibility in defining user access roles and custom metadata, making it suitable for complex project setups or when integrating with other systems. however, it's important to note that while many customization options are available, only the 'title' parameter is required for creating a basic subfolder.
</Accordion>

<Accordion title="List Space Folder Blueprints">
  Lists space-level folder blueprints tree in wrike.
</Accordion>

<Accordion title="Create invitation">
  Creates and sends an invitation to join a wrike workspace. this endpoint allows you to invite new users to your wrike account by specifying their email address and optional details such as name, role, and user type. it's particularly useful for onboarding new team members or external collaborators. the invitation process can be customized with personalized subject lines and messages, though these features are not available for free accounts. when using this endpoint, be mindful of the mutually exclusive parameters (role, external, and usertypeid) to ensure proper user configuration.
</Accordion>

<Accordion title="Retrieve invitation list">
  Retrieves a list of all active invitations in the wrike system. this endpoint allows users to view pending invitations sent to collaborators, team members, or external partners. it's useful for tracking outstanding invitations and managing user onboarding processes. the response likely includes details such as the invitee's email, the date the invitation was sent, and its current status. this tool should be used when you need to audit or manage the invitation process within your wrike workspace. note that this endpoint only provides information about active invitations and does not allow for creating, modifying, or canceling invitations.
</Accordion>

<Accordion title="Retrieve list of groups">
  Retrieves a list of groups within the wrike workspace. this endpoint allows users to fetch information about existing groups, which are essential for team management and organization in wrike. it supports pagination and optional field selection for more detailed group information. use this endpoint when you need to display a list of groups, manage team structures, or gather group-related data for reporting purposes. the endpoint returns basic group information by default, with options to include additional details as needed. it does not create, modify, or delete groups; separate endpoints should be used for those operations.
</Accordion>

<Accordion title="Fetch all workflows">
  Retrieves a list of workflows from the wrike platform. this endpoint allows you to fetch information about existing workflows, including their structure, stages, and associated metadata. use this endpoint when you need to view or analyze the current workflows set up in your wrike account. it's particularly useful for auditing workflow configurations, integrating workflow information into external systems, or building custom reporting tools. the endpoint supports pagination and filtering by status, allowing for efficient retrieval of large sets of workflow data. note that this endpoint only provides read access to workflow information and cannot be used to modify existing workflows or create new ones.
</Accordion>

<Accordion title="Retrieve custom field by id">
  Retrieves detailed information about a specific custom field in wrike by its unique identifier. this endpoint allows developers to access the properties, configuration, and metadata of a custom field, which can be crucial for understanding the structure of tasks, projects, or other entities in wrike that use this custom field. use this endpoint when you need to inspect or validate the settings of a particular custom field, such as its type, possible values (for dropdown fields), or any other associated attributes. it's particularly useful when building integrations that need to work with wrike's custom data structures or when creating reports that involve custom field data.
</Accordion>

<Accordion title="List subfolders by folder id">
  Retrieves a list of subfolders within a specified parent folder in the wrike workspace. this endpoint is used to navigate the folder hierarchy and obtain information about the immediate child folders of a given folder. it's particularly useful for building folder tree structures, implementing folder navigation in user interfaces, or when you need to process or analyze the contents of a specific folder. the endpoint returns only the direct subfolders and does not recursively fetch nested folder structures. use this when you need to explore or manage the organization of projects, tasks, or other items within the wrike folder system. note that this endpoint does not provide information about the contents of the subfolders (such as tasks or files) - it only returns folder metadata.
</Accordion>

<Accordion title="List Task Blueprints">
  Lists account-level task blueprints in wrike.
</Accordion>

<Accordion title="Get group by id">
  Retrieves detailed information about a specific group in wrike. this endpoint allows you to fetch comprehensive data about a group, including its name, members, permissions, and other relevant attributes. use this when you need to access or display information about a particular group within your wrike workspace. the endpoint is particularly useful for applications that manage team structures, permissions, or need to show group details in user interfaces. note that this endpoint only provides read access to group data and cannot be used to modify group information. ensure you have the necessary read permissions for the group you're querying.
</Accordion>

<Accordion title="Get contacts">
  Retrieves a list of contacts from the wrike platform. this endpoint allows users to access contact information for individuals associated with their wrike account, such as team members, clients, or external collaborators. it's particularly useful for applications that need to display or manage user information within wrike projects or tasks. the endpoint returns contact details in json format, likely including fields such as name, email, and role. while it provides a comprehensive list of contacts, it may not include detailed information about each contact's specific task assignments or project involvement. use this endpoint when you need to retrieve contact information for user management, team organization, or integration with other systems.
</Accordion>

<Accordion title="Get custom fields">
  Retrieves a list of custom fields defined in the wrike workspace. this endpoint allows you to fetch all custom fields or a subset based on optional filtering parameters. it's useful for obtaining an overview of the available custom fields, their types, and configurations. the response typically includes details such as field ids, names, types (e.g., text, dropdown, numeric), and any associated metadata. use this endpoint when you need to populate a list of available custom fields in your application or when you need to retrieve the ids of specific custom fields for use in other api calls. note that the endpoint may not return the actual values of custom fields for specific tasks or projects; it focuses on the field definitions themselves.
</Accordion>

<Accordion title="Get folders">
  Retrieves a list of folders from the user's wrike account. this endpoint allows users to fetch information about their folders, which are fundamental organizational units in wrike used for managing projects, tasks, and other work items. it can be used to obtain an overview of the folder structure, gather details about specific folders, or as part of a folder navigation feature. the endpoint supports optional filtering, field selection, and pagination to customize the response based on the user's needs. it's particularly useful for applications that need to display or manipulate the folder hierarchy within a wrike account, such as project management dashboards or folder tree visualizations.
</Accordion>

<Accordion title="Retrieve contact by id">
  Retrieves detailed information about a specific contact in wrike using their unique identifier. this endpoint allows you to fetch comprehensive data about a single contact, including their personal information, role, and any custom fields associated with them. use this when you need to access or display the full profile of a particular contact within your wrike account. the endpoint is particularly useful for integrations that require up-to-date contact information or for populating user interfaces with detailed contact data. note that this endpoint only provides information for one contact at a time; for bulk retrieval of contacts, a separate endpoint would be necessary.
</Accordion>

<Accordion title="Update custom field by id">
  Updates an existing custom field in wrike. this endpoint allows users to modify the properties of a custom field, such as its name, type, or other attributes. it should be used when changes to a custom field's configuration are needed, such as updating its name, changing its type, or modifying its applicability to tasks, folders, or projects. the endpoint requires the default or wsreadwrite scope for authorization. note that while you can update various properties, you cannot change a custom field's id or convert it between space-level and account-level fields using this endpoint. be cautious when modifying custom fields, as changes may affect existing data and integrations relying on the field.
</Accordion>

<Accordion title="Create task in folder">
  Creates a new task within a specified folder in wrike. this endpoint allows for detailed task creation with numerous customizable fields, supporting wrike's comprehensive project and task management capabilities. it can be used to programmatically add tasks to projects, set task properties, assign responsibilities, and integrate with custom workflows. the endpoint is particularly useful for bulk task creation, automating project setups, or integrating wrike task creation into external systems or workflows.
</Accordion>

<Accordion title="Modify pending invitation parameters">
  Updates the properties of a pending invitation in wrike. this endpoint allows you to modify various aspects of an invitation that has not yet been accepted, such as resending the invitation, changing the user's role, or updating their user type. it's particularly useful for correcting mistakes in the original invitation or adjusting user permissions before the invitee joins the wrike account. the endpoint should only be used for pending invitations; attempting to modify accepted or expired invitations will likely result in an error. note that some parameters are deprecated, and using the 'usertypeid' parameter is recommended for setting user roles and permissions.
</Accordion>

<Accordion title="Update account metadata">
  This endpoint allows you to update or add metadata to a wrike account. it's used for storing custom key-value pairs of information associated with the account, which can be useful for integrations with external systems or maintaining application-specific data. the metadata is isolated on a per-client (application) basis, ensuring that different integrations don't interfere with each other's data. you can add new metadata entries, update existing ones, or remove entries by setting their value to null. this endpoint is particularly useful for maintaining mappings between wrike account data and external system identifiers or configurations.
</Accordion>

<Accordion title="Retrieve user information">
  Retrieves detailed information about a specific user in the wrike platform. this endpoint allows you to fetch user data such as profile information, account settings, and role within the organization. it's particularly useful when you need to access or verify details of a single user account. the endpoint should be used when specific user information is required, such as during user management tasks, permission checks, or when displaying user profiles. note that this endpoint only provides information for one user at a time and does not return sensitive data like passwords.
</Accordion>

<Accordion title="Modify folder attributes">
  The updatefolder endpoint modifies existing folders in wrike. it can rename folders, update descriptions, manage folder hierarchy, control sharing, update custom fields, and convert between folders and projects. use it for workspace organization, project management, and access control. exercise caution with operations that significantly alter folder properties or accessibility.
</Accordion>

<Accordion title="Retrieve task by id">
  Retrieves detailed information about a specific task in the wrike platform. this endpoint allows developers to fetch comprehensive data about a task, including its title, description, status, assignees, due dates, custom fields, and other relevant metadata. it's particularly useful when you need to access or display the full details of a task within your application or integration. the endpoint should be used when you have a specific task id and require its complete information. note that this endpoint only retrieves data and does not modify the task; for updates, you would need to use a separate endpoint.
</Accordion>

<Accordion title="Delete customfield by id">
  This endpoint permanently deletes a specific custom field from the wrike system. it should be used when you need to remove a custom field that is no longer required or relevant to your project management workflow. the deletion is irreversible, so use this endpoint with caution. only account administrators or users with appropriate permissions can perform this operation. after deletion, the custom field will no longer be available for tasks, folders, projects, or spaces where it was previously used. this endpoint does not return the deleted field's data; it typically returns a success status upon completion. be aware that deleting a custom field may affect existing reports or integrations that rely on that field's data.
</Accordion>

<Accordion title="Update contact details by id">
  The updatecontactdetails endpoint allows you to modify various aspects of a contact's information in wrike. this put request to /contacts/\{contactid} enables updating metadata, bill rates, cost rates, job roles, and custom fields for a specific contact. use this endpoint when you need to change or add details to a contact's profile, such as updating their job role, modifying billing information, or managing custom fields. the endpoint provides granular control over which fields to update and allows for the inclusion of specific fields in the response. note that while users have full read/write access to their own metadata, they may have limited access to other contacts' information. additionally, custom fields can be removed by setting their values to null, providing flexibility in managing contact data.
</Accordion>

<Accordion title="Delete folder by id">
  Deletes a specified folder from the wrike workspace. this endpoint permanently removes the folder and all its contents, including tasks, documents, and subfolders. use this endpoint when you need to eliminate a project or organizational structure that is no longer needed. exercise caution when calling this endpoint, as the deletion is irreversible and may affect team members' access to information. the operation may fail if the folder contains active tasks or if the user doesn't have sufficient permissions to delete the folder. it's recommended to review the folder contents and inform team members before deletion.
</Accordion>

<Accordion title="Delete group by id">
  Deletes a specific group from the wrike workspace. this endpoint should be used when you need to remove a group that is no longer required, such as for organizational restructuring or cleaning up obsolete team structures. it permanently removes the group and its associations, but does not affect the users who were members of the group. use with caution as this action cannot be undone. the endpoint does not return the deleted group's data; it typically returns a success status code upon completion.
</Accordion>

<Accordion title="Launch Folder Blueprint Async">
  Launches a folder blueprint asynchronously in wrike.
</Accordion>

<Accordion title="Launch Task Blueprint Async">
  Launches a task blueprint asynchronously in wrike.
</Accordion>

<Accordion title="Update user profile by account id">
  Updates a user's profile information in the wrike system. this endpoint allows for modifying specific attributes of a user's profile, including their associated account, role, and external status. it's particularly useful for user management tasks such as changing a user's role or updating their account association. the endpoint should be used when there's a need to modify existing user information, but it cannot be used to create new users or delete existing ones. note that partial updates are supported, meaning you can update one or more fields without affecting the others.
</Accordion>

<Accordion title="Delete invitation by id">
  This endpoint deletes a specific invitation in the wrike platform using its unique identifier. it should be used when you need to cancel or remove an existing invitation, perhaps due to a mistake or change in circumstances. the deletion is permanent and cannot be undone, so use this endpoint with caution. it's particularly useful for managing user access and maintaining the accuracy of pending invitations in your wrike workspace. note that this endpoint only handles deletion and does not provide any information about the invitation being removed.
</Accordion>

<Accordion title="Fetch all tasks">
  Retrieves a list of tasks from the wrike platform based on specified criteria. this endpoint allows you to fetch task information, including details such as task title, description, status, due dates, and assignees. it's useful for applications that need to display or process task data from wrike, such as project management dashboards or reporting tools. the endpoint supports pagination and filtering to manage large sets of tasks efficiently. while it provides comprehensive task data, it does not modify any task information - use separate endpoints for creating, updating, or deleting tasks. note that the response may not include all task fields by default, so specify required fields using the 'fields' parameter for complete information.
</Accordion>

<Accordion title="Delete task by id">
  Deletes a specific task from the wrike system using its unique identifier. this endpoint should be used when you need to permanently remove a task from a project or workspace. the operation is irreversible, so it should be used with caution. once a task is deleted, all associated data, including comments, attachments, and custom fields, will be permanently removed. this endpoint is particularly useful for cleaning up completed or obsolete tasks, or when restructuring projects. it requires the 'wsreadwrite' scope and should only be accessed by users with appropriate permissions to delete tasks.
</Accordion>

<Accordion title="Get account details">
  Retrieves detailed information about the authenticated user's wrike account. this endpoint provides essential account-level data, which may include account name, id, subscription details, and other relevant metadata. it should be used when you need to access or display general account information within your application. the endpoint does not modify any data and is suitable for read-only operations. note that the specific fields returned may vary based on the user's permissions and the account's subscription level.
</Accordion>

<Accordion title="Update group information">
  Updates an existing group in wrike with new properties and settings. this endpoint allows you to modify various aspects of a group, including its title, membership, invitations, parent group, avatar, and metadata. it's particularly useful for managing group structures, adjusting team compositions, and maintaining up-to-date group information. the endpoint requires the group id and accepts multiple optional parameters for granular control over group properties. it's important to note that this operation can affect user access and group hierarchy, so it should be used carefully, especially when modifying members or changing the parent group.
</Accordion>

<Accordion title="Bulk update group members">
  The update group members bulk endpoint allows for bulk updating of group memberships in wrike. it enables adding and removing members from multiple groups in a single api call, improving efficiency in group management operations. this endpoint is particularly useful for large-scale group membership changes or when synchronizing group data with external systems. the operation is limited to 20 group updates per request, ensuring optimal performance and preventing misuse. use this endpoint when you need to modify memberships for multiple groups simultaneously, rather than making individual api calls for each group update.
</Accordion>

<Accordion title="Update task properties">
  Updates an existing task in wrike with the provided information. this endpoint allows for comprehensive modifications to a task, including its basic properties, relationships with other tasks and folders, assignees, custom fields, and more. it's particularly useful for keeping task information up-to-date as project requirements change or progress is made. the endpoint can handle multiple types of updates in a single call, making it efficient for batch updates or complex task modifications. however, users should be cautious when using this endpoint, as it can significantly alter task details and relationships. it's recommended to review the changes carefully before submitting the update request.
</Accordion>


# Yousearch
Source: https://docs.push.ai/integrations/yousearch



YouSearch is a search engine or search tool that enables users to find relevant information, possibly with enhanced filtering or privacy-focused features

<Accordion title="My Custom Search">
  Perform a search using the custom api.
</Accordion>


# Youtube
Source: https://docs.push.ai/integrations/youtube



Youtube actions to interact with youtube app

<Accordion title="Get Channel Id by Handle">
  Get the id of channel using the channel's handle. for example @composio
</Accordion>

<Accordion title="List channel videos">
  List videos of a specific youtube channel.
</Accordion>

<Accordion title="List caption track">
  List captions of a youtube video.
</Accordion>

<Accordion title="List user playlists">
  List user playlists.
</Accordion>

<Accordion title="Video details">
  List all details about a youtube video, including likes, views, etc.
</Accordion>

<Accordion title="Update thumbnail">
  Update the thumbnail of a youtube video.
</Accordion>

<Accordion title="List user subscriptions">
  List user subscriptions.
</Accordion>

<Accordion title="Load captions">
  Download and extract text from youtube captions note : you can only download captions for videos you own.
</Accordion>

<Accordion title="Update video">
  Update a video's metadata on youtube.
</Accordion>

<Accordion title="Search you tube">
  Search youtube for videos, channels, or playlists.
</Accordion>

<Accordion title="Subscribe channel">
  Subscribe to a youtube channel.
</Accordion>


# Zendesk
Source: https://docs.push.ai/integrations/zendesk



Zendesk is a customer service and sales platform that helps businesses manage customer communication and support

<Accordion title="Count Zendesk Organizations">
  Count the number of organizations in zendesk.
</Accordion>

<Accordion title="Delete Zendesk Organization">
  Delete an organization in zendesk.
</Accordion>

<Accordion title="Create Zendesk Organization">
  Create an organization in zendesk.
</Accordion>

<Accordion title="Create Zendesk Ticket">
  Create a ticket in zendesk.
</Accordion>

<Accordion title="Get Zendesk Organizations">
  Get all organizations in zendesk.
</Accordion>

<Accordion title="Get Zendesk About Me">
  Get information about the owner account in zendesk.
</Accordion>

<Accordion title="Reply to Zendesk Ticket">
  Action to reply to a zendesk ticket by adding a comment.
</Accordion>

<Accordion title="Get Zendesk Organization">
  Get information about a specific organization in zendesk.
</Accordion>

<Accordion title="Delete Zendesk Ticket">
  Delete a ticket in zendesk.
</Accordion>

<Accordion title="Update Zendesk Organization">
  Update an organization in zendesk.
</Accordion>

<Accordion title="Get Zendesk Ticket">
  Get ticket details from zendesk.
</Accordion>


# Zenrows
Source: https://docs.push.ai/integrations/zenrows



ZenRows is a web scraping API allowing developers to bypass CAPTCHAs and blocks, gather structured data from dynamic websites, and quickly integrate results into applications

<Accordion title="Get Detailed Concurrency Status">
  This tool provides detailed information about the current concurrency status and limits of your zenrows account by making a request to the api and analyzing the response headers. it is essential for monitoring real-time api usage, managing concurrent requests, and ensuring optimal performance within plan limits.
</Accordion>

<Accordion title="Get ZenRows API Usage Statistics">
  This tool retrieves the current api usage statistics and limits for your zenrows account. it is an independent action that requires no additional parameters besides authentication. it is useful for monitoring api usage and ensuring that the account has sufficient remaining credits.
</Accordion>

<Accordion title="Get Original Status Code">
  This tool retrieves the original http status code returned by the target website, which is useful for debugging purposes. it returns the original status code in the response headers under 'x-zenrows-original-status'. it can also provide the full response body and error messages, helping with debugging scraping issues, verifying website responses, monitoring availability, and understanding website behavior.
</Accordion>

<Accordion title="Get Response with Compression">
  A tool to fetch content from a url using the zenrows api with compression enabled to optimize bandwidth usage and improve performance. it supports gzip, deflate, and br compression encodings, handles decompression automatically, and provides compression statistics along with the decompressed content.
</Accordion>

<Accordion title="Get Concurrency Status">
  This tool retrieves the current concurrency status of your zenrows api usage. it reports the maximum number of concurrent requests allowed by your plan and the number of available concurrent request slots. it is useful for monitoring api usage, implementing rate limiting, debugging request issues, and capacity planning.
</Accordion>

<Accordion title="Get PDF from URL">
  This tool generates a pdf version of the scraped content from a given url. it requires javascript rendering to be enabled and sets the response type to pdf, making it ideal for archiving web pages, creating documentation, generating reports, or saving articles for offline reading.
</Accordion>

<Accordion title="Get response headers">
  A tool to retrieve and parse response headers from zenrows api requests. it provides critical metadata such as concurrency limits, available request slots, request cost, unique request id, and final url after redirects, which is essential for monitoring usage, debugging, and optimizing requests.
</Accordion>

<Accordion title="Get Plaintext Response">
  This tool extracts plain text content from a webpage using the zenrows api. by using the response type=plaintext parameter, it strips html tags and formats the content into clean, plain text. it's useful for extracting readable content for nlp, summarization, or archiving purposes.
</Accordion>

<Accordion title="Get Real Estate Property Data">
  A specialized tool for extracting structured data from real estate platforms like zillow and idealista. it leverages zenrows' real estate api to fetch comprehensive property information, including property details, location information, features, seller details, and more, in a structured format.
</Accordion>

<Accordion title="Scrape url autoparse">
  The zenrows scrape url autoparse tool automatically parses and extracts structured data from any given url using intelligent parsing capabilities. it eliminates the need for manual css selectors by auto-identifying relevant content on web pages, returning data such as titles, main content, meta descriptions, images, links, prices, and contact information in a structured json format.
</Accordion>

<Accordion title="Get Session ID">
  This tool implements zenrows' session management functionality to maintain the same ip address across multiple requests for up to 10 minutes. it supports parameters like url, session id, and premium proxy, and is useful for maintaining consistent scraping sessions, simulating real user behavior, and avoiding detection by anti-bot systems.
</Accordion>

<Accordion title="Screenshot URL">
  A tool to capture screenshots of web pages using zenrows api. this tool allows you to take screenshots of entire web pages or specific elements, with customizable options for format and quality.
</Accordion>

<Accordion title="Scrape url">
  Scrape and extract data from a specified url. this action allows you to collect and process web data effortlessly using the zenrows api.
</Accordion>

<Accordion title="Scrape URL HTML">
  This tool extracts raw html data from a given url using zenrows' universal scraper api. it focuses on retrieving the pure html content of the webpage without automatic parsing or data extraction. it supports parameters such as js render for enabling javascript rendering, custom headers for custom http headers, premium proxy for using premium proxies, and session id for maintaining the same ip across multiple requests.
</Accordion>

<Accordion title="Scrape URL with CSS Selectors">
  This tool allows users to scrape specific elements from a webpage using css selectors. it is particularly useful for targeted data extraction rather than retrieving the entire page content. the endpoint takes a url and a json object containing css selectors for parsing elements such as titles, links, images, and prices, and includes optional parameters like using premium proxies, specifying response wait times, and custom headers among others.
</Accordion>


# Zoho
Source: https://docs.push.ai/integrations/zoho



Zoho actions to interact with zoho CRM

<Accordion title="Update Related Records in Zoho CRM">
  Associates or updates relationships between records across different modules in zoho crm.
</Accordion>

<Accordion title="Create Zoho CRM Record">
  Creates new records in a specified module in zoho crm.
</Accordion>

<Accordion title="Get Zoho CRM Records">
  Retrieves records from a specified module in zoho crm.
</Accordion>

<Accordion title="Convert Zoho CRM Lead">
  Converts a lead into a contact, account, and optionally a deal in zoho crm.
</Accordion>

<Accordion title="Update Zoho CRM Record">
  Updates existing records in a specified module in zoho crm.
</Accordion>

<Accordion title="Create Zoho CRM Tag">
  Creates new tags in zoho crm.
</Accordion>


# Zoom
Source: https://docs.push.ai/integrations/zoom



Zoom is a video conferencing and online meeting platform featuring breakout rooms, screen sharing, and integrations with various enterprise tools

<Accordion title="Delete a h 323 sip device">
  A h.323/sip device can join or be called into a zoom meeting via a room connector. this api allows for the deletion of such a device from a zoom account. it has an `h323:write:admin` scope and a `light` rate limit.
</Accordion>

<Accordion title="Create webinar s invite links">
  Generate webinar invitation links requiring a business, education, or api plan with add-on. necessary scopes include `webinar:write` and `webinar:write:admin` with granular scopes for invitation links. rate limit is light.
</Accordion>

<Accordion title="Create a h 323 sip device">
  H.323/sip devices can join or be called into zoom meetings via room connector. use the api to add devices to your zoom account. rate limit: light.
</Accordion>

<Accordion title="Create meeting s invite links">
  Create a batch of invitation links for a meeting. **scopes:** `meeting:write:admin`,`meeting:write` **[rate limit label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `light`
</Accordion>

<Accordion title="Delete a meeting survey">
  To delete a zoom meeting survey, the host needs a pro account with the survey feature enabled for scheduled meetings. permissions: `meeting:write`, `meeting:write:admin`. rate limit: `light`.
</Accordion>

<Accordion title="Delete a tracking field">
  This api allows deletion of zoom tracking fields. requirements: business, education, api plan, or higher. needs admin permissions with `tracking fields:write:admin` scope. rate limit is light.
</Accordion>

<Accordion title="Delete a user s tsp account">
  Delete a user's tsp account. **scopes:** `tsp:write:admin`,`tsp:write` **[rate limit label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `light`
</Accordion>

<Accordion title="Delete a meeting s archived files">
  Api to delete all meeting's archived files requires meeting/webinar archiving enabled and scopes `recording:write:admin`, `recording:write`. rate limit: light.
</Accordion>

<Accordion title="Delete a webinar">
  To delete a webinar, you need a pro plan or higher with the webinar add-on. required scopes are `webinar:write` and `webinar:delete:webinar`. rate limit is light.
</Accordion>

<Accordion title="Delete a webinar poll">
  Guidelines for deleting a webinar's poll feature in zoom, requiring 'webinar:write' and admin permissions, with granular scopes for poll deletion. rate limit label is 'light'.
</Accordion>

<Accordion title="Create a meeting">
  Enable zoom meeting creation via user-level apps with "me". "start url" for hosts expires in 2 hours, or 90 days for "custcreate" users. renew via api, capped at 100 requests/day. requires "meeting:write" permission, subject to medium rate limit.
</Accordion>

<Accordion title="Delete sip phone">
  This api deletes a zoom account's sip phone, supported only on cisco and avaya pbx systems. users must enable sip phone integration via zoom sales. scope required: `sip phone:write:admin` with a `light` rate limit.
</Accordion>

<Accordion title="Delete a live meeting message">
  Delete a message in a zoom live meeting using the api, requires dlp enabled for in-meeting chat. applicable scopes are `meeting:write` and `meeting:write:admin`. rate limit is classified as `medium`.
</Accordion>

<Accordion title="Delete a webinar survey">
  Use the api to delete zoom webinar surveys if you have a pro plan or higher, the survey feature enabled, and the right scopes. rate limit is light.
</Accordion>

<Accordion title="Create a meeting poll">
  Meeting hosts can create polls for attendees if using a pro or higher plan, with the polling feature enabled, and for scheduled meetings only. rate limit: light.
</Accordion>

<Accordion title="Get archived file statistics">
  Zoom offers an archiving solution for accounts to automate the recording and collection of meeting/webinar data for compliance. it requires meeting/webinar archiving enabled and has a medium rate limit.
</Accordion>

<Accordion title="Delete a webinar registrant">
  Guide to deleting webinar registrants, requiring `webinar:write` or admin permissions and specific granular scopes. rate limit level: light.
</Accordion>

<Accordion title="Get a meeting">
  The text provides details on api permissions for reading meeting information, categorizing permissions into general and granular scopes, and labels the rate limit as 'light'.
</Accordion>

<Accordion title="Get a meeting s join token for live streaming">
  To live stream a zoom meeting, obtain a join token for a recording bot using the zoom sdk, which supports regular and raw streaming. requires a pro plan, livestreaming enabled, and specific scopes. rate limit: light.
</Accordion>

<Accordion title="Get a meeting sip uri with passcode">
  The api retrieves a meeting's sip uri, including meeting id, optional passcode, and participant code, plus subscription status, participant code, and uri validity. scopes and rate limit are specified.
</Accordion>

<Accordion title="Get a meeting poll">
  Meeting hosts can survey attendees through polls, with details available via a provided link. it requires `meeting:read:admin` and `meeting:read` permissions and has a `light` rate limit.
</Accordion>

<Accordion title="Delete a webinar s branding name tag">
  This api removes a webinar's session branding name tag. requirements include enabled webinar session branding setting. it needs `webinar:write` or `webinar:write:admin` scopes, with a `light` rate limit.
</Accordion>

<Accordion title="Get a meeting s archive token for local archiving">
  Get a meeting archive token for sdk apps or bots to access real-time raw media streams. requires a pro plan or higher and activating **archive meetings and webinars** in zoom settings. scope: `meeting token:read:admin:local archiving`. rate limit: light.
</Accordion>

<Accordion title="Get a meeting registrant">
  Details on a specific user registered for a zoom meeting can be accessed by a host or admin with permissions. requires a meeting plan and the scopes `meeting:read:admin` and `meeting:read`. rate limit label is `light`.
</Accordion>

<Accordion title="Create a meeting template from an existing meeting">
  Create a meeting template from an existing meeting. **scopes:** `meeting:write:admin`,`meeting:write` **[rate limit label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `medium`
</Accordion>

<Accordion title="Delete zpa device by vendor and mac address">
  To remove a zpa device in the device manager by vendor and mac, use scopes `device:write:admin`, `device:delete:zpa device:admin`, and `device:delete:zpa device:master`. rate limit: medium.
</Accordion>

<Accordion title="Delete a live webinar message">
  This api lets you delete a specific message in a live webinar by id. required: zoom's dlp for in-meeting chat enabled. scopes needed are `webinar:write` and `webinar:write:admin`, with a `medium` rate limit.
</Accordion>

<Accordion title="Get a tracking field">
  This api provides details on zoom's scheduling tracking fields. it requires a business, education, api, or higher plan with `tracking fields:read:admin` scope. the rate limit label is `light`.
</Accordion>

<Accordion title="Get a meeting summary">
  Meeting summary info requires a pro+ host plan, ai companion enabled, excluding e2ee meetings. scopes include meeting summary:read and admin versions. rate limit: light.
</Accordion>

<Accordion title="Get a meeting s join token for local recording">
  Obtain a join token for a zoom meeting to enable a recording bot, using the sdk, to connect and start local recording. requires enabling local recording in zoom settings. applicable rate limit: light.
</Accordion>

<Accordion title="Get a webinar poll">
  Access webinar poll details with `webinar:read:admin` or `webinar:read` scopes. for specific poll info, use `webinar:read:poll` or its admin version. it's under `light` rate limit.
</Accordion>

<Accordion title="Add a meeting registrant">
  This text guides on creating and customizing a user's registration for a zoom meeting, with a max of 4,999 registrants. preconditions include the host being licensed. api scopes and a light rate limit apply.
</Accordion>

<Accordion title="Get a webinar">
  Access zoom webinar details requires pro or higher plan and webinar add-on. scopes include `webinar:read:admin` and `webinar:read`. granular scopes and a 'light' rate limit also apply.
</Accordion>

<Accordion title="Delete a webinar s branding virtual backgrounds">
  This api allows the deletion of webinar session branding, specifically virtual backgrounds. requires the webinar session branding setting enabled. accessible with `webinar:write` and `webinar:write:admin` scopes. rate limit is light.
</Accordion>

<Accordion title="Add a new device">
  Add a new device to a zoom account, requiring `device:write:admin` scope with a `medium` rate limit.
</Accordion>

<Accordion title="Enable sip phone">
  Zoom's psi allows integration of sip phones with supported pbx systems (cisco, avaya) for softphone functionality within zoom. requires enabling by account owner/admin through sales. scope: `sip phone:write:admin`, rate limit: `light`.
</Accordion>

<Accordion title="Get a webinar registrant">
  Zoom's webinar feature supports broadcasting to up to 10,000 attendees, requiring registration and a webinar plan. it includes an api for user details and comes with a 'light' rate limit.
</Accordion>

<Accordion title="Get a webinar survey">
  Zoom's webinar survey feature requires a pro or higher plan and an add-on, enabled in the host's account. it's governed by scopes (`webinar:read:admin`, `webinar:read`) and granular scopes, with a `light` rate limit.
</Accordion>

<Accordion title="Get a webinar sip uri with passcode">
  To obtain a webinar's sip uri, include its id, any passcode, and participant code. api also displays subscription status, participant code, and uri lifespan. necessary scopes and a light rate limit apply.
</Accordion>

<Accordion title="Get a user s tsp account">
  This api retrieves details for a user's specific tsp account, with a two-account maximum per user. it requires `tsp:read:admin` or `tsp:read` scopes and has a 'light' rate limit.
</Accordion>

<Accordion title="Create a recording registrant">
  Zoom offers on-demand cloud recordings of past meetings, accessible to registered users via an api. api scopes required are `recording:write:admin` and `recording:write`, with a 'light' rate limit.
</Accordion>

<Accordion title="Get a webinar s join token for live streaming">
  Api provides a webinar archive token for live streaming via zoom sdk and supports both live and raw streaming. prerequisites include pro plan with webinar add-on and enabling streaming in settings. scopes and light rate limit apply.
</Accordion>

<Accordion title="Get a webinar s archive token for local archiving">
  This api provides a webinar's archive token for real-time access to raw audio and video streams, requiring a pro plan, webinar add-on, and enabled archive settings. rate limit: light.
</Accordion>

<Accordion title="Get billing invoice reports">
  Access department billing invoices using `billing id` from the get billing reports api. requires pro account, department billing, `report:read:admin`, and `report:read:billing invoice:admin` scope. heavy rate limits apply.
</Accordion>

<Accordion title="Delete a meeting">
  Delete a meeting. **scopes:** `meeting:write:admin`,`meeting:write` **[rate limit label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `light`
</Accordion>

<Accordion title="Get a webinar s join token for local recording">
  Api provides a join token for webinar local recording via a bot using zoom sdk, supporting standard and raw types. requires pro plan, webinar add-on, and enabled setting. scopes: webinar token:read. rate limit: light.
</Accordion>

<Accordion title="Get account s tsp information">
  Access telephony service provider info at account level requires a pro plan or higher, `tsp:read:admin` scope, and falls under `light` rate limit according to zoom's api.
</Accordion>

<Accordion title="Get a meeting survey">
  Zoom's post-meeting survey and reporting require a pro license, enabled survey feature, and scheduled meeting setup. it applies to `meeting:read` and `meeting:read:admin` scopes with a `light` rate limit.
</Accordion>

<Accordion title="Get billing reports">
  To get zoom account department billing reports, require a pro/higher account with department billing enabled and permission scopes `report:read:admin` and `report:read:billing:admin`. contact zoom support for setup. note: heavy rate limits apply.
</Accordion>

<Accordion title="Delete a webinar s branding wallpaper">
  This api removes a webinar's session branding wallpaper file, requiring the webinar session branding setting and `webinar:write` or `webinar:write:admin` scopes. it has a light rate limit.
</Accordion>

<Accordion title="Get livestream details">
  Zoom supports livestreaming meetings to a custom platform, requiring a pro plan or higher, pre-configuration of streaming details, and observing rate limits. it provides stream url, stream key, and page url for the stream.
</Accordion>

<Accordion title="Get live stream details">
  Zoom webinar live stream setup requires pro plan or higher, webinar add-on, and pre-configured streaming details. it supports custom platforms, including stream url, stream key, and page url. rate limit: light.
</Accordion>

<Accordion title="Add a user s tsp account">
  Add a user's tsp account. **scopes:** `tsp:write:admin`,`tsp:write` **[rate limit label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `light`
</Accordion>

<Accordion title="Get meeting detail reports">
  Obtain a thorough report for a previous meeting. requirements: pro plan or higher, with admin rights to read reports. rate limit is categorized as heavy.
</Accordion>

<Accordion title="Create a tracking field">
  Use the api to create tracking fields for zoom, allowing analysis of usage by organization fields. prerequisites include a business or higher plan. rate limit is light.
</Accordion>

<Accordion title="Get active inactive host reports">
  Generate reports for active or inactive hosts within the last 6 months, limited to a month's range. active hosts have hosted meetings; inactive have not. requires pro plan or higher and specific admin permissions. rate limit: heavy.
</Accordion>

<Accordion title="Get cloud recording usage report">
  Get cloud recording usage report for the last 6 months, up to yesterday, with a max date range of 30 days. requires pro plan or higher, `report:read:admin` scope, and has a `heavy` rate limit.
</Accordion>

<Accordion title="Get a meeting s archived files">
  To access archived files for a specific meeting, ensure your account has the meeting and webinar archiving feature enabled by zoom support. requires `recording:read` scope. rate limit label: light.
</Accordion>

<Accordion title="Change device">
  Change device name. **prerequisites:** \* device must be enrolled in zmd (zoom device management) **scopes:** `device:write:admin` **[rate limit label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `medium`
</Accordion>

<Accordion title="Delete a meeting recording file">
  To delete a meeting recording, enable "the host can delete cloud recordings" in zoom's recording settings. permissions needed are `recording:write:admin` and `recording:write` with a light rate limit.
</Accordion>

<Accordion title="Get daily usage report">
  The daily report provides zoom service usage details, like new users, meetings, participants, and minutes per day for a month, requiring a pro plan or higher. it has a 'heavy' rate limit.
</Accordion>

<Accordion title="Delete device">
  Delete a device from a zoom account. **prerequisites:** \* device must be enrolled in zmd (zoom device management) **scopes:** `device:write:admin` **[rate limit label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `heavy`
</Accordion>

<Accordion title="Get device detail">
  Retrieve a device's details. **scopes:** `device:read:admin`,`device:write:admin` **[rate limit label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `heavy`
</Accordion>

<Accordion title="Assign a device to a user or commonarea">
  Assign, move, or remove a device for a user/common area within zoom device management (zdm). requires the device to be enrolled in zdm and appropriate admin scopes. rate limit category is medium.
</Accordion>

<Accordion title="Delete a meeting registrant">
  Delete a meeting registrant. **scopes:** `meeting:write:admin`,`meeting:write` **[rate limit label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `light`
</Accordion>

<Accordion title="Change device association">
  Api allows changing zoom room device associations, requiring enrollment in zoom device management (zmd) with admin write access. rate limit is medium.
</Accordion>

<Accordion title="Delete a meeting poll">
  Meeting hosts can survey attendees using polls, but polls must be deleted post-meeting. requirements: pro account, enabled polling, and a scheduled meeting. rate limit: light.
</Accordion>

<Accordion title="Add panelists">
  Panelists in webinars have access to more features like video sharing and screen sharing compared to attendees. adding panelists requires a pro or higher zoom plan with webinar add-on and specific scopes. rate limit label is medium.
</Accordion>

<Accordion title="Create a webinar s branding name tag">
  Use the api to create up to 20 name tags for a webinar's session branding. requires enabled webinar session branding setting and `webinar:write`, `webinar:write:admin` scopes. rate limit is medium.
</Accordion>

<Accordion title="Create a webinar s poll">
  Learn how to create a poll for a webinar, including permissions needed (webinar:write, admin) and specific abilities (poll creation). rate limit category is light.
</Accordion>

<Accordion title="Delete meeting recordings">
  Summary: to delete all meeting recordings, ensure the user's account has cloud recording enabled. required permissions include `recording:write:admin` and `recording:write` with a `light` rate limit label.
</Accordion>

<Accordion title="Create a webinar template">
  Use this api to create a webinar template from an existing webinar. **scopes:** `webinar:write:admin`,`webinar:write` **[rate limit label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `medium`
</Accordion>

<Accordion title="Add a webinar registrant">
  Zoom users with a webinar plan can create and manage webinars, broadcasting to up to 10,000 attendees. registration requires a pro plan, specific permissions, and is governed by a "light" rate limit.
</Accordion>

<Accordion title="Create a webinar">
  To schedule a host's webinar, use 'me' in user-level apps. max 10,000 attendees, 100 daily requests. needs pro plan or higher, webinar add-on, `webinar:write` scopes, and falls under 'light' rate limit.
</Accordion>

<Accordion title="Get meeting invitation">
  Retrieve the meeting invitation note for a specific meeting. **scopes:** `meeting:read`,`meeting:read:admin` **[rate limit label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `light`
</Accordion>

<Accordion title="Get meeting recordings">
  To download meeting recordings, use `download url`. include oauth token in the header for passcode-protected ones. supports `recording:read` and `phone recording:read:admin` scopes, with a `light` rate limit.
</Accordion>

<Accordion title="Get meeting recording settings">
  This text outlines the api for retrieving zoom cloud recording settings for meetings, specifying required scopes (`recording:read:admin` and `recording:read`) and indicating a `light` rate limit label.
</Accordion>

<Accordion title="Get meeting participant reports">
  Use this api to generate past meeting reports with multiple participants, excluding solo participant reports. note: information may be limited without a hipaa baa. requires pro plan, specific admin scopes, and adheres to heavy rate limits.
</Accordion>

<Accordion title="Get meeting reports">
  Retrieve reports on past zoom meetings and webinars within a six-month period, limited to one month at a time, requiring at least two unique participants. applicable for pro plans or higher, with specific admin scopes. rate limit label: heavy.
</Accordion>

<Accordion title="Get webinar q a report">
  Summary: get a report of q\&as from past webinars, requiring a pro/higher plan with webinar add-on, and specific admin permissions. rate limit category: heavy.
</Accordion>

<Accordion title="Get webinar detail reports">
  Access past webinar details through a report, requiring a pro or higher plan with webinar add-on. it needs `report:read:admin` and `report:read:webinar:admin` scopes and is subject to a `heavy` rate limit.
</Accordion>

<Accordion title="Get meeting q a report">
  Summary: access past meeting q\&a reports requires a pro plan or higher, with `report:read:admin` and `report:read:meeting qna:admin` scopes. note the `heavy` rate limit label.
</Accordion>

<Accordion title="Get operation logs report">
  The zoom operations logs report allows auditing of user and admin actions like additions, setting adjustments, and recording deletions within a period. it requires at least a pro plan and specific scopes, with a high rate limit.
</Accordion>

<Accordion title="Get webinar participant reports">
  Access detailed reports on webinar attendees for up to 6 months. requires pro or higher plan with webinar add-on. necessary scopes include `report:read:admin` and `report:read:list webinar participants:admin`. rate limit label: heavy.
</Accordion>

<Accordion title="Get meeting poll reports">
  This api allows fetching past meeting poll results. requirements: pro plan or higher, `report:read:admin` and `report:read:list meeting polls:admin` scopes. rate limit is heavy.
</Accordion>

<Accordion title="Get meeting recording s analytics summary">
  Access zoom meeting recording analytics with a 1-month max duration using an oauth token. use specific api scopes and note the medium rate limit. example: `curl` command with authorization header.
</Accordion>

<Accordion title="Get meeting survey report">
  To access past meeting survey reports on zoom, a pro or higher plan is needed, with `report:read:admin` and `report:read:meeting survey:admin` permissions. rate limit label is `heavy`.
</Accordion>

<Accordion title="Get webinar poll reports">
  Access past webinar polls report on zoom with a pro/higher plan and webinar add-on. requires `report:read:admin` and `report:read:list webinar polls:admin` permissions. rate limit: heavy.
</Accordion>

<Accordion title="List all recordings">
  This text details how to list zoom cloud recordings for a user, notably by using "me" for user-level apps and requiring an oauth token for access. it requires a pro plan, cloud recording enabled, and has a medium rate limit.
</Accordion>

<Accordion title="List past meetings q a">
  Zoom meetings' q\&a feature allows participants to ask and answer questions during a meeting. specific meeting q\&as are listed, requiring `meeting:read:admin` and `meeting:read` scopes, with a 'medium' rate limit.
</Accordion>

<Accordion title="List meeting polls">
  Meeting hosts with pro or higher plans can poll attendees in scheduled meetings, but not in instant meetings. polls are listed with "light" rate limits under `meeting:read:admin` and `meeting:read` scopes.
</Accordion>

<Accordion title="List past meeting instances">
  Return a list of past meeting instances. **scopes:** `meeting:read:admin`,`meeting:read` **[rate limit label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `medium`
</Accordion>

<Accordion title="List meetings">
  This zoom api lists a user's scheduled meetings using the `me` value for user-level apps, excluding instant meetings and only showing unexpired ones. it requires specific scopes and has a `medium` rate limit.
</Accordion>

<Accordion title="Get meeting s token">
  Get a zoom meeting closed caption token to use with third-party captioning services by enabling specific settings. it requires meeting read permissions and has a 'light' rate limit.
</Accordion>

<Accordion title="Perform batch poll creation">
  Meeting hosts can survey attendees using polls after meeting the prerequisites: pro account or higher, polling enabled, and scheduled meetings only. rate limit: light.
</Accordion>

<Accordion title="Get webinar survey report">
  Access past webinar survey reports with a pro plan or higher and webinar add-on. requires `report:read:admin` and `report:read:webinar survey:admin` scopes. note: heavy rate limit applies.
</Accordion>

<Accordion title="List registration questions for meeting">
  This text provides details on registering for a meeting via zoom, including the required api scopes (meeting:read, meeting:read:admin) and the rate limit label, which is categorized as "light."
</Accordion>

<Accordion title="Get meeting recording s analytics details">
  Access zoom meeting recording analytics and download within 1 month using oauth token in the authorization header. requires scopes `recording:read:admin`,`recording:read` with a medium rate limit.
</Accordion>

<Accordion title="List sip phones">
  Zoom's phone system integration allows organizations to connect the zoom client to cisco or avaya pbx systems for softphone functionality. users must contact sales to enable it. this api lists sip phones on an account. rate limit: medium.
</Accordion>

<Accordion title="List registration questions for webinar">
  To register for a webinar, users must fill out a form with specific fields and questions. requirements include a pro or higher plan with a webinar add-on and certain access scopes.
</Accordion>

<Accordion title="List past meeting s poll results">
  Zoom meeting polls enable hosts to survey attendees and list results, but only for pro account holders in scheduled meetings. polling is not available for instant meetings. rate limit: medium.
</Accordion>

<Accordion title="List user s tsp accounts">
  A user can have a maximum of two tsp accounts. use this api to list all tsp accounts of a user. **scopes:** `tsp:read:admin`,`tsp:read` **[rate limit label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `medium`
</Accordion>

<Accordion title="List webinars">
  The api lists all scheduled webinars for zoom users with a webinar plan, using `me` for user-level apps. it only shows unexpired webinars for hosts broadcasting to up to 10,000 attendees. requires pro plan upwards and specific scopes. rate limit: medium.
</Accordion>

<Accordion title="List upcoming meetings">
  The api lists a zoom user's upcoming meetings within the next 24 hours, covering both scheduled and invited ones. use `me` for user-level apps. requires `meeting:read` scopes. rate limit: medium.
</Accordion>

<Accordion title="List tracking fields">
  Use the api to view all tracking fields on zoom for usage analysis. requires business, education, api plan or higher. scope: tracking fields:read:admin. rate limit: medium.
</Accordion>

<Accordion title="Get past meeting details">
  Get information about a past meeting. **scopes:** `meeting:read:admin`,`meeting:read` **[rate limit label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `light`
</Accordion>

<Accordion title="List past webinar instances">
  The text details api permissions and rate limit for listing past webinar instances, including scopes like `webinar:read:admin` and `webinar:read`, with a `light` rate limit.
</Accordion>

<Accordion title="List recording registrants">
  This api lists past meeting registrants for on-demand cloud recordings. viewers must register to access. it requires `recording:read:admin` and `recording:read` scopes with a medium rate limit.
</Accordion>

<Accordion title="List archived files">
  Zoom's archiving solution enables administrators to automatically record and archive meeting data to third-party platforms for compliance, needing the meeting and webinar archiving feature enabled.
</Accordion>

<Accordion title="List meeting registrants">
  Zoom meetings can require registration by a host or admin. it allows listing of registered users and has `meeting:read:admin` and `meeting:read` scopes with a medium rate limit.
</Accordion>

<Accordion title="List webinar participants">
  Get a list of past webinar participants with a pro plan or above plus an add-on. requires specific scopes and has a medium rate limit.
</Accordion>

<Accordion title="List past webinar poll results">
  This api endpoint fetches results for webinar polls, supporting single or multiple-choice questions. requirements include a webinar license and specific scopes with a medium rate limit.
</Accordion>

<Accordion title="Perform batch registration">
  Summarize: licensed zoom users can register up to 30 attendees at once for scheduled meetings requiring registration. not applicable to instant or recurring meetings. requires `meeting:write` permissions. rate limit label: heavy.
</Accordion>

<Accordion title="Get past meeting participants">
  Api allows paid users (pro+) to fetch past meeting attendee info, excluding solo participants. requires double encoding for certain uuids, with `meeting:read` scope and others. rate limit is medium.
</Accordion>

<Accordion title="Set global dial in url for a tsp user">
  An api allows setting the url for a user's global dial-in page in zoom with tsp and third-party audio options. applicable scopes are `tsp:write:admin`, `tsp:write`, and it has a `light` rate limit.
</Accordion>

<Accordion title="Remove webinar panelists">
  To remove all panelists from a webinar, ensure you have a pro plan or higher with the webinar add-on. required access includes `webinar:write` and `webinar:delete:panelist` scopes, under a `light` rate limit.
</Accordion>

<Accordion title="Zoom Schedule User Webinar With Registration">
  Schedule a webinar for up to 30 participants requiring registration. must be a licensed user & webinar type 5. use specific api scopes with a 'heavy' rate limit label.
</Accordion>

<Accordion title="Update a live meeting message">
  Update a live meeting message by id after enabling zoom's dlp for chat. prerequisites: dlp enabled. scopes: `meeting:write`, `meeting:write:admin`. rate limit: medium.
</Accordion>

<Accordion title="Recover meeting recordings">
  Zoom's api lets pro users with cloud recording enabled recover deleted recordings from trash within 30 days. it applies to specific meetings and has a 'light' rate limit. scopes required: `recording:write:admin`,`recording:write`.
</Accordion>

<Accordion title="Recover a single recording">
  Zoom's api enables users to restore recordings from the trash within 30 days of deletion. it supports recovery of individual meeting files. requires `recording:write:admin` or `recording:write` scopes. rate limit category is `light`.
</Accordion>

<Accordion title="Get registration questions">
  Use the api to fetch questions displayed for user registration to view specific meeting on-demand recordings. includes fields for question inclusion. scopes: `recording:read:admin`, `recording:read`. rate limit: light.
</Accordion>

<Accordion title="Remove a panelist">
  To remove a webinar panelist, first get their `panelistid` via the list panelists api. requirements: pro/higher plan with webinar add-on. scopes needed: webinar:write, write:admin, delete:panelist, delete:panelist:admin. rate limit: light.
</Accordion>

<Accordion title="List q as of a past webinar">
  The text describes zoom's q\&a feature for webinars, allowing attendees to ask questions and panelists to answer, lists prerequisites like a webinar license, scopes for accessing past q\&as, and mentions a 'medium' rate limit.
</Accordion>

<Accordion title="List meeting summaries of an account">
  Generates meeting summaries for pro account holders with ai companion enabled, excluding e2ee meetings. requires scopes `meeting summary:read:admin` and `meeting:read:list summaries:admin`. rate limit: medium.
</Accordion>

<Accordion title="List a user s pac accounts">
  To list a user's pac accounts on zoom, use the 'me' value for user-level apps. requires pro plan or higher with audio conferencing subscription and pac enabled. scopes: `pac:read:admin`, `pac:read`. rate limit: light.
</Accordion>

<Accordion title="List meeting templates">
  To access zoom meeting templates for user-level apps, use `me` instead of `userid`. scopes required are `meeting:read` and `meeting:read:admin`, with a medium rate limit.
</Accordion>

<Accordion title="Update a live stream">
  To update webinar live stream info, you need a pro plan with add-on, pre-configured streaming details, and specific permissions. rate limit is light.
</Accordion>

<Accordion title="Get webinar s session branding">
  This api lets you customize webinars with wallpapers and virtual backgrounds for participants, requiring a pro plan, webinar add-on, and session branding enabled. rate limit: light.
</Accordion>

<Accordion title="Update a tsp account">
  Update a user's tsp account. **scopes:** `tsp:write:admin`,`tsp:write` **[rate limit label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `light`
</Accordion>

<Accordion title="Update a webinar s branding name tag">
  Use the api to change a webinar's session branding name tag, requiring the setting enabled and `webinar:write`,`webinar:write:admin` scopes. rate limit is medium.
</Accordion>

<Accordion title="List webinar registrants">
  Zoom users with a webinar plan can list registrants for webinars, requiring a pro plan or higher and webinar add-on. webinars broadcast to up to 10k attendees. registration is mandatory.
</Accordion>

<Accordion title="Update live stream status">
  Zoom allows live streaming webinars to custom platforms for users with pro or higher plans and a webinar add-on, after configuring live streaming details. scopes include webinar writing/admin, with light rate limits.
</Accordion>

<Accordion title="Update livestream status">
  Zoom supports livestreaming meetings to custom platforms with options to update livestream status, requiring a host with a pro license and specific permissions. rate limit label: light.
</Accordion>

<Accordion title="List panelists">
  Webinar panelists have enhanced capabilities like video, screen share, and annotating, requiring a pro/higher plan with webinar add-on. access controls include `webinar:read:admin` and others, with a medium rate limit.
</Accordion>

<Accordion title="List webinar templates">
  Zoom users with a pro account or higher can list webinar templates and use them for scheduling future webinars by using `template id` in the api. for user-level apps, use `me` instead of `userid`. requires `webinar:read` or admin equivalents.
</Accordion>

<Accordion title="Update meeting status">
  Update the status of a meeting. **scopes:** `meeting:write:admin`,`meeting:write` **[rate limit label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `light`
</Accordion>

<Accordion title="Update webinar registration fields">
  Update webinar registration questions/fields for user completion to receive the join link. requires pro/higher plan with webinar add-on, and registration set as required. rate limit: light.
</Accordion>

<Accordion title="Update a meeting poll">
  Meeting hosts can survey attendees with polls. requires `meeting:write:admin` or `meeting:write` scopes. rate limit is `light`. more info: [zoom polling](https://support.zoom.us/hc/en-us/articles/213756303-polling-for-meetings).
</Accordion>

<Accordion title="Update registrant s status">
  This api lets you update a registrant's status for accessing an on-demand recording, with either approval or denial. it requires `recording:write:admin` or `recording:write` scopes and has a medium rate limit.
</Accordion>

<Accordion title="List a webinar s polls">
  The text outlines zoom webinar's api for listing polls, including required scopes (`webinar:read:admin`, `webinar:read`, `webinar:read:list polls`, `webinar:read:list polls:admin`) and mentioning its `light` rate limit label.
</Accordion>

<Accordion title="Update meeting registrant status">
  Update meeting registrant status to approve, cancel, or deny participation. requires `meeting:write:admin`, `meeting:write` scopes. rate limit: medium.
</Accordion>

<Accordion title="Update meeting recording settings">
  Updated settings for zoom's cloud recording feature. applicable scopes: recording:write, recording:write:admin. rate limit label: light.
</Accordion>

<Accordion title="Update webinar registrant status">
  Update webinar registrants' status: approve, deny, or revoke. requires `webinar:write` or admin scopes. features granular scopes for registrant status updates. rate limit: medium.
</Accordion>

<Accordion title="List devices">
  This api lets you list devices. **scopes:** `device:read:admin`,`device:write:admin` **[rate limit label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `heavy`
</Accordion>

<Accordion title="Get webinar s token">
  Get a closed caption token for zoom webinars to enable third-party closed captioning by visiting the provided link. requires a pro plan, webinar add-on, and specific settings enabled. rate limit: light.
</Accordion>

<Accordion title="Upgrade zpa os app">
  Upgrade zpa firmware/app via zoom device manager group id. needs `device:write:admin` or more specific permissions. rate limit is classified as `heavy`.
</Accordion>

<Accordion title="List h 323 sip devices">
  H.323/sip devices can make or receive calls via a room connector to join zoom meetings. this api lists all such devices on a zoom account. scopes: h323:read:admin. rate limit: medium.
</Accordion>

<Accordion title="Update registration questions">
  This api lets you update registration questions for viewers of on-demand meeting recordings, with fields displayed during registration. it requires `recording:write:admin` and `recording:write` scopes and has a `light` rate limit.
</Accordion>

<Accordion title="Update sip phone">
  Zoom's psi allows integrating supported pbx systems like cisco and avaya for softphone use. account owners/admins must enable sip phone integration. it also offers an api for sip info updates with a light rate limit.
</Accordion>

<Accordion title="Upload a webinar s branding wallpaper">
  This api lets you upload one webinar branding wallpaper in jpg/jpeg, gif, or png format, with a 16:9 ratio, ideally 1920x1080 px, not exceeding 15mb. requires "webinar session branding" enabled and has a medium rate limit.
</Accordion>

<Accordion title="Zoom Update Zoom Meeting Registration Questions">
  Update questions shown to users during meeting registration on zoom. applicable scopes: `meeting:write`, `meeting:write:admin`. rate limit label: `light`.
</Accordion>

<Accordion title="Upload a webinar s branding virtual background">
  Use the provided api to upload up to 10 virtual backgrounds for webinar sessions, in jpg/jpeg, gif, or png format, not exceeding 15mb. requires webinar session branding setting and `webinar:write` scopes. rate limit is medium.
</Accordion>

<Accordion title="Update webinar status">
  This api ends an ongoing webinar. requires a valid webinar plan, `webinar:write` and `webinar:update:status` scopes. rate limit is light.
</Accordion>

<Accordion title="Get zdm group info">
  Retrieve zoom device manager group details for an account, requiring `device:read:admin` or granular `device:read:list groups:admin/master` permissions. rate limit: medium.
</Accordion>

<Accordion title="Update a meeting">
  To update a meeting via api, ensure `start time` is future-dated; `recurrence` is needed. limit: 100 requests/day, 100 updates/meeting in 24 hrs. requires `meeting:write` and `meeting:write:admin` scopes, with a `light` rate limit.
</Accordion>

<Accordion title="Update a webinar poll">
  Update webinar polls in zoom with `webinar:write` and `webinar:write:admin` scopes. granular scopes include `webinar:update:poll` and `webinar:update:poll:admin`. rate limit is light.
</Accordion>

<Accordion title="Update a tracking field">
  This api allows updating tracking fields on zoom, requiring a business, education, api or higher plan, with `tracking fields:write:admin` scope. rate limit: light.
</Accordion>

<Accordion title="Update a webinar">
  Update your scheduled webinar up to 100 times daily per webinar host's userid. requires a pro plan or higher plus a webinar add-on. scopes include webinar:write and admin updates, with a 'light' rate limit label.
</Accordion>

<Accordion title="Update a meeting survey">
  To update a zoom meeting survey, the host must be a pro user with the feature enabled for scheduled meetings. required scopes are meeting:write:admin and meeting:write. the rate limit is light.
</Accordion>

<Accordion title="Get webinar tracking sources">
  Zoom's webinar registration tracking sources feature allows users to analyze where registrants come from, aiding in marketing strategy optimization. it needs a webinar license, registration, and permissions, with a 'medium' rate limit.
</Accordion>

<Accordion title="Use in meeting controls">
  Zoom meeting controls allow for managing recordings and inviting participants. cloud recording is necessary; local not supported. requires live meeting, host status, and specific permissions with a medium rate limit.
</Accordion>

<Accordion title="Get zpa version info">
  Get zpa firmware/app version upgrade info. scopes: `device:read:admin`. granular: `device:read:list zpa versions:admin`, `device:read:list zpa versions:master`. rate limit: medium.
</Accordion>

<Accordion title="Get telephone reports">
  The telephone report api offers data on who joined meetings by phone, their dial-in number, and more, for a given time. it requires a pro plan, specific admin read scopes, and has a heavy rate limit.
</Accordion>

<Accordion title="Get webinar absentees">
  This text details api permissions for viewing absentees of a webinar, including specific scopes and granular scopes, and notes that the rate limit label for this action is categorized as "heavy."
</Accordion>

<Accordion title="Get sign in  sign out activity report">
  Get zoom user sign in/out logs with a pro plan or higher. requires `report:read:admin` and `report:read:user activities:admin` scopes. rate limit is heavy.
</Accordion>

<Accordion title="Update a webinar survey">
  To update a zoom webinar survey, you need a pro plan or higher with a webinar add-on, enable the survey feature, have `webinar:write` and survey update permissions, under a `light` api rate limit.
</Accordion>

<Accordion title="Update a h 323 sip device">
  H.323/sip devices can use a room connector to join/invite to zoom meetings. use the api to edit device info in your zoom account. scopes: h323:write:admin. rate limit: light.
</Accordion>

<Accordion title="Get upcoming events report">
  This api lists upcoming meetings/webinars within a month for users with a pro plan or higher. it requires `report:read:admin` and `report:read:upcoming meetings webinars:admin` scopes. rate limit: heavy.
</Accordion>

<Accordion title="Update a livestream">
  Update livestream details on zoom for meetings to a custom platform. requires a pro license host. applicable scopes are `meeting:write:admin`, `meeting:write`. rate limit is light.
</Accordion>

<Accordion title="Update an archived file s auto delete status">
  To update an archived file's auto-delete status on zoom, ensure your account has the archiving feature enabled and auto-delete disabled by contacting zoom support. requires `recording:write` scopes. rate limit: light.
</Accordion>

<Accordion title="Update account s tsp information">
  Summary: update an account's telephony service provider (tsp) settings, ensuring the tsp account option is enabled. requires `tsp:write:admin` scope and adheres to the `light` rate limit.
</Accordion>

<Accordion title="Set webinar s default branding virtual background">
  Use the api for setting a webinar's default session branding with a virtual background, requiring an enabled webinar session branding setting, webinar:write and webinar:write:admin scopes. rate limit: light.
</Accordion>


# Zoominfo
Source: https://docs.push.ai/integrations/zoominfo



ZoomInfo is a multiplatform operating system that revenue teams use to deliver business growth.

<Accordion title="Contact Enrich">
  Use this endpoint to match contact information based on input values and return the desired output fields in the response. use contact enrich outputs to retrieve the list of available output fields.returns a list of news articles from zoominfo's data which meet the specified search criteria. all inputs are optional, but you must use at least one input parameter to generate a successful response.
</Accordion>

<Accordion title="Company Enrich">
  Use this endpoint to match contact information based on input values and return the desired output fields in the response. use contact enrich outputs to retrieve the list of available output fields.returns a list of news articles from zoominfo's data which meet the specified search criteria. all inputs are optional, but you must use at least one input parameter to generate a successful response.
</Accordion>

<Accordion title="Scoop Search">
  Returns a list of scoops from zoominfo's data which meet the specified search criteria.
</Accordion>

<Accordion title="Location Enrich">
  Use this endpoint to match contact information based on input values and return the desired output fields in the response. use contact enrich outputs to retrieve the list of available output fields.returns a list of news articles from zoominfo's data which meet the specified search criteria. all inputs are optional, but you must use at least one input parameter to generate a successful response.
</Accordion>

<Accordion title="Technology Enrich">
  Use this endpoint to match contact information based on input values and return the desired output fields in the response. use contact enrich outputs to retrieve the list of available output fields.returns a list of news articles from zoominfo's data which meet the specified search criteria. all inputs are optional, but you must use at least one input parameter to generate a successful response.
</Accordion>

<Accordion title="Scoop Search Inputs">
  Returns a list of fields you can use as input for the scoop search action.
</Accordion>

<Accordion title="Company Search">
  Returns a list of companies from zoominfo's data which meet the specified search criteria.
</Accordion>

<Accordion title="Company Search Inputs">
  Returns a list of fields you can use as input for the company search action.
</Accordion>

<Accordion title="Intent Search Inputs">
  Returns a list of fields you can use as input for the intent action.
</Accordion>

<Accordion title="Contact Search Inputs">
  Returns a list of fields you can use as input for the contact search action.
</Accordion>

<Accordion title="News Search">
  Returns a list of news articles from zoominfo's data which meet the specified search criteria. all inputs are optional, but you must use at least one input parameter to generate a successful response.
</Accordion>

<Accordion title="News Search Inputs">
  Returns a list of fields you can use as input for the news search endpoint.
</Accordion>

<Accordion title="Intent Search">
  Use this endpoint to search for companies and recommended contacts based on intent data. use input values to return the desired output fields in the response. for charging purposes, each intent signal returned is counted as a record.
</Accordion>

<Accordion title="Contact Search">
  Returns a list of contacts from zoominfo's data that meet the specified search criteria.
</Accordion>


# Introduction
Source: https://docs.push.ai/introduction

Welcome to Push.ai

<img alt="Hero Light" />

<img alt="Hero Dark" />

## What is Push.ai?

Push.ai is a business intelligence platform that enables teams to answer any business question.

Push.ai works by first defining a model of your business, using a set of metrics, dimensions, entities and other metadata. After this model is in place, connect with more than 250+ third party applications, to integrate the contextual information of your business through sources of unstructured data. Combining individual pieces from the structured data model and measurement system, with related context is the core mechanism behind the platform and a system we refer to as the Business Graph.

With the Business Graph, users can quickly get answers to business questions, and receive AI-generated updates or analysis that increase organizational knowledge and drive action.

Need additional help? [Send us a message.](mailto:support@push.ai)


# Knowledge
Source: https://docs.push.ai/knowledge/how-it-works

Create versioned documents that align AI with how your business operates.

## What is Knowledge?

Knowledge documents are versioned guidance that the AI refers to during analysis. A
document’s title and description help the AI understand when it should be used, and
linking the document to nodes on the Business Graph™ scopes where it applies.

<img alt="Knowledge document example" />

## Why it matters

* Align AI with your organization’s language, concepts, and decision rubrics
* Produce higher-precision answers and avoid irrelevant exploration
* Generate faster, more accurate Business Reviews with consistent narratives
* Reduce time-to-insight and rework

<Info>
  Knowledge documents are versioned. The AI refers to the latest published version
  that is relevant to the user’s question and graph context.
</Info>

## How it works (at a glance)

* The AI evaluates relevance based on the document’s title, description, content, and
  linked Business Graph™ nodes
* The latest published version is considered the active reference for analysis
* Linking to specific nodes (e.g., a metric or model) focuses retrieval and improves
  alignment with how your business operates

<Tip>
  Write titles and descriptions that clearly communicate when the document should be
  used (scope), who it is for (audience), and what it contains (intent).
</Tip>

## Authoring for better AI outcomes

* Intent, audience, scope: describe when-to-use and when-not-to-use
* Domain glossary: acronyms, synonyms, and internal names your team uses
* Canonical definitions and decision criteria, with examples and counterexamples
* Negative guidance: deprecated terms, common pitfalls, and exceptions

## Create a Knowledge document

### Step 1 - Create and title your document

Use a specific, outcome-oriented title and a descriptive summary so the AI can
recognize applicability.

### Step 2 - Add content and save a draft

Capture definitions, rubrics, narratives, and examples that guide analysis. Save as a
draft while collaborating.

### Step 3 - Link to the Business Graph™

Attach the document to relevant nodes so the AI brings it into context at the right
time.

| Node type    | Examples                          | When to link                                        |
| :----------- | :-------------------------------- | :-------------------------------------------------- |
| Model        | `sales_orders`, `ad_spend_model`  | Authoritative data source or semantic model         |
| Metric       | `ARR`, `CAC`, `Activation Rate`   | Guidance for how to interpret or analyze the metric |
| Dimension    | `region`, `segment`, `channel`    | Definitions, caveats, or grouping guidance          |
| Entity       | `Customer`, `Product`, `Campaign` | Context specific to an object in the graph          |
| Team/Project | `Marketing`, `Q1 GTM`             | Review templates, rituals, or ownership guidance    |

<Warning>
  Over-linking broad nodes (e.g., root-level departments) can introduce irrelevant
  context. Prefer precise links to the exact nodes when possible. Make sure to ground
  the AI with context at the proper level
</Warning>

### Step 4 - Publish a version

Publish to make the document the active version the AI refers to. Iterate by creating
new versions as the business changes. You can compare versions and roll back if
needed.

## Evaluate impact and iterate

* Test representative prompts in the Query Agent and look for improved alignment with
  your terminology and decision criteria
* If results aren’t aligned, refine the title/description and adjust linked nodes
* Track outcomes such as answer precision, review quality, and time-to-insight

## Usage notes and troubleshooting

* Retrieval favors documents linked to the exact nodes in context
* If a document isn’t being referenced: broaden the title terms, refine links, or add
  glossary terms

See the Business Graph™ overview at [/business-graph/how-it-works](/business-graph/how-it-works) and learn about
asking questions in the Query Agent at [/query-agent/query-agent](/query-agent/query-agent).


# Knowledge Use Cases
Source: https://docs.push.ai/knowledge/use-cases

Canonical knowledge patterns that align AI with how your business operates.

<Info>
  These are canonical documents for the AI to refer to. They encode institutional
  knowledge so analysis reflects how your business actually operates.
</Info>

## Department Operating Guides (Sales, Marketing, Support, Finance)

* **Outcome**: The AI understands how each department works and frames analysis in the
  right operating context.
* **Include**: Org structure and responsibilities; core processes and handoffs;
  SLAs; cadences (pipeline reviews, forecast calls); definitions of success; common
  edge cases.
* **Link to**: Department/team nodes; key models; core metrics and dimensions;
  relevant entities (e.g., Opportunity, Ticket, Invoice).
* **Title examples**: `Sales Operations Guide`, `Marketing Analytics Operating Model`.

## Business Glossary and Taxonomy

* **Outcome**: Consistent terminology and fewer misunderstandings across teams.
* **Include**: Canonical terms; synonyms and forbidden terms; calculation notes;
  naming conventions; examples and counterexamples for tricky concepts.
* **Link to**: Models, metrics, and dimensions the terms govern.
* **Title examples**: `Enterprise Segment Glossary`, `Attribution Taxonomy`.

## Metric Interpretation and Decision Rubrics

* **Outcome**: Analyses read metrics the way your business does and recommend actions
  consistent with policy.
* **Include**: Metric purpose; leading/lagging relationships; how to read changes;
  expected ranges and seasonality; common pitfalls; decision criteria and next-best-
  actions.
* **Link to**: Metric nodes and the dimensions used to break them down.
* **Title examples**: `ARR Interpretation Guide`, `Activation Rate Decision Rubric`.

## Data Lineage, Quality, and Ownership

* **Outcome**: The AI respects data limitations and routes questions to the right
  sources.
* **Include**: Source systems; refresh cadences; known gaps/quirks; authoritative vs.
  derived datasets; owner contacts and escalation process.
* **Link to**: Models and pipelines; metrics that depend on them; data owner/team nodes.
* **Title examples**: `Revenue Model Lineage & Quality Notes`, `Attribution Data Owner Guide`.

## Strategic Initiatives and Quarterly Focus

* **Outcome**: Business Reviews and analyses prioritize current strategic goals.
* **Include**: Objectives and hypotheses; guardrails; success measures; relevant time
  windows; key stakeholders and dependencies.
* **Link to**: Project/initiative nodes; teams; impacted metrics; regions/categories.
* **Title examples**: `Q1 Growth Initiatives`, `Cost Optimization Program Overview`.

## Customer and Segment Definitions

* **Outcome**: Customer-facing analyses reflect real segmentation and account context.
* **Include**: Segmentation logic; named segment lists; strategic customers; lifecycle
  stages and triggers; notable exceptions.
* **Link to**: `Customer`/`Account` entities; segment dimensions; revenue/retention metrics.
* **Title examples**: `Enterprise Segmentation Framework`, `Strategic Accounts Playbook`.

## Pricing, Discounts, and Policy Constraints

* **Outcome**: Analyses interpret revenue and conversion with the right pricing context.
* **Include**: Discount policy; approval thresholds; common exceptions; how pricing
  impacts key metrics; reporting caveats.
* **Link to**: Revenue metrics (`ARR`, `Bookings`); deal/opportunity entities; Finance team.
* **Title examples**: `Discount Policy Guide`, `Pricing Context for Revenue Analysis`.

## Seasonality and Event Calendars

* **Outcome**: Variance is attributed correctly given seasonal effects and events.
* **Include**: Calendars (holidays, events, campaigns); expected uplift/drag; blackout
  periods; known interactions (e.g., weather, geo-specific patterns).
* **Link to**: `Region`, `Category`, and `Campaign` nodes; affected metrics and dimensions.
* **Title examples**: `Retail Holiday Context`, `Event & Seasonality Calendar`.

### Do vs Avoid

* **Do**: Make titles and descriptions explicit about scope and audience
* **Do**: Link to the exact nodes users query so the right guidance is referenced
* **Avoid**: Over-linking high-level nodes that pull unrelated context
* **Avoid**: Vague titles like "Marketing Guide" without scope or ownership


# Data Processing Agreement
Source: https://docs.push.ai/legal/data-processing-agreement



This Data Processing Agreement ("DPA") is entered into by and between Push AI, Inc. ("Data Processor") and the Customer ("Data Controller") (collectively referred to as the "Parties").

### Definitions

1.1. "Data Controller" refers to the party that determines the purposes and means of the processing of personal data.

1.2. "Data Processor" refers to the party that processes personal data on behalf of the Data Controller.

1.3. "Personal Data" refers to any information relating to an identified or identifiable natural person.

1.4. "Processing" refers to any operation performed on personal data, such as collection, recording, organization, storage, adaptation, alteration, retrieval, consultation, use, disclosure, erasure, or destruction.

### Sub-processors

2.1. The Data Processor engages sub-processors to assist in the provision of the services, which can be seen in Exhibit A.

### Data Processing Obligations

3.1. Compliance with Laws: The Data Processor shall process Personal Data in compliance with all applicable data protection laws, regulations, and industry standards.

3.2. Confidentiality: The Data Processor shall ensure that any person authorized to process Personal Data is subject to an appropriate duty of confidentiality.

3.3. Security Measures: The Data Processor shall implement and maintain appropriate technical and organizational measures to protect the Personal Data from unauthorized access, loss, disclosure, alteration, or destruction.

3.4. Subprocessing: The Data Processor shall provide a current list of all sub-processors engaged in the processing of Personal Data to the Data Controller. The Data Processor shall ensure that any sub-processor is bound by data protection obligations through a written agreement.

3.5. Data Subject Rights: The Data Processor shall assist the Data Controller in responding to data subject requests, including requests to access, rectify, delete, or restrict the processing of Personal Data.

3.6. Data Breach Notification: In the event of a personal data breach, the Data Processor shall promptly notify the Data Controller about the breach and provide all necessary information to assist the Data Controller in fulfilling its obligations under applicable data protection laws.

### Data Controller Responsibilities

4.1. Lawful Basis: The Data Controller shall ensure that it has a lawful basis for the processing of Personal Data and that the necessary consents or authorizations have been obtained, where applicable.

4.2. Instructions: The Data Controller shall provide written instructions to the Data Processor regarding the processing of Personal Data. The Data Processor shall not process the Personal Data for any purpose other than as instructed by the Data Controller.

4.3. Data Subject Rights: The Data Controller shall be responsible for responding to data subject requests related to the exercise of their rights under applicable data protection laws.

### Data Transfer

5.1. Data transfers to third countries or international organizations may only occur with the prior written consent of the Data Controller and in compliance with applicable data protection laws.

### Term and Termination

6.1. This DPA shall remain in effect for the duration of the data processing activities or until terminated in accordance with the terms set forth herein or in the Terms of Service.

### Exhibit A: List of Sub-Processors

The following sub-processors are engaged by the Data Processor for the processing of Personal Data:

| Sub-processor name        |     Sub-processor Activities     | Processing Location |
| ------------------------- | :------------------------------: | ------------------- |
| Render Services, Inc.     |   cloud computing and analysis   | United States       |
| Planetscale, Inc.         | cloud computing and data hosting | United States       |
| Heroku (Salesforce, Inc.) |          cloud computing         | United States       |
| Amazon Web Services, Inc. | cloud computing and data hosting | United States       |
| OpenAI L.L.C.             |      artifical intelligence      | United States       |


# Data Retention Policy 
Source: https://docs.push.ai/legal/data-retention-policy



Push.ai seeks to ensure that it retains only data necessary to effectively conduct its program activities and work in fulfillment of its mission. The need to retain data varies widely with the type of data and the purpose for which it was collected. Push.ai strives to ensure that data is only retained for the period necessary to fulfill the purpose for which it was collected and is fully deleted when no longer required. This policy sets forth Push.ai’s guidelines on data retention and is to be consistently applied throughout the organization. Scope This policy covers all data collected by Push.ai and stored on Push.ai owned or leased systems and media, regardless of location. It applies to both data collected and held electronically (including photographs, video and audio recordings) and data that is collected and held as hard copy or paper files. The need to retain certain information may be mandated by federal or local law, federal regulations and legitimate business purposes, as well as the EU General Data Protection Regulation (GDPR).

## Reasons for Data Retention

Push.ai retains only that data that is necessary to effectively conduct its program activities, fulfill its mission and comply with applicable laws and regulations. Reasons for data retention include: - Providing an ongoing service to the data subject (e.g. sending a newsletter, publication or ongoing program updates to an individual, ongoing training or participation in Push.ai’s programs, processing of employee payroll and other benefits)

* Compliance with applicable laws and regulations associated with financial and programmatic reporting by Push.ai to its funding agencies and other donors
* Compliance with applicable labor, tax and immigration laws
* Other regulatory requirements
* Security incident or other investigation
* Intellectual property preservation
* Litigation

## Data Duplication

Push.ai seeks to avoid duplication in data storage whenever possible, though there may be instances in which for programmatic or other business reasons it is necessary for data to be held in more than one place. This policy applies to all data in Push.ai’s possession, including duplicate copies of data.

## Retention Requirements

Push.ai has set the following guidelines for retaining all personal data as defined in the Institute’s data privacy policy.

* Website visitor data will be retained as long as necessary to provide the service requested/initiated through the Push.ai website.
* Contributor data will be retained for the year in which the individual has contributed and then for 1 year after the date of the last contribution. Financial information will not be retained longer than is necessary to process a single transaction.
* Event participant data will be retained for the period of the event, including any follow up activities, such as the distribution of reports, plus a period of 1 year;
* Program participant data (including sign in sheets) will be retained for the duration of the grant agreement that financed the program plus any additional time required under the terms of the grant agreement.
* Personal data of subgrantees, subcontractors and vendors will be kept for the duration of the contract or agreement.
* Employee data will be held for the duration of employment and then 1 year after the last day of employment.
* Data associated with employee wages, leave and pension shall be held for the period of employment plus 1 year, with the exception of pension eligibility and retirement beneficiary data which shall be kept for 1 year.
* Recruitment data, including interview notes of unsuccessful applicants, will be held for 1 year after the closing of the position recruitment process.
* Consultant (both paid and pro bono) data will be held for the duration of the consulting contract plus 1 year after the end of the consultancy.
* Board member data will be held for the duration of service on the Board plus for 1 year after the end of the member’s term.
* Data associated with tax payments (including payroll, corporate and VAT) will be held for 1 year.
* Operational data related to program proposals, reporting and program management will be held for the period required by the Push.ai donor, but not more than 1 year.

## Data Destruction

Data destruction ensures that Push.ai manages the data it controls and processes it in an efficient and responsible manner. When the retention period for the data as outlined above expires, Push.ai will actively destroy the data covered by this policy. If an individual believes that there exists a legitimate business reason why certain data should not be destroyed at the end of a retention period, he or she should identify this data to his/her supervisor and provide information as to why the data should not be destroyed. Any exceptions to this data retention policy must be approved by Push.ai’s data protection offer in consultation with legal counsel. In rare circumstances, a litigation hold may be issued by legal counsel prohibiting the destruction of certain documents. A litigation hold remains in effect until released by legal counsel and prohibits the destruction of data subject to the hold.


# Privacy Policy
Source: https://docs.push.ai/legal/privacy-policy



This Privacy Policy governs the manner in which Push.ai collects, uses, maintains and discloses information collected from users (each, a "User") of the [https://push.ai](https://push.ai) website ("Site"). This privacy policy applies to the Site and all products and services offered by Push.ai.

### Personal identification information

We may collect personal identification information from Users in a variety of ways, including, but not limited to, when Users visit our site, register on the site, make a purchase, subscribe to the newsletter, respond to a survey, fill out a form, and in connection with other activities, services, features or resources we make available on our Site. Users may be asked for, as appropriate, name, email address, credit card information. Users may, however, visit our Site anonymously. We will collect personal identification information from Users only if they voluntarily submit such information to us. Users can always refuse to supply personally identification information, except that it may prevent them from engaging in certain Site related activities.

### Non-personal identification information

We may collect non-personal identification information about Users whenever they interact with our Site. Non-personal identification information may include the browser name, the type of computer and technical information about Users means of connection to our Site, such as the operating system and the Internet service providers utilized and other similar information.

### Web browser cookies

Our Site may use "cookies" to enhance the User experience. Users web browser places cookies on their hard drive for record-keeping purposes and sometimes to track information about them. User may choose to set their web browser to refuse cookies, or to alert you when cookies are being sent. If they do so, note that some parts of the Site may not function properly.

### How we use collected information

Push.ai may collect and use Users personal information for the following purposes:

* To improve customer service. Information you provide helps us respond to your customer service requests and support needs more efficiently.
* To personalize user experience. We may use information in the aggregate to understand how our Users as a group use the services and resources provided on our Site.
* To improve our Site. We may use feedback you provide to improve our products and services.
* To process payments. We may use the information Users provide about themselves when placing an order only to provide service to that order. We do not share this information with outside parties except to the extent necessary to provide the service.
* To run a promotion, contest, survey or other Site feature. To send Users information they agreed to receive about topics we think will be of interest to them.
* To send periodic emails. We may use the email address to send User information and updates pertaining to their order. It may also be used to respond to their inquiries, questions, and/or other requests. If User decides to opt-in to our mailing list, they will receive emails that may include company news, updates, related product or service information, etc. If at any time the User would like to unsubscribe from receiving future emails, we include detailed unsubscribe instructions at the bottom of each email.

### How we protect your information

We adopt appropriate data collection, storage and processing practices and security measures to protect against unauthorized access, alteration, disclosure or destruction of your personal information, username, password, transaction information and data stored on our Site.
Sensitive and private data exchange between the Site and its Users happens over a SSL secured communication channel and is encrypted and protected with digital signatures.

### Sharing personal information

We do not sell, trade, or rent Users personal identification information to others. We may share generic aggregated demographic information not linked to any personal identification information regarding visitors and users with our business partners, trusted affiliates and advertisers for the purposes outlined above.

### Third party websites

Users may find advertising or other content on our Site that link to the sites and services of our partners, suppliers, advertisers, sponsors, licensors and other third parties. We do not control the content or links that appear on these sites and are not responsible for the practices employed by websites linked to or from our Site. In addition, these sites or services, including their content and links, may be constantly changing. These sites and services may have their own privacy policies and customer service policies. Browsing and interaction on any other website, including websites which have a link to our Site, is subject to that website's own terms and policies.

### Changes to this privacy policy

Push.ai has the discretion to update this privacy policy at any time. When we do, we will post a notification on the main page of our Site, revise the updated date at the bottom of this page. We encourage Users to frequently check this page for any changes to stay informed about how we are helping to protect the personal information we collect. You acknowledge and agree that it is your responsibility to review this privacy policy periodically and become aware of modifications.

### Your acceptance of these terms

By using this Site, you signify your acceptance of this policy and terms of service. If you do not agree to this policy, please do not use our Site. Your continued use of the Site following the posting of changes to this policy will be deemed your acceptance of those changes.

## Data Retention Policy

Push.ai seeks to ensure that it retains only data necessary to effectively conduct its program activities and work in fulfillment of its mission. The need to retain data varies widely with the type of data and the purpose for which it was collected. Push.ai strives to ensure that data is only retained for the period necessary to fulfill the purpose for which it was collected and is fully deleted when no longer required. This policy sets forth Push.ai’s guidelines on data retention and is to be consistently applied throughout the organization. This policy covers all data collected by Push.ai and stored on Push.ai owned or leased systems and media, regardless of location. It applies to both data collected and held electronically (including photographs, video and audio recordings) and data that is collected and held as hard copy or paper files. The need to retain certain information may be mandated by federal or local law, federal regulations and legitimate business purposes, as well as the EU General Data Protection Regulation (GDPR).

### Reasons for Data Retention

Push.ai retains only that data that is necessary to effectively conduct its program activities, fulfill its mission and comply with applicable laws and regulations. Reasons for data retention include:

* Providing an ongoing service to the data subject
* Compliance with applicable laws and regulations associated with financial and programmatic reporting by Push.ai to its funding agencies and other donors
* Compliance with applicable labor, tax and immigration laws
* Other regulatory requirements
* Security incident or other investigation
* Intellectual property preservation
* Litigation

### Data Duplication

Push.ai seeks to avoid duplication in data storage whenever possible, though there may be instances in which for programmatic or other business reasons it is necessary for data to be held in more than one place. This policy applies to all data in Push.ai’s possession, including duplicate copies of data.

### Retention Requirements

Push.ai has set the following guidelines for retaining all personal data as defined in the Push.ai data privacy policy.

* Website visitor data will be retained as long as necessary to provide the service requested/initiated through the Push.ai website.
* Customer data will be retained for a period of 90 days after the last activity in an account or until a data source is disconnected.

### Data Destruction

Data destruction ensures that Push.ai manages the data it controls and processes it in an efficient and responsible manner. When the retention period for the data as outlined above expires, Push.ai will actively destroy the data covered by this policy. If an individual believes that there exists a legitimate business reason why certain data should not be destroyed at the end of a retention period, he or she should identify this data to his/her supervisor and provide information as to why the data should not be destroyed. Any exceptions to this data retention policy must be approved by Push.ai’s data protection offer in consultation with legal counsel. In rare circumstances, a litigation hold may be issued by legal counsel prohibiting the destruction of certain documents. A litigation hold remains in effect until released by legal counsel and prohibits the destruction of data subject to the hold.

### Data Deletion Requests

If you would like to request that your personal or organization data get deleted from Push.ai, you can submit a request for deletion to [support@push.ai](mailto:support@push.ai). The data deletion process may take a few days to complete and will remove all information related to your user and/or organization dependent upon your request.

### Contacting us

If you have any questions about this Privacy Policy, the practices of this site, or your dealings with this site, please contact us at:

Push AI, Inc.

[https://push.ai](https://push.ai)

[admin@push.ai](mailto:admin@push.ai)


# Terms of Service
Source: https://docs.push.ai/legal/terms-of-service



These Terms of Service ("Agreement") are entered into by and between Push AI, Inc. ("Company") and the user ("User") accessing or using the software, applications, and services provided by Push AI, Inc. (collectively referred to as the "Services"). This Agreement governs the User's use of the Services. By accessing or using the Services, the User agrees to be bound by the terms and conditions of this Agreement.

### Acceptance of Terms

By using the Services, the User represents and warrants that they have read and understood this Agreement and agree to be bound by its terms and conditions. If the User does not agree to this Agreement, they must refrain from accessing or using the Services.

### Use of Services

2.1 Eligibility: The User must be of legal age and have the legal capacity to enter into this Agreement. By using the Services, the User represents and warrants that they meet these eligibility requirements.

2.2 License: Subject to the terms of this Agreement, the Company grants the User a limited, non-exclusive, non-transferable, and revocable license to access and use the Services for their internal business purposes. The User shall not modify, adapt, reproduce, distribute, reverse engineer, or create derivative works based on the Services.

2.3 User Responsibilities: The User is responsible for maintaining the confidentiality of their account credentials and for all activities conducted through their account. The User shall not engage in any conduct that violates applicable laws, regulations, or the rights of others while using the Services.

### Intellectual Property

3.1 Ownership: The Company retains all rights, title, and interest in and to the Services, including all intellectual property rights. The User acknowledges that they do not acquire any ownership rights by using the Services.

3.2 Feedback: The User may provide suggestions, ideas, or feedback to the Company regarding the Services ("Feedback"). The User grants the Company a worldwide, perpetual, irrevocable, royalty-free license to use, modify, reproduce, and incorporate the Feedback into the Services without any obligation to the User.

### Privacy and Data Protection

The Company's collection, use, and protection of personal data are governed by the Company's Privacy Policy. By using the Services, the User agrees to the Company's Privacy Policy.

### Limitation of Liability

To the maximum extent permitted by law, the Company shall not be liable for any indirect, incidental, consequential, or punitive damages arising out of or relating to the use or inability to use the Services, even if the Company has been advised of the possibility of such damages. The Company's liability under this Agreement, regardless of the cause of action, shall be limited to the fees paid by the User for the Services during the twelve (12) months preceding the event giving rise to the liability.

### Indemnification

The User agrees to indemnify, defend, and hold harmless the Company and its officers, directors, employees, and affiliates from and against any claims, liabilities, damages, losses, costs, or expenses arising out of or relating to the User's use of the Services or violation of this Agreement.

### Termination

The Company may terminate or suspend the User's access to the Services at any time, with or without cause. The User may terminate their use of the Services by ceasing to use the Services. Upon termination, the User's rights to use the Services shall immediately cease, and the provisions of this Agreement that by their nature should survive termination shall survive.


# Query Agent
Source: https://docs.push.ai/query-agent/query-agent

The Push.ai Query Agent navigates the Business Graph™ to help any user answer any business question.

## Features

* Ask questions in natural language using trusted semantic-layer queries
* Agentic Business Graph exploration (i.e., it can do data analysis for you)
* Support for citations, sources, charts, tables
* Share conversations across your team

## Tagging Business Objects

Objects can be explicity tagged an brought into context by typing "@". The agent will also search for objects relevant to the user's query, so tagging is recommended but not required.

## Exploratory Data analysis

The agent performs well when tasked with questions that require exploratory dat analysis. As an example, when asking "why" a metric has changed, the agent will navigate the Business Graph™ by pulling the data by relevant dimensions to look for specific drivers or time periods of the change.

## Web Search

The agent can retrieve real-time web data to help augment an analysis and provide import context. For example, for a seasonal or weather related business, we can retrieve real-time and historical weather data to understand it's affects on business metrics.

## Sharing

Conversations with the Query Agent can be shared using a URL. Viewing shared conversations requires a user login.


# Reviews
Source: https://docs.push.ai/reviews/reviews

Use Reviews to share metrics in shared channels where teams can discuss and take action.

## Features

* Add metrics, dimensions and calculations to select relevant data.
* Configure a schedule to generate the most up-to-date data and deliver the review (e.g., daily, weekly or monthly).
* Select a user or channel to receive the review, or use distribute by dimension to send to multiple destinations.

## Building Reviews

Our review builder allows teams to easily build, deliver and automate reviewing processes.

### Adding Metrics and Dimensions

Dimensions can be applied individually at the metric level or at the review level (across all metrics in the review). When applying metrics at the review-level, a dimension must be shared across all metrics. If you're unable to add a dimension or a metric when using dimensions at the review-level, you can either remove metrics that don't contain that dimension or add the dimension to those metrics, if applicable.

For Reviews using dimensions, dimension values can be filtered to a specific list of values.

### Formatting and Layout Options

#### Metric and Dimension Layout

When using dimensions in Reviews, dimensions applied at the review-level can be displayed at the highest level of the review structure (i.e., dimensions as groups) or within each metric. Dimensions applied at the metric level will display within the hierarchy of that metric.

#### Calculation Layout

Calculations can be displayed in a single line (or horizontally) or stacked (vertically). Single line layouts are more compact but can cause formatting difficulties. We recommended sending test reviews to identify the best format for each review.

#### Ordering

The order of display for metrics and calculations can be adjusted in the review builder. For reviews using dimensions, dimension values will be ordered alphabetically and limited to the top-20 dimension values (by metric value). Support for additional configuration options will be coming soon.

## Distribute by Dimension

This feature allows users to distribute reviews in more complex use-cases. Using dimensions, users can configure reviews to send to multiple destinations containing the data for each dimension value.

For example, a sales team might track metrics around contacts and opportunity at the aggregate and sales rep level. Using those sales metrics and the sales rep as a dimension, a review could be generated for each sales rep to help them track their individual metrics.


# Subscriptions
Source: https://docs.push.ai/subscriptions/subscriptions

Receive a personalized feed of updates around the parts of the business you care about.

## Features

* Subscribe to any part of your business using metrics and dimensions or objects within your semantic model.
* Receive updates directly in your inbox via Slack, Email or Microsoft Teams.
* Use AI Summaries to quickly stay informed with what's happening and why.

## Subscribing to metrics and dimensions

To create a Subscription, follow these steps:

1. Navigate to the [**Data**](https://app.push.ai/data) section of your Push.ai web application.
2. Select the metrics and dimension values you want to subscribe to. Examples include:
   * **Metrics**: I'm a CMO and want to follow the metrics I manages.
   * **Dimension Values**: I'm a marketing manager and want to follow the channels I manage
3. Configure your subscription preferences in [**Notification Preferences**](https://app.push.ai/settings).

## Configuring Subscriptions

You can manage your subscription settings through [**Notification Preferences**](https://app.push.ai/settings) in the Push.ai web application:

1. Navigate to [**Settings**](https://app.push.ai/settings) > [**Notification Preferences**](https://app.push.ai/settings).
2. Customize the frequency to receive updates, either Daily, Weekly or Monthly.
3. Choose your preferred destination among Slack, Email or Microsoft Teams.
4. Save your changes to update your preferences.

## Additional Set Up for Subscriptions in Slack

To receive a Subscription in Slack, you must first connect your Slack user to your Push.ai user:

1. Navigate to [**Member Management**](https://app.push.ai/settings/) in your Push.ai dashboard.
2. Find your user profile and click **Connect Slack**.
3. Select your Slack profile from a list of profiles in your Slack workspace.