Returns a paginated list of focus areas with optional filtering.
focus-areas-read-scopestring
string
string
string
string
string
Focus areas returned successfully.
Paginated REST response.
1
2
3
4
curl --request GET \
--url '/focus/v1/focus-areas' \
--header 'Authorization: Bearer <access_token>' \
--header 'Accept: application/json'1
2
3
4
5
6
7
8
9
{
"values": [
{}
],
"cursor": "<string>",
"last": true,
"totalCount": 21,
"nextPageCursor": "<string>"
}Creates a new focus area with the provided details. Status is automatically set to PENDING. Target date and target date type are not set on create, and draft defaults to false. If parent focus area is omitted, the new focus area is created as top-level. When owner is omitted, the authenticated user is used as creator and owner.
focus-areas-write-scopestring
Requiredstring
Requiredstring
string
string
Focus area created successfully.
A Focus Area.
1
2
3
4
5
6
7
8
9
10
11
12
curl --request POST \
--url '/focus/v1/focus-areas' \
--header 'Authorization: Bearer <access_token>' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '{
"name": "<string>",
"focusAreaTypeId": "<string>",
"externalId": "<string>",
"parentFocusAreaId": "<string>",
"ownerId": "<string>"
}'1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
{
"id": "<string>",
"parent": {
"id": "<string>"
},
"name": "<string>",
"externalId": "<string>",
"about": "<string>",
"createdDate": "<string>",
"updatedDate": "<string>",
"owner": {
"id": "<string>",
"name": "<string>"
},
"focusAreaType": {
"id": "<string>",
"name": "<string>"
},
"targetDate": "<string>",
"path": [
{
"id": "<string>",
"index": 100
}
],
"status": {
"id": "<string>",
"name": "<string>"
}
}Returns focus area details by focus area ID.
focus-areas-read-scopestring
RequiredFocus area returned successfully.
A Focus Area.
1
2
3
4
curl --request GET \
--url '/focus/v1/focus-areas/{focusAreaId}' \
--header 'Authorization: Bearer <access_token>' \
--header 'Accept: application/json'1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
{
"id": "<string>",
"parent": {
"id": "<string>"
},
"name": "<string>",
"externalId": "<string>",
"about": "<string>",
"createdDate": "<string>",
"updatedDate": "<string>",
"owner": {
"id": "<string>",
"name": "<string>"
},
"focusAreaType": {
"id": "<string>",
"name": "<string>"
},
"targetDate": "<string>",
"path": [
{
"id": "<string>",
"index": 100
}
],
"status": {
"id": "<string>",
"name": "<string>"
}
}Deletes the specified focus area. This action is irreversible and will re-parent all child focus areas to the parent of the deleted focus area, or as parentless if the deleted focus area is a parent.
focus-areas-write-scopestring
RequiredFocus area deleted successfully.
1
2
3
curl --request DELETE \
--url '/focus/v1/focus-areas/{focusAreaId}' \
--header 'Authorization: Bearer <access_token>'Updates the details of the specified focus area. The updateMask query parameter specifies which fields to update; supported fields are name, ownerId, externalId, and about. Fields not listed in updateMask are not modified. Fields listed in updateMask but omitted from the request body or set to null are cleared; clearing a required field is not allowed and will result in a 400 response.
focus-areas-write-scopestring
Requiredstring
Requiredstring
string
string
string
Focus area updated successfully.
A Focus Area.
1
2
3
4
5
6
7
8
9
10
11
curl --request PATCH \
--url '/focus/v1/focus-areas/{focusAreaId}?updateMask=name%2Cabout' \
--header 'Authorization: Bearer <access_token>' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '{
"name": "<string>",
"ownerId": "<string>",
"externalId": "<string>",
"about": "<string>"
}'1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
{
"id": "<string>",
"parent": {
"id": "<string>"
},
"name": "<string>",
"externalId": "<string>",
"about": "<string>",
"createdDate": "<string>",
"updatedDate": "<string>",
"owner": {
"id": "<string>",
"name": "<string>"
},
"focusAreaType": {
"id": "<string>",
"name": "<string>"
},
"targetDate": "<string>",
"path": [
{
"id": "<string>",
"index": 100
}
],
"status": {
"id": "<string>",
"name": "<string>"
}
}Rate this page: