GET /v1/customers/lookup
Look up POS customers by phone
| Key | Required. See Authentication. |
|---|---|
| Capability | customer-access |
| Scope | customers.read.all |
| Price | 1 credit, per call. How pricing works. |
| Estimate | Add estimate=true for a free quote. With estimate=true the 200 body is EstimateResponse (a priced quote for exactly this request), not the schema documented under responses.200; nothing is reserved or dispatched. |
Example
curl -s "https://api.compudime.com/v1/customers/lookup" \
-H "Authorization: Bearer $PUBLIC_API_KEY"Parameters
| Name | In | Type | Description |
|---|---|---|---|
phone required | query | string | 10-digit US phone number; formatting characters and a leading +1 are accepted. |
fields | query | string | Comma-separated customers fields to include (see x-compudime-field-catalog), or * for every field the key may see. Omitted: a flat-priced endpoint returns every field; once IT prices the endpoint by field count (includedFields in x-compudime-pricing), an omitted fields returns the standard set at the base price and each field beyond the included count adds extraFieldCost. An unknown or denied field is a free 400 field_not_allowed. |
estimate | query | boolean | When true, returns EstimateResponse instead of the normal body and never reserves credits: the request is authenticated, authorized and field-resolved exactly like a real call, then priced by billing (base cost plus extra-field credits for the resolved fields) and returned without dispatching to the store. Free of charge. Default: false. |
Responses
| Status | Description | Body |
|---|---|---|
200 | Projected POS customer matches for the phone number (found:false with no matches). At access level own, only the matches linked to this integration. | CustomerLookupResponse |
400 | The phone query parameter is missing or not a 10-digit US number. | Problem |
401 | Public API key is missing, invalid, or revoked. | Problem |
402 | The request was blocked by billing policy: no_api_plan (no plan funds this meter), billing_card_missing, billing_card_failed, usage_exhausted, overage_cap_reached, subscription_paused, sandbox_exhausted, or billing_blocked. A key the store pays for under its approval gets grant_cap_exceeded (the store's monthly limit for your calls) or payer_billing_blocked (the store cannot be charged right now; ask the store owner) instead: what is wrong with the store's billing is not shown to it. | Problem |
403 | The API key is not enabled for this endpoint. | Problem |
405 | The requested method is not allowed for this endpoint. | Problem |
429 | Too many requests from this API key (code rate_limited). Each key has its own request budget at the API edge, refilled continuously; it covers every authenticated endpoint, including the free ones, and is checked before anything is billed or sent to the store. Billed endpoints are also subject to the store plan's per-minute ceiling, which answers the same problem code. Wait at least Retry-After seconds before the next request with this key, then resume; if 429 answers again, back off exponentially (double the wait each time, up to a minute or so) and add random jitter so parallel workers do not retry in step. A 429 is never charged and reserves nothing. Header Retry-After: Whole seconds to wait before retrying with this key: the time until the key's next request token at the edge (never less than 1), or 60 when the store plan's per-minute ceiling refused the call. | Problem |
500 | The API edge encountered an internal error. | Problem |
502 | The store's POS could not complete the lookup (code store_error). | Problem |
503 | The store's POS agent is offline (code store_offline), or a Public API dependency is unavailable. Also answered, with code endpoint_disabled, while CompuDime has temporarily switched the endpoint off: the whole API, the endpoint's family (x-compudime-family) or this endpoint alone; the detail says which and why. It is checked before anything is validated, reserved or sent to the store, so it is never charged; it is retryable and carries Retry-After. Header Retry-After: Sent with code endpoint_disabled: whole seconds to wait before asking again. A switch has no scheduled end, so this is a polling interval (60), not a promise. | Problem |
504 | The store's POS did not answer inside the lookup ceiling (code store_timeout). | Problem |
Error bodies are problem JSON; every code is listed there.
Fields
Choose with fields=; see Choosing fields.
| All fields | posCustomerId, firstName, lastName, company, addressLine1, addressLine2, city, state, postalCode, email, phones, custLevel, cat, tagList, matchedOn, modifiedAt |
|---|---|
| Standard set | posCustomerId, firstName, lastName, company, addressLine1, addressLine2, city, state, postalCode, email, phones, custLevel, cat, tagList, matchedOn, modifiedAt |
Access level
What your integration's access level changes here.
| Level | Scope | Effect |
|---|---|---|
own | customers.read.self | Returns only the customers linked to this integration among the phone's matches. When none is linked the answer is found:false with no customers, exactly like a phone the store does not know, so it never confirms that a customer exists. |
all | customers.read.all | Returns every customer on file for the phone. |