{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"f23366fa-e5a3-417b-a37c-ee7f402b4088","name":"Workflow Infinity","description":"To use the API, you should create an API key under Advanced > API Keys in your application. Enter your preferred Client ID and the system will generate a Client Secret. Use these details along with your user/employee credentials to generate an access token and use that access token to access each endpoint.\n\nNearly every endpoint accepts some basic parameters via the query string including; `where`, `limit`, `offset` and `order_by` clauses (some knowledge of the underlying database structure is required or the structure can be interrogated via a GET request). In addition, the bespoke endpoint can accept, `select`, `from`, `group_by` and `having` clauses. By default, only a limited number of items are returned but the limit can be unset by setting `limit` to -1. If you are unbounding the limit, it is recommended that other filters are applied to avoid overloading the system.\n\nThe system can accept raw SQL parameters (only if enabled by your system administrator and in a private/protected environment) however under normal circumstances, parameters can be supplied as URL encoded JSON strings (examples below). Aggregate functions `COUNT`, `SUM`, `AVG`, `MIN`, `MAX` are supported in `select`, `having` and `order_by` clauses. The following operators, `=` (equals), `<>` (not equals), `>` (greater than), `<` (less than), `>=` (greater than or equal to), `<=` (less than or equal to) are supported in `where` and `having` clauses and additionally, `where` also supports `LIKE` (like), `NOT LIKE` (not like), `IN` (in a set), `NOT IN` (not in a set). `where` and `order_by` also support `expr` instead of `column` in non-aggregated contexts. The `expr` must specify a type which can be e.g. `coalesce` (allowing a `fallback` value) or `bespoke` (exposing advanced functionality to the API). Example of JSON clauses:\n\n`select`\n\n``` json\n[\n  {\n    \"column\": \"employee_id\"\n  },\n  {\n    \"agg\": \"COUNT\",\n    \"column\": \"work_id\",\n    \"alias\": \"work_count\"\n  }\n]\n\n ```\n\n`where`\n\n``` json\n{\n  \"type\": \"group\",\n  \"logic\": \"AND\",\n  \"conditions\": [\n    {\n      \"column\": \"date_and_time\",\n      \"op\": \">=\",\n      \"value\": \"2026-01-01\"\n    },\n    {\n      \"column\": \"date_and_time\",\n      \"op\": \"<=\",\n      \"value\": \"2026-12-31\"\n    },\n    {\n      \"column\": \"type\",\n      \"op\": \"IN\",\n      \"value\": [\n        1000,\n        8000\n      ]\n    },\n    {\n      \"type\": \"group\",\n      \"logic\": \"OR\",\n      \"conditions\": [\n        {\n          \"expr\": {\n            \"type\": \"coalesce\",\n            \"columns\": [\n              \"status\"\n            ],\n            \"fallback\": 0\n          },\n          \"op\": \">\",\n          \"value\": 0\n        },\n        {\n          \"expr\": {\n            \"type\": \"coalesce\",\n            \"columns\": [\n              \"override_anomaly\"\n            ],\n            \"fallback\": 0\n          },\n          \"op\": \">\",\n          \"value\": 0\n        }\n      ]\n    }\n  ]\n}\n\n ```\n\n`group_by`\n\n```\n[\n  {\n    \"column\": \"employee_id\"\n  }\n]\n\n ```\n\n`having`\n\n```\n[\n  {\n    \"agg\": \"COUNT\",\n    \"column\": \"work_id\",\n    \"op\": \">\",\n    \"value\": 10\n  }\n]\n\n ```\n\n`order_by`\n\n```\n[\n  {\n    \"column\": \"work_count\",\n    \"direction\": \"DESC\"\n  }\n]\n\n ```\n\nPlease note that some endpoints are read-only or only provide data in certain scopes (e.g. user or employee). Where endpoints allow writing data, while input is validated, you should set all appropriate fields, very few are filled automatically by the API.","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":true,"owner":"10079290","team":2201027,"collectionId":"f23366fa-e5a3-417b-a37c-ee7f402b4088","publishedId":"2s9Ykn81xs","public":true,"publicUrl":"https://api.workflowinfinity.com","privateUrl":"https://go.postman.co/documentation/10079290-f23366fa-e5a3-417b-a37c-ee7f402b4088","customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"61B0C7"},"documentationLayout":"classic-double-column","customisation":{"metaTags":[{"name":"description","value":"API documentation for the Workflow Infinity suite of software applications."},{"name":"title","value":""}],"appearance":{"default":"light","themes":[{"name":"dark","logo":null,"colors":{"top-bar":"212121","right-sidebar":"303030","highlight":"61B0C7"}},{"name":"light","logo":null,"colors":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"61B0C7"}}]}},"version":"8.10.1","publishDate":"2023-12-15T21:20:02.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{"title":"","description":"API documentation for the Workflow Infinity suite of software applications."},"logos":{"logoLight":null,"logoDark":null}},"statusCode":200},"environments":[{"name":"Workflow","id":"e13e775d-4040-41ac-a459-ac7c256aa468","owner":"10079290","values":[{"key":"access_token","value":"","enabled":true,"type":"secret"},{"key":"api_url","value":"https://demo.ntprocloud.com/Roster/rest/v1","enabled":true,"type":"default"},{"key":"api_client_secret","value":"","enabled":true,"type":"secret"},{"key":"api_client_id","value":"","enabled":true,"type":"secret"},{"key":"api_username","value":"","enabled":true,"type":"secret"},{"key":"api_password","value":"","enabled":true,"type":"secret"},{"key":"api_scope","value":"","enabled":true,"type":"default"},{"key":"system_url","value":"https://demo.ntprocloud.com/Roster/","enabled":true,"type":"default"},{"key":"fire_username","value":"","enabled":true,"type":"secret"},{"key":"fire_password","value":"","enabled":true,"type":"secret"}],"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/fdc607707862031714470b0bd1191d6b09bf0fa9f96fe95ebf66236441d02b80","favicon":"https://res.cloudinary.com/postman/image/upload/v1626195030/team/rilsc710szt92cwc1isi.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":"Workflow","value":"10079290-e13e775d-4040-41ac-a459-ac7c256aa468"}],"canonicalUrl":"https://api.workflowinfinity.com/view/metadata/2s9Ykn81xs"}