> For the complete documentation index, see [llms.txt](https://timetackle.gitbook.io/tackle/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://timetackle.gitbook.io/tackle/api-categories/jobs.md).

# S3 jobs

## Create a job

> Creates a new job with the specified configuration.

```json
{"openapi":"3.0.3","info":{"title":"Tackle API","version":"1.0.0"},"servers":[{"url":"https://api.timetackle.com/external-api/v1"}],"security":[{"ApiKeyAuth":[]}],"components":{"securitySchemes":{},"schemas":{"JobCreateRequest":{"type":"object","required":["name","config"],"properties":{"name":{"type":"string"},"config":{"$ref":"#/components/schemas/JobConfig"}}},"JobConfig":{"type":"object","properties":{"teamId":{"type":"integer","nullable":true},"calendarIds":{"type":"array","items":{"type":"string"}},"startDate":{"type":"string","format":"date"},"endDate":{"type":"string","format":"date"},"mergeAll":{"type":"boolean"},"filters":{"$ref":"#/components/schemas/JobFilters"},"formatting":{"$ref":"#/components/schemas/JobFormatting"}}},"JobFilters":{"type":"object","properties":{"search":{"type":"array","items":{"type":"string"}},"tag":{"type":"array","items":{"type":"string"}},"allDay":{"type":"string","enum":["INCLUDE","EXCLUDE"]},"rsvp":{"type":"boolean"},"hasCrmAccount":{"type":"boolean","nullable":true},"hasCrmOpportunity":{"type":"boolean","nullable":true},"hasCrmOpportunityOwner":{"type":"boolean","nullable":true},"hasCrmStage":{"type":"boolean","nullable":true},"crmAccountTags":{"type":"array","items":{"type":"string"},"nullable":true},"crmOpportunityTags":{"type":"array","items":{"type":"string"},"nullable":true},"crmOpportunityOwnerTags":{"type":"array","items":{"type":"string"},"nullable":true},"crmStageTags":{"type":"array","items":{"type":"string"},"nullable":true},"taggedEvent":{"type":"boolean","nullable":true}}},"JobFormatting":{"type":"object","properties":{"date":{"type":"string","enum":["MM_DD_YYYY","DD_MM_YYYY"]},"time":{"type":"string","enum":["HOUR_MIN_AMPM","HOUR_MIN"]},"duration":{"type":"string","enum":["HOURS_IN_DECIMAL","MINUTES"]},"color":{"type":"string","enum":["NONE","RED","BLUE","GREEN"]},"excludeOrganizer":{"type":"boolean"},"excludeResource":{"type":"boolean"},"singleColumnTag":{"type":"boolean"}}},"JobCreateResponse":{"type":"object","properties":{"jobId":{"type":"string","format":"uuid"}}}}},"paths":{"/job/create":{"post":{"summary":"Create a job","description":"Creates a new job with the specified configuration.","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/JobCreateRequest"}}}},"responses":{"201":{"description":"Job successfully created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/JobCreateResponse"}}}}}}}}}
```

## Get list of jobs

> Retrieves a list of jobs with their details.

```json
{"openapi":"3.0.3","info":{"title":"Tackle API","version":"1.0.0"},"servers":[{"url":"https://api.timetackle.com/external-api/v1"}],"security":[{"ApiKeyAuth":[]}],"components":{"securitySchemes":{},"schemas":{"JobListItem":{"type":"object","properties":{"id":{"type":"integer"},"jobId":{"type":"string","format":"uuid"},"status":{"type":"string","enum":["PENDING","RUNNING","SUCCEED","FAILED"]},"name":{"type":"string"},"config":{"$ref":"#/components/schemas/JobConfig"},"executedAt":{"type":"string","format":"date-time"},"lastModifiedAt":{"type":"string","format":"date-time"}}},"JobConfig":{"type":"object","properties":{"teamId":{"type":"integer","nullable":true},"calendarIds":{"type":"array","items":{"type":"string"}},"startDate":{"type":"string","format":"date"},"endDate":{"type":"string","format":"date"},"mergeAll":{"type":"boolean"},"filters":{"$ref":"#/components/schemas/JobFilters"},"formatting":{"$ref":"#/components/schemas/JobFormatting"}}},"JobFilters":{"type":"object","properties":{"search":{"type":"array","items":{"type":"string"}},"tag":{"type":"array","items":{"type":"string"}},"allDay":{"type":"string","enum":["INCLUDE","EXCLUDE"]},"rsvp":{"type":"boolean"},"hasCrmAccount":{"type":"boolean","nullable":true},"hasCrmOpportunity":{"type":"boolean","nullable":true},"hasCrmOpportunityOwner":{"type":"boolean","nullable":true},"hasCrmStage":{"type":"boolean","nullable":true},"crmAccountTags":{"type":"array","items":{"type":"string"},"nullable":true},"crmOpportunityTags":{"type":"array","items":{"type":"string"},"nullable":true},"crmOpportunityOwnerTags":{"type":"array","items":{"type":"string"},"nullable":true},"crmStageTags":{"type":"array","items":{"type":"string"},"nullable":true},"taggedEvent":{"type":"boolean","nullable":true}}},"JobFormatting":{"type":"object","properties":{"date":{"type":"string","enum":["MM_DD_YYYY","DD_MM_YYYY"]},"time":{"type":"string","enum":["HOUR_MIN_AMPM","HOUR_MIN"]},"duration":{"type":"string","enum":["HOURS_IN_DECIMAL","MINUTES"]},"color":{"type":"string","enum":["NONE","RED","BLUE","GREEN"]},"excludeOrganizer":{"type":"boolean"},"excludeResource":{"type":"boolean"},"singleColumnTag":{"type":"boolean"}}}}},"paths":{"/job/list":{"get":{"summary":"Get list of jobs","description":"Retrieves a list of jobs with their details.","responses":{"200":{"description":"List of jobs","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/JobListItem"}}}}}}}}}}
```