External APIs for organizations.
Returns a paginated list of organizations with optional filtering.
read:organizations:focusinteger
string
string
string
array<string>
Organizations returned successfully.
Paginated REST response.
1
2
3
4
curl --request GET \
--url '/focus/v1/organizations' \
--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 organization with the provided details. If parent organization is omitted, the new organization is created as top-level. When owner is omitted, the authenticated user is used as creator and owner.
write:organizations:focusstring
Requiredstring
Requiredstring
string
string
string
string
Organization created successfully.
An Organization.
1
2
3
4
5
6
7
8
9
10
11
12
13
14
curl --request POST \
--url '/focus/v1/organizations' \
--header 'Authorization: Bearer <access_token>' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '{
"name": "<string>",
"organizationTypeId": "<string>",
"externalId": "<string>",
"parentOrganizationId": "<string>",
"ownerId": "<string>",
"targetDate": "<string>",
"targetDateType": "<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
{
"id": "<string>",
"name": "<string>",
"externalId": "<string>",
"about": "<string>",
"createdDate": "<string>",
"updatedDate": "<string>",
"owner": {
"id": "<string>",
"name": "<string>"
},
"organizationType": {
"id": "<string>",
"name": "<string>"
},
"parent": {
"id": "<string>"
},
"path": [
{
"id": "<string>",
"index": 68
}
],
"status": {
"id": "<string>",
"name": "<string>"
}
}Moves the specified organization under a new parent organization. If the parent organization ID is omitted, the organization is moved to the top level.
write:organizations:focusstring
Requiredstring
Organization reparented successfully.
An Organization.
1
2
3
4
5
6
7
8
curl --request POST \
--url '/focus/v1/organizations/{organizationId}:reparent' \
--header 'Authorization: Bearer <access_token>' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '{
"parentOrganizationId": "<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
{
"id": "<string>",
"name": "<string>",
"externalId": "<string>",
"about": "<string>",
"createdDate": "<string>",
"updatedDate": "<string>",
"owner": {
"id": "<string>",
"name": "<string>"
},
"organizationType": {
"id": "<string>",
"name": "<string>"
},
"parent": {
"id": "<string>"
},
"path": [
{
"id": "<string>",
"index": 68
}
],
"status": {
"id": "<string>",
"name": "<string>"
}
}Archives the specified organization with an optional comment.
write:organizations:focusstring
Requiredstring
Organization archived successfully.
1
2
3
4
5
6
7
curl --request POST \
--url '/focus/v1/organizations/{organizationId}:archive' \
--header 'Authorization: Bearer <access_token>' \
--header 'Content-Type: application/json' \
--data '{
"comment": "<string>"
}'Returns organization details by organization ID.
read:organizations:focusstring
RequiredOrganization returned successfully.
An Organization.
1
2
3
4
curl --request GET \
--url '/focus/v1/organizations/{organizationId}' \
--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
{
"id": "<string>",
"name": "<string>",
"externalId": "<string>",
"about": "<string>",
"createdDate": "<string>",
"updatedDate": "<string>",
"owner": {
"id": "<string>",
"name": "<string>"
},
"organizationType": {
"id": "<string>",
"name": "<string>"
},
"parent": {
"id": "<string>"
},
"path": [
{
"id": "<string>",
"index": 68
}
],
"status": {
"id": "<string>",
"name": "<string>"
}
}Deletes the specified organization. This action is irreversible.
write:organizations:focusstring
RequiredOrganization deleted successfully.
1
2
3
curl --request DELETE \
--url '/focus/v1/organizations/{organizationId}' \
--header 'Authorization: Bearer <access_token>'Updates the details of the specified organization. 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.
write:organizations:focusstring
Requiredstring
Requiredstring
string
string
string
Organization updated successfully.
An Organization.
1
2
3
4
5
6
7
8
9
10
11
curl --request PATCH \
--url '/focus/v1/organizations/{organizationId}?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
{
"id": "<string>",
"name": "<string>",
"externalId": "<string>",
"about": "<string>",
"createdDate": "<string>",
"updatedDate": "<string>",
"owner": {
"id": "<string>",
"name": "<string>"
},
"organizationType": {
"id": "<string>",
"name": "<string>"
},
"parent": {
"id": "<string>"
},
"path": [
{
"id": "<string>",
"index": 68
}
],
"status": {
"id": "<string>",
"name": "<string>"
}
}Rate this page: