Skip to main content
Main content start

Build Solutions that fit your unique needs and drive growth.

Build workflows and custom integrations seamlessly connected to Xero and tailored just for you.

Get started

Go beyond off-the-shelf. Build a custom solution with the Xero API.

Alongside our standard OAuth 2.0 flow, Custom Connections is a streamlined integration option for anyone building bespoke solutions for Xero businesses. It utilises the client credentials grant type to provide a simplified, more efficient developer experience, perfect for machine to machine integrations.

  • Sign up as a developer partner

    If you’ve got proven experience building custom integrations with the Xero API, then register to get listed as a certified custom integrator.

    Sign up as a developer partner

  • Custom Connections

    A streamlined integration option for anyone building bespoke solutions for Xero businesses. It utilises the client credentials grant type to provide a simplified, efficient developer experience.

    Create a custom connection

  • Add a collaborator

    Building and maintaining an app or integration with Xero often involves a team of people. Xero’s app collaboration function ensures that multiple people can have access to an app.

    Add a collaborator

Custom Connections are now available in the AU, NZ, UK and US

Custom Connections are a premium integration option that utilise the client credentials grant type to access data from a single Xero organisation. Custom Connections can be connected to the Xero Demo Company for free for development purposes. It's done in three easy steps:

  • Set up your custom connection

    It's an easy process to set up a custom connection, select your scopes, authorise, get your client id and secret, request and receive a token, and call the Xero API.

  • Purchase a custom connection subscription

    Xero customers can now have multiple Custom Connection apps connected to their organisation. They just need to have purchased a subscripton with a sufficient quantity of custom connections. There is more Custom Connection information for Xero customers on Xero Central.

  • Build your custom solution

    It's time to build the custom connection on behalf of a client. You'll need to develop and test the integration using your demo company and once it's ready, you'll add your client as an authorising user.

More information about Custom Connections

Key information

Price: $10/m AUD (inc GST), $10/m NZD (ex GST), £5/m GBP (ex VAT), $5/m USD (ex tax). Recurring monthly subscriber charge per Custom connection purchased.

Availability: Xero organisations in AU, NZ, UK and US only. Check out the Custom Integration FAQs here.

Custom Connections benefits for developers

Simple, fast and secure access: makes it easier to retrieve access tokens and call the API. No need to build an authorization flow into your app (we take care of that).

Goodbye refresh tokens: forget managing refresh tokens for a single integration. Simply use your client id and client secret to request a new access token when you need one.

World class authorisation and consent: a clear, robust user experience that keeps users in control of their data.

More jobs, happier customers: by reducing the complexity to build and manage machine-to-machine (M2M) integrations, you will reduce cost and friction for your customers.

Build more and without limits: owners can purchase as many connections as their business needs - empowering them to innovate more, and you to build and connect countless solutions for their business.

Benefits for Xero businesses and accounting practices

Simple, fast connections: you, or a developer you commission, can access Xero’s APIs and manage custom integrations more easily.

Cost efficient: less complexity and time to build will reduce development costs. Plus, a more efficient connection will save you maintenance and management costs over time.

Highly secure: You remain in control of your data, consent is as clear and robust as connecting apps from Xero’s App Store. More solutions, no limits: purchase as many connections as your business needs - empowering you to innovate, build and connect countless bespoke solutions for your business.

Technical details

Steps to create a custom connection:

  1. A Xero user purchases Custom Connections for their organisation

  2. The developer creates a new Custom connection app on developer.xero.com

  3. The developer requests authorisation from the Xero user

  4. The Xero user grants authorisation to connect to their organisation

  5. The custom connection is activated

If a developer is building an integration to their own organisation then the developer and Xero user will be the same person.

Want to learn more? Check out the FAQs!

Still have questions?

Please contact our developer platform support team.

Ready to build a custom connection?

Sign up to be listed as a custom integratorGet started