Admin API [Deprecated]

We've deprecated this API; for the latest API documentation, please visit developers.dialpad.com/docs/welcome

---

If you have any questions regarding API keys on Dialpad, please visit the developer discussion board.

All requests are simple HTTP REST type requests sent as content type application/x-www-form-urlencoded. For GET requests all parameters are passed in the query string. For PUT/POST/DELETE requests all parameters are sent in the body of the request in query string format.

For any HTTP API requests, the access token should be generated by your Admin from the web portal. You can pass the access token with the parameter api_key or with the Authorization: Bearer HTTP header (ex: Authorization: Bearer <access_token>).

All endpoints are only accessible via https and are located at dialpad.com. For instance: you can get a list of your Users by requesting the following URL with your access token:

https://dialpad.com/api/v1/admin/user?api_key=<ACCESS-TOKEN> 

Dialpad Tip: Did you know Pro and Enterprise plans have access to a sandbox environment? Just reach out to our support team to enable access.

Access and Create API Key 

To access and create your API key, have your Office Admin follow these steps:

1. Navigate to Admin Settings > Authentication > API Keys
   1. If you don't see this option, reach out to our support team
2. Select Add Key
3. Name your key and set your expiry then hit Save
4. Select Show Value to reveal your API key 

Dialpad Tip: You can edit API keys including deleting them by selecting Edit next to the specific key.

User Management

Add a New User

{
  "office_count": 34,
  "pending_user": "sample@sample.com",
  "message": "creating user...check back in a moment please",
  # Adding a new user is asynchronous. Check the user status later.
  "company_count": 34
}

{
  # Company account information
  office_count: 34,
  company_count: 34,
  # User information
  user: {
    last_name: "",
    first_name: "",
    primary_email: "sample@sample.com",
    primary_phone: "+14154292691",
    # ... etc
  }
}

{
  status: 1,
  errors: [
    "email_conflict"
  ]
}

{
  "kind": "stats",
  "status": "processing"
}

{
  "download_url": ""
  "file_type": "csv",
  "kind": "stats",
  "status": "complete"
}