{"info":{"_postman_id":"ac74567f-86dc-49a7-85d0-58b3b5504583","name":"Playhunt API documentation","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"description":"","owner":"300628","collectionId":"ac74567f-86dc-49a7-85d0-58b3b5504583","publishedId":"SzS1UUuD","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"EF5B25"},"publishDate":"2020-03-12T17:31:00.000Z"},"item":[{"name":"Interview","item":[{"name":"create interview","id":"f9976525-75de-41ea-9d9b-07c4f5de20e2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"access-token","value":"ZyKPWcr6PkaAk_accEssToKenExAmpLe","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"questions","value":"[\"Is this question number one?\", \"Is this question number two?\", \"Is this question number three?\"]","type":"text"},{"key":"topic","value":"Interview Topic","type":"text"}]},"url":"https://api.playhunt.io/public/1.00/interview/create-interview","description":"

Endpoint to create a new interview

\n","urlObject":{"protocol":"https","path":["public","1.00","interview","create-interview"],"host":["api","playhunt","io"],"query":[],"variable":[]}},"response":[{"id":"4f9dc1ba-1728-4216-9b90-3e9a19731fb0","name":"create interview","originalRequest":{"method":"POST","header":[{"key":"access-token","value":"ZyKPWcr6PkaAk_accEssToKenExAmpLe","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"questions","value":"[\"Is this question number one?\", \"Is this question number two?\", \"Is this question number three?\"]","type":"text"},{"key":"topic","value":"Interview Topic","type":"text"}]},"url":"https://api.playhunt.io/public/1.00/interview/create-interview"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"topic\": \"Interview Topic\",\n \"guid\": \"kepfol09\",\n \"questions\": [\n {\n \"question\": \"Is this question number one?\",\n \"position\": 0\n },\n {\n \"question\": \"Is this question number two?\",\n \"position\": 1\n },\n {\n \"question\": \"Is this question number three?\",\n \"position\": 2\n }\n ],\n \"url\": \"https://playhunt.io/welcome/kepfol09\",\n \"created_at\": 1584034075,\n \"updated_at\": 1584034075\n}"}],"_postman_id":"f9976525-75de-41ea-9d9b-07c4f5de20e2"},{"name":"edit interview","id":"a1be8c50-f888-4c88-a23f-ff6392b069c7","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"access-token","type":"text","value":"ZyKPWcr6PkaAk_accEssToKenExAmpLe"}],"body":{"mode":"formdata","formdata":[{"key":"questions","type":"text","value":"[\"Is this question number one (edited)?\", \"Is this question number two (edited)?\", \"Is this question number three? (edited)\"]"},{"key":"topic","type":"text","value":"interview topic edited"},{"key":"guid","type":"text","value":"kepfol09"}]},"url":"https://api.playhunt.io/public/1.00/interview/edit-interview","description":"

Endpoint to edit an existing interview.

\n
\n

Important: You should submit all of the interview fields, not just the ones you want to change. Otherwise, the fields that you will not submit - will clear

