Type Alias GetAccessTokenDto

GetAccessTokenDto: {
    client_id: string;
    client_secret: string;
    grant_type: "authorization_code" | "refresh_token";
    user_type: "Company" | "Location";
    code?: string;
    refresh_token?: string;
    redirect_uri?: string;
}

Type declaration

  • client_id: string

    The ID provided by GHL for your app integration

    Example

    64720d51b50eb849194247ce-lzdnsr6z
  • client_secret: string

    The secret provided by GHL for your app integration

    Example

    5060d220-a031-4f39-9cr0-0424e08ffba5
  • grant_type: "authorization_code" | "refresh_token"

    The type of token to be requested

    Example

    authorization_code
  • user_type: "Company" | "Location"

    The scope of the token to be requested

    Example

    read write
  • Optionalcode?: string

    The code provided in the query of the URI after installing the app required if grant_type is authorization_code

    Example

    86b68a0da12ba59f9a85abf2f5bafde171321bdd
  • Optionalrefresh_token?: string

    The refresh token provided in the response of the initial request required if grant_type is refresh_token must be valid jwt token format

    Example

    eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c
  • Optionalredirect_uri?: string

    The redirect URI for your application Must be registered as a valid redirect URI in the GHL app settings

    Example

    https://myapp.com/oauth/callback/gohighlevel

Settings

Member Visibility