Actions

List actions

GET /api/v1/actions

Parameters

Name	In	Type	Required	Description
`organisationId`	query	string	No	—
`zoneId`	query	string	No	—
`containerId`	query	string	No	—
`limit`	query	integer	No	—
`cursor`	query	string	No	Opaque continuation token from a previous list response's `nextCursor`.

Example request

curl -X GET \
"https://api.example.com/api/v1/actions?organisationId=<organisationId>&zoneId=<zoneId>&containerId=<containerId>&limit=<limit>&cursor=<cursor>" \
-H "Authorization: Bearer <API_KEY>" \
-H "Content-Type: application/json"

Example response

Status: 200

{
  "data": [
    {
      "_id": "string",
      "name": "string",
      "description": "string",
      "zoneId": "string",
      "doDate": 0,
      "dueDate": 0,
      "userId": "string",
      "organisationId": "string",
      "createdAt": 0,
      "updatedAt": 0,
      "typeIds": [
        "string"
      ],
      "categoryIds": [
        "string"
      ]
    }
  ],
  "nextCursor": "string"
}

Other statuses: 401.

Response body type

{ data: Action[]; nextCursor: string }

Create action

POST /api/v1/actions

Example request

curl -X POST \
"https://api.example.com/api/v1/actions" \
-H "Authorization: Bearer <API_KEY>" \
-H "Content-Type: application/json"
-d '{"name":"string","zoneId":"string","description":"string","doDate":0,"dueDate":0,"organisationId":"string","typeIds":["string"],"categoryIds":["string"]}'

Example response

Status: 200

{
  "data": {
    "_id": "string",
    "name": "string",
    "description": "string",
    "zoneId": "string",
    "doDate": 0,
    "dueDate": 0,
    "userId": "string",
    "organisationId": "string",
    "createdAt": 0,
    "updatedAt": 0,
    "typeIds": [
      "string"
    ],
    "categoryIds": [
      "string"
    ]
  }
}

Other statuses: 400, 401.

Response body type

{ data: Action }

Get action by id

GET /api/v1/actions/{id}

Parameters

Name	In	Type	Required	Description
`id`	path	string	Yes	Path parameter.

Example request

curl -X GET \
"https://api.example.com/api/v1/actions/<id>" \
-H "Authorization: Bearer <API_KEY>" \
-H "Content-Type: application/json"

Example response

Status: 200

{
  "data": {
    "_id": "string",
    "name": "string",
    "description": "string",
    "zoneId": "string",
    "doDate": 0,
    "dueDate": 0,
    "userId": "string",
    "organisationId": "string",
    "createdAt": 0,
    "updatedAt": 0,
    "typeIds": [
      "string"
    ],
    "categoryIds": [
      "string"
    ]
  }
}

Other statuses: 401, 404.

Response body type

{ data: Action }

Update action

PATCH /api/v1/actions/{id}

Parameters

Name	In	Type	Required	Description
`id`	path	string	Yes	Path parameter.

Example request

curl -X PATCH \
"https://api.example.com/api/v1/actions/<id>" \
-H "Authorization: Bearer <API_KEY>" \
-H "Content-Type: application/json"
-d '{"name":"string","description":"string","doDate":0,"dueDate":0,"zoneId":"string","typeIds":["string"],"categoryIds":["string"]}'

Example response

Status: 200

{
  "data": {
    "_id": "string",
    "name": "string",
    "description": "string",
    "zoneId": "string",
    "doDate": 0,
    "dueDate": 0,
    "userId": "string",
    "organisationId": "string",
    "createdAt": 0,
    "updatedAt": 0,
    "typeIds": [
      "string"
    ],
    "categoryIds": [
      "string"
    ]
  }
}

Other statuses: 401, 403, 404.

Response body type

{ data: Action }

Delete action

DELETE /api/v1/actions/{id}

Parameters

Name	In	Type	Required	Description
`id`	path	string	Yes	Path parameter.

Example request

curl -X DELETE \
"https://api.example.com/api/v1/actions/<id>" \
-H "Authorization: Bearer <API_KEY>" \
-H "Content-Type: application/json"

Other statuses: 401, 403, 404.

Response body type

—