Get an account's saved site logins

Overview

Check whether an account has a login saved for one review site, without exposing the password.

Send the account (company_id) and the review site (review_site_id). If a login is saved at account level for that site, you get its username and when it was last changed. If not, data is an empty array. Call it once per site you want to check.

Prerequisites

• A bearer token. See Authentication.
• The account's id (company_id) and the review site's id (review_site_id).

Base URL

Endpoint

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

Authentication

Partner or Account token

• company_id must be inside your own account tree. A Partner token can read any account under the partner; an Account token can read only its own account.
• An account outside your tree is rejected with 422.

Rate limit

This endpoint has no rate limit.

Request parameters

Request body

None.

Request payload

None.

Response body

The payload is inside data.

Response payload

{
  "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"
    }
  }
}

Examples

Success payload

A login is saved: see Response payload.

No login saved for this site:

{
  "data": {
    "status": "success",
    "data": []
  }
}

Error payload

422 Missing company_id

{
  "message": "The company id field is required.",
  "errors": {
    "company_id": [
      "The company id field is required."
    ]
  }
}

422 Account outside your tree

{
  "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."
    ]
  }
}

422 Review site doesn't exist

{
  "message": "The selected review site id is invalid.",
  "errors": {
    "review_site_id": [
      "The selected review site id is invalid."
    ]
  }
}

Example request

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