Retrieve brand list

GET 
/api/v3/brand

Request

Responses

200

Object was fetched successfully

application/json

Schema

Schema

code integer
status string
message stringnullable
details objectnullable

response

object[]

Array [

brand_id integer

Brand ID #

brand string

Deprecated (use "name" instead)

name string

Brand name

brand_addr1 string

Street address 1

brand_addr2 string

Street address 1

brand_city string

City

brand_state string

State/province

brand_postcode string

Postal code

brand_country string

Country

brand_block string

Printable brand address

brand_phone string

Brand phone number

brand_email string

Brand email address

brand_linkedin string

Brand linkedin

brand_twitter string

Brand twitter

brand_facebook string

Brand facebook

brand_yelp string

Brand yelp

brand_youtube string

Brand youtube

brand_instagram string

Brand instagram

brand_pinterest string

Brand pinterest

brand_tiktok string

Brand tiktok

custom_1 string

Custom field 1

custom_2 string

Custom field 2

custom_3 string

Custom field 3

custom_4 string

Custom field 4

custom_5 string

Custom field 5

url_logosmall string

URL to a small version of the brand logo

url_logomedium string

URL to a medium version of the brand logo

url_logolarge string

URL to a large version of the brand logo

url_logohuge string

URL to a huge version of the brand logo

url_logooriginal string

URL to the originally uploaded brand logo

]

Example (from schema)

{
  "code": 0,
  "status": "string",
  "message": "string",
  "details": {},
  "response": [
    {
      "brand_id": 0,
      "brand": "string",
      "name": "string",
      "brand_addr1": "string",
      "brand_addr2": "string",
      "brand_city": "string",
      "brand_state": "string",
      "brand_postcode": "string",
      "brand_country": "string",
      "brand_block": "string",
      "brand_phone": "string",
      "brand_email": "string",
      "brand_linkedin": "string",
      "brand_twitter": "string",
      "brand_facebook": "string",
      "brand_yelp": "string",
      "brand_youtube": "string",
      "brand_instagram": "string",
      "brand_pinterest": "string",
      "brand_tiktok": "string",
      "custom_1": "string",
      "custom_2": "string",
      "custom_3": "string",
      "custom_4": "string",
      "custom_5": "string",
      "url_logosmall": "string",
      "url_logomedium": "string",
      "url_logolarge": "string",
      "url_logohuge": "string",
      "url_logooriginal": "string"
    }
  ]
}

Example 1

{
  "code": 200,
  "status": "OK",
  "message": "",
  "response": [
    {
      "brand_id": 1,
      "brand": "Default"
    }
  ]
}

400

Bad request

application/json

Schema

Schema

code integer
status string
message stringnullable
details objectnullable
response boolean

Example (from schema)

{
  "code": 0,
  "status": "string",
  "message": "string",
  "details": {},
  "response": true
}

Example 1

{
  "code": 400,
  "status": "Error",
  "message": "Missing or invalid parameter.",
  "details": {},
  "response": false
}

401

Authentication error

application/json

Schema

Schema

code integer
status string
message stringnullable
details objectnullable
response boolean

Example (from schema)

{
  "code": 0,
  "status": "string",
  "message": "string",
  "details": {},
  "response": true
}

Example 1

{
  "code": 401,
  "status": "Error",
  "message": "Invalid or incorrect authorization [Missing (basic) authorization header.]",
  "details": {},
  "response": false
}

404

Object not found

application/json

Schema

Schema

code integer
status string
message stringnullable
details objectnullable
response booleannullable

Example (from schema)

{
  "code": 0,
  "status": "string",
  "message": "string",
  "details": {},
  "response": true
}

Example 1

{
  "code": 404,
  "status": "Error",
  "message": "This object does not exist.",
  "details": {},
  "response": null
}

Loading...