This page is about an old version of Active Collab that's not developed anymore.
Click here to open the documentation for the latest version.

System Information

This chapter lists all the commands that retrieve activeCollab's system information.

info #

The above request returns the system information about the installation that you are working with. This information includes the system version, the users that are currently logged in, the API mode, etc.

Method: GET

By using this request, you can get the following information:

  • api_version - The version of the activeCollab API.
  • system_version - The version of activeCollab that you are communicating with.
  • loaded_frameworks - The loaded activeCollab frameworks.
  • enabled_modules - The modules enabled in this activeCollab setup.
  • logged_user - The URL of the users currently logged in.
  • read_only - The value is set to 1 if the API is in read only mode, or 0 if it supports both read and write requests.

Example response:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
<info>
  <api_version>
    <![CDATA[3.0.0]]>
  </api_version>
  <system_version>
    <![CDATA[3.1.8]]>
  </system_version>
  <logged_user>
    <id>1</id>
    <name>
      <![CDATA[msvsbc]]>
    </name>
       ...
    <company_id>1</company_id>
    <role_id>1</role_id>
  </logged_user>
  <read_only>0</read_only>
  <loaded_frameworks> ... </loaded_frameworks>
  <enabled_modules> ... </enabled_modules>
  <max_upload_size> ... </max_upload_size>
</info>

info/days-off #

This request returns a list of days off.

Compatibility Note

These API commands were introduced in activeCollab 3.3.12 and are not available in older releases.

Method: GET

Example response:

1
2
3
4
5
6
7
8
<day_offs>
  <day_off>
    <name><![CDATA[Christmas]]></name>
    <date><![CDATA[2000-12-25]]></date>
    <repeat_yearly>1</repeat_yearly>
  </day_off>
  ...
</day_offs>

info/currencies #

This request returns a list of defined Currencies in activeCollab.

Compatibility Note

These API commands were introduced in activeCollab 3.3.19 and are not available in older releases.

Method: GET

Example response:

1
2
3
4
5
6
7
8
9
10
11
<currencies>
  <currency>
    <id>2</id>
    <name><![CDATA[US Dollar]]></name>
    <code><![CDATA[USD]]></code>
    <decimal_spaces>2</decimal_spaces>
    <decimal_rounding>0</decimal_rounding>
    <is_default>1</is_default>
  </currency>
  ...
</currencies>

info/labels/project #

This request lists all available Project Labels in the system.

Method: GET

Example response:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
<labels>
  <label>
    <id>1</id>
    <name>
      <![CDATA[CANCELED]]>
    </name>
    <fg_color>
      <![CDATA[#FFFFFF]]>
    </fg_color>
    <bg_color>
      <![CDATA[#FF0000]]>
    </bg_color>
  </label>
  ...
</labels>

info/labels/assignment #

This request lists all available Assignment Labels. These labels are used by Tasks and Subtasks.

Method: GET

Example response:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
<labels>
  <label>
    <id>6</id>
    <name>
      <![CDATA[ASSIGNED]]>
    </name>
    <fg_color>
      <![CDATA[#FFFFFF]]>
    </fg_color>
    <bg_color>
      <![CDATA[#FF0000]]>
    </bg_color>
  </label>
   ...
</labels>

info/roles #

This request lists all System Roles and role details (with permissions included).

Method: GET

Example response:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
<roles>
  <role>
    <id>7</id>
    <name>
      <![CDATA[Administrator]]>
    </name>
    ...
  </role>
  <role>
    <id>1</id>
    <name>
      <![CDATA[Administrator (+ Finances)]]>
    </name>
     ...
  <role>
    <id>6</id>
    <name>
      <![CDATA[Client Company Employee]]>
    </name>
     ...
  </role>
   ...
</roles>

info/roles/project #

This request lists all Project Roles and displays their permissions.

Method: GET

Example response:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
<roles>
<role>
    <id>2</id>
    <name>
      <![CDATA[role 1]]>
    </name>
    ...
  </role>
<role>
    <id>1</id>
    <name>
      <![CDATA[test role]]>
    </name>
    ...
  </role>
</roles>

info/job-types #

This request lists all specified Job Types and their Hourly Rates set in activeCollab.

Method: GET

Example response:

1
2
3
4
5
6
7
8
9
<job_types>
  <job_type>
    <id>1</id>
    <name><![CDATA[Programming]]></name>
    <default_hourly_rate>100</default_hourly_rate>
    <is_default>1</is_default>
  </job_type>
  ...
</job_types>

info/expense-categories #

This request lists all defined Expense Categories.

Method: GET

Compatibility Note

This API command was introduced in activeCollab 3.2.13 and is not available in older releases

Example response:

1
2
3
4
5
6
7
8
<expense_categories>
  <expense_category>
    <id>1</id>
    <name><![CDATA[General]]></name>
    <is_default>1</is_default>
  </expense_category>
  ...
</expense_categories>
« Prev
Back to the Top
Next »