Person API Documentation

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

GET/v1/personal

Properties

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

Name
id
Type
string
Description
Identifier for the person.
Name
public_id
Type
string
Description
Public identifier for the person.
Name
slug
Type
string
Description
Identifier for the person.
Name
firstName
Type
string
Description
Firstname of the person in persian.
Name
lastName
Type
string
Description
Lastname of the person in persian.
Name
personNumber
Type
string
Description
Individual identifier for the person.
Name
passportNumber
Type
string
Description
Identifier for the passport of the person.
Name
firstNameLatin
Type
string
Description
Firstname of the person.
Name
lastNameLatin
Type
object
Description
Lastname of the person.
Name
birthDay
Type
string
Description
Birthday of the person.
Name
birthCountry
Type
string
Description
Birthcountry of the person.
Name
gender
Type
string
Description
Gender of the person.
Name
phone
Type
array
Description
Phone number of the person.
Name
mail
Type
array
Description
Email of the person.
Name
address
Type
array
Description
Address for the person.
Name
address_info
Type
object
Description
Object containing address for the person.
Name
borough
Type
string
Description
Administrative unit of the address.
Name
address
Type
string
Description
Street address.
Name
city
Type
string
Description
Name of the city.
Name
zip
Type
string
Description
zip code.
Name
region
Type
string
Description
DMA region of the person location.
Name
country_code
Type
string
Description
ISO country code of the person location.
Name
latitude
Type
float
Description
Latitude in google maps for the person address.
Name
longitude
Type
float
Description
Latitude in google maps for the person address.
Name
name
Type
string
Description
Name of the person location.
Name
photo
Type
string
Description
The url photo of the person.
Name
media
Type
array
Description
The url media of the person.
Name
tags
Type
array
Description
Tags of the person.
Name
links
Type
array
Description
Available interactions with the person.
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
job
Type
array
Description
Jobs of the person.
Name
company_id
Type
string
Description
Identifier of the person at the company.
Name
position
Type
string
Description
Position of the person.
Name
claimed
Type
boolean
Description
Show if its verified by its owner.
Name
status
Type
string
Description
Situation of the person.
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":"",
    "firstName": "آتوسا",
    "lastName": "کیانی",
    "personNumber": "3380198170",
    "passportNumber": "2819357281",
    "firstNameLatin": "Atossa",
    "lastNameLatin": "Kiani",
    "birthDay": 20230215,
    "birthPlace": "Muskegon",
    "birthCountry": "US",
    "gender": 0,
    "phone": [
      "+18188500070"
    ],
    "mail": [
      "atoosa.kiani@gmail.com"
    ],
    "address": [
      {
        "address": "1697 W Sherman Blvd, Muskegon, MI 49441",
        "address_info": {
          "borough": "Glenside",
          "address": "1697 W Sherman Blvd",
          "zip": "49441",
          "city": "Muskegon",
          "region": "Michigan",
          "country_code": "US"
        },
        "latitude": 43.205452799999996,
        "longitude": -86.2853444,
        "name": "Home"
      }
    ],
    "photo": "https://sr1.webstatic.net/photo.jpg",
    "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"
    ],
    "tags": [
      "web-designer"
    ],
    "links": [
      {
        "type": "instagram",
        "title": "Instagram",
        "url": "https://www.instagram.com/YOURNAME"
      },
      {
        "type": "facebook",
        "title": "Facebook",
        "url": "https://www.facebook.com/YOURNAME"
      }
    ],
    "job": [
      {
        "company_id": "XXXXXXXXXXXXXXXXXXX",
        "position": "CEO"
      }
    ],
    "claimed": true,
    "status": "deleted",
    "date": "2023-02-15T12:50:30",
    "version": "1",
    "author-id": ""
  }

GET/v1/personal

List all personal informations

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

Optional attributes

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

Request

GET

/v1/personal

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