The simplest way to try out Scanifly's API locally is by using Postman. You can import the collection below into your local Postman application and start sending requests. You will need to be set up with an integration account and access token. Please contact your Scanifly Account Executive for more details or email us at [email protected].
{
"info": {
"_postman_id": "4bb43e56-ecae-4478-af8c-a3efda917806",
"name": "Scanifly API",
"description": "Scanifly API Specification",
"schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json",
"_exporter_id": "31016038"
},
"item": [
{
"name": "api/v1",
"item": [
{
"name": "users",
"item": [
{
"name": "{id}",
"item": [
{
"name": "role",
"item": [
{
"name": "Give user admin role",
"request": {
"method": "PATCH",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/users/:id/role/admin?access_token={{accessToken}}",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"users",
":id",
"role",
"admin"
],
"query": [
{
"key": "access_token",
"value": "{{accessToken}}",
"description": "(Required) API Access Token"
}
],
"variable": [
{
"key": "id",
"value": "<string>",
"description": "(Required) "
}
]
}
},
"response": []
},
{
"name": "Give user default role",
"request": {
"method": "PATCH",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/users/:id/role/default?access_token={{accessToken}}",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"users",
":id",
"role",
"default"
],
"query": [
{
"key": "access_token",
"value": "{{accessToken}}",
"description": "(Required) API Access Token"
}
],
"variable": [
{
"key": "id",
"value": "<string>",
"description": "(Required) "
}
]
}
},
"response": []
}
]
},
{
"name": "Delete user",
"request": {
"method": "DELETE",
"header": [],
"url": {
"raw": "{{baseUrl}}/api/v1/users/:id?access_token={{accessToken}}",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"users",
":id"
],
"query": [
{
"key": "access_token",
"value": "{{accessToken}}",
"description": "(Required) API Access Token"
}
],
"variable": [
{
"key": "id",
"value": "<string>",
"description": "(Required) "
}
]
}
},
"response": []
},
{
"name": "get User Image",
"request": {
"method": "GET",
"header": [],
"url": {
"raw": "{{baseUrl}}/api/v1/users/:id/image?access_token={{accessToken}}&token=<string>&base64=<boolean>",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"users",
":id",
"image"
],
"query": [
{
"key": "access_token",
"value": "{{accessToken}}",
"description": "(Required) API Access Token"
},
{
"key": "token",
"value": "<string>",
"description": "(Required) "
},
{
"key": "base64",
"value": "<boolean>",
"description": "(Required) "
}
],
"variable": [
{
"key": "id",
"value": "<string>",
"description": "(Required) "
}
]
}
},
"response": []
},
{
"name": "Update user permissions",
"request": {
"method": "PATCH",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"permissions\": [\n \"<string>\",\n \"<string>\"\n ]\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/users/:id/permissions?access_token={{accessToken}}",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"users",
":id",
"permissions"
],
"query": [
{
"key": "access_token",
"value": "{{accessToken}}",
"description": "(Required) API Access Token"
}
],
"variable": [
{
"key": "id",
"value": "<string>",
"description": "(Required) "
}
]
}
},
"response": []
},
{
"name": "Set folders user is allowed to access",
"request": {
"method": "PATCH",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"folderIds\": \"<object>\"\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/users/:id/access?access_token={{accessToken}}",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"users",
":id",
"access"
],
"query": [
{
"key": "access_token",
"value": "{{accessToken}}",
"description": "(Required) API Access Token"
}
],
"variable": [
{
"key": "id",
"value": "<string>",
"description": "(Required) "
}
]
}
},
"response": []
}
]
},
{
"name": "Get available user positions",
"request": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/users/positions?access_token={{accessToken}}",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"users",
"positions"
],
"query": [
{
"key": "access_token",
"value": "{{accessToken}}",
"description": "(Required) API Access Token"
}
]
}
},
"response": []
},
{
"name": "get User",
"request": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/users/:userId?access_token={{accessToken}}",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"users",
":userId"
],
"query": [
{
"key": "access_token",
"value": "{{accessToken}}",
"description": "(Required) API Access Token"
}
],
"variable": [
{
"key": "userId",
"value": "<string>",
"description": "(Required) "
}
]
}
},
"response": []
}
]
},
{
"name": "folders",
"item": [
{
"name": "{id}",
"item": [
{
"name": "projects",
"item": [
{
"name": "{projectId}",
"item": [
{
"name": "Add project to folder",
"request": {
"method": "POST",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/folders/:id/projects/:projectId?access_token={{accessToken}}",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"folders",
":id",
"projects",
":projectId"
],
"query": [
{
"key": "access_token",
"value": "{{accessToken}}",
"description": "(Required) API Access Token"
}
],
"variable": [
{
"key": "id",
"value": "<string>",
"description": "(Required) "
},
{
"key": "projectId",
"value": "<string>",
"description": "(Required) "
}
]
}
},
"response": []
},
{
"name": "Delete project from folder",
"request": {
"method": "DELETE",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/folders/:id/projects/:projectId?access_token={{accessToken}}",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"folders",
":id",
"projects",
":projectId"
],
"query": [
{
"key": "access_token",
"value": "{{accessToken}}",
"description": "(Required) API Access Token"
}
],
"variable": [
{
"key": "id",
"value": "<string>",
"description": "(Required) "
},
{
"key": "projectId",
"value": "<string>",
"description": "(Required) "
}
]
}
},
"response": []
}
]
},
{
"name": "Add many projects to folder",
"request": {
"method": "PATCH",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"projects\": [\n \"<string>\",\n \"<string>\"\n ]\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/folders/:id/projects/many?access_token={{accessToken}}",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"folders",
":id",
"projects",
"many"
],
"query": [
{
"key": "access_token",
"value": "{{accessToken}}",
"description": "(Required) API Access Token"
}
],
"variable": [
{
"key": "id",
"value": "<string>",
"description": "(Required) "
}
]
}
},
"response": []
}
]
},
{
"name": "Get folder",
"request": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/folders/:id?access_token={{accessToken}}",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"folders",
":id"
],
"query": [
{
"key": "access_token",
"value": "{{accessToken}}",
"description": "(Required) API Access Token"
}
],
"variable": [
{
"key": "id",
"value": "<string>",
"description": "(Required) "
}
]
}
},
"response": []
},
{
"name": "Update folder",
"request": {
"method": "PATCH",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"name\": \"<string>\",\n \"color\": \"<string>\",\n \"projects\": [\n \"<string>\",\n \"<string>\"\n ]\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/folders/:id?access_token={{accessToken}}",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"folders",
":id"
],
"query": [
{
"key": "access_token",
"value": "{{accessToken}}",
"description": "(Required) API Access Token"
}
],
"variable": [
{
"key": "id",
"value": "<string>",
"description": "(Required) "
}
]
}
},
"response": []
},
{
"name": "Delete folder",
"request": {
"method": "DELETE",
"header": [],
"url": {
"raw": "{{baseUrl}}/api/v1/folders/:id?access_token={{accessToken}}",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"folders",
":id"
],
"query": [
{
"key": "access_token",
"value": "{{accessToken}}",
"description": "(Required) API Access Token"
}
],
"variable": [
{
"key": "id",
"value": "<string>",
"description": "(Required) "
}
]
}
},
"response": []
}
]
},
{
"name": "Create a folder",
"request": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"name\": \"<string>\",\n \"color\": \"<string>\"\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/folders?access_token={{accessToken}}",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"folders"
],
"query": [
{
"key": "access_token",
"value": "{{accessToken}}",
"description": "(Required) API Access Token"
}
]
}
},
"response": []
},
{
"name": "Delete many projects from folder",
"request": {
"method": "DELETE",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"projects\": [\n \"<string>\",\n \"<string>\"\n ]\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/folders/projects/many?access_token={{accessToken}}",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"folders",
"projects",
"many"
],
"query": [
{
"key": "access_token",
"value": "{{accessToken}}",
"description": "(Required) API Access Token"
}
]
}
},
"response": []
},
{
"name": "Get all folders for current company",
"request": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/folders/current?access_token={{accessToken}}&sortBy[name]=<string>",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"folders",
"current"
],
"query": [
{
"key": "access_token",
"value": "{{accessToken}}",
"description": "(Required) API Access Token"
},
{
"key": "sortBy[name]",
"value": "<string>"
}
]
}
},
"response": []
}
]
},
{
"name": "companies",
"item": [
{
"name": "current",
"item": [
{
"name": "image",
"item": [
{
"name": "Update company image",
"request": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "multipart/form-data"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "formdata",
"formdata": [
{
"key": "file",
"value": "<binary>",
"description": "(Required) ",
"type": "text"
}
]
},
"url": {
"raw": "{{baseUrl}}/api/v1/companies/current/image?access_token={{accessToken}}",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"companies",
"current",
"image"
],
"query": [
{
"key": "access_token",
"value": "{{accessToken}}",
"description": "(Required) API Access Token"
}
]
}
},
"response": []
},
{
"name": "Get company image",
"request": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/companies/current/image?access_token={{accessToken}}&token=<string>&base64=<boolean>",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"companies",
"current",
"image"
],
"query": [
{
"key": "access_token",
"value": "{{accessToken}}",
"description": "(Required) API Access Token"
},
{
"key": "token",
"value": "<string>",
"description": "(Required) "
},
{
"key": "base64",
"value": "<boolean>",
"description": "(Required) "
}
]
}
},
"response": []
}
]
},
{
"name": "Get current users company",
"request": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/companies/current?access_token={{accessToken}}",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"companies",
"current"
],
"query": [
{
"key": "access_token",
"value": "{{accessToken}}",
"description": "(Required) API Access Token"
}
]
}
},
"response": []
},
{
"name": "Get current users company members",
"request": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/companies/current/members?access_token={{accessToken}}&base64=<boolean>",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"companies",
"current",
"members"
],
"query": [
{
"key": "access_token",
"value": "{{accessToken}}",
"description": "(Required) API Access Token"
},
{
"key": "base64",
"value": "<boolean>",
"description": "(Required) "
}
]
}
},
"response": []
}
]
},
{
"name": "{id}",
"item": [
{
"name": "category",
"item": [
{
"name": "Update company media categories",
"request": {
"method": "PATCH",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"newCategoryName\": \"<string>\"\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/companies/:id/category?access_token={{accessToken}}&categoryName=<string>",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"companies",
":id",
"category"
],
"query": [
{
"key": "access_token",
"value": "{{accessToken}}",
"description": "(Required) API Access Token"
},
{
"key": "categoryName",
"value": "<string>",
"description": "(Required) "
}
],
"variable": [
{
"key": "id",
"value": "<string>",
"description": "(Required) "
}
]
}
},
"response": []
},
{
"name": "Delete company media category",
"request": {
"method": "DELETE",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/companies/:id/category?access_token={{accessToken}}&categoryName=<string>",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"companies",
":id",
"category"
],
"query": [
{
"key": "access_token",
"value": "{{accessToken}}",
"description": "(Required) API Access Token"
},
{
"key": "categoryName",
"value": "<string>",
"description": "(Required) "
}
],
"variable": [
{
"key": "id",
"value": "<string>",
"description": "(Required) "
}
]
}
},
"response": []
},
{
"name": "Create company media category",
"request": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"categoryName\": \"<string>\"\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/companies/:id/category?access_token={{accessToken}}",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"companies",
":id",
"category"
],
"query": [
{
"key": "access_token",
"value": "{{accessToken}}",
"description": "(Required) API Access Token"
}
],
"variable": [
{
"key": "id",
"value": "<string>",
"description": "(Required) "
}
]
}
},
"response": []
}
]
}
]
}
]
},
{
"name": "module-library",
"item": [
{
"name": "{userId}",
"item": [
{
"name": "Read users module library",
"request": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/module-library/:userId?access_token={{accessToken}}",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"module-library",
":userId"
],
"query": [
{
"key": "access_token",
"value": "{{accessToken}}",
"description": "(Required) API Access Token"
}
],
"variable": [
{
"key": "userId",
"value": "<string>",
"description": "(Required) "
}
]
}
},
"response": []
},
{
"name": "Update a users module library",
"request": {
"method": "PUT",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"modules\": \"<object>\"\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/module-library/:userId?access_token={{accessToken}}",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"module-library",
":userId"
],
"query": [
{
"key": "access_token",
"value": "{{accessToken}}",
"description": "(Required) API Access Token"
}
],
"variable": [
{
"key": "userId",
"value": "<string>",
"description": "(Required) "
}
]
}
},
"response": []
}
]
},
{
"name": "Read company module library",
"request": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/module-library/combined/:projectUserId?access_token={{accessToken}}",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"module-library",
"combined",
":projectUserId"
],
"query": [
{
"key": "access_token",
"value": "{{accessToken}}",
"description": "(Required) API Access Token"
}
],
"variable": [
{
"key": "projectUserId",
"value": "<string>",
"description": "(Required) "
}
]
}
},
"response": []
}
]
},
{
"name": "checklist",
"item": [
{
"name": "{projectId}",
"item": [
{
"name": "{checklistId}",
"item": [
{
"name": "Get checklist by id",
"request": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/checklist/:projectId/:checklistId?access_token={{accessToken}}",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"checklist",
":projectId",
":checklistId"
],
"query": [
{
"key": "access_token",
"value": "{{accessToken}}",
"description": "(Required) API Access Token"
}
],
"variable": [
{
"key": "projectId",
"value": "<string>",
"description": "(Required) "
},
{
"key": "checklistId",
"value": "<string>",
"description": "(Required) "
}
]
}
},
"response": []
},
{
"name": "Update checklist by id",
"request": {
"method": "PUT",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"title\": \"<string>\",\n \"status\": \"<string>\",\n \"submittedResponse\": [\n {\n \"id\": \"<string>\",\n \"title\": \"<string>\",\n \"components\": [\n \"<object>\",\n \"<object>\"\n ]\n },\n {\n \"id\": \"<string>\",\n \"title\": \"<string>\",\n \"components\": [\n \"<object>\",\n \"<object>\"\n ]\n }\n ],\n \"id\": \"<string>\",\n \"project\": {\n \"id\": \"<string>\",\n \"name\": \"<string>\"\n },\n \"template\": {\n \"id\": \"<string>\",\n \"name\": \"<string>\"\n },\n \"createdBy\": {\n \"id\": \"<string>\",\n \"firstName\": \"<string>\",\n \"lastName\": \"<string>\"\n },\n \"createdAt\": \"<dateTime>\",\n \"updatedAt\": \"<dateTime>\",\n \"generatedPdf\": \"<string>\",\n \"requiredProgress\": {\n \"totalRequiredFields\": \"<number>\",\n \"completedRequiredFields\": \"<number>\"\n },\n \"totalProgress\": {\n \"totalFields\": \"<number>\",\n \"completedFields\": \"<number>\"\n }\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/checklist/:projectId/:checklistId?access_token={{accessToken}}",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"checklist",
":projectId",
":checklistId"
],
"query": [
{
"key": "access_token",
"value": "{{accessToken}}",
"description": "(Required) API Access Token"
}
],
"variable": [
{
"key": "projectId",
"value": "<string>",
"description": "(Required) "
},
{
"key": "checklistId",
"value": "<string>",
"description": "(Required) "
}
]
}
},
"response": []
},
{
"name": "Set checklist status by id",
"request": {
"method": "PUT",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"status\": \"<string>\"\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/checklist/:projectId/:checklistId/status?access_token={{accessToken}}",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"checklist",
":projectId",
":checklistId",
"status"
],
"query": [
{
"key": "access_token",
"value": "{{accessToken}}",
"description": "(Required) API Access Token"
}
],
"variable": [
{
"key": "projectId",
"value": "<string>",
"description": "(Required) "
},
{
"key": "checklistId",
"value": "<string>",
"description": "(Required) "
}
]
}
},
"response": []
}
]
},
{
"name": "Get checklists by project id",
"request": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/checklist/:projectId?access_token={{accessToken}}",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"checklist",
":projectId"
],
"query": [
{
"key": "access_token",
"value": "{{accessToken}}",
"description": "(Required) API Access Token"
}
],
"variable": [
{
"key": "projectId",
"value": "<string>",
"description": "(Required) "
}
]
}
},
"response": []
}
]
},
{
"name": "Create a new checklist",
"request": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"submittedResponse\": [\n {\n \"id\": \"<string>\",\n \"title\": \"<string>\",\n \"components\": [\n \"<object>\",\n \"<object>\"\n ]\n },\n {\n \"id\": \"<string>\",\n \"title\": \"<string>\",\n \"components\": [\n \"<object>\",\n \"<object>\"\n ]\n }\n ],\n \"project\": {\n \"id\": \"<string>\",\n \"name\": \"<string>\"\n },\n \"template\": {\n \"id\": \"<string>\",\n \"name\": \"<string>\"\n },\n \"title\": \"<string>\",\n \"status\": \"<string>\",\n \"generatedPdf\": \"<string>\",\n \"requiredProgress\": {\n \"totalRequiredFields\": \"<number>\",\n \"completedRequiredFields\": \"<number>\"\n },\n \"totalProgress\": {\n \"totalFields\": \"<number>\",\n \"completedFields\": \"<number>\"\n }\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/checklist/create?access_token={{accessToken}}",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"checklist",
"create"
],
"query": [
{
"key": "access_token",
"value": "{{accessToken}}",
"description": "(Required) API Access Token"
}
]
}
},
"response": []
}
]
},
{
"name": "checklist-template",
"item": [
{
"name": "{templateId}",
"item": [
{
"name": "Get checklist template by id",
"request": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/checklist-template/:templateId?access_token={{accessToken}}",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"checklist-template",
":templateId"
],
"query": [
{
"key": "access_token",
"value": "{{accessToken}}",
"description": "(Required) API Access Token"
}
],
"variable": [
{
"key": "templateId",
"value": "<string>",
"description": "(Required) "
}
]
}
},
"response": []
},
{
"name": "Update a checklist template",
"request": {
"method": "PUT",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"title\": \"<string>\",\n \"checklistStructure\": [\n {\n \"id\": \"<string>\",\n \"title\": \"<string>\",\n \"components\": [\n \"<object>\",\n \"<object>\"\n ]\n },\n {\n \"id\": \"<string>\",\n \"title\": \"<string>\",\n \"components\": [\n \"<object>\",\n \"<object>\"\n ]\n }\n ],\n \"id\": \"<string>\",\n \"createdAt\": \"<dateTime>\",\n \"updatedAt\": \"<dateTime>\",\n \"companyId\": \"<string>\",\n \"type\": \"<string>\"\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/checklist-template/:templateId?access_token={{accessToken}}",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"checklist-template",
":templateId"
],
"query": [
{
"key": "access_token",
"value": "{{accessToken}}",
"description": "(Required) API Access Token"
}
],
"variable": [
{
"key": "templateId",
"value": "<string>",
"description": "(Required) "
}
]
}
},
"response": []
},
{
"name": "Delete a checklist template",
"request": {
"method": "DELETE",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/checklist-template/:templateId?access_token={{accessToken}}",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"checklist-template",
":templateId"
],
"query": [
{
"key": "access_token",
"value": "{{accessToken}}",
"description": "(Required) API Access Token"
}
],
"variable": [
{
"key": "templateId",
"value": "<string>",
"description": "(Required) "
}
]
}
},
"response": []
}
]
},
{
"name": "Get checklist templates",
"request": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/checklist-template?access_token={{accessToken}}&companyId=<string>",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"checklist-template"
],
"query": [
{
"key": "access_token",
"value": "{{accessToken}}",
"description": "(Required) API Access Token"
},
{
"key": "companyId",
"value": "<string>",
"description": "(Required) "
}
]
}
},
"response": []
},
{
"name": "Create a new checklist template",
"request": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"title\": \"<string>\",\n \"type\": \"<string>\",\n \"checklistStructure\": [\n {\n \"id\": \"<string>\",\n \"title\": \"<string>\",\n \"components\": [\n \"<object>\",\n \"<object>\"\n ]\n },\n {\n \"id\": \"<string>\",\n \"title\": \"<string>\",\n \"components\": [\n \"<object>\",\n \"<object>\"\n ]\n }\n ]\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/checklist-template/create?access_token={{accessToken}}&companyId=<string>",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"checklist-template",
"create"
],
"query": [
{
"key": "access_token",
"value": "{{accessToken}}",
"description": "(Required) API Access Token"
},
{
"key": "companyId",
"value": "<string>",
"description": "(Required) "
}
]
}
},
"response": []
}
]
},
{
"name": "boundaries",
"item": [
{
"name": "{id}",
"item": [
{
"name": "Get boundary",
"request": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/boundaries/:id?access_token={{accessToken}}",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"boundaries",
":id"
],
"query": [
{
"key": "access_token",
"value": "{{accessToken}}",
"description": "(Required) API Access Token"
}
],
"variable": [
{
"key": "id",
"value": "<string>",
"description": "(Required) "
}
]
}
},
"response": []
},
{
"name": "Update boundary",
"request": {
"method": "PATCH",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"area\": \"<number>\",\n \"center\": {\n \"lng\": \"<number>\",\n \"lat\": \"<number>\"\n },\n \"corners\": [\n {\n \"lng\": \"<number>\",\n \"lat\": \"<number>\"\n },\n {\n \"lng\": \"<number>\",\n \"lat\": \"<number>\"\n }\n ],\n \"heading\": \"<number>\",\n \"height\": \"<number>\",\n \"width\": \"<number>\"\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/boundaries/:id?access_token={{accessToken}}",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"boundaries",
":id"
],
"query": [
{
"key": "access_token",
"value": "{{accessToken}}",
"description": "(Required) API Access Token"
}
],
"variable": [
{
"key": "id",
"value": "<string>",
"description": "(Required) "
}
]
}
},
"response": []
},
{
"name": "Delete boundary",
"request": {
"method": "DELETE",
"header": [],
"url": {
"raw": "{{baseUrl}}/api/v1/boundaries/:id?access_token={{accessToken}}",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"boundaries",
":id"
],
"query": [
{
"key": "access_token",
"value": "{{accessToken}}",
"description": "(Required) API Access Token"
}
],
"variable": [
{
"key": "id",
"value": "<string>",
"description": "(Required) "
}
]
}
},
"response": []
}
]
},
{
"name": "Create a new boundary",
"request": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"projectId\": \"<object>\",\n \"boundingBox\": {\n \"area\": \"<number>\",\n \"center\": {\n \"lng\": \"<number>\",\n \"lat\": \"<number>\"\n },\n \"corners\": [\n {\n \"lng\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n },\n \"lat\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n }\n },\n {\n \"lng\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n },\n \"lat\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n }\n }\n ],\n \"heading\": \"<number>\",\n \"height\": \"<number>\",\n \"width\": \"<number>\"\n },\n \"updateProjectType\": \"<boolean>\"\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/boundaries?access_token={{accessToken}}",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"boundaries"
],
"query": [
{
"key": "access_token",
"value": "{{accessToken}}",
"description": "(Required) API Access Token"
}
]
}
},
"response": []
},
{
"name": "Get boundary by project id",
"request": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/boundaries/project/:projectId?access_token={{accessToken}}",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"boundaries",
"project",
":projectId"
],
"query": [
{
"key": "access_token",
"value": "{{accessToken}}",
"description": "(Required) API Access Token"
}
],
"variable": [
{
"key": "projectId",
"value": "<string>",
"description": "(Required) "
}
]
}
},
"response": []
}
]
},
{
"name": "designs",
"item": [
{
"name": "{projectId}",
"item": [
{
"name": "{designId}",
"item": [
{
"name": "Delete design",
"request": {
"method": "DELETE",
"header": [],
"url": {
"raw": "{{baseUrl}}/api/v1/designs/:projectId/:designId?access_token={{accessToken}}",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"designs",
":projectId",
":designId"
],
"query": [
{
"key": "access_token",
"value": "{{accessToken}}",
"description": "(Required) API Access Token"
}
],
"variable": [
{
"key": "projectId",
"value": "<string>",
"description": "(Required) "
},
{
"key": "designId",
"value": "<string>",
"description": "(Required) "
}
]
}
},
"response": []
},
{
"name": "Duplicate design on project id",
"request": {
"method": "POST",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/designs/:projectId/:designId/duplicate?access_token={{accessToken}}",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"designs",
":projectId",
":designId",
"duplicate"
],
"query": [
{
"key": "access_token",
"value": "{{accessToken}}",
"description": "(Required) API Access Token"
}
],
"variable": [
{
"key": "projectId",
"value": "<string>",
"description": "(Required) "
},
{
"key": "designId",
"value": "<string>",
"description": "(Required) "
}
]
}
},
"response": []
}
]
},
{
"name": "Get designs by project id",
"request": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/designs/:projectId?access_token={{accessToken}}",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"designs",
":projectId"
],
"query": [
{
"key": "access_token",
"value": "{{accessToken}}",
"description": "(Required) API Access Token"
}
],
"variable": [
{
"key": "projectId",
"value": "<string>",
"description": "(Required) "
}
]
}
},
"response": []
},
{
"name": "Create design on project id",
"request": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"projectId\": \"<object>\",\n \"name\": \"<string>\",\n \"companyId\": \"<object>\",\n \"remote\": \"<boolean>\",\n \"shareLinkUrl\": \"<object>\",\n \"systemSize\": \"<number>\",\n \"ASA\": \"<number>\",\n \"TOF\": \"<number>\",\n \"TSRF\": \"<number>\",\n \"annualProduction\": \"<number>\",\n \"annualConsumption\": \"<number>\",\n \"offset\": \"<number>\",\n \"shadingGraphUrl\": \"<object>\",\n \"productionGraphUrl\": \"<object>\",\n \"thumbnailUrl\": \"<object>\",\n \"shadeReportUrl\": \"<object>\",\n \"horizonProfileUrl\": \"<object>\",\n \"hourlyProductionUrl\": \"<object>\",\n \"stlSurfaceModelUrl\": \"<object>\",\n \"objSurfaceModelUrl\": \"<object>\",\n \"daeSurfaceModelUrl\": \"<object>\",\n \"dxfParallelProjectionsAllPlanesUrl\": \"<object>\",\n \"dxf2DWireframeUrl\": \"<object>\",\n \"dxf3DWireframeUrl\": \"<object>\",\n \"dxfCombinedUrl\": \"<object>\",\n \"projectInfoUrl\": \"<object>\"\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/designs/:projectId?access_token={{accessToken}}",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"designs",
":projectId"
],
"query": [
{
"key": "access_token",
"value": "{{accessToken}}",
"description": "(Required) API Access Token"
}
],
"variable": [
{
"key": "projectId",
"value": "<string>",
"description": "(Required) "
}
]
}
},
"response": []
}
]
},
{
"name": "List project designs",
"request": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/designs?access_token={{accessToken}}&pageIndex=<number>&size=<number>&filterBy[name]=<string>&filterBy[status]=<string>&filterBy[createdAt][gte]=<dateTime>&filterBy[createdAt][lte]=<dateTime>&filterBy[createdAt][eq]=<dateTime>&filterBy[updatedAt][gte]=<dateTime>&filterBy[updatedAt][lte]=<dateTime>&filterBy[updatedAt][eq]=<dateTime>&sortBy[name]=<string>&sortBy[createdAt]=<string>&sortBy[updatedAt]=<string>",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"designs"
],
"query": [
{
"key": "access_token",
"value": "{{accessToken}}",
"description": "(Required) API Access Token"
},
{
"key": "pageIndex",
"value": "<number>"
},
{
"key": "size",
"value": "<number>",
"description": "Max value is 150"
},
{
"key": "filterBy[name]",
"value": "<string>"
},
{
"key": "filterBy[status]",
"value": "<string>"
},
{
"key": "filterBy[createdAt][gte]",
"value": "<dateTime>"
},
{
"key": "filterBy[createdAt][lte]",
"value": "<dateTime>"
},
{
"key": "filterBy[createdAt][eq]",
"value": "<dateTime>"
},
{
"key": "filterBy[updatedAt][gte]",
"value": "<dateTime>"
},
{
"key": "filterBy[updatedAt][lte]",
"value": "<dateTime>"
},
{
"key": "filterBy[updatedAt][eq]",
"value": "<dateTime>"
},
{
"key": "sortBy[name]",
"value": "<string>"
},
{
"key": "sortBy[createdAt]",
"value": "<string>"
},
{
"key": "sortBy[updatedAt]",
"value": "<string>"
}
]
}
},
"response": []
}
]
},
{
"name": "projects",
"item": [
{
"name": "Create project",
"request": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"name\": \"<string>\",\n \"address\": \"<string>\",\n \"geolocation\": {\n \"latitude\": \"<number>\",\n \"longitude\": \"<number>\"\n },\n \"ownerDetails\": {\n \"firstName\": \"<string>\",\n \"lastName\": \"<string>\",\n \"email\": \"<string>\",\n \"phone\": \"<string>\"\n },\n \"kwh\": \"<object>\",\n \"externalMetadata\": \"<object>\"\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/projects?access_token={{accessToken}}",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"projects"
],
"query": [
{
"key": "access_token",
"value": "{{accessToken}}",
"description": "(Required) API Access Token"
}
]
}
},
"response": []
},
{
"name": "List projects",
"request": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/projects?access_token={{accessToken}}&pageIndex=<number>&size=<number>&filterBy[id]=<string>&filterBy[name]=<string>&filterBy[folderName]=<string>&filterBy[address]=<string>&filterBy[status]=<string>&filterBy[statusDescription]=<string>&filterBy[type]=<string>&filterBy[searchText]=<string>&filterBy[latitude][gte]=<number>&filterBy[latitude][lte]=<number>&filterBy[longitude][gte]=<number>&filterBy[longitude][lte]=<number>&filterBy[createdAt][gte]=<dateTime>&filterBy[createdAt][lte]=<dateTime>&filterBy[createdAt][eq]=<dateTime>&filterBy[completedDate][gte]=<dateTime>&filterBy[completedDate][lte]=<dateTime>&filterBy[completedDate][eq]=<dateTime>&filterBy[updatedAt][gte]=<dateTime>&filterBy[updatedAt][lte]=<dateTime>&filterBy[updatedAt][eq]=<dateTime>&sortBy[name]=<string>&sortBy[createdAt]=<string>&sortBy[completedDate]=<string>&sortBy[updatedAt]=<string>&sortBy[latitude]=<string>&sortBy[longitude]=<string>",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"projects"
],
"query": [
{
"key": "access_token",
"value": "{{accessToken}}",
"description": "(Required) API Access Token"
},
{
"key": "pageIndex",
"value": "<number>"
},
{
"key": "size",
"value": "<number>",
"description": "Max value is 150"
},
{
"key": "filterBy[id]",
"value": "<string>"
},
{
"key": "filterBy[name]",
"value": "<string>"
},
{
"key": "filterBy[folderName]",
"value": "<string>"
},
{
"key": "filterBy[address]",
"value": "<string>"
},
{
"key": "filterBy[status]",
"value": "<string>"
},
{
"key": "filterBy[statusDescription]",
"value": "<string>"
},
{
"key": "filterBy[type]",
"value": "<string>"
},
{
"key": "filterBy[searchText]",
"value": "<string>"
},
{
"key": "filterBy[latitude][gte]",
"value": "<number>"
},
{
"key": "filterBy[latitude][lte]",
"value": "<number>"
},
{
"key": "filterBy[longitude][gte]",
"value": "<number>"
},
{
"key": "filterBy[longitude][lte]",
"value": "<number>"
},
{
"key": "filterBy[createdAt][gte]",
"value": "<dateTime>"
},
{
"key": "filterBy[createdAt][lte]",
"value": "<dateTime>"
},
{
"key": "filterBy[createdAt][eq]",
"value": "<dateTime>"
},
{
"key": "filterBy[completedDate][gte]",
"value": "<dateTime>"
},
{
"key": "filterBy[completedDate][lte]",
"value": "<dateTime>"
},
{
"key": "filterBy[completedDate][eq]",
"value": "<dateTime>"
},
{
"key": "filterBy[updatedAt][gte]",
"value": "<dateTime>"
},
{
"key": "filterBy[updatedAt][lte]",
"value": "<dateTime>"
},
{
"key": "filterBy[updatedAt][eq]",
"value": "<dateTime>"
},
{
"key": "sortBy[name]",
"value": "<string>"
},
{
"key": "sortBy[createdAt]",
"value": "<string>"
},
{
"key": "sortBy[completedDate]",
"value": "<string>"
},
{
"key": "sortBy[updatedAt]",
"value": "<string>"
},
{
"key": "sortBy[latitude]",
"value": "<string>"
},
{
"key": "sortBy[longitude]",
"value": "<string>"
}
]
}
},
"response": []
},
{
"name": "Get project by id",
"request": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/projects/:projectId?access_token={{accessToken}}",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"projects",
":projectId"
],
"query": [
{
"key": "access_token",
"value": "{{accessToken}}",
"description": "(Required) API Access Token"
}
],
"variable": [
{
"key": "projectId",
"value": "<string>",
"description": "(Required) "
}
]
}
},
"response": []
},
{
"name": "Update project",
"request": {
"method": "PATCH",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"name\": \"<string>\",\n \"address\": \"<string>\",\n \"geolocation\": {\n \"latitude\": \"<number>\",\n \"longitude\": \"<number>\"\n },\n \"ownerDetails\": {\n \"firstName\": \"<string>\",\n \"lastName\": \"<string>\",\n \"email\": \"<string>\",\n \"phone\": \"<string>\"\n },\n \"kwh\": \"<object>\",\n \"externalMetadata\": \"<object>\"\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/projects/:id?access_token={{accessToken}}",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"projects",
":id"
],
"query": [
{
"key": "access_token",
"value": "{{accessToken}}",
"description": "(Required) API Access Token"
}
],
"variable": [
{
"key": "id",
"value": "<string>",
"description": "(Required) "
}
]
}
},
"response": []
}
]
},
{
"name": "media",
"item": [
{
"name": "Get Media by Category id",
"request": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/media/:projectId/:categoryId?access_token={{accessToken}}",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"media",
":projectId",
":categoryId"
],
"query": [
{
"key": "access_token",
"value": "{{accessToken}}",
"description": "(Required) API Access Token"
}
],
"variable": [
{
"key": "projectId",
"value": "<string>",
"description": "(Required) "
},
{
"key": "categoryId",
"value": "<string>",
"description": "(Required) "
}
]
}
},
"response": []
},
{
"name": "Get Media by id",
"request": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/media/:projectId/:categoryId/:id?access_token={{accessToken}}",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"media",
":projectId",
":categoryId",
":id"
],
"query": [
{
"key": "access_token",
"value": "{{accessToken}}",
"description": "(Required) API Access Token"
}
],
"variable": [
{
"key": "projectId",
"value": "<string>",
"description": "(Required) "
},
{
"key": "categoryId",
"value": "<string>",
"description": "(Required) "
},
{
"key": "id",
"value": "<string>",
"description": "(Required) "
}
]
}
},
"response": []
}
]
},
{
"name": "media-categories",
"item": [
{
"name": "Get Media Categories for a project",
"request": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/media-categories/:projectId?access_token={{accessToken}}",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"media-categories",
":projectId"
],
"query": [
{
"key": "access_token",
"value": "{{accessToken}}",
"description": "(Required) API Access Token"
}
],
"variable": [
{
"key": "projectId",
"value": "<string>",
"description": "(Required) "
}
]
}
},
"response": []
}
]
}
]
}
],
"variable": [
{
"key": "baseUrl",
"value": "/",
"type": "string"
}
]
}
{
"name": "Scanifly Prod",
"values": [
{
"key": "baseUrl",
"value": "https://api.portal.scanifly.com",
"type": "default",
"enabled": true
},
{
"key": "accessToken",
"value": "your-access-token-here",
"type": "default",
"enabled": true
}
],
"_postman_variable_scope": "environment"
}