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

subject string required
customer string
raised_by string
status string

Default: Open

priority string
issue_type string
description string
service_level_agreement string
response_by string
first_responded_on string
lead string
contact string
email_account string
customer_name string
project string
company string
resolution_details string
opening_date string
opening_time string
content_type string
attachment string
via_customer_portal boolean

Default: false

service_level_agreement_creation string
issue_split_from string
avg_response_time integer
resolution_time integer
user_resolution_time integer
on_hold_since string
total_hold_time integer
agreement_status string

Default: First Response Due

first_response_time integer
sla_resolution_by string
sla_resolution_date string
The Issue object 
{
  "id": "issue_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "subject": "subject_example",
  "customer": "customer_example",
  "raised_by": "raised_by_example",
  "status": "Open",
  "priority": "priority_example",
  "issue_type": "issue_type_example",
  "description": "description_example",
  "service_level_agreement": "service_level_agreement_example",
  "response_by": "response_by_example",
  "first_responded_on": "first_responded_on_example",
  "lead": "lead_example",
  "contact": "contact_example",
  "email_account": "user@example.com",
  "customer_name": "customer_name_example",
  "project": "project_example",
  "company": "Example Corp",
  "resolution_details": "resolution_details_example",
  "opening_date": "2024-01-15",
  "opening_time": "opening_time_example",
  "content_type": "content_type_example",
  "attachment": "attachment_example",
  "via_customer_portal": false,
  "service_level_agreement_creation": "service_level_agreement_creation_example",
  "issue_split_from": "issue_split_from_example",
  "avg_response_time": 0,
  "resolution_time": 0,
  "user_resolution_time": 0,
  "on_hold_since": "on_hold_since_example",
  "total_hold_time": 0,
  "agreement_status": "First Response Due",
  "first_response_time": 0,
  "sla_resolution_by": "sla_resolution_by_example",
  "sla_resolution_date": "2024-01-15"
}
GET /api/support/issue/{id}

Retrieve a issue

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

Path parameters

id string required

The identifier of the issue to retrieve.

Returns

Returns the issue object if a valid identifier was provided.

GET /api/support/issue/{id} 
curl https://api.overplane.dev/api/support/issue/issue_abc123 \
  -H "Authorization: Bearer sk_test_..."
Response 
{
  "id": "issue_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "subject": "subject_example",
  "customer": "customer_example",
  "raised_by": "raised_by_example",
  "status": "Open",
  "priority": "priority_example",
  "issue_type": "issue_type_example",
  "description": "description_example",
  "service_level_agreement": "service_level_agreement_example",
  "response_by": "response_by_example",
  "first_responded_on": "first_responded_on_example",
  "lead": "lead_example",
  "contact": "contact_example",
  "email_account": "user@example.com",
  "customer_name": "customer_name_example",
  "project": "project_example",
  "company": "Example Corp",
  "resolution_details": "resolution_details_example",
  "opening_date": "2024-01-15",
  "opening_time": "opening_time_example",
  "content_type": "content_type_example",
  "attachment": "attachment_example",
  "via_customer_portal": false,
  "service_level_agreement_creation": "service_level_agreement_creation_example",
  "issue_split_from": "issue_split_from_example",
  "avg_response_time": 0,
  "resolution_time": 0,
  "user_resolution_time": 0,
  "on_hold_since": "on_hold_since_example",
  "total_hold_time": 0,
  "agreement_status": "First Response Due",
  "first_response_time": 0,
  "sla_resolution_by": "sla_resolution_by_example",
  "sla_resolution_date": "2024-01-15"
}
GET /api/support/issue

List all issues

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

GET /api/support/issue 
curl https://api.overplane.dev/api/support/issue \
  -H "Authorization: Bearer sk_test_..."
Response 
{
  "data": [
    {
      "id": "issue_abc123",
      "created_at": "2024-01-15T09: 30: 00Z",
      "updated_at": "2024-01-15T09: 30: 00Z",
      "subject": "subject_example",
      "customer": "customer_example",
      "raised_by": "raised_by_example",
      "status": "Open",
      "priority": "priority_example",
      "issue_type": "issue_type_example",
      "description": "description_example",
      "service_level_agreement": "service_level_agreement_example",
      "response_by": "response_by_example",
      "first_responded_on": "first_responded_on_example",
      "lead": "lead_example",
      "contact": "contact_example",
      "email_account": "user@example.com",
      "customer_name": "customer_name_example",
      "project": "project_example",
      "company": "Example Corp",
      "resolution_details": "resolution_details_example",
      "opening_date": "2024-01-15",
      "opening_time": "opening_time_example",
      "content_type": "content_type_example",
      "attachment": "attachment_example",
      "via_customer_portal": false,
      "service_level_agreement_creation": "service_level_agreement_creation_example",
      "issue_split_from": "issue_split_from_example",
      "avg_response_time": 0,
      "resolution_time": 0,
      "user_resolution_time": 0,
      "on_hold_since": "on_hold_since_example",
      "total_hold_time": 0,
      "agreement_status": "First Response Due",
      "first_response_time": 0,
      "sla_resolution_by": "sla_resolution_by_example",
      "sla_resolution_date": "2024-01-15"
    }
  ],
  "has_more": false,
  "total": 1
}
POST /api/support/issue

