The Project 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.

project_type string required
description string
The Project Type object 
{
  "id": "project-type_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "project_type": "project_type_example",
  "description": "description_example"
}
GET /api/projects/project-type/{id}

Retrieve a project type

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

Path parameters

id string required

The identifier of the project type to retrieve.

Returns

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

GET /api/projects/project-type/{id} 
curl https://api.overplane.dev/api/projects/project-type/project-type_abc123 \
  -H "Authorization: Bearer sk_test_..."
Response 
{
  "id": "project-type_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "project_type": "project_type_example",
  "description": "description_example"
}
GET /api/projects/project-type

List all project types

Returns a list of project 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 project type objects.

GET /api/projects/project-type 
curl https://api.overplane.dev/api/projects/project-type \
  -H "Authorization: Bearer sk_test_..."
Response 
{
  "data": [
    {
      "id": "project-type_abc123",
      "created_at": "2024-01-15T09: 30: 00Z",
      "updated_at": "2024-01-15T09: 30: 00Z",
      "project_type": "project_type_example",
      "description": "description_example"
    }
  ],
  "has_more": false,
  "total": 1
}
POST /api/projects/project-type

Create a project type

Creates a new project type object.

Body parameters

project_type string required
description string

Returns

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

POST /api/projects/project-type 
curl https://api.overplane.dev/api/projects/project-type \
  -H "Authorization: Bearer sk_test_..." \
  -X POST \
  -H "Content-Type: application/json" \
  -d '{"project_type":"project_type_example"}'
Response 
{
  "id": "project-type_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "project_type": "project_type_example",
  "description": "description_example"
}
PATCH /api/projects/project-type/{id}

Update a project type

Updates the specified project 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 project type to update.

Body parameters

project_type string
description string

Returns

Returns the updated project type object.

PATCH /api/projects/project-type/{id} 
curl https://api.overplane.dev/api/projects/project-type/project-type_abc123 \
  -H "Authorization: Bearer sk_test_..." \
  -X PATCH \
  -H "Content-Type: application/json" \
  -d '{"project_type":"project_type_example","description":"description_example"}'
Response 
{
  "id": "project-type_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "project_type": "project_type_example",
  "description": "description_example"
}
DELETE /api/projects/project-type/{id}

Delete a project type

Permanently deletes a project type. This cannot be undone.

Path parameters

id string required

The identifier of the project type to delete.

Returns

Returns a confirmation that the project type has been deleted.

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