Skip to content
Account and onboarding

List properties

Every property (one store or Google Ads account set up in Product Metrics) the signed-in person can open, with its workspace, Google Ads customer id and currency, and the signed-in account (account.email).

GET /properties

Scope read · Access Read only · Operation id properties.list

Try it

productmetrics runs after productmetrics login; curl needs PM_TOKEN (see Authentication).

productmetrics properties list --json

Response

API response (200):

{
  "data": {
    "account": {
      "email": "owner@example.com"
    },
    "properties": [
      {
        "property_id": "8c1f4d2e-7a3b-4c5d-9e6f-0a1b2c3d4e5f",
        "company_id": "2a7d9b3c-1e4f-4a5b-8c6d-7e8f9a0b1c2d",
        "name": "Example Store",
        "company": "Example Store B.V.",
        "google_ads_customer_id": "1234567890",
        "currency": "EUR"
      }
    ]
  },
  "request_id": "req_01J28MWSEF96DX6K8WXDDB6K48"
}

CLI output: productmetrics properties list --json prints { "ok": true, "data": …, "request_id": "…" } with the same data.

Before you call

It lists only workspaces that have a property; companies.list lists every workspace. Use a property_id from this list wherever another operation asks for one.

Errors

A failure answers with its HTTP status and { error: { code, message, details? }, request_id }. Branch on code (stable, lower_snake); show message to the person. The CLI prints the same error with "ok": false.

{
  "error": {
    "code": "insufficient_scope",
    "message": "This operation needs the read scope; connect again and allow it.",
    "details": {
      "required_scope": "read"
    }
  },
  "request_id": "req_01JCW4W8W3HK1XFM0R5VFDPAMV"
}
StatusCodeWhen
401invalid_tokenThe token is missing, expired or revoked: sign in again (productmetrics login). The WWW-Authenticate header says why.
403insufficient_scopeThe token lacks the read scope (details.required_scope): sign in again and allow it.
429rate_limitedMore than 600 requests a minute for this person: wait the Retry-After seconds (60) and retry.

All Account and onboarding operations