--- updatedAt: 2025-11-05T15:33:30.000Z agentTools: projectIndex: https://docs.staxpayments.com/llms.txt --- # Get a Customer's Information Retrieves detailed information about a specific customer using their unique ID The **Get a Customer's Information** endpoint retrieves detailed information about a specific customer using their unique ID. This allows merchants to access and review customer data for management and operational purposes. *** ## Key Features * **Retrieve Specific Customer Details**: Fetch all stored data for a specific customer by their `customer_id`. * **Integration with Payment Methods**: View a customer's associated payment methods using the [Get all Payment Methods for a Customer](https://docs.staxpayments.com/reference/get-all-payment-methods-for-a-customer) endpoint. * **Data for Updates**: Retrieve data that can be used with the [Update Customer Information](https://docs.staxpayments.com/reference/update-customer-info) or [Delete a Customer](https://docs.staxpayments.com/reference/delete-a-customer) endpoints. *** ## Usage Notes **Required Parameter**: The `customer_id` is mandatory to locate and fetch the customer record. **Payment Method Details**: This endpoint does not include payment methods. Use the [Get all Payment Methods for a Customer](https://docs.staxpayments.com/reference/get-all-payment-methods-for-a-customer) endpoint to retrieve them. **Use Case**: Ideal for scenarios where detailed customer information is needed for review, updates, or integrations. *** ## Response Structure | Code | Response | Description | | ---- | --------------------- | -------------------------------------------------- | | 200 | Success | Returns the full customer record. | | 400 | Bad Request | Invalid or missing `customer_id`. | | 401 | Unauthorized | API key invalid or missing. | | 404 | Not Found | No customer found with the provided `customer_id`. | | 500 | Internal Server Error | An unexpected error occurred on the server. | *** ## Important Considerations * **Customer Deletion**: If the `deleted_at` field in the response is non-null, the customer has been soft-deleted and will not appear in general customer lists. * **Data Completeness**: Ensure the customer ID provided matches an existing record. A non-matching ID will result in a `404` response. * **Data Sensitivity**: Avoid exposing sensitive customer data in your application's front end. *** ## Best Practices * Use this endpoint in conjunction with the [Update Customer Information](https://docs.staxpayments.com/reference/update-customer-info) endpoint to maintain accurate records. * For operations involving payment methods, follow up this call with the [Get all Payment Methods for a Customer](https://docs.staxpayments.com/reference/get-all-payment-methods-for-a-customer) endpoint. * Log or cache customer data judiciously to avoid repetitive API calls. # OpenAPI definition ```json { "openapi": "3.1.0", "info": { "title": "stax-api", "version": "0.1" }, "servers": [ { "url": "https://apiprod.fattlabs.com/" } ], "components": { "securitySchemes": { "ApiKeyAuth": { "type": "http", "scheme": "bearer", "bearerFormat": "JWT", "description": "API key for merchant-level operations. Provides access to merchant-specific endpoints including transactions, payments, customer management, and merchant account settings. This key is scoped to a single merchant account and cannot access partner-level functionality." } } }, "security": [ { "ApiKeyAuth": [] } ], "paths": { "/customer/{id}": { "get": { "summary": "Get a Customer's Information", "description": "Retrieves detailed information about a specific customer using their unique ID", "operationId": "get-a-customers-information", "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string" }, "required": true } ], "responses": { "200": { "description": "200", "content": { "application/json": { "examples": { "Result": { "value": "{\n \"id\": \"d45ee88c-8b27-4be8-8d81-77dda1b81826\",\n \"firstname\": \"John\",\n \"lastname\": \"Smith\",\n \"company\": \"ABC INC\",\n \"email\": \"contact@example.com\",\n \"cc_emails\": [\n \"demo@abc.com\"\n ],\n \"phone\": \"1234567898\",\n \"address_1\": \"123 Rite Way\",\n \"address_2\": \"Unit 12\",\n \"address_city\": \"Orlando\",\n \"address_state\": \"FL\",\n \"address_zip\": \"32801\",\n \"address_country\": \"USA\",\n \"notes\": null,\n \"reference\": \"BARTLE\",\n \"options\": null,\n \"created_at\": \"2017-05-08 19:22:51\",\n \"updated_at\": \"2017-05-08 19:22:51\",\n \"deleted_at\": null,\n \"gravatar\": \"//www.gravatar.com/avatar/45357c125af15b6df8864a71a653bea2\",\n \"has_address\": true,\n \"missing_address_components\": []\n}" } }, "schema": { "type": "object", "properties": { "id": { "type": "string", "example": "d45ee88c-8b27-4be8-8d81-77dda1b81826" }, "firstname": { "type": "string", "example": "John" }, "lastname": { "type": "string", "example": "Smith" }, "company": { "type": "string", "example": "ABC INC" }, "email": { "type": "string", "example": "contact@example.com" }, "cc_emails": { "type": "array", "items": { "type": "string", "example": "demo@abc.com" } }, "phone": { "type": "string", "example": "1234567898" }, "address_1": { "type": "string", "example": "123 Rite Way" }, "address_2": { "type": "string", "example": "Unit 12" }, "address_city": { "type": "string", "example": "Orlando" }, "address_state": { "type": "string", "example": "FL" }, "address_zip": { "type": "string", "example": "32801" }, "address_country": { "type": "string", "example": "USA" }, "notes": {}, "reference": { "type": "string", "example": "BARTLE" }, "options": {}, "created_at": { "type": "string", "example": "2017-05-08 19:22:51" }, "updated_at": { "type": "string", "example": "2017-05-08 19:22:51" }, "deleted_at": {}, "gravatar": { "type": "string", "example": "//www.gravatar.com/avatar/45357c125af15b6df8864a71a653bea2" }, "has_address": { "type": "boolean", "example": true, "default": true }, "missing_address_components": { "type": "array" } } } } } }, "404": { "description": "404", "content": { "application/json": { "examples": { "Result": { "value": "{\n \"id\": \"customer not found\"\n}" } }, "schema": { "type": "object", "properties": { "id": { "type": "string", "example": "customer not found" } } } } } } }, "deprecated": false } } }, "x-readme": { "headers": [], "explorer-enabled": true, "proxy-enabled": true }, "x-readme-fauxas": true } ```