Getscope.com (1.0.0)
Download OpenAPI specification:Download
This API connects with the Getscope application.
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.
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.
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
Get projects
All projects connected with the API credetials. Workspace is optional and defaults to 0.
Responses
Response samples
- 200
- 404
{- "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
{- "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 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
{- "sprint_id": 1000,
- "title": "Sample project",
- "statusname": "running",
- "start_date": "2022-01-01",
- "end_date": "22-12-01",
- "stories": 40,
- "total_done": 30
}Response samples
- 200
- 404
{- "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
{- "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
}Response samples
- 200
- 404
{- "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
}