Type Alias GetAccessCodeBaseSchema

GetAccessCodeBaseSchema: {
    userId: string;
    access_token?: string;
    token_type?: "Bearer";
    expires_in?: number;
    refresh_token?: string;
    scope?: Scope[];
    userType?: string;
    locationId?: string;
    companyId?: string;
    approvedLocations?: string[];
    planId?: string;
}

Type declaration

  • userId: string

    USER ID - Represent user id of person who performed installation

    Example

    64720d51b50eb849194247ce
  • Optionalaccess_token?: string

    The token used to access the GHL API

    Example

    eyJrIjoiSDI1NiIsInR5cCI6IkpXVCIsImFsZyI6IkhTMjU2In0.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.iSE7GVfFsdDqqaV7PyXDAZtkxy78MZ2CnAhAnoN5MSU
  • Optionaltoken_type?: "Bearer"

    The type of token provided

    Example

    Bearer
  • Optionalexpires_in?: number

    The amount of time until the access_token expires in seconds - Can be refreshed using the Refresh Token up to 1 year after token created Once Refreshed, a new access_token / refresh_token will be provided The new access_token will expire in 24 hours and the new refresh_token will expire in 1 year

    Example

    86399
  • Optionalrefresh_token?: string

    The refresh token to be used to request a new access token

    Example

    eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c
  • Optionalscope?: Scope[]

    The scope of the token provided

    Example

    ["conversations/message.readonly" "conversations/message.write"]
  • OptionaluserType?: string

    The type of user the token is for

    Example

    Location
  • OptionallocationId?: string

    Location ID - Present only for Sub-Account Access Token

    Example

    l1C08ntBrFjLS0elLIYU
  • OptionalcompanyId?: string

    Company ID

    Example

    l1C08ntBrFjLS0elLIYU
  • OptionalapprovedLocations?: string[]

    Approved locations to generate location access token

    Example

    ["l1C08ntBrFjLS0elLIYU"]
  • OptionalplanId?: string

    Plan Id of the subscribed plan in paid apps.

    Example

    l1C08ntBrFjLS0elLIYU

Settings

Member Visibility