Google Integrations

Google Integrations Documentation

Google Integration [LIST]

Google Integration [LIST]

Request

Endpoint

GET /api/v2/user/google_accounts/c9831c5f-9946-45c8-a461-8d7b87d77ce2/google_integrations
Content-Type: application/vnd.api+json

Body

Parameters

Filters

account_list_id

Type ID string

Description filter by account list id

Required No

Response

Headers

Content-Type: application/vnd.api+json; charset=utf-8
200 OK

Body

{
  "data": [
    {
      "id": "807db89c-4bda-4d0d-afea-fadf646e01d5",
      "type": "google_integrations",
      "attributes": {
        "calendar_id": "cal1",
        "calendar_integration": true,
        "calendar_integrations": [
          "Appointment"
        ],
        "calendar_name": null,
        "calendars": [

        ],
        "created_at": "2022-01-12T17:18:23Z",
        "updated_at": "2022-01-12T17:18:23Z",
        "updated_in_db_at": "2022-01-12T17:18:23Z"
      },
      "relationships": {
        "account_list": {
          "data": {
            "id": "c1dfab8a-331d-42e2-8d43-9588717cd185",
            "type": "account_lists"
          }
        },
        "google_account": {
          "data": {
            "id": "c9831c5f-9946-45c8-a461-8d7b87d77ce2",
            "type": "google_accounts"
          }
        }
      }
    }
  ],
  "meta": {
    "pagination": {
      "page": 1,
      "per_page": 25,
      "total_count": 1,
      "total_pages": 1
    },
    "sort": null,
    "filter": {
    }
  }
}

Fields

data

Type [Google Integrations]

Description An array of Google Integrations

Google Integration [POST]

Google Integration [POST]

Request

Endpoint

POST /api/v2/user/google_accounts/d3664057-4c96-4a6b-a9e4-bc13f5c60c82/google_integrations
Content-Type: application/vnd.api+json

Body

{
  "data": {
    "type": "google_integrations",
    "attributes": {
      "calendar_integration": false,
      "calendar_name": "test123",
      "updated_in_db_at": "2022-01-12 17:18:21 UTC"
    },
    "relationships": {
      "account_list": {
        "data": {
          "type": "account_lists",
          "id": "0cf5702a-b868-41f9-a8a2-0d766c7daa28"
        }
      },
      "google_account": {
        "data": {
          "type": "google_accounts",
          "id": "d3664057-4c96-4a6b-a9e4-bc13f5c60c82"
        }
      }
    }
  }
}

Parameters

Attributes

calendar_id

Type string

Description The unique identifier of the calendar being synced

Required No

calendar_integration

Type boolean

Description Specifies if calendar integration enabled

Required No

calendar_integrations

Type [Object]

Description An array of calendar integration objects

Required No

calendar_name

Type string

Description The unique name of the calendar being synced

Required No

calendars

Type [Calendar]

Description An array of calendars available to sync

Required No

created_at

Type date

Description The timestamp of when this resource was created

Required No

updated_at

Type date

Description The timestamp of when this resource was last updated

Required No

updated_in_db_at

Type date

Description This is to be used as a reference for the last time the resource was updated in the remote database - specifically for when data is updated while the client is offline.

Required No

Relationships

account_list.data

Type Account List

Description The account list that this integration belongs to

Required No

google_account.data

Type Google Account

Description The google account that this integration belongs to

Required No

Response

Headers

Content-Type: application/vnd.api+json; charset=utf-8
201 Created

Body

{
  "data": {
    "id": "38a25f14-1841-4659-8594-15a2171478cf",
    "type": "google_integrations",
    "attributes": {
      "calendar_id": null,
      "calendar_integration": false,
      "calendar_integrations": [

      ],
      "calendar_name": "test123",
      "calendars": [

      ],
      "created_at": "2022-01-12T17:18:21Z",
      "updated_at": "2022-01-12T17:18:21Z",
      "updated_in_db_at": "2022-01-12T17:18:21Z"
    },
    "relationships": {
      "account_list": {
        "data": {
          "id": "0cf5702a-b868-41f9-a8a2-0d766c7daa28",
          "type": "account_lists"
        }
      },
      "google_account": {
        "data": {
          "id": "d3664057-4c96-4a6b-a9e4-bc13f5c60c82",
          "type": "google_accounts"
        }
      }
    }
  }
}

Fields

Attributes

calendar_id

Type string

Description The unique identifier of the calendar being synced

calendar_integration

Type boolean

Description Specifies if calendar integration enabled

calendar_integrations

Type [Object]

Description An array of calendar integration objects

calendar_name

Type string

Description The unique name of the calendar being synced

calendars

Type [Calendar]

Description An array of calendars available to sync

created_at

Type date

Description The timestamp of when this resource was created

updated_at

Type date

Description The timestamp of when this resource was last updated

updated_in_db_at

Type date

Description This is to be used as a reference for the last time the resource was updated in the remote database - specifically for when data is updated while the client is offline.

Relationships

account_list.data

Type Account List

Description The account list that this integration belongs to

google_account.data

Type Google Account

Description The google account that this integration belongs to

Google Integration [GET]

Google Integration [GET]

Request

Endpoint

GET /api/v2/user/google_accounts/ba63d3b1-d10a-4f1f-9aee-0b5146521198/google_integrations/4de632d6-578b-46c4-961c-581afc716a0f
Content-Type: application/vnd.api+json

Body

Response

Headers

Content-Type: application/vnd.api+json; charset=utf-8
200 OK

Body

