Google Business Profile info

GET

/api/v1/reviews/profile

curl --request GET \
  --url https://digize.com/api/v1/reviews/profile \
  --header 'x-api-key: <x-api-key>'

• Digize

What Google Search and Maps show about the business: its name, categories, hours, contact details and attributes, and any edits Google is still checking.

Needs the reviews:read permission.

Authorizations

• apiKey
• bearer

Responses

200

Done

Media typeapplication/json

object

name

required

string

<= 200 characters

status

required

string

Allowed values: open temporarily_closed permanently_closed

primaryCategory

required

string

<= 120 characters

additionalCategories

required

Array<string>

<= 9 items

description

required

string

<= 750 characters

openingDate

required

The first of the month it opened, or empty.

string

/^(\d{4}-\d{2}-01)?$/

phone

required

string

<= 40 characters

website

required

string

<= 500 characters

links

required

object

menu

required

string

<= 500 characters

order

required

string

<= 500 characters

booking

required

string

<= 500 characters

address

required

object

line1

required

string

<= 200 characters

line2

required

string

<= 200 characters

city

required

string

<= 100 characters

region

required

string

<= 100 characters

postalCode

required

string

<= 20 characters

country

required

string

<= 80 characters

hideAddress

required

boolean

serviceAreas

required

Array<string>

<= 20 items

hours

required

Array<object>

>= 7 items <= 7 items

object

day

required

integer

<= 6

open

required

boolean

ranges

required

Array<object>

<= 6 items

object

start

required

integer

<= 1440

end

required

integer

<= 1440

specialHours

required

Array<object>

<= 100 items

object

id

required

string

<= 64 characters

date

required

string

/^\d{4}-\d{2}-\d{2}$/

label

required

string

<= 80 characters

closed

required

boolean

ranges

required

Array<object>

<= 6 items

object

start

required

integer

<= 1440

end

required

integer

<= 1440

attributes

required

Array<string>

<= 200 items

locationId

required

string

mapsUrl

required

string

reviewUrl

required

string

pending

required

Any of:

object

object

fields

required

Array<string>

since

required

string format: date-time

null

null

error

required

Why Google refused the last edit.

string | null

updatedAt

required

string format: date-time

updatedBy

required

string

Example

{
  "status": "open"
}

400

What was sent isn’t valid (invalid).

Media typeapplication/json

object

error

required

object

code

required

string

Allowed values: invalid unauthorized forbidden not_found conflict too_large rate_limited unavailable internal

message

required

string

details

object

key

additional properties

any

Example

{
  "error": {
    "code": "invalid"
  }
}

401

No key, or one that’s unknown, off or expired.

Media typeapplication/json

object

error

required

object

code

required

string

Allowed values: invalid unauthorized forbidden not_found conflict too_large rate_limited unavailable internal

message

required

string

details

object

key

additional properties

any

Example

{
  "error": {
    "code": "invalid"
  }
}

403

The key doesn’t have the permission this needs.

Media typeapplication/json

object

error

required

object

code

required

string

Allowed values: invalid unauthorized forbidden not_found conflict too_large rate_limited unavailable internal

message

required

string

details

object

key

additional properties

any

Example

{
  "error": {
    "code": "invalid"
  }
}

404

Nothing has that id (not_found).

Media typeapplication/json

object

error

required

object

code

required

string

Allowed values: invalid unauthorized forbidden not_found conflict too_large rate_limited unavailable internal

message

required

string

details

object

key

additional properties

any

Example

{
  "error": {
    "code": "invalid"
  }
}

429

Over the rate limit; see retry-after.

Media typeapplication/json

object

error

required

object

code

required

string

Allowed values: invalid unauthorized forbidden not_found conflict too_large rate_limited unavailable internal

message

required

string

details

object

key

additional properties

any

Example

{
  "error": {
    "code": "invalid"
  }
}