Password https://app paymoapp com/api/projects


Download 47.25 Kb.
NamePassword https://app paymoapp com/api/projects
A typeUser
1. Overview

Paymo 3 API base URL: https://app.paymoapp.com/api/

The API is RESTful (http://en.wikipedia.org/wiki/Representational_State_Transfer)

Request types: GET, POST, PUT, DELETE
2. Authentication

a) Basic HTTP Authentication (http://en.wikipedia.org/wiki/Basic_access_authentication)

Example:

$ curl -u user@domain.com:password https://app.paymoapp.com/api/projects

or

$ curl -H "Authorization: Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ==" https://app.paymoapp.com/api/projects
b) Using header `X-Session` to send a session ID during API request

$ curl -H "X-Session: a398ff952557f5bff855cf0dcabd36ad" https://app.paymoapp.com/api/projects

If you use Basic HTTP Auth, you can get your active sessions by making a GET request to: https://app.paymoapp.com/api/sessions

or you can create one by making a POST request to: https://app.paymoapp.com/api/sessions
3. Request/Response content types:

You can ask for the response to be in a specific format by sending the header `Accept`, e.g. `Accept: application/json`. The default response format is `text/xml`.

For POST/PUT requests, you can send the data in json format by sending the header `Content-Type: application/json`, or as a web browser with `Content-Type: application/x-www-form-urlencoded`.
3. Paymo 3 Resources

https://app.paymoapp.com/api/sessions

https://app.paymoapp.com/api/company

https://app.paymoapp.com/api/me

https://app.paymoapp.com/api/clients

https://app.paymoapp.com/api/clientcontacts

https://app.paymoapp.com/api/projects

https://app.paymoapp.com/api/tasklists

https://app.paymoapp.com/api/tasks

https://app.paymoapp.com/api/entries

https://app.paymoapp.com/api/discussions

https://app.paymoapp.com/api/threads

https://app.paymoapp.com/api/comments

https://app.paymoapp.com/api/milestones

https://app.paymoapp.com/api/users

https://app.paymoapp.com/api/files

https://app.paymoapp.com/api/invoices

https://app.paymoapp.com/api/invoiceitems

https://app.paymoapp.com/api/invoicepayments

https://app.paymoapp.com/api/estimates

https://app.paymoapp.com/api/estimateitems

https://app.paymoapp.com/api/recurringprofiles

https://app.paymoapp.com/api/recurringprofileitems

https://app.paymoapp.com/api/expenses

https://app.paymoapp.com/api/reports

https://app.paymoapp.com/api/tags

https://app.paymoapp.com/api/projecttemplates

https://app.paymoapp.com/api/projecttemplatestasklists

https://app.paymoapp.com/api/projecttemplatestasks
You can get each object type properties by making a request to the respective URL.

Example for projects:

GET https://app.paymoapp.com/api/projects/148387

Response:
{

   "projects": [

      {

         "id": 148387,

         "name": "Sample Project",

         "description": "",

         "client_id": 54990,

         "active": false,

         "budget_hours": 0,

         "price_per_hour": 30,

         "billable": true,

         "color": null,

         "users": [

            6399

         ],

         "managers": [

            6399

         ],

         "created_on": "2010-10-23T07:26:00Z",

         "updated_on": "2013-10-23T08:21:14Z"

      }

   ]

}
4. Adding WHERE condition to requests

You can filter your lists by using the `where` param. 
Example for filtering only the active projects:

GET https://app.paymoapp.com/api/projects/?where=active%3Dtrue (condition is: "active=true" urlencoded)
You can specify multiple conditions using `and`

Example for filtering active projects from client 54990:

GET https://app.paymoapp.com/api/projects/?where=active%3Dtrue%20and%20client_id%3D54990 (condition is: "active=true and client_id=54990" urlencoded)
Operators used in `where` condition are: =, >, >=, <, <=, !=, like, in (value1,value2,...), not in (value1, value2)

Examples of `where` conditions (not urlencoded for clarity):

client_id in (123,124)

name like Sample

name="Sample Project"

price_per_hour>50
5. Including data from related objects using `include` param.

Example: for the projects, you can include the data for the parent client object:

GET https://app.paymoapp.com/api/projects/148387?include=client

