Business Keys

The Business Keys API is used to access the different business keys on your business' account. The business keys act as stand-ins for the different business configurations used on your business' account.

On this page

1 Business Keys API Endpoints
2 Business Keys API Parameters
3 Business Keys API Request Body/Payloads
4 Business Keys API Responses
5 Business Keys Object Values

Business Keys API Endpoints

Return to Top

These are the endpoints that are available under the /businessKeys path, which lists all the different business keys that are available on your business' account.

Endpoint	Description

Endpoint

Description

GET /businessKeys

Returns all businessKeys objects on your business' account in array format.

POST /businessKeys

Updates the specified businessKeys object.

Request body/payload: Must pass a businessKeys object in the request body/payload.

For these calls, you need to pass a businessKeys object with all the required fields and any fields you want to updated filled in in the body of the payload. We have an example of a businessKeys object in the responses section below.

Business Keys API Parameters

Return to top

There are no parameters included with businessKeys calls.

Business Keys API Request Body/Payloads

Return to Top

The objects below represent the minimum viable objects to pass that are needed to update a businessKeys object. Check whether or not a property can be written to by looking at the Object Values table below to see if the property is writable.

{
    "annualRevenue": null,
    "anyPaymentGatewaySetup": true,
    "appointmentTemplate": null,
    "appointmentTemplateClient": null,
    "archiveLocationDays": 90,
    "authNetApiLoginId": null,
    "authNetTransKey": null,
    "authnetSetup": false,
    "autoArchiveLocations": false,
    "billingProcessor": null,
    "billingToken": null,
    "bulkTextGateway": null,
    "businessId": 43111,
    "callRejectMsg": null,
    "cayanSetup": false,
    "checkedInApptTemplate": null,
    "clientPayAuthOnly": false,
    "courseInvoiceDescription": "%REASON% - %SET_NAME%",
    "createdDate": 1536168780000,
    "createdUser": "JoeSchmo",
    "cronofyServiceAccessToken": null,
    "cronofyServiceAccountId": null,
    "cronofyServiceRefreshToken": null,
    "customCode": null,
    "cyberSourceAccessKey": null,
    "cyberSourceProfileId": null,
    "cyberSourceSecretKey": null,
    "cyberSourceSetup": false,
    "defaultExtCalDownload": true,
    "defaultExtCalDownloadDetails": true,
    "defaultExtCalIncludeFreeEvents": true,
    "defaultExtCalReasonIdList": [255178],
    "defaultExtCalUpload": false,
    "defaultExtCalUploadBody": "Client Phone #: %CLIENT_PHONE%-1\nClient Email: %CLIENT_EMAILADDRESS%\n%CLIENT_ADDRESS1%\n%CLIENT_CITY%\n%CLIENT_STATE% %CLIENT_ZIP%\nCustom Fields: %CUSTOM_FIELDS%",
    "defaultExtCalUploadSubject": "%CLIENT_FULLNAME% for %REASON% #1",
    "defaultExtCalUploadWhere": "%LOCATION_NAME% #2",
    "defaultGateway": "STRIPE",
    "emailGateway": null,
    "exactSetup": false,
    "excludeEmailCategoryIdList": [],
    "excludeSecurityRoleIdList": null,
    "firstInvoiceDate": null,
    "flexOffersAid": null,
    "globalRelay": false,
    "hubspotConfigJson": null,
    "hubspotConfigMap": null,
    "infusionsoftAPIKey": "q2",
    "infusionsoftAccessToken": null,
    "infusionsoftAction": null,
    "infusionsoftGroupId": 55,
    "infusionsoftId": "13",
    "infusionsoftNoShowGroupId": null,
    "infusionsoftRefreshToken": null,
    "invoiceDescription": "For %REASON% with %PROFESSIONAL_FULLNAME% on %APPT_DATE_TIME%",
    "invoiceFrequency": null,
    "invoiceNumberPrefix": null,
    "invoiceTemplate": null,
    "invoicedLocations": null,
    "invoicedStaff": null,
    "ipAddressWhitelist": null,
    "locationCategoryList": null,
    "lumaPayAccountId": null,
    "lumaPaySetup": false,
    "lumapayFlatRate": 0.3,
    "lumapayRate": 2.9,
    "modifiedDate": 1679936012000,
    "modifiedUser": "Downgrade",
    "mstenantid": null,
    "mwGeniusIP": null,
    "mwMerchantKey": null,
    "mwMerchantName": null,
    "mwSiteId": null,
    "nextInvoiceChargeDate": null,
    "paymentByLocation": false,
    "paymentConfirmUrl": null,
    "paymentMethods": ["Check", "Visa", "Master card", "Amex", "Discover"],
    "paymentReq": false,
    "paymentThankYouPage": null,
    "paymentThankYouScript": null,
    "paypalId": "JoeSchmo@test.com",
    "paypalSetup": true,
    "pendingCancelMinutes": null,
    "postmarkApiKey": null,
    "restrictIpAddress": false,
    "restrictLoginHours": false,
    "salesforceAccessToken": null,
    "salesforceAccountJson": null,
    "salesforceAddClient": null,
    "salesforceAddOpportunity": false,
    "salesforceClientSearchFields": null,
    "salesforceContactJson": null,
    "salesforceEventJson": null,
    "salesforceInstanceUrl": null,
    "salesforceLeadJson": null,
    "salesforceOpportunityJson": null,
    "salesforcePersonJson": null,
    "salesforceRefreshToken": null,
    "saml2Endpoint": null,
    "samlMetadataUrl": null,
    "samlx509Cert": null,
    "sendApptWebhook": null,
    "sendClientWebhook": null,
    "sendPaymentWebhook": null,
    "sendgridKey": null,
    "snsTopic": null,
    "squareAccessToken": null,
    "squareDefaultLocationId": null,
    "squareMerchantId": null,
    "squareSetup": false,
    "squareTokenExpires": null,
    "staffCoordSecurityRoleIdList": null,
    "stripeAccountId": "acct_1BB4YNJDL97oy2LN",
    "stripeBusinessLogo": null,
    "stripePublishableKey": "pk_test_E0qAgmhveERwu8UQ26LXdtTy",
    "stripeRefreshToken": "rt_BYBe2nVZGXtdhTiZ2zUSmP77hUuBqkKr4BTPubY1BFFI6zpR",
    "stripeSecretKey": "sk_test_35AxIp4JwOFEYgA9QbN8G7YF",
    "stripeSetup": true,
    "tax1Name": null,
    "tax1Rate": 7,
    "tax2Name": "tax 2 rate",
    "tax2Rate": 5,
    "test": true,
    "textGateway": null,
    "textRejectMsg": null,
    "transactionFeeAmount": 1,
    "transactionFeeDescription": null,
    "transactionFeeRate": 2,
    "twilioAuthToken": null,
    "twilioSID": null,
    "webhookAuthJson": null,
    "webhookMap": null,
    "webhookUrl": "https://en4fhbxn8czrwci.m.pipedream.net",
    "xactLoginId": null,
    "xactResponseKey": null,
    "xactTxnKey": null
}

