Appearance

List Contacts ​

Endpoint ​

http
GET /unified/calendar/contacts
Integrations supported
  • Google Calendar
  • Outlook Calendar

Query parameters ​

Refer Specifying query parameters in Truto APIs

integrated_account_id
string · uuid
REQUIRED · 

The ID of the integrated account to use for the request.

Example: 62f44730-dd91-461e-bd6a-aedd9e0ad79d
truto_response_format
string

The format of the response.

  • unified will return the response with unified mappings applied.
  • raw will return the raw response from the remote API.
  • normalized will apply the unified mappings and return the data in a normalized format.

Defaults to unified.

All possible enum values:
  • unified
  • raw
  • normalized
Example: unified
truto_key_by
string

By default the result attribute is an array of objects. This parameter allows you to specify a field in each result objects to use as key, which transforms the result array into an object with the array items keyed by the field. This is useful for when you want to use the result as a lookup table.

Example: id
truto_ignore_limit
boolean

Ignores the limit query parameter.

truto_ignore_remote_data
boolean

Excludes the remote_data attribute from the response.

truto_exclude_fields
array

Array of fields to exclude from the response.

Example: truto_exclude_fields[]=id&truto_exclude_fields[]=name
remote_query
object

Query parameters to pass to the underlying API without any transformations. Refer this guide to see how to structure the query parameters.

Example: remote_query[foo]=bar
search_term
string

The search term.

Required in
  • Google Calendar
Supported in
  • Outlook Calendar
name
string

The contact's full name

Supported in
  • Google Calendar
  • Outlook Calendar
email_addresses
array
Supported in
  • Google Calendar

Response Body ​

result
object[]

List of Contacts

id
string
REQUIRED · 

The contact's unique identifier

Supported in
  • Google Calendar
  • Outlook Calendar
first_name
string

The contact's first name

Supported in
  • Google Calendar
  • Outlook Calendar
middle_name
string

The contact's middle name

Supported in
  • Google Calendar
last_name
string

The contact's last name

Supported in
  • Google Calendar
  • Outlook Calendar
name
string

The contact's full name

Supported in
  • Google Calendar
  • Outlook Calendar
title
string

The contact's job title

Supported in
  • Outlook Calendar
addresses
object[]
Supported in
  • Google Calendar
id
string

The unique identifier of the address

street_1
string

Line 1 of the street address

street_2
string

Line 2 of the street address

city
string

The city

state
string

The state

postal_code
string

The postal code

country
string

The country

type
string

The address type

email_addresses
object[]
Supported in
  • Google Calendar
  • Outlook Calendar
id
string

The unique identifier of the email addresses

email
string

The email address

type
string

The email address type

phone_numbers
object[]
Supported in
  • Outlook Calendar
id
string

The unique identifier of the phone number

number
string

The phone number

extension
string

The extension of the phone number

type
string

The phone number type

tags
object[]

The contact's tags

id
string

The tag's unique identifier

name
string

The tag's name

last_activity_at
string · date-time

The date and time of the contact's last activity

created_at
string · date-time

The date and time of the contact's creation

updated_at
string · date-time

The date and time of the contact's last update

remote_data
object

Raw data returned from the remote API call.

next_cursor
string

The cursor to use for the next page of results. Pass this value as next_cursor in the query parameter in the next request to get the next page of results.