Issues a short-lived, HubSpot-scoped Kiflo access token.

Called by a HubSpot App Card through hubspot.fetch, which appends portalId and signs the request. The signature proves the request originates from HubSpot.

GET /v3/hubspot/access-token

Issues a short-lived, HubSpot-scoped Kiflo access token.

cURL

curl --request GET \
  --url https://api.example.com/v3/hubspot/access-token

200

{
  "accessToken": "<string>",
  "expiresInSeconds": 123,
  "accountId": 123,
  "permissions": [
    "DealView"
  ]
}

Query Parameters

portalId · integer<int64>

userEmail · string

Response

200

application/json

A short-lived access token was issued.

accessToken · string | null

expiresInSeconds · integer<int64>

accountId · integer<int32>

Account id of the Kiflo workspace the token was issued for, which identifies the workspace in the Kiflo app's URLs.

permissions · enum<string>[] | null

The features relevant to the HubSpot app that the user this token was issued for actually holds. Lets the app leave out an action the user would only be refused, and never grants anything: each endpoint still enforces its own policy.

Available options: DealView, DealCreate, DealUpdate, DealDelete, DealUpdateStage, DealViewTotalAmount, DealRequestQuote, DealSetupChannelConflictsDetection, DealPartnerRoleView, DealPartnerRoleCreate, DealPartnerRoleUpdate, DealPartnerRoleAssign, DealPartnerRoleDelete, LeadView, LeadCreate, LeadUpdate, LeadDelete, LeadShare, LeadAccept, LeadRefuse, LeadConvert, LeadAbandon, LeadSetupChannelConflictsDetection, DealValidate, BusinessPlanCreate, BusinessPlanUpdate, BusinessPlanView, BusinessPlanDelete, BusinessPlanActivityCreate, BusinessPlanActivityUpdate, BusinessPlanActivityView, BusinessPlanActivityDelete, ProgramView, ProgramCreate, ProgramUpdate, ProgramDelete, ProgramLevelView, ProgramLevelCreate, ProgramLevelUpdate, ProgramLevelDelete, CertificationView, CertificationCreate, CertificationUpdate, CertificationDelete, TransactionView, TransactionCreate, TransactionUpdate, TransactionDelete, CustomerView, CustomerCreate, CustomerUpdate, CustomerDelete, NewsView, NewsCreate, NewsUpdate, NewsDelete, ExportCreate, CollectionView, CollectionCreate, CollectionUpdate, CollectionDelete, ArticleView, ArticleCreate, ArticleUpdate, ArticleDelete, IntegrationView, IntegrationCreate, IntegrationUpdate, IntegrationDelete, IntegrationSalesforce, PayoutView, PayoutCreate, PayoutUpdate, PayoutDelete, PayoutValidate, PayoutAccept, PayoutPay, PayoutExport, PayoutGet, PayoutSetupAutomaticCreation, LinkCreate, LinkUpdate, LinkView, LinkDelete, RewardDelete, RewardView, RewardValidate, RewardCreate, ProductView, ProductCreate, ProductUpdate, ProductDelete, ProductPriceView, ProductPriceCreate, ProductPriceUpdate, ProductPriceDelete, LineItemView, LineItemCreate, LineItemUpdate, LineItemDelete, TaskView, TaskCreate, TaskUpdate, TaskDelete, AccountDataReset, AccountDataInsert, AccountTenantSettingsUpdate, AccountSetupSSO, AccountPartnerSettingsUpdate, AccountSetupMfa, TeamMemberView, TeamMemberCreate, TeamMemberUpdate, TeamMemberDelete, PartnerView, PartnerCreate, PartnerUpdate, PartnerDelete, PartnerImpersonate, PartnerApplicationAccept, PartnerApplicationReject, GroupView, GroupCreate, GroupUpdate, GroupDelete, AssetView, AssetCreate, AssetUpdate, AssetDelete, AssetMove, AssetCobrandedView, AssetCobrandedCreate, CoworkerView, CoworkerCreate, CoworkerUpdate, CoworkerDelete, CoworkerAssignOwnerRole, CoworkerAssignAdminRole, CoworkerAssignUserRole, CoworkerAssignViewerRole, EmailTemplateView, EmailTemplateCreate, EmailTemplateUpdate, EmailTemplateDelete, DashboardView, DashboardCreate, DashboardUpdate, DashboardDelete, ViewCreateShared, TeamMemberCertificationView, TeamMemberCertificationCreate, TeamMemberCertificationUpdate, TeamMemberCertificationDelete, OnboardingView, OnboardingCreate, OnboardingUpdate, OnboardingDelete, OnboardingStageActionCreate, OnboardingStageActionUpdate, OnboardingStageActionChangeStatus, OnboardingStageActionDelete, OnboardingStageActionView, CommentCreate, CommentUpdate, CommentDelete, CommentView, WorkflowCreate, WorkflowUpdate, WorkflowUpdateStatus, WorkflowManageEnrollments, WorkflowDelete, WorkflowView, MeetingView, MeetingCreate, MeetingUpdate, MeetingDelete, NoteView, NoteCreate, NoteUpdate, NoteDelete, AttachmentView, AttachmentCreate, AttachmentDelete, BillingManage, EmailSend, DirectoryView, DirectoryCreate, DirectoryUpdate, DirectoryDelete, DirectoryProfileView, DirectoryProfileCreate, DirectoryProfileUpdate, DirectoryProfileDelete, SelfInvoicingView, SelfInvoicingManage, AccountMappingDataSourceView, AccountMappingDataSourceCreate, AccountMappingDataSourceUpdate, AccountMappingDataSourceDelete, AccountMappingAccountView, AccountMappingOverlapExport, AccountMappingCollaborationView, AccountMappingCollaborationCreate, AccountMappingCollaborationUpdate, AccountMappingCollaborationDelete, AccountMappingCollaborationRequestCreate, AddonCustomDomain, AddonPartnerDirectory