> ## Documentation Index > Fetch the complete documentation index at: https://help.kajabi.com/llms.txt > Use this file to discover all available pages before exploring further. ## Submitting Feedback If you encounter incorrect, outdated, or confusing documentation on this page, submit feedback: POST https://help.kajabi.com/feedback ```json { "path": "/api-reference/customers/customer-details", "feedback": "Description of the issue" } ``` Only submit feedback when you have something specific and actionable to report. # Customer details > Show customer details * The `name` and `email` attributes are kept in sync with the related `contact` resource * The `external_user_id` attribute may be used as a customer reference in an external system ## Customer Attributes * `name` (string) - The customer's full name. This is a required field and can be either user-provided or auto-generated from their email address if left blank. * `email` (string) - The customer's email address. This is a required field and must be unique within a site. It's automatically downcased and stripped of whitespace. Used for authentication and communication. * `avatar` (string) - A URL to the customer's profile image. Can be either a custom uploaded avatar or falls back to Gravatar. If not set, defaults to a blank image. * `external_user_id` (string) - An optional external identifier that can be used to link the customer to external systems. Must be unique within a site. * `public_bio` (string) - A text field containing the customer's public biography or description. This is optional and can be displayed in community/social features. * `public_location` (string) - A text field for the customer's public location information. Optional field used for community/social features. * `public_website` (string) - The customer's website URL. This is validated to ensure it's a proper URL format and is transformed to ensure proper formatting. * `socials` (object) - A collection of the customer's social media links and profiles. * `net_revenue` (string) - The total revenue generated by this customer through their purchases. This is calculated from their successful payment transactions. * `sign_in_count` (integer) - A counter tracking how many times the customer has signed into their account. * `last_request_at` (string) - Timestamp of the customer's most recent activity or request. Used to track user engagement and activity. * `bounced_at` (string) - Timestamp indicating when the customer's email started bouncing. This is reset if the email address is changed. * `created_at` (string) - Timestamp when the customer record was created. * `updated_at` (string) - Timestamp when the customer record was last updated. ## Include Related Resources Use the `include` parameter to include related resources: ### Include offers and products * `GET /v1/customers/123?include=contact,offers,products` Response will include related resources ```json { "data": { "id": "123", "type": "customers", "attributes": { "name": "Alice Smith", "email": "alice@example.com", "avatar": null, "external_user_id": "cust_123", "public_bio": null, "public_location": null, "public_website": null, "socials": null, "net_revenue": "0.0", "sign_in_count": 0, "last_request_at": null, "bounced_at": null, "created_at": "2021-01-01T00:00:00Z", "updated_at": "2021-01-01T00:00:00Z" }, "links": { "contact": "https://app.kajabi.com/api/v1/contacts/321" }, "relationships": { "contact": { "data": { "id": "321", "type": "contacts" } }, "offers": { "data": [{ "id": "456", "type": "offers" }], "links": { "self": "https://app.kajabi.com/api/v1/customers/123/relationships/offers" } }, "products": { "data": [{ "id": "789", "type": "products" }] } } }, "included": [ { "id": "456", "type": "offers", "attributes": { "name": "Offer 1", "description": "Offer 1 description", "internal_title": "Offer 1", "price_in_cents": 0, "payment_type": "free", "token": "offer_123", "payment_method": "none", "price_description": "Free", "checkout_url": "https://mywebsite.com/offers/456", "recurring_offer": false, "subscription": false, "one_time": true, "single": false, "free": true } }, { "id": "789", "type": "products", "attributes": { "created_at": "2024-11-12T23:43:09.551Z", "title": "Course 1", "description": "Course 1 description", "status": "ready", "members_aggregate_count": 0, "product_type_name": "Course", "product_type_id": 789, "publish_status": "published", "thumbnail_url": null } }, { "id": "321", "type": "contacts", "attributes": { "name": "Alice Smith", "email": "alice@example.com", "address_line_1": null, "address_line_2": null, "address_city": null, "address_country": null, "address_state": null, "address_zip": null, "phone_number": null, "business_number": null, "subscribed": false, "external_user_id": null, "created_at": "2024-11-20T18:53:19.389Z", "updated_at": "2024-11-20T18:53:19.389Z" } } ] } ``` ## Sparse Fields Use the `fields[customers]` parameter to request only specific attributes: ### Only return name and email attributes * `GET /v1/customers/123?fields[customers]=name,email` Response will only include requested fields ```json { "data": { "id": "123", "type": "customers", "attributes": { "name": "Alice Smith", "email": "alice@example.com" } } } ``` ## Using Multiple Parameters Together You can combine filtering, sparse fields, pagination and search in a single request: * `GET /v1/customers/123?include=products&fields[customers]=name&fields[product]=title` Response will include related resources with sparse fields ```json { "data": { "id": "123", "type": "customers", "attributes": { "name": "Alice Smith" }, "relationships": {} }, "included": [ { "id": "789", "type": "products", "attributes": { "title": "Course 1" } } ] } ``` ## OpenAPI ````yaml /openapi.yaml get /v1/customers/{id} openapi: 3.1.1 info: title: Kajabi API V1 version: 1.0.1 description: > ## Public API * Server URL `https://api.kajabi.com` * Endpoint paths are prefixed with `/v1` * Version endpoint `GET https://api.kajabi.com/v1/version` * See the [Developers Site](https://developers.kajabi.com) for documentation and examples. * Try the demo [Postman collection](https://www.postman.com/kajabi-apis/beta-public-api-demo/collection/fg4iyaz/kajabi-public-api-v1) ## API Keys * Your API `client_id` and `client_secret` are available on the [User API Keys](https://app.kajabi.com/admin/settings/security) section of the Kajabi Admin Portal. * Custom API Keys can be created with specific permissions. * Click the "Create User API Key" button, enter a name (e.g. "My project"), select the user and permissions, and click "Create". * For security purposes, you may "Delete" or "Rotate" the api credentials at any time; which will invalidate any access tokens granted with the credentials. ## Video Walkthroughs * [Capabilities](https://drive.google.com/file/d/1Puc9B2sSdA-RQb7YMxmUXg4FVoEXytoc/view?usp=sharing) * [Getting Started](https://drive.google.com/file/d/1hbGRShkxven_QMWvgYrerHKURbcZrnvJ/view?usp=sharing) * [Error Examples](https://drive.google.com/file/d/1i0wQK71I1jpaZVsxYwsn62gVj40S_E7Y/view?usp=sharing) * [External Contact Form](https://drive.google.com/file/d/1HqpULXvan5TOK3LvM7nILCuCkCaX0kFT/view?usp=sharing) contact: email: support@kajabi.com name: Support url: >- https://help.kajabi.com/hc/en-us/articles/4404549690523-How-to-Get-Help-From-Kajabi-Live-Agents license: name: Apache 2.0 url: http://www.apache.org/licenses/LICENSE-2.0.html servers: - url: https://api.kajabi.com description: Production security: [] paths: /v1/customers/{id}: get: tags: - Customers summary: Customer details description: > Show customer details * The `name` and `email` attributes are kept in sync with the related `contact` resource * The `external_user_id` attribute may be used as a customer reference in an external system ## Customer Attributes * `name` (string) - The customer's full name. This is a required field and can be either user-provided or auto-generated from their email address if left blank. * `email` (string) - The customer's email address. This is a required field and must be unique within a site. It's automatically downcased and stripped of whitespace. Used for authentication and communication. * `avatar` (string) - A URL to the customer's profile image. Can be either a custom uploaded avatar or falls back to Gravatar. If not set, defaults to a blank image. * `external_user_id` (string) - An optional external identifier that can be used to link the customer to external systems. Must be unique within a site. * `public_bio` (string) - A text field containing the customer's public biography or description. This is optional and can be displayed in community/social features. * `public_location` (string) - A text field for the customer's public location information. Optional field used for community/social features. * `public_website` (string) - The customer's website URL. This is validated to ensure it's a proper URL format and is transformed to ensure proper formatting. * `socials` (object) - A collection of the customer's social media links and profiles. * `net_revenue` (string) - The total revenue generated by this customer through their purchases. This is calculated from their successful payment transactions. * `sign_in_count` (integer) - A counter tracking how many times the customer has signed into their account. * `last_request_at` (string) - Timestamp of the customer's most recent activity or request. Used to track user engagement and activity. * `bounced_at` (string) - Timestamp indicating when the customer's email started bouncing. This is reset if the email address is changed. * `created_at` (string) - Timestamp when the customer record was created. * `updated_at` (string) - Timestamp when the customer record was last updated. ## Include Related Resources Use the `include` parameter to include related resources: ### Include offers and products * `GET /v1/customers/123?include=contact,offers,products` Response will include related resources ```json { "data": { "id": "123", "type": "customers", "attributes": { "name": "Alice Smith", "email": "alice@example.com", "avatar": null, "external_user_id": "cust_123", "public_bio": null, "public_location": null, "public_website": null, "socials": null, "net_revenue": "0.0", "sign_in_count": 0, "last_request_at": null, "bounced_at": null, "created_at": "2021-01-01T00:00:00Z", "updated_at": "2021-01-01T00:00:00Z" }, "links": { "contact": "https://app.kajabi.com/api/v1/contacts/321" }, "relationships": { "contact": { "data": { "id": "321", "type": "contacts" } }, "offers": { "data": [{ "id": "456", "type": "offers" }], "links": { "self": "https://app.kajabi.com/api/v1/customers/123/relationships/offers" } }, "products": { "data": [{ "id": "789", "type": "products" }] } } }, "included": [ { "id": "456", "type": "offers", "attributes": { "name": "Offer 1", "description": "Offer 1 description", "internal_title": "Offer 1", "price_in_cents": 0, "payment_type": "free", "token": "offer_123", "payment_method": "none", "price_description": "Free", "checkout_url": "https://mywebsite.com/offers/456", "recurring_offer": false, "subscription": false, "one_time": true, "single": false, "free": true } }, { "id": "789", "type": "products", "attributes": { "created_at": "2024-11-12T23:43:09.551Z", "title": "Course 1", "description": "Course 1 description", "status": "ready", "members_aggregate_count": 0, "product_type_name": "Course", "product_type_id": 789, "publish_status": "published", "thumbnail_url": null } }, { "id": "321", "type": "contacts", "attributes": { "name": "Alice Smith", "email": "alice@example.com", "address_line_1": null, "address_line_2": null, "address_city": null, "address_country": null, "address_state": null, "address_zip": null, "phone_number": null, "business_number": null, "subscribed": false, "external_user_id": null, "created_at": "2024-11-20T18:53:19.389Z", "updated_at": "2024-11-20T18:53:19.389Z" } } ] } ``` ## Sparse Fields Use the `fields[customers]` parameter to request only specific attributes: ### Only return name and email attributes * `GET /v1/customers/123?fields[customers]=name,email` Response will only include requested fields ```json { "data": { "id": "123", "type": "customers", "attributes": { "name": "Alice Smith", "email": "alice@example.com" } } } ``` ## Using Multiple Parameters Together You can combine filtering, sparse fields, pagination and search in a single request: * `GET /v1/customers/123?include=products&fields[customers]=name&fields[product]=title` Response will include related resources with sparse fields ```json { "data": { "id": "123", "type": "customers", "attributes": { "name": "Alice Smith" }, "relationships": {} }, "included": [ { "id": "789", "type": "products", "attributes": { "title": "Course 1" } } ] } ``` parameters: - name: id in: path required: true schema: type: string - name: include in: query required: false description: >- with ?include=offers,products the response will include the related resources schema: type: string - name: fields[customers] in: query required: false description: Partial attributes as specified, e.g. fields[customers]=name,email schema: type: string - name: include in: query required: false schema: type: string - name: filter[products_search] in: query required: false description: Search products by title schema: type: string - name: include in: query required: false schema: type: string - name: filter[products_page] in: query required: false schema: type: integer - name: filter[products_per] in: query required: false schema: type: integer - name: include in: query required: false schema: type: string - name: filter[offers_search] in: query required: false description: Search offers by title or internal title schema: type: string - name: include in: query required: false schema: type: string - name: filter[offers_page] in: query required: false schema: type: integer - name: filter[offers_per] in: query required: false schema: type: integer - name: include in: query required: false schema: type: string - name: filter[products_search] in: query required: false schema: type: string - name: filter[offers_search] in: query required: false schema: type: string - name: filter[products_search] in: query required: false description: Should be ignored when include parameter is missing schema: type: string - name: filter[offers_search] in: query required: false description: Should be ignored when include parameter is missing schema: type: string responses: '200': description: Success - filters ignored when include parameter not present content: application/vnd.api+json: schema: $ref: '#/components/schemas/customers_show_response' '401': description: Unauthorized, Authorization header is missing or invalid content: application/vnd.api+json: schema: $ref: '#/components/schemas/errors_unauthorized' '403': description: Forbidden, insufficient permission to access the resource content: application/vnd.api+json: schema: $ref: '#/components/schemas/errors_forbidden' security: - Bearer: [] components: schemas: customers_show_response: type: object properties: data: type: object properties: id: type: string type: type: string attributes: $ref: '#/components/schemas/customers_attributes' relationships: type: object properties: contact: type: object properties: data: $ref: '#/components/schemas/resource_identifier' site: type: object properties: data: $ref: '#/components/schemas/resource_identifier' offers: type: object properties: data: $ref: '#/components/schemas/resource_identifiers' links: type: object properties: self: type: string products: type: object properties: data: $ref: '#/components/schemas/resource_identifiers' links: type: object properties: contact: type: string links: type: object properties: self: type: string current: type: string errors_unauthorized: type: object properties: errors: type: array items: $ref: '#/components/schemas/errors_attributes' errors_forbidden: type: object properties: errors: type: array items: $ref: '#/components/schemas/errors_attributes' customers_attributes: type: object properties: name: type: string email: type: string avatar: type: - string - 'null' external_user_id: type: string nullable: true description: Supported once contact is granted an offer or makes a purchase public_bio: type: - string - 'null' public_location: type: - string - 'null' public_website: type: - string - 'null' socials: type: object nullable: true properties: twitter: type: - string - 'null' facebook: type: - string - 'null' instagram: type: - string - 'null' net_revenue: type: - string - 'null' sign_in_count: type: integer nullable: true description: Read only last_request_at: type: string nullable: true description: ISO 8601 date-time, read only bounced_at: type: string nullable: true description: ISO 8601 date-time, read only created_at: type: string format: date-time readOnly: true description: ISO 8601 date-time, read only updated_at: type: string format: date-time readOnly: true description: ISO 8601 date-time, read only resource_identifier: type: object properties: id: type: string type: type: string required: - id - type resource_identifiers: type: array items: $ref: '#/components/schemas/resource_identifier' errors_attributes: type: object properties: status: type: string source: type: object nullable: true properties: pointer: type: string title: type: string detail: type: string securitySchemes: Bearer: type: http scheme: bearer ````