1. List companies (api1/companies)
This method will answer with a collection of iinsight's companies in JSON format.
The results would be
paginated, having a maximum of 5000 records per page. An empty collection and a status code 200 response, means that
there is no records in the specified page.
URL
| Server |
URL |
HTTP type |
| UAT |
https://api-usa-uat.iinsightonline.com/api1/companies |
GET |
| PRODUCTION |
https://api-usa.iinsightonline.com/api1/companies |
GET |
Authorization
| Parameter |
Value |
Mandatory |
| Type |
Bearer Token |
Yes |
| Token |
The token is generated using the /auth/login method |
Yes |
Query Params
| Parameter |
Value |
Mandatory |
| page |
The page number of the paginated results. (i.e.: 1)
|
Yes |
| modified_since |
Date since last update or insert. Format yyyy-mm-dd (i.e.: 2022-12-31)
Use "1900-01-01" to get all
contacts no matter the modified or created date.
|
Yes |
Response
[
{
"company_id": "283",
"company_name": "New Release Test",
"email": "contact@newreleasetest.com.au",
"phone1": "123456",
"phone2": "7891",
"fax": "(02) 1234 5678",
"mobile": "0412 345 987",
"street": "52-58 William Street",
"postcode": "2011",
"suburb": "Woolloomooloo",
"sublocality": "City of Sydney",
"state": "New South Wales",
"country": "Australia",
"bank": "Commonwealth Bank",
"branch": "Darlinghurst",
"abn": "54 123 456 789",
"biller_id": "112233",
"notes": "A, B, C, D"
},
{
"company_id": "294",
"company_name": "Be Software Testing PVT",
"email": "info@besoftwaretesting.com.au",
"phone1": "(02) 9876 5432",
"phone2": "(02) 9876 5433",
"fax": "(02) 9876 5434",
"mobile": "0456 789 063",
"street": "Mrs Macquaries Road",
"postcode": "2000",
"suburb": "Sydney",
"sublocality": "City of Sydney",
"state": "New South Wales",
"country": "Australia",
"bank": "ANZ",
"branch": "Circular Quay",
"abn": "98 654 321 000",
"biller_id": "998877",
"notes": "Testing account. Call after 3PM."
},
...
]
2. List Companies by Name (api1/companies/list)
This method will answer with case contacts list. It will be in JSON format.
The results can be filter by company name and it will be in alphabetical order.
URL
| Server |
URL |
HTTP type |
| UAT |
https://api-usa-uat.iinsightonline.com/api1/companies/list |
GET |
| PRODUCTION |
https://api-usa.iinsightonline.com/api1/companies/list |
GET |
Authorization
| Parameter |
Value |
Mandatory |
| Type |
Bearer Token |
Yes |
| Token |
The token is generated using the /auth/login method |
Yes |
Query Params
| Parameter |
Value |
Mandatory |
| fields |
Company's fields separated by commas with no blank spaces: address,biller_id,company_id,company_name,country,email,fax,mobile,notes,phone1,phone2,postcode,state,suburb |
Yes |
| sort_col |
Sort by column field name. (i.e.: field_name) |
No |
| sort_type |
Sort column type. Options: asc, desc |
No |
| search_criteria |
Search field name. (i.e.: {"field_name1":"value1","field_name2":"value1,value2"}) |
No |
| page |
The page number of the paginated results. (i.e.: 1) |
No |
| limit |
The limit amount of items. (i.e.: 1) |
No |
Response
[
{
"address": "603/6 Help Street",
"biller_id": "BIZ001",
"company_id": "1",
"company_name": "Bizexpress Pty Limited",
"country": "Australia",
"email": "info@bizexpress.com.au",
"fax": "(02) 9372 5199",
"mobile": "0412 345 678",
"notes": "Preferred contact via email.",
"phone1": "(02) 9372 5100",
"phone2": "(02) 9372 5101",
"postcode": "2060",
"state": "NSW",
"suburb": "Chatswood"
},
{
"address": "456 Watson Ave",
"biller_id": "HFC002",
"company_id": "2",
"company_name": "Highfields Corp Pty Limited",
"country": "Australia",
"email": "contact@highfields.com.au",
"fax": "(03) 9999 9998",
"mobile": "0400 111 222",
"notes": "Handles international shipments.",
"phone1": "(03) 9999 9999",
"phone2": "(03) 9999 9988",
"postcode": "3000",
"state": "VIC",
"suburb": "Melbourne"
},
...
]
3. List Company contacts (api1/companies/contacts)
This method will respond with a list of contacts based on the company ID provided. If a specific contact ID is provided, only that contact will be returned. The response will be in JSON format.
Results can be filtered by contact name and will be sorted by contact ID.
URL
| Server |
URL |
HTTP type |
| UAT |
https://api-usa-uat.iinsightonline.com/api1/companies/contacts |
GET |
| PRODUCTION |
https://api-usa.iinsightonline.com/api1/companies/contacts |
GET |
Authorization
| Parameter |
Value |
Mandatory |
| Type |
Bearer Token |
Yes |
| Token |
The token is generated using the /auth/login method |
Yes |
Query Params
| Parameter |
Value |
Mandatory |
| company_id |
ID of the company you want to see contacts for. (i.e.: 1,2,3,...).
You can send "all" instead an id to obtain all contacts.
|
Yes |
| fields |
Company's fields seperated by comma and no blank spaces. (i.e.: field_name1,field_name2,...) |
Yes |
| Status |
The contact status options: enabled, disabled, or all.
- "Enabled" returns all enabled contacts.
- "Disabled" returns all disabled contacts.
- "All" returns both enabled and disabled contacts.
|
No |
| contact_id |
ID of the contact you want to see from the company. If not provided, all contacts from the company will be shown. (e.g.: 1,2,3,...) |
No |
| sort_col |
Sort by column field name. (i.e.: field_name) |
No |
| sort_type |
Sort column type. Options: asc, desc |
No |
| search_criteria |
Search field name. (i.e.: {"field_name1":"value1","field_name2":"value1,value2"}) |
No |
| page |
The page number of the paginated results. (i.e.: 1) |
No |
| limit |
The limit amount of items. (i.e.: 1) |
No |
Response
[
{
"contact_id": "512",
"company_name": "Tech Solutions Inc",
"country": "United States",
"date_created": "2024-08-01T12:34:56Z",
"date_disabled": null,
"department": "IT",
"disabled": "0",
"email": "contact@techsolutions.com",
"fax": "123-456-7890",
"first_name": "Alice",
"job_title": "Software Engineer",
"last_name": "Johnson",
"mobile": "555-123-4567",
"notes": "Key contact for technical support",
"phone1": "123-456-7890",
"phone2": "",
"position": "Senior Engineer",
"postcode": "90210",
"provider_no": "TS001",
"state": "California",
"suburb": "Beverly Hills",
"title": "Ms",
"address": "1234 Main St, Suite 100",
"contact_role_bill_to": "Yes",
"contact_role_bill_to_cc": "No",
"contact_role_employer": "No",
"contact_role_referrer": "No",
"longitude": "-118.400356",
"latitude": "34.073620",
"full_name": "Alice Johnson , Ms",
"biller_id": "",
"status": "enabled"
},
{
"contact_id": "784",
"company_name": "Greenfield Farming Ltd",
"country": "Canada",
"date_created": "2023-11-15T09:21:34Z",
"date_disabled": "2024-07-30T14:12:09Z",
"department": "Agriculture",
"disabled": "1",
"email": "john.doe@greenfield.com",
"fax": "555-987-6543",
"first_name": "John",
"job_title": "Farm Manager",
"last_name": "Doe",
"mobile": "555-876-5432",
"notes": "Contact for supply chain inquiries",
"phone1": "555-987-6543",
"phone2": "555-987-0000",
"position": "Manager",
"postcode": "K1A 0B1",
"provider_no": "GF200",
"state": "Ontario",
"suburb": "Ottawa",
"title": "Mr",
"address": "5678 Farm Road",
"contact_role_bill_to": "No",
"contact_role_bill_to_cc": "Yes",
"contact_role_employer": "Yes",
"contact_role_referrer": "No",
"longitude": "-75.697193",
"latitude": "45.421530",
"full_name": "John Doe , Mr",
"biller_id": "45778900",
"status": "disabled"
}
]