Documentation
LogIn- Getting started
-
CRM API
- Adding/Updating Contacts
- List Filter/Search Contacts
- Contact Timeline Actions
- Contact Info
- Contact Actions
- Adding/Updating Company
- List Filter/Search Companies
- Company Timeline Actions
- Company Info
- Update Company Info
- Add Company Timeline Action
- Adding/Updating Deals
- List Filter/Search Deals
- List Filter/Search Deals Board View
- Drag/Drop Deals between Stages
- Deal WIN/LOSS Reasons
- Owners
- Countries
- Stages
- Funnels
- Lead Scores
- Deal Timeline Actions
- Deal Info
- Update Deal Info
- Add Deal Timeline Action
- List Filter/Search Activities/Tasks
- Add/Update Activity/Tasks
- Contact Messages
- List User Messages
- Delete Actions
-
Phone API
- Send SMS
- Search Phone Numbers
- Order Phone Number
- List Active Phone Numbers
- Disconnect Phone Number
- List Available Audio Files
- Block Phone Number
- Unblock Phone Number
- Check Number Block Status
- List Phone Sub Accounts
- Add/Edit Sub Account
- Attach Phone Number to Sub Account
- List Phone Numbers Per Sub Account
- System API
- Service/Tickets API
- API - Premium Edition
- Callbacks
- Resellers API
- Enabler API
- SMS Error Codes
This API is used to list companies in the CRM with ability to search in it with pagination also.
Method: Get/Post
Base URL : https://hubbucs.com/site/api/hubb/companies
Method: Get/Post
Base URL : https://hubbucs.com/site/api/hubb/companies
Mandatory Parameters | Sample | Description |
---|---|---|
key | 374593457034859 | The company account API key, you can get from company settings > API settings |
newcompany@url.com | email for user to authenticate | |
password | 123456 | Password for user to authenticate |
Optional Parameters for Search/Filter | Sample | Description |
---|---|---|
id | 876566 | the company id |
company_email | newcompany@url.com | email for the company |
dba | Hubb DBA | The company dba name |
name | Hubb | The name for the company |
tax_id | douglas | The tax ID for the company |
tags | Test1,Test2 | Tags for the company |
street | 23 new york st | Company Street |
city | Sunrise | The city name for the company Address |
country | 55 | The country ID for the company Address |
facebook ULR or Facebook name | The Facebook page or name for the company | |
twitter ULR or twitter name | The twitter account for the company | |
Linkedin username | The Linkedin username account for the company | |
sector_id | 2 | The Sector ID for the company |
owner_id | 4 | The Owner ID for the company |
employee_range | 1-10 | The Rang of the Employee inside the company |
added_date | 2020-08-31 | The Creation Date for the company |
custom_field | custom_field_api_name | any value |
screen | Return 20 record for each page .Send page number to return page records.(You have total records returned in the response) | number of page (required for pagination) |
Example:
Example :
https://hubbucs.com/site/api/hubb/companies?key=12134651Gsuid7349&email=XXXXX&password=XXXXX[&name=XXXXX&company_emailemail=XXXXX&....etc&screen=1]
Response :
- {
- "message":"success",
- "total_records":"20",
- "company_id":"56",
- "company_name":"HUBB",
- "company_dba":"companyEmail@email.com",
- "contact_no":"52",
- "logo":"company Picture"
- "last_activity":"last activity date"
- "page":"page number"
- }
- ------OR------
- {
- "error_message":"error message"
- }