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

FieldTypeDescription
target *Target
objectobject
object
FieldTypeDescription
querystringOptional provider-specific search string.
filterobject
limitinteger (minimum 1; maximum 500; default 50)
cursorstring
filter
FieldTypeDescription
namestring
emailstring (email)
organizationstring

Result

FieldTypeDescription
items *object[]
next_cursorstringPresent when more results are available.
estimated_totalinteger
items[]
FieldTypeDescription
given_namestring
family_namestring
display_namestring
emailsstring (email)[]
phonesstring[]
organizationstring
job_titlestring

Examples

by email

{
  "target": {
    "system": "google_contacts"
  },
  "object": {
    "filter": {
      "email": "jane@example.com"
    }
  }
}

Profiles