JobTread

App · 20 actions

Read jobs, tasks, documents and contacts; create and manage customer and vendor accounts.

Actions

ActionWhat it does
Create accountCreate account.
Create contactCreate contact.
Delete accountDelete account.
Delete contactDelete contact.
Get accountGet account.
Get contactGet contact.
Get current grantGet current grant.
Get documentGet document.
Get jobGet job.
Get locationGet location.
Get organizationGet organization.
Get taskGet task.
List accountsList accounts.
List contactsList contacts.
List documentsList documents.
List jobsList jobs.
List locationsList locations.
List tasksList tasks.
Update accountUpdate account.
Update contactUpdate contact.

Create account

Create account.

Inputs

Archivearchivetrue/false
Returned value.
Is taxableis_taxabletrue/false
Returned value.
NamenametextRequired
Returned value.
Notifynotifytrue/false
Returned value.
Organization IDorganization_idtextRequired
Returned value.
Suffix if necessarysuffix_if_necessarytrue/false
Returned value.
TypetypetextRequired
Returned value.One of: customer, vendor.

Outputs

dataobject
Returned value.
Example output
{
  "data": {
    "createdAccount": {
      "id": "example",
      "name": "example"
    }
  }
}

Create contact

Create contact.

Inputs

Account IDaccount_idtextRequired
Returned value.
NamenametextRequired
Returned value.
Titletitletext
Returned value.

Outputs

dataobject
Returned value.
Example output
{
  "data": {
    "createdContact": {
      "id": "example",
      "name": "example"
    }
  }
}

Delete account

Delete account.

Inputs

IdidtextRequired
Returned value.

Outputs

dataobject
Returned value.
Example output
{
  "data": {}
}

Delete contact

Delete contact.

Inputs

IdidtextRequired
Returned value.

Outputs

dataobject
Returned value.
Example output
{
  "data": {}
}

Get account

Get account.

Inputs

Account IDaccount_idtextRequired
Account ID.

Outputs

dataobject
Returned value.
Example output
{
  "data": {
    "account": {
      "createdAt": "example",
      "description": "example",
      "id": "example",
      "name": "example",
      "number": "example",
      "timeZone": "example"
    }
  }
}

Get contact

Get contact.

Inputs

Contact IDcontact_idtextRequired
Contact ID.

Outputs

dataobject
Returned value.
Example output
{
  "data": {
    "contact": {
      "createdAt": "example",
      "description": "example",
      "id": "example",
      "name": "example",
      "number": "example",
      "timeZone": "example"
    }
  }
}

Get current grant

Get current grant.

Inputs

None.

Outputs

dataobject
Returned value.
Example output
{
  "data": {
    "currentGrant": {
      "id": "example",
      "organization": {
        "id": "example",
        "name": "example"
      }
    }
  }
}

Get document

Get document.

Inputs

Document IDdocument_idtextRequired
Document ID.

Outputs

dataobject
Returned value.
Example output
{
  "data": {
    "document": {
      "createdAt": "example",
      "description": "example",
      "id": "example",
      "name": "example",
      "number": "example",
      "timeZone": "example"
    }
  }
}

Get job

Get job.

Inputs

Job IDjob_idtextRequired
Job ID.

Outputs

dataobject
Returned value.
Example output
{
  "data": {
    "job": {
      "createdAt": "example",
      "description": "example",
      "id": "example",
      "name": "example",
      "number": "example",
      "timeZone": "example"
    }
  }
}

Get location

Get location.

Inputs

Location IDlocation_idtextRequired
Location ID.

Outputs

dataobject
Returned value.
Example output
{
  "data": {
    "location": {
      "createdAt": "example",
      "description": "example",
      "id": "example",
      "name": "example",
      "number": "example",
      "timeZone": "example"
    }
  }
}

Get organization

Get organization.

Inputs

Organization IDorganization_idtextRequired
Organization ID.

Outputs

dataobject
Returned value.
Example output
{
  "data": {
    "organization": {
      "createdAt": "example",
      "description": "example",
      "id": "example",
      "name": "example",
      "number": "example",
      "timeZone": "example"
    }
  }
}

Get task

Get task.

Inputs

Task IDtask_idtextRequired
Task ID.

Outputs

dataobject
Returned value.
Example output
{
  "data": {
    "task": {
      "createdAt": "example",
      "description": "example",
      "id": "example",
      "name": "example",
      "number": "example",
      "timeZone": "example"
    }
  }
}

List accounts

List accounts.

Inputs

Organization IDorganization_idtextRequired
Organization ID.
Pagepagetext
Page.
Sizesizenumber
Returned value.From 1 to 100.

Outputs

dataobject
Returned value.
Example output
{
  "data": {
    "organization": {
      "accounts": {
        "nextPage": "example",
        "nodes": []
      }
    }
  }
}

List contacts

List contacts.

Inputs

Organization IDorganization_idtextRequired
Organization ID.
Pagepagetext
Page.
Sizesizenumber
Returned value.From 1 to 100.

Outputs

dataobject
Returned value.
Example output
{
  "data": {
    "organization": {
      "contacts": {
        "nextPage": "example",
        "nodes": []
      }
    }
  }
}

List documents

List documents.

Inputs

Organization IDorganization_idtextRequired
Organization ID.
Pagepagetext
Page.
Sizesizenumber
Returned value.From 1 to 100.

Outputs

dataobject
Returned value.
Example output
{
  "data": {
    "organization": {
      "documents": {
        "nextPage": "example",
        "nodes": []
      }
    }
  }
}

List jobs

List jobs.

Inputs

Organization IDorganization_idtextRequired
Organization ID.
Pagepagetext
Page.
Sizesizenumber
Returned value.From 1 to 100.

Outputs

dataobject
Returned value.
Example output
{
  "data": {
    "organization": {
      "jobs": {
        "nextPage": "example",
        "nodes": []
      }
    }
  }
}

List locations

List locations.

Inputs

Organization IDorganization_idtextRequired
Organization ID.
Pagepagetext
Page.
Sizesizenumber
Returned value.From 1 to 100.

Outputs

dataobject
Returned value.
Example output
{
  "data": {
    "organization": {
      "locations": {
        "nextPage": "example",
        "nodes": []
      }
    }
  }
}

List tasks

List tasks.

Inputs

Organization IDorganization_idtextRequired
Organization ID.
Pagepagetext
Page.
Sizesizenumber
Returned value.From 1 to 100.

Outputs

dataobject
Returned value.
Example output
{
  "data": {
    "organization": {
      "tasks": {
        "nextPage": "example",
        "nodes": []
      }
    }
  }
}

Update account

Update account.

Inputs

Archivearchivetrue/false
Returned value.
IdidtextRequired
Returned value.
Is taxableis_taxabletrue/false
Returned value.
Namenametext
Returned value.
Notifynotifytrue/false
Returned value.

Outputs

dataobject
Returned value.
Example output
{
  "data": {}
}

Update contact

Update contact.

Inputs

IdidtextRequired
Returned value.
Namenametext
Returned value.
Titletitletext
Returned value.

Outputs

dataobject
Returned value.
Example output
{
  "data": {}
}

On this page