Skip to content

Get Cron Job Groups

Get the cron job groups of current user.

Method

GET

Endpoint

https://api.easycron.com/v1/cron-job-groups
Some other possible URLs:
https://api.easycron.com/v1/cron-jobs-groups&pretty
https://api.easycron.com/v1/cron-jobs-groups?page=2&order=asc
https://api.easycron.com/v1/cron-jobs-groups?sort_by=cron_job_group_name&order=desc

NOTE:  By appending pretty in the request URL query string, you can get a pretty printed JSON (indented with spaces).

Query parameters

nametyperequireddefaultdescriptionlimits
pageintoptional1Page number.
page_sizeintoptional10The result number in one page.min=1, max=500
sort_bystringoptionalcron_job_group_idWhat to sort results by.
Allowed values: cron_job_group_id, cron_job_group_name
orderstringoptionaldescThe order the returned results should be in.
Allowed values: desc, asc

Example API call

Terminal window
curl \
--include \
--request GET \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <API_KEY>' \
"https://api.easycron.com/v1/cron-job-groups?pretty"

Example Success Response

Together with the HTTP code 200, the following content will be responded:

{
"cron_job_groups": [
{
"cron_job_group_id": 40525,
"cron_job_group_name": "cronJobGroupName1"
},
{
"cron_job_group_id": 33340,
"cron_job_group_name": "cronJobGroupName2"
},
...
],
"meta": {
"page": 1,
"page_size": 10,
"result_count": 10,
"total_count": 32
}
}

Example Failure Response

Together with the HTTP code of the error, the following error message will be responded:

{"message":"ERROR_MESSAGE"}