Getscope.com (1.0.0)

Download OpenAPI specification:Download

E-mail: contact@getscope.com URL: http://getscope.com/contact License: Apache 2.0 Terms of Service

This API connects with the Getscope application.

Introduction

This API definition is intended as interface to fetch information from the Getscope application.

It uses the Open API specification: OpenAPI/Swagger format.

The API is the only available for PRO accounts.

GETSCOPE API Specification

The goal of The OpenAPI Specification is to define a standard, language-agnostic interface to REST APIs which allows both humans and computers to discover and understand the capabilities of the service without access to source code, documentation, or through network traffic inspection. When properly defined via OpenAPI, a consumer can understand and interact with the remote service with a minimal amount of implementation logic. Similar to what interfaces have done for lower-level programming, OpenAPI removes the guesswork in calling the service.

Authorization

Access to the API is granted with the API keys provided in the profile of the PRO user. It is based on Basic Http Autorization. Set the headers as api-key:api-secret

Workspaces

Operations about workspaces.

Get workspaces

All workspaces connected with the API credetials.

Responses

Response samples

200
404

Content type

application/json

{"workspace_id": 1000,
"label": "Sample workspace",
"owner": 1
}

Projects

Operations about projects.

Get projects

All projects connected with the API credetials. Workspace is optional and defaults to 0.

Responses

Response samples

200
404

Content type

application/json

{"project_id": 1000,
"workspace_id": 0,
"title": "Sample project",
"type": "kanban",
"status": 1,
"start_date": "2022-01-01",
"end_date": "22-12-01",
"last_updated": "23-05-01"
}

Get project

Get project.

path Parameters

projectid

required

string

The project that needs to be fetched

Responses

Response samples

200
404

Content type

application/json

{"project_id": 1000,
"title": "Sample project",
"type": "scrumm",
"description": "Sample project with demo data",
"status": 0,
"start_date": "2022-01-01",
"end_date": "22-12-01",
"sprint_id": 1,
"sprint": "Sprint 1",
"budget": 10,
"stories": 10,
"last_updated": "23-05-01"
}

Get epics

All epics from a project.

Responses

Response samples

200
404

Content type

application/json

{"folder_id": 12,
"title": "Sample project",
"description": "Epic explanation",
"total_stories": 40,
"total_done": 30
}

Get columns

All lanes from a scrumm, kanban or basicboard project.

Responses

Response samples

200
404

Content type

application/json

{"column_id": 123,
"column_order": 1,
"label": "Todo",
"status": 1,
"cnt": 10,
"todo": "checked",
"done": "checked"
}

Get sprints

All sprints from a scrumm project.

Responses

Response samples

200
404

Content type

application/json

{"sprint_id": 1000,
"title": "Sample project",
"statusname": "running",
"start_date": "2022-01-01",
"end_date": "22-12-01",
"stories": 40,
"total_done": 30
}

Get sprint

Get sprint.

path Parameters

projectid required	integer The project that needs to be fetched
sprintid required	integer The sprint that needs to be fetched

Responses

Response samples

200
404

Content type

application/json

{"sprint_id": 1000,
"title": "Sample project",
"statusname": "running",
"start_date": "2022-01-01",
"end_date": "22-12-01",
"stories": 40,
"total_done": 30
}

Get stories

All stories from a project.

Responses

Response samples

200
404

Content type

application/json

{"objective_id": 1000,
"description": "Sample story",
"acceptance_criteria": "Everythiong must be completed",
"sprint_id": 0,
"column_id": 9000,
"folder_id": 100,
"backlog_column_id": 100,
"storypoints": 3,
"prio": 1,
"assigned_to": 2,
"tasks_total": 2,
"tasks_done": 1,
"tasks_progress": 50,
"minutes": 480
}

Get story

Get story.

path Parameters

projectid required	integer The project that needs to be fetched
storyid required	story The story that needs to be fetched

Responses

Response samples

200
404

Content type

application/json

{"objective_id": 1000,
"description": "Sample story",
"acceptance_criteria": "Everythiong must be completed",
"sprint_id": 0,
"column_id": 9000,
"folder_id": 100,
"backlog_column_id": 100,
"storypoints": 3,
"prio": 1,
"assigned_to": 2,
"tasks_total": 2,
"tasks_done": 1,
"tasks_progress": 50,
"minutes": 480
}

Get backlog

All stories from a project's backlog.

Responses

Response samples

200
404

Content type

application/json

{"objective_id": 1000,
"description": "Sample story",
"acceptance_criteria": "Everythiong must be completed",
"sprint_id": 0,
"column_id": 9000,
"folder_id": 100,
"backlog_column_id": 100,
"storypoints": 3,
"prio": 1,
"assigned_to": 2,
"tasks_total": 2,
"tasks_done": 1,
"tasks_progress": 50,
"minutes": 480
}

Get team

All members from a project.

Responses

Response samples

200
404

Content type

application/json

{"user_id": 1122,
"name": "John",
"rolename": "owner",
"active": 1
}