Contacts

Here you find all available endpoints related to Followup CRM contacts. 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/contacts

GET /api/v1/file-data/contacts-by-company

POST /api/v1/file-data/save-project-company-contact

POST /api/v1/contact/note

PUT /api/v1/contact/note/{id}

GET /api/v1/contacts

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
companies_id
string		 Filter contacts to show only those from this companies_id, scpecified as a comma-separated string. None
per_page
integer		 Number of records to be returned in one request. 15
start_date
date		 Filter contacts by the creation date.

Format: YYYY-MM-DD

Requires end_date		 None
end_date
date		 Filter contacts by the creation date.

Format: YYYY-MM-DD

Requires start_date		 None

Examples


Request Example

/api/v1/contacts?api_token=YOUR_API_TOKEN&team_id=2&companies_id=48,49,50&per_page=2&start_date=2020-01-01&end_date=2020-01-10


Response

{
    "data": [
        {
            "id": 81,
            "team_id": 2,
            "name": "Danial Weber",
            "cell": "1-218-649-2515 x26136",
            "email": "jose.ritchie@bechtelar.com",
            "title": "Dr.",
            "company":{"id": 41, "team_id": 2, "name": "Hammes PLC", "address": "425 Angela Extension"},
            "status": null,
            "date": null,
            "completed": null,
            "last_meeting":{
                "date": null,
                "completed": null,
                "user": null
            },
            "created_at": "2020-01-01T00:00:00Z",
            "notes": [
                {
                    "id": 106,
                    "team_id": 179,
                    "note": "<p>BlueSky Industries</p>"
                },
                {
                    "id": 107,
                    "team_id": 179,
                    "note": "Hello Contact 1"
                },
                {
                    "id": 108,
                    "team_id": 179,
                    "note": "Hello Contact"
                }
            ]
        },
        {
            "id": 81,
            "team_id": 2,
            "name": "Alexander Shanahan",
            "cell": "1-263-516-6469",
            "email": "russel.tevin@hotmail.com",
            "title": "Dr.",
            "company":{"id": 41, "team_id": 2, "name": "Hammes PLC", "address": "425 Angela Extension"},
            "status": null,
            "date": null,
            "completed": null,
            "last_meeting":{
                "date": null,
                "completed": null,
                "user": null
            },
            "created_at": "2020-01-01T00:00:00Z",
            "notes": []
        }
    ],
    "links":{
        "first": "{{ config('app.url') }}/api/v1/contacts?page=1",
        "last": "{{ config('app.url') }}/api/v1/contacts?page=40",
        "prev": null,
        "next": "{{ config('app.url') }}/api/v1/contacts?page=2"
    },
    "meta":{
        "current_page": 1,
        "from": 1,
        "last_page": 40,
        "path": "{{ config('app.url') }}/api/v1/contacts",
        "per_page": "2",
        "to": 2,
        "total": 80
    }
}

GET /api/v1/file-data/contacts-by-company

Path Parameters

Key Description Default
api_token
string | REQUIRED		 The API token generated throught UI interface on Followup CRM platform. None
company_id
string		 Filter contacts to show only from this company_id. None

Examples


Request Example

/api/v1/file-data/contacts-by-company?api_token=YOUR_API_TOKEN&company_id=117408


Response

{
    "success": true,
    "message": "Contacts listing",
    "data": [
        {
            "id": 167902,
            "name": "test contact",
            "cell": "23412341234",
            "title": "Mr.",
            "email": "majidashraf@dmeo.com",
            "team_id": 3,
            "company_id": 117408,
            "notes": [
                {
                    "id": 106,
                    "team_id": 179,
                    "note": "<p>BlueSky Industries</p>"
                },
                {
                    "id": 107,
                    "team_id": 179,
                    "note": "Hello Contact 1"
                },
                {
                    "id": 108,
                    "team_id": 179,
                    "note": "Hello Contact"
                }
            ]
        },
        {
            "id": 168387,
            "name": "Zap Contact Test",
            "cell": "3333333333",
            "title": null,
            "email": "zaptest@gmail.com",
            "team_id": 3,
            "company_id": 117408,
            "notes" : []
        },
        {
            "id": 168388,
            "name": "Zap Contact Test 2",
            "cell": "3333333333",
            "title": null,
            "email": "zaptest@gmail.com",
            "team_id": 3,
            "company_id": 117408,
            "notes" : []
        }
    ]
}

POST /api/v1/file-data/save-project-company-contact

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
project_id big int REQUIRED
company_id big int REQUIRED
company_contact_id big int NULLABLE
name string NULLABLE
title string NULLABLE
email string NULLABLE
cell string NULLABLE
date string NULLABLE
status string NULLABLE

Examples


Request Example

/api/v1/file-data/save-project-company-contact?api_token=YOUR_API_TOKEN

Request Payload

{
    "project_id": 2170,
    "company_id": 200,
    "company_contact_id": "",
    "date": "07-01-2021",
    "name": "dev",
    "email": "dev@devigital.com",
    "cell": "23235324",
    "title": "Mr.",
    "status": "lost" 
}


Response

{
    "success": true,
    "message": "Company contact added successfully"
}

POST /api/v1/contact/note

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
contact_id big int REQUIRED
note string REQUIRED

Examples


Request Example

/api/v1/contact/note?api_token=YOUR_API_TOKEN

Request Payload

{
    "contact_id": 74,
    "note": "Hello Contact"
}


Response

{
    "success": true,
    "message": "Contact note saved successfully"
}

PUT /api/v1/contact/note/{id}

Path Parameters

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

Body

Body Parameters

Key Type Required
note string REQUIRED

Examples


Request Example

/api/v1/contact/note/{id}?api_token=YOUR_API_TOKEN

Request Payload

{
    "note": "Hello Contact Updated"
}


Response

{
    "success": true,
    "message": "Contact note updated successfully"
}