List CRM People - Zeeg Developer Hub

{ "success": true, "status": 200, "data": { "pagination": { "totalItems": 1, "perPage": 10, "currentPage": 1, "lastPage": 1, "hasPreviousPage": false, "hasNextPage": false }, "people": [ { "id": "b2c3d4e5-f6a7-8901-bcde-f23456789012", "firstName": "Jane", "lastName": "Doe", "salutation": null, "emails": [ "jane.doe@acme.com" ], "jobTitle": "Head of Product", "description": null, "phoneNumber": null, "primaryLocation": null, "avatarUrl": null, "company": null, "socials": { "linkedin": null, "twitter": null, "facebook": null, "instagram": null }, "customAttributes": {}, "createdAt": "2025-01-15T09:00:00+00:00", "updatedAt": "2025-01-15T09:00:00+00:00" } ] } }

Authorizations

Authorization

string

header

required

Query Parameters

page

integer

default:1

Page number.

Required range: x >= 1

perPage

integer

default:10

Number of records per page.

Required range: 1 <= x <= 100

sortBy

string

default:created_at

Field to sort by.

sortOrder

enum<string>

default:asc

Sort direction.

Available options:

asc,

desc

Response

success

boolean

Example:

true

status

integer

Example:

200

data

object

Hide child attributes

data.pagination

object

Hide child attributes

data.pagination.totalItems

integer

data.pagination.perPage

integer

data.pagination.currentPage

integer

data.pagination.lastPage

integer

data.pagination.hasPreviousPage

boolean

data.pagination.hasNextPage

boolean

data.people

object[]

Hide child attributes

data.people.id

string<uuid>

required

Unique identifier for the person record.

Example:

"b2c3d4e5-f6a7-8901-bcde-f23456789012"

data.people.firstName

string | null

required

First name.

Example:

"Jane"

data.people.lastName

string | null

required

Last name.

Example:

"Doe"

data.people.salutation

string | null

required

Salutation or title (e.g. Mr, Ms, Dr).

Example:

"Ms"

data.people.emails

string<email>[]

required

List of email addresses. The first entry is the primary email.

Example:

["jane.doe@acme.com"]

data.people.jobTitle

string | null

required

Job title or role.

Example:

"Head of Product"

data.people.description

string | null

required

Free-text description or notes about the person.

Example:

"Key decision-maker at Acme Corp."

data.people.phoneNumber

string | null

required

Primary phone number.

Example:

"+4930123456789"

data.people.primaryLocation

string | null

required

Primary location or city.

Example:

"Berlin, Germany"

data.people.avatarUrl

string | null

required

URL of the person's avatar image.

Example:

null

data.people.company

object

required

The company this person is associated with, if any.

Hide child attributes

data.people.company.id

string<uuid>

data.people.company.name

string | null

data.people.company.domain

string | null

data.people.socials

object

required

Social profile links.

Hide child attributes

data.people.socials.linkedin

string | null

Example:

"https://linkedin.com/in/janedoe"

data.people.socials.twitter

string | null

Example:

null

data.people.socials.facebook

string | null

Example:

null

data.people.socials.instagram

string | null

Example:

null

data.people.customAttributes

object

required

Key/value pairs for custom attributes defined on the people object.

Example:

{}

data.people.createdAt

string<date-time>

required

ISO 8601 timestamp when the record was created.

Example:

"2025-01-15T09:00:00+00:00"

data.people.updatedAt

string<date-time>

required

ISO 8601 timestamp when the record was last updated.

Example:

"2025-06-01T12:00:00+00:00"

Documentation Index

Authorizations

Query Parameters

Response