Here you find all available endpoints related to Followup CRM file data. 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 BY ID
/api/v1/pm-file-data/id
POST
/api/v1/pm-file-data/custom-fields
/api/v1/pm-file-data
Key | Description | Default |
---|---|---|
api_token string | REQUIRED |
The API token generated through UI interface on Followup CRM platform. | None |
team_id string |
** | |
Filter** file-data to show only those from this team_id . |
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 |
/api/v1/pm-file-data?api_token=YOUR_API_TOKEN&team_id=2&per_page=2&start_date=2020-01-01&end_date=2020-01-10
{
"data": [
{
"id": 495,
"legacy_id": null,
"sequential_team_id": null,
"name": "Abdiel Roberts",
"address": "3967 Marvin Summit Apt. 988",
"city": "East Shirleyview",
"state": "Utah",
"zip": "23048",
"contact": {
"id": 495,
"team_id": 1,
"project_id": 495,
"name": "Prof. Haley Shanahan DDS",
"phone": "(141) 756-9274 ext. 4936",
"fax": "(154) 376-2179 ext. 1",
"cell": "(408) 898-3088 ext. 3925",
"email": "christelle47@hotmail.com",
"created_at": "2020-12-02T11:37:14.000000Z",
"updated_at": "2020-12-10T13:00:47.000000Z",
"deleted_at": null
},
"account_manager": "sohaib",
"estimator": null,
"company_name": null,
"sales_status": "SHOT",
"contract_amount": "8.33",
"base_bid": "1.35",
"bid_id": null,
"contract_date": "06/15/2020",
"bid_date": "04/05/2020",
"pre_qualified": true,
"last_update": "08/17/2021",
"contract_type": ".",
"office": "Onsite",
"login_date": "12/15/2020",
"superintendent": null,
"project_manager": null,
"project_admin": null,
"crew_leader": [
{
"id": 1,
"uuid": "7025f374-0f75-4214-aae1-7aca18a39e72",
"name": "DevSquad",
"email": "team@devsquad.com",
"email_verified_at": "2020-12-02 11:14:24",
"include_in_company_report": 1,
"follow_up": 1,
"google_id": null,
"microsoft_id": null,
"photo_url": "https://www.gravatar.com/avatar/1c72fb117ca95a102e0ce13ba5aca793.jpg?s=200&d=mm",
"uses_two_factor_auth": false,
"external_email": null,
"external_email_added_in": null,
"last_selected_timezone": "America/New_York",
"two_factor_reset_code": null,
"current_team_id": 1,
"user_type": "sales",
"stripe_id": null,
"current_billing_plan": null,
"billing_state": null,
"vat_id": null,
"trial_ends_at": null,
"last_read_announcements_at": "2021-05-25 05:59:42",
"created_at": "2020-12-02T11:14:24.000000Z",
"updated_at": "2021-10-22T13:46:40.000000Z",
"reports_to": null,
"legacy_id": null,
"comment_credit_value": "0.00",
"deleted_at": null,
"exchange_server": "mail.centralroofing.com",
"exchange_username": "efollowup",
"exchange_password": "New2021!#%",
"stack_partner_response_code": null,
"company_cam_partner_response_code": null,
"company_cam_user_id": 2657438,
"signature": null,
"pivot": {
"project_id": 1,
"user_id": 1,
"start_date": "2021-04-09 00:00:00",
"end_date": "2021-04-09 00:00:00"
}
}
],
"project_engineer": null,
"project_stage": {
"id": 4,
"team_id": 1,
"code": "Stage4",
"full_description": "Completed",
"short_description": "Completed",
"load_order": 4,
"locked": 1,
"created_at": "2020-12-02T11:17:41.000000Z",
"updated_at": "2020-12-02T11:17:41.000000Z",
"deleted_at": null,
"legacy_id": null
},
"project_duration": {
"id": 1,
"team_id": 1,
"code": "Small",
"full_description": "Small Job",
"short_description": "Small Job",
"load_order": 1,
"locked": 1,
"created_at": "2020-12-02T11:17:41.000000Z",
"updated_at": "2020-12-02T11:17:41.000000Z",
"deleted_at": null,
"legacy_id": null
},
"complete_date": "12/22/2020",
"actual_completed_date": "06/30/2020",
"pm_contract_date": "06/15/2020",
"office_name": null,
"contract_type_name": null,
"custom_fields": [
{
"id": 1,
"label_value": "Dead Reason",
"value": "1",
"type": 3
},
{
"id": 5,
"label_value": "Segment",
"value": "2",
"type": 3
}
]
}
],
"links": {
"first": "{{ config('app.url') }}/api/v1/pm-file-data?page=1",
"last": "{{ config('app.url') }}/api/v1/pm-file-data?page=3",
"prev": null,
"next": "{{ config('app.url') }}/api/v1/pm-file-data?page=2"
},
"meta": {
"current_page": 1,
"from": 1,
"last_page": 3,
"path": "{{ config('app.url') }}/api/v1/pm-file-data",
"per_page": "2",
"to": 2,
"total": 6
}
}
/api/v1/pm-file-data/id
Key | Description | Default |
---|---|---|
api_token string | REQUIRED |
The API token generated through UI interface on Followup CRM platform. | None |
id string |
** | |
Filter** show only the project corresponding to ID. | None |
/api/v1/pm-file-data/id?api_token=YOUR_API_TOKEN
{
"project": {
"id": 495,
"legacy_id": null,
"sequential_team_id": null,
"name": "Abdiel Roberts",
"address": "3967 Marvin Summit Apt. 988",
"city": "East Shirleyview",
"state": "Utah",
"zip": "23048",
"contact": {
"id": 495,
"team_id": 1,
"project_id": 495,
"name": "Prof. Haley Shanahan DDS",
"phone": "(141) 756-9274 ext. 4936",
"fax": "(154) 376-2179 ext. 1",
"cell": "(408) 898-3088 ext. 3925",
"email": "christelle47@hotmail.com",
"created_at": "2020-12-02T11:37:14.000000Z",
"updated_at": "2020-12-10T13:00:47.000000Z",
"deleted_at": null
},
"account_manager": "sohaib",
"estimator": null,
"company_name": null,
"sales_status": "SHOT",
"contract_amount": "8.33",
"base_bid": "1.35",
"bid_id": null,
"contract_date": "06/15/2020",
"bid_date": "04/05/2020",
"pre_qualified": true,
"last_update": "08/17/2021",
"contract_type": ".",
"office": "Onsite",
"login_date": "12/15/2020",
"superintendent": null,
"project_manager": null,
"project_admin": null,
"crew_leader": [
{
"id": 1,
"uuid": "7025f374-0f75-4214-aae1-7aca18a39e72",
"name": "DevSquad",
"email": "team@devsquad.com",
"email_verified_at": "2020-12-02 11:14:24",
"include_in_company_report": 1,
"follow_up": 1,
"google_id": null,
"microsoft_id": null,
"photo_url": "https://www.gravatar.com/avatar/1c72fb117ca95a102e0ce13ba5aca793.jpg?s=200&d=mm",
"uses_two_factor_auth": false,
"external_email": null,
"external_email_added_in": null,
"last_selected_timezone": "America/New_York",
"two_factor_reset_code": null,
"current_team_id": 1,
"user_type": "sales",
"stripe_id": null,
"current_billing_plan": null,
"billing_state": null,
"vat_id": null,
"trial_ends_at": null,
"last_read_announcements_at": "2021-05-25 05:59:42",
"created_at": "2020-12-02T11:14:24.000000Z",
"updated_at": "2021-10-22T13:46:40.000000Z",
"reports_to": null,
"legacy_id": null,
"comment_credit_value": "0.00",
"deleted_at": null,
"exchange_server": "mail.centralroofing.com",
"exchange_username": "efollowup",
"exchange_password": "New2021!#%",
"stack_partner_response_code": null,
"company_cam_partner_response_code": null,
"company_cam_user_id": 2657438,
"signature": null,
"pivot": {
"project_id": 1,
"user_id": 1,
"start_date": "2021-04-09 00:00:00",
"end_date": "2021-04-09 00:00:00"
}
}
],
"project_engineer": null,
"project_stage": {
"id": 4,
"team_id": 1,
"code": "Stage4",
"full_description": "Completed",
"short_description": "Completed",
"load_order": 4,
"locked": 1,
"created_at": "2020-12-02T11:17:41.000000Z",
"updated_at": "2020-12-02T11:17:41.000000Z",
"deleted_at": null,
"legacy_id": null
},
"project_duration": {
"id": 1,
"team_id": 1,
"code": "Small",
"full_description": "Small Job",
"short_description": "Small Job",
"load_order": 1,
"locked": 1,
"created_at": "2020-12-02T11:17:41.000000Z",
"updated_at": "2020-12-02T11:17:41.000000Z",
"deleted_at": null,
"legacy_id": null
},
"complete_date": "12/22/2020",
"actual_completed_date": "06/30/2020",
"pm_contract_date": "06/15/2020",
"office_name": null,
"contract_type_name": null,
"custom_fields": [
{
"id": 1,
"label_value": "Dead Reason",
"value": "1",
"type": 3
},
{
"id": 5,
"label_value": "Segment",
"value": "2",
"type": 3
}
]
}
}
/api/v1/pm-file-data
Key | Description | Default |
---|---|---|
api_token string | REQUIRED |
The API token generated through UI interface on Followup CRM platform. | None |
Key | Type | Required |
---|---|---|
name | string | REQUIRED |
contact_name | string | REQUIRED |
address | string | NULLABLE |
city | string | NULLABLE |
state | string | NULLABLE |
zip | string | NULLABLE |
contact_name | string | NULLABLE |
contact_email | string | NULLABLE |
contact_phone | string | NULLABLE |
contact_cell | string | NULLABLE |
contact_fax | string | NULLABLE |
pm_contract_date | date | NULLABLE |
actual_completed_date | date | NULLABLE |
complete_date | date | NULLABLE |
crew_leaders | array | NULLABLE |
/api/v1/pm-file-data?api_token=YOUR_API_TOKEN
{
"name": "Abdiel Roberts",
"address": "3967 Marvin Summit Apt. 988",
"city": "East Shirleyview",
"state": "Utah",
"zip": "23048",
"contact_name":"Prof. Haley Shanahan DDS",
"contact_phone": "(141) 756-9274 ext. 4936",
"contact_fax": "(154) 376-2179 ext. 1",
"contact_cell": "(408) 898-3088 ext. 3925",
"contact_email": "christelle47@hotmail.com",
"complete_date": "12/22/2020",
"actual_completed_date": "06/30/2020",
"pm_contract_date": "06/15/2020",
"crew_leader": [
{
"id": 1,
"uuid": "7025f374-0f75-4214-aae1-7aca18a39e72",
"name": "DevSquad",
"email": "team@devsquad.com",
"email_verified_at": "2020-12-02 11:14:24",
"include_in_company_report": 1,
"follow_up": 1,
"google_id": null,
"microsoft_id": null,
"photo_url": "https://www.gravatar.com/avatar/1c72fb117ca95a102e0ce13ba5aca793.jpg?s=200&d=mm",
"uses_two_factor_auth": false,
"external_email": null,
"external_email_added_in": null,
"last_selected_timezone": "America/New_York",
"two_factor_reset_code": null,
"current_team_id": 1,
"user_type": "sales",
"stripe_id": null,
"current_billing_plan": null,
"billing_state": null,
"vat_id": null,
"trial_ends_at": null,
"last_read_announcements_at": "2021-05-25 05:59:42",
"created_at": "2020-12-02T11:14:24.000000Z",
"updated_at": "2021-10-22T13:46:40.000000Z",
"reports_to": null,
"legacy_id": null,
"comment_credit_value": "0.00",
"deleted_at": null,
"exchange_server": "mail.centralroofing.com",
"exchange_username": "efollowup",
"exchange_password": "New2021!#%",
"stack_partner_response_code": null,
"company_cam_partner_response_code": null,
"company_cam_user_id": 2657438,
"signature": null,
"pivot": {
"project_id": 1,
"user_id": 1,
"start_date": "2021-04-09 00:00:00",
"end_date": "2021-04-09 00:00:00"
}
}
]
}
{
"project": {
"id": 495,
"legacy_id": null,
"sequential_team_id": null,
"name": "Abdiel Roberts",
"address": "3967 Marvin Summit Apt. 988",
"city": "East Shirleyview",
"state": "Utah",
"zip": "23048",
"contact": {
"id": 495,
"team_id": 1,
"project_id": 495,
"name": "Prof. Haley Shanahan DDS",
"phone": "(141) 756-9274 ext. 4936",
"fax": "(154) 376-2179 ext. 1",
"cell": "(408) 898-3088 ext. 3925",
"email": "christelle47@hotmail.com",
"created_at": "2020-12-02T11:37:14.000000Z",
"updated_at": "2020-12-10T13:00:47.000000Z",
"deleted_at": null
},
"account_manager": "sohaib",
"estimator": null,
"company_name": null,
"sales_status": "SHOT",
"contract_amount": "8.33",
"base_bid": "1.35",
"bid_id": null,
"contract_date": "06/15/2020",
"bid_date": "04/05/2020",
"pre_qualified": true,
"last_update": "08/17/2021",
"contract_type": ".",
"office": "Onsite",
"login_date": "12/15/2020",
"superintendent": null,
"project_manager": null,
"project_admin": null,
"crew_leader": [
{
"id": 1,
"uuid": "7025f374-0f75-4214-aae1-7aca18a39e72",
"name": "DevSquad",
"email": "team@devsquad.com",
"email_verified_at": "2020-12-02 11:14:24",
"include_in_company_report": 1,
"follow_up": 1,
"google_id": null,
"microsoft_id": null,
"photo_url": "https://www.gravatar.com/avatar/1c72fb117ca95a102e0ce13ba5aca793.jpg?s=200&d=mm",
"uses_two_factor_auth": false,
"external_email": null,
"external_email_added_in": null,
"last_selected_timezone": "America/New_York",
"two_factor_reset_code": null,
"current_team_id": 1,
"user_type": "sales",
"stripe_id": null,
"current_billing_plan": null,
"billing_state": null,
"vat_id": null,
"trial_ends_at": null,
"last_read_announcements_at": "2021-05-25 05:59:42",
"created_at": "2020-12-02T11:14:24.000000Z",
"updated_at": "2021-10-22T13:46:40.000000Z",
"reports_to": null,
"legacy_id": null,
"comment_credit_value": "0.00",
"deleted_at": null,
"exchange_server": "mail.centralroofing.com",
"exchange_username": "efollowup",
"exchange_password": "New2021!#%",
"stack_partner_response_code": null,
"company_cam_partner_response_code": null,
"company_cam_user_id": 2657438,
"signature": null,
"pivot": {
"project_id": 1,
"user_id": 1,
"start_date": "2021-04-09 00:00:00",
"end_date": "2021-04-09 00:00:00"
}
}
],
"project_engineer": null,
"project_stage": {
"id": 4,
"team_id": 1,
"code": "Stage4",
"full_description": "Completed",
"short_description": "Completed",
"load_order": 4,
"locked": 1,
"created_at": "2020-12-02T11:17:41.000000Z",
"updated_at": "2020-12-02T11:17:41.000000Z",
"deleted_at": null,
"legacy_id": null
},
"project_duration": {
"id": 1,
"team_id": 1,
"code": "Small",
"full_description": "Small Job",
"short_description": "Small Job",
"load_order": 1,
"locked": 1,
"created_at": "2020-12-02T11:17:41.000000Z",
"updated_at": "2020-12-02T11:17:41.000000Z",
"deleted_at": null,
"legacy_id": null
},
"complete_date": "12/22/2020",
"actual_completed_date": "06/30/2020",
"pm_contract_date": "06/15/2020",
"office_name": null,
"contract_type_name": null
}
}
/api/v1/file-data/{id}
Key | Description | Default |
---|---|---|
api_token string | REQUIRED |
The API token generated throught UI interface on Followup CRM platform. | None |
id string |
** |
Key | Type | Required |
---|---|---|
name | string | REQUIRED |
contact_name | string | REQUIRED |
address | string | NULLABLE |
city | string | NULLABLE |
state | string | NULLABLE |
zip | string | NULLABLE |
contact_name | string | NULLABLE |
contact_email | string | NULLABLE |
contact_phone | string | NULLABLE |
contact_cell | string | NULLABLE |
contact_fax | string | NULLABLE |
pm_contract_date | date | NULLABLE |
actual_completed_date | date | NULLABLE |
complete_date | date | NULLABLE |
crew_leaders | array | NULLABLE |
/api/v1/pm-file-data/{id}?api_token=YOUR_API_TOKEN
{
"name": "Abdiel Roberts",
"address": "3967 Marvin Summit Apt. 988",
"city": "East Shirleyview",
"state": "Utah",
"zip": "23048",
"contact_name":"Prof. Haley Shanahan DDS",
"contact_phone": "(141) 756-9274 ext. 4936",
"contact_fax": "(154) 376-2179 ext. 1",
"contact_cell": "(408) 898-3088 ext. 3925",
"contact_email": "christelle47@hotmail.com",
"complete_date": "12/22/2020",
"actual_completed_date": "06/30/2020",
"pm_contract_date": "06/15/2020",
"crew_leader": [
{
"id": 1,
"uuid": "7025f374-0f75-4214-aae1-7aca18a39e72",
"name": "DevSquad",
"email": "team@devsquad.com",
"email_verified_at": "2020-12-02 11:14:24",
"include_in_company_report": 1,
"follow_up": 1,
"google_id": null,
"microsoft_id": null,
"photo_url": "https://www.gravatar.com/avatar/1c72fb117ca95a102e0ce13ba5aca793.jpg?s=200&d=mm",
"uses_two_factor_auth": false,
"external_email": null,
"external_email_added_in": null,
"last_selected_timezone": "America/New_York",
"two_factor_reset_code": null,
"current_team_id": 1,
"user_type": "sales",
"stripe_id": null,
"current_billing_plan": null,
"billing_state": null,
"vat_id": null,
"trial_ends_at": null,
"last_read_announcements_at": "2021-05-25 05:59:42",
"created_at": "2020-12-02T11:14:24.000000Z",
"updated_at": "2021-10-22T13:46:40.000000Z",
"reports_to": null,
"legacy_id": null,
"comment_credit_value": "0.00",
"deleted_at": null,
"exchange_server": "mail.centralroofing.com",
"exchange_username": "efollowup",
"exchange_password": "New2021!#%",
"stack_partner_response_code": null,
"company_cam_partner_response_code": null,
"company_cam_user_id": 2657438,
"signature": null,
"pivot": {
"project_id": 1,
"user_id": 1,
"start_date": "2021-04-09 00:00:00",
"end_date": "2021-04-09 00:00:00"
}
}
]
}
{
"project": {
"id": 495,
"legacy_id": null,
"sequential_team_id": null,
"name": "Abdiel Roberts",
"address": "3967 Marvin Summit Apt. 988",
"city": "East Shirleyview",
"state": "Utah",
"zip": "23048",
"contact": {
"id": 495,
"team_id": 1,
"project_id": 495,
"name": "Prof. Haley Shanahan DDS",
"phone": "(141) 756-9274 ext. 4936",
"fax": "(154) 376-2179 ext. 1",
"cell": "(408) 898-3088 ext. 3925",
"email": "christelle47@hotmail.com",
"created_at": "2020-12-02T11:37:14.000000Z",
"updated_at": "2020-12-10T13:00:47.000000Z",
"deleted_at": null
},
"account_manager": "sohaib",
"estimator": null,
"company_name": null,
"sales_status": "SHOT",
"contract_amount": "8.33",
"base_bid": "1.35",
"bid_id": null,
"contract_date": "06/15/2020",
"bid_date": "04/05/2020",
"pre_qualified": true,
"last_update": "08/17/2021",
"contract_type": ".",
"office": "Onsite",
"login_date": "12/15/2020",
"superintendent": null,
"project_manager": null,
"project_admin": null,
"crew_leader": [
{
"id": 1,
"uuid": "7025f374-0f75-4214-aae1-7aca18a39e72",
"name": "DevSquad",
"email": "team@devsquad.com",
"email_verified_at": "2020-12-02 11:14:24",
"include_in_company_report": 1,
"follow_up": 1,
"google_id": null,
"microsoft_id": null,
"photo_url": "https://www.gravatar.com/avatar/1c72fb117ca95a102e0ce13ba5aca793.jpg?s=200&d=mm",
"uses_two_factor_auth": false,
"external_email": null,
"external_email_added_in": null,
"last_selected_timezone": "America/New_York",
"two_factor_reset_code": null,
"current_team_id": 1,
"user_type": "sales",
"stripe_id": null,
"current_billing_plan": null,
"billing_state": null,
"vat_id": null,
"trial_ends_at": null,
"last_read_announcements_at": "2021-05-25 05:59:42",
"created_at": "2020-12-02T11:14:24.000000Z",
"updated_at": "2021-10-22T13:46:40.000000Z",
"reports_to": null,
"legacy_id": null,
"comment_credit_value": "0.00",
"deleted_at": null,
"exchange_server": "mail.centralroofing.com",
"exchange_username": "efollowup",
"exchange_password": "New2021!#%",
"stack_partner_response_code": null,
"company_cam_partner_response_code": null,
"company_cam_user_id": 2657438,
"signature": null,
"pivot": {
"project_id": 1,
"user_id": 1,
"start_date": "2021-04-09 00:00:00",
"end_date": "2021-04-09 00:00:00"
}
}
],
"project_engineer": null,
"project_stage": {
"id": 4,
"team_id": 1,
"code": "Stage4",
"full_description": "Completed",
"short_description": "Completed",
"load_order": 4,
"locked": 1,
"created_at": "2020-12-02T11:17:41.000000Z",
"updated_at": "2020-12-02T11:17:41.000000Z",
"deleted_at": null,
"legacy_id": null
},
"project_duration": {
"id": 1,
"team_id": 1,
"code": "Small",
"full_description": "Small Job",
"short_description": "Small Job",
"load_order": 1,
"locked": 1,
"created_at": "2020-12-02T11:17:41.000000Z",
"updated_at": "2020-12-02T11:17:41.000000Z",
"deleted_at": null,
"legacy_id": null
},
"complete_date": "12/22/2020",
"actual_completed_date": "06/30/2020",
"pm_contract_date": "06/15/2020",
"office_name": null,
"contract_type_name": null
}
}
/api/v1/pm-file-data/custom-fields
Key | Description | Default |
---|---|---|
api_token string | REQUIRED |
The API token generated through UI interface on Followup CRM platform. | None |
Key | Type | Required |
---|---|---|
dynamic_custom_field_id | string | REQUIRED |
project_id | integer | REQUIRED |
/api/v1/pm-file-data/custom-fields?api_token=YOUR_API_TOKEN
{
"1": "",
"2": "",
"3": "",
"5": "test value 1",
"6": "test value 2",
"7": "test value 3",
"8": "test value 4",
"4": "",
"project_id": 2304
}
{
"success": true,
"message": "Custom fields saved successfully."
}