Configuration

List projects belonging to the company identified by the Authorization API key. Returns active and disabled projects by default. Use onlyActive=1 to return only active projects. Find the desired project by name in data and pass its complete object as project when saving a sales invoice; tagId is the project identifier. No companyId parameter is needed.

get/company/projects

Request

  • Base URL
    https://api.altera.co
  • URL
    https://api.altera.co/company/projects
  • Auth
    API key in header Authorization

Query parameters

onlyActive0 | 1

Set to 1 to return only active projects. Omit or set to 0 to include disabled projects.

Response

Company projects. data is an empty array when no projects match.

result'OK' required

Example response

{
  "data": [
    {
      "tagId": 1,
      "name": "Marketing",
      "enabled": false,
      "color": 4286963618
    }
  ]
}

Changes