Company API Documentation

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

GET/v1/business

Properties

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

Name
public_id
Type
string
Description
identifier for the business.
Name
slug
Type
string
Description
identifier for the business.
Name
title
Type
string
Description
The title for the business.
Name
description
Type
string
Description
The description of the business.
Name
type
Type
string
Description
type for the business.
Name
industry
Type
string
Description
type for the business.
Name
address
Type
string
Description
address for the business.
Name
address_info
Type
object
Description
object containing address for the business.
Name
borough
Type
string
Description
administrative unit of the business.
Name
address
Type
string
Description
street address for the business.
Name
city
Type
string
Description
name of the city that business is located.
Name
zip
Type
string
Description
zip code of the business.
Name
region
Type
string
Description
DMA region of the business location.
Name
country_code
Type
string
Description
ISO country code of the business location.
Name
phone
Type
string
Description
The phone number for the business.
Name
mail
Type
string
Description
The email for the business.
Name
logo
Type
string
Description
The avatar logo for the business.
Name
image
Type
string
Description
The url image for the business.
Name
media
Type
array
Description
The url media for the business.
Name
latitude
Type
float
Description
latitude in google maps for the business.
Name
longitude
Type
float
Description
latitude in google maps for the business.
Name
attributes
Type
object
Description
service details of a business.
Name
work_time
Type
object
Description
work time datails for the business.
Name
saturday
Type
array
Description
work hours on saturday.
Name
open
Type
object
Description
opening time of the business.
Name
hour
Type
integer
Description
hours in the 24-hour format of the business.
Name
minute
Type
integer
Description
minutes of the business.
Name
close
Type
object
Description
closing time of the business.
Name
business_links
Type
array
Description
available interactions with the business.
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
person
Type
array
Description
available contacts for the business.
Name
person-id
Type
string
Description
ids for contacts of the business.
Name
position
Type
string
Description
position of contacts.
Name
created
Type
string
Description
position of contacts.
Name
last_updated
Type
string
Description
when business data was updated.
Name
price_level
Type
string
Description
price level for the business.
Name
employees_count
Type
integer
Description
count of employees of the business.
Name
founded
Type
integer
Description
time of founded.
Name
is_claimed
Type
boolean
Description
show if its verified by its owner.
Name
brand-id
Type
string
Description
identifier for the brand.
Name
company-id
Type
string
Description
identifier for the company.
Name
status
Type
string
Description
situation of the business.
Name
time_update
Type
string
Description
time updated for the business.
Name
version
Type
string
Description
version of the business.
Name
author-id
Type
string
Description
identifier for the author.

Response


{
"id": "XXXXXXXXXXXXXXXXXXXXXXX",
"publicId": "XXXXXXXXXXXXXXXXXXX",
"slug":"",
"title": "",
"type": "",
"tags": [
  "",
  ""
],
"image": "",
"startDate": "",
"endDate": "",
"timezone": "",
"host": [
  {
    "type": "company",
    "publicId": "XXXXXXXXXXXXXXXXXXX"
  },
  {
    "type": "person",
    "publicId": "XXXXXXXXXXXXXXXXXXX"
  }
],
"guest": [
  "",
  ""
],    
"links": [
  {
    "type": "website",
    "title": "contentapi.io",
    "url": "https://www.contentapi.io/"
  },
  {
    "type": "google-maps",
    "title": "Google Maps",
    "url": "https://www.google.com/maps?cid=2412308833485550683&hl=en&gl=US"
  }
],
"address": "1697 W Sherman Blvd, Muskegon, MI 49441",
"addressInfo": {
  "borough": "Glenside",
  "address": "1697 W Sherman Blvd",
  "zip": "49441",
  "city": "Muskegon",
  "region": "Michigan",
  "country": "US"
},
"latitude": 43.205452799999996,
"longitude": -86.2853444,
"claimed": true,
"status": "deleted",
"date": "2023-02-15T12:50:30",
"version": "1",
"authorId": ""
}

GET/v1/business

List all business

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

Optional attributes

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

Request

GET

/v1/business

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