Examples

Example API Request

Create a project (POST)

API endpoint: https://api.rocketlane.com/api/1.0/projects

Request

The base URL with versioning (add versioning link) for all requests to Rocketlane APIs is:
https://api.rocketlane.com/api/1.0

Every API request you make will start with the same base URL. Now, since we want to operate on projects, the full URL in our case becomes:
https://api.rocketlane.com/api/1.0/projects

We'll make a POST request to that URL, which serves as our API endpoint for creating a project. In the header, we'll authorize the request with our API key.

curl --request POST  
     --url <https://api.rocketlane.com/api/1.0/projects>  
     --header 'accept: application/json'  
     --header 'api-key: <api-key>'  
     --header 'content-type: application/json'

For our POST body, we'll send a data object that encapsulates all the fields that we want to set.

{
    "projectName":"Acme onboarding",
    "customer":{
        "companyName":"Acme Inc"
    },
    "owner":{
        "emailId":"[email protected]"
    }
}

Response

After requesting information from the API, you will receive a response in JSON format. In our specific case, the API returns a 201 Created response status code, indicating that the request was successful and led to the creation of a resource.

{
    "projectId":201,
    "projectName":"Acme onboarding",
    "startDate":"2023-03-28",
    "dueDate":"2023-03-28",
    "startDateActual":"2023-03-28",
    "dueDateActual":"2023-03-28",
    "createdAt":1681319726000,
    "updatedAt":1681319726000,
    "customer":{
        "companyId":201,
        "companyName":"Acme Inc",
        "companyUrl":"https://www.acme.com"
    },
    "partnerCompanies":[
        {
            "companyId":301,
            "companyName":"Modert Inc",
            "companyUrl":"https://www.modert.com"
        }
    ],
    "archived":false,
    "visibility":"EVERYONE",
    "owner":{
        "emailId":"[email protected]",
        "userId":201,
        "firstName":"John",
        "lastName":"Doe"
    },
    "teamMembers":{
        "members":[
            {
                "emailId":"[email protected]",
                "userId":201,
                "firstName":"John",
                "lastName":"Doe"
            }
        ],
        "customers":[
            {
                "emailId":"[email protected]",
                "userId":301,
                "firstName":"Rachel",
                "lastName":"Green"
            }
        ],
        "customerChampion":{
            "emailId":"[email protected]",
            "userId":302,
            "firstName":"Ruth",
            "lastName":"Bell"
        }
    },
    "status":{
        "value":2,
        "label":"In progress"
    },
    "fields":[
        {
            "fieldId":201,
            "fieldLabel":"MRR",
            "fieldValue":"1000"
        }
    ],
    "annualizedRecurringRevenue":10000,
    "projectFee":100000,
    "budgetedHours":1000,
    "trackedHours":530,
    "allocatedHours":500,
    "progressPercentage":42,
    "plannedDurationInDays":24,
    "inferredProgress":"RUNNING_LATE",
    "projectAgeInDays":38,
    "customersInvited":5,
    "customersJoined":12,
    "createdBy":{
        "emailId":"[email protected]",
        "userId":201,
        "firstName":"John",
        "lastName":"Doe"
    }
}

In the above code snippet, the entire record of the newly-created project is returned.