NYnylas
Contacts

Return all Contact Groups

Changed on

Return the Contact Groups associated with a grant. This endpoint is not supported for EWS. See Work with Contact Groups for provider-specific behavior.

get/v3/grants/{grant_id}/contacts/groups

Request

  • Base URL
    https://api.us.nylas.com
  • Auth
    • HTTP bearer
    • or HTTP bearer

Query parameters

limitinteger

The maximum number of objects to return. See Pagination for more information.

page_tokenstring

An identifier that specifies which page of data to return. You can get this value from the next_cursor response field. See Pagination for more information.

selectstring

Specify fields that you want Nylas to return, as a comma-separated list (for example, select=id,updated_at). This allows you to receive only the portion of object data that you're interested in. You can use select to optimize response size and reduce latency by limiting queries to only the information that you need.

Response

Contact Groups

request_idstring

The request ID.

next_cursorstring nullable

A cursor pointing to the next page of results for the request.

Example response

{
  "request_id": "5fa64c92-e840-4357-86b9-2aa364d35b88",
  "next_cursor": "CigKGjRlaDdyNGQydTFqbWJ0bGo5a2QxdWJtdDZnGAEggIDAu7fw7bEYGg8IABIAGPjh2PGEi_0CIAEiBwgCEOqs6i4="
}

Changes

  • a669a04b02baRevision changes
    • breaking

      the //// response's property type changed from object to array for status

  • 763d6b969cd7Revision changes
    • info

      added the optional property / to the response with the status