Retrieve a page of todo's for a contact

GET /todo/profile/{user_id}/{unique_id}/{page}
OAuth2

When you need the list of todo's for a specific contact. Note that currently the user_id is the same id as logged in user.

Path parameters

  • user_id integer Required

    the user id making the request

  • unique_id integer Required

    the user id about whom the request is being made

  • page integer Required

    the page requested - starting at 1

Responses

  • 200 application/json

    OK

    Hide response attributes Show response attributes object
    • items array[object]
      Hide items attributes Show items attributes object
      • id integer

        id of the To Do

      • unique_id integer

        id of the person to whom this todo is applicable to

      • added_by_workflow_step_id integer

        when a todo is triggered by a workflow, this identifies the step that triggered it

      • added_by_workflow_step_action_id integer

        when a todo is triggered by a workflow, this identifies the trigger that triggered it

      • created_by array[object]
        Hide created_by attributes Show created_by attributes object
        • unique_id integer

          id of the person who created this to do

        • name string

          name of the person who create this to do

        • date string

          the date time this todo was created

        • date_show string

          the date time this todo was created in display format

      • task string

        title of the to do

      • description string

        description of the to do

      • todo array[object]
        Hide todo attributes Show todo attributes object
        • by string

          Who is tasked to do this

          Values are Me, Group, or People.

        • by_text string

          decoded list of group or people to do this

      • when array[object]
        Hide when attributes Show when attributes object
        • type string

          Whether its On or By the specified date

          Values are On or By.

        • date string

          the date this task needs to be done on/by

        • date_show string

          the display format of the date this task needs to be done on/by

      • permissions array[object]
        Hide permissions attributes Show permissions attributes object
        • edit string

          whether the logged in user can edit this todo

          Values are Y or N.

        • delete string

          whether the logged in user can delete this todo

          Values are Y or N.

    • paging object

      Additional properties are allowed.

      Hide paging attributes Show paging attributes object
GET /todo/profile/{user_id}/{unique_id}/{page} 
curl \
 -X GET https://YOURSITE.infoodle.com/apiv2/todo/profile/1234/1234/1 \
 -H "Authorization: Bearer $ACCESS_TOKEN"
Response examples (200) 
{
  "items": [
    {
      "id": 99,
      "unique_id": 123,
      "added_by_workflow_step_id": 321,
      "added_by_workflow_step_action_id": 321,
      "created_by": [
        {
          "unique_id": 1355,
          "name": "john smith",
          "date": "2024-04-31 12:13:14",
          "date_show": "31st April 2024 12:13:14"
        }
      ],
      "task": "make a phone call",
      "description": "call them and ask them how they are",
      "todo": [
        {
          "by": "Me",
          "by_text": "Me"
        }
      ],
      "when": [
        {
          "type": "On",
          "date": "2018-12-05",
          "date_show": "5th December 2018"
        }
      ],
      "permissions": [
        {
          "edit": "Y",
          "delete": "Y"
        }
      ]
    }
  ],
  "paging": {
    "total": 1,
    "pages": 1,
    "thispage": 1,
    "firstpage": 1,
    "initialpage": "string",
    "finalpage": "string",
    "lastpage": 1,
    "shown_on_this_page": 1
  }
}