Business Keys API Responses

Return to Top

{
    "annualRevenue": null,
    "anyPaymentGatewaySetup": true,
    "appointmentTemplate": null,
    "appointmentTemplateClient": null,
    "archiveLocationDays": 90,
    "authNetApiLoginId": null,
    "authNetTransKey": null,
    "authnetSetup": false,
    "autoArchiveLocations": false,
    "billingProcessor": null,
    "billingToken": null,
    "bulkTextGateway": null,
    "businessId": 43111,
    "callRejectMsg": null,
    "cayanSetup": false,
    "checkedInApptTemplate": null,
    "clientPayAuthOnly": false,
    "courseInvoiceDescription": "%REASON% - %SET_NAME%",
    "createdDate": 1536168780000,
    "createdUser": "JoeSchmo",
    "cronofyServiceAccessToken": null,
    "cronofyServiceAccountId": null,
    "cronofyServiceRefreshToken": null,
    "customCode": null,
    "cyberSourceAccessKey": null,
    "cyberSourceProfileId": null,
    "cyberSourceSecretKey": null,
    "cyberSourceSetup": false,
    "defaultExtCalDownload": true,
    "defaultExtCalDownloadDetails": true,
    "defaultExtCalIncludeFreeEvents": true,
    "defaultExtCalReasonIdList": [255178],
    "defaultExtCalUpload": false,
    "defaultExtCalUploadBody": "Client Phone #: %CLIENT_PHONE%-1\nClient Email: %CLIENT_EMAILADDRESS%\n%CLIENT_ADDRESS1%\n%CLIENT_CITY%\n%CLIENT_STATE% %CLIENT_ZIP%\nCustom Fields: %CUSTOM_FIELDS%",
    "defaultExtCalUploadSubject": "%CLIENT_FULLNAME% for %REASON% #1",
    "defaultExtCalUploadWhere": "%LOCATION_NAME% #2",
    "defaultGateway": "STRIPE",
    "emailGateway": null,
    "exactSetup": false,
    "excludeEmailCategoryIdList": [],
    "excludeSecurityRoleIdList": null,
    "firstInvoiceDate": null,
    "flexOffersAid": null,
    "globalRelay": false,
    "hubspotConfigJson": null,
    "hubspotConfigMap": null,
    "infusionsoftAPIKey": "q2",
    "infusionsoftAccessToken": null,
    "infusionsoftAction": null,
    "infusionsoftGroupId": 55,
    "infusionsoftId": "13",
    "infusionsoftNoShowGroupId": null,
    "infusionsoftRefreshToken": null,
    "invoiceDescription": "For %REASON% with %PROFESSIONAL_FULLNAME% on %APPT_DATE_TIME%",
    "invoiceFrequency": null,
    "invoiceNumberPrefix": null,
    "invoiceTemplate": null,
    "invoicedLocations": null,
    "invoicedStaff": null,
    "ipAddressWhitelist": null,
    "locationCategoryList": null,
    "lumaPayAccountId": null,
    "lumaPaySetup": false,
    "lumapayFlatRate": 0.3,
    "lumapayRate": 2.9,
    "modifiedDate": 1679936012000,
    "modifiedUser": "Downgrade",
    "mstenantid": null,
    "mwGeniusIP": null,
    "mwMerchantKey": null,
    "mwMerchantName": null,
    "mwSiteId": null,
    "nextInvoiceChargeDate": null,
    "paymentByLocation": false,
    "paymentConfirmUrl": null,
    "paymentMethods": ["Check", "Visa", "Master card", "Amex", "Discover"],
    "paymentReq": false,
    "paymentThankYouPage": null,
    "paymentThankYouScript": null,
    "paypalId": "JoeSchmo@test.com",
    "paypalSetup": true,
    "pendingCancelMinutes": null,
    "postmarkApiKey": null,
    "restrictIpAddress": false,
    "restrictLoginHours": false,
    "salesforceAccessToken": null,
    "salesforceAccountJson": null,
    "salesforceAddClient": null,
    "salesforceAddOpportunity": false,
    "salesforceClientSearchFields": null,
    "salesforceContactJson": null,
    "salesforceEventJson": null,
    "salesforceInstanceUrl": null,
    "salesforceLeadJson": null,
    "salesforceOpportunityJson": null,
    "salesforcePersonJson": null,
    "salesforceRefreshToken": null,
    "saml2Endpoint": null,
    "samlMetadataUrl": null,
    "samlx509Cert": null,
    "sendApptWebhook": null,
    "sendClientWebhook": null,
    "sendPaymentWebhook": null,
    "sendgridKey": null,
    "snsTopic": null,
    "squareAccessToken": null,
    "squareDefaultLocationId": null,
    "squareMerchantId": null,
    "squareSetup": false,
    "squareTokenExpires": null,
    "staffCoordSecurityRoleIdList": null,
    "stripeAccountId": "acct_1BB4YNJDL97oy2LN",
    "stripeBusinessLogo": null,
    "stripePublishableKey": "pk_test_E0qAgmhveERwu8UQ26LXdtTy",
    "stripeRefreshToken": "rt_BYBe2nVZGXtdhTiZ2zUSmP77hUuBqkKr4BTPubY1BFFI6zpR",
    "stripeSecretKey": "sk_test_35AxIp4JwOFEYgA9QbN8G7YF",
    "stripeSetup": true,
    "tax1Name": null,
    "tax1Rate": 7,
    "tax2Name": "tax 2 rate",
    "tax2Rate": 5,
    "test": true,
    "textGateway": null,
    "textRejectMsg": null,
    "transactionFeeAmount": 1,
    "transactionFeeDescription": null,
    "transactionFeeRate": 1,
    "twilioAuthToken": null,
    "twilioSID": null,
    "webhookAuthJson": null,
    "webhookMap": null,
    "webhookUrl": "https://en4fhbxn8czrwci.m.pipedream.net",
    "xactLoginId": null,
    "xactResponseKey": null,
    "xactTxnKey": null
}

