Projects

• Return a single project

  GET /api/1/projects/:uuid.json

  Formats

  json jsonp

  Returns a single project object belonging the authenticated user.

  Errors

  • 401 Unauthorized
  • 403 Read Denied - if the user is not allowed to read this project
  • 404 Record Not Found - returned if the company with the specified UUID is not found
  • 404 Record Not Found - returned if the project with the specified UUID is not found

  Example

  GET /api/1/projects/c4480ba3-bb9b-4cc5-88e6-90ea18e558eb
  200
  {
    "response": {
      "active": "true",
      "company_uuid": "3e326ff3-f1f1-4ba7-96cf-b887c1446cb5",
      "default_tags": null,
      "hourly_rate": null,
      "hourly_rate_cents": null,
      "name": "voluptatem dolor",
      "notes": null,
      "time_limit": null,
      "time_limit_string": null,
      "uuid": "c4480ba3-bb9b-4cc5-88e6-90ea18e558eb",
      "visibility": "private",
      "activities": [
        {
          "name": "distinctio placeat",
          "project_uuid": "c4480ba3-bb9b-4cc5-88e6-90ea18e558eb",
          "uuid": "10863ba2-858b-488a-9db2-a8437493d951"
        },
        {
          "name": "rerum ratione",
          "project_uuid": "c4480ba3-bb9b-4cc5-88e6-90ea18e558eb",
          "uuid": "2a41355c-1ccf-4260-a13e-03c42c114e9a"
        }
      ],
      "grand_total": 0
    }
  }

  Return a single project belonging to a company

  GET /api/1/companies/:company_iiid/projects/:uuid.json

  Formats

  json jsonp

  Returns a single project object belonging the authenticated user.

  Errors

  • 401 Unauthorized
  • 403 Read Denied - if the user is not allowed to read this project
  • 404 Record Not Found - returned if the company with the specified UUID is not found
  • 404 Record Not Found - returned if the project with the specified UUID is not found

  Example

  GET /api/1/projects/c4480ba3-bb9b-4cc5-88e6-90ea18e558eb
  200
  {
    "response": {
      "active": "true",
      "company_uuid": "3e326ff3-f1f1-4ba7-96cf-b887c1446cb5",
      "default_tags": null,
      "hourly_rate": null,
      "hourly_rate_cents": null,
      "name": "voluptatem dolor",
      "notes": null,
      "time_limit": null,
      "time_limit_string": null,
      "uuid": "c4480ba3-bb9b-4cc5-88e6-90ea18e558eb",
      "visibility": "private",
      "activities": [
        {
          "name": "distinctio placeat",
          "project_uuid": "c4480ba3-bb9b-4cc5-88e6-90ea18e558eb",
          "uuid": "10863ba2-858b-488a-9db2-a8437493d951"
        },
        {
          "name": "rerum ratione",
          "project_uuid": "c4480ba3-bb9b-4cc5-88e6-90ea18e558eb",
          "uuid": "2a41355c-1ccf-4260-a13e-03c42c114e9a"
        }
      ],
      "grand_total": 0
    }
  }