Get saved company credentials

Overview

Get the saved review-site login (username only, never the password) stored at the company/account level for a given review site.

Prerequisites

• A bearer token. Callable with Partner and Account tokens.

Base URL

Endpoint

GET /api/v1/store-review-site/company/credentials

Authentication

• Requires a bearer token in the Authorization: Bearer <bearer-token> header.

• Who can call it: Partner and Account tokens.

• company_id must pass an ownership check. The company has to sit within the auth user's company hierarchy.

• Partners can read any company under their tree. An Account user reads only its own.

Rate limit

• No rate limit.

Query parameters

• Query: company_id (integer, required) — must be an existing account and belong to the caller's hierarchy.
• Query: review_site_id (integer, required) — must be an existing review site.

Response

• data.status (string) — success.
• data.data (object | empty array) — when credentials exist: id, username, updated_at, review_site_id, review_site_name. When none are saved, data is an empty array []. The password is never returned.

200 Success · 200

{
  "data": {
    "status": "success",
    "data": {
      "id": 42,
      "username": "[email protected]",
      "updated_at": "2026-06-15T13:41:47.000000Z",
      "review_site_id": 1,
      "review_site_name": "Yelp"
    }
  }
}

Errors

Example request

curl --request GET \
  --url "https://production-api.shoutaboutus.com/api/v1/store-review-site/company/credentials?company_id=123&review_site_id=1" \
  --header 'Authorization: Bearer <bearer-token>' \
  --header 'Accept: application/json'