{
  "data": {
    "id": "4de632d6-578b-46c4-961c-581afc716a0f",
    "type": "google_integrations",
    "attributes": {
      "calendar_id": "cal1",
      "calendar_integration": true,
      "calendar_integrations": [
        "Appointment"
      ],
      "calendar_name": null,
      "calendars": [

      ],
      "created_at": "2022-01-12T17:18:22Z",
      "updated_at": "2022-01-12T17:18:22Z",
      "updated_in_db_at": "2022-01-12T17:18:22Z"
    },
    "relationships": {
      "account_list": {
        "data": {
          "id": "e00149f7-addd-40fd-b61b-22d954336058",
          "type": "account_lists"
        }
      },
      "google_account": {
        "data": {
          "id": "ba63d3b1-d10a-4f1f-9aee-0b5146521198",
          "type": "google_accounts"
        }
      }
    }
  }
}

Fields

Attributes

calendar_id

Type string

Description The unique identifier of the calendar being synced

calendar_integration

Type boolean

Description Specifies if calendar integration enabled

calendar_integrations

Type [Object]

Description An array of calendar integration objects

calendar_name

Type string

Description The unique name of the calendar being synced

calendars

Type [Calendar]

Description An array of calendars available to sync

created_at

Type date

Description The timestamp of when this resource was created

updated_at

Type date

Description The timestamp of when this resource was last updated

updated_in_db_at

Type date

Description This is to be used as a reference for the last time the resource was updated in the remote database - specifically for when data is updated while the client is offline.

Relationships

account_list.data

Type Account List

Description The account list that this integration belongs to

google_account.data

Type Google Account

Description The google account that this integration belongs to

Google Integration [PUT]

Google Integration [PUT]

Request

Endpoint

PUT /api/v2/user/google_accounts/174a87fd-75cc-456f-9256-fc0c9a2dc56b/google_integrations/2a806d99-2622-4584-8560-e30ea3f36cb6
Content-Type: application/vnd.api+json

Body

{
  "data": {
    "type": "google_integrations",
    "attributes": {
      "calendar_integration": false,
      "calendar_name": "test123",
      "updated_in_db_at": "2022-01-12 17:18:22 UTC"
    },
    "relationships": {
      "account_list": {
        "data": {
          "type": "account_lists",
          "id": "1d6b92da-dce0-415c-9c1b-9aab37dcf464"
        }
      },
      "google_account": {
        "data": {
          "type": "google_accounts",
          "id": "174a87fd-75cc-456f-9256-fc0c9a2dc56b"
        }
      }
    }
  }
}

Parameters

Attributes

calendar_id

Type string

Description The unique identifier of the calendar being synced

Required No

calendar_integration

Type boolean

Description Specifies if calendar integration enabled

Required No

calendar_integrations

Type [Object]

Description An array of calendar integration objects

Required No

calendar_name

Type string

Description The unique name of the calendar being synced

Required No

calendars

Type [Calendar]

Description An array of calendars available to sync

Required No

created_at

Type date

Description The timestamp of when this resource was created

Required No

overwrite

Type boolean

Description Only used for updating a record where you want to ignore the server's ' 'updated_in_db_at value and force overwrite the values for the record. ' 'Must be true to work.

Required No

updated_at

Type date

Description The timestamp of when this resource was last updated

Required No

updated_in_db_at

Type date

Description This is to be used as a reference for the last time the resource was updated in the remote database - specifically for when data is updated while the client is offline.

Required No

Relationships

account_list.data

Type Account List

Description The account list that this integration belongs to

Required No

google_account.data

Type Google Account

Description The google account that this integration belongs to

Required No

Response

Headers

Content-Type: application/vnd.api+json; charset=utf-8
200 OK

Body

{
  "data": {
    "id": "2a806d99-2622-4584-8560-e30ea3f36cb6",
    "type": "google_integrations",
    "attributes": {
      "calendar_id": "cal1",
      "calendar_integration": false,
      "calendar_integrations": [

      ],
      "calendar_name": "test123",
      "calendars": [

      ],
      "created_at": "2022-01-12T17:18:22Z",
      "updated_at": "2022-01-12T17:18:22Z",
      "updated_in_db_at": "2022-01-12T17:18:22Z"
    },
    "relationships": {
      "account_list": {
        "data": {
          "id": "1d6b92da-dce0-415c-9c1b-9aab37dcf464",
          "type": "account_lists"
        }
      },
      "google_account": {
        "data": {
          "id": "174a87fd-75cc-456f-9256-fc0c9a2dc56b",
          "type": "google_accounts"
        }
      }
    }
  }
}

Fields

Attributes

calendar_id

Type string

Description The unique identifier of the calendar being synced

calendar_integration

Type boolean

Description Specifies if calendar integration enabled

calendar_integrations

Type [Object]

Description An array of calendar integration objects

calendar_name

Type string

Description The unique name of the calendar being synced

calendars

Type [Calendar]

Description An array of calendars available to sync

created_at

Type date

Description The timestamp of when this resource was created

updated_at

Type date

Description The timestamp of when this resource was last updated

updated_in_db_at

Type date

Description This is to be used as a reference for the last time the resource was updated in the remote database - specifically for when data is updated while the client is offline.

Relationships

account_list.data

Type Account List

Description The account list that this integration belongs to

google_account.data

Type Google Account

Description The google account that this integration belongs to

Google Integration [DELETE]

Google Integration [DELETE]

Request

Endpoint

DELETE /api/v2/user/google_accounts/b22d3318-b4a0-489c-b839-b80869ee4df6/google_integrations/9ee9969a-048c-4a17-9677-04783ecdee00
Content-Type: application/vnd.api+json

Body

Response

Headers

204 No Content

Body