people

2 endpoints at a glance

Method	Path	Summary
GET	/people/{person_id}	Get Person
GET	/people/by-contact	Person By Contact

people

---

Person By Contact

GET

/people/by-contact

The shared person for one of the viewer's OWN contacts (or null).

Lets the contact-detail page source the person's cross-user interactions.
404 if the viewer doesn't own that contact; {"person": null} when the
contact has never been linked (so no person exists yet).

Parameters

Header Parameters

authorization

Query Parameters

addressbook_id*

Type

string

Required

uid*

Type

string

Required

Responses

Successful Response

Content-Type

application/json

{

  

"additionalProperties": "string"

}

GET

/people/by-contact

Playground

Headers

authorization

Variables

Key

Value

addressbook_id*

uid*

Samples

---

Get Person

GET

/people/{person_id}

Display data for a person. 404 unless the viewer can see them (a matching
contact, or ≥1 referencing entity they can read) — no existence leak.

Parameters

Header Parameters

authorization

Path Parameters

person_id*

Type

string

Required

Responses

Successful Response

Content-Type

application/json

{

  

"additionalProperties": "string"

}

GET

/people/{person_id}

Playground

Headers

authorization

Variables

Key

Value

person_id*

Samples

---