Returns the autopilot with the specified id. | awork API

Returns the autopilot including its alerts. To get the autopilot data the user needs to be the owner of the project or ‘read’ permissions of the feature ‘project-master-data’ globally or in his project role.

Required Permissions

Any authenticated user.

Returns the autopilot including its alerts. To get the autopilot data the user needs to be the owner of the project or 'read' permissions of the feature 'project-master-data' globally or in his project role. <Check title="Required Permissions">Any authenticated user.</Check>

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

autopilotIdstringRequiredformat: "uuid"

The id of the autopilot.

Response

typestring>=1 character

The type of the autopilot.

enabledboolean

Whether the autopilot is enabled.

alertslist of objects

The alerts of the autopilot.

idstring or nullformat: "uuid"

The id of the autopilot.

createdOnstring or nullformat: "date-time"

The date this object was created.

createdBystring or nullformat: "uuid"

The id of the user who created this object.

updatedOnstring or nullformat: "date-time"

The date this object was last modified.

updatedBystring or nullformat: "uuid"

The id of the user who last modified this object.

1	{
2	"type": "agile",
3	"enabled": true,
4	"alerts": [
5	{
6	"id": "123e4567-e89b-12d3-a456-426614174000",
7	"alert": "due_soon",
8	"enabled": true,
9	"channel": "email"
10	}
11	],
12	"id": "123e4567-e89b-12d3-a456-426614174000",
13	"createdOn": "2024-01-15T09:30:00Z",
14	"createdBy": "123e4567-e89b-12d3-a456-426614174000",
15	"updatedOn": "2024-01-15T09:30:00Z",
16	"updatedBy": "123e4567-e89b-12d3-a456-426614174000"
17	}

1	curl https://api.awork.com/api/v1/autopilot/autopilotId \
2	-H "Authorization: Bearer <token>"