User API Documentation

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

GET/v1/user

Properties

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

Name
id
Type
string
Description
Identifier for the use
Name
publicId
Type
string
Description
Public identifier for the user.
Name
slug
Type
string
Description
Identifier for the use
Name
fullname
Type
string
Description
Full name of the user.
Name
username
Type
string
Description
User name of the user.
Name
password
Type
string
Description
Password of the user.
Name
emailAddress
Type
string
Description
Email of the user.
Name
emailAddressConfirmed
Type
boolean
Description
Show if its comfirmed or not.
Name
phoneNumber
Type
string
Description
Phone number of the user.
Name
phoneNumberConfirmed
Type
boolean
Description
Show if its comfirmed or not.
Name
claimed
Type
boolean
Description
Show if its verified by its owner.
Name
status
Type
string
Description
Situation of the user.
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":"",
    "fullname": "",
    "username": "",
    "password": "",
    "emailAddress": "",
    "emailAddressConfirmed": true,
    "phoneNumber": "",
    "phoneNumberConfirmed": true,
    "claimed": true,
    "status": "deleted",
    "date": "2023-02-15T12:50:30",
    "version": "1",
    "authorId": ""
  }

GET/v1/user

List all users

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

Optional attributes

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

Request

GET

/v1/user

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