Command Palette

Search for a command to run...

Log In

List all Tasks for a Goal

get/public/v1/goals/{goal}/tasks
  • Authorizationstringrequired

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

  • goalstringrequired

    The goal UUID

  • sortstring

    Sort the results. Prefix with '-' for descending. One of: start_time.

    Example:-start_time
  • page[size]integer

    Number of results per page. Minimum 1, maximum 100.

    Default:25
  • page[number]integer

    The page number to retrieve. Use the last_page value from the meta response to determine the total number of pages available.

    Default:1

Response

200application/json

Paginated set of TaskResource

  • dataobject[]required
    ▶Show 8 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 attributes
      • idstringrequired
        Example:p1a2r3t4-c5d6-47e8-9f0a-1b2c3d4e5f6a
      • namestringrequired
        Example:John Doe
    • userobject | nullrequired
      ▶Show 3 child attributes
      • idstringrequired
        Example:u1s2e3r4-a5b6-47c8-9d0e-1f2a3b4c5d6e
      • namestringrequired
        Example:John Doe
      • emailstringrequired
        Example:john.doe@example.com
  • metaobjectrequired
    ▶Show 5 child attributes
    • current_pageintegerrequired≥ 1
    • last_pageintegerrequired≥ 1
    • per_pageintegerrequired≥ 0

      Number of items shown per page.

    • totalintegerrequired≥ 0

      Total number of items being paginated.

    • allowed_sortsstring[]required

      The list of allowed sorts for this endpoint.

  • 401Unauthenticated
  • 403Authorization error
  • 404Not found