Brand API Documentation

As the name suggests, brands are a core part of Pazh — the very reason Pazh exists is so you can have secure conversations with your brands. On this page, we'll dive into the different contact endpoints you can use to manage brand programmatically. We'll look at how to query, create, update, and delete brand.

GET/v1/brand

Properties

This endpoint allows you to retrieve a paginated list of all your brands. By default, a maximum of ten brands are shown per page.

Name
id
Type
string
Description
Identifier for the brand.
Name
publicId
Type
string
Description
Public identifier for the brand.
Name
slug
Type
string
Description
Identifier for the brand.
Name
type
Type
string
Description
type for the brand.
Name
industry
Type
string
Description
type for the brand.
Name
tags
Type
array
Description
tags for the brand.
Name
logo
Type
string
Description
The avatar logo for the brand.
Name
name
Type
object
Description
The name of the brand.
Name
eng
Type
string
Description
The name of the brand in English.
Name
per
Type
string
Description
The name of the brand in Persian.
Name
arb
Type
string
Description
The name of the brand in Arabic.
Name
slogan
Type
object
Description
The slogan of the brand.
Name
eng
Type
string
Description
The slogan of the brand in English.
Name
per
Type
string
Description
The slogan of the brand in Persian.
Name
arb
Type
string
Description
The slogan of the brand in Arabic.
Name
description
Type
object
Description
The description of the brand.
Name
eng
Type
string
Description
The description of the brand in English.
Name
per
Type
string
Description
The description of the brand in Persian.
Name
arb
Type
string
Description
The description of the brand in Arabic.
Name
color
Type
array
Description
The color for the brand.
Name
type
Type
string
Description
The type of the color.
Name
hex
Type
string
Description
The hex of the color.
Name
links
Type
array
Description
available interactions with the brand.
Name
type
Type
string
Description
type of element.
Name
title
Type
string
Description
title of element.
Name
url
Type
string
Description
url for the links.
Name
foundingLocation
Type
string
Description
name of the location that brand is located.
Name
contentId
Type
object
Description
Identifier for the content.
Name
eng
Type
string
Description
The id of the content in English.
Name
per
Type
string
Description
The id of the content in Persian.
Name
arb
Type
string
Description
The id of the content in Arabic.
Name
companyId
Type
string
Description
identifier for the company.
Name
localBusinessId
Type
array
Description
identifier for the business.
Name
claimed
Type
boolean
Description
Show if its verified by its owner.
Name
status
Type
string
Description
Situation of the brand.
Name
date
Type
string
Description
Time updated.
Name
version
Type
string
Description
Version.
Name
author-id
Type
string
Description
Identifier for the author.

Response

[
{
"id": "XXXXXXXXXXXXXXXXXXXXXXX",
"publicId": "XXXXXXXXXXXXXXXXXXX",
"slug":"",
"type": "",
"industry": "",
"tags": [
  "",
  ""
],
"logo": "https://s1.webstatic.net/logo.png",
"name": {
  "eng": "Pazh",
  "per": "پاژ",
  "arb": ""
},
"slogan": {
  "eng": "",
  "per": "",
  "arb": ""
},
"description": {
  "eng": "",
  "per": "",
  "arb": ""
},
"color":[
  {
    "type": "primery-color",
    "hex": "#863213"
  },
  {
    "type": "secondary-color",
    "hex": "#363313"
  }
],
"links": [
  {
    "type": "website",
    "title": "contentapi.io",
    "url": "https://www.contentapi.io/"
  }
],
"foundingLocation": "",
"contentId": {
  "eng": "XXXXXXXXXXXXXXXXXXXXXXX",
  "per": "XXXXXXXXXXXXXXXXXXXXXXX",
  "arb": "XXXXXXXXXXXXXXXXXXXXXXX"
},
"companyId": null,
"localBusinessId": [
  "",
  ""
],
"claimed": true,
"status": "deleted",
"date": "2023-02-15T12:50:30",
"version": "1",
"authorId": ""
}
]

GET/v1/brand

List all brands

This endpoint allows you to retrieve a paginated list of all your brands. By default, a maximum of ten brands are shown per page.

Optional attributes

Name
limit
Type
integer
Description
Limit the number of brand returned.

Request

GET

/v1/brand

curl -G https://api.contentapi.io/v1/brand \
  -H "Authorization: Bearer {token}" \
  -d active=true \
  -d limit=10