Customer.Get

Try it in Swagger

Endpoint

Returns a single customer/account by code. The account must be within the caller's allowed set — their own account (CustomerCode claim) plus any bill-to accounts in AdditionalWebAccess — unless the caller is a master contact (configured MasterContactCode for the tenant, with API key), who may retrieve any account. Sensitive financial, payment, and internal accounting fields are never returned.

Request Schema

Headers

Header Required Notes
X-Api-Key Required when tenant is not resolved by subdomain Resolves the tenant/customer database. Also required for master-contact elevation.
Authorization: Bearer {token} Required for authorized endpoints Get a token from Auth/Token or Session/Create.

Path Parameters

Field Type Required Notes
customerCode string Yes Customer code (primary key of the account).

Expected Response Schema

Status Codes

Status Notes
200 OK Account found and returned.
404 Not Found No account with that code is visible to the caller.

Success Body

Response type: CustomerLookupDto

Field Type Notes
accountId string Account lookup id; aliases customerCode.
customerCode string Customer code (account primary key).
name string Account name.
fullName string Account full/legal name.
attention string
address1 string
address2 string
suite string
city string
state string
zip string
mailingStreet string
mailingCity string
mailingState string
mailingZip string
phone string
fax string
email string
openDate datetime? Account open date (read-only).

Response Sample

{
  "accountId": "8888",
  "customerCode": "8888",
  "name": "Acme Law Group",
  "fullName": "Acme Law Group LLP",
  "attention": "Billing Dept",
  "address1": "123 Main St",
  "address2": "",
  "suite": "400",
  "city": "Los Angeles",
  "state": "CA",
  "zip": "90017",
  "mailingStreet": "PO Box 123",
  "mailingCity": "Los Angeles",
  "mailingState": "CA",
  "mailingZip": "90017",
  "phone": "2135550100",
  "fax": "2135550101",
  "email": "billing@acmelaw.example.com",
  "openDate": "2021-03-15T00:00:00Z"
}