Company API Documentation

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

GET/v1/company

Properties

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

Name
privateId
Type
string
Description
identifier for the company.
Name
publicId
Type
string
Description
Public identifier for the company.
Name
slug
Type
string
Description
identifier for the company.
Name
claimed
Type
boolean
Description
Show if its verified by its owner.
Name
status
Type
string
Description
Situation of the company.
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": "",
"foundingLocation": "",
"foundingDate": "",
"employeesCount": 1000,
"businessModel": "b2b",
"tags": [
  "",
  ""
],
"logo": "https://s1.webstatic.net/logo.png",
"media": [
  "https://sr1.webstatic.net/photo.jpg",
  "https://sr1.webstatic.net/video.mp4",
  "https://sr1.webstatic.net/audio.mp3",
  "https://sr1.webstatic.net/document.pdf"
],
"name": {
  "eng": "Pazh",
  "per": "پاژ",
  "arb": ""
},
"slogan": {
  "eng": "",
  "per": "",
  "arb": ""
},
"description": {
  "eng": "",
  "per": "",
  "arb": ""
},
"links": [
  {
    "type": "website",
    "title": "contentapi.io",
    "url": "https://www.contentapi.io/"
  }
],
"person":[
  {
    "personId": "XXXXXXXXXXXXXXXXXXX",
    "position": "CEO",
    "start": "2016-07-22 16:21:43",
    "end": "2023-08-21 17:19:52"
  }
],
"localBusinessId": [
  "",
  ""
],
"brandId": [
  "",
  ""
],
"contentId": {
  "eng": "XXXXXXXXXXXXXXXXXXXXXXX",
  "per": "XXXXXXXXXXXXXXXXXXXXXXX",
  "arb": "XXXXXXXXXXXXXXXXXXXXXXX"
},
"claimed": true,
"status": "deleted",
"date": "2023-02-15T12:50:30",
"version": "1",
"authorId": ""
}

GET/v1/company

List all companies

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

Optional attributes

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

Request

GET

/v1/company

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