# Dialpad Documentation ## Guides - [Token Generation via OAuth](https://developers.dialpad.com/docs/oauth.md) - [Getting Help](https://developers.dialpad.com/docs/getting-help.md) - [Access Control Policies](https://developers.dialpad.com/docs/access-control-policies.md) - [Call Routing via APIs](https://developers.dialpad.com/docs/call-routing-via-apis.md) - [Dialpad Mini Dialer (CTI)](https://developers.dialpad.com/docs/dialpad-mini-dialer.md) - [Event Subscriptions via Websocket](https://developers.dialpad.com/docs/event-subscriptions-via-websocket.md) - [Agent Status Events](https://developers.dialpad.com/docs/agent-status-events.md) - [Call Events](https://developers.dialpad.com/docs/call-events.md) - [Change Log Action Types](https://developers.dialpad.com/docs/change-log-action-types.md) - [Contact Events](https://developers.dialpad.com/docs/contact-events.md) - [Event Subscriptions](https://developers.dialpad.com/docs/event-subscriptions.md) - [SMS Events](https://developers.dialpad.com/docs/sms-events.md) - [SMS API](https://developers.dialpad.com/docs/sms-api.md) - [Stats APIs](https://developers.dialpad.com/docs/stats-api-dialpad-analytics.md) - [Publish your App](https://developers.dialpad.com/docs/publish-your-app.md) - [Welcome!](https://developers.dialpad.com/docs/welcome.md) - [Rate Limits](https://developers.dialpad.com/docs/rate-limits.md) ## API Reference - [Access Control Policies -- Assign](https://developers.dialpad.com/reference/accesscontrolpoliciesassign.md): Assigns a user to an access control policy. Requires a company admin API key. Rate limit: 1200 per minute. - [Access Control Policies -- List Assignments](https://developers.dialpad.com/reference/accesscontrolpoliciesassignments.md): Lists all users assigned to this access control policy. Rate limit: 1200 per minute. - [Access Control Policies -- Create](https://developers.dialpad.com/reference/accesscontrolpoliciescreate.md): Creates a new custom access control policy. Requires a company admin API key. Rate limit: 1200 per minute. - [Access Control Policies -- Delete](https://developers.dialpad.com/reference/accesscontrolpoliciesdelete.md): Deletes a policy by marking the state as deleted, and removing all associated users. Requires a company admin API key. Rate limit: 1200 per minute. - [Access Control Policies -- Get](https://developers.dialpad.com/reference/accesscontrolpoliciesget.md): Get a specific access control policy's details. Rate limit: 1200 per minute. - [Access Control Policies -- List Policies](https://developers.dialpad.com/reference/accesscontrolpolicieslist.md): Gets all access control policies belonging to the company. Rate limit: 1200 per minute. - [Access Control Policies -- Unassign](https://developers.dialpad.com/reference/accesscontrolpoliciesunassign.md): Unassigns one or all target groups associated with the user for an access control policy. Requires a company admin API key. Rate limit: 1200 per minute. - [Access Control Policies -- Update](https://developers.dialpad.com/reference/accesscontrolpoliciesupdate.md): Updates the provided fields for an existing access control policy. Requires a company admin API key. Rate limit: 1200 per minute. - [Call Centers -- Status](https://developers.dialpad.com/reference/callcentersget_status.md): Gets live status information on the corresponding Call Center. Added on August 7, 2023 for API v2. Rate limit: 1200 per minute. - [Operator -- Add](https://developers.dialpad.com/reference/callcentersoperatorsadd.md): Adds an operator to a call center. > Warning > > This API may result in the usage of call center licenses if required and available. If the licenses are required and not available the operation will fail. Licenses are required when adding an operator that does not have a call center license. Added on October 2, 2020 for API v2. Rate limit: 1200 per minute. - [Operator -- Get Duty Status](https://developers.dialpad.com/reference/callcentersoperatorsget_duty_status.md): Gets the operator's on duty status and reason. Rate limit: 1200 per minute. - [Operator -- Get Skill Level](https://developers.dialpad.com/reference/callcentersoperatorsget_skill_level.md): Gets the skill level of an operator within a call center. Rate limit: 1200 per minute. - [Operators -- List](https://developers.dialpad.com/reference/callcentersoperatorslist.md): Gets operators for a call center. Added on May 1, 2018 for API v2. Rate limit: 1200 per minute. - [Operator -- Update Duty Status](https://developers.dialpad.com/reference/callcentersoperatorsupdate_duty_status.md): Updates the operator's duty status for all call centers which user belongs to. Rate limit: 1200 per minute. - [Operator -- Update Skill Level](https://developers.dialpad.com/reference/callcentersoperatorsupdate_skill_level.md): Updates the skill level of an operator within a call center. Rate limit: 1200 per minute. - [Call -- Get Ai Recap](https://developers.dialpad.com/reference/callget_ai_recap.md): Gets the Ai Recap for a call. Requires scope: ``ai_recap`` Rate limit: 12 per minute. - [Call -- Assigned Operators](https://developers.dialpad.com/reference/callget_assigned_operators.md): Get all assigned operators from a call queued in a contact center. Only contact center calls are eligible for this operation. Added on June 2025 for API v2. Rate limit: 250 per minute. - [Dialpad Number -- Assign](https://developers.dialpad.com/reference/usersassign_number.md): Assigns a number to a user. The number will automatically be taken from the company's reserved block if there are reserved numbers, otherwise a number will be auto-assigned from the provided area code. Added on May 3, 2018 for API v2. Rate limit: 1200 per minute. - [Persona -- List](https://developers.dialpad.com/reference/userslist_personas.md): Provides a list of personas for a user. A persona is a target that a user can make calls from. The receiver of the call will see the details of the persona rather than the user. Added on February 12, 2021 for API v2. Rate limit: 1200 per minute. - [User -- Switch Office](https://developers.dialpad.com/reference/usersmove_office.md): Moves the user to a different office. For international offices only, all of the user's numbers will be unassigned and a new number will be assigned except when the user only has internal numbers starting with 803 -- then the numbers will remain unchanged. Admin can also assign numbers via the user assign number API after. Only supported on paid accounts and there must be enough licenses to transfer the user to the destination office. Added on May 31, 2021 for API v2. Rate limit: 1200 per minute. - [Caller ID -- Set](https://developers.dialpad.com/reference/usersset_caller_id.md): Set Caller ID for a given user ID. Added on Aug 3, 2022 for API v2. Rate limit: 1200 per minute. - [Call Recording -- Toggle](https://developers.dialpad.com/reference/userstoggle_call_recording.md): Turns call recording on or off for a user's active call. Added on Nov 18, 2019 for API v2. Rate limit: 1200 per minute. - [Dialpad Number -- Unassign](https://developers.dialpad.com/reference/usersunassign_number.md): Un-assigns a phone number from a user. The number will be returned to the company's reserved block if there is one. Otherwise the number will be released. Added on May 3, 2018 for API v2. Rate limit: 1200 per minute. - [Agent Group -- Get](https://developers.dialpad.com/reference/agentgroupget.md): Requires scope: ``agent_groups:read`` Rate limit: 1200 per minute. - [App Settings -- Get](https://developers.dialpad.com/reference/app_settingsget.md): Gets the app settings of the OAuth app that is associated with the API key for the target, if target_type and target_id are provided. Otherwise, will return the app settings for the company. Rate limit: 1200 per minute. - [Blocked Number -- Add](https://developers.dialpad.com/reference/blockednumbersadd.md): Blocks the specified numbers company-wide. Rate limit: 1200 per minute. - [Blocked Number -- Get](https://developers.dialpad.com/reference/blockednumbersget.md): Gets the specified blocked number. Rate limit: 1200 per minute. - [Blocked Numbers -- List](https://developers.dialpad.com/reference/blockednumberslist.md): Lists all numbers that have been blocked via the API. Rate limit: 1200 per minute. - [Blocked Number -- Remove](https://developers.dialpad.com/reference/blockednumbersremove.md): Unblocks the specified numbers company-wide. Rate limit: 1200 per minute. - [Call Actions -- Hang up](https://developers.dialpad.com/reference/callactionshangup.md): Hangs up the call. Added on Oct 25, 2024 for API v2. Rate limit: 1200 per minute. - [Call -- Assign Operator](https://developers.dialpad.com/reference/callassign.md): Assigns an operator to a call queued in a contact center. Only contact center calls are eligible for this operation. Currently, this endpoint supports assigning one operator per request. Added on May 2025 for API v2. Rate limit: 12 per minute. - [Call -- Initiate via Ring](https://developers.dialpad.com/reference/callcall.md): Initiates an outbound call to ring all devices (or a single specified device). Note that the user must have at least one active device (a web, desktop or mobile Dialpad app; a CTI application; or a physical deskphone). Added on Feb 20, 2020 for API v2. Rate limit: 5 per minute. - [Call -- Get](https://developers.dialpad.com/reference/callget_call_info.md): Get call status and detailed information for a concluded call, including direction, duration, recording URLs, CSAT scores, routing breadcrumbs, voicemail metadata, and transcription text. Added on May 25, 2021 for API v2. Rate limit: 10 per minute. - [Call -- Initiate IVR Call](https://developers.dialpad.com/reference/callinitiate_ivr_call.md): Initiates an outbound call to ring an IVR Workflow. Added on Aug 14, 2023 for API v2. Rate limit: 10 per minute per IVR. Rate limit: 1200 per minute. - [Call -- List](https://developers.dialpad.com/reference/calllist.md): Provides a paginated list of calls matching the specified filter parameters in reverse-chronological order by call start time (i.e. recent calls first) Note: This API will only include calls that have already concluded. Added on May 27, 2024 for API v2. Requires a company admin API key. Requires scope: ``calls:list`` Rate limit: 1200 per minute. - [Call -- Add Participant](https://developers.dialpad.com/reference/callparticipantsadd.md): Adds another participant to a call. Valid methods to add are by phone or by target. Targets require to have a primary phone Added on Nov 11, 2021 for API v2. Rate limit: 1200 per minute. - [Label -- Set](https://developers.dialpad.com/reference/callput_call_labels.md): Set Labels for a determined call id. Added on Nov 15, 2022 for API v2. Rate limit: 250 per minute. - [Call -- Transfer](https://developers.dialpad.com/reference/calltransfer_call.md): Transfers call to another recipient. Added on Sep 25, 2021 for API v2. Rate limit: 1200 per minute. - [Call -- Unassign Operator](https://developers.dialpad.com/reference/callunassign.md): Unassigns an operator from a call queued in a contact center. Only contact center calls are eligible for this operation. This endpoint supports unassigning one specific operator per request. Added on May 2025 for API v2. Rate limit: 12 per minute. - [Call -- Unassign All Operators](https://developers.dialpad.com/reference/callunassignall.md): Unassigns all assigned operators from a call queued in a contact center. Only contact center calls are eligible for this operation. Added on May 2025 for API v2. Rate limit: 12 per minute. - [Call -- Unpark](https://developers.dialpad.com/reference/callunpark.md): Unparks call from Office mainline. Added on Nov 11, 2024 for API v2. Rate limit: 1200 per minute. - [Call Back -- Enqueue](https://developers.dialpad.com/reference/callcallback.md): Requests a call back to a given number by an operator in a given call center. The call back is added to the queue for the call center like a regular call, and a call is initiated when the next operator becomes available. This API respects all existing call center settings, e.g. business / holiday hours and queue settings. This API currently does not allow international call backs. Duplicate call backs for a given number and call center are not allowed. Specific error messages will be provided in case of failure. Added on Dec 9, 2019 for API v2. Rate limit: 1200 per minute. - [Call Back -- List](https://developers.dialpad.com/reference/calllist_callbacks.md): Lists callback requests for a specific call center. Returns a paginated list of callback requests in the specified call center that the API key has access to. Callbacks are returned in FIFO order (oldest first), so the first callback in the list has been waiting longest. Each callback includes a status field indicating whether it is 'queued' (actively waiting for fulfillment) or 'timed_out' (exceeded the call center's max_hold_seconds). Timed-out callbacks have queue_position set to null. Requires admin-level access to the call center. Authorization: API key must have admin access to the specified call center. Rate limit: 1200 per minute. - [Call Back -- Validate](https://developers.dialpad.com/reference/callvalidate_callback.md): Performs a dry-run of creating a callback request, without adding it to the call center queue. This performs the same validation logic as when actually enqueuing a callback request, allowing early identification of problems which would prevent a successful callback request. Rate limit: 1200 per minute. - [Call Centers -- Create](https://developers.dialpad.com/reference/callcenterscreate.md): Creates a new call center. Requires a company admin API key. Rate limit: 1200 per minute. - [Call Centers -- Delete](https://developers.dialpad.com/reference/callcentersdelete.md): Deletes a call center by id. Requires a company admin API key. Rate limit: 1200 per minute. - [Call Centers -- Get](https://developers.dialpad.com/reference/callcentersget.md): Gets a call center by id. Added on May 1, 2018 for API v2. Rate limit: 1200 per minute. - [Call Centers -- List](https://developers.dialpad.com/reference/callcenterslistall.md): Gets all the call centers for the company. Added on Feb 3, 2022 for API v2. Rate limit: 1200 per minute. - [Operator -- Remove](https://developers.dialpad.com/reference/callcentersoperatorsdelete.md): Removes an operator from a call center. Note: This API will not change or release any licenses. Added on October 2, 2020 for API v2. Rate limit: 1200 per minute. - [Call Centers -- Update](https://developers.dialpad.com/reference/callcentersupdate.md): Updates a call center by id. Requires a company admin API key. Rate limit: 1200 per minute. - [Label -- List](https://developers.dialpad.com/reference/calllabellist.md): Gets all labels for a determined company. Added on Nov 15, 2022 for API v2. Rate limit: 1200 per minute. - [Call Review Sharelink -- Create](https://developers.dialpad.com/reference/call_review_share_linkcreate.md): Create a call review share link by call id. Added on Sep 21, 2022 for API v2. Rate limit: 250 per minute. - [Call Review Sharelink -- Delete](https://developers.dialpad.com/reference/call_review_share_linkdelete.md): Delete a call review share link by id. Added on Sep 21, 2022 for API v2. Rate limit: 1200 per minute. - [Call Review Sharelink -- Get](https://developers.dialpad.com/reference/call_review_share_linkget.md): Gets a call review share link by call id. Added on Sep 21, 2022 for API v2. Rate limit: 1200 per minute. - [Call Review Sharelink -- Update](https://developers.dialpad.com/reference/call_review_share_linkupdate.md): Update a call review share link by id. Added on Sep 21, 2022 for API v2. Rate limit: 250 per minute. - [Call Router -- Create](https://developers.dialpad.com/reference/callrouterscreate.md): Creates a new API-based call router. Rate limit: 1200 per minute. - [Call Router -- Delete](https://developers.dialpad.com/reference/callroutersdelete.md): Deletes the API call router with the given ID. Rate limit: 1200 per minute. - [Call Router -- Get](https://developers.dialpad.com/reference/callroutersget.md): Gets the API call router with the given ID. Rate limit: 1200 per minute. - [Call Router -- List](https://developers.dialpad.com/reference/callrouterslist.md): Lists all of the API call routers for a given company or office. Rate limit: 1200 per minute. - [Call Router -- Update](https://developers.dialpad.com/reference/callroutersupdate.md): Updates the API call router with the given ID. Rate limit: 1200 per minute. - [Dialpad Number -- Assign](https://developers.dialpad.com/reference/numbersassign_call_router_numberpost.md): Assigns a number to a callrouter. The number will automatically be taken from the company's reserved pool if there are reserved numbers, otherwise a number will be auto-assigned from the provided area code. Rate limit: 1200 per minute. - [Channel -- Delete](https://developers.dialpad.com/reference/channelsdelete.md): Deletes a channel by id. Added on May 11, 2022 for API v2. Rate limit: 1200 per minute. - [Channel -- Get](https://developers.dialpad.com/reference/channelsget.md): Get channel by id Added on May 11, 2022 for API v2. Rate limit: 1200 per minute. - [Channel -- List](https://developers.dialpad.com/reference/channelslist.md): Lists all channels in the company. Added on May 11, 2022 for API v2. Rate limit: 1200 per minute. - [Member -- Remove](https://developers.dialpad.com/reference/channelsmembersdelete.md): Removes a member from a channel. Added on May 12, 2022 for API v2. Rate limit: 1200 per minute. - [Members -- List](https://developers.dialpad.com/reference/channelsmemberslist.md): List all the members from a channel Added on May 11, 2022 for API v2. Rate limit: 1200 per minute. - [Member -- Add](https://developers.dialpad.com/reference/channelsmemberspost.md): Adds a user to a channel. Added on May 12, 2022 for API v2. Rate limit: 1200 per minute. - [Channel -- Create](https://developers.dialpad.com/reference/channelspost.md): Creates a new channel. Added on May 11, 2022 for API v2. Rate limit: 1200 per minute. - [Coaching Team -- Get](https://developers.dialpad.com/reference/coaching_teamget.md): Get details of a specified coaching team. Added on Jul 30th, 2021 for API v2. Rate limit: 1200 per minute. - [Coaching Team -- List](https://developers.dialpad.com/reference/coaching_teamlistall.md): Get a list of all coaching teams in the company. Added on Feb 3rd, 2022 for API v2. Rate limit: 1200 per minute. - [Coaching Team -- Add Member](https://developers.dialpad.com/reference/coaching_teammembersadd.md): Add a user to the specified coaching team as trainee or coach. Added on July 5th, 2021 for API v2. Rate limit: 1200 per minute. - [Coaching Team -- List Members](https://developers.dialpad.com/reference/coaching_teammembersget.md): Get a list of members of a coaching team. Added on Jul 30th, 2021 for API v2. Rate limit: 1200 per minute. - [Company -- Get](https://developers.dialpad.com/reference/companyget.md): Gets company information. Added on Feb 21, 2019 for API v2. Requires a company admin API key. Rate limit: 1200 per minute. - [Company -- Get SMS Opt-out List](https://developers.dialpad.com/reference/companysms_opt_out.md): Requires a company admin API key. Rate limit: 250 per minute. - [Company -- Update Settings](https://developers.dialpad.com/reference/companyupdate_settings.md): Updates company settings. Requires a company admin API key. Rate limit: 1200 per minute. - [Meeting Summary -- List](https://developers.dialpad.com/reference/conference-meetingslist.md): Lists summaries of meetings that have occurred in the specified meeting room. Requires scope: ``conference:read`` Rate limit: 1200 per minute. - [Meeting Room -- List](https://developers.dialpad.com/reference/conference-roomslist.md): Lists all conference rooms. Requires scope: ``conference:read`` Rate limit: 1200 per minute. - [Contact -- Create or Update](https://developers.dialpad.com/reference/contactscreate_with_uid.md): Creates a new shared contact with uid. Added on Jun 11, 2020 for API v2. Rate limit: 100 per minute. - [Contact -- Create](https://developers.dialpad.com/reference/contactscreate.md): Creates a new contact. Added on Mar 2, 2020 for API v2. Rate limit: 100 per minute. - [Contact -- Delete](https://developers.dialpad.com/reference/contactsdelete.md): Deletes a contact by id. Added on Mar 2, 2020 for API v2. Rate limit: 1200 per minute. - [Contact -- Get](https://developers.dialpad.com/reference/contactsget.md): Gets a contact by id. Currently, only contacts of type shared and local can be retrieved by this API. Added on Mar 2, 2020 for API v2. Rate limit: 1200 per minute. - [Contact -- List](https://developers.dialpad.com/reference/contactslist.md): Gets company shared contacts, or user's local contacts if owner_id is provided. NOTE: The `limit` parameter has been soft-deprecated. Please omit the `limit` parameter, or reduce it to `100` or less. - Limit values of greater than `100` will only produce a page size of `100`, and a `400 Bad Request` response will be produced 20% of the time in an effort to raise visibility of side-effects that might otherwise go un-noticed by solutions that had assumed a larger page size. - The `cursor` value is provided in the API response, and can be passed as a parameter to retrieve subsequent pages of results. Added on Mar 2, 2020 for API v2. Rate limit: 1200 per minute. - [Contact -- Update](https://developers.dialpad.com/reference/contactsupdate.md): Updates the provided fields for an existing contact. Added on Mar 2, 2020 for API v2. Rate limit: 1200 per minute. - [Custom IVR -- Get](https://developers.dialpad.com/reference/custom_ivrsget.md): Gets all the custom IVRs for a target. Added on July 14, 2021 for API v2. Rate limit: 1200 per minute. - [Custom IVR -- Update](https://developers.dialpad.com/reference/ivr_detailsupdate.md): Update the name or description of an existing custom ivr. Rate limit: 1200 per minute. - [Custom IVR -- Create](https://developers.dialpad.com/reference/ivrcreate.md): Creates a new custom IVR for a target. Added on June 15, 2022 for API v2. Rate limit: 1200 per minute. - [Custom IVR -- Delete](https://developers.dialpad.com/reference/ivrdelete.md): Delete and un-assign an Ivr from a target. Rate limit: 1200 per minute. - [Custom IVR -- Assign](https://developers.dialpad.com/reference/ivrupdate.md): Sets an existing Ivr for a target. Added on July 27, 2021 for API v2. Rate limit: 1200 per minute. - [Departments -- Create](https://developers.dialpad.com/reference/departmentscreate.md): Creates a new department. Added on March 25th, 2022 for API v2. Requires a company admin API key. Rate limit: 1200 per minute. - [Departments -- Delete](https://developers.dialpad.com/reference/departmentsdelete.md): Deletes a department by id. Requires a company admin API key. Rate limit: 1200 per minute. - [Department -- Get](https://developers.dialpad.com/reference/departmentsget.md): Gets a department by id. Added on May 1, 2018 for API v2. Rate limit: 1200 per minute. - [Department -- List](https://developers.dialpad.com/reference/departmentslistall.md): Gets all the departments in the company. Added on Feb 3rd, 2022 for API v2. Rate limit: 1200 per minute. - [Operator -- Remove](https://developers.dialpad.com/reference/departmentsoperatorsdelete.md): Removes an operator from a department. Added on October 2, 2020 for API v2. Rate limit: 1200 per minute. - [Operator -- List](https://developers.dialpad.com/reference/departmentsoperatorsget.md): Gets operators for a department. Added on May 1, 2018 for API v2. Rate limit: 1200 per minute. - [Operator -- Add](https://developers.dialpad.com/reference/departmentsoperatorspost.md): Adds an operator to a department. Added on October 2, 2020 for API v2. Rate limit: 1200 per minute. - [Departments -- Update](https://developers.dialpad.com/reference/departmentsupdate.md): Updates an existing department. Requires a company admin API key. Rate limit: 1200 per minute. - [Digital -- Sessions -- List](https://developers.dialpad.com/reference/digitalsessionsdatalist.md): Gets list of digital sessions which are started/ended in the requested period NOTE: - The `cursor` value is provided in the API response, and can be passed as a parameter to retrieve subsequent pages of results. - Requested period must be less than 7 days Added on July 29th, 2025 for API v2. Requires scope: ``digital_sessions`` Rate limit: 100 per minute. - [Dispositions -- Create](https://developers.dialpad.com/reference/dispositionscreate.md): Creates a disposition for an office. Added on April 4, 2024 for API v2. Rate limit: 1200 per minute. - [Dispositions -- Delete](https://developers.dialpad.com/reference/dispositionsdelete.md): Deletes the disposition by id. Added on April 4, 2024 for API v2. Rate limit: 1200 per minute. - [Dispositions -- Get](https://developers.dialpad.com/reference/dispositionsget.md): Gets a disposition by id. Added on April 4, 2024 for API v2. Rate limit: 1200 per minute. - [Dispositions -- List](https://developers.dialpad.com/reference/dispositionslist.md): Gets a list of dispositions by a target. Added on April 4, 2024 for API v2. Rate limit: 1200 per minute. - [Dispositions -- Update](https://developers.dialpad.com/reference/dispositionsupdate.md): Updates the disposition by id. Bulk updates for the targets assigned to a disposition is not supported. Added on April 4, 2024 for API v2. Rate limit: 1200 per minute. - [Download API Specification](https://developers.dialpad.com/reference/download-api-specification.md) - [Fax -- Send](https://developers.dialpad.com/reference/faxsend.md): Sends a fax to a phone number. Added on Nov 27, 2023 for API v2. Rate limit: 250 per minute. - [Fax Line -- Assign](https://developers.dialpad.com/reference/faxlinecreate.md): Assigns a fax line to a target. Target includes user and department. Depending on the chosen line type, the number will be taken from the company's reserved pool if there are available reserved numbers, otherwise numbers can be auto-assigned using a provided area code. Added on January 13, 2025 for API v2. Requires a company admin API key. Rate limit: 1200 per minute. - [Dialpad Meeting -- Create](https://developers.dialpad.com/reference/meetingscreate.md): Creates a Dialpad meeting. Requires scope: ``conference:all`` Rate limit: 1200 per minute. - [Dialpad Meeting -- Delete](https://developers.dialpad.com/reference/meetingsdelete.md): Deletes a Dialpad meeting. Requires scope: ``conference:all`` Rate limit: 1200 per minute. - [Dialpad Meeting -- Get](https://developers.dialpad.com/reference/meetingsget.md): Gets a Dialpad meeting. Requires scope: ``conference:all`` Rate limit: 1200 per minute. - [Dialpad Meeting -- List](https://developers.dialpad.com/reference/meetingslist.md): Lists all Dialpad meetings for a specified user. Requires scope: ``conference:all`` Rate limit: 1200 per minute. - [Meeting Room -- Create](https://developers.dialpad.com/reference/meetingsroomcreate.md): Creates a meeting room (personal or unique meeting). Requires scope: ``conference:all`` Rate limit: 1200 per minute. - [Dialpad Meeting -- Update](https://developers.dialpad.com/reference/meetingsupdate.md): Updates a Dialpad meeting. Requires scope: ``conference:all`` Rate limit: 1200 per minute. - [Bulk Message -- Get](https://developers.dialpad.com/reference/bulk_messagesget.md): Gets a single bulk message by ID. Added on Dec 28, 2025 for API v2. Rate limit: 1200 per minute. - [Bulk Message -- List](https://developers.dialpad.com/reference/bulk_messageslist.md): Lists all bulk messages for the authenticated user. Results can be paginated using the cursor parameter. Added on Dec 28, 2025 for API v2. Rate limit: 1200 per minute. - [Bulk Message -- Send](https://developers.dialpad.com/reference/bulk_messagessend.md): Sends a bulk message to multiple recipients (up to 50). This endpoint allows you to send the same message to multiple phone numbers. All existing logic (including spam checks, delivery behavior, and visibility in the Bulk Messages UI tab) will remain the same for API-triggered sends. **Important**: Message sending is asynchronous. This endpoint creates the bulk message batch and returns immediately with success=True, indicating the batch was created successfully. Individual messages are sent in the background. To check the delivery status of individual recipients, use the GET /message/bulk/{id} endpoint to retrieve the batch with delivery status information (attempted_send, error_message, delivery_status fields per recipient). Added on Dec 28, 2025 for API v2. Rate limit: 1200 per minute. - [Bulk Message -- Update](https://developers.dialpad.com/reference/bulk_messagesupdate.md): Updates a bulk message text and/or media. Supports partial updates. Only the fields provided in the request will be updated. Fields not provided will retain their existing values. This follows PATCH semantics. Added on Dec 28, 2025 for API v2. Rate limit: 1200 per minute. - [Message API](https://developers.dialpad.com/reference/message.md) - [Schedule -- Create](https://developers.dialpad.com/reference/schedulescreate.md): Creates a new scheduled message that will be sent at the specified time. Messages can be sent to multiple phone numbers OR to a Dialpad channel. Supports both SMS (text only) and MMS (text with media attachments). Added on Dec 5, 2025 for API v2. Rate limit: 1200 per minute. - [Schedule -- Delete](https://developers.dialpad.com/reference/schedulesdelete.md): Deletes (cancels) a scheduled message. The message will not be sent. Added on Dec 5, 2025 for API v2. Rate limit: 1200 per minute. - [Schedule -- Get](https://developers.dialpad.com/reference/schedulesget.md): Gets a single scheduled message by ID. Added on Dec 5, 2025 for API v2. Rate limit: 1200 per minute. - [Schedule -- List](https://developers.dialpad.com/reference/scheduleslist.md): Lists all active scheduled messages for the authenticated user. Only active (pending) schedules are returned. Deleted or sent schedules are not included. Results can be paginated using the cursor parameter. Added on Dec 5, 2025 for API v2. Rate limit: 1200 per minute. - [Schedule -- Send Now](https://developers.dialpad.com/reference/schedulessend_now.md): Immediately sends a scheduled message and deletes the schedule. This is useful for testing or when you want to send a scheduled message before its scheduled time. Added on Dec 5, 2025 for API v2. Rate limit: 1200 per minute. - [Schedule -- Update](https://developers.dialpad.com/reference/schedulesupdate.md): Updates an existing scheduled message. Supports partial updates. Only the fields provided in the request will be updated. Fields not provided will retain their existing values. This follows PATCH semantics. Added on Dec 5, 2025 for API v2. Rate limit: 1200 per minute. - [Phone String -- Reformat](https://developers.dialpad.com/reference/formatpost.md): Used to convert local number to E.164 or E.164 to local format. Added on June 15, 2021 for API v2. Rate limit: 1200 per minute. - [Dialpad Number -- Assign](https://developers.dialpad.com/reference/numbersassign_numberpost.md): Assigns a number to a target. Target includes user, department, office, room, callcenter, callrouter, staffgroup, channel and coachinggroup. The number will automatically be taken from the company's reserved pool if there are reserved numbers, otherwise a number will be auto-assigned from the provided area code. Added on May 26, 2020 for API v2. Rate limit: 1200 per minute. - [Dialpad Number -- Auto-Assign](https://developers.dialpad.com/reference/numbersassign_target_numberpost.md): Assigns a number to a target. The number will automatically be taken from the company's reserved pool if there are reserved numbers, otherwise a number will be auto-assigned from the provided area code. Target includes user, department, office, room, callcenter, callrouter, staffgroup, channel and coachinggroup. Added on November 18, 2020 for API v2. Rate limit: 1200 per minute. - [Dialpad Number -- Unassign](https://developers.dialpad.com/reference/numbersdelete.md): Un-assigns a phone number from a target. The number will be returned to the company's reserved pool if there is one. Otherwise the number will be released. Added on Jan 28, 2019 for API v2. Rate limit: 1200 per minute. - [Dialpad Number -- Get](https://developers.dialpad.com/reference/numbersget.md): Gets number details by number. Added on May 3, 2018 for API v2. Requires a company admin API key. Rate limit: 1200 per minute. - [Dialpad Number -- List](https://developers.dialpad.com/reference/numberslist.md): Gets all numbers in your company. Added on May 3, 2018 for API v2. Requires a company admin API key. Rate limit: 1200 per minute. - [Dialpad Number -- Swap](https://developers.dialpad.com/reference/numbersswap_numberpost.md): Swaps a target's primary number with a new one. - If a specific number is provided (`type: 'provided_number'`), the target’s primary number is swapped with that number. The provided number must be available in the company’s reserved pool, and the `reserve_pool` experiment must be enabled for the company. - If an area code is provided (`type: 'area_code'`), an available number from that area code is assigned. - If neither is provided (`type: 'auto'`), a number is automatically assigned — first from the company’s reserved pool (if available), otherwise from the target’s office area code. If no type is specified, 'auto' is used by default. Added on Mar 28, 2025 for API v2. Rate limit: 1200 per minute. - [Number Tags -- Update tags for a phone number.](https://developers.dialpad.com/reference/tagspatch.md): Update tags for a phone number. Requires a company admin API key. Rate limit: 1200 per minute. - [Token -- Authorize](https://developers.dialpad.com/reference/oauth2authorizeget.md): Initiate the OAuth flow to grant an application access to Dialpad resources on behalf of a user. - [Token -- Deauthorize](https://developers.dialpad.com/reference/oauth2deauthorizepost.md): Revokes oauth2 tokens for a given oauth app. - [Token -- Redeem](https://developers.dialpad.com/reference/oauth2tokenpost.md): Exchanges a temporary oauth code for an authorized access token. - [Call Centers -- List](https://developers.dialpad.com/reference/callcenterslist.md): Gets all the call centers for an office. Added on May 1, 2018 for API v2. Rate limit: 1200 per minute. - [Coaching Team -- List](https://developers.dialpad.com/reference/coaching_teamlist.md): Get a list of coaching teams of a office. Added on Jul 30th, 2021 for API v2. Rate limit: 1200 per minute. - [Department -- List](https://developers.dialpad.com/reference/departmentslist.md): Gets all the departments for an office. Added on May 1, 2018 for API v2. Rate limit: 1200 per minute. - [Dialpad Number -- Assign](https://developers.dialpad.com/reference/numbersassign_office_numberpost.md): Assigns a number to a office. The number will automatically be taken from the company's reserved pool if there are reserved numbers, otherwise a number will be auto-assigned from the provided area code. Added on March 19, 2019 for API v2. Rate limit: 1200 per minute. - [Dialpad Number -- Unassign](https://developers.dialpad.com/reference/numbersoffice_unassign_numberpost.md): Un-assigns a phone number from a office mainline. The number will be returned to the company's reserved pool if there is one. Otherwise the number will be released. Added on March 19, 2019 for API v2. Rate limit: 1200 per minute. - [Office -- Create](https://developers.dialpad.com/reference/officescreate.md): Creates a secondary office. Rate limit: 1200 per minute. - [E911 Address -- Get](https://developers.dialpad.com/reference/officese911get.md): Gets E911 address of the office by office id. Added on May 25, 2021 for API v2. Rate limit: 1200 per minute. - [E911 Address -- Update](https://developers.dialpad.com/reference/officese911update.md): Update E911 address of the given office. Added on May 25, 2021 for API v2. Rate limit: 1200 per minute. - [Office -- Get](https://developers.dialpad.com/reference/officesget.md): Gets an office by id. Added on May 1, 2018 for API v2. Rate limit: 1200 per minute. - [Office -- List](https://developers.dialpad.com/reference/officeslist.md): Gets all the offices that are accessible using your API key. Added on May 1, 2018 for API v2. Rate limit: 1200 per minute. - [Off-Duty Status -- List](https://developers.dialpad.com/reference/officesoffdutystatusesget.md): Lists Off-Duty status values. Rate limit: 1200 per minute. - [Operator -- Remove](https://developers.dialpad.com/reference/officesoperatorsdelete.md): Removes an operator from office's mainline. Added on Sep 22, 2023 for API v2. Rate limit: 1200 per minute. - [Operator -- List](https://developers.dialpad.com/reference/officesoperatorsget.md): Gets mainline operators for an office. Added on May 1, 2018 for API v2. Rate limit: 1200 per minute. - [Operator -- Add](https://developers.dialpad.com/reference/officesoperatorspost.md): Adds an operator into office's mainline. Added on Sep 22, 2023 for API v2. Rate limit: 1200 per minute. - [Office -- Get Primary](https://developers.dialpad.com/reference/officesprimaryget.md): Gets the primary office for the company associated with the API key. Rate limit: 1200 per minute. - [Office -- Update](https://developers.dialpad.com/reference/officesupdate.md): Updates an office Rate limit: 1200 per minute. - [Licenses -- List Available](https://developers.dialpad.com/reference/planavailable_licensesget.md): Gets the available licenses for an office. Added on July 2, 2021 for API v2. Rate limit: 1200 per minute. - [Billing Plan -- Get](https://developers.dialpad.com/reference/planget.md): Gets the plan for an office. Added on Mar 19, 2019 for API v2. Rate limit: 1200 per minute. - [Recording Sharelink -- Create](https://developers.dialpad.com/reference/recording_share_linkcreate.md): Creates a recording share link. Added on Aug 26, 2021 for API v2. Rate limit: 100 per minute. - [Recording Sharelink -- Delete](https://developers.dialpad.com/reference/recording_share_linkdelete.md): Deletes a recording share link by id. Added on Aug 26, 2021 for API v2. Rate limit: 1200 per minute. - [Recording Sharelink -- Get](https://developers.dialpad.com/reference/recording_share_linkget.md): Gets a recording share link by id. Added on Aug 26, 2021 for API v2. Rate limit: 1200 per minute. - [Recording Sharelink -- Update](https://developers.dialpad.com/reference/recording_share_linkupdate.md): Updates a recording share link by id. Added on Aug 26, 2021 for API v2. Rate limit: 100 per minute. - [Room Phone -- Assign PIN](https://developers.dialpad.com/reference/deskphonesroomscreate_international_pin.md): Assigns a PIN for making international calls from rooms When PIN protected international calls are enabled for the company, a PIN is required to make international calls from room phones. Added on Aug 16, 2018 for API v2. Requires a company admin API key. Rate limit: 1200 per minute. - [Room Phone -- Delete](https://developers.dialpad.com/reference/deskphonesroomsdelete.md): Deletes a room desk phone by id. Added on May 17, 2018 for API v2. Rate limit: 1200 per minute. - [Room Phone -- Get](https://developers.dialpad.com/reference/deskphonesroomsget.md): Gets a room desk phone by id. Added on May 17, 2018 for API v2. Rate limit: 1200 per minute. - [Room Phone -- List](https://developers.dialpad.com/reference/deskphonesroomslist.md): Gets all desk phones under a room. Added on May 17, 2018 for API v2. Rate limit: 1200 per minute. - [Dialpad Number -- Assign](https://developers.dialpad.com/reference/numbersassign_room_numberpost.md): Assigns a number to a room. The number will automatically be taken from the company's reserved block if there are reserved numbers, otherwise a number will be auto-assigned from the provided area code. Added on March 19, 2019 for API v2. Rate limit: 1200 per minute. - [Dialpad Number -- Unassign](https://developers.dialpad.com/reference/numbersroom_unassign_numberpost.md): Un-assigns a phone number from a room. The number will be returned to the company's reserved pool if there is one. Otherwise the number will be released. Added on March 19, 2019 for API v2. Rate limit: 1200 per minute. - [Room -- Delete](https://developers.dialpad.com/reference/roomsdelete.md): Deletes a room by id. Added on Mar 8, 2019 for API v2. Rate limit: 1200 per minute. - [Room -- Get](https://developers.dialpad.com/reference/roomsget.md): Gets a room by id. Added on Aug 13, 2018 for API v2. Rate limit: 1200 per minute. - [Room -- List](https://developers.dialpad.com/reference/roomslist.md): Gets all rooms in your company, optionally filtering by office. Added on Aug 13, 2018 for API v2. Rate limit: 1200 per minute. - [Room -- Update](https://developers.dialpad.com/reference/roomspatch.md): Updates room details by id. Added on Mar 8, 2019 for API v2. Rate limit: 1200 per minute. - [Room -- Create](https://developers.dialpad.com/reference/roomspost.md): Creates a new room. Added on Mar 8, 2019 for API v2. Rate limit: 1200 per minute. - [schedule reports -- Create](https://developers.dialpad.com/reference/schedule_reportscreate.md): Creates a schedule reports subscription for your company. An endpoint_id is required in order to receive the event payload and can be obtained via websockets or webhooks. A schedule reports is a mechanism to schedule daily, weekly or monthly record and statistics reports. Added on Jun 17, 2022 for API v2. Rate limit: 1200 per minute. - [Schedule reports -- Delete](https://developers.dialpad.com/reference/schedule_reportsdelete.md): Deletes a schedule report subscription by id. A schedule report is a mechanism to schedule daily, weekly or monthly record and statistics reports. Added on Jul 6, 2022 for API v2 Rate limit: 1200 per minute. - [Schedule reports -- Get](https://developers.dialpad.com/reference/schedule_reportsget.md): Gets a schedule report subscription by id. A schedule report is a mechanism to schedule daily, weekly or monthly record and statistics reports. Added on Jul 6, 2022 for API v2 Rate limit: 1200 per minute. - [Schedule reports -- List](https://developers.dialpad.com/reference/schedule_reportslist.md): Lists all schedule reports subscription for a company. A schedule report is a mechanism to schedule daily, weekly or monthly record and statistics reports. Added on Jul 6, 2022 for API v2 Rate limit: 1200 per minute. - [Schedule reports -- Update](https://developers.dialpad.com/reference/schedule_reportsupdate.md): Updates a schedule report subscription by id. A schedule report is a mechanism to schedule daily, weekly or monthly record and statistics reports. Added on Jul 6, 2022 for API v2 Rate limit: 1200 per minute. - [Scorecards export -- Initiate Processing](https://developers.dialpad.com/reference/scorecardsexportcreate.md): Begins processing statistics asynchronously, returning a request id to get the status and retrieve the results by calling GET /scorecards/export/{request_id}. Scorecards for the whole company will be processed by default. A target_id and target_type can be provided to limit the stats to a single target. Added on Feb 12, 2024 for API v2. Rate limit: 250 per minute. - [Scorecards export -- Get Result](https://developers.dialpad.com/reference/scorecardsexportget.md): Gets the progress and result of a scorecards report request. Added on Feb 12, 2024 for API v2. Rate limit: 1200 per minute. - [Scorecards -- Get](https://developers.dialpad.com/reference/scorecardsget.md): Gets a scorecard by id. Added on March 25, 2024 for API v2. Rate limit: 1200 per minute. - [Scorecards -- List](https://developers.dialpad.com/reference/scorecardslist.md): Gets a list of scorecards of a target. Added on March 25, 2024 for API v2. Rate limit: 1200 per minute. - [SMS -- Send](https://developers.dialpad.com/reference/smssend.md): Sends an SMS message to a phone number or to a Dialpad channel on behalf of a user. Added on Dec 18, 2019 for API v2. Tier 0 Rate limit: 100 per minute. Tier 1 Rate limit: 800 per minute. - [Stats -- Initiate Processing](https://developers.dialpad.com/reference/statscreate.md): Begins processing statistics asynchronously, returning a request id to get the status and retrieve the results by calling GET /stats/{request_id}. Stats for the whole company will be processed by default. An office_id can be provided to limit stats to a single office. A target_id and target_type can be provided to limit stats to a single target. Added on May 3, 2018 for API v2. Rate limit: 200 per hour. - [Stats -- Get Result](https://developers.dialpad.com/reference/statsget.md): Gets the progress and result of a statistics request. Added on May 3, 2018 for API v2. Rate limit: 1200 per minute. - [Agent Status -- Create](https://developers.dialpad.com/reference/webhook_agent_status_event_subscriptioncreate.md): Creates an agent status event subscription for your company. A webhook_id is required so that we know to which url the events shall be sent. Please be aware that only call center agent is supported for agent event subscription now. See https://developers.dialpad.com/docs/agent-status-events for details on how agent status events work, including the payload structure and payload examples. Added on May 7th, 2021 for API v2. Requires a company admin API key. Rate limit: 1200 per minute. - [Agent Status -- Delete](https://developers.dialpad.com/reference/webhook_agent_status_event_subscriptiondelete.md): Deletes an agent status event subscription by id. Added on May 7th, 2021 for API v2. Requires a company admin API key. Rate limit: 1200 per minute. - [Agent Status -- Get](https://developers.dialpad.com/reference/webhook_agent_status_event_subscriptionget.md): Gets an agent status event subscription by id. Added on May 7th, 2021 for API v2. Requires a company admin API key. Rate limit: 1200 per minute. - [Agent Status -- List](https://developers.dialpad.com/reference/webhook_agent_status_event_subscriptionlist.md): Gets a list of all the agent status event subscriptions of a company. Added on May 7th, 2021 for API v2. Requires a company admin API key. Rate limit: 1200 per minute. - [Agent Status -- Update](https://developers.dialpad.com/reference/webhook_agent_status_event_subscriptionupdate.md): Updates an agent status event subscription by id. Added on May 7th, 2021 for API v2. Requires a company admin API key. Rate limit: 1200 per minute. - [Call Event -- Create](https://developers.dialpad.com/reference/webhook_call_event_subscriptioncreate.md): Creates a call event subscription. A webhook_id is required so that we know to which url the events shall be sent. Call states can be used to limit the states for which call events are sent. A target_type and target_id may optionally be provided to scope the events only to the calls to/from that target. See https://developers.dialpad.com/docs/call-events for details on how call events work, including the payload structure, the meaning of different call states, and payload examples. Note: **To include the recording url in call events, your API key needs to have the "recordings_export" OAuth scope.** Added on April 23rd, 2021 for API v2. Rate limit: 1200 per minute. - [Call Event -- Delete](https://developers.dialpad.com/reference/webhook_call_event_subscriptiondelete.md): Deletes a call event subscription by id. Added on April 23rd, 2021 for API v2. NOTE: See https://developers.dialpad.com/v1.0-archive/reference for APIs that can operate on subscriptions that were created via the deprecated APIs. Rate limit: 1200 per minute. - [Call Event -- Get](https://developers.dialpad.com/reference/webhook_call_event_subscriptionget.md): Gets a call event subscription by id. Added on April 23rd, 2021 for API v2. NOTE: See https://developers.dialpad.com/v1.0-archive/reference for APIs that can operate on subscriptions that were created via the deprecated APIs. Rate limit: 1200 per minute. - [Call Event -- List](https://developers.dialpad.com/reference/webhook_call_event_subscriptionlist.md): Gets a list of all the call event subscriptions of a company or of a target. Added on April 23rd, 2021 for API v2. NOTE: See https://developers.dialpad.com/v1.0-archive/reference for APIs that can operate on subscriptions that were created via the deprecated APIs. Rate limit: 1200 per minute. - [Call Event -- Update](https://developers.dialpad.com/reference/webhook_call_event_subscriptionupdate.md): Updates a call event subscription by id. Added on April 23rd, 2021 for API v2. NOTE: See https://developers.dialpad.com/v1.0-archive/reference for APIs that can operate on subscriptions that were created via the deprecated APIs. Rate limit: 1200 per minute. - [Change Log -- Create](https://developers.dialpad.com/reference/webhook_change_log_event_subscriptioncreate.md): Creates a change log event subscription for your company. An endpoint_id is required so that we know to which url the events shall be sent. See https://developers.dialpad.com/docs/change-log-events for details on how change log events work, including the payload structure and payload examples. Added on December 9th, 2022 for API v2. Requires a company admin API key. Requires scope: ``change_log`` Rate limit: 1200 per minute. - [Change Log -- Delete](https://developers.dialpad.com/reference/webhook_change_log_event_subscriptiondelete.md): Deletes a change log event subscription by id. Added on December 9th, 2022 for API v2. Requires a company admin API key. Requires scope: ``change_log`` Rate limit: 1200 per minute. - [Change Log -- Get](https://developers.dialpad.com/reference/webhook_change_log_event_subscriptionget.md): Gets a change log event subscription by id. Added on December 9th, 2022 for API v2. Requires a company admin API key. Requires scope: ``change_log`` Rate limit: 1200 per minute. - [Change Log -- List](https://developers.dialpad.com/reference/webhook_change_log_event_subscriptionlist.md): Gets a list of all the change log event subscriptions of a company. Added on December 9th, 2022 for API v2. Requires a company admin API key. Requires scope: ``change_log`` Rate limit: 1200 per minute. - [Change Log -- Update](https://developers.dialpad.com/reference/webhook_change_log_event_subscriptionupdate.md): Updates change log event subscription by id. Added on December 9th, 2022 for API v2. Requires a company admin API key. Requires scope: ``change_log`` Rate limit: 1200 per minute. - [Channel Event -- Create](https://developers.dialpad.com/reference/webhook_channel_event_subscriptioncreate.md): Creates a Channel event subscription. An endpoint_id is required so that we know to which url the events shall be sent. A channel direction is also required in order to limit the direction for which events are sent. Use 'all' to get channel events for all directions. A target_id must be provided and it must be a Channel target. Added on Jul 30th, 2024 for API v2. Rate limit: 1200 per minute. - [Channel Event -- Delete](https://developers.dialpad.com/reference/webhook_channel_event_subscriptiondelete.md): Deletes a Channel event subscription by id. Added on Jul 30th, 2024 for API v2. Rate limit: 1200 per minute. - [Channel Event -- Get](https://developers.dialpad.com/reference/webhook_channel_event_subscriptionget.md): Gets a channel event subscription by id. Added on Jul 30th, 2024 for API v2. Rate limit: 1200 per minute. - [Channel Event -- List](https://developers.dialpad.com/reference/webhook_channel_event_subscriptionlist.md): Gets a list of all the Channel event subscriptions of a company or of a target. Added on Jul 30th, 2024 for API v2. Rate limit: 1200 per minute. - [Channel Event -- Update](https://developers.dialpad.com/reference/webhook_channel_event_subscriptionupdate.md): Updates a channel event subscription by id. Added on Jul 30th, 2024 for API v2. Rate limit: 1200 per minute. - [Contact Event -- Create](https://developers.dialpad.com/reference/webhook_contact_event_subscriptioncreate.md): Creates a contact event subscription for your company. A webhook_id is required so that we know to which url the events shall be sent. See https://developers.dialpad.com/docs/contact-events for details on how contact events work, including the payload structure and payload examples. Added on April 23rd, 2021 for API v2. Requires a company admin API key. Rate limit: 1200 per minute. - [Contact Event -- Delete](https://developers.dialpad.com/reference/webhook_contact_event_subscriptiondelete.md): Deletes a contact event subscription by id. Added on April 23rd, 2021 for API v2. NOTE: See https://developers.dialpad.com/v1.0-archive/reference for APIs that can operate on subscriptions that were created via the deprecated APIs. Requires a company admin API key. Rate limit: 1200 per minute. - [Contact Event -- Get](https://developers.dialpad.com/reference/webhook_contact_event_subscriptionget.md): Gets a contact event subscription by id. Added on April 23rd, 2021 for API v2. NOTE: See https://developers.dialpad.com/v1.0-archive/reference for APIs that can operate on subscriptions that were created via the deprecated APIs. Requires a company admin API key. Rate limit: 1200 per minute. - [Contact Event -- List](https://developers.dialpad.com/reference/webhook_contact_event_subscriptionlist.md): Gets a list of all the contact event subscriptions of a company. Added on April 23rd, 2021 for API v2. NOTE: See https://developers.dialpad.com/v1.0-archive/reference for APIs that can operate on subscriptions that were created via the deprecated APIs. Requires a company admin API key. Rate limit: 1200 per minute. - [Contact Event -- Update](https://developers.dialpad.com/reference/webhook_contact_event_subscriptionupdate.md): Updates a contact event subscription by id. Added on April 23rd, 2021 for API v2. NOTE: See https://developers.dialpad.com/v1.0-archive/reference for APIs that can operate on subscriptions that were created via the deprecated APIs. Requires a company admin API key. Rate limit: 1200 per minute. - [Fax Event -- Create](https://developers.dialpad.com/reference/webhook_fax_event_subscriptioncreate.md): Creates a fax event subscription. An endpoint_id is required so that we know to which url the events shall be sent. A fax direction is also required in order to limit the direction for which fax events are sent. Use 'all' to get fax events for all directions. A target_type and target_id may optionally be provided to scope the events only to fax to/from that target. See https://developers.dialpad.com/docs/fax-events for details on how fax events work, including the payload structure and payload examples. NOTE: **API key needs to have the "fax_message" OAuth scope.** Added on Jan 12th, 2024 for API v2. Requires scope: ``fax_message`` Rate limit: 1200 per minute. - [Fax Event -- Delete](https://developers.dialpad.com/reference/webhook_fax_event_subscriptiondelete.md): Deletes a fax event subscription by id. Added on Jan 12th, 2024 for API v2. Requires scope: ``fax_message`` Rate limit: 1200 per minute. - [Fax Event -- Get](https://developers.dialpad.com/reference/webhook_fax_event_subscriptionget.md): Gets a fax event subscription by id. Added on Jan 12th, 2024 for API v2. Requires scope: ``fax_message`` Rate limit: 1200 per minute. - [Fax Event -- List](https://developers.dialpad.com/reference/webhook_fax_event_subscriptionlist.md): Gets a list of all the fax event subscriptions of a company or of a target. Added on Jan 12th, 2024 for API v2. Requires scope: ``fax_message`` Rate limit: 1200 per minute. - [Fax Event -- Update](https://developers.dialpad.com/reference/webhook_fax_event_subscriptionupdate.md): Updates a fax event subscription by id. Added on Jan 12th, 2024 for API v2. Requires scope: ``fax_message`` Rate limit: 1200 per minute. - [SMS Event -- Create](https://developers.dialpad.com/reference/webhook_sms_event_subscriptioncreate.md): Creates an SMS event subscription. A webhook_id is required so that we know to which url the events shall be sent. An SMS direction is also required in order to limit the direction for which SMS events are sent. Use 'all' to get SMS events for all directions. A target_type and target_id may optionally be provided to scope the events only to SMS to/from that target. See https://developers.dialpad.com/docs/sms-events for details on how SMS events work, including the payload structure and payload examples. NOTE: **To include the MESSAGE CONTENT in SMS events, your API key needs to have the "message_content_export" OAuth scope for when a target is specified in this API and/or "message_content_export:all" OAuth scope for when no target is specified.** NOTE: See https://developers.dialpad.com/v1.0-archive/reference for APIs that can operate on subscriptions that were created via the deprecated APIs. Added on April 9th, 2021 for API v2. Rate limit: 1200 per minute. - [SMS Event -- Delete](https://developers.dialpad.com/reference/webhook_sms_event_subscriptiondelete.md): Deletes an SMS event subscription by id. Added on April 9th, 2021 for API v2. NOTE: See https://developers.dialpad.com/v1.0-archive/reference for APIs that can operate on subscriptions that were created via the deprecated APIs. Rate limit: 1200 per minute. - [SMS Event -- Get](https://developers.dialpad.com/reference/webhook_sms_event_subscriptionget.md): Gets an SMS event subscription by id. Added on April 9th, 2021 for API v2. NOTE: See https://developers.dialpad.com/v1.0-archive/reference for APIs that can operate on subscriptions that were created via the deprecated APIs. Rate limit: 1200 per minute. - [SMS Event -- List](https://developers.dialpad.com/reference/webhook_sms_event_subscriptionlist.md): Gets a list of all the SMS event subscriptions of a company or of a target. Added on April 9th, 2021 for API v2. NOTE: See https://developers.dialpad.com/v1.0-archive/reference for APIs that can operate on subscriptions that were created via the deprecated APIs. Rate limit: 1200 per minute. - [SMS Event -- Update](https://developers.dialpad.com/reference/webhook_sms_event_subscriptionupdate.md): Updates an SMS event subscription by id. Added on April 9th, 2021 for API v2. NOTE: See https://developers.dialpad.com/v1.0-archive/reference for APIs that can operate on subscriptions that were created via the deprecated APIs. Rate limit: 1200 per minute. - [Call Transcript -- Get URL](https://developers.dialpad.com/reference/transcriptsget_url.md): Gets the transcript url of a call. Added on June 9, 2021 for API v2. Rate limit: 1200 per minute. - [Call Transcript -- Get](https://developers.dialpad.com/reference/transcriptsget.md): Gets the Dialpad AI transcript of a call, including moments. Added on Dec 18, 2019 for API v2. Rate limit: 1200 per minute. - [User Device -- Get](https://developers.dialpad.com/reference/userdevicesget.md): Gets a device by ID. Added on Feb 4, 2020 for API v2. Rate limit: 1200 per minute. - [User Device -- List](https://developers.dialpad.com/reference/userdeviceslist.md): Lists the devices for a specific user. Added on Feb 4, 2020 for API v2. Rate limit: 1200 per minute. - [Caller ID -- Get](https://developers.dialpad.com/reference/caller_idusersget.md): List all available Caller IDs and the active Caller ID for a given user ID Added on Aug 3, 2022 for API v2. Rate limit: 1200 per minute. - [Desk Phone -- Delete](https://developers.dialpad.com/reference/deskphonesusersdelete.md): Deletes a user desk phone by id. Added on May 17, 2018 for API v2. Rate limit: 1200 per minute. - [Desk Phone -- Get](https://developers.dialpad.com/reference/deskphonesusersget.md): Gets a user desk phone by id. Added on May 17, 2018 for API v2. Rate limit: 1200 per minute. - [Desk Phone -- List](https://developers.dialpad.com/reference/deskphonesuserslist.md): Gets all desk phones under a user. Added on May 17, 2018 for API v2. Rate limit: 1200 per minute. - [Screen-pop -- Trigger](https://developers.dialpad.com/reference/screen_popinitiate.md): Initiates screen pop for user device. Requires scope: ``screen_pop`` Rate limit: 5 per minute. - [User -- Create](https://developers.dialpad.com/reference/userscreate.md): Creates a new user. Added on March 22, 2018 for API v2. Rate limit: 1200 per minute. - [User -- Delete](https://developers.dialpad.com/reference/usersdelete.md): Deletes a user by id. Added on May 11, 2018 for API v2. Rate limit: 1200 per minute. - [E911 Address -- Get](https://developers.dialpad.com/reference/userse911get.md): Gets E911 address of the user by user id. Added on May 25, 2021 for API v2. Rate limit: 1200 per minute. - [E911 Address -- Update](https://developers.dialpad.com/reference/userse911update.md): Update E911 address of the given user. Added on May 25, 2021 for API v2. Rate limit: 1200 per minute. - [User -- Get](https://developers.dialpad.com/reference/usersget.md): Get a user by id. Returns identity (name, email, job_title), contact details (phone_numbers, extension), status (state, do_not_disturb, is_on_duty, on_duty_status), license type, office membership (office_id, group_details), and voicemail settings. Added on March 22, 2018 for API v2. Rate limit: 1200 per minute. - [Call -- Initiate](https://developers.dialpad.com/reference/usersinitiate_call.md): Causes a user's Dialpad application to initiate an outbound call. Note that the user must have at least one active autocallable device (the web or desktop Dialpad app, or a CTI application). The Dialpad mobile apps and physical deskphones do not support this API call. Added on Nov 18, 2019 for API v2. Rate limit: 5 per minute. - [User -- List](https://developers.dialpad.com/reference/userslist.md): Gets company users, optionally filtering by email. NOTE: The `limit` parameter has been soft-deprecated. Please omit the `limit` parameter, or reduce it to `100` or less. - Limit values of greater than `100` will only produce a page size of `100`, and a `400 Bad Request` response will be produced 20% of the time in an effort to raise visibility of side-effects that might otherwise go un-noticed by solutions that had assumed a larger page size. - The `cursor` value is provided in the API response, and can be passed as a parameter to retrieve subsequent pages of results. Added on March 22, 2018 for API v2. Rate limit: 1200 per minute. - [Call VI -- Toggle](https://developers.dialpad.com/reference/userstoggle_call_vi.md): Turns call vi on or off for a user's active call. Added on May 4, 2021 for API v2. Rate limit: 1200 per minute. - [Do Not Disturb -- Toggle](https://developers.dialpad.com/reference/userstoggle_dnd.md): Toggle DND status on or off for the given user. Added on Oct 14, 2021 for API v2. Rate limit: 1200 per minute. - [User Status -- Update](https://developers.dialpad.com/reference/usersupdate_status.md): Update user's status. Returns the user's status if the user exists. Rate limit: 1200 per minute. - [User -- Update](https://developers.dialpad.com/reference/usersupdate.md): Updates the provided fields for an existing user. Added on March 22, 2018 for API v2. Rate limit: 1200 per minute. - [Webhook -- Create](https://developers.dialpad.com/reference/webhookscreate.md): Creates a new webhook for your company. A unique webhook ID will be generated when successfully creating a webhook. A webhook ID is to be required when creating event subscriptions. One webhook ID can be shared between multiple event subscriptions. When triggered, events will be sent to the provided hook_url under webhook. If a secret is provided, the webhook events will be encoded and signed in the JWT format using the shared secret with the HS256 algorithm. The JWT payload should be decoded and the signature verified to ensure that the event came from Dialpad. If no secret is provided, unencoded events will be sent in the JSON format. It is recommended to provide a secret so that you can verify the authenticity of the event. Added on April 2nd, 2021 for API v2. Rate limit: 100 per minute. - [Webhook -- Delete](https://developers.dialpad.com/reference/webhooksdelete.md): Deletes a webhook by id. Added on April 2nd, 2021 for API v2. Rate limit: 1200 per minute. - [Webhook -- Get](https://developers.dialpad.com/reference/webhooksget.md): Gets a webhook by id. Added on April 2nd, 2021 for API v2. Rate limit: 1200 per minute. - [Webhook -- List](https://developers.dialpad.com/reference/webhookslist.md): Gets a list of all the webhooks that are associated with the company. Added on April 2nd, 2021 for API v2. Rate limit: 1200 per minute. - [Webhook -- Update](https://developers.dialpad.com/reference/webhookupdate.md): Updates a webhook by id. Added on April 2nd, 2021 for API v2. Rate limit: 1200 per minute. - [Websocket -- Create](https://developers.dialpad.com/reference/websocketscreate.md): Creates a new websocket for your company. A unique websocket ID will be generated when successfully creating a websocket. A websocket ID is to be required when creating event subscriptions. One websocket ID can be shared between multiple event subscriptions. When triggered, events will be accessed through provided websocket_url under websocket. The url will be expired after 1 hour. Please use the GET websocket API to regenerate url rather than creating new ones. If a secret is provided, the websocket events will be encoded and signed in the JWT format using the shared secret with the HS256 algorithm. The JWT payload should be decoded and the signature verified to ensure that the event came from Dialpad. If no secret is provided, unencoded events will be sent in the JSON format. It is recommended to provide a secret so that you can verify the authenticity of the event. Added on April 5th, 2022 for API v2. Rate limit: 250 per minute. - [Websocket -- Delete](https://developers.dialpad.com/reference/websocketsdelete.md): Deletes a websocket by id. Added on April 2nd, 2021 for API v2. Rate limit: 1200 per minute. - [Websocket -- Get](https://developers.dialpad.com/reference/websocketsget.md): Gets a websocket by id. Added on April 5th, 2022 for API v2. Rate limit: 1200 per minute. - [Websocket -- List](https://developers.dialpad.com/reference/websocketslist.md): Gets a list of all the websockets that are associated with the company. Added on April 5th, 2022 for API v2. Rate limit: 1200 per minute. - [Websocket -- Update](https://developers.dialpad.com/reference/websocketsupdate.md): Updates a websocket by id. Added on April 5th, 2022 for API v2. Rate limit: 1200 per minute. - [Activity Metrics](https://developers.dialpad.com/reference/wfm-metrics-activityget.md): Returns paginated, activity-level metrics for specified agents. Rate limit: 1200 per minute. - [Agent Metrics](https://developers.dialpad.com/reference/wfm-metrics-agentget.md): Returns paginated, detailed agent-level performance metrics. Rate limit: 1200 per minute. ## Pages - [Report Download API](https://developers.dialpad.com/report-download-api.md) ## Changelog - [Recently Launched (July 2025)](https://developers.dialpad.com/changelog/recently-launched-july-2025.md) - [Recently Launched (September/October 2024)](https://developers.dialpad.com/changelog/recently-launched-septemberoctober-2024.md) - [Recently Launched (April 2024)](https://developers.dialpad.com/changelog/recently-launched-april-2024.md) - [Recently Launched (October 2023)](https://developers.dialpad.com/changelog/recently-launched-october-2023.md) - [Recently Launched (August 2023)](https://developers.dialpad.com/changelog/recently-launched-april-2023-1.md)