customers

Get customer by external ID

get/customers/external/{externalId}

Request

  • Base URL: https://api.agentpaid.io/api/v1
  • URL: https://api.agentpaid.io/api/v1/customers/external/{externalId}
  • Auth: HTTP bearer

Path parameters

externalIdstring required

Response

Success response

idstring required
organizationIdstring required
namestring required
externalIdstring
phonestring
employeeCountnumber double
annualRevenuenumber double
taxExemptStatus'none' | 'exempt' | 'reverse'
creationSource'manual' | 'api' | 'crm' | 'other'
creationState'active' | 'draft'
websitestring
metadataCustomerMetadata

Flexible JSON field for storing custom metadata about the customer

Changes

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