Companies APIs
A Company refers to an organization to whom you are providing the field services.
List Companies
Purpose
To fetch the list of all available companies. The records fetched will be sorted by Created Time in descending order (recent ones first).
Request URL
https://fsm.zoho.com/fsm/v1/Companies
Request Method
GET
Scope
scope=ZohoFSM.modules.Companies.READ
Query Parameters
| Parameter Name | Data Type | Description | Possible Values |
| page (optional) | Integer | The page from which you want to fetch the records. The default value is 1. | Positive Integer values only |
| per_page (optional) | Integer | The number of records you want to fetch in a page. The default value is 200. | Positive Integer values only |
Sample Request
Copiedcurl --location --request GET 'https://fsm.zoho.com/fsm/v1/Companies' \
--header 'Authorization: Zoho-oauthtoken 1000.63706db******************************d96d4a5'Sample Response
Copied{
"data": [
{
"Owner": {
"name": "Daniel Warne",
"id": "1011000000139001",
"email": "lucy.robins@zylker.com"
},
"Email": "people@zylker.com",
"$currency_symbol": "$",
"Company_Type": "Customer",
"Config": "{}",
"Website": "www.zylker.com",
"$editable": true,
"Tax": {
"Tax_Authority_Id": null,
"Tax_Percentage": 3.5,
"Tax_Exemption_Code": null,
"Tax_Authority": null,
"Tax_Id": "2908070000000135005",
"Tax_Name": "County tax",
"Tax_Exemption_Id": null,
"Taxable": true
},
"ZBilling_Id": null,
"Mobile": "987-654-3210",
"Sample__C": null,
"Exchange_Rate": 1,
"Phone": "987-654-3210",
"Billing_Address": null,
"Currency": "USD",
"Service_Address": null,
"Company_Name": "Zylker Inc",
"id": "1011000000195085",
"Fax": null
},
{
"Owner": {
"name": "Daniel Warne",
"id": "1011000000139001",
"email": "lucy.robins@zylker.com"
},
"Email": "sales@acme.com",
"$currency_symbol": "$",
"Company_Type": "Customer",
"Config": null,
"Website": "www.acme.com",
"$editable": true,
"Tax": {
"Tax_Authority_Id": null,
"Tax_Percentage": 7,
"Tax_Exemption_Code": null,
"Tax_Authority": null,
"Tax_Id": "2908070000000130005",
"Tax_Name": "Sales tax",
"Tax_Exemption_Id": null,
"Taxable": true
},
"ZBilling_Id": null,
"Mobile": "987-654-3210",
"Sample__C": null,
"Exchange_Rate": 1,
"Phone": "987-654-3210",
"Billing_Address": null,
"Currency": "USD",
"Service_Address": null,
"Company_Name": "Acme Inc",
"id": "1011000000195083",
"Fax": null
},
{
"Owner": {
"name": "Daniel Warne",
"id": "1011000000139001",
"email": "lucy.robins@zylker.com"
},
"Email": null,
"$currency_symbol": "$",
"Company_Type": null,
"Config": null,
"Website": null,
"$editable": true,
"Tax": {
"Tax_Authority_Id": null,
"Tax_Percentage": null,
"Tax_Exemption_Code": null,
"Tax_Authority": null,
"Tax_Id": "2908070000000092001",
"Tax_Name": "IllinoisExciseTax",
"Tax_Exemption_Id": null,
"Taxable": true
},
"ZBilling_Id": "2908070000000125001",
"Mobile": null,
"Sample__C": null,
"Exchange_Rate": 1,
"Phone": null,
"Billing_Address": null,
"Currency": "USD",
"Service_Address": null,
"Company_Name": "Dormell Properties 485 (Pty) Ltd",
"id": "1011000000157105",
"Fax": null
},
{
"Owner": {
"name": "Daniel Warne",
"id": "1011000000139001",
"email": "lucy.robins@zylker.com"
},
"Email": null,
"$currency_symbol": "$",
"Company_Type": null,
"Config": "{\"isWOCreated\":true}",
"Website": null,
"$editable": true,
"Tax": {
"Tax_Authority_Id": null,
"Tax_Percentage": 6.25,
"Tax_Exemption_Code": null,
"Tax_Authority": null,
"Tax_Id": "2908070000000075018",
"Tax_Name": "IllinoisSalesTax",
"Tax_Exemption_Id": null,
"Taxable": true
},
"ZBilling_Id": "2908070000000079001",
"Mobile": null,
"Sample__C": null,
"Exchange_Rate": 1,
"Phone": null,
"Billing_Address": null,
"Currency": "USD",
"Service_Address": null,
"Company_Name": "Nebula",
"id": "1011000000139165",
"Fax": null
}
],
"info": {
"per_page": 200,
"count": 4,
"page": 1,
"more_records": false
}
}