Podio API Documentation
Applications: Get app
Gets the definition of an app and can include configuration and fields. This method will always return the latest revision of the app definition.
Usage
- PHP Client
-
PodioApp.php
PodioApp::get( $app_id, $attributes = array() ); - Ruby Gem
-
application.rb
Podio::Application.find( app_id, options = {} )
Parameters
- app_id*
- Required.
Response
Full
{
"app_id": The id of the app,
"original": The original app that this app was a copy of,
"original_revision": The revision of the original app at the time of copy,
"status": The status of the app, either "active", "inactive" or "deleted".
"space_id": The id of the space on which the app is placed,
"token": The app token to use when logging in as an app,
"mailbox": The mailbox to use when mailing to the app,
"owner": The owner of the app, which has special access to the app
{
"user_id": The id of the owner,
"avatar": The avatar of the owner,
"name": The full name of the owner
},
"config": The current configuration of the app,
{
"type": The type of the app, either "standard", "meeting" or "contact",
"name": The name of the app,
"item_name": The name of each item in an app,
"description": The description of the app,
"usage": Description of how the app should be used,
"external_id": The external id of the app. This can be used to store an id from an external system on the app,
"icon": The name of the icon used to represent the app,
"allow_edit": True if other members are allowed to edit items from the app, false otherwise,
"default_view": The default view of the app items on the app main page (see area for more information),
"allow_attachments": True if attachment of files to an item is allowed, false otherwise,
"allow_comments": True if members can make comments on an item, false otherwise,
"silent_creates": True if item creates should not be posted to the stream, false otherwise,
"silent_edits": True if item edits should not be posted to the stream, false otherwise,
"fivestar": True if fivestar rating is enabled on an item, false otherwise,
"fivestar_label": If fivestar rating is enabled, this is the label that will be presented to the users,
"approved": True if an item can be approved, false otherwise,
"thumbs": True if an item can have a thumbs up or thumbs down, false otherwise,
"thumbs_label": If thumbs ratings are enabled, this is the label that will be presented to the users,
"rsvp": True if RSVP is enabled, false otherwise,
"rsvp_label": If RSVP is enabled, this is the label that will be presented to the users,
"yesno": True if yes/no rating is enabled, false otherwise,
"yesno_label": If yes/no is enabled, this is the label that will be presented to the users,
"tasks": The automatic tasks that are created when an item in the app is created,
[
{
"text": The text to use for the task,
"responsible": The list of responsible for the task,
[
{
"user_id": The id of the user,
"avatar": The file id of the avatar of the user,
"name": The full name of the user
},
... (more responsible)
]
},
... (more tasks)
]
},
"integration": The current status of the integration, if any,
{
"status": The status of the integration, either "inactive", "active", "disabled", or "error".
"type": The type of the integration, see the integration area for details,
"updating": True if the integration is currently updating, false otherwise,
"last_updated_on": The date and time of the last update,
"next_refresh_on": The date and time when the integration will be refreshed
},
"rights": The array of rights the active user has on the app,
"fields":
[
{
"field_id": The id of the field,
"type": The type of the field (see area for more information),
"external_id": External id automatically generated that will never change,
"config": The configuration of the field,
{
"label": The label of the field, which is what the users will see,
"description": The description of the field, shown to the user when inserting and editing,
"delta": An integer indicating the order of the field compared to other fields,
"settings": The settings of the field which depends on the type of the field (see area for more information),
"mapping": The mapping of the field, one of "meeting_time", "meeting_participants", "meeting_agenda" and "meeting_location" for type="meeting" and "contact_name","contact_job_title","contact_organization","contact_email","contact_phone","contact_address","contact_website","contact_notes","contact_image" for type="contact"
"required": True if the field is required when creating and editing items, false otherwise
}
},
......
],
"subscribed": True if the user is subscribed to the app, false otherwise
}
Short
{
"app_id": The id of the app,
"original": The original app that this app was a copy of,
"original_revision": The revision of the original app at the time of copy,
"status": The status of the app, either "active", "inactive" or "deleted".
"space_id": The id of the space on which the app is placed,
"owner": The owner of the app, which has special access to the app
{
"user_id": The id of the owner,
"avatar": The avatar of the owner,
"name": The full name of the owner
},
"link": The URL to the app,
"link_add": The URL to add a new item to the app,
"config": The current configuration of the app,
{
"type": The type of the app, either "standard", "meeting" or "contact",
"name": The name of the app,
"item_name": The name of each item in an app,
"description": The description of the app,
"usage": Description of how the app should be used,
"external_id": The external id of the app. This can be used to store an id from an external system on the app,
"icon": The name of the icon used to represent the app,
"allow_edit": True if other members are allowed to edit items from the app, false otherwise,
"default_view": The default view of the app items on the app main page (see area for more information),
"allow_attachments": True if attachment of files to an item is allowed, false otherwise,
"allow_comments": True if members can make comments on an item, false otherwise,
"fivestar": True if fivestar rating is enabled on an item, false otherwise,
"fivestar_label": If fivestar rating is enabled, this is the label that will be presented to the users,
"approved": True if an item can be approved, false otherwise,
"thumbs": True if an item can have a thumbs up or thumbs down, false otherwise,
"thumbs_label": If thumbs ratings are enabled, this is the label that will be presented to the users,
"rsvp": True if RSVP is enabled, false otherwise,
"rsvp_label": If RSVP is enabled, this is the label that will be presented to the users,
"yesno": True if yes/no rating is enabled, false otherwise,
"yesno_label": If yes/no is enabled, this is the label that will be presented to the users,
"tasks": A comma separated list of the tasks that will automatically be created when a new item is added
}
}
Mini
{
"app_id": The id of the app,
"status": The status of the app, either "active", "inactive" or "deleted".
"space_id": The id of the space on which the app is placed,
"link": The URL to the app,
"link_add": The URL to add a new item to the app,
"config": The current configuration of the app,
{
"type": The type of the app, either "standard", "meeting" or "contact",
"name": The name of the app,
"item_name": The name of each item in an app,
"description": The description of the app,
"usage": Description of how the app should be used,
"external_id": The external id of the app. This can be used to store an id from an external system on the app,
"icon": The name of the icon used to represent the app,
"allow_edit": True if other members are allowed to edit items from the app, false otherwise
}
}
Micro
{
"app_id": The id of the app,
"name": The name of the app,
"item_name": The name of each item in an app,
"icon": The name of the icon used to represent the app
}
Sandbox
Try the operation "/app/{app_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