{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"d5e37e02-85c9-4706-b615-6e97ec52f19e","name":"MY Compliance Management API","description":"## Usage\n\nBefore using the MY Compliance API it is required that your account be authorised to use it. If your account is not currently authorised you will need to contact your Customer Support Manager and request this be done.\n\nOnce your account is authorised to use the API you will need to generate an API key.  \nThis can be done within the MY Compliance portal by going to Account > Options > Manage API Keys.\n\nIf using this collection you will need to add the newly generated API Key as the `Bearer` variable within the collection settings\n\n## Rate Limits\n\nEach API Key has rate limit of 60 requests per minute. In addition to this each account has a global rate limit of 120 requests per minute.  \nIf your application exceeds any of these you will receive a 429 response code with an error stating if the key or account rate limit has been exceeded.\n\nIf you find yourself exceeding the rate limit on a regular basis you will need to implement throttling within your application.\n\n#### Tracking Rate limit\n\nEach Request to the API will return header fields to help you track your usage in relation to the rate limit.  \nThese are as follows\n\n- `RateLimit-Limit` - This is the amount of requests your api key can make per minute\n    \n- `RateLimit-Remaining` - This is how many request you have left in the current minute\n    \n- `RateLimit-Reset` - This is how long (in seconds) you have until the rate limit resets\n    \n\n- `RateLimit-Account-Limit` - This is the amount of requests your account can make per minute\n    \n- `RateLimit-Account-Remaining` - This is how many request your account has left in the current minute\n    \n- `RateLimit-Account-Reset` - This is how long (in seconds) you have until the rate limit resets for your account\n    \n\n## Request Parameters\n\nAll index routes support a series of query parameters. These allow you to filter and customise the way in which the API will return data to your application. All request query parameters are optional\n\n| Parameter | Description |\n| --- | --- |\n| pageSize | The `pageSize` query parameter allows you to specify the page size of the results the API will return up to a maximum of 100 resources per page |\n| page | The `page` query parameter allows you to specify the page of results you would like from the API. In the event that an invalid page number is provided the API will return a 400 status code stating why it is invalid |\n| orderBy | The `orderBy` query parameter allows you to specify a field by which to order the results by, If no orderBy query parameter is provided the API will automatically order the results by `id` |\n| orderDirection | The `orderDirection` query parameter allows you to specify a direction in which to order your data by. There are only 2 possible values for this Ascending `asc` or Descending `desc` |\n\n## Filters\n\nFilters allow you to filter the data you retrieve from the API  \nThe MY Compliance API allows you to filter by any property within a resource apart from those returned as relationships.\n\nfor example if you wanted to filter by reference numbers bigger than 10 you would add the following filter.\n\n`/actions?filter=reference gt 10`\n\nYou can also filter by dates using the `gt` and `lt` operators this allows us to filter for resources in a date range like so  \n`/actions?filter=due_date gt datetime'2020-12-15T08:46:40' AND due_date lt datetime'2022-12-15T08:46:40'`\n\nThe format of date filters is very important so please take care to make sure you use the same format. Filters that do not comply will be ignored by the API\n\n##### Filter structure\n\nFilters are structured in 3 segments.\n\n1. The property you would like to filter by\n    \n2. The comparison operation you would like to use (You can see the available operators below)\n    \n3. The value are comparing to\n    \n\n##### Comparison Operators\n\n| Operator | Description |\n| --- | --- |\n| eq | Check if the values are equal |\n| ne | Check if the values are not equal |\n| gt | Check if the property value is greater than the specified value |\n| lt | Check if the property value is less than the specified value |","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":false,"owner":"13654287","collectionId":"d5e37e02-85c9-4706-b615-6e97ec52f19e","publishedId":"UV5dcE3v","public":true,"publicUrl":"https://documenter-api.postman.tech/view/13654287/UV5dcE3v","privateUrl":"https://go.postman.co/documentation/13654287-d5e37e02-85c9-4706-b615-6e97ec52f19e","customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"EF5B25"},"documentationLayout":"classic-double-column","customisation":null,"version":"8.10.0","publishDate":"2022-05-03T14:40:46.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{},"logos":{}},"statusCode":200},"environments":[],"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/dcabb1360917529b81bd8a6bfc7b343f75b4164a1720b63cfbb72419affa1d5f","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"}],"canonicalUrl":"https://documenter.gw.postman.com/view/metadata/UV5dcE3v"}