# Yoobic Jobs API

**Canonical:** https://apis.io/apis/yoobic/yoobic-jobs-api/  
**Provider:** Yoobic — https://apis.io/providers/yoobic/  
**Base URL:** https://api.yoobic.com/public/api  
**Documentation:** https://docs.yoobic.com/api.html

Yoobic Jobs API is one of 41 APIs that [Yoobic](https://apis.io/providers/yoobic/) publishes on the [APIs.io](https://apis.io/) network, described by a machine-readable OpenAPI specification. Tagged areas include Job. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, and a changelog.

<a id="group-jobs"></a> The Jobs endpoint allows you to query the status of your asynchronous jobs, whether they are queued, running, completed, or expired. The `id` required to request status is returned from your requests that are queued asynchronously on enabled endpoints. ### Fields | Field | Type | Required | Readonly | OrderBy | Description | |----------------------|:--------------:|:--------:|:--------:|:-------:|---------------------------| |`job_id` | string | x | x | | Unique id of the inventory | |`name` | string | | x | | Job name suffixed with a UUID | |`progress` | number | | x | | Between 0-1, the progress of a job, 1 being complete | |`lastFinishedAt` | date | | x | | The date the job finished | |`data.stats.execution_time_milliseconds` | number | | x | | How long the job ran in milliseconds | |`data.stats.execution_time` | number | | x | | How long the job ran in words | |`data.stats.errors` | number | | x | | Number of errors in the run | |`data.stats.success` | number | | x | | Number of successes in the run | |`data.input` | object | | x | | Request parameters supplied to the job (see below details for export/import) | |`data.output` | object | | x | | Response parameters of the job (see below details for export/import) | #### Fields Export | Field | Type | Required | Readonly | OrderBy | Description | |----------------------|:--------------:|:--------:|:--------:|:-------:|---------------------------| |`data.input.filter` | object | | x | | The filter object passed to the request | |`data.input.modelName`| string | | x | | The endpoint's entity name | |`data.input.type` | string | | x | | The exported file type (csv/xlsx) | |`data.output.errors` | array | | x | | General error or errors that may have occurred for this export job | |`data.output.data.download_url` | string | | x | | The exported file | |`data.output.data.expires_at` | string | | x | | The date at which the file will no longer be available for download | #### Fields Import | Field | Type | Required | Readonly | OrderBy | Description | |----------------------|:--------------:|:--------:|:--------:|:-------:|---------------------------| |`data.input.originalFilename` | string | | x | | The file passed to the request | |`data.input.modelName`| string | | x | | The endpoint's entity name | |`data.input.type` | string | | x | | The imported file type (csv/xlsx) | |`data.output.error.download_url` | string | | x | | The file containing all errors (if any) | |`data.output.error.expires_at` | date | | x | | The date at which the file will no longer be available for download |

## Machine-readable artifacts (11)

- **OpenAPI** — https://raw.githubusercontent.com/api-evangelist/yoobic/refs/heads/main/openapi/yoobic-jobs-api-openapi.yml
- **Documentation** — https://docs.yoobic.com/api.html
- **APIReference** — https://docs.yoobic.com/api.html
- **Postman** — https://assets.yoobic.com/raw/upload/v1767016464/3c85c240-dd03-4981-9814-bc6e5e861fa0.zip
- **ErrorCatalog** — https://raw.githubusercontent.com/api-evangelist/yoobic/refs/heads/main/errors/yoobic-problem-types.yml
- **Conventions** — https://raw.githubusercontent.com/api-evangelist/yoobic/refs/heads/main/conventions/yoobic-conventions.yml
- **ChangeLog** — https://raw.githubusercontent.com/api-evangelist/yoobic/refs/heads/main/changelog/yoobic-changelog.yml
- **Lifecycle** — https://raw.githubusercontent.com/api-evangelist/yoobic/refs/heads/main/lifecycle/yoobic-lifecycle.yml
- **Conformance** — https://raw.githubusercontent.com/api-evangelist/yoobic/refs/heads/main/conformance/yoobic-conformance.yml
- **Sandbox** — https://raw.githubusercontent.com/api-evangelist/yoobic/refs/heads/main/sandbox/yoobic-sandbox.yml
- **Webhooks** — https://raw.githubusercontent.com/api-evangelist/yoobic/refs/heads/main/asyncapi/yoobic-webhooks.yml

## Other Yoobic APIs (12)

- [Yoobic Answers API](https://apis.io/apis/yoobic/yoobic-answers-api/)
- [Yoobic Badges API](https://apis.io/apis/yoobic/yoobic-badges-api/)
- [Yoobic Bot Messages API](https://apis.io/apis/yoobic/yoobic-bot-messages-api/)
- [Yoobic Bots API](https://apis.io/apis/yoobic/yoobic-bots-api/)
- [Yoobic Business KPIs data - salesdata API](https://apis.io/apis/yoobic/yoobic-business-kpis-data-salesdata-api/)
- [Yoobic Campaigns API](https://apis.io/apis/yoobic/yoobic-campaigns-api/)
- [Yoobic Catalogs API](https://apis.io/apis/yoobic/yoobic-catalogs-api/)
- [Yoobic Chats API](https://apis.io/apis/yoobic/yoobic-chats-api/)
- [Yoobic Comments API](https://apis.io/apis/yoobic/yoobic-comments-api/)
- [Yoobic Communities API](https://apis.io/apis/yoobic/yoobic-communities-api/)
- [Yoobic Community Posts API](https://apis.io/apis/yoobic/yoobic-community-posts-api/)
- [Yoobic Competencies API](https://apis.io/apis/yoobic/yoobic-competencies-api/)

## Tags

Job

---

Profiled by [API Evangelist](https://apievangelist.com) and published on [APIs.io](https://apis.io/apis/yoobic/yoobic-jobs-api/). The API's provider profile, Kin Score and agent-readiness rating are at https://apis.io/providers/yoobic/.