> For the complete documentation index, see [llms.txt](https://developer.usemultiplier.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://developer.usemultiplier.com/api-reference/partner-management/customers.md).
# Customers
Manage customer profiles and information
## List all customers
> Retrieves a paginated list of all customers associated with the partner.\
> \
> Results are returned in descending order by creation date (newest first).
```json
{"openapi":"3.0.1","info":{"title":"Multiplier Public REST API","version":"1.0.0"},"tags":[{"name":"Customers","description":"Manage customer profiles and information"}],"servers":[{"url":"https://api.usemultiplier.com","description":"Production API / Partner Sandbox"},{"url":"https://release-api-gateway.api.usemultiplier.com","description":"MPL internal release environment"},{"url":"https://api-gateway.api.acc.staging.usemultiplier.com","description":"MPL internal staging"}],"security":[{"BearerAuth":[]}],"components":{"securitySchemes":{"BearerAuth":{"type":"http","description":"JWT Bearer token authentication.\n\nTo authenticate:\n1. Obtain a JWT token from your authentication endpoint\n2. Click the \"Authorize\" button above\n3. Enter your token in the format: your-jwt-token\n4. Click \"Authorize\" to apply to all requests\n\nThe token will be automatically included in the Authorization header\nas: Authorization: Bearer {token}\n","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"StrategicPartner_CustomerListResponse":{"required":["data","pagination"],"type":"object","properties":{"data":{"type":"array","description":"List of customers for the partner","items":{"$ref":"#/components/schemas/StrategicPartner_CustomerResponse"}},"pagination":{"$ref":"#/components/schemas/StrategicPartner_Pagination"}}},"StrategicPartner_CustomerResponse":{"required":["currency","displayName","id","legalName","status"],"type":"object","properties":{"id":{"type":"string","description":"Unique customer identifier (UUID v7 format)"},"legalName":{"type":"string","description":"Official legal name of the customer"},"displayName":{"type":"string","description":"Display name for the customer"},"currency":{"type":"string","description":"Primary operating currency","enum":["AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYN","BYR","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNH","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GGP","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","IMP","INR","IQD","IRR","ISK","JEP","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LTL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLL","SOS","SPL","SRD","SSP","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TVD","TWD","TZS","UAH","UGX","USD","USN","UYI","UYU","UYW","UZS","VEF","VES","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XOF","XPD","XPF","XPT","XSU","XTS","XUA","YER","ZAR","ZMK","ZMW","ZWD","ZWL"]},"status":{"$ref":"#/components/schemas/StrategicPartner_CustomerStatus"},"customerCode":{"type":"string","description":"External customer identifier provided by the partner"}}},"StrategicPartner_CustomerStatus":{"type":"string","description":"Customer account status:\n- UNKNOWN_COMPANY_STATUS: Unknown or unrecognized company status\n- CREATED: Customer record created\n- INVITED: Customer invited to join\n- INVITE_ACCEPTED: Customer accepted invitation\n- UNVERIFIED: Created but not yet verified\n- ACTIVE: Fully operational\n- INACTIVE: Temporarily suspended or closed\n","enum":["UNKNOWN_COMPANY_STATUS","CREATED","INVITED","INVITE_ACCEPTED","UNVERIFIED","ACTIVE","INACTIVE"]},"StrategicPartner_Pagination":{"required":["page","pageSize","totalCount"],"type":"object","properties":{"page":{"minimum":1,"type":"integer","description":"Current page number (1-indexed)"},"pageSize":{"maximum":100,"minimum":1,"type":"integer","description":"Number of items per page"},"totalCount":{"minimum":0,"type":"integer","description":"Total number of items across all pages"},"totalPages":{"minimum":0,"type":"integer","description":"Total number of pages (calculated from totalCount and pageSize)"}}},"StrategicPartner_ErrorResponse":{"required":["code","correlationId","message","path","timestamp"],"type":"object","properties":{"timestamp":{"type":"string","description":"ISO-8601 UTC timestamp of when the error occurred","format":"date-time"},"code":{"type":"string","description":"HTTP status code category:\n- BAD_REQUEST: 400 - request validation or input error\n- UNAUTHORIZED: 401 - authentication failure\n- FORBIDDEN: 403 - authorization failure\n- NOT_FOUND: 404 - resource not found\n- CONFLICT: 409 - resource conflict\n- INTERNAL_SERVER_ERROR: 500 - unexpected server error\n- SERVICE_UNAVAILABLE: 503 - service unavailable\n"},"message":{"type":"string","description":"Human-readable summary of the error"},"path":{"type":"string","description":"The request path that caused the error"},"correlationId":{"type":"string","description":"Correlation ID for tracing this error across systems"},"errors":{"type":"array","description":"Field-level error details. Present only for validation errors (VALIDATION_ERROR); omitted or null for all other error types.","items":{"$ref":"#/components/schemas/StrategicPartner_ErrorItem"}},"error":{"required":["code","message","type"],"type":"object","properties":{"type":{"type":"object","description":"Error category for client-side handling:\n- ValidationError: Request validation failed\n- NotFoundError: Resource doesn't exist\n- ConflictError: Resource already exists or state conflict\n- AuthenticationError: Invalid credentials\n- AuthorizationError: Insufficient permissions\n- ServerError: Unexpected server error\n","enum":["ValidationError","NotFoundError","ConflictError","AuthenticationError","AuthorizationError","ServerError"]},"code":{"type":"object","description":"Common codes:\n- VALIDATION_FAILED: Request validation failed\n- RESOURCE_NOT_FOUND: Resource doesn't exist\n- RESOURCE_ALREADY_EXISTS: Duplicate resource\n- RESOURCE_CONFLICT: State conflict\n- AUTHENTICATION_FAILED: Invalid credentials\n- AUTHORIZATION_FAILED: Insufficient permissions\n- INTERNAL_ERROR: Server error\n","enum":["VALIDATION_FAILED","RESOURCE_NOT_FOUND","RESOURCE_ALREADY_EXISTS","RESOURCE_CONFLICT","AUTHENTICATION_FAILED","AUTHORIZATION_FAILED","INTERNAL_ERROR"]},"message":{"type":"object","description":"Human-readable error message"},"details":{"type":"object","description":"Field-level validation errors (only present for validation_error type)","items":{"$ref":"#/components/schemas/StrategicPartner_FieldError"}}},"description":"Deprecated: use top-level fields (timestamp, code, message, path, correlationId, errors) instead. This field will be removed in a future version.","deprecated":true}},"description":"Standard error response for all API errors"},"StrategicPartner_ErrorItem":{"required":["message"],"type":"object","properties":{"property":{"type":"string","description":"Property path that caused the error, using dot notation"},"message":{"type":"string","description":"Human-readable error message"}},"description":"Individual error item"},"StrategicPartner_FieldError":{"required":["field","message"],"type":"object","properties":{"field":{"type":"string","description":"Field path using dot notation for nested fields"},"message":{"type":"string","description":"Human-readable error message for this field"}},"description":"Field-level validation error"}}},"paths":{"/v1/partner/customers":{"get":{"tags":["Customers"],"summary":"List all customers","description":"Retrieves a paginated list of all customers associated with the partner.\n\nResults are returned in descending order by creation date (newest first).\n","operationId":"customersList","parameters":[{"name":"page","in":"query","description":"Page number (1-indexed)","required":false,"style":"form","explode":true,"schema":{"minimum":1,"type":"object","default":1}},{"name":"pageSize","in":"query","description":"Number of items per page","required":false,"style":"form","explode":true,"schema":{"maximum":100,"minimum":1,"type":"object","default":20}},{"name":"customerCode","in":"query","description":"Filter customers by exact customer code match","required":false,"style":"form","explode":true,"schema":{"type":"object"}}],"responses":{"200":{"description":"Customers retrieved successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StrategicPartner_CustomerListResponse"}}}},"400":{"description":"Bad Request - Validation failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StrategicPartner_ErrorResponse"}}}},"401":{"description":"Unauthorized - Missing or invalid authentication","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StrategicPartner_ErrorResponse"}}}},"500":{"description":"Internal Server Error - Unexpected server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StrategicPartner_ErrorResponse"}}}}}}}}}
```
## Get customer details
> Retrieves detailed information about a specific customer.
```json
{"openapi":"3.0.1","info":{"title":"Multiplier Public REST API","version":"1.0.0"},"tags":[{"name":"Customers","description":"Manage customer profiles and information"}],"servers":[{"url":"https://api.usemultiplier.com","description":"Production API / Partner Sandbox"},{"url":"https://release-api-gateway.api.usemultiplier.com","description":"MPL internal release environment"},{"url":"https://api-gateway.api.acc.staging.usemultiplier.com","description":"MPL internal staging"}],"security":[{"BearerAuth":[]}],"components":{"securitySchemes":{"BearerAuth":{"type":"http","description":"JWT Bearer token authentication.\n\nTo authenticate:\n1. Obtain a JWT token from your authentication endpoint\n2. Click the \"Authorize\" button above\n3. Enter your token in the format: your-jwt-token\n4. Click \"Authorize\" to apply to all requests\n\nThe token will be automatically included in the Authorization header\nas: Authorization: Bearer {token}\n","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"StrategicPartner_CustomerResponse":{"required":["currency","displayName","id","legalName","status"],"type":"object","properties":{"id":{"type":"string","description":"Unique customer identifier (UUID v7 format)"},"legalName":{"type":"string","description":"Official legal name of the customer"},"displayName":{"type":"string","description":"Display name for the customer"},"currency":{"type":"string","description":"Primary operating currency","enum":["AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYN","BYR","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNH","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GGP","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","IMP","INR","IQD","IRR","ISK","JEP","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LTL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLL","SOS","SPL","SRD","SSP","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TVD","TWD","TZS","UAH","UGX","USD","USN","UYI","UYU","UYW","UZS","VEF","VES","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XOF","XPD","XPF","XPT","XSU","XTS","XUA","YER","ZAR","ZMK","ZMW","ZWD","ZWL"]},"status":{"$ref":"#/components/schemas/StrategicPartner_CustomerStatus"},"customerCode":{"type":"string","description":"External customer identifier provided by the partner"}}},"StrategicPartner_CustomerStatus":{"type":"string","description":"Customer account status:\n- UNKNOWN_COMPANY_STATUS: Unknown or unrecognized company status\n- CREATED: Customer record created\n- INVITED: Customer invited to join\n- INVITE_ACCEPTED: Customer accepted invitation\n- UNVERIFIED: Created but not yet verified\n- ACTIVE: Fully operational\n- INACTIVE: Temporarily suspended or closed\n","enum":["UNKNOWN_COMPANY_STATUS","CREATED","INVITED","INVITE_ACCEPTED","UNVERIFIED","ACTIVE","INACTIVE"]},"StrategicPartner_ErrorResponse":{"required":["code","correlationId","message","path","timestamp"],"type":"object","properties":{"timestamp":{"type":"string","description":"ISO-8601 UTC timestamp of when the error occurred","format":"date-time"},"code":{"type":"string","description":"HTTP status code category:\n- BAD_REQUEST: 400 - request validation or input error\n- UNAUTHORIZED: 401 - authentication failure\n- FORBIDDEN: 403 - authorization failure\n- NOT_FOUND: 404 - resource not found\n- CONFLICT: 409 - resource conflict\n- INTERNAL_SERVER_ERROR: 500 - unexpected server error\n- SERVICE_UNAVAILABLE: 503 - service unavailable\n"},"message":{"type":"string","description":"Human-readable summary of the error"},"path":{"type":"string","description":"The request path that caused the error"},"correlationId":{"type":"string","description":"Correlation ID for tracing this error across systems"},"errors":{"type":"array","description":"Field-level error details. Present only for validation errors (VALIDATION_ERROR); omitted or null for all other error types.","items":{"$ref":"#/components/schemas/StrategicPartner_ErrorItem"}},"error":{"required":["code","message","type"],"type":"object","properties":{"type":{"type":"object","description":"Error category for client-side handling:\n- ValidationError: Request validation failed\n- NotFoundError: Resource doesn't exist\n- ConflictError: Resource already exists or state conflict\n- AuthenticationError: Invalid credentials\n- AuthorizationError: Insufficient permissions\n- ServerError: Unexpected server error\n","enum":["ValidationError","NotFoundError","ConflictError","AuthenticationError","AuthorizationError","ServerError"]},"code":{"type":"object","description":"Common codes:\n- VALIDATION_FAILED: Request validation failed\n- RESOURCE_NOT_FOUND: Resource doesn't exist\n- RESOURCE_ALREADY_EXISTS: Duplicate resource\n- RESOURCE_CONFLICT: State conflict\n- AUTHENTICATION_FAILED: Invalid credentials\n- AUTHORIZATION_FAILED: Insufficient permissions\n- INTERNAL_ERROR: Server error\n","enum":["VALIDATION_FAILED","RESOURCE_NOT_FOUND","RESOURCE_ALREADY_EXISTS","RESOURCE_CONFLICT","AUTHENTICATION_FAILED","AUTHORIZATION_FAILED","INTERNAL_ERROR"]},"message":{"type":"object","description":"Human-readable error message"},"details":{"type":"object","description":"Field-level validation errors (only present for validation_error type)","items":{"$ref":"#/components/schemas/StrategicPartner_FieldError"}}},"description":"Deprecated: use top-level fields (timestamp, code, message, path, correlationId, errors) instead. This field will be removed in a future version.","deprecated":true}},"description":"Standard error response for all API errors"},"StrategicPartner_ErrorItem":{"required":["message"],"type":"object","properties":{"property":{"type":"string","description":"Property path that caused the error, using dot notation"},"message":{"type":"string","description":"Human-readable error message"}},"description":"Individual error item"},"StrategicPartner_FieldError":{"required":["field","message"],"type":"object","properties":{"field":{"type":"string","description":"Field path using dot notation for nested fields"},"message":{"type":"string","description":"Human-readable error message for this field"}},"description":"Field-level validation error"}}},"paths":{"/v1/partner/customers/{customerId}":{"get":{"tags":["Customers"],"summary":"Get customer details","description":"Retrieves detailed information about a specific customer.","operationId":"customerGet","parameters":[{"name":"customerId","in":"path","description":"Customer ID","required":true,"style":"simple","explode":false,"schema":{"type":"object"}}],"responses":{"200":{"description":"Customer details retrieved successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StrategicPartner_CustomerResponse"}}}},"401":{"description":"Unauthorized - Missing or invalid authentication","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StrategicPartner_ErrorResponse"}}}},"404":{"description":"Not Found - Resource does not exist","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StrategicPartner_ErrorResponse"}}}},"500":{"description":"Internal Server Error - Unexpected server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StrategicPartner_ErrorResponse"}}}}}}}}}
```
---
# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.
## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.
Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:
```
GET https://developer.usemultiplier.com/api-reference/partner-management/customers.md?ask=&goal=
```
`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.
Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.