{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"2341a288-99e2-4446-aff4-3ab5b0db89ab","name":"Gallabox API","description":"The Gallabox API is organised around [REST](http://en.wikipedia.org/wiki/Representational_State_Transfer). Our API has predictable resource-oriented URLs, accepts [form-encoded](https://en.wikipedia.org/wiki/POST_(HTTP)#Use_for_submitting_web_forms) request bodies, returns [JSON-encoded](http://www.json.org/) responses, and uses standard HTTP response codes, authentication, and verbs.\n\n# Overview\n\nGallabox provides an HTTP-based API that follows the principles of REST. The HTTP rules followed allow simple HTTP clients like cURL to be used as well. The URLs are resource-oriented, the request format is form-encoded, and the responses are in JSON.\n\nDepending on the type of operation, the endpoints use one of two HTTP methods:\n\n- **GET**: Used for all read-only operations such as retrieving a resource or listing a group of resources.\n \n- **POST**: Used for all write operations. Such operations modify the state of a resource\n \n\nA history of changes to the API is provided in the API Changelog.\n\n### Resources\n\nGallabox follows the REST model of exposing resources as urls. For example, Users are exposed as\n\n```\nhttps://server.gallabox.com/devapi/accounts/{{accountId}}/users\n\n ```\n\n### Request\n\nThe HTTP method (like GET,POST) determines the operation type on the resource. Query parameters allow you to provide additional options to the GET requests. POST parameters provide the data to write operations like creation, modification of resource(s).\n\n### Response\n\nThe response is in JSON format. Currently Gallabox does not support any other response format.\n\n# Concepts\n\nThroughout the Gallabox API and it's documentation, there are different concepts, variables, and terms used as you continue to explore. Below you can find more information about these concepts and where to find them in the Gallabox app.\n\n### AccountId\n\nA unique identifier of an Account in Gallabox. You can click the \"Copy\" button when viewing your account's settings.\n\n### ChannelId\n\nA unique identifier of an Channel in Gallabox. You can click the \"Copy\" button when viewing your channel's settings.\n\n# Authentication\n\nGallabox authenticates your API requests using your account’s **API keys**. If you do not include your keys in header when making an API request, or use one that is incorrect or outdated, Gallabox returns an error.\n\nProduction Host for APIs: [https://server.gallabox.com](https://server.gallabox.com)\n\n```\nGET /devapi/test\nHost: server.gallabox.com\napiKey: {{apiKey}}\napiSecret: {{apiSecret}}\nContent-Type: application/json\n\n ```\n\n### How to authenticate\n\nEvery request to Gallabox API should have HTTP header containing a valid API Key and Secret that we use to authenticate the account:\n\n```\napiKey - your account's API Key\napiSecret - your account's API Secret\n\n ```\n\nAPI key and secret can be obtained from Settings page when you are logged into the Gallabox application (screenshot below) or just simply click [here
](https://app.gallabox.com/apikey)\n\n\n\n# Rate Limiting\n\nDifferent types of API methods are subject to different rate limits.\n\nThe response's HTTP headers are the authoritative source for the current number of API calls available to you or your app at any given time. The returned HTTP headers of any API request show your current rate limit status, as described below.\n\n| Header Name | **Description** |\n| --- | --- |\n| X-RateLimit-Limit | The maximum number of requests you're permitted to make in the current rate limit window. |\n| X-RateLimit-Remaining | The number of requests remaining in the current rate limit window. |\n| X-RateLimit-Reset | The time at which the current rate limit window resets in UTC epoch seconds. |\n\nIf you exceed the rate limit, an API error response is returned:\n\n```\nHTTP/2 429\nX-RateLimit-Limit: 60\nX-RateLimit-Remaining: 0\nX-RateLimit-Reset: 1377013266\n{\n \"status\": \"TOO_MANY_REQUEST\",\n \"message\": \"API rate limit exceeded. Please try again in 60 seconds\"\n}\n\n ```","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":false,"owner":"17087523","team":2352682,"collectionId":"2341a288-99e2-4446-aff4-3ab5b0db89ab","publishedId":"Tzz7QJTJ","public":true,"publicUrl":"https://api-docs.gallabox.com","privateUrl":"https://go.postman.co/documentation/17087523-2341a288-99e2-4446-aff4-3ab5b0db89ab","customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"3365fb"},"documentationLayout":"classic-double-column","customisation":{"metaTags":[{"name":"description","value":"Discover the comprehensive Gallabox API documentation. Integrate seamlessly with our WhatsApp automation platform to enhance and automate your business conversations. Access detailed guides, examples, and API references for efficient implementation and optimal performance."},{"name":"title","value":"Gallabox API Documentation - Enhance Your Business Conversations"}],"appearance":{"default":"light","themes":[{"name":"dark","logo":"https://content.pstmn.io/9e165192-82bf-4eb4-916f-f1b72e9fdfca/Z2FsbGFib3gtbG9nby13aXRoLXRleHQucG5n","colors":{"top-bar":"212121","right-sidebar":"303030","highlight":"3365FB"}},{"name":"light","logo":"https://content.pstmn.io/9e165192-82bf-4eb4-916f-f1b72e9fdfca/Z2FsbGFib3gtbG9nby13aXRoLXRleHQucG5n","colors":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"3365fb"}}]}},"version":"8.10.1","publishDate":"2024-07-10T12:23:04.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{"title":"Gallabox API Documentation - Enhance Your Business Conversations","description":"Discover the comprehensive Gallabox API documentation. Integrate seamlessly with our WhatsApp automation platform to enhance and automate your business conversations. Access detailed guides, examples, and API references for efficient implementation and optimal performance."},"logos":{"logoLight":"https://content.pstmn.io/9e165192-82bf-4eb4-916f-f1b72e9fdfca/Z2FsbGFib3gtbG9nby13aXRoLXRleHQucG5n","logoDark":"https://content.pstmn.io/9e165192-82bf-4eb4-916f-f1b72e9fdfca/Z2FsbGFib3gtbG9nby13aXRoLXRleHQucG5n"}},"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/05516b7f3c2740a36ad67c9a0e62373c7cf9ddde9936e15891f8b66f360d611f","favicon":"https://gallabox.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://documenter.gw.postman.com/view/metadata/Tzz7QJTJ"}