Back to index

FOREST CRM - XML Category API

This API provides access to user data in the ForestCRM system.

Request

The request format is:

https://app.forestcrm.hu/api/xml/<API KEY>/categories

Request parameters:

type (optional):

either company or contact or opportunity or project role. Only matching categories are returned.

id (optional):

exact internal id of the category to be returned. Only exact matches are returned. Takes precedence over type.

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

Example

https://app.forestcrm.hu/api/xml/demo/categories

Response

Response conforms the attached XSD.

Example

<categories>
  <category id="713">
    <updated>2010-12-29T00:00:00+01:00</updated>
    <name>VIP</name>
    <type>contact</type>
  </category>
  <category id="74513">
    <updated>2010-12-30T14:35:20+01:00</updated>
    <name>Size: 10-50</name>
    <type>company</type>
  </category>
</categories>

Back to index