{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"79e9d206-773f-43eb-a195-d4f11de27285","name":"Pigeon API","description":"## **Authorization – Getting Started**\n\nTo interact with our API, you must include a **Bearer Token** in your request headers. This token verifies your identity and grants access to authorized endpoints.\n\n### **Step 1: Obtain Your API Token**\n\nLog in to your account and navigate to the Settings > API section in your dashboard. There, you can:\n\n- Generate a new API token\n    \n- View existing tokens\n    \n\n> **Note:** Treat your token like a password. Do not share it or expose it in client-side code. \n  \n\n### **Step 2: Add the Token to Your Request**\n\n``` bash\ncurl -X GET https://yourdomain.com/api/customer \\\n  -H \"Authorization: Bearer YOUR_API_TOKEN\"\n\n ```\n\n### HTTP Status Codes\n\n| 200 - OK | Everything worked as expected. |  \n| 401 - Unauthorized | No valid API key provided. |  \n| 500, 502, 503, 504 - Server Errors | Server errors (very rare) |\n\n### **Troubleshooting**\n\n- If you receive a 401 Unauthorized error, check that:\n    \n    - Your token is correct and active\n        \n    - The Authorization header is properly formatted (Bearer YOUR_API_TOKEN)\n        \n    - The endpoint you’re trying to access is available to your token’s permission scope","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":false,"owner":"27561152","team":5389468,"collectionId":"79e9d206-773f-43eb-a195-d4f11de27285","publishedId":"2sB34imLHM","public":true,"publicUrl":"https://api.pigeon.io","privateUrl":"https://go.postman.co/documentation/27561152-79e9d206-773f-43eb-a195-d4f11de27285","customColor":{"top-bar":"2b408d","right-sidebar":"303030","highlight":"485c99"},"documentationLayout":"classic-double-column","customisation":{"metaTags":[{"name":"description","value":"Do more with Pigeon API. Get access to customers, plans, and subscriptions. "},{"name":"title","value":"Pigeon API Reference"}],"appearance":{"default":"dark","themes":[{"name":"dark","logo":"https://content.pstmn.io/f97e0d5a-58d3-46e5-bd12-c937b4e9c43e/bG9nby1jb2xvcmZ1bC5wbmc=","colors":{"top-bar":"2b408d","right-sidebar":"303030","highlight":"485c99"}},{"name":"light","logo":"https://content.pstmn.io/f97e0d5a-58d3-46e5-bd12-c937b4e9c43e/bG9nby1jb2xvcmZ1bC5wbmc=","colors":{"top-bar":"2b408d","right-sidebar":"303030","highlight":"485c99"}}]}},"version":"8.10.1","publishDate":"2025-07-17T22:29:04.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{"title":"Pigeon API Reference","description":"Do more with Pigeon API. Get access to customers, plans, and subscriptions. "},"logos":{"logoLight":"https://content.pstmn.io/f97e0d5a-58d3-46e5-bd12-c937b4e9c43e/bG9nby1jb2xvcmZ1bC5wbmc=","logoDark":"https://content.pstmn.io/f97e0d5a-58d3-46e5-bd12-c937b4e9c43e/bG9nby1jb2xvcmZ1bC5wbmc="}},"statusCode":200},"environments":[{"name":"Staging","id":"b746e7cb-55ec-4d6e-9deb-1180802565de","owner":"27561152","values":[{"key":"base_url","value":"https://demo.pigeon.io","enabled":true,"type":"text"},{"key":"api_key","value":"s1l4tq00xdy2o14j3aw5xjjv99n7l30v","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/e9c4ae26896049bebaefba1f5b7ccadf18b9ecd71010463f111f3f5fb646078d","favicon":"https://pigeon.io/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"},{"label":"Staging","value":"27561152-b746e7cb-55ec-4d6e-9deb-1180802565de"}],"canonicalUrl":"https://api.pigeon.io/view/metadata/2sB34imLHM"}