{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"736ed633-628a-4cc4-82b4-d3185338fc29","name":"Edify API Docs","description":"Welcome to the **Edify API Docs**. This Postman collection contains all of the documented services and routes of Edify API.\n\n# Get started\n\nFollow the steps below to get started with Edify API in Postman.\n\n1. Create an Edify account by filling out the [Edify activation form](https://activate.edify.cx/) and confirming your email address / phone number.\n2. Click the **Run in Postman** button in the top-right corner of the screen to import this collection to your Postman workspace.\n3. In Google Chrome, navigate to [console.edify.cx](https://console.edify.cx) in Google Chrome. Log in with your Edify email and password.\n4. Click the **API** button in the bottom-left corner of the screen.\n5. On the API Console Logs workspace, click the **API Credentials** (key icon) button in the top-right corner of the screen.\n6. Copy your your **Edify email address** and your **Token** (_keep this secret!_).\n7. In Postman, click the **Environments** tab in the workspace where you shared the collection. Click the environment called **Edify API Docs**.\n8. In the **Current Value** column, fill in your email address for the `` edify_api_user_credential` `` and your token for the `edify_api_token`.\n9. Save your changes after editing the variables.\n10. To test your connection, run the **Describe Account** route (_Account > Describe Account_). If it succeeds, you're all set. If it fails, review these steps to make sure you followed everything correctly.\n    \n\n## Video guide\n\nWatch the video below to help get started with Edify API in Postman. (If video does not load, you can also [view it on YouTube](https://www.youtube.com/watch?v=nvEvPWKsvMo)).\n\n<video src=\"https://youtube.com/embed/nvEvPWKsvMo\" width=\"640\" height=\"360\"></video>\n\n## Request example\n\nBelow is a code example of making a Describe Account request with basic authorization (email:token).\n\n``` cURL\ncurl --location --request GET 'https://api.edify.cx/v4/account' \\\n--header 'u:{{your_login_email}}:{{your_api_token}}'\n\n ```\n\n# Bearer authentication\n\nThis section explains how to set up bearer authentication as an alternative to the basic authentication set up in the **Get started** section above. Note that **you must follow the steps in the Get started section** to get basic authentication configured before you can configure bearer authentication.\n\n1. With basic authentication configured (see **Get started** above), in Edify API navigate to _User Tokens > Create JWT_.\n2. Run the **Create JWT** route, making sure to fill out the following body parameters (see the route's documentation):\n    1. `userId` (of the user making API requests)\n    2. `expiresUnit`\n    3. `expiresScalar`\n    4. `label`\n3. Run the Create JWT route. If successful, it should return a response body containing a `token` object with a child `value` object. This is your bearer token; copy it to the clipboard (_without_ the quotation marks).\n4. In Postman, find and click the Edify API collection. Click the **Variables** button in the middle of the Postman screen.\n5. For the variable `edify_JWT_token`, paste the bearer token you copied in step 3.\n6. Save your changes after editing the variables.\n7. Click the **Authorization** button. In the **Type** menu, select **Bearer Token**.\n8. In the **Token** text box, input the variable `edify_JWT_token`.\n9. Save your changes after editing the authorization type.\n10. To test your connection, run the **Describe Account** route (_Account > Describe Account_). If it succeeds, you're all set. If it fails, review these steps to make sure you followed everything correctly.\n    \n\n## Request example\n\nBelow is a code example of making a Describe Account request with bearer authorization.\n\n``` cURL\ncurl --location --request GET 'https://api.edify.cx/v4/account' \\\n--header 'Authorization: Bearer {{your_JWT_token}}'\n\n ```\n\n## Need help?\n\nIf you need help authorizing against Edify API, please reach out to Edify Support:\n\n| Method | Link |\n| --- | --- |\n| Email | [support@edify.cx](https://mailto:support@edify.cx) |\n| Web chat | [Edify Support web chat](https://catalyst.edify.cx/ask-the-catalyst-community-team) |\n\n---\n\n# Requests and responses\n\nEdify API supports the following request body formats:\n\n- `form-data`\n- `x-www-form-urlencoded`\n- `JSON`\n    \n\nSome routes only support, or strongly suggest, JSON request bodies. The documentation for such routes will indicate whether JSON is the preferred request body format.\n\nIn most circumstances, Edify API v4 returns responses in JSON format. The only exception to this is when when a route returns a file.\n\n# Errors\n\nYou may encounter errors with Edify API. If an error occurs, the response body will typically match this format:\n\n``` json\n{\n  message: <string>,\n  errors: <array>\n}\n\n ```\n\nSome error codes may include:\n\n| Code | Description |\n| --- | --- |\n| 401 | Unauthorized -- typically due to invalid credentials |\n| 404 | Not found -- typically due to an incorrect route or a non-existent resource |\n| 422 | Unprocessable entity -- typically due to missing required fields |\n| 500 | Internal error - typically due to a problem with Edify API |\n\n# Extended record details\n\nMany of the \"Describe\" and \"List\" routes retrieve basic sets of data about the requested resource. If you also want to retrieve information about the user who created the resource, you can request extended record details.\n\nIf you want to receive extended record details, provide this query string parameter in your request: includeExtendedRecordDetails=true.\n\nBelow is an example of a request and response with extended record details.\n\n``` curl\ncurl -XGET https://api.edify.cx/v4/authProviders?includeExtendedRecordDetails=true -H 'authorization: Basic email:token'\n\n ```\n\n``` json\n{\n  authProviders: [\n    {\n      id: '...',\n      displayName: 'My Auth Provider',\n      createdBy: '002...',\n      createdByUser: {\n        id: '002...', // same as `createdBy`\n        email: 'hello@world.com',\n        firstName: 'John',\n        lastName: 'Hammond',\n        fullName: 'John Hammond',\n      }\n    }\n  ]\n}\n\n ```\n\n# Reference\n\nView the folders below for documentation and examples of Edify API routes.","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":false,"owner":"16046560","collectionId":"736ed633-628a-4cc4-82b4-d3185338fc29","publishedId":"UVC8CRnT","public":true,"publicUrl":"https://apidocs.avaya.cx","privateUrl":"https://go.postman.co/documentation/16046560-736ed633-628a-4cc4-82b4-d3185338fc29","customColor":{"top-bar":"84c441","right-sidebar":"303030","highlight":"84c441"},"documentationLayout":"classic-double-column","customisation":{"metaTags":[{"name":"description","value":"With the Edify API, you can deploy the power of real-time API capabilities to extend the functionality of your business communications. Our docs will help you get started using the Edify API."},{"name":"title","value":""}],"appearance":{"default":"light","themes":[{"name":"dark","logo":null,"colors":{"top-bar":"212121","right-sidebar":"303030","highlight":"FF6C37"}},{"name":"light","logo":null,"colors":{"top-bar":"84c441","right-sidebar":"303030","highlight":"84c441"}}]}},"version":"8.11.6","publishDate":"2024-05-21T22:32:38.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{"title":"","description":"With the Edify API, you can deploy the power of real-time API capabilities to extend the functionality of your business communications. Our docs will help you get started using the Edify API."},"logos":{"logoLight":null,"logoDark":null}},"statusCode":200},"environments":[{"name":"Edify API Docs","id":"e228e3f3-f420-407f-9596-a672eca1520e","owner":"16046560","values":[{"key":"edify_api_user_credential","value":"your_edify_login_email","enabled":true,"type":"default"},{"key":"edify_api_token","value":"api_key (found in Edify Console)","enabled":true,"type":"default"},{"key":"edify_api_base_url","value":"https://api.edify.cx/v4","enabled":true,"type":"default"}],"published":true}],"user":{"authenticated":false,"permissions":{"publish":false}},"run":{"button":{"js":"https://run.pstmn.io/button.js","css":"https://run.pstmn.io/button.css"}},"web":"https://www.getpostman.com/","team":{"logo":"https://res.cloudinary.com/postman/image/upload/t_team_logo_pubdoc/v1/team/ef069d5e295b70db001e18fc5fbe65d5bc0a67abcec49ee9ca8e15574e6688a3","favicon":"https://res.cloudinary.com/postman/image/upload/v1546486077/team/lhwlkelucdpqfpnl7onj.ico"},"isEnvFetchError":false,"languages":"[{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"HttpClient\"},{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"RestSharp\"},{\"key\":\"curl\",\"label\":\"cURL\",\"variant\":\"cURL\"},{\"key\":\"dart\",\"label\":\"Dart\",\"variant\":\"http\"},{\"key\":\"go\",\"label\":\"Go\",\"variant\":\"Native\"},{\"key\":\"http\",\"label\":\"HTTP\",\"variant\":\"HTTP\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"OkHttp\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"Unirest\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"Fetch\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"jQuery\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"XHR\"},{\"key\":\"c\",\"label\":\"C\",\"variant\":\"libcurl\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Axios\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Native\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Request\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Unirest\"},{\"key\":\"objective-c\",\"label\":\"Objective-C\",\"variant\":\"NSURLSession\"},{\"key\":\"ocaml\",\"label\":\"OCaml\",\"variant\":\"Cohttp\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"cURL\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"Guzzle\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"HTTP_Request2\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"pecl_http\"},{\"key\":\"powershell\",\"label\":\"PowerShell\",\"variant\":\"RestMethod\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"http.client\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"Requests\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"httr\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"RCurl\"},{\"key\":\"ruby\",\"label\":\"Ruby\",\"variant\":\"Net::HTTP\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"Httpie\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"wget\"},{\"key\":\"swift\",\"label\":\"Swift\",\"variant\":\"URLSession\"}]","languageSettings":[{"key":"csharp","label":"C#","variant":"HttpClient"},{"key":"csharp","label":"C#","variant":"RestSharp"},{"key":"curl","label":"cURL","variant":"cURL"},{"key":"dart","label":"Dart","variant":"http"},{"key":"go","label":"Go","variant":"Native"},{"key":"http","label":"HTTP","variant":"HTTP"},{"key":"java","label":"Java","variant":"OkHttp"},{"key":"java","label":"Java","variant":"Unirest"},{"key":"javascript","label":"JavaScript","variant":"Fetch"},{"key":"javascript","label":"JavaScript","variant":"jQuery"},{"key":"javascript","label":"JavaScript","variant":"XHR"},{"key":"c","label":"C","variant":"libcurl"},{"key":"nodejs","label":"NodeJs","variant":"Axios"},{"key":"nodejs","label":"NodeJs","variant":"Native"},{"key":"nodejs","label":"NodeJs","variant":"Request"},{"key":"nodejs","label":"NodeJs","variant":"Unirest"},{"key":"objective-c","label":"Objective-C","variant":"NSURLSession"},{"key":"ocaml","label":"OCaml","variant":"Cohttp"},{"key":"php","label":"PHP","variant":"cURL"},{"key":"php","label":"PHP","variant":"Guzzle"},{"key":"php","label":"PHP","variant":"HTTP_Request2"},{"key":"php","label":"PHP","variant":"pecl_http"},{"key":"powershell","label":"PowerShell","variant":"RestMethod"},{"key":"python","label":"Python","variant":"http.client"},{"key":"python","label":"Python","variant":"Requests"},{"key":"r","label":"R","variant":"httr"},{"key":"r","label":"R","variant":"RCurl"},{"key":"ruby","label":"Ruby","variant":"Net::HTTP"},{"key":"shell","label":"Shell","variant":"Httpie"},{"key":"shell","label":"Shell","variant":"wget"},{"key":"swift","label":"Swift","variant":"URLSession"}],"languageOptions":[{"label":"C# - HttpClient","value":"csharp - HttpClient - C#"},{"label":"C# - RestSharp","value":"csharp - RestSharp - C#"},{"label":"cURL - cURL","value":"curl - cURL - cURL"},{"label":"Dart - http","value":"dart - http - Dart"},{"label":"Go - Native","value":"go - Native - Go"},{"label":"HTTP - HTTP","value":"http - HTTP - HTTP"},{"label":"Java - OkHttp","value":"java - OkHttp - Java"},{"label":"Java - Unirest","value":"java - Unirest - Java"},{"label":"JavaScript - Fetch","value":"javascript - Fetch - JavaScript"},{"label":"JavaScript - jQuery","value":"javascript - jQuery - JavaScript"},{"label":"JavaScript - XHR","value":"javascript - XHR - JavaScript"},{"label":"C - libcurl","value":"c - libcurl - C"},{"label":"NodeJs - Axios","value":"nodejs - Axios - NodeJs"},{"label":"NodeJs - Native","value":"nodejs - Native - NodeJs"},{"label":"NodeJs - Request","value":"nodejs - Request - NodeJs"},{"label":"NodeJs - Unirest","value":"nodejs - Unirest - NodeJs"},{"label":"Objective-C - NSURLSession","value":"objective-c - NSURLSession - Objective-C"},{"label":"OCaml - Cohttp","value":"ocaml - Cohttp - OCaml"},{"label":"PHP - cURL","value":"php - cURL - PHP"},{"label":"PHP - Guzzle","value":"php - Guzzle - PHP"},{"label":"PHP - HTTP_Request2","value":"php - HTTP_Request2 - PHP"},{"label":"PHP - pecl_http","value":"php - pecl_http - PHP"},{"label":"PowerShell - RestMethod","value":"powershell - RestMethod - PowerShell"},{"label":"Python - http.client","value":"python - http.client - Python"},{"label":"Python - Requests","value":"python - Requests - Python"},{"label":"R - httr","value":"r - httr - R"},{"label":"R - RCurl","value":"r - RCurl - R"},{"label":"Ruby - Net::HTTP","value":"ruby - Net::HTTP - Ruby"},{"label":"Shell - Httpie","value":"shell - Httpie - Shell"},{"label":"Shell - wget","value":"shell - wget - Shell"},{"label":"Swift - URLSession","value":"swift - URLSession - Swift"}],"layoutOptions":[{"value":"classic-single-column","label":"Single Column"},{"value":"classic-double-column","label":"Double Column"}],"versionOptions":[],"environmentOptions":[{"value":"0","label":"No Environment"},{"label":"Edify API Docs","value":"16046560-e228e3f3-f420-407f-9596-a672eca1520e"}],"canonicalUrl":"https://apidocs.avaya.cx/view/metadata/UVC8CRnT"}