API: Projects

The project object

Attributes

id: integer

The projects's unique id.

client_id: integer

The id of the client this project belongs to.

name: string

The project's name.

Example response

{
  "project": {
    "id": 321,
    "client_id": 1234,
    "name": "Website Build"
  }
}

---

List all projects

Returns a list of all of your account's projects.

Arguments
(none)

Returns
An array of project objects.

Definition

GET /v1/projects

Fetch a project

Retrieves the details of an existing project.

Arguments
(none)

Returns
A project object, if a valid id was provided.

Definition

GET /v1/projects/{PROJECT_ID}

Create a new project

Arguments

client_id: integer (required)

The identifier of the client to associate with the project being created.

name: string (required)

The name of the project.

completed: boolean (optional)

Whether the project has been completed or not.

Returns
The newly created project object, if valid parameters were provided.

Definition

POST /v1/projects

Updates an existing project

Arguments
(none)

name: string (optional)

The name of the project.

completed: boolean (optional)

Whether the project has been completed or not.

Returns
The updated project object, if valid parameters were provided.

Definition

PUT /v1/projects/{PROJECT_ID}

Delete an existing project

Deletes an existing project, and all jobs, expenses, and time logs associated with it.

Arguments
(none)

Returns
The removed project.

Definition

DELETE /v1/projects/{PROJECT_ID}