API Reference

SprintFlint provides a REST API for programmatic access to your projects, sprints, and issues. Use it to integrate with Zapier, custom scripts, or your own applications.

Authentication

All API requests require authentication using a bearer token.

Generating an API Token

Click your avatar in the sidebar
Go to "My Profile"
Scroll to the "API Token" section
Click "Generate Token"
Copy and securely store your token

Token Security - Your API token provides the same access as your logged-in account. Keep it secret and never commit it to version control.

Using the Token

Include the token in the Authorization header of every request:

Authorization: Bearer your-api-token-here

Example with cURL:

curl -H "Authorization: Bearer your-api-token" \
  https://sprintflint.com/api/v1/projects

Base URL

https://sprintflint.com/api/v1

Response Format

All responses are in JSON format. Successful responses return the requested data. Error responses include an error message:

{
  "error": "Resource not found"
}

Available Endpoints

Projects

Method	Endpoint	Description
`GET`	`/projects`	List all projects
`GET`	`/projects/:id`	Get a specific project
`POST`	`/projects`	Create a new project
`PUT`	`/projects/:id`	Update a project
`DELETE`	`/projects/:id`	Delete a project

Sprints

Method	Endpoint	Description
`GET`	`/projects/:project_id/sprints`	List sprints in a project
`GET`	`/projects/:project_id/sprints/:id`	Get a specific sprint
`POST`	`/projects/:project_id/sprints`	Create a new sprint
`PUT`	`/projects/:project_id/sprints/:id`	Update a sprint
`POST`	`/projects/:project_id/sprints/:id/activate`	Activate a sprint
`POST`	`/projects/:project_id/sprints/:id/complete`	Complete a sprint
`DELETE`	`/projects/:project_id/sprints/:id`	Delete a sprint

Issues

Method	Endpoint	Description
`GET`	`/projects/:project_id/sprints/:sprint_id/issues`	List issues in a sprint
`GET`	`/projects/:project_id/sprints/:sprint_id/issues/:id`	Get a specific issue
`POST`	`/projects/:project_id/sprints/:sprint_id/issues`	Create a new issue
`PUT`	`/projects/:project_id/sprints/:sprint_id/issues/:id`	Update an issue
`DELETE`	`/projects/:project_id/sprints/:sprint_id/issues/:id`	Delete an issue

Comments

Method	Endpoint	Description
`GET`	`/.../issues/:issue_id/comments`	List comments on an issue
`POST`	`/.../issues/:issue_id/comments`	Add a comment to an issue
`GET`	`/comments/:id`	Get a specific comment
`PUT`	`/comments/:id`	Update a comment
`DELETE`	`/comments/:id`	Delete a comment

Example: Create an Issue

curl -X POST \
  -H "Authorization: Bearer your-api-token" \
  -H "Content-Type: application/json" \
  -d '{
    "issue": {
      "title": "Add user authentication",
      "description": "Implement login and logout functionality",
      "story_points": 5,
      "status": "todo"
    }
  }' \
  https://sprintflint.com/api/v1/projects/1/sprints/1/issues

Example: Update Issue Status

curl -X PUT \
  -H "Authorization: Bearer your-api-token" \
  -H "Content-Type: application/json" \
  -d '{
    "issue": {
      "status": "in_progress"
    }
  }' \
  https://sprintflint.com/api/v1/projects/1/sprints/1/issues/123

Rate Limits

API requests are rate limited to prevent abuse:

1000 requests per hour per API token
Rate limit headers are included in responses

Interactive API Documentation

For detailed request/response schemas and the ability to test endpoints directly:

View Interactive API Docs (Swagger)

Regenerating Your Token

If your token is compromised:

Go to "My Profile"
Click "Regenerate Token"
The old token is immediately invalidated
Update your integrations with the new token

Need Help?

If you have questions about the API or need assistance with your integration, contact us at [email protected].