Response:
{

   "projects": [

      {

         "id": 148387,

         "name": "Sample Project",

         "description": "",

         "client_id": 54990,

         "active": false,

         "budget_hours": 0,

         "price_per_hour": 30,

         "billable": true,

         "color": null,

         "users": [

            6399

         ],

         "managers": [

            6399

         ],

         "created_on": "2010-10-23T07:26:00Z",

         "updated_on": "2013-10-23T08:21:14Z",

         "client": {

            "id": 54990,

            "name": "Sample Client",

            "address": "",

            "city": "",

            "state": "",

            "postal_code": "",

            "country": "",

            "phone": "",

            "fax": "",

            "email": "",

            "website": "",

            "image": "",

            "fiscal_information": "",

            "active": true,

            "created_on": "2010-10-23T07:26:00Z",

            "updated_on": "2010-10-23T07:26:00Z"

         }

      }

   ]

}
You can also include data for the child objects. For a project, child objects are: tasklists, tasks, etc.

Example request to include all tasks for a project:

GET https://app.paymoapp.com/api/projects/148387?include=tasks

Response:
{

   "projects": [

      {

         "id": 148387,

         "name": "Sample Project",

         "description": "",

         "client_id": 54990,

         "active": false,

         "budget_hours": 0,

         "price_per_hour": 30,

         "billable": true,

         "color": null,

         "users": [

            6399

         ],

         "managers": [

            6399

         ],

         "created_on": "2010-10-23T07:26:00Z",

         "updated_on": "2013-10-23T08:21:14Z",

         "tasks": [

            {

               "id": 997943,

               "name": "Sample Task",

               "project_id": 148387,

               "tasklist_id": 247938,

               "user_id": null,

               "complete": true,

               "billable": true,

               "seq": 0,

               "description": "",

               "price_per_hour": null,

               "due_date": null,

               "budget_hours": null,

               "users": [],

               "created_on": "2010-10-23T07:26:00Z",

               "updated_on": "2012-04-25T12:50:19Z"

            },

{

               "id": 997945,

               "name": "another task",

               "project_id": 148387,

               "tasklist_id": 247938,

               "user_id": 6399,

               "complete": false,

               "billable": true,

               "seq": 1,

               "description": "",

               "price_per_hour": null,

               "due_date": null,

               "budget_hours": null,

               "users": [],

               "created_on": "2012-04-25T12:50:11Z",

               "updated_on": "2012-04-25T12:50:11Z"

            }

         ]

      }

   ]

}
You can include a part of the related object by specifying `type.field` in `include` param. 

Example to include id and name for the tasks from a project:

GET https://app.paymoapp.com/api/projects/148387?include=tasks.id,tasks.name

Response:
{

   "projects": [

      {

         "id": 148387,

         "name": "Sample Project",

         "description": "",

         "client_id": 54990,

         "active": false,

         "budget_hours": 0,

         "price_per_hour": 30,

         "billable": true,

         "color": null,

         "users": [

            6399

         ],

         "managers": [

            6399

         ],

         "created_on": "2010-10-23T07:26:00Z",

         "updated_on": "2013-10-23T08:21:14Z",

         "tasks": [

            {

               "id": 997943,

               "name": "Sample Task"

            },

            {

               "id": 997945,

               "name": "another task"

            }

         ]

      }

   ]

}
You can use `where` param together with the `include` to filter the data included.

Example of including only the tasks that are not complete:

GET https://app.paymoapp.com/api/projects?include=tasks&where=tasks.complete=%3Dfalse
6. You might want to look at the Network log in a browser debug console (such as Chrome's Developer Tools) to get an ideea of what API requests are made by the Paymo 3 application.

Share in:

Related:

Password https://app paymoapp com/api/projects iconSample Program https:/scratch mit edu/projects/95235421

Password https://app paymoapp com/api/projects iconCreate google app engine console project Sign up for Google App Engine:...

Password https://app paymoapp com/api/projects iconSigning app Note: signing the app is only necessary when you intend...

Password https://app paymoapp com/api/projects iconThese instructions are taken from the U. S. Customs and Border Patrol...

Password https://app paymoapp com/api/projects iconUser id=UserName;Password=Password

Password https://app paymoapp com/api/projects iconDownload the app To get started, make sure you are using an iPhone...

Password https://app paymoapp com/api/projects iconMedical Access Plan (map), Innovation Projects, and Planning and Implementation Projects

Password https://app paymoapp com/api/projects iconDescription of Product: Outlook Mobile app for ios is the business-class...

Password https://app paymoapp com/api/projects iconBlind Square is a combination Point of Interest poi and basic navigating...

Password https://app paymoapp com/api/projects iconIs the app name that appears to users. For this project, use "My First App."




forms and shapes


When copying material provide a link © 2017
contacts
filling-form.info
search