{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"d4768090-7b48-4a06-aca9-5bbd4ce1c3ed","name":"Twiglers API Version 1","description":"Welcome to the latest version of the Twiglers API: version/1. All new development should use this version of the API.\n\nAPI version /1 is based on RESTful principles, is secured by OAuth 2.0, and provides JSON messages, search, pagination, sorting, and filtering.\n\n![Alt text](https://i.imgur.com/jVOuGBV.png)\n\nNeed help?\n--------------------\nThe Twiglers engineers are always around answering questions. The quickest way to get help is by emailing your question through [support@twiglers.com](support@twiglers.com).\n\nUsing Query Parameters\n====================\nYou can use the following query parameters when calling the Get Users, Get Companies and Get Vacancies resource APIs.\n\nFields\n--------------------\nWhen you call a resource API, include the fields query parameter to return only the attributes you want to return.\n\nFor example, to return only user email, username, and status values, use the field parameter with this criteria:\n\n'{{domain}}/{{version}}/user?fields=email,username,status'\n\nThe response will return user objects that look like this:\n\n<code>\n{\n    \"data\": [\n        {\n            \"type\": \"user\",\n            \"id\": 10,\n            \"attributes\": {\n\t\t\t\t\"email\": \"test@twiglers.com\",\n\t\t\t\t\"username\": \"test_user\",\n\t\t\t\t\"status\": 1\n\t\t}\n\t]\n}\n</code>\n\n<blockquote>\nNote: The id attribute will always be returned, even if it is not explicitly included as a fields criteria.\n</blockquote>\n\nSearch\n--------------------\nWhen you call a resource API, include a search parameter to return only the results that meet your criteria.\n\nFor example, you can search for a specific attribute value:\n\n`{{domain}}/{{version}}/user?email=test@twiglers.com`\n\nFor more information about the search parameters that are available for resources, see the documentation for the specific API call.\n\nPage Limit and Offset\n--------------------\nWhen you call a resource API, the response message will include a pagination element like the one shown here:\n\n`{{domain}}/{{version}}/user?page[limit]=10&page[offset]=100`\n\nSort\n--------------------\nWhen you call a resource API, include the `sort` query parameter to sort results value.\n\nUse the sort parameter with criteria and `-` to return resources sorted attribute value in descending order. For example:\n\n`{{domain}}/{{version}}/user?sort=-id`\n\nUse a `+` instead of `-` to sort in ascending order. For example:\n\n`{{domain}}/{{version}}/user?sort=+id`\n\nCombining Parameters\n--------------------\nYou can combine use of any of the parameters discussed on this page to create very specific queries. Here are some examples:\n\n`{{domain}}/{{version}}/user?page[limit]=5&fields[user]=name,id&include=company`\n\nPostman Collections\n==================\n\nDownload a Postman Collection that provides all of the calls available for each of our Twiglers resources.\n\nTry it out with a test account first: Start off using a Postman Collection with a test Twiglers account and API credentials.\n\nOnce you’ve familiarized yourself with the API’s behavior, switch over to using your production Twiglers account and API credentials.\n\nSetting Up Postman Environment Variables\n-----------------\nTo use the Postman Collections provided further down this page (and on each individual API doc page), you’ll need to set up environment variables in Postman.\n\nYou’ll use these environment variables to set values that Postman needs to make an API call. Why don’t the Postman Collections include these values as delivered? This is because the values are unique, and even private, to your Twiglers account environment. For example, you’ll create environment variables to provide values for your client ID and secret, data shard, access token, subdomain, and so forth.\n\nSetting up the environment variables requires some upfront work, but will make repeated use of the Postman Collections a lot more convenient.\n\nClient SDKs\n=================\nThe fastest way to get up and running with the Twiglers API is to use one of our open source client SDKs. The SDKs will take care of authentication for you make it easy to call any of the API endpoints.\n\nThe source for each SDK along with installation instructions and sample code is available on Github.\n\nLanguage Support\n------------------\nComing Soon\n\nThird Party Clients\n------------------\nComing Soon\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":false,"owner":"3829931","team":97387,"collectionId":"d4768090-7b48-4a06-aca9-5bbd4ce1c3ed","publishedId":"RVnPJNzp","public":true,"publicUrl":"https://docs.twiglers.com","privateUrl":"https://go.postman.co/documentation/3829931-d4768090-7b48-4a06-aca9-5bbd4ce1c3ed","customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"EF5B25"},"documentationLayout":"classic-double-column","version":"8.10.1","publishDate":"2018-12-10T16:32:52.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{},"logos":{}},"statusCode":200},"environments":[{"name":"Production","id":"c670cc1d-f6dd-4bfe-a993-0058d06f842f","owner":"3829931","values":[{"key":"domain","value":"https://api.twiglers.com","enabled":true},{"key":"version","value":"v1","enabled":true},{"key":"token","value":"token","enabled":true},{"key":"client_id","value":"11_0575c7647fb613967aadabd7b4472ad6838958ab2b0837b4a4","enabled":true},{"key":"client_secret","value":"cab84a444ec2be649370237f100c3ae50ebb9d5e1e9dbffe97","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/98aef039d89f3d57ae60ee6d025fb12177b6bbb2cc57903921d7118bf11fea84","favicon":"https://twiglers.com/favicon.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":"Production","value":"3829931-c670cc1d-f6dd-4bfe-a993-0058d06f842f"}],"canonicalUrl":"https://docs.twiglers.com/view/metadata/RVnPJNzp"}