Podio API Documentation
Items: Get item
Returns the item with the specified id.
Usage
- PHP Client
-
PodioItem.php
PodioItem::get( $item_id ); - Ruby Gem
-
item.rb
Podio::Item.find( id )
Parameters
- item_id*
- Required.
- mark_as_viewed
If true marks any new notifications on the given item as viewed, otherwise leaves any notifications untouched
Default value: true
Response
{
"item_id": The id of the item,
"app": The app where the item belongs,
{
"app_id": The id of the app,
"name": The name of the app,
"item_name": The name of an item in the app,
"icon": The icon for the app
},
"external_id": The external id of the item. This can be used to hold a reference to the item in an external system.
"created_by": The entity who created the item,
"created_via": Through which client the item was created,
"created_on": When the item was created,
"initial_revision": The information on who created the first revision of the item
{
"revision": The revision number,
"app_revision": The revision of the app at the time this item revision was made,
"created_by": The entity who made the revision,
"created_via": Through which client the revision was made,
"created_on": When the revision was created
},
"current_revision": The latest revision, contains the same as the initial_revision field,
"last_event_on": The date and time of the last activity,
"title": The title of the item. This is made of up one of the fields below, or by the item name and id,
"link": The full link to the item,
"rights": The list of rights the active user has on the item,
"fields": Each field for which there are values in the correct order,
[
{
"field_id": The id of the field,
"type": The type of the field,
"external_id": The external id of the field,
"config": The configuration of the field
{
"label": The label of the field,
"description": The description of the field,
"delta": The order of the field,
"settings": The settings on the field, depends on the type of field,
"required": True if the field is required, false otherwise
},
"values": The values for the field,
[
{
"{sub_id}":"{value}",
.... (more sub values)
},
.... (more values)
]
},
... (more fields)
],
"participants": The participants, if app is of type meeting
{
"{profile_id"}:
{
"status": The status for the given profile, either "invited", "accepted", "declined" or "tentative"
}
... (more profiles)
},
"reminder": The active reminder a user has on this meeting
{
"reminder_id": The id of the reminder,
"remind_delta": Minutes to remind before the due_date
},
"recurrence": The recurrence for the meeting, 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
},
"linked_account_id": The linked account used for the meeting,
"linked_account_data": The data about the meeting
{
"type": The type of meeting, f.ex. "gotomeeting",
"id": The external id of the meeting,
"info": Information about the meeting,
"url": The URL to join the meeting
},
"ref": The reference the item is attached to, 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 associated with the reference, depends on the type of reference
},
"revisions": The latest 8 revisions of the item sorted descending by date
[
{
"revision": The revision number,
... (see the get revisions operation for details)
}
]
"comments": The comments on the item,
[
{
"comment_id": The id of the comment,
... (see the get comment operation for details)
},
... (more comments)
],
"ratings": The ratings on the item
{
... See the get all ratings operation for details,
},
"files": The files on the status
[
{
"file_id": The id of the file,
... (see the get file operation for details)
},
... (more files)
],
"refs": The counts of items that reference this item
[
{
"app": The app the reference is from
{
"app_id": The id of the app,
"name": The name of the app,
"item_name": The name for items in the app,
"icon": The icon of the app,
"url_label": The URL label of the app
},
"field": The field that references the item,
{
"field_id": The id of the field,
"type": The type of field (always "app"),
"status": The status of the field ("active" or "deleted"),
"label": The label of the field
},
"count": The total number of items
},
... (more references)
],
"tags": The tags on the item
[
{tag}: The text of the tag
... (more tags)
],
"subscribed": True if the active user is subscribed to updates, false otherwise,
"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
},
"user_ratings": The ratings of the active user on the object,
{
"{type}": The value of the rating of the given type,
... (more types)
},
"invite": Invitation details if the user was invited to this item
{
"invited_by": The profile of the inviter,
"subject": The subject of the invitation.
"message": The message of the invitation
}
"excerpt": A summary of the item, if the item has a suitable value
{
"label": The label of the field the excerpt is taken from,
"text": The excerpt text, e.g. the name for a contact, date string for a date field etc.
}
}
The values field can f.ex. look like this:
{
....,
"fields":
[
{
"field_id": 1,
"type": "state",
"label": "Is hired?",
"values":
[
{
"value": "yes"
},
{
"value": "no"
}
],
},
{
"field_id": 2,
"type": "date",
"label": "First work day",
"values":
[
{
"start": "2010-08-04 09:00:00",
"end": "2010-08-04 10:00:00"
}
]
}
}
}
Sandbox
Try the operation "/item/{item_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