GET api/v1/Commitments/{id}
Gets a specific commitment
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| id |
The ID of the commitment requested |
globally unique identifier |
Required |
| fields |
Use this to only return the data fields you're interested in. Field names not found are ignored and no error is thrown. If no fields are found then the full object is returned. |
Collection of string |
None. |
| suppressResponseCodes |
Some applications do wonky things if error codes are used. Use this to force 200s to always return. |
boolean |
None. |
| APIKey |
This is your unique key that identifies you as the developer of this app. Required for all calls. |
string |
None. |
| APIToken |
This is the user's session token generated when you authenticate the user |
string |
None. |
Body Parameters
None.
Response Information
Resource Description
Commitment| Name | Description | Type | Additional information |
|---|---|---|---|
| ID |
The commitment's ID |
globally unique identifier |
None. |
| Text |
The text body of the commitment |
string |
None. |
| Completed |
Whether the user has completed the commitment |
boolean |
None. |
| PeriodStartDate |
The week the commitment is for |
date |
None. |
| GoalID |
The goal the commitment is tied to |
globally unique identifier |
None. |
| TeamID |
The team this commitment is a part of (a user can be on multiple teams) |
globally unique identifier |
None. |
| UserID |
The user this commitment is assigned to |
globally unique identifier |
None. |
Response Formats
application/json, text/json
{
"ID": "f1f836c3-815e-49e0-8ad4-1fcd8a9b3110",
"Text": "sample string 2",
"Completed": true,
"PeriodStartDate": "2024-05-19T09:51:09.3274729-04:00",
"GoalID": "bc87559b-fa54-4f98-ad29-8946cacde85c",
"TeamID": "f05c3d69-ac42-44ac-abbc-0e9cda8849c3",
"UserID": "33dbe4d6-816f-4ea4-abbd-020d61a85bdb"
}