List contacts
org.intentschema.productivity.contacts.contact.list.v1
JSON: bare · @sha256:b8f69f74c07c…
Hash: sha256:b8f69f74c07c86a984eb19f4a822a488dbc2ad03ce2ee32d8484526bb8e82677
List the contact directory by name, email, or organization.
Payload
| Field | Type | Description |
target * | Target | |
object | object | |
object
| Field | Type | Description |
query | string | Optional provider-specific search string. |
filter | object | |
limit | integer (minimum 1; maximum 500; default 50) | |
cursor | string | |
filter
| Field | Type | Description |
name | string | |
email | string (email) | |
organization | string | |
Result
| Field | Type | Description |
items * | object[] | |
next_cursor | string | Present when more results are available. |
estimated_total | integer | |
items[]
| Field | Type | Description |
given_name | string | |
family_name | string | |
display_name | string | |
emails | string (email)[] | |
phones | string[] | |
organization | string | |
job_title | string | |
Examples
by email
{
"target": {
"system": "google_contacts"
},
"object": {
"filter": {
"email": "jane@example.com"
}
}
}
Profiles