{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"6b6f6f82-6e96-4ba7-b84c-a626a8e14f7d","name":"Public API","description":"### Servers\nWhen making requests to the API, the API url should be assembled with the companies subdomain in the URL. Companies pick their subdomain when signing up and it's the URL of their dashboard. For example, if the companies subdomain is `testcompany` (dashboard url being `https://testcompany.liverydesk.com`), the API url would be:\n\nProduction: `https://testcompany.liverydesk.com/api`\nStaging: `https://testcompany.staging.liverydesk.com/api` \n**Only specific companies have staging URL's**\n\nIn the case where we don't have access to a companies subdomain to assemble the API URL, calls can be made to the following generic URL's:\n\nProduction: `https://api.liverydesk.com/api`\nStaging Server: `https://staging.liverydesk.com/api`\n\n\n\n### Making Requests\nThe API accepts data as `form-data` or `JSON`. For JSON, make sure the `Content-Type` is `application/json`. \n\nWhen making requests to Guest endpoints, you'll need to pass the API Key in your headers as `X-API-KEY`. \nOnce authenticated, you'll need to pass the access token in your headers as `X-ACCESS-TOKEN`.\nIt's OK to pass both if these at all times if they're both available.\n\n\n### Response Envelope:\nAll responses are wrapped in a specific envelope which contains a `data` and `meta` object. The `data` object will always contain the data for that endpoint and `meta` will contain additinal details about the data returned. \n\nThis API uses two different layers for response codes. It will always return HTTP Status 200 if the request to the server was successful on a network level. To determine if the request was successfull on the application level, use the code returned in the `meta` object.\n    \n    {\n        \"data\":{\n            \"user_id\": 1,\n            \"hash\": \"dfa324d\",\n            \"email\": \"ashwinnn+user@gmail.com\",\n            \"first_name\": \"ashwin\",\n            \"last_name\": \"surge\",\n            \"_type\": \"user\"\n        },\n        \"meta\": {\n            \"paging\": {\n                previous: \"\",\n                next: \"\"\n            },\n            \"code\": 201,\n            \"code_description\": \"Created\",\n            \"items\": 0\n        }   \n    }\n    \nMultiple result sets will be wrapped in an array. If the endpoint supports paging, there will be a `paging` object inside `meta`.\n    \n    {\n        \"data\": [\n            {\n                \"id\": \"1\",\n                ...\n            },\n            {\n                \"id\": \"2\",\n                ...\n            },\n            {\n                \"id\": \"3\",\n                ...\n            },\n        ],\n        \"meta\": {\n            \"code\": 200,\n            \"items\": 3\n        }\n    }    \n\nIf there is an error, there will not be a \"data\" object in the response envelope. There will be an \"error\" object instead.\n\n    {\n        \"error\": {\n            \"message\": \"Incorrect password\"\n        }\n    }\n    \n    \n### Pagination\nPagination can be applied to `GET` requests. The API respects the following pagination modifiers: `_page` and `_limit`. `_limit` is the amount of results per page and is defaulted to 25. The total amount of found records is the `total_results` attribute. `previous` and `next` are API links to get more records. `page` respresents the current page of data. `total_pages` is the total amount of pages which is just `total_results`/`limit`.\n\nThe paging metadata is on the `paging` attribute on the `meta` object.\n\n\n  meta: {\n      \"paging\": {\n        \"per_page\": 25,\n        \"total_pages\": 2,\n        \"page\": 1,\n        \"total_results\": 46,\n        \"previous\": null,\n        \"next\": \"http://127.0.0.1/1/activity?_page=2\"\n      },\n      \"code\": 200,\n      \"code_description\": \"Ok\",\n      \"items\": 25\n    }","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":false,"owner":"8109188","collectionId":"6b6f6f82-6e96-4ba7-b84c-a626a8e14f7d","publishedId":"2s8YeoNDE9","public":true,"publicUrl":"https://docs.dispatch.weedmaps.com","privateUrl":"https://go.postman.co/documentation/8109188-6b6f6f82-6e96-4ba7-b84c-a626a8e14f7d","customColor":{"top-bar":"FFFFFF","right-sidebar":"252935","highlight":"00cdbe"},"documentationLayout":"classic-double-column","customisation":null,"version":"8.10.1","publishDate":"2022-11-11T00:16:57.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/768118b36f06c94b0306958b980558e6915839447e859fe16906e29d683976f0","favicon":"https://weedmaps.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"}],"canonicalUrl":"https://docs.dispatch.weedmaps.com/view/metadata/2s8YeoNDE9"}