{"info":{"_postman_id":"5934fe9e-cd8e-46cd-bcdc-ef0771c71bd9","name":"PanelPress","description":"

This is a temporary API for PanelPress. Only agency clients have access to these endpoints. You can find your API token under panelpress.io -> Company -> Integrations. All requests are POST request.

We will release a rest api when V2 of PanelPress gets released.

\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"10263571","collectionId":"5934fe9e-cd8e-46cd-bcdc-ef0771c71bd9","publishedId":"VUjQnjyi","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"00845a"},"publishDate":"2022-08-11T16:45:09.000Z"},"item":[{"name":"Get Roles","id":"eeda73da-69d4-4258-99a9-449df707ca4b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"url":"https://panelpress.io/api/1.1/wf/agency-get-roles/","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{api-token}}"}]},"isInherited":true,"source":{"_postman_id":"5934fe9e-cd8e-46cd-bcdc-ef0771c71bd9","id":"5934fe9e-cd8e-46cd-bcdc-ef0771c71bd9","name":"PanelPress","type":"collection"}},"urlObject":{"protocol":"https","path":["api","1.1","wf","agency-get-roles",""],"host":["panelpress","io"],"query":[],"variable":[]}},"response":[{"id":"bebb0c05-c4b8-4adb-a5c4-235b40066db6","name":"Get Roles","originalRequest":{"method":"POST","header":[{"key":"","value":"","type":"text","disabled":true}],"url":"https://panelpress.io/api/1.1/wf/agency-get-roles/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 11 Aug 2022 21:27:11 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"x-powered-by","value":"Express"},{"key":"set-cookie","value":"gridapp_live_u2main=; path=/; expires=Thu, 01 Jan 1970 00:00:00 GMT; secure; httponly"},{"key":"set-cookie","value":"gridapp_live_u2main.sig=vIH92yu0IKwhMsz3eRFK9Ygdz9U; path=/; expires=Thu, 01 Jan 1970 00:00:00 GMT; secure; httponly"},{"key":"access-control-allow-origin","value":"*"},{"key":"x-bubble-perf","value":"{\"total\":540.7,\"percents\":{\"top\":{\"bubble_cpu\":8.4,\"block\":91.3,\"capacity_rl\":0,\"other_pause\":0,\"pre_fiber\":0.1},\"sub\":{\"pp_userdb\":5.9,\"pp_wait_userdb\":0,\"http_request\":0,\"serverjson\":59.1,\"appserver_cache_misses_time\":0,\"redis\":12.8,\"fiber_queue\":0.7,\"capacity_wait\":0}},\"counts\":{\"pp_userdb\":7,\"http_request\":0,\"derived_build\":0,\"derived_cache_attempts\":1,\"derived_cache_memory_misses\":1,\"serverjson\":42,\"appserver_cache_attempts\":2,\"appserver_mem_cache_hits\":0,\"appserver_cache_hits\":2,\"appserver_cache_misses\":0,\"redis\":72,\"fiber_queue\":73,\"blocks\":72},\"misc\":{\"userdb_results\":7,\"userdb_data\":13701,\"spent_time\":15796236,\"derived_build_time_spent\":0}}"},{"key":"x-bubble-capacity-used","value":"0.243 unit-seconds used"},{"key":"x-bubble-capacity-limit","value":"0 ms slower"},{"key":"vary","value":"Accept-Encoding"},{"key":"CF-Cache-Status","value":"DYNAMIC"},{"key":"Expect-CT","value":"max-age=604800, report-uri=\"https://report-uri.cloudflare.com/cdn-cgi/beacon/expect-ct\""},{"key":"Server","value":"cloudflare"},{"key":"CF-RAY","value":"73940dc43f68aca9-TXL"},{"key":"Content-Encoding","value":"br"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"success\",\n \"response\": {\n \"role\": [\n {\n \"Name\": \"Admin\",\n \"Created By\": \"admin_user_gridapp_test\",\n \"Created Date\": 1644015151142,\n \"Modified Date\": 1660214601956,\n \"Features\": [\n \"SSO WP Admin\",\n \"SSO PHPMyAdmin\",\n \"Enable Page Cache\",\n \"Disable Page Cache\",\n \"Clear Page Cache\",\n \"Modify Page Cache TTL\",\n \"Disable SSL\",\n \"Enable SSL\",\n \"Add Domain\",\n \"Change PHP Version\",\n \"Clear Object Cache\",\n \"Modify Object Cache\",\n \"Read Error Log\",\n \"Read Access Log\",\n \"Read Debug Log\",\n \"Modify WP Debug\",\n \"View SFTP Credentials\",\n \"Restore Backups\",\n \"Create Backups\",\n \"Purge Backups\",\n \"Read Backups\",\n \"Import Site\",\n \"Edit Branding\",\n \"Access Infinite Staging\",\n \"Activate Theme\",\n \"Add Domain\",\n \"Assign Role\",\n \"Cancel Scheduled Process\",\n \"Change PHP Version\",\n \"Change PHP Version\",\n \"Clear Object Cache\",\n \"Clear Page Cache\",\n \"Connect Infinite Staging Sites\",\n \"Create Backups\",\n \"Create Role\",\n \"Create Theme\",\n \"Delete Domain\",\n \"Delete Role\",\n \"Delete User\",\n \"Modify Object Cache\",\n \"Disable Page Cache\",\n \"Disable SSL\",\n \"Edit Theme\",\n \"Modify WP Debug\",\n \"Enable Page Cache\",\n \"Disable SSL\",\n \"Invite User\",\n \"Modify User Sites\",\n \"Modify User Sites\",\n \"Assign Role\",\n \"Create Role\",\n \"Delete Role\",\n \"Remove Site\",\n \"Read Activity Log\"\n ],\n \"instance_role\": true,\n \"all_sites\": true,\n \"_id\": \"1644015151142x318231725569120260\"\n },\n {\n \"Name\": \"Client\",\n \"Created By\": \"1643303115527x231346729868611160\",\n \"Created Date\": 1644015296940,\n \"Modified Date\": 1658813546680,\n \"Features\": [\n \"SSO WP Admin\",\n \"SSO PHPMyAdmin\",\n \"Enable Page Cache\",\n \"Disable Page Cache\",\n \"Clear Page Cache\",\n \"Modify Page Cache TTL\",\n \"Disable SSL\",\n \"Enable SSL\",\n \"Add Domain\",\n \"Change PHP Version\",\n \"Clear Object Cache\",\n \"Modify Object Cache\",\n \"Read Error Log\",\n \"Read Access Log\",\n \"Read Debug Log\",\n \"Modify WP Debug\",\n \"View SFTP Credentials\",\n \"Restore Backups\",\n \"Create Backups\",\n \"Purge Backups\",\n \"Read Backups\"\n ],\n \"instance_role\": true,\n \"all_sites\": false,\n \"_id\": \"1644015296431x840762641763008500\"\n },\n {\n \"company\": \"1653924220890x881935511301282300\",\n \"Name\": \"Test\",\n \"Created By\": \"1653924200737x244877078620337380\",\n \"Created Date\": 1654194380482,\n \"Modified Date\": 1658185363730,\n \"Features\": [\n \"SSO WP Admin\",\n \"SSO PHPMyAdmin\",\n \"Enable Page Cache\",\n \"Disable Page Cache\",\n \"Clear Page Cache\",\n \"Modify Page Cache TTL\",\n \"Disable SSL\",\n \"Enable SSL\",\n \"Add Domain\",\n \"Change PHP Version\",\n \"Clear Object Cache\",\n \"Modify Object Cache\",\n \"Read Error Log\",\n \"Read Access Log\",\n \"Read Debug Log\",\n \"Modify WP Debug\",\n \"View SFTP Credentials\",\n \"Restore Backups\",\n \"Create Backups\",\n \"Purge Backups\",\n \"Read Backups\"\n ],\n \"instance_role\": false,\n \"all_sites\": false,\n \"assignable_roles\": [\n \"1644015296431x840762641763008500\",\n \"1654194379899x225300910859354100\"\n ],\n \"sites\": [],\n \"_id\": \"1654194379899x225300910859354100\"\n }\n ]\n }\n}"}],"_postman_id":"eeda73da-69d4-4258-99a9-449df707ca4b"},{"name":"Get Users","id":"81f14103-7c55-4118-bf41-82346fe433d0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"url":"https://panelpress.io/api/1.1/wf/agency-get-users/","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{api-token}}"}]},"isInherited":true,"source":{"_postman_id":"5934fe9e-cd8e-46cd-bcdc-ef0771c71bd9","id":"5934fe9e-cd8e-46cd-bcdc-ef0771c71bd9","name":"PanelPress","type":"collection"}},"urlObject":{"protocol":"https","path":["api","1.1","wf","agency-get-users",""],"host":["panelpress","io"],"query":[],"variable":[]}},"response":[{"id":"4a7eb007-9650-4598-ac5d-1061f311bab4","name":"Get Users","originalRequest":{"method":"POST","header":[{"key":"","value":"","type":"text","disabled":true}],"url":"https://panelpress.io/api/1.1/wf/agency-get-users/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 11 Aug 2022 21:27:43 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"x-powered-by","value":"Express"},{"key":"set-cookie","value":"gridapp_live_u2main=; path=/; expires=Thu, 01 Jan 1970 00:00:00 GMT; secure; httponly"},{"key":"set-cookie","value":"gridapp_live_u2main.sig=vIH92yu0IKwhMsz3eRFK9Ygdz9U; path=/; expires=Thu, 01 Jan 1970 00:00:00 GMT; secure; httponly"},{"key":"access-control-allow-origin","value":"*"},{"key":"x-bubble-perf","value":"{\"total\":589.4,\"percents\":{\"top\":{\"bubble_cpu\":8.2,\"block\":91.6,\"capacity_rl\":0,\"other_pause\":0,\"pre_fiber\":0.1},\"sub\":{\"pp_userdb\":2.2,\"pp_wait_userdb\":0,\"http_request\":0,\"serverjson\":132.9,\"appserver_cache_misses_time\":0,\"redis\":14,\"fiber_queue\":0.8,\"capacity_wait\":0}},\"counts\":{\"pp_userdb\":3,\"http_request\":0,\"derived_build\":0,\"derived_cache_attempts\":2,\"derived_cache_memory_misses\":2,\"serverjson\":46,\"appserver_cache_attempts\":2,\"appserver_mem_cache_hits\":0,\"appserver_cache_hits\":1,\"appserver_cache_misses\":1,\"redis\":84,\"fiber_queue\":82,\"blocks\":81},\"misc\":{\"userdb_results\":5,\"userdb_data\":12103,\"spent_time\":12241601,\"derived_build_time_spent\":0}}"},{"key":"x-bubble-capacity-used","value":"0.188 unit-seconds used"},{"key":"x-bubble-capacity-limit","value":"0 ms slower"},{"key":"vary","value":"Accept-Encoding"},{"key":"CF-Cache-Status","value":"DYNAMIC"},{"key":"Expect-CT","value":"max-age=604800, report-uri=\"https://report-uri.cloudflare.com/cdn-cgi/beacon/expect-ct\""},{"key":"Server","value":"cloudflare"},{"key":"CF-RAY","value":"73940e8bec26aca9-TXL"},{"key":"Content-Encoding","value":"br"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"success\",\n \"response\": {\n \"users\": [\n {\n \"_id\": \"1653924200737x244877078620337380\",\n \"Created Date\": 1653924200742,\n \"Modified Date\": 1660253262976,\n \"user_signed_up\": true,\n \"authentication\": {\n \"email\": {\n \"email\": \"tobi@gridpane.com\",\n \"email_confirmed\": null\n }\n },\n \"gp_id\": 2178,\n \"photo_url\": \"https://my.gridpane.com//storage/profiles/0H315nDhefSH57E9F5a70bMfhkZRU3smShCoRIBn.jpeg\",\n \"gp_connected\": true,\n \"first_name\": \"Tobias\",\n \"last_name\": \"Vogel\",\n \"company\": \"1653924220890x881935511301282300\",\n \"connecting_to_gp\": false,\n \"is_instance_admin\": false,\n \"sign_up_completed\": true,\n \"sites\": [\n \"1656259664773x573922779687799940\",\n \"1656259674823x303803785621589800\",\n \"1656259684871x562329407196797900\",\n \"1656259694897x470429278703722940\",\n \"1656259705056x251313330538964760\",\n \"1656259724791x370894509766650300\",\n \"1656259744854x489097707551791940\",\n \"1656259754926x115394569874306850\",\n \"1656259765423x303146631564764600\",\n \"1656259795076x304876375377250750\",\n \"1656259814746x324038637737213760\"\n ],\n \"invite_ident\": 423,\n \"basic_creds_set\": true,\n \"gp_client\": true,\n \"latest_changelog_seen\": true,\n \"agency_client\": true,\n \"gp_auth_connection_failed\": false,\n \"preferred_color_scheme\": \"Light\",\n \"sites_table_data\": [\n \"ip\",\n \"region\",\n \"server\",\n \"page_caching\",\n \"page_cache_enabled\",\n \"nginx_caching_ttl\",\n \"is_debug\",\n \"http_auth\",\n \"favicon\"\n ],\n \"role_v2\": [\n \"1644015151142x318231725569120260\"\n ],\n \"reload_backups\": false,\n \"bug_reporting\": true,\n \"site_view_mode\": \"grid\",\n \"portal_api_token\": \"Ib4Eom 811811220811167KqB3gW1653924200737x244877078620337380\",\n \"last-api-request\": 1660253262975\n }\n ]\n }\n}"}],"_postman_id":"81f14103-7c55-4118-bf41-82346fe433d0"},{"name":"Invite User","id":"b34bb6d9-7890-4710-a23b-0d46aa4b4f93","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"first_name\": \"{string}\",\n \"last_name\": \"{string}\",\n \"email\": \"{string}\",\n \"role\": \"{string}\"\n}","options":{"raw":{"language":"json"}}},"url":"https://panelpress.io/api/1.1/wf/agency-invite-user/","description":"

first_name - string - required

First name of the new user to be invited.

last_name - string - required

Last name of the new user to be invited.

email - string - required

Email of the new user to be invited.

role - string - required

The role id. You can retrieve the role_id from the agency-get-roles endpoint.

\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{api-token}}"}]},"isInherited":true,"source":{"_postman_id":"5934fe9e-cd8e-46cd-bcdc-ef0771c71bd9","id":"5934fe9e-cd8e-46cd-bcdc-ef0771c71bd9","name":"PanelPress","type":"collection"}},"urlObject":{"protocol":"https","path":["api","1.1","wf","agency-invite-user",""],"host":["panelpress","io"],"query":[],"variable":[]}},"response":[{"id":"689e719d-f869-4c69-9ba1-4abda3209e78","name":"Invite User","originalRequest":{"method":"POST","header":[{"key":"","value":"","type":"text","disabled":true}],"body":{"mode":"raw","raw":"{\n \"first_name\": \"{string}\",\n \"last_name\": \"{string}\",\n \"email\": \"{string}\",\n \"role\": \"{string}\"\n}","options":{"raw":{"language":"json"}}},"url":"https://panelpress.io/api/1.1/wf/agency-invite-user/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 11 Aug 2022 21:30:34 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"x-powered-by","value":"Express"},{"key":"set-cookie","value":"gridapp_live_u2main=; path=/; expires=Thu, 01 Jan 1970 00:00:00 GMT; secure; httponly"},{"key":"set-cookie","value":"gridapp_live_u2main.sig=vIH92yu0IKwhMsz3eRFK9Ygdz9U; path=/; expires=Thu, 01 Jan 1970 00:00:00 GMT; secure; httponly"},{"key":"access-control-allow-origin","value":"*"},{"key":"x-bubble-perf","value":"{\"total\":21251.4,\"percents\":{\"top\":{\"bubble_cpu\":1.7,\"block\":51.3,\"capacity_rl\":0,\"other_pause\":47.1,\"pre_fiber\":0},\"sub\":{\"pp_userdb\":0.4,\"pp_wait_userdb\":0,\"http_request\":1.5,\"serverjson\":14.9,\"appserver_cache_misses_time\":0,\"redis\":1.7,\"fiber_queue\":0.1,\"capacity_wait\":0.1}},\"counts\":{\"pp_userdb\":16,\"http_request\":1,\"derived_build\":1,\"derived_cache_attempts\":3,\"derived_cache_memory_misses\":3,\"derived_cache_redis_misses\":1,\"derived_cache_postgres_misses\":1,\"serverjson\":138,\"appserver_cache_attempts\":1,\"appserver_mem_cache_hits\":0,\"appserver_cache_hits\":1,\"appserver_cache_misses\":0,\"redis\":298,\"fiber_queue\":357,\"blocks\":356},\"misc\":{\"userdb_results\":20,\"userdb_data\":20044,\"spent_time\":145441551,\"derived_build_time_spent\":130}}"},{"key":"x-bubble-capacity-used","value":"2.238 unit-seconds used"},{"key":"x-bubble-capacity-limit","value":"21.7 ms slower"},{"key":"vary","value":"Accept-Encoding"},{"key":"CF-Cache-Status","value":"DYNAMIC"},{"key":"Expect-CT","value":"max-age=604800, report-uri=\"https://report-uri.cloudflare.com/cdn-cgi/beacon/expect-ct\""},{"key":"Server","value":"cloudflare"},{"key":"CF-RAY","value":"73941235b9abaca9-TXL"},{"key":"Content-Encoding","value":"br"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"success\",\n \"response\": {\n \"Status\": \"Success\",\n \"invitation\": {\n \"_id\": \"1660253413522x612449656959932000\",\n \"company\": \"1653924220890x881935511301282300\",\n \"email\": \"anemail@tobi.tools\",\n \"first_name\": \"First Name\",\n \"gp_client\": false,\n \"hash\": \"$2b$12$CnQcNnx76fHpz3kqslYRVeXa3spJaeptZnFUd0FMOvT3Krx2TMIpq\",\n \"ident\": 585,\n \"last_name\": \"last Name\",\n \"redeemed\": false,\n \"Created By\": \"non_authenticated_user_gridapp_live\",\n \"Created Date\": 1660253413566,\n \"Modified Date\": 1660253434353,\n \"agency_client\": false,\n \"role_v2\": [\n null\n ]\n },\n \"role\": {}\n }\n}"}],"_postman_id":"b34bb6d9-7890-4710-a23b-0d46aa4b4f93"},{"name":"Import Site","id":"1a06460f-748a-4e3f-ad35-533e5374056f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"gp_site_id\": 2178\n}","options":{"raw":{"language":"json"}}},"url":"https://panelpress.io/api/1.1/wf/agency-import-site/","description":"

gp_site_id - int - required

You can find the endpoint to retrieve the gp_site_id here.