PEpennylane
Customers

Retrieve a customer

Changed on

This endpoint returns a customer.

ℹ️ This endpoint requires one of the following scopes: customers:all, customers:readonly

get/api/external/v2/customers/{id}

Request

  • Base URL
    https://app.pennylane.com
  • URL
    https://app.pennylane.com/api/external/v2/customers/{id}
  • Auth
    OAuth 2
    Authorization code: https://app.pennylane.com/oauth/authorize
    Token URL: https://app.pennylane.com/oauth/oauth/token scopes: customers:all, customers:readonly

Path parameters

idinteger required

Customer identifier

Headers

X-Company-Idstring
Example:12345

Numeric ID of the company to act on. Required when authenticating with a firm token. Ignored when the token is already bound to a company.

Response

Returns a company customer

OR

Example response

{
  "id": 42,
  "name": "My company",
  "billing_iban": "FR1420041010050500013M02606",
  "recipient": "John Doe",
  "phone": "+33612345678",
  "reference": "REF-1234",
  "notes": "Some notes",
  "vat_number": "FR12345678901",
  "reg_no": "123456789",
  "electronic_billing_address": "123456789_00012",
  "emails": [
    "hello@example.org"
  ],
  "created_at": "2023-08-30T10:08:08.146343Z",
  "updated_at": "2023-08-30T10:08:08.146343Z",
  "external_reference": "0e67fc3c-c632-4feb-ad34-e18ed5fbf66a",
  "mandates": {
    "url": "https://app.pennylane.com/api/external/v2/gocardless_mandates?filter=%5B%7B%5C\"field%5C\":%5C\"customer_id%5C\",%5C\"operator%5C\":%5C\"eq%5C\",%5C\"value%5C\":%5C\"42%5C\"%7D%5D"
  },
  "pro_account_mandates": {
    "url": "https://app.pennylane.com/api/external/v2/pro_account/mandates?filter=%5B%7B%22field%22%3A%22customer_id%22%2C%22operator%22%3A%22eq%22%2C%22value%22%3A%2242%22%7D%5D"
  },
  "contacts": {
    "url": "https://app.pennylane.com/api/external/v2/customers/42/contacts"
  }
}

Changes

  • 871f863307e5Revision changes
    • warning

      added the new es_ES enum value to the / response property for the response status

    • warning

      added the new es_ES enum value to the / response property for the response status

    • info

      added the new optional header request parameter X-Company-Id

    • info

      added the required property / to the response with the status

    • info

      added the required property / to the response with the status