{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"05d74712-6d22-4a82-9c17-5d5be8325faf","name":"Krisp Portal API","description":"This API is intended to help Krisp Team admins to manage their teams more easily. If you are managing a team with many thousands of users, you can use this to write scripts and automate the most commonly performed operations such as adding or removing a seat, inviting new users to join the team, or monitoring the team status.  \nThis API can be used to manage both device and email teams.\n\n# How it works\n\nThe Krisp Team Management API is based on REST. Authentication is performed with API keys. Requests are made via HTTP endpoints with clear functions and appropriate response codes. The responses are JSON-encoded. The API supports both **application/json** and **x-www-form-urlencoded** headers.\n\n# Authentication\n\nThe Krisp Team Management API uses Basic authentication to authenticate requests. You can view and manage credentials (API key and secret) in the [Krisp Teams Dashboard](https://account.krisp.ai/app/manage/account).\n\nYour API credentials carry many privileges, so be sure to keep them secure! Do not share your secret API credentials in publicly accessible areas such as GitHub, client-side code, and so forth.\n\nAll API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail.  \nAll requests to the API must contain the following authentication header.\n\n`Authorization : \"Basic base64({{api_key}}:{{secret}})\"`\n\n# Versioning\n\nWhen backward-incompatible changes are made to the API a new API version is published. We define backward-incompatible changes as\n\n- changes in response attribute names\n    \n- changes in logic\n    \n- changes in endpoint names\n    \n- removal of existing attributes\n    \n- deprecated endpoints\n    \n\nWhen a new version of the API is released you will be notified by email to change your exiting code accordingly. The old API will be deprecated after 3 months.  \nAPI version number is included in URL after the domain name like so [https://teams.krisp.ai/api/{{VERSION_NUMBER}}](https://teams.krisp.ai/api/%7B%7BVERSION_NUMBER%7D%7D)\n\n**Important.** When adding new attributes to the response of the existing API endpoints, a new version of API will not be published. Your existing version of the API will continue working as it did. You need to specify the version of the API every time you make a request. Important changes made to the API will be communicated additionally.\n\n# Rate Limiting\n\nRate limiting works based on the requester's IP address. If the requester exceeds the limit, then the requests from the same IP address will be blocked for a predefined period of time.  \nHTTP status code 429 will be returned in the response.  \nExample configuration: exceeding 700 requests from the same IP address within 1 minute to block the requester for 1 hour (table below).\n\n| Type | Requests per minute | Blocking timeout |\n| --- | --- | --- |\n| IP | 700 | 1 hour |\n\n# Response codes\n\nKrisp Team Management API will provide the standard HTTP codes and also the body status code that will give mode context about the nature of the error or response.\n\n| Code | Message example | HTTP status code |\n| --- | --- | --- |\n| 0 | Success | 200 |\n| 1 | Authentication failure | 401 |\n| 1015 | Not found | 400 |\n| 1016 | Validation error | 400 |\n| 1023 | Forbidden | 400 |\n| 1026 | Too Many Requests | 429 |\n| 10000 | Internal server error | 500 |\n\n# Error codes\n\n| Error code | Situation | UI message |\n| --- | --- | --- |\n| AUTH_HEADER_MISSING | Make sure to include authorization header in request headers | Problem during authentication. |\n| AUTH_HEADER_WRONG_FORMAT | Only Basic and Bearer tokens are supported | Problem during authentication. |\n| AUTH_BASIC_ONLY | Happens when the authorization header is not basic | Problem during authentication. |\n| AUTH_BASIC_INVALID_TOKEN | Happens when basic auth credentials are wrong | Problem during authentication. |\n| VALIDATION_ERROR | Happens when API receives inputs from a client that are unexpected or wrong | Something went wrong. |\n| NOT_PERMITTED_ADD_SEATS | Happens when team payment type is invoice | Not enough permissions. |\n| SEAT_NOT_FOUND | Happens when seat not found | Seat not found. |\n| NOT_PERMITTED_CHANGE_SEAT_STATUS | Happens when seat type is not device | Not enough permissions. |\n| SEAT_IS_EMPTY | Happens when trying change empty seat status | Seat is empty. |\n| SEAT_IS_NOT_EMPTY | Happens when trying to delete seat but seat already has a user assigned | Seat is in use. remove assigned user from the seat before deleting it. |\n| NOT_PERMITTED_DELETE_SEAT | Happens when team payment type is invoice | Not enough permissions. |\n| NOT_PERMITTED_INVITE_USER | Happens when access denied inviting new members | Not enough permissions. |\n| NOT_EMPTY_SEAT | Happens when trying to log in but don't have empty seats | You don't have empty seats. |\n| ALREADY_MEMBER | User is already assigned to another seat within the same team | User is already a team member. |\n| NOT_PERMITTED_UNASSIGN_LAST_ADMINISTRATOR_SEAT | Not enough permissions. | Happens when you try unassign last administrator in the them |\n\n# Response Data\n\n| Attributes | Description | Possible values |\n| --- | --- | --- |\n| code | Response code | See \"Response codes\" table |\n| error_code | Specifies the error detail for the failed response | See \"Error codes\" table |\n| message | Verbal description of the error code | Arbitrary string value |\n| situation | Verbal description of the possible reason of the failure | Arbitrary string value |\n| data->count | The number of matching results returned in the response | A non-negative number |\n| data->seats->id | Seat Id | Positive integer |\n| data->seats->type | Seat type | \"device\", \"standard\" |\n| data->seats->status | Seat status | \"unassigned\", \"active\", \"inactive\", \"blocked\", \"logged_in\", \"pending_accept\", \"pending_login\" |\n| data->seats->role | Seat role | \"Admin\", \"User\" |\n| data->seats->join_date | User join date-time | Valid date-time in ISO 8601 format |\n| data->seats->nickname | Seat nickname | Valid nickname string in UTF8 or null |\n| data->seats->user->id | User ID | Positive integer |\n| data->seats->user->hostname | User computer hostname | Arbitrary string value |\n| data->seats->user->email | User E-mail | Valid email string |","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":false,"owner":"9824085","team":123714,"collectionId":"05d74712-6d22-4a82-9c17-5d5be8325faf","publishedId":"T17M75y2","public":true,"publicUrl":"https://documenter-api.postman.tech/view/9824085/T17M75y2","privateUrl":"https://go.postman.co/documentation/9824085-05d74712-6d22-4a82-9c17-5d5be8325faf","customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"EF5B25"},"documentationLayout":"classic-double-column","customisation":null,"version":"8.10.0","publishDate":"2020-07-29T13:32:18.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{},"logos":{}},"statusCode":200},"environments":[{"name":"API","id":"fe5bb0ae-39f0-438d-bfd6-9e22397237c1","owner":"9824085","values":[{"key":"host","value":"https://teams.krisp.ai","enabled":true}],"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/07b0a963e63981349f53dadee0f17a8fe87d4c586c2a258484c409c948c8058b","favicon":""},"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":"API","value":"9824085-fe5bb0ae-39f0-438d-bfd6-9e22397237c1"}],"canonicalUrl":"https://documenter.gw.postman.com/view/metadata/T17M75y2"}