Back to index

FOREST CRM - CSV Company API

This API provides the following services:

• List companies

List companies

Request

The request format is:

https://app.forestcrm.hu/api/csv/<API KEY>/companies

Request HTTP method: GET

Request parameters:

id (optional):

exact internal id of the company to be returned. Only exact matches are returned. Takes precedence over all other parameters.

external_ref

If present (with any value or without value), `id` is interpreted as an external reference ("external id").

query (optional):

string to query in company data (name, address, description). Partial matches are also returned. Search is case insensitiv`e. query string may be but does not have to be surrounded by either single or double quotation marks.

withOpportunity (optional):

return companies with opportunities only.

withContract (optional):

return companies with contracts only.

If no parameters are supplied, all companies for the tenant are returned.

Example

GET https://app.forestcrm.hu/api/csv/demo/companies?query=Corp

GET https://app.forestcrm.hu/api/csv/demo/companies?id=A1231&external_ref

Response

Response has the following columns:

1. company_id
2. status
3. Salesrep
4. Name
5. Description
6. Homepage
7. Tax number
8. Address street
9. Address city
10. Address zip
11. Address country
12. Geocoding Status
13. Latitude
14. Longitude
15. isArchived
16. forest_email
17. Created at
18. Created by
19. Updated at
20. Updated by
21. External ref

Notes:

• address_country_code elements contain ISO 3166 two-letter coutry codes

Example

Back to index