Start a timer on a project

POST

/api/v1/time-entries/start

curl --request POST \
  --url https://api.pitch2sale.com/api/v1/time-entries/start \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "project_id": "example", "task_id": "example", "description": "example", "is_billable": true }'

Fails if you already have a running timer.

Authorizations

• bearerJwt
• personalAccessToken
• oauthAccessToken

Request Body^required

Media typeapplication/json

object

project_id

required

string

/^[0-9a-fA-F]{24}$/

task_id

Any of:

string

string

/^[0-9a-fA-F]{24}$/

null

null

description

Any of:

string

string

<= 2000 characters

null

null

is_billable

boolean

Example^generated

{
  "project_id": "example",
  "task_id": "example",
  "description": "example",
  "is_billable": true
}

Responses

201

The running entry

Media typeapplication/json

object

time_entry

required

object

_id

required

string

key

additional properties

any

Example^generated

{
  "time_entry": {
    "_id": "example"
  }
}

400

Validation failed

Media typeapplication/json

object

error

required

string

code

string

message

string

details

Array<object>

object

field

required

string

message

required

string

code

required

string

Example^generated

{
  "error": "example",
  "code": "example",
  "message": "example",
  "details": [
    {
      "field": "example",
      "message": "example",
      "code": "example"
    }
  ]
}

401

Authentication required or token invalid

Media typeapplication/json

object

error

required

string

code

string

message

string

details

Array<object>

object

field

required

string

message

required

string

code

required

string

Example^generated

{
  "error": "example",
  "code": "example",
  "message": "example",
  "details": [
    {
      "field": "example",
      "message": "example",
      "code": "example"
    }
  ]
}

403

Role permission or token scope missing

Media typeapplication/json

object

error

required

string

code

string

message

string

details

Array<object>

object

field

required

string

message

required

string

code

required

string

Example^generated

{
  "error": "example",
  "code": "example",
  "message": "example",
  "details": [
    {
      "field": "example",
      "message": "example",
      "code": "example"
    }
  ]
}

429

Rate limit exceeded

Media typeapplication/json

object

error

required

string

code

string

message

string

details

Array<object>

object

field

required

string

message

required

string

code

required

string

Example^generated

{
  "error": "example",
  "code": "example",
  "message": "example",
  "details": [
    {
      "field": "example",
      "message": "example",
      "code": "example"
    }
  ]
}