\n
\n","urlObject":{"protocol":"https","path":["public","1.00","interview","edit-interview"],"host":["api","playhunt","io"],"query":[],"variable":[]}},"response":[{"id":"7eeb5457-0fb7-46ac-8681-4987dd2f1281","name":"edit interview","originalRequest":{"method":"POST","header":[{"key":"access-token","type":"text","value":"ZyKPWcr6PkaAk_accEssToKenExAmpLe"}],"body":{"mode":"formdata","formdata":[{"key":"questions","type":"text","value":"[\"Is this question number one (edited)?\", \"Is this question number two (edited)?\", \"Is this question number three? (edited)\"]"},{"key":"topic","type":"text","value":"Interview Topic Edited"},{"key":"guid","type":"text","value":"kepfol09"}]},"url":"https://api.playhunt.io/public/1.00/interview/edit-interview"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"topic\": \"Interview Topic Edited\",\n \"guid\": \"kepfol09\",\n \"questions\": [\n {\n \"question\": \"Is this question number one (edited)?\",\n \"position\": 0\n },\n {\n \"question\": \"Is this question number two (edited)?\",\n \"position\": 1\n },\n {\n \"question\": \"Is this question number three? (edited)\",\n \"position\": 2\n }\n ],\n \"url\": \"https://playhunt.io/welcome/kepfol09\",\n \"created_at\": 1584034075,\n \"updated_at\": 1584034075\n}"}],"_postman_id":"a1be8c50-f888-4c88-a23f-ff6392b069c7"},{"name":"delete interview","id":"ded4aba6-89a0-4d2f-94fc-0bde976fb748","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"access-token","type":"text","value":"ZyKPWcr6PkaAk_accEssToKenExAmpLe"}],"body":{"mode":"formdata","formdata":[{"key":"guid","type":"text","value":"kepfol09"}]},"url":"https://api.playhunt.io/public/1.00/interview/delete-interview","description":"

Endpoint to delete an existing interview.
The server will return a response with the status 200-OK if the delete operation will have done successfully

\n","urlObject":{"protocol":"https","path":["public","1.00","interview","delete-interview"],"host":["api","playhunt","io"],"query":[],"variable":[]}},"response":[{"id":"ad3f2a0a-c593-4753-885a-7218a2488321","name":"delete interview","originalRequest":{"method":"POST","header":[{"key":"access-token","type":"text","value":"ZyKPWcr6PkaAk_accEssToKenExAmpLe"}],"body":{"mode":"formdata","formdata":[{"key":"guid","type":"text","value":"kepfol09"}]},"url":"https://api.playhunt.io/public/1.00/interview/delete-interview"},"status":"OK","code":200,"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":" "}],"_postman_id":"ded4aba6-89a0-4d2f-94fc-0bde976fb748"},{"name":"get interview","id":"4bfee282-6300-4304-9f14-8ee3f133695c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"access-token","type":"text","value":"ZyKPWcr6PkaAk_accEssToKenExAmpLe"}],"body":{"mode":"formdata","formdata":[{"key":"guid","value":"kepfol09","type":"text"}]},"url":"https://api.playhunt.io/public/1.00/interview/get-interview","description":"

Endpoint to get an existing interview by guid

\n","urlObject":{"protocol":"https","path":["public","1.00","interview","get-interview"],"host":["api","playhunt","io"],"query":[],"variable":[]}},"response":[{"id":"ff66d9fb-ae11-47d8-99fb-7046b21a4806","name":"get interview","originalRequest":{"method":"POST","header":[{"key":"access-token","type":"text","value":"ZyKPWcr6PkaAk_accEssToKenExAmpLe"}],"body":{"mode":"formdata","formdata":[{"key":"guid","value":"kepfol09","type":"text"}]},"url":"https://api.playhunt.io/public/1.00/interview/get-interview"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"topic\": \"interview topic\",\n \"guid\": \"kepfol09\",\n \"questions\": [\n {\n \"question\": \"Is this question number one?\",\n \"position\": 0\n },\n {\n \"question\": \"Is this question number two?\",\n \"position\": 1\n },\n {\n \"question\": \"Is this question number three?\",\n \"position\": 2\n }\n ],\n \"url\": \"https://playhunt.io/welcome/hhqflikl\",\n \"created_at\": 1579040268,\n \"updated_at\": 1579974646\n}"}],"_postman_id":"4bfee282-6300-4304-9f14-8ee3f133695c"},{"name":"get all interviews","id":"992ba446-9bc4-445d-af38-406e70c59055","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"access-token","type":"text","value":"ZyKPWcr6PkaAk_accEssToKenExAmpLe"}],"body":{"mode":"formdata","formdata":[]},"url":"https://api.playhunt.io/public/1.00/interview/get-all-interviews","description":"

Endpoint to get all interviews

\n","urlObject":{"protocol":"https","path":["public","1.00","interview","get-all-interviews"],"host":["api","playhunt","io"],"query":[],"variable":[]}},"response":[{"id":"eb7e3e97-a2b5-47da-990c-3f2fac73028e","name":"get all interviews","originalRequest":{"method":"POST","header":[{"key":"access-token","type":"text","value":"ZyKPWcr6PkaAk_accEssToKenExAmpLe"}],"body":{"mode":"formdata","formdata":[]},"url":"https://api.playhunt.io/public/1.00/interview/get-all-interviews"},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"[\n {\n \"topic\": \"Interview Topic\",\n \"guid\": \"kepfol09\",\n \"questions\": [\n {\n \"question\": \"Is this question number one?\",\n \"position\": 0\n },\n {\n \"question\": \"Is this question number two?\",\n \"position\": 1\n },\n {\n \"question\": \"Is this question number three?\",\n \"position\": 2\n }\n ],\n \"url\": \"https://playhunt.io/welcome/kepfol09\",\n \"created_at\": 1584033573,\n \"updated_at\": 1584033573\n },\n {\n \"topic\": \"Interview Topic 2\",\n \"guid\": \"4b0s728r\",\n \"questions\": [\n {\n \"question\": \"Tell Me About Yourself\",\n \"position\": 0\n },\n {\n \"question\": \"How Did You Hear About This Position?\",\n \"position\": 1\n },\n {\n \"question\": \"Why Do You Want to Work at our Company?\",\n \"position\": 2\n }\n ],\n \"url\": \"https://playhunt.io/welcome/4b0s728r\",\n \"created_at\": 1584034075,\n \"updated_at\": 1584034075\n }\n]"}],"_postman_id":"992ba446-9bc4-445d-af38-406e70c59055"}],"id":"edd46fa0-de70-4ffa-9f3d-a469382ff9bd","_postman_id":"edd46fa0-de70-4ffa-9f3d-a469382ff9bd","description":""},{"name":"Interview's responses","item":[{"name":"get interview's responses","id":"866c1ab7-a680-4347-9008-fd217bfe1261","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"access-token","type":"text","value":"ZyKPWcr6PkaAk_accEssToKenExAmpLe"}],"body":{"mode":"formdata","formdata":[{"key":"guid","type":"text","value":"t6erppwd"}]},"url":"https://api.playhunt.io/public/1.00/interview-response/get-by-interview-guid","description":"

Endpoint to get all responses for the specific interview

\n","urlObject":{"protocol":"https","path":["public","1.00","interview-response","get-by-interview-guid"],"host":["api","playhunt","io"],"query":[],"variable":[]}},"response":[{"id":"094f2bcd-5adc-4e2a-a9f5-7a33ed99d0ea","name":"get interview's responses","originalRequest":{"method":"POST","header":[{"key":"access-token","type":"text","value":"ZyKPWcr6PkaAk_accEssToKenExAmpLe"}],"body":{"mode":"formdata","formdata":[{"key":"guid","type":"text","value":"t6erppwd"}]},"url":"https://api.playhunt.io/public/1.00/interview-response/get-by-interview-guid"},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"[\n {\n \"guid\": \"pqeupjypuo2lf01nd1mq73gf\",\n \"file_mp4\": \"https://playhunt.io/path_to_file/file.mp4\",\n \"file_jpg\": \"https://playhunt.io/path_to_file/file.jpg\",\n \"candidate_name\": \"Gloria Bunny\",\n \"candidate_email\": \"gloria.bunny@fakemail.com\",\n \"candidate_phone\": \"309-123-4567\",\n \"created_at\": 1582025676,\n \"updated_at\": 1582025855\n }\n]"}],"_postman_id":"866c1ab7-a680-4347-9008-fd217bfe1261"},{"name":"get response","id":"50e4c5f3-bfae-4393-971d-38a4ec62e1a4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"access-token","value":"ZyKPWcr6PkaAk_accEssToKenExAmpLe","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"guid","type":"text","value":"pqeupjypuo2lf01nd1mq73gw"}]},"url":"https://api.playhunt.io/public/1.00/interview-response/get-interview-response","description":"

Endpoint to get all responses for the specific interview

\n","urlObject":{"protocol":"https","path":["public","1.00","interview-response","get-interview-response"],"host":["api","playhunt","io"],"query":[],"variable":[]}},"response":[{"id":"f89b3aec-7ee2-4901-b19e-4c250d929e8e","name":"get interview's responses","originalRequest":{"method":"POST","header":[{"key":"access-token","value":"ZyKPWcr6PkaAk_accEssToKenExAmpLe","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"guid","type":"text","value":"pqeupjypuo2lf01nd1mq73gf"}]},"url":"https://api.playhunt.io/public/1.00/interview-response/get-interview-response"},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\n \"guid\": \"pqeupjypuo2lf01nd1mq73gf\",\n \"file_mp4\": \"https://playhunt.io/path_to_file/file.mp4\",\n \"file_jpg\": \"https://playhunt.io/path_to_file/file.jpg\",\n \"candidate_name\": \"Gloria Bunny\",\n \"candidate_email\": \"gloria.bunny@fakemail.com\",\n \"candidate_phone\": \"309-123-4567\",\n \"created_at\": 1582025676,\n \"updated_at\": 1582025855\n}"}],"_postman_id":"50e4c5f3-bfae-4393-971d-38a4ec62e1a4"}],"id":"33a814c4-893c-4b4d-93a0-be669a74563d","_postman_id":"33a814c4-893c-4b4d-93a0-be669a74563d","description":""},{"name":"white-label","item":[{"name":"create white-label config","id":"8c4dbb2c-9788-43a3-bd83-504fb04b09af","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"access-token","type":"text","value":"ZyKPWcr6PkaAk_accEssToKenExAmpLe"}],"body":{"mode":"formdata","formdata":[{"key":"domain","value":"customdomain","description":"

optional, only a-z, max length: 16

\n","type":"text"},{"key":"color","value":"#8e44ad","description":"

optional. Get acceptable values through the endpoint: \"get available page colors\"

\n","type":"text"},{"key":"pageLang","value":"en","description":"

optional. Get acceptable values through the endpoint: \"get available page langs\"

\n","type":"text"},{"key":"textTitle","value":"Custom Title","description":"

optional, max length: 30

\n","type":"text"},{"key":"textBody","value":"Custom Body","description":"

optional, max length: 500

\n","type":"text"},{"key":"logoUrl","value":"https://your-domain.com/path_to_file/file.png","description":"

optional, url to the logo. Acceptable file format: 'jpg', 'jpeg', 'png'. Acceptable image size: 294px*84px

\n","type":"text"},{"key":"isDefault","value":"0","description":"

optional, 0 or 1

\n","type":"text"}]},"url":"https://api.playhunt.io/public/1.00/white-label/create-white-label-config","description":"

Endpoint to create new white-label config

\n","urlObject":{"protocol":"https","path":["public","1.00","white-label","create-white-label-config"],"host":["api","playhunt","io"],"query":[],"variable":[]}},"response":[{"id":"2866850c-7090-47af-ae0a-324113310ee9","name":"create white-label config","originalRequest":{"method":"POST","header":[{"key":"access-token","type":"text","value":"ZyKPWcr6PkaAk_accEssToKenExAmpLe"}],"body":{"mode":"formdata","formdata":[{"key":"domain","value":"customdomain","type":"text"},{"key":"color","value":"#8e44ad","type":"text"},{"key":"pageLang","value":"en","type":"text"},{"key":"textTitle","value":"Custom Title","type":"text"},{"key":"textBody","value":"Custom Body","type":"text"},{"key":"logoUrl","value":"https://your-domain.com/path_to_file/file.png","type":"text"},{"key":"isDefault","value":"0","type":"text"}]},"url":"https://api.playhunt.io/public/1.00/white-label/create-white-label-config"},"status":"OK","code":200,"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\n \"guid\": \"7lx5f9hn\",\n \"domain\": \"customdomain\",\n \"color\": \"#8e44ad\",\n \"logo_path\": \"https://playhunt.io/path_to_file/file.png\",\n \"page_lang\": \"en\",\n \"text_title\": \"Custom Title\",\n \"text_body\": \"Custom Body\",\n \"is_default\": 0,\n \"created_at\": 1636207497,\n \"updated_at\": 1636207497\n}"}],"_postman_id":"8c4dbb2c-9788-43a3-bd83-504fb04b09af"},{"name":"edit white-label config","id":"12f59fd5-dbca-444f-b33e-58140e2b98c7","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"access-token","type":"text","value":"ZyKPWcr6PkaAk_accEssToKenExAmpLe"}],"body":{"mode":"formdata","formdata":[{"key":"guid","value":"7lx5f9hn","description":"

required

\n","type":"text"},{"key":"domain","value":"customdomain","description":"

optional, only a-z, max length: 16

\n","type":"text"},{"key":"color","value":"#34495e","description":"

optional. Get acceptable values through the endpoint: \"get available page colors\"

\n","type":"text"},{"key":"pageLang","value":"en","description":"

optional. Get acceptable values through the endpoint: \"get available page langs\"

\n","type":"text"},{"key":"textTitle","value":"Custom Title Edited","description":"

optional, max length: 30

\n","type":"text"},{"key":"textBody","value":"Custom Body Edited","description":"

optional, max length: 500

\n","type":"text"},{"key":"isDefault","value":"0","description":"

optional, 0 or 1

\n","type":"text"},{"key":"logoUrl","value":"https://your-domain.com/path_to_file/file.png","description":"

optional, url to the logo. Acceptable file format: 'jpg', 'jpeg', 'png'. Acceptable image size: 294px*84px

\n","type":"text"}]},"url":"https://api.playhunt.io/public/1.00/white-label/edit-white-label-config","description":"

Endpoint to edit an existing white-label config.

\n
\n

Important: You should submit all of the white-label config fields, not just the ones you want to change. Otherwise, the fields that you will not submit - will clear

\n
\n","urlObject":{"protocol":"https","path":["public","1.00","white-label","edit-white-label-config"],"host":["api","playhunt","io"],"query":[],"variable":[]}},"response":[{"id":"e2cc811c-d3e3-4dc7-a87d-e8ec6162a5ff","name":"edit white-label config","originalRequest":{"method":"POST","header":[{"key":"access-token","type":"text","value":"ZyKPWcr6PkaAk_accEssToKenExAmpLe"}],"body":{"mode":"formdata","formdata":[{"key":"guid","value":"7lx5f9hn","type":"text"},{"key":"domain","value":"customdomain","type":"text"},{"key":"color","value":"#34495e","type":"text"},{"key":"pageLang","value":"en","type":"text"},{"key":"textTitle","value":"Custom Title Edited","type":"text"},{"key":"textBody","value":"Custom Body Edited","type":"text"},{"key":"isDefault","value":"0","type":"text"},{"key":"logoUrl","value":"https://your-domain.com/path_to_file/file.png","type":"text"}]},"url":"https://api.playhunt.io/public/1.00/white-label/edit-white-label-config"},"status":"OK","code":200,"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\n \"guid\": \"7lx5f9hn\",\n \"domain\": \"customdomain\",\n \"color\": \"#34495e\",\n \"logo_path\": \"https://playhunt.io/path_to_file/file.png\",\n \"page_lang\": \"en\",\n \"text_title\": \"Custom Title Edited\",\n \"text_body\": \"Custom Body Edited\",\n \"is_default\": 0,\n \"created_at\": 1636153353,\n \"updated_at\": 1636207582\n}"}],"_postman_id":"12f59fd5-dbca-444f-b33e-58140e2b98c7"},{"name":"delete white-label config","id":"5cf85e5c-632c-436c-b11a-287470bf5fc6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"access-token","type":"text","value":"ZyKPWcr6PkaAk_accEssToKenExAmpLe"}],"body":{"mode":"formdata","formdata":[{"key":"guid","value":"7lx5f9hn","description":"

required

\n","type":"text"}]},"url":"https://api.playhunt.io/public/1.00/white-label/delete-white-label-config","description":"

Endpoint to delete an existing white-label config.
The server will return a response with the status 200-OK if the delete operation will have done successfully

\n","urlObject":{"protocol":"https","path":["public","1.00","white-label","delete-white-label-config"],"host":["api","playhunt","io"],"query":[],"variable":[]}},"response":[{"id":"b3c1c485-72da-45ce-a8c8-aae4a2194685","name":"delete white-label config","originalRequest":{"method":"POST","header":[{"key":"access-token","type":"text","value":"ZyKPWcr6PkaAk_accEssToKenExAmpLe"}],"body":{"mode":"formdata","formdata":[{"key":"guid","value":"7lx5f9hn","description":"required","type":"text"}]},"url":"https://api.playhunt.io/public/1.00/white-label/delete-white-label-config"},"status":"OK","code":200,"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":null}],"_postman_id":"5cf85e5c-632c-436c-b11a-287470bf5fc6"},{"name":"get all white-label configs","id":"155a821c-fe76-43d8-8392-9e0f5c27aae1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"access-token","type":"text","value":"ZyKPWcr6PkaAk_accEssToKenExAmpLe"}],"body":{"mode":"formdata","formdata":[]},"url":"https://api.playhunt.io/public/1.00/white-label/get-all-white-label-configs","description":"

Endpoint to get all white-label configs.

\n","urlObject":{"protocol":"https","path":["public","1.00","white-label","get-all-white-label-configs"],"host":["api","playhunt","io"],"query":[],"variable":[]}},"response":[{"id":"fb6383ea-5e86-429f-ac16-05aa9a7da3e4","name":"get all white-label configs","originalRequest":{"method":"POST","header":[{"key":"access-token","type":"text","value":"ZyKPWcr6PkaAk_accEssToKenExAmpLe"}],"body":{"mode":"formdata","formdata":[]},"url":"https://api.playhunt.io/public/1.00/white-label/get-all-white-label-configs"},"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"[\n {\n \"guid\": \"7lx5f9hn\",\n \"domain\": \"customdomain\",\n \"color\": \"#34495e\",\n \"logo_path\": \"https://playhunt.io/path_to_file/file.png\",\n \"page_lang\": \"en\",\n \"text_title\": \"Custom Title\",\n \"text_body\": \"Custom Body\",\n \"is_default\": 0,\n \"created_at\": 1636153353,\n \"updated_at\": 1636207582\n },\n {\n \"guid\": \"gyj8bskl\",\n \"domain\": \"mydomain\",\n \"color\": \"#34495e\",\n \"logo_path\": \"https://playhunt.io/path_to_file/file.png\",\n \"page_lang\": \"en\",\n \"text_title\": \"Custom Title 2\",\n \"text_body\": \"Custom Body 2\",\n \"is_default\": 1,\n \"created_at\": 1636153353,\n \"updated_at\": 1636207582\n }\n]"}],"_postman_id":"155a821c-fe76-43d8-8392-9e0f5c27aae1"},{"name":"get white-label config","id":"aaf5dc0c-35a1-4a19-bd04-09f9d1f8f711","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"access-token","type":"text","value":"ZyKPWcr6PkaAk_accEssToKenExAmpLe"}],"body":{"mode":"formdata","formdata":[{"key":"guid","value":"sh33hx8b","type":"text"}]},"url":"https://api.playhunt.io/public/1.00/white-label/get-white-label-config","description":"

Endpoint to get an existing white-label config by guid

\n","urlObject":{"protocol":"https","path":["public","1.00","white-label","get-white-label-config"],"host":["api","playhunt","io"],"query":[],"variable":[]}},"response":[{"id":"a022a2b8-9442-433b-bdac-ce065d3ef5f1","name":"get white-label config","originalRequest":{"method":"POST","header":[{"key":"access-token","type":"text","value":"ZyKPWcr6PkaAk_accEssToKenExAmpLe"}],"body":{"mode":"formdata","formdata":[{"key":"guid","value":"7lx5f9hn","type":"text"}]},"url":"https://api.playhunt.io/public/1.00/white-label/get-white-label-config"},"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"guid\": \"7lx5f9hn\",\n \"domain\": \"customdomain\",\n \"color\": \"#8e44ad\",\n \"logo_path\": \"https://playhunt.io/path_to_file/file.png\",\n \"page_lang\": \"en\",\n \"text_title\": \"Custom Title\",\n \"text_body\": \"Custom Body\",\n \"is_default\": 0,\n \"created_at\": 1636207497,\n \"updated_at\": 1636207497\n}"}],"_postman_id":"aaf5dc0c-35a1-4a19-bd04-09f9d1f8f711"},{"name":"assign white-label config to the interview","id":"df29fe52-561d-4481-9644-edae786c75f3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"access-token","type":"text","value":"ZyKPWcr6PkaAk_accEssToKenExAmpLe"}],"body":{"mode":"formdata","formdata":[{"key":"whiteLabelGuid","value":"hno1nbov","type":"text"},{"key":"interviewGuid","value":"hhqflikl","type":"text"}]},"url":"https://api.playhunt.io/public/1.00/white-label/assign-white-label-config-to-interview","description":"

Endpoint to assign specific white-label config to the interview. The server will return a response with the status 200-OK if the assign operation will have done successfully

\n","urlObject":{"protocol":"https","path":["public","1.00","white-label","assign-white-label-config-to-interview"],"host":["api","playhunt","io"],"query":[],"variable":[]}},"response":[{"id":"09f8ac9d-d78a-4075-b24b-8271af06532e","name":"assign white-label config to the interview","originalRequest":{"method":"POST","header":[{"key":"access-token","type":"text","value":"ZyKPWcr6PkaAk_accEssToKenExAmpLe"}],"body":{"mode":"formdata","formdata":[{"key":"whiteLabelGuid","value":"hno1nbov","type":"text"},{"key":"interviewGuid","value":"hhqflikl","type":"text"}]},"url":"https://api.playhunt.io/public/1.00/white-label/assign-white-label-config-to-interview"},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":null}],"_postman_id":"df29fe52-561d-4481-9644-edae786c75f3"},{"name":"unassign white-label config from the interview","id":"a6da4719-0952-494b-9183-3fc79a4f4058","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"access-token","type":"text","value":"ZyKPWcr6PkaAk_accEssToKenExAmpLe"}],"body":{"mode":"formdata","formdata":[{"key":"interviewGuid","value":"hhqflikl","type":"text"}]},"url":"https://api.playhunt.io/public/1.00/white-label/unassign-white-label-config-from-interview","description":"

Endpoint to unassign specific white-label config to the interview. The server will return a response with the status 200-OK if the unassign operation will have done successfully

\n","urlObject":{"protocol":"https","path":["public","1.00","white-label","unassign-white-label-config-from-interview"],"host":["api","playhunt","io"],"query":[],"variable":[]}},"response":[{"id":"5117ea78-e34e-49fe-9bcb-572f8d5bb1b8","name":"unassign white-label config from the interview","originalRequest":{"method":"POST","header":[{"key":"access-token","type":"text","value":"ZyKPWcr6PkaAk_accEssToKenExAmpLe"},{"key":"","value":"","type":"text","disabled":true}],"body":{"mode":"formdata","formdata":[{"key":"interviewGuid","value":"kepfol09","type":"text"}]},"url":"https://api.playhunt.io/public/1.00/white-label/unassign-white-label-config-from-interview"},"status":"OK","code":200,"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":null}],"_postman_id":"a6da4719-0952-494b-9183-3fc79a4f4058"},{"name":"get available page langs","id":"c0c644f1-b513-4e14-9c69-f8fa27523e98","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"access-token","type":"text","value":"ZyKPWcr6PkaAk_accEssToKenExAmpLe"}],"body":{"mode":"formdata","formdata":[]},"url":"https://api.playhunt.io/public/1.00/white-label/get-available-page-langs","description":"

Endpoint to get a dictionary of all acceptable passing interview page languages

\n","urlObject":{"protocol":"https","path":["public","1.00","white-label","get-available-page-langs"],"host":["api","playhunt","io"],"query":[],"variable":[]}},"response":[{"id":"82e2e8d0-9258-4c8f-9277-b4e150220a08","name":"get available page langs","originalRequest":{"method":"POST","header":[{"key":"access-token","type":"text","value":"ZyKPWcr6PkaAk_accEssToKenExAmpLe"}],"body":{"mode":"formdata","formdata":[]},"url":"https://api.playhunt.io/public/1.00/white-label/get-available-page-langs"},"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"[\n \"en\",\n \"ua\",\n \"ru\",\n \"it\",\n \"vn\",\n \"fr\",\n \"es\",\n \"id\"\n]"}],"_postman_id":"c0c644f1-b513-4e14-9c69-f8fa27523e98"},{"name":"get available page colors","id":"c53f8247-9a52-4957-9f15-47a697fd32cf","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"access-token","type":"text","value":"ZyKPWcr6PkaAk_accEssToKenExAmpLe"}],"body":{"mode":"formdata","formdata":[]},"url":"https://api.playhunt.io/public/1.00/white-label/get-available-page-colors","description":"

Endpoint to get a dictionary of all acceptable passing interview page colors

\n","urlObject":{"protocol":"https","path":["public","1.00","white-label","get-available-page-colors"],"host":["api","playhunt","io"],"query":[],"variable":[]}},"response":[{"id":"6ae91fde-1d76-4658-b3d0-6d79426ac322","name":"get available page colors","originalRequest":{"method":"POST","header":[{"key":"access-token","type":"text","value":"ZyKPWcr6PkaAk_accEssToKenExAmpLe"}],"body":{"mode":"formdata","formdata":[]},"url":"https://api.playhunt.io/public/1.00/white-label/get-available-page-colors"},"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"[\n \"#1abc9c\",\n \"#27ae60\",\n \"#3498db\",\n \"#2980b9\",\n \"#8e44ad\",\n \"#f368e0\",\n \"#e1b12c\",\n \"#f18024\",\n \"#e74c3c\",\n \"#34495e\"\n]"}],"_postman_id":"c53f8247-9a52-4957-9f15-47a697fd32cf"}],"id":"86c2d714-46d5-4126-bf32-c38e145227ee","description":"

White-label configs help companies to customize the look of passing interview pages. \nWhite-label config can be used as the default for all company interviews (field isDefault). Also white-label can be assigned to the specific interviews (see: 'assign white-label config to the interview' and 'unassign white-label config from the interview').

\n

Priority of assigned white-label configs is higher than the default one.

\n

The company can have any number of white-label configs but only one can be the default.

\n

White-label config fields description:

\n\n","_postman_id":"86c2d714-46d5-4126-bf32-c38e145227ee"}]}