Google Integrations

Google Integrations Documentation

Google Integration [LIST]

Google Integration [LIST]

Request

Endpoint

GET /api/v2/user/google_accounts/3960fa69-6259-4ace-9801-5b9a0cf2d10e/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": "70d92488-278f-4487-ae8c-0b6b62e8eea3",
      "type": "google_integrations",
      "attributes": {
        "calendar_id": "cal1",
        "calendar_integration": true,
        "calendar_integrations": [
          "Appointment"
        ],
        "calendar_name": null,
        "calendars": [

        ],
        "created_at": "2021-11-23T14:37:38Z",
        "updated_at": "2021-11-23T14:37:38Z",
        "updated_in_db_at": "2021-11-23T14:37:38Z"
      },
      "relationships": {
        "account_list": {
          "data": {
            "id": "2fcf34d9-3e4e-4988-b923-9c8a0c2b480f",
            "type": "account_lists"
          }
        },
        "google_account": {
          "data": {
            "id": "3960fa69-6259-4ace-9801-5b9a0cf2d10e",
            "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/f37b9724-0ac3-48c3-b5a0-fba3bc2867ca/google_integrations
Content-Type: application/vnd.api+json

Body

{
  "data": {
    "type": "google_integrations",
    "attributes": {
      "calendar_integration": false,
      "calendar_name": "test123",
      "updated_in_db_at": "2021-11-23 14:37:38 UTC"
    },
    "relationships": {
      "account_list": {
        "data": {
          "type": "account_lists",
          "id": "66ca6dda-8b93-49aa-9236-438eec35535a"
        }
      },
      "google_account": {
        "data": {
          "type": "google_accounts",
          "id": "f37b9724-0ac3-48c3-b5a0-fba3bc2867ca"
        }
      }
    }
  }
}

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": "69d19005-10a5-47e2-8575-ab275e4a465e",
    "type": "google_integrations",
    "attributes": {
      "calendar_id": null,
      "calendar_integration": false,
      "calendar_integrations": [

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

      ],
      "created_at": "2021-11-23T14:37:38Z",
      "updated_at": "2021-11-23T14:37:38Z",
      "updated_in_db_at": "2021-11-23T14:37:38Z"
    },
    "relationships": {
      "account_list": {
        "data": {
          "id": "66ca6dda-8b93-49aa-9236-438eec35535a",
          "type": "account_lists"
        }
      },
      "google_account": {
        "data": {
          "id": "f37b9724-0ac3-48c3-b5a0-fba3bc2867ca",
          "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/d0fdccd7-8c02-4449-81fa-3b066260ec59/google_integrations/90c8488f-9ec7-4e42-b78c-61e558fceafc
Content-Type: application/vnd.api+json

Body

Response

Headers

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

Body

{
  "data": {
    "id": "90c8488f-9ec7-4e42-b78c-61e558fceafc",
    "type": "google_integrations",
    "attributes": {
      "calendar_id": "cal1",
      "calendar_integration": true,
      "calendar_integrations": [
        "Appointment"
      ],
      "calendar_name": null,
      "calendars": [

      ],
      "created_at": "2021-11-23T14:37:38Z",
      "updated_at": "2021-11-23T14:37:38Z",
      "updated_in_db_at": "2021-11-23T14:37:38Z"
    },
    "relationships": {
      "account_list": {
        "data": {
          "id": "c0e1f07e-d172-4c7f-b2cb-6798517e6c63",
          "type": "account_lists"
        }
      },
      "google_account": {
        "data": {
          "id": "d0fdccd7-8c02-4449-81fa-3b066260ec59",
          "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/68c8168f-756f-49c2-bde4-b6d3bae7245f/google_integrations/d23cdf56-eda0-4b42-83db-d188a57b77bb
Content-Type: application/vnd.api+json

Body

{
  "data": {
    "type": "google_integrations",
    "attributes": {
      "calendar_integration": false,
      "calendar_name": "test123",
      "updated_in_db_at": "2021-11-23 14:37:38 UTC"
    },
    "relationships": {
      "account_list": {
        "data": {
          "type": "account_lists",
          "id": "19763e89-99ea-4531-aa57-fb328da7b54a"
        }
      },
      "google_account": {
        "data": {
          "type": "google_accounts",
          "id": "68c8168f-756f-49c2-bde4-b6d3bae7245f"
        }
      }
    }
  }
}

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": "d23cdf56-eda0-4b42-83db-d188a57b77bb",
    "type": "google_integrations",
    "attributes": {
      "calendar_id": "cal1",
      "calendar_integration": false,
      "calendar_integrations": [

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

      ],
      "created_at": "2021-11-23T14:37:38Z",
      "updated_at": "2021-11-23T14:37:38Z",
      "updated_in_db_at": "2021-11-23T14:37:38Z"
    },
    "relationships": {
      "account_list": {
        "data": {
          "id": "19763e89-99ea-4531-aa57-fb328da7b54a",
          "type": "account_lists"
        }
      },
      "google_account": {
        "data": {
          "id": "68c8168f-756f-49c2-bde4-b6d3bae7245f",
          "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/b00deff5-9e23-494c-a946-6c1d1d48b171/google_integrations/411a3a88-d94a-41e7-9748-d556ffc6c060
Content-Type: application/vnd.api+json

Body

Response

Headers

204 No Content

Body