How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Nylas Contacts API

Contacts. Read, create, update and delete a grant's contacts and contact groups.

Nylas Contacts API is one of 13 APIs that Nylas publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Contacts. The published artifact set on APIs.io includes an OpenAPI specification.

This API exposes 6 operations across 3 paths, and defines 27 schemas. It is described by OpenAPI 3.2.0, at version v3.

Requests are made against 2 base URLs: https://api.us.nylas.com, https://api.eu.nylas.com.

6 operations 3 paths 27 schemas 1 DELETE3 GET1 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
v3
Base URL
https://api.us.nylas.com
Authentication
HTTP Bearer, HTTP Bearer
Resource Areas
1

Authentication & Security 2

Nylas Contacts API declares 2 security schemes for authenticating requests. It accepts HTTP bearer tokens (NYLAS_ACCESS_TOKEN) (ACCESS_TOKEN). It accepts HTTP bearer tokens (NYLAS_API_KEY) (NYLAS_API_KEY). By default, every request must be authenticated.

  • ACCESS_TOKEN — The Nylas access token for a specific grant. Issued as part of OAuth 2.1 flow token exchange.
  • NYLAS_API_KEY — The Nylas API key provides application-level access to APIs and all grants. You can generate these from the Dashboard. Learn more about [authorizing requests](…

Paths & Operations 6

Across 3 paths, the API surfaces 6 operations — 1 DELETE, 3 GET, 1 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Contacts 6
POST
/v3/grants/{grant_id}/contacts
Create contact
post-contact 2 params body → 200400401429504
GET
/v3/grants/{grant_id}/contacts
Return all contacts
list-contact 9 params → 200400401429504
GET
/v3/grants/{grant_id}/contacts/{contact_id}
Return a contact
get-contact 4 params → 200400401404429504
PUT
/v3/grants/{grant_id}/contacts/{contact_id}
Update a contact
put-contact 3 params body → 200400401429504
DELETE
/v3/grants/{grant_id}/contacts/{contact_id}
Delete a contact
delete-contact 2 params → 200400401429504
GET
/v3/grants/{grant_id}/contacts/groups
Return all Contact Groups
list-contact-groups 4 params → 200400401429504

Schemas 27

The contract defines 27 schemas that model the data the API accepts and returns. The most detailed are contact (22 properties), contact_physical_address (6 properties), contact_group (6 properties), common_response_with_cursor (3 properties). Each schema is shown below with its type and property counts.

contact_manager_name
string
The name of the contact's manager.
contact_suffix
string
(Not supported for EWS) The suffix of a contact's name, if applicable.
contact_office_location
string
The location of the office where the contact works.
contact_picture_url
string
A URL that links to the contact's picture.
contact_birthday
string
The contact's birthday in [ISO-8601 format](https://en.wikipedia.org/wiki/ISO8601Calendardates).
contact_surname
string
The contact's surname.
contact_nickname
string
A custom nickname for the contact.
contact_physical_address
object
An array of physical addresses associated with the contact. Different providers may have different limits on the number of physical addresses. - IMAP/iCloud/Ya…
6 properties 1 required
contact_given_name
string
The contact's given name.
contact_email
object
An array of the contact's email addresses. Different providers may have different limits on the number of email addresses. - IMAP/iCloud/Yahoo: at most one ema…
2 properties 1 required
grant_id
string
The ID of grant for the connected user.
common_response_with_cursor
object
3 properties
contact_job_title
string
The contact's occupation or job title.
common_response
object
2 properties
contact_with_picture
object
contact
object
22 properties
contact_company_name
string
The name of the company that the contact is affiliated with (for example, their workplace).
contact_picture
string
The contact's picture, represented as a Base64-encoded string.
contact_im_address
object
An array of the contact's instant messaging (IM) addresses. Different providers may have different limits on the number of IM addresses. - IMAP/iCloud/Yahoo: a…
2 properties 1 required
id
string
A globally unique object identifier for Microsoft accounts. An email address for Google accounts.
contact_source
string
The source of the contact. For iCloud and IMAP grants, the source is inbox if the contact is parsed from a message. If the contact is created or updated using…
contact_group
object
6 properties
contact_phone_number
object
An array of phone numbers associated with the contact. Different providers may have different limits on the number of phone numbers. - IMAP/iCloud/Yahoo: at mo…
2 properties 1 required
contact_notes
string
Notes about with the contact (for example, their favorite food).
contact_web_page
object
2 properties 1 required
contact_middle_name
string
The contact's middle name.
contact_group_id
object
1 property 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

nylas-contacts-api-openapi.yml Raw ↑

Other APIs Nylas publishes across the network.

Nylas Admin API
Nylas Auth API
Nylas Calendars API
Nylas Drafts API
Nylas Events API
Nylas Grants API
Nylas Messages API
Nylas Scheduling API
Nylas Threads API
Nylas Notifications API
Nylas Notetaker API
Nylas Templates and Workflows API
Where this information came from

This is an independent, third-party profile of Nylas Contacts API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.