Skip to main content
TroopyDocs
Open Troopy
Troopy

API reference / CRM

List the CRM's lists

The workspace's lists of people or companies, most recently changed first, with how many rows each has. Get one for its columns.

get/api/v1/lists

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 lists list
MCP tooltroopy_list_lists
Rate limit120 calls in 60 seconds, for each key

Response

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

A 24-character id

name*string
kind*enum<string>

peoplecompanies

rows*integer
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

Errors

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.