Type Alias GetLocationTokenResponse

GetLocationTokenResponse: {
    userId: string;
    access_token?: string;
    token_type?: "Bearer";
    expires_in?: number;
    scope?: LocationScope[];
    locationId?: 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 Cannot be refreshed but a new access_token can be requested with the Company access_token

    Example

    86399
  • Optionalscope?: LocationScope[]

    The scope of the token provided

    Example

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

    The ID of the location to generate an access token for

    Example

    l1C08ntBrFjLS0elLIYU
  • OptionalplanId?: string

    Plan Id of the subscribed plan in paid apps.

    Example

    l1C08ntBrFjLS0elLIYU

Settings

Member Visibility