meet and rockDeveloper Docs

Milestone API

The Milestone API allows you to create, retrieve, update, and delete milestones for your project. Use milestones to group work into meaningful goals and track progress over time.

Base URL

All URLs referenced in the documentation have the following base:

Base URL
https://api.meetandrock.com/v1/dev
Authentication

Send your secret API key as a Bearer token in the Authorization header:Authorization: Bearer YOUR_API_KEY

Endpoints overview

  • GET/milestone: Retrieve a list of all milestones.
  • POST/milestone: Create a new milestone.
  • GET/milestone/:milestoneId: Retrieve details of a specific milestone.
  • PUT/milestone/:milestoneId: Update an existing milestone.
  • DELETE/milestone/:milestoneId: Delete a milestone.

Create a new milestone

Use this endpoint to create a new milestone attached to the current project.

  • name (string, required): The name of the milestone.
  • description (string, required): A brief description of the milestone.
  • estimate (datetime, required): Target ISO date to complete the milestone.
POSThttps://api.meetandrock.com/v1/dev/milestone
Create milestone

Create a new milestone for the current project.

curl -X POST "https://api.meetandrock.com/v1/dev/milestone" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Launch MVP",
    "description": "Milestone to launch the minimum viable product",
    "estimate": "2024-01-15T00:00:00Z"
  }'

Retrieve all milestones

Use this endpoint to retrieve a list of all milestones associated with your project.

GEThttps://api.meetandrock.com/v1/dev/milestone
List milestones

Retrieve all milestones for the current project.

curl -X GET "https://api.meetandrock.com/v1/dev/milestone" \
  -H "Authorization: Bearer YOUR_API_KEY"

Retrieve milestone by ID

Retrieve details of a specific milestone using its unique ID.

GEThttps://api.meetandrock.com/v1/dev/milestone/:milestoneId
Get milestone

Retrieve a single milestone by its ID.

curl -X GET "https://api.meetandrock.com/v1/dev/milestone/:milestoneId" \
  -H "Authorization: Bearer YOUR_API_KEY"

Update an existing milestone

Update the details of an existing milestone by providing the updated fields.

  • name (string, required): The updated name of the milestone.
  • description (string, required): The updated description of the milestone.
  • estimate (datetime, required): The updated target completion date.
PUThttps://api.meetandrock.com/v1/dev/milestone/:milestoneId
Update milestone

Update fields for an existing milestone.

curl -X PUT "https://api.meetandrock.com/v1/dev/milestone/:milestoneId" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Updated MVP Launch",
    "description": "Updated milestone description",
    "estimate": "2024-01-20T00:00:00Z"
  }'

Delete a milestone

Use this endpoint to delete a milestone by its ID.

DELETEhttps://api.meetandrock.com/v1/dev/milestone/:milestoneId
Delete milestone

Delete a milestone permanently.

curl -X DELETE "https://api.meetandrock.com/v1/dev/milestone/:milestoneId" \
  -H "Authorization: Bearer YOUR_API_KEY"

Contents