GET
/
transform
/
v1
/
jobs
/
{id}
cURL
curl --request GET \
  --url https://api.invopop.com/transform/v1/jobs/{id} \
  --header 'Authorization: Bearer <token>'
{
  "args": {},
  "attachments": [
    {
      "desc": "My file description.",
      "hash": "ba7816bf8f01cfea414140de5dae2223b00361a396177a9cb410ff61f20015ad",
      "id": "b564ff94-7823-4f54-975e-280feb38df3f",
      "meta": {},
      "mime": "application/pdf",
      "name": "my-file.pdf",
      "size": 12345,
      "url": "<string>"
    }
  ],
  "completed_at": "<string>",
  "created_at": "<string>",
  "envelope": {},
  "faults": [
    {
      "code": "<string>",
      "message": "<string>",
      "provider": "pdf"
    }
  ],
  "id": "5b45453c-cdd0-11ed-afa1-0242ac120002",
  "intents": [
    {
      "completed": true,
      "created_at": "<string>",
      "events": [
        {
          "args": {},
          "at": "2021-09-15T15:04:05.999Z",
          "code": "<string>",
          "index": 0,
          "message": "<string>",
          "silo_entry_id": "<string>",
          "status": "ERR"
        }
      ],
      "id": "b564ff94-7823-4f54-975e-280feb38df3f",
      "name": "PDF Generation",
      "provider": "pdf",
      "step_id": "8d49556b-ff63-477b-9cd3-32c986c1c77b",
      "updated_at": "<string>"
    }
  ],
  "key": "<string>",
  "silo_entry_id": "75fa764a-cdd0-11ed-afa1-0242ac120002",
  "status": "<string>",
  "tags": [
    "<string>"
  ],
  "updated_at": "<string>",
  "workflow_id": "186522a6-e697-4e34-8498-eee961bcb845"
}

Authorizations

​
Authorization
string
header
required

Use the Bearer scheme with a valid JWT token to authenticate requests. Example: Authorization: Bearer <token>

Path Parameters

​
id
string
required

ID of the job to fetch.

Example:

"5b45453c-cdd0-11ed-afa1-0242ac120002"

Response

200 - application/json

OK

​
args
object

Any additional arguments that might be used by workflow actions.

​
attachments
Attachments · object[]

Any attachments that have been generated while processing the job in the workflow will be here.

​
completed_at
string

When this job was completed, will be nil if still ongoing.

​
created_at
string

When the job was created.

​
envelope
object

Raw JSON data of the complete GOBL Envelope.

​
faults
Faults · object[]

Array of fault objects that represent errors that occurred during the processing of the job.

​
id
string

The UUID v7 or v1 of the job

Example:

"5b45453c-cdd0-11ed-afa1-0242ac120002"

​
intents
Intents · object[]

Array of intent objects following the execution of each of the steps of the associated workflow.

​
key
string

Key assigned to the job, used to identify it in the system.

​
silo_entry_id
string
Example:

"75fa764a-cdd0-11ed-afa1-0242ac120002"

​
status
string

Last known status text for this job.

​
tags
string[]

Any tags that may be useful to be associated with the job.

​
updated_at
string

When the job was last updated.

​
workflow_id
string
Example:

"186522a6-e697-4e34-8498-eee961bcb845"