---
title: "List gocardless mandates"
method: GET
path: "/api/external/v2/gocardless_mandates"
tags: ["Mandates"]
---

# List gocardless mandates

`GET /api/external/v2/gocardless_mandates`

## Request

- Base URL: `https://app.pennylane.com`
- URL: `https://app.pennylane.com/api/external/v2/gocardless_mandates`
- Auth: OAuth 2
  - Authorization code: `https://app.pennylane.com/oauth/authorize`
  - Token URL: `https://app.pennylane.com/oauth/oauth/token` scopes: `customer_mandates:all`, `customer_mandates:readonly`

List gocardless mandates

> ℹ️
> This endpoint requires one of the following scopes: `customer_mandates:all`, `customer_mandates:readonly`

## Query parameters

- `cursor` string
- `limit` integer
- `filter` string
- `sort` string

## Headers

- `X-Company-Id` string

## Response `200`

The list of gocardless mandates

- object
  - `has_more` boolean, required: Indicates whether additional results are available beyond this set. Use this flag to determine if another request is needed.
  - `next_cursor` string, nullable, required: Cursor to retrieve the next set of results. Include this value in the cursor parameter of your next request to fetch subsequent items. A `null` `next_cursor` in the response indicates no further results.
  - `items` object[], required
    - `id` integer, required
    - `external_reference` string, nullable, required: Unique external identifier for the Gocardless mandate.
    - `customer` object, nullable, required
      - `id` integer, required
      - `url` string, required: URL to get the customer.
    - `status` 'pending_customer_approval' | 'pending_submission' | 'submitted' | 'active' | 'failed' | 'cancelled' | 'expired' | 'consumed' | 'replaced' | 'blocked' | 'bank_disconnected', required
    - `external_customer_account` string, required: Identifier for the Gocardless customer account.
    - `external_customer_label` string, nullable, required: Label for the Gocardless customer account.
    - `created_at` string, date-time, required: Creation date of the Gocardless mandate
    - `updated_at` string, date-time, required: Last update date of the Gocardless mandate

## Other responses

- `400`: Bad request
- `401`: Access token is missing or invalid
- `403`: Access to this resource forbidden
- `404`: The resource was not found

## Changes

- **2026-11-03** `871f863307e5`: 1 info
  - added the new optional `header` request parameter `X-Company-Id`

[Operation history](https://skmtc.dev/pennylane/apis/company-v2/changes/api/external/v2/gocardless_mandates/get.md)

---

[API](https://skmtc.dev/pennylane/apis/company-v2.md) - [All operations](https://skmtc.dev/pennylane/apis/company-v2/llms.txt) - [OpenAPI document](https://skmtc.dev/pennylane/apis/company-v2/revisions/871f863307e5?raw)