Skip to main content
GET
/
v1
/
people
List people
curl --request GET \
  --url https://api.vendaze.com/v1/people \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "full_name": "Maria Silva",
      "emails": [
        {
          "email": "maria@company.com",
          "reminder": "work"
        }
      ],
      "phones": [
        {
          "phone": "+5511999990001",
          "reminder": "mobile"
        }
      ],
      "company_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "owner_user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "position": "Sales Director",
      "ranking": 4,
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z"
    }
  ],
  "meta": {
    "total": 150,
    "page": 1,
    "per_page": 50,
    "has_more": true
  }
}

Documentation Index

Fetch the complete documentation index at: https://developers.vendaze.com/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

OAuth 2.1 access token.

Query Parameters

​
page
integer
default:1
Required range: x >= 1
​
per_page
integer
default:50

Max 100.

Required range: 1 <= x <= 100
​
order_by
string
default:created_at
​
order
enum<string>
default:desc
Available options:
asc,
desc
​
full_name
string

Partial match on full name.

​
email
string

Filter by email address.

​
phone
string

Filter by phone number.

​
company_id
string<uuid>

Filter by linked company.

​
owner_user_id
string<uuid>

Filter by owner.

​
position
string

Partial match on job title.

​
tag
string[]

Filter by tags. AND logic.

​
created_after
string<date-time>
​
created_before
string<date-time>
​
updated_after
string<date-time>
​
updated_before
string<date-time>

Response

List of people returned successfully.

​
data
object[]
​
meta
object