This guide shows you how to register your own app with Xero to obtain your OAuth credentials (client ID & secret). These are required to let your users grant your app access to their Xero account.Documentation Index
Fetch the complete documentation index at: https://nango.dev/docs/llms.txt
Use this file to discover all available pages before exploring further.
Access requirements
Before you begin, note the following requirements for Xero:| Pre-Requisites | Status | Comment |
|---|---|---|
| Paid dev account | ✅ Not required | Free, self-signup for a Xero Developer account. |
| Paid test account | ✅ Not required | Developer account includes a demo company for testing. |
| Partnership | ✅ Not required | |
| App review | ✅ Not required | Only required for apps published to the Xero App Store. |
| Security audit | ✅ Not required |
Setup guide
Create a Xero Developer account
Go to Xero Developer signup page and create a free account.
Create a new app
- Log in to your Xero My Apps developer console.
- Click New app in the top right corner.
- A new app form will appear. Enter a unique App name.
- Select Mobile or desktop app as the integration type.
- Fill in the Company or application URL and Redirect URI fields. For the Redirect URI, use:
https://api.nango.dev/oauth/callback. - Check the developer’s terms checkbox and click Create App.
- Your app will be generated, and you will be redirected to your App details page.
Obtain API credentials
- Navigate to the Configuration tab to retrieve your Client ID and Client Secret.
- Click Generate a Secret to create a new Client Secret.
- You will need these credentials when configuring your integration in Nango.
Configure your integration in Nango
Follow the Quickstart to add your credentials to Nango.
Important notes
- Organization selection: When a user authorizes your app, they select which Xero organization to connect. Your app can only access data for the selected organization.
- Multiple organizations: If you need to work with multiple Xero organizations, you’ll need to handle the tenant context in your API calls. After a connection is created, Nango will automatically fetch and store the
tenant_idin the connection config, which you can then use in your API calls. - Token refresh: Make sure you add the
offline_accessscope to ensure the token refreshes as expected.