The Activity Type object

Attributes

id string

Unique identifier for the object.

created_at string

ISO 8601 timestamp of when the object was created.

updated_at string

ISO 8601 timestamp of when the object was last updated.

activity_type string required
costing_rate number
billing_rate number
disabled boolean

Default: false

The Activity Type object 
{
  "id": "activity-type_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "activity_type": "activity_type_example",
  "costing_rate": 0,
  "billing_rate": 0,
  "disabled": false
}
GET /api/projects/activity-type/{id}

Retrieve a activity type

Retrieves the details of an existing activity type. Supply the unique activity type ID that was returned from a previous request.

Path parameters

id string required

The identifier of the activity type to retrieve.

Returns

Returns the activity type object if a valid identifier was provided.

GET /api/projects/activity-type/{id} 
curl https://api.overplane.dev/api/projects/activity-type/activity-type_abc123 \
  -H "Authorization: Bearer sk_test_..."
Response 
{
  "id": "activity-type_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "activity_type": "activity_type_example",
  "costing_rate": 0,
  "billing_rate": 0,
  "disabled": false
}
GET /api/projects/activity-type

List all activity types

Returns a list of activity types. The results are sorted by creation date, with the most recently created appearing first.

Query parameters

limit integer

Maximum number of objects to return. Default: 20.

offset integer

Number of objects to skip for pagination. Default: 0.

Returns

A paginated list of activity type objects.

GET /api/projects/activity-type 
curl https://api.overplane.dev/api/projects/activity-type \
  -H "Authorization: Bearer sk_test_..."
Response 
{
  "data": [
    {
      "id": "activity-type_abc123",
      "created_at": "2024-01-15T09: 30: 00Z",
      "updated_at": "2024-01-15T09: 30: 00Z",
      "activity_type": "activity_type_example",
      "costing_rate": 0,
      "billing_rate": 0,
      "disabled": false
    }
  ],
  "has_more": false,
  "total": 1
}
POST /api/projects/activity-type

Create a activity type

Creates a new activity type object.

Body parameters

activity_type string required
costing_rate number
billing_rate number
disabled boolean

Default: false

Returns

Returns the newly created activity type object if the call succeeded.

POST /api/projects/activity-type 
curl https://api.overplane.dev/api/projects/activity-type \
  -H "Authorization: Bearer sk_test_..." \
  -X POST \
  -H "Content-Type: application/json" \
  -d '{"activity_type":"activity_type_example"}'
Response 
{
  "id": "activity-type_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "activity_type": "activity_type_example",
  "costing_rate": 0,
  "billing_rate": 0,
  "disabled": false
}
PATCH /api/projects/activity-type/{id}

Update a activity type

Updates the specified activity type by setting the values of the parameters passed. Any parameters not provided will be left unchanged.

Path parameters

id string required

The identifier of the activity type to update.

Body parameters

activity_type string
costing_rate number
billing_rate number
disabled boolean

Default: false

Returns

Returns the updated activity type object.

PATCH /api/projects/activity-type/{id} 
curl https://api.overplane.dev/api/projects/activity-type/activity-type_abc123 \
  -H "Authorization: Bearer sk_test_..." \
  -X PATCH \
  -H "Content-Type: application/json" \
  -d '{"activity_type":"activity_type_example","costing_rate":0}'
Response 
{
  "id": "activity-type_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "activity_type": "activity_type_example",
  "costing_rate": 0,
  "billing_rate": 0,
  "disabled": false
}
DELETE /api/projects/activity-type/{id}

Delete a activity type

Permanently deletes a activity type. This cannot be undone.

Path parameters

id string required

The identifier of the activity type to delete.

Returns

Returns a confirmation that the activity type has been deleted.

DELETE /api/projects/activity-type/{id} 
curl https://api.overplane.dev/api/projects/activity-type/activity-type_abc123 \
  -H "Authorization: Bearer sk_test_..." \
  -X DELETE
Response 
{
  "id": "activity-type_abc123",
  "deleted": true
}