Cakemail API

Task

Endpointhttps://api.cakemail.dev

Monitor asynchronous background tasks such as exports and imports. Tasks track the progress and status of long-running operations.

Show all asynchronous Tasks

GET

https://api.cakemail.dev

/tasks

Show all asynchronous Task.

Required scope(s): tasks:read

Show all asynchronous Tasks › query Parameters

account_id

integer · min: 1

Optional Account ID to be used for the request

page

integer · min: 1

Default: 1

per_page

integer · min: 1

Default: 50

with_count

boolean

Include count in the response

Default: false

sort

string

Sort term and direction, using syntax [-|+]term.

Valid terms:

status
created_on
expires_on

Sort term and direction, using syntax [-|+]term.

Valid terms:

status
created_on
expires_on

filter

string

Valid Terms:

type
status
list_id
progress

Valid Operators:

==

Query separator:

Valid Terms:

type
status
list_id
progress

Valid Operators:

==

Query separator:

Show all asynchronous Tasks › Responses

Successful Response

object · required

object[] · required

List of tasks

GET/tasks

curl --request GET \
  --url https://api.cakemail.dev/tasks

shell

Example Responses

{
  "pagination": {
    "page": 0,
    "per_page": 0,
    "count": 0
  },
  "data": [
    {
      "id": "id",
      "status": "pending",
      "created_on": 0,
      "expires_on": 0,
      "progress": 0,
      "requested_by": {
        "email": "test@example.com",
        "id": 0
      },
      "type": "contactsexport",
      "description": "description",
      "payload": {}
    }
  ]
}

json

application/json

Show an asynchronous Task

GET

https://api.cakemail.dev

/tasks/{task_id}

Show an asynchronous Task.

Required scope(s): tasks:read

Show an asynchronous Task › path Parameters

task_id

string · required

Show an asynchronous Task › query Parameters

account_id

integer · min: 1

Optional Account ID to be used for the request

Show an asynchronous Task › Responses

Successful Response

object · required

GET/tasks/{task_id}

curl --request GET \
  --url https://api.cakemail.dev/tasks/:task_id

shell

Example Responses

{
  "data": {
    "id": "id",
    "status": "pending",
    "created_on": 0,
    "expires_on": 0,
    "progress": 0,
    "requested_by": {
      "email": "test@example.com",
      "id": 0
    },
    "type": "contactsexport",
    "description": "description",
    "payload": {}
  }
}

json

application/json

Delete an asynchronous Task

DELETE

https://api.cakemail.dev

/tasks/{task_id}

Delete an asynchronous Task.

Required scope(s): tasks:delete

Delete an asynchronous Task › path Parameters

task_id

string · required

Delete an asynchronous Task › query Parameters

account_id

integer · min: 1

Optional Account ID to be used for the request

Delete an asynchronous Task › Responses

Successful Response

object · required

DELETE/tasks/{task_id}

curl --request DELETE \
  --url https://api.cakemail.dev/tasks/:task_id

shell

Example Responses

{
  "data": {
    "id": "id",
    "status": "pending",
    "created_on": 0,
    "expires_on": 0,
    "progress": 0,
    "requested_by": {
      "email": "test@example.com",
      "id": 0
    },
    "type": "contactsexport",
    "description": "description",
    "payload": {}
  }
}

json

application/json

System Email Logo

Show all asynchronous Tasks

GET

https://api.cakemail.dev

/tasks

Show all asynchronous Task.

Required scope(s): tasks:read

Show all asynchronous Tasks › query Parameters

account_id

integer · min: 1

Optional Account ID to be used for the request

page

integer · min: 1

Default: 1

per_page

integer · min: 1

Default: 50

with_count

boolean

Include count in the response

Default: false

sort

string

Sort term and direction, using syntax [-|+]term.

Valid terms:

status
created_on
expires_on

Sort term and direction, using syntax [-|+]term.

Valid terms:

status
created_on
expires_on

filter

string

Valid Terms:

type
status
list_id
progress

Valid Operators:

==

Query separator:

Valid Terms:

type
status
list_id
progress

Valid Operators:

==

Query separator:

Show all asynchronous Tasks › Responses

Successful Response

object · required

object[] · required

List of tasks

Show an asynchronous Task

GET

https://api.cakemail.dev

/tasks/{task_id}

Show an asynchronous Task.

Required scope(s): tasks:read

Show an asynchronous Task › path Parameters

task_id

string · required

Show an asynchronous Task › query Parameters

account_id

integer · min: 1

Optional Account ID to be used for the request

Show an asynchronous Task › Responses

Successful Response

object · required

Delete an asynchronous Task

DELETE

https://api.cakemail.dev

/tasks/{task_id}

Delete an asynchronous Task.

Required scope(s): tasks:delete

Delete an asynchronous Task › path Parameters

task_id

string · required

Delete an asynchronous Task › query Parameters

account_id

integer · min: 1

Optional Account ID to be used for the request

Delete an asynchronous Task › Responses

Successful Response

object · required