{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"61011ab1-26be-4b00-85fa-9af22fb60ab5","name":"Customers API","description":"<img src=\"https://content.pstmn.io/edbddf7e-d19e-4607-aada-10ccc31b5fe7/TWFpbiBMb2dvIG1kLnBuZw==\">\n\n---\n\nWelcome to the documentation for the **Beta** version of the MeetRox API. This API allows you to access data from your recorded and analyzed conversations by MeetRox, including meeting details, participants, and AI-generated insights.\n\n## Quick Start Guide\n\n---\n\nTo start using the MeetRox API, follow these steps:\n\n1. **API Key Generation:**\n    \n    - Log in to the [MeetRox platform](https://app.meetrox.ai/) and navigate to **Manage > Settings > API Keys** to generate your key.\n        \n    - Only users with **manager** permissions can generate an API key.\n        \n2. **Request Configuration:**\n    \n    - All requests must be made over **HTTPS**.\n        \n    - Requests and responses use the **JSON** format.\n        \n    - For authentication, include your **API Key** in the `Authorization` header in every request.\n        \n    - To use our advanced filtering mechanism, refer to the Advanced Filters section below.\n        \n\n## ⚡ Rate Limit\n\n---\n\nThe MeetRox API has usage restrictions to ensure stability.\n\n- **Each API key can make up to 100 requests per minute.**\n    \n- If the limit is exceeded, the response will return **429 Too Many Requests**.\n    \n- The following headers are provided for monitoring:\n    \n\n| Header | Description |\n| --- | --- |\n| `X-RateLimit-Limit` | Maximum number of requests allowed per minute. |\n| `X-RateLimit-Remaining` | Remaining number of requests in the current window. |\n| `X-RateLimit-Reset` | UTC timestamp indicating when the limit will reset. |\n\n## 📚 Support and FAQ Links\n\n---\n\nFor any questions or more information, please visit:\n\n- [Official MeetRox Website](https://meetrox.ai/) – General product information.\n    \n- [Help Center (FAQ)](https://help.meetrox.ai/) – Frequently asked questions and guides.\n    \n- [System Status](https://status.meetrox.ai/) – Check the API availability.\n    \n\n## 🔍 Filters\n\n---\n\nOur API follows the [Query Params specification](https://jsonapi.org/format/#query-parameters) for JSON APIs. With this, you can refine your searches using custom filters to retrieve exactly the data you need.\n\n### ⚙️ How It Work\n\nIn addition to the common key-value usage, advanced filters are composed of three parts:\n\n- **`field`** **(Field):** The attribute you want to filter (e.g., `title`, `duration`, `status`).\n    \n- **`op`** **(Operator):** The comparison operator (e.g., `=`, `!=`, `>`, `<`, `like`, etc.).\n    \n- **`value`** **(Value):** The value to compare against.\n    \n\n**Filter Example:**  \nTo find meetings where the title contains “Meeting” and the duration is greater than 1800 seconds, you can send the following filters:\n\n#### Via Query String:\n\n``` bash\ncurl --location '{{baseUrl}}/calls?filters[0][field]=title&filters[0][op]=like&filters[0][value]=Meeting&filters[1][field]=duration&filters[1][op]=>&filters[1][value]=1800'\n\n ```\n\n#### Or via JSON Body:\n\n``` json\n{\n  \"filters\": [\n    { \"field\": \"title\", \"op\": \"like\", \"value\": \"Meeting\" },\n    { \"field\": \"duration\", \"op\": \">\", \"value\": 1800 }\n  ]\n}\n\n ```\n\n### 🔧 Available Filter Operators\n\nBelow is a table with the operators you can use to build custom filters in your requests:\n\n| Operator | Description | Example Usage (Query Params) |\n| --- | --- | --- |\n| `=` or `==` | Returns records where the field value equals the given value. | `?filters[0][field]=status&filters[0][op]==&filters[0][value]=completed` |\n| `!=` | Returns records where the field value is not equal to the given value. | `?filters[0][field]=status&filters[0][op]=!=&filters[0][value]=canceled` |\n| `:=~` | Performs a partial match search (case-insensitive). | `?filters[0][field]=title&filters[0][op]=:=~&filters[0][value]=demo` |\n| `empty` | Checks if the field is empty or null (boolean). | `?filters[0][field]=notes&filters[0][op]=empty&filters[0][value]=true` |\n| `not_empty` | Checks if the field is not empty. | `?filters[0][field]=notes&filters[0][op]=not_empty&filters[0][value]=true` |\n| `<=` | Returns records where the field is less than or equal to the given value. | `?filters[0][field]=duration&filters[0][op]=<=&filters[0][value]=3600` |\n| `<` | Returns records where the field is less than the given value. | `?filters[0][field]=duration&filters[0][op]=<&filters[0][value]=1800` |\n| `>=` | Returns records where the field is greater than or equal to the given value. | `?filters[0][field]=duration&filters[0][op]=>=&filters[0][value]=3600` |\n| `>` | Returns records where the field is greater than the given value. | `?filters[0][field]=duration&filters[0][op]=>&filters[0][value]=1800` |\n| `in` | Returns records where the field value is within a list of values. | `?filters[0][field]=status&filters[0][op]=in&filters[0][value][]=completed&filters[0][value][]=scheduled` |\n| `not_in` | Returns records where the field value is not within a list of values. | `?filters[0][field]=status&filters[0][op]=not_in&filters[0][value][]=canceled&filters[0][value][]=failed` |\n| `contains` | For array fields: checks if the array contains the specified value. | `?filters[0][field]=tags&filters[0][op]=contains&filters[0][value]=urgent` |\n| `not_contains` | For array fields: checks if the array does not contain the specified value. | `?filters[0][field]=tags&filters[0][op]=not_contains&filters[0][value]=internal` |\n| `like` | Performs a partial match search (case-sensitive). | `?filters[0][field]=title&filters[0][op]=like&filters[0][value]=Meeting` |\n| `not_like` | Returns records that do not match the partial search (case-sensitive). | `?filters[0][field]=title&filters[0][op]=not_like&filters[0][value]=Test` |\n| `like_and` | Splits the string into terms and returns records containing all terms (case-sensitive). | `?filters[0][field]=title&filters[0][op]=like_and&filters[0][value]=Sales+Client` |\n| `like_or` | Splits the string into terms and returns records containing at least one term (case-sensitive). | `?filters[0][field]=title&filters[0][op]=like_or&filters[0][value]=Sales+Marketing` |\n| `ilike` | Performs a partial match search (case-insensitive). | `?filters[0][field]=title&filters[0][op]=ilike&filters[0][value]=meeting` |\n| `not_ilike` | Returns records that do not match the case-insensitive partial search. | `?filters[0][field]=title&filters[0][op]=not_ilike&filters[0][value]=exclusive` |\n| `ilike_and` | Performs a case-insensitive search that splits the string and requires all terms to be present. | `?filters[0][field]=title&filters[0][op]=ilike_and&filters[0][value]=sales+client` |\n| `ilike_or` | Performs a case-insensitive search that splits the string and returns records containing at least one term. | `?filters[0][field]=title&filters[0][op]=ilike_or&filters[0][value]=sales+marketing` |\n\n> **Note**: If no filters are provided (i.e., no field, op, and value), the query returns all available records, applying only pagination and sorting parameters if specified. \n  \n\n## 🔢 Ordering\n\nOur API allows you to control the order in which records are returned. You can specify one or more fields to order by and define the direction (ascending or descending) for each field.\n\n### ⚙️ How It Works\n\n- **`order_by`**:  \n    Specifies the field(s) by which to order the results. You can include multiple fields by repeating this parameter.\n    \n- **`order_directions`**:  \n    Specifies the sorting direction for each corresponding field in `orderBy`. Valid values are:\n    \n    - `asc` for ascending order.\n        \n    - `desc` for descending order.\n        \n\nIf the `order_directions` parameter is omitted or contains fewer values than the number of fields, the missing directions default to ascending order.\n\n### Example\n\nTo order meeting records by `inserted_at` in descending order and then by `title` in ascending order, your query would be:\n\n``` bash\ncurl --location '{{baseUrl}}/calls?order_by[]=inserted_at&order_directions[]=desc&order_by[]=title&order_directions[]=asc'\n\n ```\n\nThis query sorts the records first by `inserted_at` (newest first) and then, for records with identical `inserted_at` values, sorts by `title` in alphabetical order.\n\n### Tips\n\n- **Multiple Fields:** You can specify multiple fields in `order_by` to create compound sorting.\n    \n- **Default Behavior:** If no ordering is provided, the API returns records in the system's default order.\n    \n\nThis ordering mechanism gives you precise control over how data is presented, ensuring that you can retrieve results in the most useful sequence for your application.\n\n## 🔄 Cursor-Based Pagination\n\nOur API uses cursor-based pagination to help you navigate through large sets of results efficiently. Unlike traditional page-based pagination, cursor-based pagination uses a unique marker (cursor) to indicate the position in the result set.\n\n### ⚙️ How It Works\n\n- **Initial Request:**\n    \n\nWhen you make a request without any cursor, the API returns the first set of records along with pagination metadata. This metadata includes a `startCursor` and an `endCursor`.\n\n- **Navigating Forward:**\n    \n\nTo fetch the next set of records, include the `after` parameter in your query with the value of the `endCursor` from your previous response. For example:\n\n``` bash\ncurl --location '{{baseUrl}}/{{version}}/calls?first=10&after=YOUR_END_CURSOR'\n\n ```\n\n- **Parameters Overview:**\n    \n- `first`: The number of records to return starting from the cursor.\n    \n- `after`: The cursor indicating the position after which to return records.\n    \n- `last`: The number of records to return ending at the cursor.\n    \n- `before`: The cursor indicating the position before which to return records.\n    \n\n### Example\n\nAssume your initial request returns:\n\n``` json\n{\n  \"data\": [ /* array of records */ ],\n  \"meta\": {\n    \"page_size\": 10,\n    \"has_next_page\": true,\n    \"has_revious_page\": false,\n    \"start_cursor\": \"cursor_start_value\",\n    \"end_cursor\": \"cursor_end_value\"\n  }\n}\n\n ```\n\nTo fetch the next 10 records, your query would look like:\n\n``` bash\ncurl --location '{{baseUrl}}/{{version}}/calls?first=10&after=cursor_end_value'\n\n ```\n\nTo fetch the previous 10 records, you would use:\n\n``` bash\ncurl --location '{{baseUrl}}/{{version}}/calls?last=10&before=cursor_start_value'\n\n ```\n\nThis mechanism ensures smooth navigation through your data set, even when dealing with large volumes of records.","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":true,"owner":"42704606","team":6809741,"collectionId":"61011ab1-26be-4b00-85fa-9af22fb60ab5","publishedId":"2sAYdmjSjS","public":true,"publicUrl":"https://documenter-api.postman.tech/view/42704606/2sAYdmjSjS","privateUrl":"https://go.postman.co/documentation/42704606-61011ab1-26be-4b00-85fa-9af22fb60ab5","customColor":{"top-bar":"6f2fd8","right-sidebar":"52525b","highlight":"6f2fd8"},"documentationLayout":"classic-single-column","customisation":{"metaTags":[{"name":"description","value":""},{"name":"title","value":"MeetRox API"}],"appearance":{"default":"dark","themes":[{"name":"dark","logo":"https://content.pstmn.io/e2f334ce-0784-4f00-a289-24d1dec0a323/TWFpbiBMb2dvIG1kLnBuZw==","colors":{"top-bar":"0B0516","right-sidebar":"18181b","highlight":"a982e8"}},{"name":"light","logo":"https://content.pstmn.io/d1915571-c7a9-4813-9598-64c8170698d1/TWFpbiBMb2dvIG1kLnBuZw==","colors":{"top-bar":"6f2fd8","right-sidebar":"52525b","highlight":"6f2fd8"}}]}},"version":"8.10.1","publishDate":"2025-03-05T18:28:43.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{"title":"MeetRox API","description":""},"logos":{"logoLight":"https://content.pstmn.io/d1915571-c7a9-4813-9598-64c8170698d1/TWFpbiBMb2dvIG1kLnBuZw==","logoDark":"https://content.pstmn.io/e2f334ce-0784-4f00-a289-24d1dec0a323/TWFpbiBMb2dvIG1kLnBuZw=="}},"statusCode":200},"environments":[{"name":"Beta","id":"58e5153a-fd04-40c3-be53-ea624a08c2bd","owner":"42704606","values":[{"key":"apiKey","value":"","enabled":true,"type":"secret"},{"key":"baseUrl","value":"https://api.meetrox.ai","enabled":true,"type":"default"},{"key":"version","value":"v1","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/97b84b91e813ab87993796cb331537c2338c7568a4ca03b7f4b38674939b8d78","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":"Beta","value":"42704606-58e5153a-fd04-40c3-be53-ea624a08c2bd"}],"canonicalUrl":"https://documenter.gw.postman.com/view/metadata/2sAYdmjSjS"}