GOgocardless
Customer

List customers

Returns a cursor-paginated list of your customers.

get/customers

Request

  • Base URL
    https://api.gocardless.com
  • Auth
    HTTP bearer

Query parameters

beforestring nullable

Cursor pointing to the end of the desired set.

afterstring nullable

Cursor pointing to the start of the desired set.

integer
OR
string

Number of records to return.

gtstring date-time

Limit to records created after the specified date-time.

ltstring date-time

Limit to records created before the specified date-time.

gtestring date-time

Limit to records created on or after the specified date-time.

ltestring date-time

Limit to records created on or before the specified date-time.

sort_field'name' | 'company_name' | 'created_at'

Field by which to sort records. One of:

  • name
  • company_name
  • created_at
sort_direction'asc' | 'desc'

The direction to sort in. One of:

  • asc
  • desc
currency'AUD' | 'CAD' | 'DKK' | 'EUR' | 'GBP' | 'NZD' | 'SEK' | 'USD'

ISO 4217 currency code. Currently "AUD", "CAD", "DKK", "EUR", "GBP", "NZD", "SEK" and "USD" are supported.

Example:EUR
action_required'true' | 'false'

Boolean indicating whether the customer has any actions required.

Headers

GoCardless-Versionstring required

Response

Successful response

Example response

{
  "customers": [
    {
      "id": "CU123",
      "created_at": "2014-01-01T12:00:00.000Z",
      "email": "user@example.com",
      "given_name": "Frank",
      "family_name": "Osborne",
      "company_name": "Hamilton Trading Ltd.",
      "address_line1": "221B Baker Street",
      "address_line2": "Marylebone",
      "address_line3": "City of Westminster",
      "city": "London",
      "region": "Greater London",
      "postal_code": "NW1 6XE",
      "country_code": "GB",
      "language": "en",
      "phone_number": "+64 4 817 9999",
      "swedish_identity_number": "556564-5404",
      "danish_identity_number": "2205506218"
    }
  ],
  "meta": {
    "limit": 50
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.