Podio API Documentation
Tasks: Get task
Returns the task with the given id.
Usage
- PHP Client
-
PodioTask.php
PodioTask::get( $task_id ); - Ruby Gem
-
task.rb
Podio::Task.find( id, options = {} )
Parameters
- task_id*
- Required.
Response
{
"task_id": The id of the task,
"external_id": The external id associated with the task,
"status": The status of the task (see area for possible values),
"text": The text of the task,
"description": The description of the task, if any,
"private": True if the task is private, false otherwise,
"due_date": The due date of the task, if any (in local time),
"due_time": The due time of the task, if any (in local time),
"due_on": The due date and time of the task, if any (in UTC),
"space_id": The id of the space,
"responsible": The user responsible for the task,
{
"user_id": The id of the user,
"avatar": The avatar of the user,
"name": The name of the user
},
"link": The link to the task,
"created_on": The date and time the task was created,
"created_by": The entity who created the task,
"created_via": Through which client the task was created,
"completed_on": When the task was completed, if any,
"completed_by": The entity who completed the task,
"completed_via": Through which client the task was completed,
"deleted_on": When the task was deleted, if any,
"deleted_by": The entity who deleted the task,
"deleted_via": Through which client the task was deleted,
"is_liked": True if the active user liked the task, false otherwise,
"like_count": The number of users who liked the task,
"subscribed": True if the active user is subscribed to updates, false otherwise,
"subscribed_count": The number of users subscribed to the status,
"push": Details about the push channel
{
"channel": The name of the channel for the push service,
"signature": The signature for the channel,
"timestamp": The timestamp of the signature
},
"ref": The reference of the task, if any
{
"type": The type of the reference,
"id": The id of the reference,
"title": The title of the reference,
"link": The link to the reference,
"data": The data of the reference, depends on the type of reference
},
"files": The files on the comment,
[
{
"file_id": The id of the file,
"name": The name of the file,
"description": The description of the file,
"mimetype": The type of the file, see the area for allowed types,
"size": The size of the file in bytes,
}
... (more files)
],
"labels": The active users labels attached to the task
[
{
"label_id": The id of the label,
"text": The name of the label,
"color": The hex color of the label
},
... (more labels)
],
"reminder": The active reminder a user has on this task
{
"remind_delta": Minutes to remind before the due_date
},
"recurrence": The recurrence for the task, if any,
{
"name": The name of the recurrence, "weekly", "monthly" or "yearly",
"config": The configuration for the recurrence, depends on the type
{
"days": List of weekdays (for "weekly"),
"repeat_on": When to repeat, "day_of_week" or "day_of_month" (for "monthly")
},
"step": The step size, 1 or more,
"until": The latest date the recurrence should take place
},
"comments": The comments on the task,
[
{
"comment_id": The id of the comment. Can be used to update and delete the comment,
"value": The actual comment,
"external_id": The external id set on the comment, if any,
"created_by": The entity who created the comment,
"created_via": The interface through which the comment was created,
"created_on": The date and time the comment was created,
"files": The files on the comment,
[
{
"file_id": The id of the file,
"name": The name of the file,
"description": The description of the file,
"mimetype": The type of the file, see the area for allowed types,
"size": The size of the file in bytes,
}
... (more files)
]
},
... (more comments)
]
}
Sandbox
Try the operation "/task/{task_id}"You can simulate the API request by filling out the arguments below, and press the submit button to see the response.
You need to be logged in to Podio to use the Sandbox. Login here