XExeroapi
FeedConnections

Retrieve the Feed Connections for an Organisation

Changed on

Returns the Feed Connections belonging to both the Organisation in Xero-Tenant-Id and the Application associated with the OAuth client. Connections belonging to another Application are not returned, and there is no way to observe that they exist.

A page beyond the end of the collection returns an empty items array rather than an error.

get/FeedConnections

Request

  • Base URL
    https://api.xero.com/bankfeeds.xro/2.0
  • URL
    https://api.xero.com/bankfeeds.xro/2.0/FeedConnections
  • Auth
    OAuth 2
    Authorization code: https://login.xero.com/identity/connect/authorize
    Token URL: https://identity.xero.com/connect/token scopes: bankfeedsv2

Query parameters

pageinteger

The page to return, counting from 1.

pageSizeinteger

How many Feed Connections to return per page. No maximum is enforced.

Headers

Xero-Tenant-Idstring required

Xero identifier for Tenant

Response

The requested page of Feed Connections.

Changes

  • v27b8338264030Revision changes
    • breaking

      added the new required header request parameter Xero-Tenant-Id

    • info

      the endpoint scheme security OAuth2 was added to the API

    • info

      added the new optional query request parameter page

    • info

      added the new optional query request parameter pageSize

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the success response with the status

  • v2de9385475971Revision changes
    • breaking

      removed the success response with the status

    • warning

      deleted the header request parameter Xero-Tenant-Id

    • warning

      deleted the query request parameter page

    • warning

      deleted the query request parameter pageSize

    • info

      the endpoint scheme security OAuth2 was removed from the API

    • info

      removed the non-success response with the status

    • info

      removed the non-success response with the status

    • info

      removed the non-success response with the status

    • info

      removed the non-success response with the status