{ "variable": [ { "id": "baseUrl", "key": "baseUrl", "type": "string", "name": "string", "value": "http:\/\/localhost" } ], "info": { "name": "RosettaChat API Documentation", "_postman_id": "236ea10b-8f83-43ec-ae4d-0b7ae40e9e3a", "description": "RosettaChat V1 API for authentication, file staging, Workspace Channel chat, Direct Chat, attachments, automation, and webhooks.", "schema": "https:\/\/schema.getpostman.com\/json\/collection\/v2.1.0\/collection.json", "version": "1.0.0" }, "item": [ { "name": "App Authentication", "description": "\nToken-based authentication APIs for native mobile\/desktop applications", "item": [ { "name": "Register", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/auth\/app\/register", "query": [], "raw": "{{baseUrl}}\/api\/v1\/auth\/app\/register" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"name\":\"John Doe\",\"email\":\"john@example.com\",\"password\":\"secretpassword\",\"preferred_language\":\"id\",\"password_confirmation\":\"secretpassword\",\"device_name\":\"iPhone 15 Pro\"}" }, "description": "Create a new user account and return an access token.", "auth": { "type": "noauth" } }, "response": [ { "header": [], "code": 200, "body": "{\n \"access_token\": \"1|abc123...\",\n \"token_type\": \"Bearer\",\n \"user\": {\"id\": 1, \"name\": \"John Doe\", \"email\": \"john@example.com\"}\n}", "name": "" }, { "header": [], "code": 422, "body": "{\n \"message\": \"The given data was invalid.\",\n \"errors\": {\"email\": [\"This email is already registered.\"]}\n}", "name": "Validation error" } ] }, { "name": "Login", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/auth\/app\/login", "query": [], "raw": "{{baseUrl}}\/api\/v1\/auth\/app\/login" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"email\":\"john@example.com\",\"password\":\"secretpassword\",\"device_name\":\"iPhone 15 Pro\"}" }, "description": "Authenticate user with email and password, return an access token.", "auth": { "type": "noauth" } }, "response": [ { "header": [], "code": 200, "body": "{\n \"access_token\": \"1|abc123...\",\n \"token_type\": \"Bearer\",\n \"user\": {\"id\": 1, \"name\": \"John Doe\", \"email\": \"john@example.com\"}\n}", "name": "" }, { "header": [], "code": 403, "body": "{\n \"message\": \"Account is inactive.\"\n}", "name": "Account inactive" }, { "header": [], "code": 422, "body": "{\n \"message\": \"The given data was invalid.\",\n \"errors\": {\"email\": [\"The provided credentials are incorrect.\"]}\n}", "name": "Invalid credentials" } ] }, { "name": "Request OTP", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/auth\/app\/otp", "query": [], "raw": "{{baseUrl}}\/api\/v1\/auth\/app\/otp" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"email\":\"john@example.com\"}" }, "description": "Send a One-Time Password to the user's email for passwordless authentication.", "auth": { "type": "noauth" } }, "response": [ { "header": [], "code": 200, "body": "{\n \"message\": \"OTP sent to your email.\"\n}", "name": "" }, { "header": [], "code": 422, "body": "{\n \"message\": \"The given data was invalid.\",\n \"errors\": {\"email\": [\"The email field must be a valid email address.\"]}\n}", "name": "Validation error" } ] }, { "name": "Verify OTP", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/auth\/app\/otp\/verify", "query": [], "raw": "{{baseUrl}}\/api\/v1\/auth\/app\/otp\/verify" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"email\":\"john@example.com\",\"token\":\"123456\",\"device_name\":\"iPhone 15 Pro\"}" }, "description": "Verify the One-Time Password and return an access token.\nCreates a new account if the email is not registered.", "auth": { "type": "noauth" } }, "response": [ { "header": [], "code": 200, "body": "{\n \"access_token\": \"1|abc123...\",\n \"token_type\": \"Bearer\",\n \"user\": {\"id\": 1, \"name\": \"john\", \"email\": \"john@example.com\"}\n}", "name": "" }, { "header": [], "code": 403, "body": "{\n \"message\": \"Account is inactive.\"\n}", "name": "Account inactive" }, { "header": [], "code": 422, "body": "{\n \"message\": \"The given data was invalid.\",\n \"errors\": {\"token\": [\"Invalid or expired OTP.\"]}\n}", "name": "Invalid OTP" } ] }, { "name": "Forgot Password", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/auth\/app\/forgot-password", "query": [], "raw": "{{baseUrl}}\/api\/v1\/auth\/app\/forgot-password" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"email\":\"john@example.com\"}" }, "description": "Send a password reset link to the user's email.", "auth": { "type": "noauth" } }, "response": [ { "header": [], "code": 200, "body": "{\n \"message\": \"Password reset link sent to your email.\"\n}", "name": "" }, { "header": [], "code": 422, "body": "{\n \"message\": \"The given data was invalid.\",\n \"errors\": {\"email\": [\"We could not find an account with that email.\"]}\n}", "name": "Email not found" } ] }, { "name": "Reset Password", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/auth\/app\/reset-password", "query": [], "raw": "{{baseUrl}}\/api\/v1\/auth\/app\/reset-password" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"token\":\"abc123def456...\",\"email\":\"john@example.com\",\"password\":\"newsecretpassword\",\"password_confirmation\":\"newsecretpassword\"}" }, "description": "Reset the user's password using the reset token.", "auth": { "type": "noauth" } }, "response": [ { "header": [], "code": 200, "body": "{\n \"message\": \"Password has been reset successfully.\"\n}", "name": "" }, { "header": [], "code": 422, "body": "{\n \"message\": \"The given data was invalid.\",\n \"errors\": {\"email\": [\"This password reset token is invalid.\"]}\n}", "name": "Invalid token" } ] }, { "name": "Logout", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/auth\/app\/logout", "query": [], "raw": "{{baseUrl}}\/api\/v1\/auth\/app\/logout" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Revoke the current access token." }, "response": [ { "header": [], "code": 200, "body": "{\n \"message\": \"Logged out successfully.\"\n}", "name": "" }, { "header": [], "code": 401, "body": "{\n \"message\": \"Unauthenticated.\"\n}", "name": "Unauthenticated" } ] }, { "name": "Change Password", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/auth\/app\/change-password", "query": [], "raw": "{{baseUrl}}\/api\/v1\/auth\/app\/change-password" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"current_password\":\"oldsecretpassword\",\"password\":\"newsecretpassword\",\"password_confirmation\":\"newsecretpassword\"}" }, "description": "Change the authenticated user's password." }, "response": [ { "header": [], "code": 200, "body": "{\n \"message\": \"Password changed successfully.\"\n}", "name": "" }, { "header": [], "code": 401, "body": "{\n \"message\": \"Unauthenticated.\"\n}", "name": "Unauthenticated" }, { "header": [], "code": 422, "body": "{\n \"message\": \"The given data was invalid.\",\n \"errors\": {\"current_password\": [\"The current password is incorrect.\"]}\n}", "name": "Wrong current password" } ] } ] }, { "name": "App Authentication - Social", "description": "\nToken-based social authentication APIs for native mobile\/desktop applications", "item": [ { "name": "Get OAuth Redirect URL", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/auth\/app\/social\/:provider\/redirect", "query": [], "raw": "{{baseUrl}}\/api\/v1\/auth\/app\/social\/:provider\/redirect", "variable": [ { "id": "provider", "key": "provider", "value": "google", "description": "The OAuth provider name." } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Get the OAuth redirect URL for the specified provider.\nThe client should open this URL in a browser to start the OAuth flow.", "auth": { "type": "noauth" } }, "response": [ { "header": [], "code": 200, "body": "{\n \"redirect_url\": \"https:\/\/accounts.google.com\/o\/oauth2\/v2\/auth?...\"\n}", "name": "" }, { "header": [], "code": 422, "body": "{\n \"message\": \"The given data was invalid.\",\n \"errors\": {\"provider\": [\"The selected provider is invalid.\"]}\n}", "name": "Invalid provider" } ] }, { "name": "OAuth Callback", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/auth\/app\/social\/:provider\/callback", "query": [], "raw": "{{baseUrl}}\/api\/v1\/auth\/app\/social\/:provider\/callback", "variable": [ { "id": "provider", "key": "provider", "value": "google", "description": "The OAuth provider name." } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"code\":\"4\\\/0AfJohXn...\",\"state\":\"xyz123\",\"device_name\":\"iPhone 15 Pro\"}" }, "description": "Exchange the OAuth code for an access token and authenticate the user.\nReturns a Bearer token for subsequent API requests.", "auth": { "type": "noauth" } }, "response": [ { "header": [], "code": 200, "body": "{\n \"access_token\": \"1|abc123...\",\n \"token_type\": \"Bearer\",\n \"user\": {\"id\": 1, \"name\": \"John Doe\", \"email\": \"john@example.com\"}\n}", "name": "" }, { "header": [], "code": 403, "body": "{\n \"message\": \"Account is inactive.\"\n}", "name": "Account inactive" }, { "header": [], "code": 422, "body": "{\n \"message\": \"The given data was invalid.\",\n \"errors\": {\"provider\": [\"The selected provider is invalid.\"]}\n}", "name": "Invalid provider" } ] }, { "name": "List Linked Accounts", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/auth\/app\/social\/accounts", "query": [], "raw": "{{baseUrl}}\/api\/v1\/auth\/app\/social\/accounts" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Get all social accounts linked to the authenticated user." }, "response": [ { "header": [], "code": 200, "body": "{\n \"accounts\": [\n {\"id\": 1, \"provider\": \"google\", \"provider_email\": \"john@gmail.com\", \"name\": \"John Doe\", \"avatar\": \"https:\/\/...\", \"created_at\": \"2024-01-01T00:00:00.000000Z\"}\n ]\n}", "name": "" }, { "header": [], "code": 401, "body": "{\n \"message\": \"Unauthenticated.\"\n}", "name": "Unauthenticated" } ] }, { "name": "Link Social Account", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/auth\/app\/social\/:provider\/link", "query": [], "raw": "{{baseUrl}}\/api\/v1\/auth\/app\/social\/:provider\/link", "variable": [ { "id": "provider", "key": "provider", "value": "google", "description": "The OAuth provider name." } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Link a new social account to the authenticated user.\nReturns the OAuth redirect URL for the linking flow." }, "response": [ { "header": [], "code": 200, "body": "{\n \"redirect_url\": \"https:\/\/accounts.google.com\/o\/oauth2\/v2\/auth?...\"\n}", "name": "" }, { "header": [], "code": 401, "body": "{\n \"message\": \"Unauthenticated.\"\n}", "name": "Unauthenticated" }, { "header": [], "code": 422, "body": "{\n \"message\": \"The given data was invalid.\",\n \"errors\": {\"provider\": [\"The selected provider is invalid.\"]}\n}", "name": "Invalid provider" } ] }, { "name": "Complete Link Social Account", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/auth\/app\/social\/:provider\/link\/callback", "query": [], "raw": "{{baseUrl}}\/api\/v1\/auth\/app\/social\/:provider\/link\/callback", "variable": [ { "id": "provider", "key": "provider", "value": "google", "description": "The OAuth provider name." } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"code\":\"4\\\/0AfJohXn...\",\"state\":\"architecto\",\"device_name\":\"n\"}" }, "description": "Complete the social account linking after OAuth callback." }, "response": [ { "header": [], "code": 200, "body": "{\n \"account\": {\"id\": 1, \"provider\": \"google\", \"provider_email\": \"john@gmail.com\", \"name\": \"John Doe\"},\n \"message\": \"Social account linked successfully.\"\n}", "name": "" }, { "header": [], "code": 401, "body": "{\n \"message\": \"Unauthenticated.\"\n}", "name": "Unauthenticated" }, { "header": [], "code": 422, "body": "{\n \"message\": \"This social account is already linked to your account.\"\n}", "name": "Already linked" }, { "header": [], "code": 422, "body": "{\n \"message\": \"This social account is already linked to another user.\"\n}", "name": "Linked to another user" } ] }, { "name": "Unlink Social Account", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/auth\/app\/social\/:provider\/unlink", "query": [], "raw": "{{baseUrl}}\/api\/v1\/auth\/app\/social\/:provider\/unlink", "variable": [ { "id": "provider", "key": "provider", "value": "google", "description": "The OAuth provider name." } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Remove a linked social account from the authenticated user." }, "response": [ { "header": [], "code": 200, "body": "{\n \"message\": \"Social account unlinked successfully.\"\n}", "name": "" }, { "header": [], "code": 401, "body": "{\n \"message\": \"Unauthenticated.\"\n}", "name": "Unauthenticated" }, { "header": [], "code": 404, "body": "{\n \"message\": \"Social account not found.\"\n}", "name": "Not found" }, { "header": [], "code": 422, "body": "{\n \"message\": \"Cannot unlink the last authentication method. Please set a password first.\"\n}", "name": "Last auth method" } ] } ] }, { "name": "Devices", "description": "", "item": [ { "name": "Register a push device.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/devices", "query": [], "raw": "{{baseUrl}}\/api\/v1\/devices" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"platform\":\"ios\",\"provider\":\"fcm\",\"push_token\":\"fGc1...token\",\"device_id\":\"7B3F2A10-...\",\"device_name\":\"John's iPhone\",\"app_version\":\"1.4.2\"}" }, "description": "Registers (or refreshes) the calling user's device for push\nnotifications. The push token is the identity: re-sending an existing\ntoken \u2014 even from a different account \u2014 transfers ownership so a\nrecycled device never receives the previous user's notifications.\nIdempotent; safe to call on every app launch." }, "response": [ { "header": [], "code": 201, "body": "{\"data\": {\"id\": \"01HX...\", \"platform\": \"ios\", \"provider\": \"fcm\", \"device_name\": \"John's iPhone\", \"last_used_at\": \"2026-05-17T10:00:00+00:00\"}}", "name": "" } ] }, { "name": "Unregister a push device.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/devices\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v1\/devices\/:id", "variable": [ { "id": "id", "key": "id", "value": "architecto", "description": "The ID of the device." }, { "id": "device", "key": "device", "value": "01HX...", "description": "The device id." } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Removes one of the caller's registered devices. Only the owner may\ndelete a device." }, "response": [ { "header": [], "code": 204, "body": "{}", "name": "" } ] } ] }, { "name": "Email Verification", "description": "\nVerify and resend email verification links.", "item": [ { "name": "Verify Email", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/auth\/email\/verify\/:id\/:hash", "query": [], "raw": "{{baseUrl}}\/api\/v1\/auth\/email\/verify\/:id\/:hash", "variable": [ { "id": "id", "key": "id", "value": "16", "description": "The user id encoded into the link." }, { "id": "hash", "key": "hash", "value": "architecto", "description": "The sha1(email) hash encoded into the link." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Confirms ownership of the email address via a temporary signed URL.\nOn success, redirects to the configured frontend URL when set,\notherwise returns a JSON success response.", "auth": { "type": "noauth" } }, "response": [ { "header": [], "code": 200, "body": "{\n \"message\": \"Email verified successfully.\"\n}", "name": "" }, { "header": [], "code": 404, "body": "{\n \"message\": \"Verification link is invalid.\"\n}", "name": "Invalid link" } ] }, { "name": "Resend Verification Email", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/auth\/email\/verification-notification", "query": [], "raw": "{{baseUrl}}\/api\/v1\/auth\/email\/verification-notification" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Re-sends the verification email to the authenticated user. Returns 200\neven when the account is already verified (to avoid leaking state)." }, "response": [ { "header": [], "code": 200, "body": "{\n \"message\": \"Verification email sent.\"\n}", "name": "" } ] } ] }, { "name": "Endpoints", "description": "", "item": [ { "name": "PATCH api\/v1\/me", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/me", "query": [], "raw": "{{baseUrl}}\/api\/v1\/me" }, "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"name\":\"b\",\"preferred_language\":\"zh-CN\",\"avatar_url\":\"http:\\\/\\\/bailey.com\\\/\"}" }, "description": "", "auth": { "type": "noauth" } }, "response": [] }, { "name": "Public preview of an invite so the join screen can show what the user is\nabout to join \u2014 even before they sign in.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/invites\/:token", "query": [], "raw": "{{baseUrl}}\/api\/v1\/invites\/:token", "variable": [ { "id": "token", "key": "token", "value": "architecto", "description": "" } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "", "auth": { "type": "noauth" } }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "x-ratelimit-limit", "value": "30" }, { "key": "x-ratelimit-remaining", "value": "29" }, { "key": "access-control-allow-origin", "value": "*" } ], "code": 404, "body": "{\"message\":\"This invite link is not valid.\"}", "name": "" } ] }, { "name": "Redeem an invite: add the authenticated user to the workspace.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/invites\/:token\/accept", "query": [], "raw": "{{baseUrl}}\/api\/v1\/invites\/:token\/accept", "variable": [ { "id": "token", "key": "token", "value": "architecto", "description": "" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "", "auth": { "type": "noauth" } }, "response": [] }, { "name": "GET api\/v1\/workspaces", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/workspaces", "query": [], "raw": "{{baseUrl}}\/api\/v1\/workspaces" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "", "auth": { "type": "noauth" } }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "access-control-allow-origin", "value": "*" } ], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "" } ] }, { "name": "POST api\/v1\/workspaces", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/workspaces", "query": [], "raw": "{{baseUrl}}\/api\/v1\/workspaces" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"name\":\"b\",\"slug\":\"n\",\"password\":\"|{+-0pBNvYgx\"}" }, "description": "", "auth": { "type": "noauth" } }, "response": [] }, { "name": "GET api\/v1\/workspaces\/{id}", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/workspaces\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v1\/workspaces\/:id", "variable": [ { "id": "id", "key": "id", "value": "01ktvxyqmbcm7abv91483q1hfd", "description": "The ID of the workspace." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "", "auth": { "type": "noauth" } }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "access-control-allow-origin", "value": "*" } ], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "" } ] }, { "name": "GET api\/v1\/direct-conversations", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/direct-conversations", "query": [], "raw": "{{baseUrl}}\/api\/v1\/direct-conversations" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "", "auth": { "type": "noauth" } }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "access-control-allow-origin", "value": "*" } ], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "" } ] }, { "name": "POST api\/v1\/direct-conversations", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/direct-conversations", "query": [], "raw": "{{baseUrl}}\/api\/v1\/direct-conversations" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"participant_user_id\":\"architecto\"}" }, "description": "", "auth": { "type": "noauth" } }, "response": [] }, { "name": "POST api\/v1\/direct-recipients\/resolve", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/direct-recipients\/resolve", "query": [], "raw": "{{baseUrl}}\/api\/v1\/direct-recipients\/resolve" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"email\":\"gbailey@example.net\"}" }, "description": "", "auth": { "type": "noauth" } }, "response": [] }, { "name": "GET api\/v1\/direct-conversations\/{conversation_id}\/messages", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/direct-conversations\/:conversation_id\/messages", "query": [], "raw": "{{baseUrl}}\/api\/v1\/direct-conversations\/:conversation_id\/messages", "variable": [ { "id": "conversation_id", "key": "conversation_id", "value": "01ktvxyqq8nx0zyqm8rtrcp3xa", "description": "The ID of the conversation." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "", "auth": { "type": "noauth" } }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "access-control-allow-origin", "value": "*" } ], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "" } ] }, { "name": "POST api\/v1\/direct-conversations\/{conversation_id}\/messages", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/direct-conversations\/:conversation_id\/messages", "query": [], "raw": "{{baseUrl}}\/api\/v1\/direct-conversations\/:conversation_id\/messages", "variable": [ { "id": "conversation_id", "key": "conversation_id", "value": "01ktvxyqq8nx0zyqm8rtrcp3xa", "description": "The ID of the conversation." } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"content\":\"architecto\",\"attachment_ids\":[\"architecto\"]}" }, "description": "", "auth": { "type": "noauth" } }, "response": [] }, { "name": "GET api\/v1\/message-attachments\/{attachment_id}\/download", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/message-attachments\/:attachment_id\/download", "query": [], "raw": "{{baseUrl}}\/api\/v1\/message-attachments\/:attachment_id\/download", "variable": [ { "id": "attachment_id", "key": "attachment_id", "value": "architecto", "description": "The ID of the attachment." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "", "auth": { "type": "noauth" } }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "access-control-allow-origin", "value": "*" } ], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "" } ] }, { "name": "GET api\/v1\/direct-message-attachments\/{attachment_id}\/download", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/direct-message-attachments\/:attachment_id\/download", "query": [], "raw": "{{baseUrl}}\/api\/v1\/direct-message-attachments\/:attachment_id\/download", "variable": [ { "id": "attachment_id", "key": "attachment_id", "value": "architecto", "description": "The ID of the attachment." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "", "auth": { "type": "noauth" } }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "access-control-allow-origin", "value": "*" } ], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "" } ] }, { "name": "GET api\/v1\/workspaces\/{workspace_id}\/channels", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/workspaces\/:workspace_id\/channels", "query": [], "raw": "{{baseUrl}}\/api\/v1\/workspaces\/:workspace_id\/channels", "variable": [ { "id": "workspace_id", "key": "workspace_id", "value": "01ktvxyqmbcm7abv91483q1hfd", "description": "The ID of the workspace." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "", "auth": { "type": "noauth" } }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "access-control-allow-origin", "value": "*" } ], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "" } ] }, { "name": "POST api\/v1\/workspaces\/{workspace_id}\/channels", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/workspaces\/:workspace_id\/channels", "query": [], "raw": "{{baseUrl}}\/api\/v1\/workspaces\/:workspace_id\/channels", "variable": [ { "id": "workspace_id", "key": "workspace_id", "value": "01ktvxyqmbcm7abv91483q1hfd", "description": "The ID of the workspace." } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"name\":\"b\",\"slug\":\"n\",\"password\":\"|{+-0pBNvYgx\"}" }, "description": "", "auth": { "type": "noauth" } }, "response": [] }, { "name": "PUT api\/v1\/workspaces\/{workspace_id}\/channels\/{id}", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/workspaces\/:workspace_id\/channels\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v1\/workspaces\/:workspace_id\/channels\/:id", "variable": [ { "id": "workspace_id", "key": "workspace_id", "value": "01ktvxyqmbcm7abv91483q1hfd", "description": "The ID of the workspace." }, { "id": "id", "key": "id", "value": "01ktvxyqn17t8d0w6jx8t2k6e8", "description": "The ID of the channel." } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"name\":\"b\",\"slug\":\"n\",\"password\":\"|{+-0pBNvYgx\"}" }, "description": "", "auth": { "type": "noauth" } }, "response": [] }, { "name": "DELETE api\/v1\/workspaces\/{workspace_id}\/channels\/{id}", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/workspaces\/:workspace_id\/channels\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v1\/workspaces\/:workspace_id\/channels\/:id", "variable": [ { "id": "workspace_id", "key": "workspace_id", "value": "01ktvxyqmbcm7abv91483q1hfd", "description": "The ID of the workspace." }, { "id": "id", "key": "id", "value": "01ktvxyqn17t8d0w6jx8t2k6e8", "description": "The ID of the channel." } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "", "auth": { "type": "noauth" } }, "response": [] }, { "name": "GET api\/v1\/workspaces\/{workspace_id}\/members", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/workspaces\/:workspace_id\/members", "query": [], "raw": "{{baseUrl}}\/api\/v1\/workspaces\/:workspace_id\/members", "variable": [ { "id": "workspace_id", "key": "workspace_id", "value": "01ktvxyqmbcm7abv91483q1hfd", "description": "The ID of the workspace." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "", "auth": { "type": "noauth" } }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "access-control-allow-origin", "value": "*" } ], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "" } ] }, { "name": "PUT api\/v1\/workspaces\/{workspace_id}\/members\/{id}", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/workspaces\/:workspace_id\/members\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v1\/workspaces\/:workspace_id\/members\/:id", "variable": [ { "id": "workspace_id", "key": "workspace_id", "value": "01ktvxyqmbcm7abv91483q1hfd", "description": "The ID of the workspace." }, { "id": "id", "key": "id", "value": "01ktvxyqme70jcjz30my99v5hb", "description": "The ID of the member." } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"role\":\"architecto\",\"preferred_language\":\"architecto\"}" }, "description": "", "auth": { "type": "noauth" } }, "response": [] }, { "name": "DELETE api\/v1\/workspaces\/{workspace_id}\/members\/{id}", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/workspaces\/:workspace_id\/members\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v1\/workspaces\/:workspace_id\/members\/:id", "variable": [ { "id": "workspace_id", "key": "workspace_id", "value": "01ktvxyqmbcm7abv91483q1hfd", "description": "The ID of the workspace." }, { "id": "id", "key": "id", "value": "01ktvxyqme70jcjz30my99v5hb", "description": "The ID of the member." } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "", "auth": { "type": "noauth" } }, "response": [] }, { "name": "GET api\/v1\/workspaces\/{workspace_id}\/invites", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/workspaces\/:workspace_id\/invites", "query": [], "raw": "{{baseUrl}}\/api\/v1\/workspaces\/:workspace_id\/invites", "variable": [ { "id": "workspace_id", "key": "workspace_id", "value": "01ktvxyqmbcm7abv91483q1hfd", "description": "The ID of the workspace." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "", "auth": { "type": "noauth" } }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "access-control-allow-origin", "value": "*" } ], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "" } ] }, { "name": "POST api\/v1\/workspaces\/{workspace_id}\/invites", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/workspaces\/:workspace_id\/invites", "query": [], "raw": "{{baseUrl}}\/api\/v1\/workspaces\/:workspace_id\/invites", "variable": [ { "id": "workspace_id", "key": "workspace_id", "value": "01ktvxyqmbcm7abv91483q1hfd", "description": "The ID of the workspace." } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"expires_in_days\":1}" }, "description": "", "auth": { "type": "noauth" } }, "response": [] }, { "name": "DELETE api\/v1\/workspaces\/{workspace_id}\/invites\/{id}", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/workspaces\/:workspace_id\/invites\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v1\/workspaces\/:workspace_id\/invites\/:id", "variable": [ { "id": "workspace_id", "key": "workspace_id", "value": "01ktvxyqmbcm7abv91483q1hfd", "description": "The ID of the workspace." }, { "id": "id", "key": "id", "value": "01ktwzbyvaea33cwb6grhj3f3e", "description": "The ID of the invite." } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "", "auth": { "type": "noauth" } }, "response": [] }, { "name": "GET api\/v1\/workspaces\/{workspace_id}\/webhooks", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/workspaces\/:workspace_id\/webhooks", "query": [], "raw": "{{baseUrl}}\/api\/v1\/workspaces\/:workspace_id\/webhooks", "variable": [ { "id": "workspace_id", "key": "workspace_id", "value": "01ktvxyqmbcm7abv91483q1hfd", "description": "The ID of the workspace." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "", "auth": { "type": "noauth" } }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "access-control-allow-origin", "value": "*" } ], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "" } ] }, { "name": "POST api\/v1\/workspaces\/{workspace_id}\/webhooks", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/workspaces\/:workspace_id\/webhooks", "query": [], "raw": "{{baseUrl}}\/api\/v1\/workspaces\/:workspace_id\/webhooks", "variable": [ { "id": "workspace_id", "key": "workspace_id", "value": "01ktvxyqmbcm7abv91483q1hfd", "description": "The ID of the workspace." } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"name\":\"b\",\"default_channel_id\":\"architecto\"}" }, "description": "", "auth": { "type": "noauth" } }, "response": [] }, { "name": "PUT api\/v1\/workspaces\/{workspace_id}\/webhooks\/{id}", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/workspaces\/:workspace_id\/webhooks\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v1\/workspaces\/:workspace_id\/webhooks\/:id", "variable": [ { "id": "workspace_id", "key": "workspace_id", "value": "01ktvxyqmbcm7abv91483q1hfd", "description": "The ID of the workspace." }, { "id": "id", "key": "id", "value": "architecto", "description": "The ID of the webhook." } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"name\":\"b\",\"default_channel_id\":\"architecto\",\"is_active\":true,\"regenerate_secret\":false}" }, "description": "", "auth": { "type": "noauth" } }, "response": [] }, { "name": "DELETE api\/v1\/workspaces\/{workspace_id}\/webhooks\/{id}", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/workspaces\/:workspace_id\/webhooks\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v1\/workspaces\/:workspace_id\/webhooks\/:id", "variable": [ { "id": "workspace_id", "key": "workspace_id", "value": "01ktvxyqmbcm7abv91483q1hfd", "description": "The ID of the workspace." }, { "id": "id", "key": "id", "value": "architecto", "description": "The ID of the webhook." } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "", "auth": { "type": "noauth" } }, "response": [] }, { "name": "GET api\/v1\/workspaces\/{workspace_id}\/channels\/{channel_id}\/messages", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/workspaces\/:workspace_id\/channels\/:channel_id\/messages", "query": [], "raw": "{{baseUrl}}\/api\/v1\/workspaces\/:workspace_id\/channels\/:channel_id\/messages", "variable": [ { "id": "workspace_id", "key": "workspace_id", "value": "01ktvxyqmbcm7abv91483q1hfd", "description": "The ID of the workspace." }, { "id": "channel_id", "key": "channel_id", "value": "01ktvxyqn17t8d0w6jx8t2k6e8", "description": "The ID of the channel." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "", "auth": { "type": "noauth" } }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "access-control-allow-origin", "value": "*" } ], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "" } ] }, { "name": "POST api\/v1\/workspaces\/{workspace_id}\/channels\/{channel_id}\/messages", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/workspaces\/:workspace_id\/channels\/:channel_id\/messages", "query": [], "raw": "{{baseUrl}}\/api\/v1\/workspaces\/:workspace_id\/channels\/:channel_id\/messages", "variable": [ { "id": "workspace_id", "key": "workspace_id", "value": "01ktvxyqmbcm7abv91483q1hfd", "description": "The ID of the workspace." }, { "id": "channel_id", "key": "channel_id", "value": "01ktvxyqn17t8d0w6jx8t2k6e8", "description": "The ID of the channel." } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"content\":\"architecto\",\"attachment_ids\":[\"architecto\"],\"skip_translation\":false}" }, "description": "", "auth": { "type": "noauth" } }, "response": [] }, { "name": "POST api\/v1\/automation\/workspaces\/{workspace_id}\/channels\/{channel_id}\/messages", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/automation\/workspaces\/:workspace_id\/channels\/:channel_id\/messages", "query": [], "raw": "{{baseUrl}}\/api\/v1\/automation\/workspaces\/:workspace_id\/channels\/:channel_id\/messages", "variable": [ { "id": "workspace_id", "key": "workspace_id", "value": "01ktvxyqmbcm7abv91483q1hfd", "description": "The ID of the workspace." }, { "id": "channel_id", "key": "channel_id", "value": "01ktvxyqn17t8d0w6jx8t2k6e8", "description": "The ID of the channel." } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"content\":\"architecto\",\"attachment_ids\":[\"architecto\"],\"skip_translation\":false}" }, "description": "", "auth": { "type": "noauth" } }, "response": [] }, { "name": "POST api\/v1\/webhooks\/{webhook_id}\/messages", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/webhooks\/:webhook_id\/messages", "query": [], "raw": "{{baseUrl}}\/api\/v1\/webhooks\/:webhook_id\/messages", "variable": [ { "id": "webhook_id", "key": "webhook_id", "value": "architecto", "description": "The ID of the webhook." } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"content\":\"architecto\",\"channel_id\":\"architecto\",\"skip_translation\":false}" }, "description": "", "auth": { "type": "noauth" } }, "response": [] } ] }, { "name": "External Temporary Rooms", "description": "", "item": [ { "name": "Create a Temporary Room", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/external\/rooms", "query": [], "raw": "{{baseUrl}}\/api\/v1\/external\/rooms" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"name\":\"Customer Support Room\",\"external_reference\":\"customer-123\",\"ttl_hours\":12}" }, "description": "Creates a developer-owned anonymous Temporary Room. Requires a Sanctum API token with `temporary-rooms:create`." }, "response": [ { "header": [], "code": 201, "body": "{\"data\":{\"room_id\":\"01HX...\",\"workspace_id\":\"01HX...\",\"channel_id\":\"01HX...\",\"name\":\"Customer Support Room\",\"kind\":\"temporary_room\",\"status\":\"active\",\"external_reference\":\"customer-123\",\"expires_at\":\"2026-06-12T12:00:00+00:00\",\"max_expires_at\":\"2026-06-13T00:00:00+00:00\",\"extension_count\":0,\"join\":{\"method\":\"POST\",\"endpoint\":\"https:\/\/api.example.test\/api\/v1\/external\/rooms\/01HX...\/guests\"}}}", "name": "" }, { "header": [], "code": 403, "body": "{\"message\":\"Temporary Room active room limit exceeded.\",\"errors\":{\"code\":[\"temporary_room_quota_exceeded\"]}}", "name": "Temporary Room quota exceeded" }, { "header": [], "code": 422, "body": "{\"message\":\"The given data was invalid.\",\"errors\":{\"ttl_hours\":[\"ttl_hours_exceeds_limit\"]}}", "name": "TTL exceeds limit" } ] }, { "name": "List developer-owned Temporary Rooms", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/external\/rooms", "query": [], "raw": "{{baseUrl}}\/api\/v1\/external\/rooms" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Requires a Sanctum API token with `temporary-rooms:read`." }, "response": [ { "header": [], "code": 200, "body": "{\"data\":[{\"room_id\":\"01HX...\",\"kind\":\"temporary_room\",\"status\":\"active\"}]}", "name": "" } ] }, { "name": "Show Temporary Room usage summary", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/external\/rooms\/usage", "query": [], "raw": "{{baseUrl}}\/api\/v1\/external\/rooms\/usage" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Requires a Sanctum API token with `temporary-rooms:read`." }, "response": [ { "header": [], "code": 200, "body": "{\"data\":{\"limits\":{\"active_limit\":3,\"monthly_creation_limit\":10},\"usage\":{\"active_room_count\":1,\"monthly_creation_count\":2},\"abuse_signals\":{\"active_limit_reached\":false,\"monthly_creation_limit_reached\":false}}}", "name": "" } ] }, { "name": "Extend a Temporary Room", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/external\/rooms\/:room_id\/extend", "query": [], "raw": "{{baseUrl}}\/api\/v1\/external\/rooms\/:room_id\/extend", "variable": [ { "id": "room_id", "key": "room_id", "value": "01ktvxyqmbcm7abv91483q1hfd", "description": "The ID of the room." } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"extension_hours\":24}" }, "description": "Requires a Sanctum API token with `temporary-rooms:extend` and paid\/developer Temporary Room limits." }, "response": [ { "header": [], "code": 200, "body": "{\"data\":{\"room_id\":\"01HX...\",\"expires_at\":\"2026-06-13T12:00:00+00:00\",\"max_expires_at\":\"2026-07-12T12:00:00+00:00\",\"extension_count\":1}}", "name": "" }, { "header": [], "code": 403, "body": "{\"message\":\"Temporary Room extension is not allowed.\",\"errors\":{\"code\":[\"temporary_room_extension_not_allowed\"]}}", "name": "Extension not allowed" }, { "header": [], "code": 422, "body": "{\"message\":\"The given data was invalid.\",\"errors\":{\"extension_hours\":[\"extension_hours_exceeds_limit\"]}}", "name": "Extension exceeds max" } ] }, { "name": "Join a Temporary Room as a guest", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/external\/rooms\/:room_id\/guests", "query": [], "raw": "{{baseUrl}}\/api\/v1\/external\/rooms\/:room_id\/guests", "variable": [ { "id": "room_id", "key": "room_id", "value": "01ktvxyqmbcm7abv91483q1hfd", "description": "The ID of the room." } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"nickname\":\"Mei\",\"preferred_language\":\"zh-CN\"}" }, "description": "Creates a restricted guest user and one guest session token scoped to this Temporary Room.", "auth": { "type": "noauth" } }, "response": [ { "header": [], "code": 201, "body": "{\"data\":{\"guest\":{\"id\":\"01HX...\",\"nickname\":\"Mei\",\"preferred_language\":\"zh-CN\"},\"session\":{\"token\":\"grst_...\",\"token_type\":\"guest\",\"header\":\"X-Rosetta-Guest-Token\",\"expires_at\":\"2026-06-12T12:00:00+00:00\"},\"room\":{\"room_id\":\"01HX...\",\"workspace_id\":\"01HX...\",\"channel_id\":\"01HX...\",\"name\":\"Customer Support Room\",\"status\":\"active\",\"expires_at\":\"2026-06-12T12:00:00+00:00\"}}}", "name": "" }, { "header": [], "code": 410, "body": "{\"message\":\"Temporary Room is not available.\",\"errors\":{\"code\":[\"temporary_room_expired\"]}}", "name": "Expired room" } ] }, { "name": "List guest-visible room messages", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/external\/rooms\/:room_id\/messages", "query": [], "raw": "{{baseUrl}}\/api\/v1\/external\/rooms\/:room_id\/messages", "variable": [ { "id": "room_id", "key": "room_id", "value": "01ktvxyqmbcm7abv91483q1hfd", "description": "The ID of the room." } ] }, "method": "GET", "header": [ { "key": "X-Rosetta-Guest-Token", "value": "string required Guest session token." }, { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Requires `X-Rosetta-Guest-Token`.", "auth": { "type": "noauth" } }, "response": [ { "header": [], "code": 200, "body": "{\"data\":[{\"id\":\"01HX...\",\"display_content\":\"Hello\",\"display_source\":\"original\"}]}", "name": "" } ] }, { "name": "Send a guest room message", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/external\/rooms\/:room_id\/messages", "query": [], "raw": "{{baseUrl}}\/api\/v1\/external\/rooms\/:room_id\/messages", "variable": [ { "id": "room_id", "key": "room_id", "value": "01ktvxyqmbcm7abv91483q1hfd", "description": "The ID of the room." } ] }, "method": "POST", "header": [ { "key": "X-Rosetta-Guest-Token", "value": "string required Guest session token." }, { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"content\":\"Hello team\",\"attachment_ids\":[\"architecto\"],\"parent_message_id\":\"architecto\",\"skip_translation\":false}" }, "description": "Requires `X-Rosetta-Guest-Token`.", "auth": { "type": "noauth" } }, "response": [ { "header": [], "code": 201, "body": "{\"data\":{\"id\":\"01HX...\",\"original_content\":\"Hello team\",\"translation_status\":\"pending\"}}", "name": "" } ] } ] }, { "name": "Files", "description": "", "item": [ { "name": "Upload a file.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/files", "query": [], "raw": "{{baseUrl}}\/api\/v1\/files" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "multipart\/form-data" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "formdata", "formdata": [ { "key": "visibility", "value": "architecto", "type": "text", "description": "Optional. `public` or `private`. Defaults to the configured visibility." }, { "key": "file", "src": [], "type": "file" } ] }, "description": "Returns the created file record with a TTL. Persist the returned id on\na parent record and call FileService::claim() to opt out of cleanup." }, "response": [ { "header": [], "code": 201, "body": "{\"data\": {\"id\": \"01HX...\", \"client_name\": \"photo.jpg\", \"size\": 12345, \"expires_at\": \"2026-05-11T05:00:00+00:00\"}}", "name": "" } ] }, { "name": "Show file metadata.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/files\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v1\/files\/:id", "variable": [ { "id": "id", "key": "id", "value": "architecto", "description": "The ID of the file." } ] }, "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": "access-control-allow-origin", "value": "*" } ], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "" } ] }, { "name": "Stream the file contents to the client.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/files\/:file_id\/download", "query": [], "raw": "{{baseUrl}}\/api\/v1\/files\/:file_id\/download", "variable": [ { "id": "file_id", "key": "file_id", "value": "architecto", "description": "The ID of the file." } ] }, "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": "access-control-allow-origin", "value": "*" } ], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "" } ] }, { "name": "Delete a file (soft delete + remove from disk).", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/files\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v1\/files\/:id", "variable": [ { "id": "id", "key": "id", "value": "architecto", "description": "The ID of the file." } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [] } ] }, { "name": "Me", "description": "", "item": [ { "name": "List my files.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/me\/files", "query": [ { "key": "claimed", "value": "1", "description": "Filter by claim state. `true` = persistent (no TTL), `false` = pending. Defaults to `true`.", "disabled": false }, { "key": "visibility", "value": "private", "description": "Filter by visibility. `public` or `private`.", "disabled": false }, { "key": "q", "value": "invoice", "description": "Substring search on the original client filename.", "disabled": false }, { "key": "sort", "value": "-created_at", "description": "One of `created_at`, `-created_at`, `size`, `-size`. Defaults to `-created_at`.", "disabled": false }, { "key": "per_page", "value": "20", "description": "1\u2013100. Defaults to 15.", "disabled": false }, { "key": "page", "value": "1", "description": "1+.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v1\/me\/files?claimed=1&visibility=private&q=invoice&sort=-created_at&per_page=20&page=1" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"claimed\":true,\"visibility\":\"public\",\"q\":\"b\",\"sort\":\"-created_at\",\"per_page\":22,\"page\":67}" }, "description": "Returns files owned by the authenticated user. By default only claimed\n(persistent) files are listed \u2014 pass `?claimed=false` to see files\nthat still carry a TTL. Anonymously uploaded files are never listed\nhere regardless of filters." }, "response": [ { "header": [], "code": 200, "body": "{\"data\": [{\"id\": \"01HX...\", \"client_name\": \"photo.jpg\"}], \"meta\": {\"current_page\": 1}, \"links\": {}}", "name": "" } ] }, { "name": "List my push devices.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/me\/devices", "query": [ { "key": "provider", "value": "fcm", "description": "Filter by push transport. One of `fcm`, `expo`, `apns`.", "disabled": false }, { "key": "sort", "value": "-last_used_at", "description": "One of `last_used_at`, `-last_used_at`, `created_at`, `-created_at`. Defaults to `-last_used_at`.", "disabled": false }, { "key": "per_page", "value": "20", "description": "1\u2013100. Defaults to 15.", "disabled": false }, { "key": "page", "value": "1", "description": "1+.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v1\/me\/devices?provider=fcm&sort=-last_used_at&per_page=20&page=1" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"provider\":\"expo\",\"sort\":\"-last_used_at\",\"per_page\":1,\"page\":22}" }, "description": "Returns the push-notification devices registered to the authenticated\nuser. Raw push tokens are never returned." }, "response": [ { "header": [], "code": 200, "body": "{\"data\": [{\"id\": \"01HX...\", \"platform\": \"ios\", \"provider\": \"fcm\"}], \"meta\": {\"current_page\": 1}, \"links\": {}}", "name": "" } ] } ] }, { "name": "Shared Authentication", "description": "\nShared authentication APIs that work with both token and cookie-based authentication", "item": [ { "name": "Get Current User", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/me", "query": [], "raw": "{{baseUrl}}\/api\/v1\/me" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Retrieve the authenticated user's information.\nWorks with both token-based and cookie-based authentication." }, "response": [ { "header": [], "code": 200, "body": "{\n \"id\": 1,\n \"name\": \"John Doe\",\n \"email\": \"john@example.com\",\n \"email_verified_at\": \"2024-01-01T00:00:00.000000Z\",\n \"is_active\": true,\n \"last_login_at\": \"2024-01-15T10:30:00.000000Z\",\n \"created_at\": \"2024-01-01T00:00:00.000000Z\",\n \"updated_at\": \"2024-01-15T10:30:00.000000Z\"\n}", "name": "" }, { "header": [], "code": 401, "body": "{\n \"message\": \"Unauthenticated.\"\n}", "name": "Unauthenticated" } ] } ] }, { "name": "Web Authentication", "description": "\nCookie-based authentication APIs for Single Page Applications (SPA)", "item": [ { "name": "Register", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/auth\/web\/register", "query": [], "raw": "{{baseUrl}}\/api\/v1\/auth\/web\/register" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"name\":\"John Doe\",\"email\":\"john@example.com\",\"password\":\"secretpassword\",\"preferred_language\":\"en\",\"password_confirmation\":\"secretpassword\"}" }, "description": "Create a new user account and establish a session.", "auth": { "type": "noauth" } }, "response": [ { "header": [], "code": 200, "body": "{\n \"user\": {\"id\": 1, \"name\": \"John Doe\", \"email\": \"john@example.com\"},\n \"message\": \"Registered successfully.\"\n}", "name": "" }, { "header": [], "code": 422, "body": "{\n \"message\": \"The given data was invalid.\",\n \"errors\": {\"email\": [\"This email is already registered.\"]}\n}", "name": "Validation error" } ] }, { "name": "Login", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/auth\/web\/login", "query": [], "raw": "{{baseUrl}}\/api\/v1\/auth\/web\/login" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"email\":\"john@example.com\",\"password\":\"secretpassword\",\"device_name\":\"v\"}" }, "description": "Authenticate user with email and password, establish a session.", "auth": { "type": "noauth" } }, "response": [ { "header": [], "code": 200, "body": "{\n \"user\": {\"id\": 1, \"name\": \"John Doe\", \"email\": \"john@example.com\"},\n \"message\": \"Logged in successfully.\"\n}", "name": "" }, { "header": [], "code": 403, "body": "{\n \"message\": \"Account is inactive.\"\n}", "name": "Account inactive" }, { "header": [], "code": 422, "body": "{\n \"message\": \"The given data was invalid.\",\n \"errors\": {\"email\": [\"The provided credentials are incorrect.\"]}\n}", "name": "Invalid credentials" } ] }, { "name": "Request OTP", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/auth\/web\/otp", "query": [], "raw": "{{baseUrl}}\/api\/v1\/auth\/web\/otp" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"email\":\"john@example.com\"}" }, "description": "Send a One-Time Password to the user's email for passwordless authentication.", "auth": { "type": "noauth" } }, "response": [ { "header": [], "code": 200, "body": "{\n \"message\": \"OTP sent to your email.\"\n}", "name": "" }, { "header": [], "code": 422, "body": "{\n \"message\": \"The given data was invalid.\",\n \"errors\": {\"email\": [\"The email field must be a valid email address.\"]}\n}", "name": "Validation error" } ] }, { "name": "Verify OTP", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/auth\/web\/otp\/verify", "query": [], "raw": "{{baseUrl}}\/api\/v1\/auth\/web\/otp\/verify" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"email\":\"john@example.com\",\"token\":\"123456\",\"device_name\":\"j\"}" }, "description": "Verify the One-Time Password and establish a session.\nCreates a new account if the email is not registered.", "auth": { "type": "noauth" } }, "response": [ { "header": [], "code": 200, "body": "{\n \"user\": {\"id\": 1, \"name\": \"john\", \"email\": \"john@example.com\"},\n \"message\": \"Logged in successfully.\"\n}", "name": "" }, { "header": [], "code": 403, "body": "{\n \"message\": \"Account is inactive.\"\n}", "name": "Account inactive" }, { "header": [], "code": 422, "body": "{\n \"message\": \"The given data was invalid.\",\n \"errors\": {\"token\": [\"Invalid or expired OTP.\"]}\n}", "name": "Invalid OTP" } ] }, { "name": "Forgot Password", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/auth\/web\/forgot-password", "query": [], "raw": "{{baseUrl}}\/api\/v1\/auth\/web\/forgot-password" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"email\":\"john@example.com\"}" }, "description": "Send a password reset link to the user's email.", "auth": { "type": "noauth" } }, "response": [ { "header": [], "code": 200, "body": "{\n \"message\": \"Password reset link sent to your email.\"\n}", "name": "" }, { "header": [], "code": 422, "body": "{\n \"message\": \"The given data was invalid.\",\n \"errors\": {\"email\": [\"We could not find an account with that email.\"]}\n}", "name": "Email not found" } ] }, { "name": "Reset Password", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/auth\/web\/reset-password", "query": [], "raw": "{{baseUrl}}\/api\/v1\/auth\/web\/reset-password" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"token\":\"abc123def456...\",\"email\":\"john@example.com\",\"password\":\"newsecretpassword\",\"password_confirmation\":\"newsecretpassword\"}" }, "description": "Reset the user's password using the reset token.", "auth": { "type": "noauth" } }, "response": [ { "header": [], "code": 200, "body": "{\n \"message\": \"Password has been reset successfully.\"\n}", "name": "" }, { "header": [], "code": 422, "body": "{\n \"message\": \"The given data was invalid.\",\n \"errors\": {\"email\": [\"This password reset token is invalid.\"]}\n}", "name": "Invalid token" } ] }, { "name": "Logout", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/auth\/web\/logout", "query": [], "raw": "{{baseUrl}}\/api\/v1\/auth\/web\/logout" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Destroy the current session." }, "response": [ { "header": [], "code": 200, "body": "{\n \"message\": \"Logged out successfully.\"\n}", "name": "" }, { "header": [], "code": 401, "body": "{\n \"message\": \"Unauthenticated.\"\n}", "name": "Unauthenticated" } ] }, { "name": "Change Password", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/auth\/web\/change-password", "query": [], "raw": "{{baseUrl}}\/api\/v1\/auth\/web\/change-password" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"current_password\":\"oldsecretpassword\",\"password\":\"newsecretpassword\",\"password_confirmation\":\"newsecretpassword\"}" }, "description": "Change the authenticated user's password." }, "response": [ { "header": [], "code": 200, "body": "{\n \"message\": \"Password changed successfully.\"\n}", "name": "" }, { "header": [], "code": 401, "body": "{\n \"message\": \"Unauthenticated.\"\n}", "name": "Unauthenticated" }, { "header": [], "code": 422, "body": "{\n \"message\": \"The given data was invalid.\",\n \"errors\": {\"current_password\": [\"The current password is incorrect.\"]}\n}", "name": "Wrong current password" } ] } ] }, { "name": "Web Authentication - Social", "description": "\nCookie-based social authentication APIs for Single Page Applications (SPA)", "item": [ { "name": "Get OAuth Redirect URL", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/auth\/web\/social\/:provider\/redirect", "query": [], "raw": "{{baseUrl}}\/api\/v1\/auth\/web\/social\/:provider\/redirect", "variable": [ { "id": "provider", "key": "provider", "value": "google", "description": "The OAuth provider name." } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Get the OAuth redirect URL for the specified provider.\nThe client should open this URL in a browser to start the OAuth flow.", "auth": { "type": "noauth" } }, "response": [ { "header": [], "code": 200, "body": "{\n \"redirect_url\": \"https:\/\/accounts.google.com\/o\/oauth2\/v2\/auth?...\"\n}", "name": "" }, { "header": [], "code": 422, "body": "{\n \"message\": \"The given data was invalid.\",\n \"errors\": {\"provider\": [\"The selected provider is invalid.\"]}\n}", "name": "Invalid provider" } ] }, { "name": "OAuth Callback", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/auth\/web\/social\/:provider\/callback", "query": [], "raw": "{{baseUrl}}\/api\/v1\/auth\/web\/social\/:provider\/callback", "variable": [ { "id": "provider", "key": "provider", "value": "google", "description": "The OAuth provider name." } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"code\":\"4\\\/0AfJohXn...\",\"state\":\"xyz123\",\"device_name\":\"n\"}" }, "description": "Exchange the OAuth code for a session and authenticate the user.\nEstablishes a session cookie for subsequent requests.", "auth": { "type": "noauth" } }, "response": [ { "header": [], "code": 200, "body": "{\n \"user\": {\"id\": 1, \"name\": \"John Doe\", \"email\": \"john@example.com\"},\n \"message\": \"Logged in successfully.\"\n}", "name": "" }, { "header": [], "code": 403, "body": "{\n \"message\": \"Account is inactive.\"\n}", "name": "Account inactive" }, { "header": [], "code": 422, "body": "{\n \"message\": \"The given data was invalid.\",\n \"errors\": {\"provider\": [\"The selected provider is invalid.\"]}\n}", "name": "Invalid provider" } ] }, { "name": "List Linked Accounts", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/auth\/web\/social\/accounts", "query": [], "raw": "{{baseUrl}}\/api\/v1\/auth\/web\/social\/accounts" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Get all social accounts linked to the authenticated user." }, "response": [ { "header": [], "code": 200, "body": "{\n \"accounts\": [\n {\"id\": 1, \"provider\": \"google\", \"provider_email\": \"john@gmail.com\", \"name\": \"John Doe\", \"avatar\": \"https:\/\/...\", \"created_at\": \"2024-01-01T00:00:00.000000Z\"}\n ]\n}", "name": "" }, { "header": [], "code": 401, "body": "{\n \"message\": \"Unauthenticated.\"\n}", "name": "Unauthenticated" } ] }, { "name": "Link Social Account", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/auth\/web\/social\/:provider\/link", "query": [], "raw": "{{baseUrl}}\/api\/v1\/auth\/web\/social\/:provider\/link", "variable": [ { "id": "provider", "key": "provider", "value": "google", "description": "The OAuth provider name." } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Link a new social account to the authenticated user.\nReturns the OAuth redirect URL for the linking flow." }, "response": [ { "header": [], "code": 200, "body": "{\n \"redirect_url\": \"https:\/\/accounts.google.com\/o\/oauth2\/v2\/auth?...\"\n}", "name": "" }, { "header": [], "code": 401, "body": "{\n \"message\": \"Unauthenticated.\"\n}", "name": "Unauthenticated" }, { "header": [], "code": 422, "body": "{\n \"message\": \"The given data was invalid.\",\n \"errors\": {\"provider\": [\"The selected provider is invalid.\"]}\n}", "name": "Invalid provider" } ] }, { "name": "Complete Link Social Account", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/auth\/web\/social\/:provider\/link\/callback", "query": [], "raw": "{{baseUrl}}\/api\/v1\/auth\/web\/social\/:provider\/link\/callback", "variable": [ { "id": "provider", "key": "provider", "value": "google", "description": "The OAuth provider name." } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"code\":\"4\\\/0AfJohXn...\",\"state\":\"architecto\",\"device_name\":\"n\"}" }, "description": "Complete the social account linking after OAuth callback." }, "response": [ { "header": [], "code": 200, "body": "{\n \"account\": {\"id\": 1, \"provider\": \"google\", \"provider_email\": \"john@gmail.com\", \"name\": \"John Doe\"},\n \"message\": \"Social account linked successfully.\"\n}", "name": "" }, { "header": [], "code": 401, "body": "{\n \"message\": \"Unauthenticated.\"\n}", "name": "Unauthenticated" }, { "header": [], "code": 422, "body": "{\n \"message\": \"This social account is already linked to your account.\"\n}", "name": "Already linked" }, { "header": [], "code": 422, "body": "{\n \"message\": \"This social account is already linked to another user.\"\n}", "name": "Linked to another user" } ] }, { "name": "Unlink Social Account", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/auth\/web\/social\/:provider\/unlink", "query": [], "raw": "{{baseUrl}}\/api\/v1\/auth\/web\/social\/:provider\/unlink", "variable": [ { "id": "provider", "key": "provider", "value": "google", "description": "The OAuth provider name." } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Remove a linked social account from the authenticated user." }, "response": [ { "header": [], "code": 200, "body": "{\n \"message\": \"Social account unlinked successfully.\"\n}", "name": "" }, { "header": [], "code": 401, "body": "{\n \"message\": \"Unauthenticated.\"\n}", "name": "Unauthenticated" }, { "header": [], "code": 404, "body": "{\n \"message\": \"Social account not found.\"\n}", "name": "Not found" }, { "header": [], "code": 422, "body": "{\n \"message\": \"Cannot unlink the last authentication method. Please set a password first.\"\n}", "name": "Last auth method" } ] } ] } ], "auth": { "type": "bearer", "bearer": [ { "key": "key", "type": "string" } ] } }