---
title: "Communicates to QuickBooksOnline provider for authentication/authorization/access."
method: GET
path: "/Ams/QuickBooksOnlineOAuth"
tags: ["Ams"]
---

# Communicates to QuickBooksOnline provider for authentication/authorization/access.

`GET /Ams/QuickBooksOnlineOAuth`

## Request

- Base URL: `https://ws.yourmembership.com`
- URL: `https://ws.yourmembership.com/Ams/QuickBooksOnlineOAuth`
- Auth: none declared. Required headers: `Accept`
- TypeScript: <https://skmtc.dev/yourmembership/apis/ym-rest-services/docs/Ams/QuickBooksOnlineOAuth/get.ts> (a function with typed inputs; its response is checked against the schema)

Communicates to QuickBooksOnline provider for authentication/authorization/access.

## Query parameters

- `adminId` integer
- `clientId` integer
- `realmid` string
- `returnUrl` string
- `disconnect` boolean
- `refreshToken` string
- `code` string
- `state` string
- `error_reason` string
- `error` string
- `error_code` string
- `error_description` string

## Response `200`

Success

- QuickBooksOnlineOAuthResponse: QuickBooksOnlineOAuthResponse
  - `AccessToken` string
  - `AccessTokenExpires` string, date-time
  - `RefreshToken` string
  - `RefreshTokenExpires` string, date-time
  - `adminId` integer
  - `clientId` integer
  - `realmid` string
  - `returnUrl` string
  - `disconnect` boolean
  - `refreshToken` string
  - `code` string
  - `state` string
  - `error_reason` string
  - `error` string
  - `error_code` string
  - `error_description` string

---

[API](https://skmtc.dev/yourmembership/apis/ym-rest-services.md) - [All operations](https://skmtc.dev/yourmembership/apis/ym-rest-services/llms.txt) - [OpenAPI document](https://skmtc.dev/yourmembership/apis/ym-rest-services/revisions/8d8a2e7e7d56?raw)
