Google Accounts

Google Accounts Documentation

Google Account [LIST]

Google Account [LIST]

Request

Endpoint

GET /api/v2/user/google_accounts
Content-Type: application/vnd.api+json

Body

Response

Headers

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

Body

{
  "data": [
    {
      "id": "36c59648-74e6-4852-b8b4-30cc1f004761",
      "type": "google_accounts",
      "attributes": {
        "created_at": "2021-11-23T14:38:15Z",
        "email": "[email protected]",
        "expires_at": "2021-11-23T15:38:15Z",
        "last_download": null,
        "last_email_sync": null,
        "primary": false,
        "remote_id": "MyString",
        "token_expired": false,
        "updated_at": "2021-11-23T14:38:15Z",
        "updated_in_db_at": "2021-11-23T14:38:15Z"
      },
      "relationships": {
        "contact_groups": {
          "data": [

          ]
        }
      }
    }
  ],
  "meta": {
    "pagination": {
      "page": 1,
      "per_page": 25,
      "total_count": 1,
      "total_pages": 1
    },
    "sort": null,
    "filter": {
    }
  }
}

Fields

data

Type [Google Account]

Description An array of Google Accounts

Google Account [POST]

Google Account [POST]

Request

Endpoint

POST /api/v2/user/google_accounts
Content-Type: application/vnd.api+json

Body

{
  "data": {
    "type": "google_accounts",
    "attributes": {
      "email": "[email protected]",
      "remote_id": "MyString",
      "updated_in_db_at": "2021-11-23 14:38:14 UTC"
    }
  }
}

Parameters

Attributes

created_at

Type date

Description The timestamp of when this resource was created

Required No

email

Type string

Description Primary email address for Google Account

Required No

expires_at

Type string

Description OAuth Access Token Expiration Time

Required No

last_download

Type string

Description Last Download

Required No

last_email_sync

Type string

Description Last Email Sync

Required No

primary

Type boolean

Description Primary

Required No

remote_id

Type number

Description Remote Id

Required No

token_expired

Type boolean

Description OAuth Access Token Expired

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

Response

Headers

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

Body

{
  "data": {
    "id": "70feedc1-60c5-4ecb-89f0-295ea4b47c20",
    "type": "google_accounts",
    "attributes": {
      "created_at": "2021-11-23T14:38:15Z",
      "email": "[email protected]",
      "expires_at": null,
      "last_download": null,
      "last_email_sync": null,
      "primary": false,
      "remote_id": "MyString",
      "token_expired": true,
      "updated_at": "2021-11-23T14:38:15Z",
      "updated_in_db_at": "2021-11-23T14:38:15Z"
    },
    "relationships": {
      "contact_groups": {
        "data": [

        ]
      }
    }
  }
}

Fields

Attributes

created_at

Type date

Description The timestamp of when this resource was created

email

Type string

Description Primary email address for Google Account

expires_at

Type string

Description OAuth Access Token Expiration Time

last_download

Type string

Description Last Download

last_email_sync

Type string

Description Last Email Sync

primary

Type boolean

Description Primary

remote_id

Type number

Description Remote Id

token_expired

Type boolean

Description OAuth Access Token Expired

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

contact_groups.data

Type [Contact Group]

Description An array of Contact Groups from Google

Google Account [GET]

Google Account [GET]

Request

Endpoint

GET /api/v2/user/google_accounts/89c02798-d26c-4d35-9792-7bc43928b09b
Content-Type: application/vnd.api+json

Body

Response

Headers

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

Body

{
  "data": {
    "id": "89c02798-d26c-4d35-9792-7bc43928b09b",
    "type": "google_accounts",
    "attributes": {
      "created_at": "2021-11-23T14:38:14Z",
      "email": "[email protected]",
      "expires_at": "2021-11-23T15:38:14Z",
      "last_download": null,
      "last_email_sync": null,
      "primary": false,
      "remote_id": "MyString",
      "token_expired": false,
      "updated_at": "2021-11-23T14:38:14Z",
      "updated_in_db_at": "2021-11-23T14:38:14Z"
    },
    "relationships": {
      "contact_groups": {
        "data": [

        ]
      }
    }
  }
}

Fields

Attributes

created_at

Type date

Description The timestamp of when this resource was created

email

Type string

Description Primary email address for Google Account

expires_at

Type string

Description OAuth Access Token Expiration Time

last_download

Type string

Description Last Download

last_email_sync

Type string

Description Last Email Sync

primary

Type boolean

Description Primary

remote_id

Type number

Description Remote Id

token_expired

Type boolean

Description OAuth Access Token Expired

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

contact_groups.data

Type [Contact Group]

Description An array of Contact Groups from Google

Google Account [PUT]

Google Account [PUT]

Request

Endpoint

PUT /api/v2/user/google_accounts/faec97dd-6c2b-43f2-8b0f-7f2c611cd933
Content-Type: application/vnd.api+json

Body

{
  "data": {
    "type": "google_accounts",
    "attributes": {
      "email": "[email protected]",
      "remote_id": "MyString",
      "updated_in_db_at": "2021-11-23 14:38:14 UTC"
    }
  }
}

Parameters

Attributes

created_at

Type date

Description The timestamp of when this resource was created

Required No

email

Type string

Description Primary email address for Google Account

Required No

expires_at

Type string

Description OAuth Access Token Expiration Time

Required No

last_download

Type string

Description Last Download

Required No

last_email_sync

Type string

Description Last Email Sync

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

primary

Type boolean

Description Primary

Required No

remote_id

Type number

Description Remote Id

Required No

token_expired

Type boolean

Description OAuth Access Token Expired

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

Response

Headers

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

Body

{
  "data": {
    "id": "faec97dd-6c2b-43f2-8b0f-7f2c611cd933",
    "type": "google_accounts",
    "attributes": {
      "created_at": "2021-11-23T14:38:14Z",
      "email": "[email protected]",
      "expires_at": "2021-11-23T15:38:14Z",
      "last_download": null,
      "last_email_sync": null,
      "primary": false,
      "remote_id": "MyString",
      "token_expired": false,
      "updated_at": "2021-11-23T14:38:14Z",
      "updated_in_db_at": "2021-11-23T14:38:14Z"
    },
    "relationships": {
      "contact_groups": {
        "data": [

        ]
      }
    }
  }
}

Fields

Attributes

created_at

Type date

Description The timestamp of when this resource was created

email

Type string

Description Primary email address for Google Account

expires_at

Type string

Description OAuth Access Token Expiration Time

last_download

Type string

Description Last Download

last_email_sync

Type string

Description Last Email Sync

primary

Type boolean

Description Primary

remote_id

Type number

Description Remote Id

token_expired

Type boolean

Description OAuth Access Token Expired

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

contact_groups.data

Type [Contact Group]

Description An array of Contact Groups from Google

Google Account [DELETE]

Google Account [DELETE]

Request

Endpoint

DELETE /api/v2/user/google_accounts/b69130d3-337a-4121-a0fb-51f4c2151dca
Content-Type: application/vnd.api+json

Body

Response

Headers

204 No Content

Body