Fetching Data

Project details

Fetch available projects

Fetch list of projects

URI: https://<im4>/projects/{'updated'?}/{agency_id?}
?days={days?}
?minutes={minutes?}
?search={search?}
?take={take?}&skip={skip?}
  • Request-type: GET
  • Parameters:
    {'updated'} (part of URI) (optional):Since 0.27 If 'updated' included - sort by, take and days use updated_at instead of created_at
    {agency_id} (part of URI) (optional): Agency - fallback to client agency + collaborating agencies
    {days} (integer) (default 120): Days to include - skipped if minutes, search or take set
    {minutes} (integer) : Since 0.28 Minutes to include - skipped if search or take set
    {search} (string): Multi-word search – if specified, days and minutes are ignored.
    {take} (integer): Limit result – used for paging – if specified, days and minutes are ignored.
    {skip} (integer): Skip first x results – used for paging – will only work if take specified
  • Return data:{mixed} (JSON)
If user has access to multiple agencies – projects in all agencies will be returned unless agency_id is specified

Fetch all project details

Fetche all project info (as defined in valid project keys) as JSON data.

URI: https://<im4>/project/{projectId}
  • Request-type: GET
  • Parameters: {projectId} (part of URI): ID of the project
  • Return data: {project} (JSON)

Fetch specific project details

Fetch project data as JSON - either the entire data set, a specific key, or a set of comma separated keys (see list of valid project keys)

URI: https://<im4>/project/{projectId}/{key|keys}
  • Request-type: GET
  • Parameters:
    {projectId} (part of URI): ID of the project
    {key} (part of URI): valid project key to be fetched
    {keys} (part of URI): valid comma separated project keys to be fetched
  • Return data:{mixed} (JSON)