Connector credentials

List credentials

List credentials for the specified provider.

get/v3/connectors/{provider}/creds

Path parameters

provider'google' | 'microsoft' | 'imap' | 'icloud' | 'yahoo' | 'ews' | 'virtual-calendar' | 'zoom' | 'nylas' required
Example:google

Query parameters

limitinteger

Limit the number of credentials Nylas returns.

offsetinteger

Offset the results.

sort_by'created_at' | 'updated_at'

Sort the returned credentials using the contents of the specified field.

order_by'desc' | 'asc'

Specify the sort order of returned credentials.

Response

Returns an array of Credential objects.

request_idstring

The request ID.

limitinteger
offsetinteger

Example response

{
  "request_id": "5967ca40-a2d8-4ee0-a0e0-6f18ace39a90",
  "data": [
    {
      "id": "e19f8e1a-eb1c-41c0-b6a6-d2e59daf7f47",
      "name": "My first Google credential",
      "created_at": 1617817109,
      "updated_at": 1617817109
    }
  ],
  "limit": 10
}

Changes

No recorded changes to this endpoint across all 1 revision of this API.