Create a issue

Creates a new issue object.

Body parameters

subject string required
customer string
raised_by string
status string

Default: Open

priority string
issue_type string
description string
service_level_agreement string
response_by string
first_responded_on string
lead string
contact string
email_account string
customer_name string
project string
company string
resolution_details string
opening_date string
opening_time string
content_type string
attachment string
via_customer_portal boolean

Default: false

service_level_agreement_creation string
issue_split_from string
avg_response_time integer
resolution_time integer
user_resolution_time integer
on_hold_since string
total_hold_time integer
agreement_status string

Default: First Response Due

first_response_time integer
sla_resolution_by string
sla_resolution_date string

Returns

Returns the newly created issue object if the call succeeded.

POST /api/support/issue 
curl https://api.overplane.dev/api/support/issue \
  -H "Authorization: Bearer sk_test_..." \
  -X POST \
  -H "Content-Type: application/json" \
  -d '{"subject":"subject_example"}'
Response 
{
  "id": "issue_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "subject": "subject_example",
  "customer": "customer_example",
  "raised_by": "raised_by_example",
  "status": "Open",
  "priority": "priority_example",
  "issue_type": "issue_type_example",
  "description": "description_example",
  "service_level_agreement": "service_level_agreement_example",
  "response_by": "response_by_example",
  "first_responded_on": "first_responded_on_example",
  "lead": "lead_example",
  "contact": "contact_example",
  "email_account": "user@example.com",
  "customer_name": "customer_name_example",
  "project": "project_example",
  "company": "Example Corp",
  "resolution_details": "resolution_details_example",
  "opening_date": "2024-01-15",
  "opening_time": "opening_time_example",
  "content_type": "content_type_example",
  "attachment": "attachment_example",
  "via_customer_portal": false,
  "service_level_agreement_creation": "service_level_agreement_creation_example",
  "issue_split_from": "issue_split_from_example",
  "avg_response_time": 0,
  "resolution_time": 0,
  "user_resolution_time": 0,
  "on_hold_since": "on_hold_since_example",
  "total_hold_time": 0,
  "agreement_status": "First Response Due",
  "first_response_time": 0,
  "sla_resolution_by": "sla_resolution_by_example",
  "sla_resolution_date": "2024-01-15"
}
PATCH /api/support/issue/{id}

Update a issue

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

Body parameters

subject string
customer string
raised_by string
status string

Default: Open

priority string
issue_type string
description string
service_level_agreement string
response_by string
first_responded_on string
lead string
contact string
email_account string
customer_name string
project string
company string
resolution_details string
opening_date string
opening_time string
content_type string
attachment string
via_customer_portal boolean

Default: false

service_level_agreement_creation string
issue_split_from string
avg_response_time integer
resolution_time integer
user_resolution_time integer
on_hold_since string
total_hold_time integer
agreement_status string

Default: First Response Due

first_response_time integer
sla_resolution_by string
sla_resolution_date string

Returns

Returns the updated issue object.

PATCH /api/support/issue/{id} 
curl https://api.overplane.dev/api/support/issue/issue_abc123 \
  -H "Authorization: Bearer sk_test_..." \
  -X PATCH \
  -H "Content-Type: application/json" \
  -d '{"subject":"subject_example","customer":"customer_example"}'
Response 
{
  "id": "issue_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "subject": "subject_example",
  "customer": "customer_example",
  "raised_by": "raised_by_example",
  "status": "Open",
  "priority": "priority_example",
  "issue_type": "issue_type_example",
  "description": "description_example",
  "service_level_agreement": "service_level_agreement_example",
  "response_by": "response_by_example",
  "first_responded_on": "first_responded_on_example",
  "lead": "lead_example",
  "contact": "contact_example",
  "email_account": "user@example.com",
  "customer_name": "customer_name_example",
  "project": "project_example",
  "company": "Example Corp",
  "resolution_details": "resolution_details_example",
  "opening_date": "2024-01-15",
  "opening_time": "opening_time_example",
  "content_type": "content_type_example",
  "attachment": "attachment_example",
  "via_customer_portal": false,
  "service_level_agreement_creation": "service_level_agreement_creation_example",
  "issue_split_from": "issue_split_from_example",
  "avg_response_time": 0,
  "resolution_time": 0,
  "user_resolution_time": 0,
  "on_hold_since": "on_hold_since_example",
  "total_hold_time": 0,
  "agreement_status": "First Response Due",
  "first_response_time": 0,
  "sla_resolution_by": "sla_resolution_by_example",
  "sla_resolution_date": "2024-01-15"
}
DELETE /api/support/issue/{id}

Delete a issue

Permanently deletes a issue. This cannot be undone.

Path parameters

id string required

The identifier of the issue to delete.

Returns

Returns a confirmation that the issue has been deleted.

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