UPupflow
Contacts

Get Customer Contact

This endpoint can be used to retrieve a specific customer contact by its ID.

get/customers/{customer_id}/contacts/{id}

Request

  • Base URL
    https://api.upflow.io/v1
  • Auth
    API key in header X-Api-Key and API key in header X-Api-Secret

Query parameters

source'USER_DEFINED' | 'SALESFORCE' | 'NETSUITE' | 'SELLSY' | 'QUICKBOOKSONLINE' | 'STRIPE' | 'STRIPE_EXPRESS' | 'CHARGEBEE' | 'XERO' | 'ZUORA' | 'SAGE_INTACCT' | 'PENNYLANE'
Example:USER_DEFINED

Data source for the contact. Recommended when using a contact ID that is external to Upflow.

Response

Contact details.

firstNamestring

Contact first name.

lastNamestring

Contact last name.

phonestring

Contact phone number.

emailstring email required

Contact email (must be unique).

positionstring

Contact position label.

externalIdstring

Contact custom external identifier.

isMainboolean

Indicates if this is the main contact for the customer.

idstring uuid required

The contact ID.

positionIdstring uuid nullable

The custom contact position ID.

createdAtstring date-time

The date at which the contact was created (ISO 8601 format).

Example response

{
  "firstName": "John",
  "lastName": "Doe",
  "phone": "+33678059778",
  "email": "john@example.com",
  "position": "ACCOUNTING",
  "externalId": "CONT123",
  "isMain": true,
  "customFields": [
    {
      "id": "00a70b35-2be3-4c43-aefb-397190134655",
      "externalId": "AEGaaZD"
    }
  ],
  "id": "00a70b35-2be3-4c43-aefb-397190134655",
  "positionId": "c8490f71-8252-40b2-935a-fb93ade55867",
  "createdAt": "2015-05-05T12:30:00Z"
}

Changes

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