Skip to main content
GET
Get attribute metadata

Request contract

  • Method and path: GET /apis/v1/social/accounts/{accountId}/gmb-attribute-metadata
  • Availability: enabled
  • Request URL template: https://api.aisa.one/apis/v1/social/accounts/{accountId}/gmb-attribute-metadata
  • accountId: path; required
  • locationId: query; optional
  • categoryName: query; optional
  • regionCode: query; optional
  • languageCode: query; optional
  • pageSize: query; optional
  • pageToken: query; optional
  • Runtime facts: 99acb5bddbedc8d3352e7c4fef86c3e6d8852c14772bcd18dbcf415237a642bd
Complete OpenAPI definition Effective request and pricing declaration (including authentication and referenced schemas):

Cost and request rules

A request reference price is not currently available; use a request quote where supported. Account-specific pricing and final settlement may differ. Published reference values are not an account-specific quote or a settled charge. For endpoints supporting X-AISA-Cost-Mode: quote, obtain a free quote for your exact request before execution; reconcile the settled cost with response metadata and Usage Logs. USD amounts use 1,000,000 integer micro-USD per dollar.

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

accountId
string
required

One of your social accounts (acc_...).

Pattern: ^acc_[0-9A-Za-z]{22}$

Query Parameters

locationId
string

Google Business Profile location ID (e.g. "6257659026299438786"). If omitted, uses the account's stored selectedLocationId. Mutually exclusive with categoryName.

categoryName
string

Category resource name, must start with "categories/" (e.g. "categories/gcid:plumber"). Required together with regionCode. Mutually exclusive with locationId.

regionCode
string

BCP-47 region code (e.g. "US", "ES"). Required when categoryName is provided.

languageCode
string

BCP-47 language code for display names (e.g. "en", "es"). Optional when categoryName is provided. Omitted from the Google call when not supplied.

pageSize
integer

Maximum number of attribute metadata items to return. Google defaults to 200.

Required range: 1 <= x <= 200
pageToken
string

Pagination token from a previous response's nextPageToken field.

Response

Attribute metadata fetched successfully

accountId
string

One of your social accounts (acc_...).

Pattern: ^acc_[0-9A-Za-z]{22}$
attributeMetadata
object[]
locationId
string

Only present in location mode.

nextPageToken
string

Present when additional pages of results are available.

success
boolean