People

Customers and contacts.

GET List people
POST Create a person
GET Get a person
PATCH Update a person
DELETE Archive a person

#List people

GET/api/v1/people

Operation list_people · needs scope people:read

Parameter	In	Type	Notes
`limit`	query	integer	Page size, at most 100.
`cursor`	query	string	`pagination.nextCursor` from the previous page.
`sort`	query	-updated_at \| updated_at \| -created_at \| created_at	Sort order. A leading minus sorts descending.
`updated_since`	query	datetime	Only records updated at or after this instant.
`q`	query	string	Free-text search over the object's main columns.
`email`	query	string	Only records whose email equals this.
`lifecycle_stage`	query	string	Only records whose lifecycle_stage equals this.
`owner`	query	string	Only records whose owner equals this.
`company`	query	string	Only records linked to this company (public id).
`lead_source`	query	string	Only records whose lead_source equals this.
`country`	query	string	Only records whose country equals this.
`city`	query	string	Only records whose city equals this.
`title`	query	string	Only records whose title equals this.

bash

curl https://synconone.com/api/v1/people \
  -H "Authorization: Bearer sk_live_YOUR_KEY"

json

{
  "data": [
    {
      "id": "pr_1a2b3c4d5e6f7a8b",
      "object": "string",
      "display_name": "Emily Carter",
      "first_name": "Emily",
      "last_name": "Carter",
      "email": "[email protected]",
      "phone": "+61 400 000 000",
      "whatsapp": "string",
      "title": "Annual plan renewal",
      "department": "string"
    }
  ],
  "pagination": {
    "nextCursor": null,
    "hasMore": false
  }
}

Errors: 401: Missing, invalid, revoked or expired API key. · 403: The key lacks the scope, or its role cannot do this. · 422: Validation failed. · 429: Rate limited. Honour Retry-After.. See errors.

#Create a person

POST/api/v1/people

Operation create_person · needs scope people:write

Built-in and custom fields by key. Relations take public ids.

Body field	Type	Notes
`display_name`	string	Name
`first_name`	string	First name
`last_name`	string	Last name
`email`	string	Email
`phone`	string	Phone
`whatsapp`	string	WhatsApp
`title`	string	Job title
`department`	string	Department
`company`	string	Company
`lifecycle_stage`	lead \| prospect \| customer \| churned	Lifecycle stage
`lead_source`	string	Lead source
`owner`	string	Owner
`linkedin_url`	string	LinkedIn
`city`	string	City
`region`	string	Region
`country`	string	Country
`time_zone`	string	Time zone
`language`	string	Language
`tags`	list of string	Tags
`description`	string	About
`do_not_contact`	boolean	Do not contact

bash

curl -X POST https://synconone.com/api/v1/people \
  -H "Authorization: Bearer sk_live_YOUR_KEY" \
  -H "Content-Type: application/json" \
  -d '{"display_name":"Emily Carter","first_name":"Emily","last_name":"Carter","email":"[email protected]","phone":"+61 400 000 000"}'

json

{
  "data": {
    "id": "pr_1a2b3c4d5e6f7a8b",
    "object": "string",
    "display_name": "Emily Carter",
    "first_name": "Emily",
    "last_name": "Carter",
    "email": "[email protected]",
    "phone": "+61 400 000 000",
    "whatsapp": "string",
    "title": "Annual plan renewal",
    "department": "string"
  }
}

Errors: 401: Missing, invalid, revoked or expired API key. · 403: The key lacks the scope, or its role cannot do this. · 409: Conflict, approval required, or idempotent request in progress. · 422: Validation failed. · 429: Rate limited. Honour Retry-After.. See errors.

#Get a person

GET/api/v1/people/{id}

Operation get_person · needs scope people:read

Parameter	In	Type	Notes
`id` required	path	string	Public id of the person.

bash

curl https://synconone.com/api/v1/people/pr_1a2b3c4d5e6f7a8b \
  -H "Authorization: Bearer sk_live_YOUR_KEY"

json

{
  "data": {
    "id": "pr_1a2b3c4d5e6f7a8b",
    "object": "string",
    "display_name": "Emily Carter",
    "first_name": "Emily",
    "last_name": "Carter",
    "email": "[email protected]",
    "phone": "+61 400 000 000",
    "whatsapp": "string",
    "title": "Annual plan renewal",
    "department": "string"
  }
}

Errors: 401: Missing, invalid, revoked or expired API key. · 403: The key lacks the scope, or its role cannot do this. · 404: Not found, or not visible to this key. · 422: Validation failed. · 429: Rate limited. Honour Retry-After.. See errors.

#Update a person

PATCH/api/v1/people/{id}

Operation update_person · needs scope people:write

Only the keys sent are changed. Fields are applied in order; the first refusal stops the request and details.applied lists what was already changed.

Parameter	In	Type	Notes
`id` required	path	string	Public id of the person.

Body field	Type	Notes
`display_name`	string	Name
`first_name`	string	First name
`last_name`	string	Last name
`email`	string	Email
`phone`	string	Phone
`whatsapp`	string	WhatsApp
`title`	string	Job title
`department`	string	Department
`company`	string	Company
`lifecycle_stage`	lead \| prospect \| customer \| churned	Lifecycle stage
`lead_source`	string	Lead source
`owner`	string	Owner
`linkedin_url`	string	LinkedIn
`city`	string	City
`region`	string	Region
`country`	string	Country
`time_zone`	string	Time zone
`language`	string	Language
`tags`	list of string	Tags
`description`	string	About
`do_not_contact`	boolean	Do not contact

bash

curl -X PATCH https://synconone.com/api/v1/people/pr_1a2b3c4d5e6f7a8b \
  -H "Authorization: Bearer sk_live_YOUR_KEY" \
  -H "Content-Type: application/json" \
  -d '{"display_name":"Emily Carter","first_name":"Emily","last_name":"Carter","email":"[email protected]","phone":"+61 400 000 000"}'

json

{
  "data": {
    "id": "pr_1a2b3c4d5e6f7a8b",
    "object": "string",
    "display_name": "Emily Carter",
    "first_name": "Emily",
    "last_name": "Carter",
    "email": "[email protected]",
    "phone": "+61 400 000 000",
    "whatsapp": "string",
    "title": "Annual plan renewal",
    "department": "string"
  }
}

Errors: 401: Missing, invalid, revoked or expired API key. · 403: The key lacks the scope, or its role cannot do this. · 404: Not found, or not visible to this key. · 409: Conflict, approval required, or idempotent request in progress. · 422: Validation failed. · 429: Rate limited. Honour Retry-After.. See errors.

#Archive a person

DELETE/api/v1/people/{id}

Operation archive_person · needs scope people:write

Archives the record (it can be restored in the app). Nothing is destroyed.

Parameter	In	Type	Notes
`id` required	path	string	Public id of the person.

bash

curl -X DELETE https://synconone.com/api/v1/people/pr_1a2b3c4d5e6f7a8b \
  -H "Authorization: Bearer sk_live_YOUR_KEY"

json

{
  "data": {
    "id": "pr_1a2b3c4d5e6f7a8b",
    "object": "string",
    "archived": true
  }
}