--- updatedAt: 2026-10-01T15:02:09.000Z agentTools: projectIndex: https://docs.shoutaboutus.com/llms.txt --- # List supported review sites Get the review sites on this account's plans, each with its id, name, logo and `auth_type` (how it connects). Use this to find a `review_site_id`, to show a site picker in your own UI, or to decide which connection flow to show for a site. Only sites on the account's plans are returned, so an account with no plan gets an empty list. Google and Yelp come first when they're on the plan. **Prerequisites:** a bearer token. Optional: the account's id (`company_id`); leave it out to list the sites for your own account. **Authentication:** Partner or Account token. `company_id` must be inside your own account tree (a Partner token reaches any account under the partner, an Account token only its own); otherwise `422`. **Rate limit:** none. # OpenAPI definition ```json { "openapi": "3.0.0", "info": { "title": "Shout About Us API", "description": "The Shout About Us API for monitoring and responding to reviews across Google, Facebook, Trustpilot and more, running review-request campaigns, and viewing analytics.\n\n**Base path:** most endpoints are versioned under `/api/v1`; the OAuth token endpoint lives at the server root.\n\n**Authentication:** send a **Bearer** token (a Personal access token from the dashboard's API Keys page, or an App credentials (OAuth 2.0) access token) in the `Authorization` header. Public endpoints are marked per-endpoint.", "contact": { "name": "Shout About Us Support", "email": "techsupport@shoutaboutus.com" }, "version": "1.0.0" }, "servers": [ { "url": "https://production-api.shoutaboutus.com", "description": "Production" }, { "url": "https://development-api.shoutaboutus.com", "description": "Development" } ], "security": [ { "bearerAuth": [] } ], "paths": { "/api/v1/account/reviewsite/list": { "post": { "tags": [ "Review sites — catalogue & bulk credentials" ], "summary": "List supported review sites", "operationId": "postAccountReviewsiteList", "description": "Get the review sites on this account's plans, each with its id, name, logo and `auth_type` (how it connects). Use this to find a `review_site_id`, to show a site picker in your own UI, or to decide which connection flow to show for a site. Only sites on the account's plans are returned, so an account with no plan gets an empty list. Google and Yelp come first when they're on the plan.\n\n**Prerequisites:** a bearer token. Optional: the account's id (`company_id`); leave it out to list the sites for your own account.\n\n**Authentication:** Partner or Account token. `company_id` must be inside your own account tree (a Partner token reaches any account under the partner, an Account token only its own); otherwise `422`.\n\n**Rate limit:** none.", "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "properties": { "company_id": { "type": "integer", "description": "The account to list sites for. Must exist and be inside your account tree. Leave it out to use the account of the user behind the token.", "example": 5994, "default": 5994 }, "except_review_site_id": { "type": "array", "items": { "type": "integer" }, "description": "Review site ids to leave out of the list, e.g. `[44]` to hide Google.", "example": [ 44 ], "default": [ 44 ] } } }, "examples": { "account": { "summary": "One account, without Google", "value": { "company_id": 5994, "except_review_site_id": [ 44 ] } }, "own": { "summary": "Your own account (empty body)", "value": {} } } } } }, "responses": { "200": { "description": "The account's review sites, or `[]` when it has none.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "description": "The payload.", "properties": { "status": { "type": "string", "description": "`success`.", "example": "success" }, "response": { "type": "array", "description": "The review sites. An empty array `[]` when the account has no plan, or its plans have no review sites.", "items": { "type": "object", "properties": { "value": { "type": "integer", "description": "The review site's id. Use it as `review_site_id` in other calls.", "example": 44 }, "label": { "type": "string", "description": "The review site's name, e.g. `Google`.", "example": "Google" }, "logo": { "type": "string", "format": "uri", "description": "URL of the site's logo." }, "auth_type": { "type": "string", "nullable": true, "enum": [ "oauth", "credential", "cookie", "restapi", "default" ], "description": "How the site connects, which tells you the connection flow to show. `oauth`: sign in with the platform (e.g. Google, Facebook). `cookie` or `credential`: manager invite; the business adds our address as a manager on its listing (get the address from `POST /api/v1/store-review-site/{id}/connect`). `default`: the site's username and password, for sites that don't support adding a manager; not available yet, coming in a future release. `restapi`: connected through the platform's own API; nothing for the business to do. `null`: no connection flow for this site. Fixed per review site; it doesn't vary by account or plan." } } } } } } } }, "examples": { "all": { "summary": "All the account's sites", "value": { "data": { "status": "success", "response": [ { "value": 44, "label": "Google", "logo": "https://d2ny6zb7otrnhl.cloudfront.net/assets/backend/images/logos/google_ic.png", "auth_type": "oauth" }, { "value": 1, "label": "Yelp", "logo": "https://d2ny6zb7otrnhl.cloudfront.net/assets/backend/images/logos/yelp_ic.png", "auth_type": "cookie" }, { "value": 3, "label": "Facebook", "logo": "https://d2ny6zb7otrnhl.cloudfront.net/assets/backend/images/logos/facebook_ic.png", "auth_type": "oauth" } ] } } }, "except": { "summary": "With except_review_site_id [44]", "value": { "data": { "status": "success", "response": [ { "value": 1, "label": "Yelp", "logo": "https://d2ny6zb7otrnhl.cloudfront.net/assets/backend/images/logos/yelp_ic.png", "auth_type": "cookie" }, { "value": 3, "label": "Facebook", "logo": "https://d2ny6zb7otrnhl.cloudfront.net/assets/backend/images/logos/facebook_ic.png", "auth_type": "oauth" } ] } } }, "empty": { "summary": "No plan, or no sites on the plans", "value": { "data": { "status": "success", "response": [] } } } } } } }, "401": { "description": "The token is missing, expired or invalid.", "content": { "application/json": { "example": { "message": "Unauthenticated." } } } }, "422": { "description": "`company_id` doesn't exist or is outside your tree, or `except_review_site_id` isn't an array.", "content": { "application/json": { "examples": { "tree": { "summary": "Account outside your tree", "value": { "message": "The selected company id does not belong to your company hierarchy.", "errors": { "company_id": [ "The selected company id does not belong to your company hierarchy." ] } } }, "missing": { "summary": "Account doesn't exist", "value": { "message": "The selected company id is invalid. (and 1 more error)", "errors": { "company_id": [ "The selected company id is invalid.", "The selected company id does not belong to your company hierarchy." ] } } }, "array": { "summary": "except_review_site_id isn't an array", "value": { "message": "The except review site id field must be an array.", "errors": { "except_review_site_id": [ "The except review site id field must be an array." ] } } } } } } }, "500": { "description": "Unexpected server error.", "content": { "application/json": { "example": { "message": "An unexpected error occurred. Please try again later or contact your account rep.", "status": "error", "errors": [] } } } } } } } }, "components": { "securitySchemes": { "bearerAuth": { "type": "http", "scheme": "bearer", "bearerFormat": "JWT" } } } } ```