{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"5b97ee73-30e5-40cf-8873-17b7a110c264","name":"Netcall Liberty Spark API for Personal Usage","description":"Welcome to the documentation of Spark Public API.\n\nFirst of all, please make sure that you've read all the section below (Getting started).\n\n# Getting started\n\n## Create your token\n\n- Log in to Spark and navigate to your account settings (click on your name in the top-right) and go to Integrations\n    \n- Generate a new token by giving a name (typically the purpose for which you need the token) and select the scope of access (\"View and update everything\" if you don't know what to select)\n    \n\n## Test your connection in Postman\n\n- Now that you have a token, in Postman, set the token in the `access_token` variable\n    \n- Go to the \"Get Authenticated User\" request to test\n    \n\n## Required headers\n\n### GET queries JSON response format\n\nSpark supports 2 types of JSON Response\n\n#### JSON:API Responses\n\nLearn about [JSON:API](https://jsonapi.org/)\n\nThis is the standard we use for the Spark application itself. It creates lighter responses. See below.\n\n- Set header to `\"Accept\": \"application/vnd.api+json\"` will output format in JSON:API standard format\n    \n\n#### Plain JSON\n\nSpark also support traditional JSON format output\n\n- Set header to `\"Accept\": \"application/json\"` will ouput format in simple JSON format with nested values.\n    \n\n#### Deserialising the JSON:API responses\n\nThe JSON:API response object is formatted in a very specific and consistent way that is optimized for data transfer. It is not conveniently usable \"as is\" in your application and you would usually use a library to deserialise it in an object that is easier to manipulate.\n\nSee available libraries [https://jsonapi.org/implementations/](https://jsonapi.org/implementations/) here.\n\nFor javascript, at Skore we have selected the [https://www.npmjs.com/package/jsona](https://www.npmjs.com/package/jsona) library.\n\n### POST / UPDATE / PATCH requests\n\nPOST requests are required to send the `Content-Type` header to specify to the server what type of data are you sending.\n\nFor example if your payload is json format, use:\n\n- `\"Content-Type\": \"application/json; charset=UTF-8\"`\n    \n\n## Authentication\n\nWe use **OAuth 2** clients for authenticate users.\n\nSo for most of the endpoints of the API you should add your token\n\n- `\"Authorization\": \"Bearer {your-issued-token-here}\"`\n    \n\n### Scopes\n\nHere's the list of scopes available within Skore's API:\n\n- `view-profile`\n    \n- `edit-profile`\n    \n- `view-workspace-content`\n    \n- `edit-workspace-content`\n    \n- `view-workspace-users`\n    \n- `edit-workspace-users`\n    \n- `view-process-revisions`\n    \n- `edit-process-revisions`\n    \n- `approve-process-revisions`\n    \n\n# Using the API\n\n## Search with Filters\n\n`Filters` are used to search through the resources. See the examples in the various examples.\n\nThe general syntax is `workspaces?filter[name]=abc` : returns all workspaces with \"abc\" in their name.\n\nThe various filters are provided for each resources.\n\n## Add related content with Includes\n\nIn this API it is very convienent to fetch all related pieces of content in 1 single query.\n\nExample : `workspaces?includes=processes.owner` will get all the workspaces, with all their processes and for each process, the process owner.\n\nThe relationships are provided for each resources\n\n## Add attributes with Appends\n\nIn some rare cases, additional attributes can be appended to the resources using the following syntax\n\nExample : `workspaces?appends[workspace]=role` will append the current user's role to the workspace. Examples are provided\n\n## Pagination\n\nAll results are paginated in Skore, which means you will sometimes need to query more page. Study the meta objet\n\n- the parameter `page[size]=100` can be set to get more results per page\n    \n- the parameter `page[number]=2` is used to get the next page of results\n    \n\n# Ready ?\n\n- Find your workspaces?\n    \n    - Go to the `Workspaces / INDEX all workspaces`\n        \n- Find your processes ?\n    \n    - Go to `Processes / INDEX all processes`\n        \n- Download a process and ALL its content (boxes, etc.)\n    \n    - Go to `Processes / SHOW a process and all its content`\n        \n\n---\n\n## Statuses\n\n### Workspace statuses\n\n- Active 1\n    \n- Archived 2\n    \n- Disabled 3\n    \n\n### Process statuses\n\n- Active 1\n    \n- Archived 2\n    \n\n### Process Revision statuses\n\n- Draft 1\n    \n- Awaiting Approval 2\n    \n- Published 3\n    \n- Was Published 4\n    \n\n### Process revision Approval statuses\n\n- Requested 1\n    \n- Canceled 2\n    \n- Rejected 3\n    \n- Confirmed 4","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":false,"owner":"9179336","team":153541,"collectionId":"5b97ee73-30e5-40cf-8873-17b7a110c264","publishedId":"SzS7Nk63","public":true,"publicUrl":"https://documenter-api.postman.tech/view/9179336/SzS7Nk63","privateUrl":"https://go.postman.co/documentation/9179336-5b97ee73-30e5-40cf-8873-17b7a110c264","customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"008B8B"},"documentationLayout":"classic-double-column","version":"8.10.0","publishDate":"2020-03-19T17:24:32.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{},"logos":{}},"statusCode":200},"environments":[{"name":"Liberty Spark Environment Variables","id":"bb3cea44-9ad1-4194-a0c5-3138c724b9b5","owner":"9179336","values":[{"key":"base_url","value":"https://app.getskore.com/api","enabled":true},{"key":"access_token","value":"","enabled":true,"type":"default"},{"key":"workspace_id","value":"1","enabled":true,"type":"default"},{"key":"process_id","value":"1","enabled":true,"type":"default"},{"key":"json_response_type","value":"application/vnd.api+json","enabled":true,"type":"default"},{"key":"client_id","value":"","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/c7de591bf63de9425764523e77b85030ef3ef98ccfc4322762cc60159aa4a9e8","favicon":"https://res.cloudinary.com/postman/image/upload/v1565596747/team/mz27futwqch7hioi7m4q.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":"Liberty Spark Environment Variables","value":"9179336-bb3cea44-9ad1-4194-a0c5-3138c724b9b5"}],"canonicalUrl":"https://documenter.gw.postman.com/view/metadata/SzS7Nk63"}