Companies

Here you find all available endpoints related to Followup CRM companies. These endpoints are protected and you'll need an API Token.

In order to use the GET and POST requests, add to the header the following:

Key Value
Content-Type application/json
Accept application/json

Methods Availables:

GET /api/v1/companies

POST /api/v1/companies

PUT /api/v1/companies/{company_id}

GET /api/v1/file-data/companies-list

GET /api/v1/companies

Path Parameters

Key Description Default
api_token
string | REQUIRED		 The API token generated throught UI interface on Followup CRM platform. None
team_id
string		 Filter companies to show only those from this team_id. None
per_page
integer		 Number of records to be returned in one request. 15

Examples


Request Example

/api/v1/companies?api_token=YOUR_API_TOKEN&team_id=2&per_page=2


Response

{
    "data": [
        {
            "id": 41,
            "team_id": 2,
            "name": "Company Name",
            "address": "123 Exemple Street",
            "city": "Laurinechester",
            "state": "Texas",
            "zip": "12345-1234",
            "phone": "1-999-999-99999 x99999",
            "fax": "999-999-99999",
            "pipeline_value": "0.02",
            "closing_ratio": "0%",
            "contact": {
                "name": "Danial Weber",
                "title": "Dr.",
                "email": "test@company.com",
                "cell": "1-999-999-99999 x99999"
            }
        },
        {
            "id": 42, 
            "team_id": 2, 
            "name": "Mayert Ltd", 
            "address": "7712 Rosendo Lake Apt. 145", 
            "city": "New Katherine",
            …
        },
    ],
    "links": {
        "first": "{{ config('app.url') }}/api/v1/companies?page=1",
        "last": "{{ config('app.url') }}/api/v1/companies?page=20",
        "prev": null,
        "next": "{{ config('app.url') }}/api/v1/companies?page=2"
    },
    "meta": {
        "current_page": 1,
        "from": 1,
        "last_page": 20,
        "path": "{{ config('app.url') }}/api/v1/companies",
        "per_page": "2",
        "to": 2,
        "total": 40
    }
}

POST /api/v1/companies

Path Parameters

Key Description Default
api_token
string | REQUIRED		 The API token generated throught UI interface on Followup CRM platform. None

Body

Body Parameters

Key Type Required
name string REQUIRED
external_id string REQUIRED
external_vendor string REQUIRED
address string NULLABLE
city string NULLABLE
state string NULLABLE
zip string NULLABLE
phone string NULLABLE
fax string NULLABLE
pipeline_value string NULLABLE
closing_ratio string NULLABLE
estimator string NULLABLE
contact Array of objects NULLABLE
sales_behaviours Array of objects NULLABLE
estimator string NULLABLE

Examples


Request Example

/api/v1/companies?api_token=YOUR_API_TOKEN

Request Payload

{
   "name": "majidashraf",
     "external_id": "AED70A97966244E89870BE764E8DD7C8",
     "external_vendor": "BlackBox",
     "address": "100 Cattlemen Rd",
     "city": "Sarasota",
     "state": "FL",
     "zip": "",
     "contact": {
         "name": "Shawn",
         "phone": "01932",
         "fax": "1313",
         "cell": "21431313",
         "email": "tbd@gmail.com"
     },
     "account_manager": "sohaib",
     "estimator": "sohaib",
     "sales_behaviours": [
         {
             "name": "Sed debitis.",
             "date": "30-12-2020",
             "completed": true
         },
         {
             "name": "Est consequatur tempora.",
             "date": "30-12-2020",
             "completed": true
         },
         {
             "name": "Proposal Delivered",
             "date": "30-12-2020",
             "completed": true
         },
         {
             "name": "Estimate Due",
             "date": "30-12-2020",
             "completed": true
         }
     ],
     "companies": [
         {
             "name": "AM Engineering, Inc.",
             "address": "",
             "city": "",
             "state": "",
             "zip": "",
             "phone": "",
             "fax": "",
             "company_type": "",
             "closing_ratio": "",
             "external_id": "MRYAN1201531434690",
             "external_vendor": "BlackBox",
             "contact": {
                 "name": "Shawn",
                 "title": "",
                 "email": "tbd",
                 "cell": ""
             }
         }
     ],
     "sales_status": "pending",
     "contract_amount": "2000",
     "base_bid": "2800",
     "contract_date": "2021-01-09",
     "contract_type": "testing project",
     "bid_date": "30-12-2020",
     "last_update": "30-12-2020",
     "proposal_delivered": "2020-12-09",
     "office": "gulberq",
     "Lead_From": "amjad",
     "created_at": "2020-12-0"
}


