Get time entries

GET /api/v1/time-entry/{trackable_type}/{trackable_uuid}

Headers

Path parameters

Query parameters

  • filter[uuid] string

    Filter by a comma separated list of UUIDs.

  • filter[accounts] string

    Time entries owned by account UUIDs, comma separated list. Do not include if getting time entries for current user.

  • filter[circle_uuids] string

    Comma separated string of circle UUIDs to filter by.

  • filter[between] string

    array Time entries started between the dates chosen, comma separated in format of Y-m-d.

  • sort string

    Field to sort by. Valid fields are [created_at, start_date, end_date]. Negative sign to denote DESC. Defaults to '-end_date'.

  • per_page integer

    Number of results to return with pagination (Default 15. Max 500).

Responses

  • 200 application/json
    Hide response attribute Show response attribute object
    • data array[object]

      Additional properties are allowed.
GET /api/v1/time-entry/{trackable_type}/{trackable_uuid} 
curl \
 -X GET https://api.plannrcrm.com/api/v1/time-entry/trackable_type/trackable_uuid \
 -H "Authorization: Bearer {OAUTH_ACCESS_TOKEN or PERSONAL_ACCESS_TOKEN}" \
 -H "Content-Type: application/json" \
 -H "Accept: application/json"
Response examples (200) 
{
  "data": [
    {
      "name": "Research",
      "uuid": "edb9f530-528f-46c1-8aac-5b7d9425b22c",
      "account": {
        "name": "Gareth Thompson",
        "role": "client",
        "type": "client",
        "uuid": "60fc053b-de19-4056-802d-f2698db040d5",
        "email": "gareth@codepotato.co.uk",
        "last_name": "Thompson",
        "photo_url": "https://eu.ui-avatars.com/api/?name=Gareth+Thompson",
        "created_at": "2025-01-17T11:18:30+00:00",
        "first_name": "Gareth",
        "updated_at": "2025-01-17T11:18:30+00:00",
        "external_references": "App\\Http\\Resources\\ExternalReferenceResource"
      },
      "end_date": "2025-01-17T10:56:30+00:00",
      "is_active": true,
      "trackable": {
        "name": "Gareth Thompson",
        "role": "client",
        "type": "client",
        "uuid": "1986e3b9-70b3-4856-8c12-add6dd0fc378",
        "email": "gareth@codepotato.co.uk",
        "last_name": "Thompson",
        "photo_url": "https://eu.ui-avatars.com/api/?name=Gareth+Thompson",
        "created_at": "2025-01-17T11:18:30+00:00",
        "first_name": "Gareth",
        "updated_at": "2025-01-17T11:18:30+00:00",
        "external_references": "App\\Http\\Resources\\ExternalReferenceResource"
      },
      "created_at": "2025-01-17T11:18:30+00:00",
      "start_date": "2025-01-17T10:28:30+00:00",
      "updated_at": "2025-01-17T11:18:30+00:00",
      "description": "This is a description.",
      "trackable_type": "Client",
      "total_time_in_minutes": 28,
      "computed_time_elapsed_in_seconds": 1680
    }
  ]
}