{ "variable": [ { "id": "baseUrl", "key": "baseUrl", "type": "string", "name": "string", "value": "https:\/\/dashboard.yourstoryz.com" } ], "info": { "name": "YourStoryz API Documentation", "_postman_id": "35fcd312-d33b-4c3e-8ee7-7b641f21f79a", "description": "This documentation aims to provide all the information you need to work with our API.", "schema": "https:\/\/schema.getpostman.com\/json\/collection\/v2.1.0\/collection.json" }, "item": [ { "name": "Users", "description": "", "item": [ { "name": "Get published videos", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/users\/:user_id\/published-videos", "query": [], "raw": "{{baseUrl}}\/api\/v1\/users\/:user_id\/published-videos", "variable": [ { "id": "user_id", "key": "user_id", "value": "507", "description": "The ID of the user." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "", "auth": { "type": "noauth" } }, "response": [ { "header": [], "code": 200, "body": "[{\"id\":1830,\"orientation\":null,\"video_url\":\"https:\\\/\\\/yourstoryz.s3.eu-west-2.amazonaws.com\\\/7uUHlRqbNfbvD8whagB4CdN9XAn5X3HFMBNaq1G2l45j8pmWz6wqD5cgCub9fgn4kPfRAUxBoDQKqPRIMwaH6wE45Ro47jPbdZm1\",\"thumbnail_url\":null,\"contents\":[],\"created_at\":\"2025-10-13T09:42:40.000000Z\"},{\"id\":1831,\"orientation\":null,\"video_url\":\"https:\\\/\\\/yourstoryz.s3.eu-west-2.amazonaws.com\\\/iRNHGpMBvkPJpdkUd2RxPzuDggV2hsMGxksTO8ew3tXi6tkStCRU6Sq55JGU14FGbrM3pas9dkPQBeLnvisfiQlYGYhFN5XHPWZi\",\"thumbnail_url\":null,\"contents\":[],\"created_at\":\"2025-10-13T09:42:40.000000Z\"}]", "name": "" } ] }, { "name": "Get stories", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/users\/:user_id\/stories", "query": [], "raw": "{{baseUrl}}\/api\/v1\/users\/:user_id\/stories", "variable": [ { "id": "user_id", "key": "user_id", "value": "507", "description": "The ID of the user." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "", "auth": { "type": "noauth" } }, "response": [ { "header": [], "code": 200, "body": "[{\"id\":1438,\"title\":\"Ab perspiciatis iure cum aut non.\",\"description\":null,\"video\":null,\"media\":[],\"author\":null,\"created_at\":\"2025-10-13T11:00:07.000000Z\",\"updated_at\":\"2025-10-13T11:00:07.000000Z\"},{\"id\":1439,\"title\":\"Nostrum quia fuga veritatis voluptatum.\",\"description\":null,\"video\":null,\"media\":[],\"author\":null,\"created_at\":\"2025-10-13T11:00:07.000000Z\",\"updated_at\":\"2025-10-13T11:00:07.000000Z\"}]", "name": "" } ] } ] }, { "name": "Companies", "description": "APIs for managing companies", "item": [ { "name": "Get settings", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/companies\/:company_id\/settings", "query": [], "raw": "{{baseUrl}}\/api\/v1\/companies\/:company_id\/settings", "variable": [ { "id": "company_id", "key": "company_id", "value": "116", "description": "The ID of the company." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{\"caption_background\":\"#F7F9FC\",\"caption_background_opacity\":100,\"caption_title_color\":\"#38416F\",\"caption_title_color_opacity\":100,\"caption_sub_title_color\":\"#4F5B9C\",\"caption_sub_title_color_opacity\":100,\"video_pre_post_loader_removable\":false}", "name": "" } ] }, { "name": "Get companies", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/companies", "query": [], "raw": "{{baseUrl}}\/api\/v1\/companies" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [], "code": 200, "body": "[{\"id\":400,\"name\":\"Price Ltd\",\"logo\":\"c400-(02-04-2026_14-55-37).\",\"logo_url\":\"https:\\\/\\\/dashboard.yourstoryz.com\\\/storage\\\/logos\\\/c400-(02-04-2026_14-55-37).\",\"phone\":null,\"website\":\"https:\\\/\\\/leuschke.com\\\/et-et-modi-ipsum-nostrum.html\",\"country\":null,\"address\":null,\"postcode\":null,\"place\":null,\"vat_id\":null,\"coc_number\":null,\"bank_ascription\":null,\"bank_account_number\":null,\"owner_id\":5567,\"created_at\":\"2026-04-02T14:55:37.000000Z\",\"updated_at\":\"2026-04-02T14:55:37.000000Z\"},{\"id\":401,\"name\":\"Feeney, Leffler and Glover\",\"logo\":\"c401-(02-04-2026_14-55-37).\",\"logo_url\":\"https:\\\/\\\/dashboard.yourstoryz.com\\\/storage\\\/logos\\\/c401-(02-04-2026_14-55-37).\",\"phone\":null,\"website\":\"http:\\\/\\\/www.haag.org\\\/distinctio-eum-doloremque-id-aut-libero-aliquam-veniam-corporis\",\"country\":null,\"address\":null,\"postcode\":null,\"place\":null,\"vat_id\":null,\"coc_number\":null,\"bank_ascription\":null,\"bank_account_number\":null,\"owner_id\":5568,\"created_at\":\"2026-04-02T14:55:37.000000Z\",\"updated_at\":\"2026-04-02T14:55:37.000000Z\"}]", "name": "" } ] }, { "name": "Get company", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/companies\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v1\/companies\/:id", "variable": [ { "id": "id", "key": "id", "value": "116", "description": "The ID of the company." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{\"id\":402,\"name\":\"Price Ltd\",\"logo\":\"c402-(02-04-2026_14-55-37).\",\"logo_url\":\"https:\\\/\\\/dashboard.yourstoryz.com\\\/storage\\\/logos\\\/c402-(02-04-2026_14-55-37).\",\"phone\":null,\"website\":\"https:\\\/\\\/leuschke.com\\\/et-et-modi-ipsum-nostrum.html\",\"country\":null,\"address\":null,\"postcode\":null,\"place\":null,\"vat_id\":null,\"coc_number\":null,\"bank_ascription\":null,\"bank_account_number\":null,\"owner_id\":5569,\"created_at\":\"2026-04-02T14:55:37.000000Z\",\"updated_at\":\"2026-04-02T14:55:37.000000Z\"}", "name": "" } ] }, { "name": "Get departments", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/companies\/:company_id\/departments", "query": [], "raw": "{{baseUrl}}\/api\/v1\/companies\/:company_id\/departments", "variable": [ { "id": "company_id", "key": "company_id", "value": "116", "description": "The ID of the company." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [], "code": 200, "body": "[{\"id\":217,\"name\":\"Price Ltd\",\"email\":\"dare.emelie@baumbach.org\",\"company_id\":403,\"created_at\":\"02-04-2026\",\"updated_at\":\"2026-04-02T14:55:37.000000Z\",\"logo\":null},{\"id\":218,\"name\":\"Gaylord, Hettinger and Nitzsche\",\"email\":\"mcdermott.verlie@mayer.com\",\"company_id\":404,\"created_at\":\"02-04-2026\",\"updated_at\":\"2026-04-02T14:55:37.000000Z\",\"logo\":null}]", "name": "" } ] }, { "name": "Get stories", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/companies\/:company_id\/stories", "query": [], "raw": "{{baseUrl}}\/api\/v1\/companies\/:company_id\/stories", "variable": [ { "id": "company_id", "key": "company_id", "value": "116", "description": "The ID of the company." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "", "auth": { "type": "noauth" } }, "response": [ { "header": [], "code": 200, "body": "[{\"id\":1440,\"title\":\"Nostrum ut id autem sint ut.\",\"description\":null,\"video\":null,\"media\":[],\"author\":null,\"created_at\":\"2025-10-13T11:00:07.000000Z\",\"updated_at\":\"2025-10-13T11:00:07.000000Z\"},{\"id\":1441,\"title\":\"Consequatur commodi nostrum quae est reprehenderit et.\",\"description\":null,\"video\":null,\"media\":[],\"author\":null,\"created_at\":\"2025-10-13T11:00:07.000000Z\",\"updated_at\":\"2025-10-13T11:00:07.000000Z\"}]", "name": "" } ] }, { "name": "Get published videos", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/companies\/:company_id\/published-videos", "query": [], "raw": "{{baseUrl}}\/api\/v1\/companies\/:company_id\/published-videos", "variable": [ { "id": "company_id", "key": "company_id", "value": "116", "description": "The ID of the company." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "", "auth": { "type": "noauth" } }, "response": [ { "header": [], "code": 200, "body": "[{\"id\":1832,\"orientation\":null,\"video_url\":\"https:\\\/\\\/yourstoryz.s3.eu-west-2.amazonaws.com\\\/2TMZfDAbVw7FIcv111B566x9u8XYfO5PXBop9DRnJ0bkweCp6vgoCqiwmmwkCVnuL2eW7FqQ5rcczBAsUp0kS7Na1FaoEPZtLpg0\",\"thumbnail_url\":null,\"contents\":[],\"created_at\":\"2025-10-13T09:42:40.000000Z\"},{\"id\":1833,\"orientation\":null,\"video_url\":\"https:\\\/\\\/yourstoryz.s3.eu-west-2.amazonaws.com\\\/AXFZKpTFitPtrgXZRR2u4Ayt8B94QjtYLOucFRPJ6QV7UqlVvo7pkp7yZZhgH3sUPawVih5B5PmAM1ztSZ4A2snQxiEMk9lMUSS1\",\"thumbnail_url\":null,\"contents\":[],\"created_at\":\"2025-10-13T09:42:40.000000Z\"}]", "name": "" } ] } ] }, { "name": "Departments", "description": "APIs for managing departments", "item": [ { "name": "Get settings", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/departments\/:department_id\/settings", "query": [], "raw": "{{baseUrl}}\/api\/v1\/departments\/:department_id\/settings", "variable": [ { "id": "department_id", "key": "department_id", "value": "99", "description": "The ID of the department." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{\"caption_background\":\"#F7F9FC\",\"caption_background_opacity\":100,\"caption_title_color\":\"#38416F\",\"caption_title_color_opacity\":100,\"caption_sub_title_color\":\"#4F5B9C\",\"caption_sub_title_color_opacity\":100,\"video_pre_post_loader_removable\":false}", "name": "" } ] }, { "name": "Get departments", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/departments", "query": [], "raw": "{{baseUrl}}\/api\/v1\/departments" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [], "code": 200, "body": "[{\"id\":219,\"name\":\"Price Ltd\",\"email\":\"ferne52@okeefe.net\",\"company_id\":405,\"created_at\":\"02-04-2026\",\"updated_at\":\"2026-04-02T14:55:37.000000Z\",\"logo\":null},{\"id\":220,\"name\":\"Mayer-Kutch\",\"email\":\"oking@cartwright.com\",\"company_id\":406,\"created_at\":\"02-04-2026\",\"updated_at\":\"2026-04-02T14:55:37.000000Z\",\"logo\":null}]", "name": "" } ] }, { "name": "Get department", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/departments\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v1\/departments\/:id", "variable": [ { "id": "id", "key": "id", "value": "99", "description": "The ID of the department." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{\"id\":221,\"name\":\"Price Ltd\",\"email\":\"christian51@leffler.com\",\"company_id\":407,\"created_at\":\"02-04-2026\",\"updated_at\":\"2026-04-02T14:55:37.000000Z\",\"logo\":null}", "name": "" } ] }, { "name": "Get stories", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/departments\/:department_id\/stories", "query": [], "raw": "{{baseUrl}}\/api\/v1\/departments\/:department_id\/stories", "variable": [ { "id": "department_id", "key": "department_id", "value": "99", "description": "The ID of the department." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "", "auth": { "type": "noauth" } }, "response": [ { "header": [], "code": 200, "body": "[{\"id\":1442,\"title\":\"Sit nostrum aut dolorem blanditiis.\",\"description\":null,\"video\":null,\"media\":[],\"author\":null,\"created_at\":\"2025-10-13T11:00:07.000000Z\",\"updated_at\":\"2025-10-13T11:00:07.000000Z\"},{\"id\":1443,\"title\":\"Qui magni qui assumenda sint.\",\"description\":null,\"video\":null,\"media\":[],\"author\":null,\"created_at\":\"2025-10-13T11:00:07.000000Z\",\"updated_at\":\"2025-10-13T11:00:07.000000Z\"}]", "name": "" } ] }, { "name": "Get published videos", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/departments\/:department_id\/published-videos", "query": [], "raw": "{{baseUrl}}\/api\/v1\/departments\/:department_id\/published-videos", "variable": [ { "id": "department_id", "key": "department_id", "value": "99", "description": "The ID of the department." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "", "auth": { "type": "noauth" } }, "response": [ { "header": [], "code": 200, "body": "[{\"id\":1834,\"orientation\":null,\"video_url\":\"https:\\\/\\\/yourstoryz.s3.eu-west-2.amazonaws.com\\\/gMubylRn0k2hIkqSIwMDHlRZ5eEyGeRor2fnxiIUb4Ukfvv2ddMUx4Vex92wbHhUbAE1dYRAm9PL2J4GtZOXTlRbB5mZFv3OAnVX\",\"thumbnail_url\":null,\"contents\":[],\"created_at\":\"2025-10-13T09:42:40.000000Z\"},{\"id\":1835,\"orientation\":null,\"video_url\":\"https:\\\/\\\/yourstoryz.s3.eu-west-2.amazonaws.com\\\/YdCQBfLlzpd20Aizcf3AlpBPS1ucn0phf2kpjwEjOyUpWJxcU1jbHJd2HJWVDHukvUcbmsSROirUIU9Xbn4hz0FspXRx6yhsQZTD\",\"thumbnail_url\":null,\"contents\":[],\"created_at\":\"2025-10-13T09:42:40.000000Z\"}]", "name": "" } ] } ] }, { "name": "Stories", "description": "APIs for managing stories", "item": [ { "name": "Get stories", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/stories", "query": [], "raw": "{{baseUrl}}\/api\/v1\/stories" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [], "code": 200, "body": "[{\"id\":1465,\"title\":\"Mollitia et quos exercitationem dolore aut.\",\"description\":null,\"video\":null,\"media\":[],\"author\":null,\"location\":[-15.917464,-71.60898],\"location_description\":null,\"created_at\":\"2026-04-02T14:55:37.000000Z\",\"updated_at\":\"2026-04-02T14:55:37.000000Z\"},{\"id\":1466,\"title\":\"Vel temporibus quibusdam laborum reprehenderit.\",\"description\":null,\"video\":null,\"media\":[],\"author\":null,\"location\":[-9.225575,77.065306],\"location_description\":null,\"created_at\":\"2026-04-02T14:55:37.000000Z\",\"updated_at\":\"2026-04-02T14:55:37.000000Z\"}]", "name": "" } ] }, { "name": "Create story", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/stories", "query": [], "raw": "{{baseUrl}}\/api\/v1\/stories" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "multipart\/form-data" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "formdata", "formdata": [ { "key": "storiable_type", "value": "b", "type": "text", "description": "Must not be greater than 255 characters." }, { "key": "storiable_id", "value": "16", "type": "text", "description": "" }, { "key": "title", "value": "n", "type": "text", "description": "Must not be greater than 255 characters." }, { "key": "description", "value": "Eius et animi quos velit et.", "type": "text", "description": "" }, { "key": "metadata", "value": "[\"architecto\",\"architecto\"]", "type": "text", "description": "Must be a valid JSON string." }, { "key": "duration", "value": "16", "type": "text", "description": "" }, { "key": "channel", "value": "architecto", "type": "text", "description": "" }, { "key": "posts", "value": "[\"architecto\",\"architecto\"]", "type": "text", "description": "Must be a valid JSON string." }, { "key": "location[latitude]", "value": "-179", "type": "text", "description": "" }, { "key": "location[longitude]", "value": "-89", "type": "text", "description": "" }, { "key": "location_description", "value": "architecto", "type": "text", "description": "" }, { "key": "channels[0][channel]", "value": "architecto", "type": "text", "description": "" }, { "key": "channels[0][channel_folders][0]", "value": "architecto", "type": "text", "description": "" }, { "key": "file", "src": [], "type": "file" }, { "key": "thumbnail", "src": [], "type": "file" }, { "key": "media[]", "src": [], "type": "file" } ] }, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{\"id\":1467,\"title\":\"Mollitia modi deserunt aut ab provident perspiciatis quo.\",\"description\":null,\"video\":null,\"media\":[],\"author\":null,\"location\":[-175.353288,-25.59289],\"location_description\":null,\"created_at\":\"2026-04-02T14:55:38.000000Z\",\"updated_at\":\"2026-04-02T14:55:38.000000Z\"}", "name": "" } ] }, { "name": "Get story", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/stories\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v1\/stories\/:id", "variable": [ { "id": "id", "key": "id", "value": "1", "description": "The ID of the story." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{\"id\":1468,\"title\":\"Modi ipsum nostrum omnis autem et.\",\"description\":null,\"video\":null,\"media\":[],\"author\":null,\"location\":[-48.641047,-45.649001],\"location_description\":null,\"created_at\":\"2026-04-02T14:55:38.000000Z\",\"updated_at\":\"2026-04-02T14:55:38.000000Z\"}", "name": "" } ] }, { "name": "Update story", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/stories\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v1\/stories\/:id", "variable": [ { "id": "id", "key": "id", "value": "1", "description": "The ID of the story." } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [] }, { "name": "Delete story", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/stories\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v1\/stories\/:id", "variable": [ { "id": "id", "key": "id", "value": "1", "description": "The ID of the story." } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [] } ] }, { "name": "Published Videos", "description": "APIs for managing published videos", "item": [ { "name": "Get published video", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/published-videos\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v1\/published-videos\/:id", "variable": [ { "id": "id", "key": "id", "value": "304", "description": "The ID of the published video." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{\"id\":1931,\"orientation\":null,\"video_url\":\"https:\\\/\\\/yourstoryz.s3.eu-west-2.amazonaws.com\\\/WmKhFTK8uB3ENNmrI0c6sQisnmTJqhbbvmg37gBNInbLbsGi2hxcUki2A9jCDWKdx9ui35o10F8Aan4n0n9SNNxt2VKvquNZZqOT\",\"thumbnail_url\":null,\"contents\":[],\"created_at\":\"2026-04-02T14:55:38.000000Z\"}", "name": "" } ] } ] }, { "name": "Endpoints", "description": "", "item": [ { "name": "GET api\/v1\/users\/me", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/users\/me", "query": [], "raw": "{{baseUrl}}\/api\/v1\/users\/me" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "vary", "value": "Origin" } ], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "" } ] } ] } ], "auth": { "type": "bearer", "bearer": [ { "key": "key", "type": "string" } ] } }