Response

{
       "data": {
            "id": 2069,
            "uuid": "a3c47133-8afb-46da-83bf-b7eebb405a4a",
            "team_id": 1,
            "name": "majidashraf",
            "address": "100 Cattlemen Rd",
            "city": "Sarasota",
            "state": "FL",
            "zip": null,
            "sales_behaviours": [
                {
                    "name": "Sed debitis.",
                    "date": "2030-12-20",
                    "completed": 1
                },
                {
                    "name": "Est consequatur tempora.",
                    "date": "2030-12-20",
                    "completed": 1
                },
                {
                    "name": "Proposal Delivered",
                    "date": "2030-12-20",
                    "completed": 1
                },
                {
                    "name": "Estimate Due",
                    "date": "2030-12-20",
                    "completed": 1
                }
            ],
            "contact": {
                "name": "Shawn",
                "phone": "01932",
                "fax": "1313",
                "cell": "21431313",
                "email": "tbd@gmail.com"
            },
            "account_manager": "sohaib",
            "companies": [],
            "proposal_delivered": "12/09/2020",
            "sales_status": "04",
            "office": "gulberq",
            "Lead_From": null,
            "contract_amount": "2,000.00",
            "base_bid": "2,800.00",
            "contract_date": "01/09/2021",
            "contract_type": "testing project",
            "bid_date": "12/30/2020",
            "last_update": "12/18/2020",
            "created_at": "2020-12-18T13:55:56.000000Z",
            "external_id": null,
            "external_vendor": null,
            "custom_fields": []
        }
}

PUT /api/v1/companies/{company_id}

Path Parameters

Key Description Default
api_token
string | REQUIRED		 The API token generated throught UI interface on Followup CRM platform. None

Body Parameters

Key Type Required
name string NULLABLE
external_id string NULLABLE
external_vendor string NULLABLE
address string NULLABLE
city string NULLABLE
state string NULLABLE
zip string NULLABLE
phone string NULLABLE
fax string NULLABLE
pipeline_value string NULLABLE
closing_ratio string NULLABLE
contact Array of objects NULLABLE
sales_behaviours Array of objects NULLABLE
estimator string NULLABLE

Examples


Request Payload

/api/v1/companies/{company_id}?api_token=YOUR_API_TOKEN

Response

{
   "name": "abdulmajid",
      "external_id": "AED70A97966244E89870BE764E8DD7C8",
      "external_vendor": "BlackBox",
      "address": "100 Cattlemen Rd",
      "city": "Sarasota",
      "state": "FL",
      "zip": "",
      "contact": {
          "name": "Shawn",
          "phone": "01932",
          "fax": "1313",
          "cell": "21431313",
          "email": "tbd@gmail.com"
      },
      "account_manager": "sohaib",
      "estimator": "sohaib",
      "sales_behaviours": [
           {
              "name": "Quos sapiente.",
              "date": "30-12-2020",
              "completed": true
          },
          {
              "name": "Sed debitis.",
              "date": "30-12-2020",
              "completed": true
          },
          {
              "name": "Est consequatur tempora.",
              "date": "30-12-2020",
              "completed": true
          },
          {
              "name": "Proposal Delivered",
              "date": "30-12-2020",
              "completed": true
          },
          {
              "name": "Estimate Due",
              "date": "30-12-2020",
              "completed": true
          }
      ],
      "companies": [
          {
              "name": "AM Engineering, Inc.",
              "address": "",
              "city": "",
              "state": "",
              "zip": "",
              "phone": "",
              "fax": "",
              "company_type": "",
              "closing_ratio": "",
              "external_id": "MRYAN1201531434690",
              "external_vendor": "BlackBox",
              "contact": {
                  "name": "Shawn",
                  "title": "",
                  "email": "tbd",
                  "cell": ""
              }
          }
      ],
      "sales_status": "04",
      "contract_amount": "2000",
      "base_bid": "2800",
      "contract_date": "2021-01-09T00:00:00",
      "contract_type": "testing project",
      "bid_date": "30-12-2020",
      "last_update": "30-12-2020",
      "proposal_delivered": "2020-12-09",
      "office": "gulberq",
      "Lead_From": "",
      "created_at": ""
}