Business Keys Object Values

Return to Top

Property name	Type	Description

Property name	Type	Description
annualRevenue	string	Displays as the amount of revenue the account brings in in a year.
anyPaymentGatewaySetup	boolean	Indicates whether or nor any payment gateway has been added on the account.
authNetApiLoginId	string	Provides unique alphanumeric API Login ID provided from Authorize.net account to link it to TimeTap.
appointmentTemplate
appointmentTemplateClient
archiveLocationDays	integer	Provides the number of days that can elapse before locations of the specified business will be archived if unused.
authNetTransKey	string	Provides unique alphanumeric Transaction Key ID provided from Authorize.net account.
authnetSetup	boolean	Indicates whether or not the specified business has Authorize.net set up as a payment gateway.
autoArchiveLocations	boolean	Indicates whether or not the specified business is set to automatically archive locations after a period of non-use.
billingProcessor	string	Displays as the billing processor that is set up for the specified business. Possible values include "RECURLY" and "INVOICE".
billingToken	string	Displays as the billing token for the specified business.
bulkTextGateway
businessId	integer	Provides unique numeric ID for the specified business.
callRejectingMsg	string	If the specified business has a dedicated Twilio number, this property displays the programmed response that will be read to anyone who calls that number.
cayanSetup	boolean	Indicates whether or not the the specified business has Cayan set up as a payment gateway.
checkedInApptTemplate
clientPayAuthOnly	boolean	Indicates whether or not the specified business wants to capture the card and authorize it but not charge it at the time of booking - only applicable to payment gateway of Authorize.net at this point in time.
courseInvoiceDescription	string	Displays as description that applies to an invoice line item when a course registration is added to an invoice.
createdDate	integer	Displays as date the specified business was created in milliseconds elapsed since January 1, 1970 00:00:00 UTC form.
createdUser	string	Displays as the username of the user who created the specified business.
cronofyServiceAccessToken
cronofyServiceAccountId	integer	Provides unique numeric ID for the specified business' Cronofy account.
cronofyServiceRefreshToken
customCode
cyberSourceAccessKey	string	Displays as the access key for the specified business' Cybersource account.
cyberSourceProfileId	integer	Provides unique numeric ID for the specified business' Cybersource account.
cyberSourceSecretKey	string	Displays as the secret key for the specified business' Cybersource account.
cyberSourceSetup	boolean	Indicates whether or not the specified business has a Cybersource account set up.
defaultExtCalDownload	boolean	Indicates whether or not the specified business is set to download from the external calendar under default calendar sync settings.
defaultExtCalDownloadDetails	boolean	Indicates whether or not the specified business is set to download details under the default calendar sync settings.
defaultExtCalIncludeFreeEvents	boolean	Indicates whether or not the specified business is set to download free events under default calendar sync settings.
defaultExtCalReasonIdList	array	Displays as an array of reasonIds of reasons uploaded for default calendar sync settings.
defaultExtCalUpload	boolean	Indicates whether or not the specified business is set to upload appointments under default calendar sync settings.
defaultExtCalUploadBody	string	Displays as uploaded event description under the default calendar sync settings.
defaultExtCalUploadSubject	string	Displays as uploaded event title under the default calendar sync settings.
defaultExtCalUploadWhere	string	Displays as uploaded event location under default calendar sync settings.
defaultGateway	string	Displays as what the specified business has set as its default payment gateway.
emailGateway	string	Displays as what the specified business has set as its email gateway.
exactSetup	boolean	Indicates whether or not the specified business has E-xact set up as a payment gateway.
excludeEmailCategoryIdList	array	If there are any email categories that you want to disable, add their emailCatagoryId to this comma-separated ID list as an array and they will not be triggered for your account.
excludeSecurityRoleIdList	array	If there are any of the default security roles that you do not want to show when adding/editing staff, put the securityRoleId for that security role in this comma-separated list as an array and they will not be shown.
firstInvoiceDate
flexOffersAid
globalRelay
hubspotConfigJson	string
hubspotConfigMap
infusionsoftApiKey	string	Displays as what is set as the specified business' Infusionsoft API key.
infusionsoftAccessToken	string	Displays as alphanumeric hash access token the specified business has set for Infusionsoft.
infusionsoftAction	string	Displays as the action to be taken in Infusionsoft when appointment is added in TimeTap (i.e. 'ADD_CONTACT').
infusionsoftGroupId	integer	Displays as what the specified business has set as its Infusionsoft group ID/tag.
infusionsoftId	string	Displays as what the specified business has set as its Infusionsoft ID.
infusionsoftNoShowGroupId	integer	Optional override for the group to place data in Infusionsoft if appointment is marked as "no show" instead of another status.
infusionsoftRefreshToken	string	Displays as alphanumeric hash refresh token the specified business has set for Infusionsoft.
invoiceDescription	string	Displays as what the specified business has set as appointment invoice description.
invoiceFrequency	string	For invoiced accounts, displays the frequency that the account gets invoiced
invoiceNumberPrefix
invoiceTemplate
invoicedLocations	integer	Provides the number of locations that the specified business is being invoiced for.
invoicedStaff	integer	Provides the number of staff that the specified business is being invoiced for.
ipAddressWhiteList	string	If the specified business is set to restrict login by IP address, set the allowed IP addresses here.
locationCategoryList
lumaPayAccountId	integer	Provides unique numeric ID for the specified business' LumaPay account.
lumaPaySetup	boolean	Indicates whether or not the specified business has a LumaPay account set up as a payment gateway.
lumapayFlatRate	integer
lumapayRate
modifiedDate	integer	Displays as date the specified business was last modified in milliseconds elapsed since January 1, 1970 00:00:00 UTC form.
mstenantid
mwGeniusIp	string	Displays as the IP address for Cayan Genius payment gateway hardware.
mwMerchantKey	string	Displays as alphanumeric key for the Cayan account connected to the specified business.
mwMerchantName	string	Displays as business name for the specified business, as stored in Cayan.
mwSiteId	string	Provides site ID for the Cayan account of the specified business.
nextInvoiceChargeDate	date	Can be used with Authorize.net payment portal to set a date in the future when all invoices that still have payment due should be charged and auto-settled using the card on file.
paymentByLocation	boolean	Can be used with PayPal and Square payment portal to segment invoices on a per-location basis.
paymentConfirmUrl	string	Can be used to redirect clients after they finish paying on the selected payment portal to a different landing page than the mini website they booked from.
paymentMethods	array	Displays as an array of all available payment methods.
paymentReq	boolean	Indicates whether or not an appointment is placed in PENDING status at the end of the scheduling flow for clients to await confirmation of funds received from payment portal.
paymentThankYouPage	string
paymentThankYouScript	string
paypalId	string	Displays as alphanumeric ID provided by Paypal to link it to TimeTap.
paypalSetup	boolean	indicates whether or not the specified business has Paypal set up as a payment gateway.
pendingCancelMinutes	integer	Provides the number of minutes that may elapse before an appointment with a status of Pending becomes cancelled.
postmarkApiKey	string	If the specified business uses Postmark to send emails, this displays as their Postmark API key.
restrictIpAddress	boolean	indicates whether or not the specified business is set to restrict login by IP address.
restrictLoginHours	boolean	indicates whether or not the specified business is set to restrict login by hours of the day.
salesforceAccessToken	string	Displays as token provided from Salesforce that grants TimeTap access to read and write from the Salesforce account.
salesforceAddOpportunity	boolean	Indicates whether or not when an appointment is added in TimeTap if TimeTap should then update & add an opportunity to the connected Salesforce account with salesforceOpportunityJson set up.
salesforceClientSearchFields	string
salesforceContactJson	string	Displays as a JSON object representing TimeTap client fields to contact profile in Salesforce.
salesforceEventJson	string	Displays as a JSON object representing TimeTap appointment fields to event profile in Salesforce.
salesforceInstanceUrl	string	Provides unique alphanumeric Salesforce account URL.
salesforceLeadJson

Business Keys

Business Keys API Endpoints

Business Keys API Parameters

Business Keys API Request Body/Payloads

Business Keys API Responses

Business Keys Object Values

Comments