The Issue Priority 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.

description string
The Issue Priority object 
{
  "id": "issue-priority_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "description": "description_example"
}
GET /api/support/issue-priority/{id}

Retrieve a issue priority

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

Path parameters

id string required

The identifier of the issue priority to retrieve.

Returns

Returns the issue priority object if a valid identifier was provided.

GET /api/support/issue-priority/{id} 
curl https://api.overplane.dev/api/support/issue-priority/issue-priority_abc123 \
  -H "Authorization: Bearer sk_test_..."
Response 
{
  "id": "issue-priority_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "description": "description_example"
}
GET /api/support/issue-priority

List all issue prioritys

Returns a list of issue prioritys. 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 issue priority objects.

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

Create a issue priority

Creates a new issue priority object.

Body parameters

description string

Returns

Returns the newly created issue priority object if the call succeeded.

POST /api/support/issue-priority 
curl https://api.overplane.dev/api/support/issue-priority \
  -H "Authorization: Bearer sk_test_..." \
  -X POST \
  -H "Content-Type: application/json"
Response 
{
  "id": "issue-priority_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "description": "description_example"
}
PATCH /api/support/issue-priority/{id}

Update a issue priority

Updates the specified issue priority 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 issue priority to update.

Body parameters

description string

Returns

Returns the updated issue priority object.

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

Delete a issue priority

Permanently deletes a issue priority. This cannot be undone.

Path parameters

id string required

The identifier of the issue priority to delete.

Returns

Returns a confirmation that the issue priority has been deleted.

DELETE /api/support/issue-priority/{id} 
curl https://api.overplane.dev/api/support/issue-priority/issue-priority_abc123 \
  -H "Authorization: Bearer sk_test_..." \
  -X DELETE
Response 
{
  "id": "issue-priority_abc123",
  "deleted": true
}