Get business attributes

GET 
/api/v2/businesses/:business_id/google/attributes

This endpoint allows you to view the attributes for a business.

Request

Path Parameters

business_id stringrequired

Query Parameters

lang locale

Default value: en

Get results in a specific language

country string
Default value: US
Country for which available attributes will be fetched
Example: US

Responses

200

application/json

Schema

Schema

items

object[]

required

Array [

id stringrequired

Attribute ID

name stringrequired

Translated attribute name

data

object

required

anyOf

AttributeBool

type stringrequired

Possible values: [BOOL]

value booleannullable

AttributeEnum

type stringrequired

Possible values: [ENUM]

value stringnullable

AttributeRepeatableEnum

type stringrequired

Possible values: [REPEATABLE_ENUM]

value

object

nullable

set_values string[]

unset_values string[]

AttributeUrl

type stringrequired

Possible values: [URL]

value stringnullable

AttributeRepeatableUrl

type stringrequired

Possible values: [REPEATABLE_URL]

value string[]nullable

]

Example (from schema)

{
  "items": [
    {
      "id": "pay_debit_card",
      "name": "Debit cards",
      "data": {}
    }
  ]
}

400

application/json

Schema

Schema

statusCode integerrequired

HTTP status code

message string

Error message

error string

Error name

Example (from schema)

{
  "statusCode": 404,
  "message": "Cannot find item",
  "error": "Not Found"
}

401

application/json

Schema

Schema

statusCode integerrequired

HTTP status code

message string

Error message

error string

Error name

Example (from schema)

{
  "statusCode": 404,
  "message": "Cannot find item",
  "error": "Not Found"
}

403

application/json

Schema

Schema

statusCode integerrequired

HTTP status code

message string

Error message

error string

Error name

Example (from schema)

{
  "statusCode": 404,
  "message": "Cannot find item",
  "error": "Not Found"
}

404

application/json

Schema

Schema

statusCode integerrequired

HTTP status code

message string

Error message

error string

Error name

Example (from schema)

{
  "statusCode": 404,
  "message": "Cannot find item",
  "error": "Not Found"
}

422

application/json

Schema

Schema

statusCode integerrequired

HTTP status code

message string

Error message

errors

object[]

required

Array [

path stringrequired

Possible values: non-empty

Path to the property with the error

errors

object[]

required

Array [

type stringrequired

Possible values: non-empty

Error type

message stringrequired

Error message

]

]

Example (from schema)

{
  "statusCode": 404,
  "message": "Cannot find item",
  "errors": [
    {
      "path": "business.id",
      "errors": [
        {
          "type": "object_required_property",
          "message": "Required property"
        }
      ]
    }
  ]
}

500

application/json

Schema

Schema

statusCode integerrequired

HTTP status code

message string

Error message

error string

Error name

Example (from schema)

{
  "statusCode": 404,
  "message": "Cannot find item",
  "error": "Not Found"
}

Loading...