PEpennylane
Customers

Retrieve a contact of a customer

Changed on

Retrieve a contact of a customer

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

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

Request

  • Base URL
    https://app.pennylane.com
  • URL
    https://app.pennylane.com/api/external/v2/customers/{customer_id}/contacts/{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

customer_idinteger required
idinteger required

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 the contact

idinteger required
first_namestring required
last_namestring required
rolestring required
emailstring required
telephone_numberstring required
mobile_numberstring required
created_atstring date-time required
updated_atstring date-time required

Example response

{
  "id": 421,
  "first_name": "Jane",
  "last_name": "Doe",
  "role": "accountant",
  "email": "jane.doe@example.com",
  "created_at": "2023-08-30T10:08:08.146343Z",
  "updated_at": "2023-08-30T10:08:08.146343Z"
}

Changes