Get Goal Data Out of Rhythm

Get Goal Data out of Rhythm with this API

Open in New Tab →

Method Details

HTTP Method: GET

URL: https://api.rhythm.cloud/api/public/goal/(id)/details where (id) is replaced with the specific goal id

Content Type: application/json

Response Format: json

Requires Authentication? Yes

HTTP header: Bearer {oath token}

Response

If all items in the request were processed successfully, you will receive a http code 200 (OK), with a JSON of goal data in the response body (see example below).

You may not see all of the data you are expecting since some data is scrubbed for security reasons.

If the access token has expired, you will receive a http code 401 (unauthorized).

Response Body Sample

{
"id": "076bdf40-7a52-40f2-8aae-23ef6ba50bad",
"name": "Sample Goal Name",
"description": null,
"owner": {
    "username": “ceo@rhythmsystems.com",
    "name": “Jack Ceo“,
    "acoach": false
},
"rank": null,
"startDate": "2024-12-29",
"endDate": "2025-12-27",
"goalType": “KPI”,
"statusCriteriaType": “QUARTER”,
"completed": null,
"privateFlag": null,
"groupLevelFlag": true,
"department": {
    "name": “Company”
},
"hasAnyStatus": false,
"criteria": {
    "red": "below 50%",
    "yellow": "Between Red & Green",
    "green": "75% by end of year",
    "supergreen": "90%"
}
}