Get a Task

get/public/v1/tasks/{task}

get/public/v1/tasks/{task}

curl --request GET \
  --url 'https://api.app.astalty.com.au/public/v1/tasks/{task}' \
  --header 'Authorization: Bearer YOUR_API_KEY' \
  --header 'Accept: application/json'

Response

{
  "data": {
    "id": "t1a2s3k4-b5c6-47d8-9e0f-1a2b3c4d5e6f",
    "title": "Support Coordination Meeting",
    "completed": true,
    "billable": true,
    "start_time": "2024-01-15T10:30:00+00:00",
    "duration": 60,
    "participant": {
      "id": "p1a2r3t4-c5d6-47e8-9f0a-1b2c3d4e5f6a",
      "name": "John Doe"
    },
    "user": {
      "id": "u1s2e3r4-a5b6-47c8-9d0e-1f2a3b4c5d6e",
      "name": "John Doe",
      "email": "john.doe@example.com"
    },
    "charges": [
      {
        "id": "c1h2a3r4-g5e6-47f8-9a0b-1c2d3e4f5a6b",
        "date": "2024-01-15T10:30:00+00:00",
        "quantity": 1.5,
        "is_primary": true,
        "unit_cost": 5000,
        "total_cost": 7500,
        "status": "pending",
        "support_item_number": "07_002_0106_8_3",
        "charge_item": {
          "id": "c1h2a3r4-g5e6-47i8-9b0c-1d2e3f4a5b6c",
          "reference": "SUPPORT_COORD_L2",
          "number": "07_001_0106_8_3",
          "name": "Support Coordination Level 2",
          "unit": "H",
          "price": 10044,
          "gst_code": "P2",
          "default_claim_type": "Direct",
          "archived_at": null
        }
      }
    ],
    "goals": [
      {
        "id": "g1o2a3l4-d5e6-47f8-9a0b-1c2d3e4f5a6b",
        "name": "Improve social interactions",
        "status": "active"
      }
    ],
    "documents": [
      {
        "id": "d1c2e3f4-a5b6-47c8-9d0e-1f2a3b4c5d6e",
        "name": "Service Agreement",
        "file_extension": "pdf",
        "created_at": "2024-01-15T10:30:00+00:00"
      }
    ]
  }
}

Authorization

Authorizationstringrequired
Bearer authentication header of the form Bearer <token>, where <token> is your API key. See How to set up an API key.

Path parameters

taskstringrequired
The task UUID

Response

200application/json

TaskResource

dataobjectrequired
▶Show 11 child attributesHide child attributes
- idstringrequired
  Example:t1a2s3k4-b5c6-47d8-9e0f-1a2b3c4d5e6f
- titlestringrequired
  Example:Support Coordination Meeting
- completedbooleanrequired
  Example:true
- billablebooleanrequired
  Example:true
- start_timestringrequired
  Example:2024-01-15T10:30:00+00:00
- durationintegerrequired
  Example:60
- participantobject | nullrequired
  ▶Show 2 child attributesHide child attributes
  idstringrequired
  Example:p1a2r3t4-c5d6-47e8-9f0a-1b2c3d4e5f6a
  namestringrequired
  Example:John Doe
- userobject | nullrequired
  ▶Show 3 child attributesHide child attributes
  idstringrequired
  Example:u1s2e3r4-a5b6-47c8-9d0e-1f2a3b4c5d6e
  namestringrequired
  Example:John Doe
  emailstringrequired
  Example:john.doe@example.com
- chargesobject[]required
  ▶Show 9 child attributesHide child attributes
  idstringrequired
  Example:c1h2a3r4-g5e6-47f8-9a0b-1c2d3e4f5a6b
  datestringrequired
  Example:2024-01-15T10:30:00+00:00
  quantitynumber | nullrequired
  Example:1.5
  is_primarybooleanrequired
  Example:true
  unit_costintegerrequired
  Example:5000
  total_costintegerrequired
  Example:7500
  statusstringrequired
  Example:pending
  support_item_numberstringrequired
  Example:07_002_0106_8_3
  charge_itemobject | nullrequired
  ▶Show 9 child attributesHide child attributes
  idstringrequired
  Example:c1h2a3r4-g5e6-47i8-9b0c-1d2e3f4a5b6c
  referencestringrequired
  Example:SUPPORT_COORD_L2
  numberstringrequired
  Example:07_001_0106_8_3
  namestringrequired
  Example:Support Coordination Level 2
  unitstringrequired
  Example:H
  priceintegerrequired
  Example:10044
  gst_codestringrequired
  Example:P2
  default_claim_typestring | nullrequired
  Example:Direct
  archived_atstring | nullrequired
- goalsobject[]required
  ▶Show 3 child attributesHide child attributes
  idstringrequired
  Example:g1o2a3l4-d5e6-47f8-9a0b-1c2d3e4f5a6b
  namestringrequired
  Example:Improve social interactions
  statusstringrequired
  Example:active
- documentsobject[]required
  ▶Show 4 child attributesHide child attributes
  idstringrequired
  Example:d1c2e3f4-a5b6-47c8-9d0e-1f2a3b4c5d6e
  namestringrequired
  Example:Service Agreement
  file_extensionstringrequired
  Example:pdf
  created_atstringrequired
  Example:2024-01-15T10:30:00+00:00

Errors

401Unauthenticated
403Authorization error
404Not found

Command Palette

Authorization

Path parameters

Response

Errors