Skip to main content
TroopyDocs
Open Troopy
Troopy

API reference / CRM

List people

The CRM's people, most recently changed first: one record each, however many lists they are on.

get/api/v1/people

Authorization

HeaderAuthorization: Bearer <API key>
Or the headerX-API-Key: <API key>
API keyMake one in Troopy under Settings > API keys. It acts as you, in its workspace.
Scopescrm:read

Other ways to call it

CLItroopy people list
MCP tooltroopy_list_people
Rate limit120 calls in 60 seconds, for each key

Query parameters

pageinteger

1-based page number

Default 1 · At least 1

limitinteger

Items per page, at most 100

Default 20 · At least 1 · At most 100

qstring

Text in their name, email, company or domain

At least 1 characters · At most 100 characters

Response

200 · application/json
data*array<object>
17 properties
id*string

A 24-character id

name*string | null
email*string | null
emailStatus*enum<string> | null

Whether the email reaches them, once a verifier checked it

validriskyinvalidunknown

stage*enum<string> | null

Where they stand with outreach: written to, wrote back, keen, or not; null before any

contactedrepliedinterestednot_interested

linkedin*string | null

Their LinkedIn profile's address

title*string | null
phone*string | null
location*string | null
company*string | null
domain*string | null

Their company's domain

companyId*string | null

Their company's record, found by its domain

source*object

Where it first came from

3 properties
kind*enum<string>

importappapiteammateprovider

url*string | null
at*string

ISO 8601 date and time

createdBy*object

Who wrote it

3 properties
type*enum<string>

personagentapi

id*string
name*string
updatedBy*object

Who wrote it

3 properties
type*enum<string>

personagentapi

id*string
name*string
createdAt*string

ISO 8601 date and time

updatedAt*string

ISO 8601 date and time

pagination*object
4 properties
page*integer
limit*integer
total*integer
pages*integer

Errors

400 invalid_inputFix the field named in detail. Each operation's schema is in /api/v1/openapi.json.
401 unauthorizedSend an API key as `Authorization: Bearer tr_live_...`. Create one in Troopy under Settings.
403 forbiddenThe key lacks a scope this operation needs, or its owner lacks the role. detail says which; create a key with the scope, or ask an organization owner or admin.
429 rate_limitedWait the number of seconds in Retry-After, then retry.