Xero Projects API
This is the Xero Projects API
Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.
Overview
This is the Xero Projects API
Endpoints 16
Project
- GETRetrieves all projects
/Projects?projectIds=3fa85f64-5717-4562-b3fc-2c963f66afa6&contactID=3fa85f64-5717-4562-b3fc-2c963f66afa6&states=string&page=1&pageSize=100Allows you to retrieve, create and update projects. - POSTCreate one or more new projects
/Projects - GETRetrieves a single project
/Projects/:projectIdAllows you to retrieve a specific project using the projectId - PUTUpdates a specific project
/Projects/:projectIdAllows you to update a specific projects. - PATCHcreates a project for the specified contact
/Projects/:projectIdAllows you to update a specific projects. - GETRetrieves a list of all project users
/ProjectsUsers?page=1&pageSize=100Allows you to retrieve the users on a projects. - GETRetrieves all project tasks
/Projects/:projectId/Tasks?page=1&pageSize=10&taskIds=string&chargeType=TIMEAllows you to retrieve a specific project - POSTAllows you to create a task
/Projects/:projectId/TasksAllows you to create a specific task - GETRetrieves a single project task
/Projects/:projectId/Tasks/:taskIdAllows you to retrieve a specific project - PUTAllows you to update a task
/Projects/:projectId/Tasks/:taskIdAllows you to update a specific task - DELETEAllows you to delete a task
/Projects/:projectId/Tasks/:taskIdAllows you to delete a specific task - GETRetrieves all time entries associated with a specific project
/Projects/:projectId/Time?userId=3fa85f64-5717-4562-b3fc-2c963f66afa6&taskId=3fa85f64-5717-4562-b3fc-2c963f66afa6&invoiceId=3fa85f64-5717-4562-b3fc-2c963f66afa6&contactId=3fa85f64-5717-4562-b3fc-2c963f66afa6&page=1&pageSize=10&states=string&isChargeable=true&dateAfterUtc=2024-01-01T00:00:00Z&dateBeforeUtc=2024-01-01T00:00:00ZAllows you to retrieve the time entries associated with a specific project - POSTCreates a time entry for a specific project
/Projects/:projectId/TimeAllows you to create a specific task - GETRetrieves a single time entry for a specific project
/Projects/:projectId/Time/:timeEntryIdAllows you to get a single time entry in a project - PUTUpdates a time entry for a specific project
/Projects/:projectId/Time/:timeEntryIdAllows you to update time entry in a project - DELETEDeletes a time entry for a specific project
/Projects/:projectId/Time/:timeEntryIdAllows you to delete a specific time entry
API details
- Base URL
https://api.xero.com/projects.xro/2.0- Authentication
- OAuth 2.0 (authorization code flow) with 5 scopes
- Operations
- 16 operations on 7 pathsGET 7PUT 3POST 3DELETE 2PATCH 1
- Main resources
- Project 16
- Response formats
application/json- Description format
- OpenAPI 3.0.0, API version
20.1.0 - Links
- OpenAPI document · Terms of service · Support
- Listed from
- Xero's published OpenAPI description (XeroAPI/Xero-OpenAPI) (MIT)
How to test the Xero Projects API in Swastik Codes
- Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
- Fork it into your workspaceChoose a workspace. You get your own copy of the Xero Projects API collection, without the publisher's secrets.
- Add your credentialsThis API uses OAuth 2.0 (authorization code flow) with 5 scopes. Add yours in the collection's variables or an environment; the requests already reference it.
- Send a requestPick an endpoint, for example “Retrieves all projects” (GET /Projects?projectIds=3fa85f64-5717-4562-b3fc-2c963f66afa6&contactID=3fa85f64-5717-4562-b3fc-2c963f66afa6&states=string&page=1&pageSize=100), and press Send. Check the response, add tests and run the whole collection with the runner.
Frequently asked questions
What is the Xero Projects API?
This is the Xero Projects API It is listed under Finance & banking and has 16 endpoints.
Who publishes the Xero Projects API?
It is listed from Xero's public API description (an OpenAPI document), not published by Xero on Swastik Codes. Anyone who controls xero.com can claim the profile by adding a DNS TXT record.
What is the base URL of the Xero Projects API?
Requests go to https://api.xero.com/projects.xro/2.0. Endpoint paths are added to this base URL.
How do I authenticate with the Xero Projects API?
With OAuth 2.0 (authorization code flow) with 5 scopes.
How many endpoints does the Xero Projects API have?
16 operations on 7 paths (7 GET, 3 PUT, 3 POST, 2 DELETE, 1 PATCH). The largest groups are Project.
Is forking the Xero Projects API free?
Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.