List Gmail Integrations

curl --request GET \
  --url https://api.village.do/v2/integrations \
  --header 'Authorization: Bearer <token>'

{
  "data": {
    "integrations": [
      {
        "id": 123,
        "type": "gmail",
        "account_identifier": "[email protected]",
        "status": "connected",
        "email_sending_per_day": 50,
        "email_sending_per_hour": 20,
        "email_sending_min_delay_seconds": 600,
        "timezone": "America/New_York",
        "authorized_gmail": true,
        "token_expiry_date": "2024-12-31T23:59:59Z",
        "email_sending_default": true,
        "refresh_token_exists": true
      }
    ],
    "default_integration": {
      "id": 123,
      "type": "gmail",
      "account_identifier": "[email protected]",
      "status": "connected",
      "email_sending_per_day": 50,
      "email_sending_per_hour": 20,
      "email_sending_min_delay_seconds": 600,
      "timezone": "America/New_York",
      "authorized_gmail": true,
      "token_expiry_date": "2024-12-31T23:59:59Z",
      "email_sending_default": true,
      "refresh_token_exists": true
    },
    "can_sync_google": true
  },
  "metadata": {
    "request_id": "<string>"
  }
}

GET

integrations

curl --request GET \
  --url https://api.village.do/v2/integrations \
  --header 'Authorization: Bearer <token>'

{
  "data": {
    "integrations": [
      {
        "id": 123,
        "type": "gmail",
        "account_identifier": "[email protected]",
        "status": "connected",
        "email_sending_per_day": 50,
        "email_sending_per_hour": 20,
        "email_sending_min_delay_seconds": 600,
        "timezone": "America/New_York",
        "authorized_gmail": true,
        "token_expiry_date": "2024-12-31T23:59:59Z",
        "email_sending_default": true,
        "refresh_token_exists": true
      }
    ],
    "default_integration": {
      "id": 123,
      "type": "gmail",
      "account_identifier": "[email protected]",
      "status": "connected",
      "email_sending_per_day": 50,
      "email_sending_per_hour": 20,
      "email_sending_min_delay_seconds": 600,
      "timezone": "America/New_York",
      "authorized_gmail": true,
      "token_expiry_date": "2024-12-31T23:59:59Z",
      "email_sending_default": true,
      "refresh_token_exists": true
    },
    "can_sync_google": true
  },
  "metadata": {
    "request_id": "<string>"
  }
}

Authorizations

Authorization

string

header

required

JWT token obtained from authentication endpoint

Response

Integrations retrieved successfully

data

object

required

Gmail integrations list response

Show child attributes

data.integrations

object[]

required

List of Gmail integrations

Show child attributes

data.integrations.id

number

required

Integration ID

Example:

123

data.integrations.type

string

required

Integration type

Example:

"gmail"

data.integrations.account_identifier

string

required

Account identifier (email address)

Example:

"[email protected]"

data.integrations.status

enum<string>

required

Integration status

Available options:

connected,

disconnected,

failed

Example:

"connected"

data.integrations.email_sending_per_day

number

required

Daily email sending limit

Example:

50

data.integrations.email_sending_per_hour

number

required

Hourly email sending limit

Example:

20

data.integrations.email_sending_min_delay_seconds

number

required

Minimum delay between emails in seconds

Example:

600

data.integrations.timezone

string

required

Timezone for scheduling

Example:

"America/New_York"

data.integrations.authorized_gmail

boolean

required

Whether Gmail is authorized

Example:

true

data.integrations.token_expiry_date

string | null

required

Token expiry date

Example:

"2024-12-31T23:59:59Z"

data.integrations.email_sending_default

boolean

required

Whether this is the default integration for email sending

Example:

true

data.integrations.refresh_token_exists

boolean

required

Whether refresh token is available

Example:

true

data.default_integration

object

required

Default integration (if any)

Show child attributes

data.default_integration.id

number

required

Integration ID

Example:

123

data.default_integration.type

string

required

Integration type

Example:

"gmail"

data.default_integration.account_identifier

string

required

Account identifier (email address)

Example:

"[email protected]"

data.default_integration.status

enum<string>

required

Integration status

Available options:

connected,

disconnected,

failed

Example:

"connected"

data.default_integration.email_sending_per_day

number

required

Daily email sending limit

Example:

50

data.default_integration.email_sending_per_hour

number

required

Hourly email sending limit

Example:

20

data.default_integration.email_sending_min_delay_seconds

number

required

Minimum delay between emails in seconds

Example:

600

data.default_integration.timezone

string

required

Timezone for scheduling

Example:

"America/New_York"

data.default_integration.authorized_gmail

boolean

required

Whether Gmail is authorized

Example:

true

data.default_integration.token_expiry_date

string | null

required

Token expiry date

Example:

"2024-12-31T23:59:59Z"

data.default_integration.email_sending_default

boolean

required

Whether this is the default integration for email sending

Example:

true

data.default_integration.refresh_token_exists

boolean

required

Whether refresh token is available

Example:

true

data.can_sync_google

boolean

required

Whether user can sync Google based on plan

Example:

true

metadata

object

required

Show child attributes

metadata.request_id

string

required

Cancel User Subscription Create Gmail Integration

⌘I

API Documentation

Endpoints

List Gmail Integrations

Authorizations

Response