Skip to main content
GET
/
v4
/
clientMgmt
/
business
Get a business
curl --request GET \
  --url https://sandbox.hurdlr.com/rest/v4/clientMgmt/business \
  --header 'Authorization: Bearer <token>'
{
  "id": "<string>",
  "companyId": "<string>",
  "companyIdLong": 123,
  "customerPartnerId": 123,
  "name": "<string>",
  "showName": true,
  "contactFirst": "<string>",
  "contactLast": "<string>",
  "showContactFirstLast": true,
  "email": "<string>",
  "showEmail": true,
  "phoneWork": "<string>",
  "showPhoneWork": true,
  "address1": "<string>",
  "address2": "<string>",
  "city": "<string>",
  "state": "<string>",
  "zip": "<string>",
  "showAddress": true,
  "tin": "<string>",
  "invoicePrefix": "<string>",
  "plaidApiEntityIds": "<string>",
  "status": "ACTIVE",
  "apiName": "GOOGLELOGIN",
  "apiClientId": "<string>",
  "bizType": "ADVISOR_COACH",
  "labelId": 123,
  "createdDate": "2023-11-07T05:31:56Z",
  "idPrefix": "COMPANY",
  "nameColumnNameForPagination": "<string>",
  "externalId": "<string>"
}

Authorizations

​
Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Query Parameters

​
id
string
default:""
required

Id of the specific business

Response

200 - application/json

Successful operation

​
id
string
​
companyId
string
​
companyIdLong
integer<int64>
​
customerPartnerId
integer<int64>
​
name
string
​
showName
boolean
​
contactFirst
string
​
contactLast
string
​
showContactFirstLast
boolean
​
email
string
​
showEmail
boolean
​
phoneWork
string
​
showPhoneWork
boolean
​
address1
string
​
address2
string
​
city
string
​
state
string
​
zip
string
​
showAddress
boolean
​
tin
string
​
invoicePrefix
string
​
plaidApiEntityIds
string
​
status
enum<string>
Available options:
ACTIVE,
INACTIVE,
PENDING,
DELETED
​
apiName
enum<string>
Available options:
GOOGLELOGIN,
LINKEDINLOGIN,
DROPBOX,
BOX,
SKYDRIVE,
CLOVER,
STRIPE,
GOOGLESTORAGE,
GOOGLECONTACTS,
GOOGLEEMAIL,
LINKEDINCONTACTS,
PLAID,
KNOX,
UBER,
FACEBOOKLOGIN,
FRESHBOOKS,
HARVEST,
KW,
FRESHBOOKS2,
CAPITAL_ONE,
SQUARE,
S3,
DOTLOOP,
XERO_DEPRECATED,
REALOGY,
UPWORK,
SHOPIFY,
DEDUCTR,
ENTERPRISE,
MOXIWORKS,
STRIPE_EXPRESS,
APPLELOGIN,
APPDIRECT,
LONEWOLF,
USER_IMPORTED,
LONEWOLF_TRANSACTIONDESK,
SAMPLE_BANK,
TAXBOT,
THIRD_PARTY_BANK,
GUSTO,
THIRD_PARTY_PAYMENTS,
XERO,
UNIT,
USER_ENTRY,
MOOV,
QBO,
COLUMN,
QUALPAY,
BENCH,
PARTNER_IMPLEMENTATION,
CHECK,
RUTTER,
WAVE,
ADYEN,
APRIL
​
apiClientId
string
​
bizType
enum<string>
Available options:
ADVISOR_COACH,
ARCHITECT,
BRANDING_DESIGN,
CONSULTANT,
GOVT_CONTRACTOR,
HOTEL_HOSPITALITY,
PHOTOGRAPHY,
PRINTING_DESIGN,
PROFESSIONAL_SERVICES,
LANDLORD,
REAL_ESTATE_AGENT,
RESTAURANT,
SOFTWARE_DEV,
SPEAKER_AUTHOR,
TECH_SUPPORT,
WEB_DESIGN_DEV,
HEALTH_PROFESSIONAL,
OTHER,
DRIVER,
AIRBNB,
FINANCIAL_ADVISOR,
INSURANCE_AGENT,
MARKETER,
RETAIL,
HOST,
FREELANCER,
E_COMMERCE,
SALES
​
labelId
integer<int64>
​
createdDate
string<date-time>
​
idPrefix
enum<string>
Available options:
COMPANY,
EMPLOYEE,
CLASS_SEGMENT,
CLASS_LABEL,
CUSTOMER,
BANK_ACCOUNT,
GL_ACCOUNT,
TRANSACTION_CATEGORY,
BANK_TRANSACTION,
PROCESSOR_TRANSACTION,
TRANSACTION_LINE_ITEM,
VENDOR,
TRANSACTION_RULE,
REVENUE_RULE,
INVOICE,
INVOICE_LINE_ITEM,
BILL,
BILL_LINE_ITEM,
PAYROLL,
PAYROLL_LINE_ITEM,
FINANCIAL_SUMMARY,
TASK,
CONVERSATION,
MESSAGE,
REACTION,
BUSINESS_TYPE,
TEMPLATE_CLASS_LABEL,
TEMPLATE_COA,
TEMPLATE_GL_ACCOUNT,
TEMPLATE_TRANSACTION_RULES,
MANUAL_JOURNAL_ENTRY,
GL_TRANSACTION,
ATTACHMENT,
CAR,
MILEAGE,
INTEGRATION,
TIME,
TIME_TYPE,
TAX_RETURN
​
nameColumnNameForPagination
string
​
externalId
string