{
 "data": {
        "id": 2068,
        "uuid": "4bf37fd7-c403-4207-a00b-dc0ef02b8f59",
        "team_id": 1,
        "name": "abdulmajid",
        "address": "100 Cattlemen Rd",
        "city": "Sarasota",
        "state": "FL",
        "zip": null,
        "sales_behaviours": [
            {
                "name": "Quos sapiente.",
                "date": "2030-12-20",
                "completed": 1
            },
            {
                "name": "Sed debitis.",
                "date": "2030-12-20",
                "completed": 1
            },
            {
                "name": "Est consequatur tempora.",
                "date": "2030-12-20",
                "completed": 1
            },
            {
                "name": "Proposal Delivered",
                "date": "2030-12-20",
                "completed": 1
            },
            {
                "name": "Estimate Due",
                "date": "2030-12-20",
                "completed": 1
            }
        ],
        "contact": {
            "name": "Shawn",
            "phone": "01932",
            "fax": "1313",
            "cell": "21431313",
            "email": "tbd@gmail.com"
        },
        "account_manager": "sohaib",
        "companies": [],
        "proposal_delivered": "12/09/2020",
        "sales_status": "04",
        "office": "gulberq",
        "Lead_From": null,
        "contract_amount": "2,000.00",
        "base_bid": "2,800.00",
        "contract_date": "01/09/2021",
        "contract_type": "testing project",
        "bid_date": "12/30/2020",
        "last_update": "12/18/2020",
        "created_at": "2020-12-18T13:46:07.000000Z",
        "external_id": null,
        "external_vendor": null,
        "custom_fields": []
    }
}

GET /api/v1/file-data/companies-list

Path Parameters

Key Description Default
api_token
string | REQUIRED		 The API token generated throught UI interface on Followup CRM platform. None

Examples


Request Example

/api/v1/file-data/companies-list?api_token=YOUR_API_TOKEN


Response

{
    "success": true,
    "message": "Companies Listing",
    "data": [
        {
            "id": 1,
            "name": "Advanced Roofing and Sheet Metal"
        },
        {
            "id": 2,
            "name": "National Disaster Solutions"
        },
        {
            "id": 3,
            "name": "Altec Roofing, Inc."
        },
        {
            "id": 4,
            "name": "Apex Mechanical    "
        },
        {
            "id": 5,
            "name": "Beldon Roofing"
        }
    ]
}

GET /api/v1/file-data/companies-list

Path Parameters

Key Description Default
api_token
string | REQUIRED		 The API token generated throught UI interface on Followup CRM platform. None

Examples


Request Example

/api/v1/file-data/companies-list?api_token=YOUR_API_TOKEN


Response

{
    "success": true,
    "message": "Companies Listing",
    "data": [
        {
            "id": 1,
            "name": "Advanced Roofing and Sheet Metal"
        },
        {
            "id": 2,
            "name": "National Disaster Solutions"
        },
        {
            "id": 3,
            "name": "Altec Roofing, Inc."
        },
        {
            "id": 4,
            "name": "Apex Mechanical    "
        },
        {
            "id": 5,
            "name": "Beldon Roofing"
        }
    ]
}