Skip to main content
GET
/
customers
/
{customerId}
Get Customer
curl --request GET \
  --url https://api.example.com/customers/{customerId}
{
  "type": "<string>",
  "id": "<string>",
  "createdAt": "<string>",
  "lastModifiedAt": "<string>",
  "policies": [
    "<string>"
  ],
  "invoices": [
    "<string>"
  ],
  "role": "<string>",
  "customFields": [
    {
      "key": "<string>",
      "value": "<string>"
    }
  ],
  "name": "<string>",
  "preferredPaymentMethodId": "<string>"
}

Documentation Index

Fetch the complete documentation index at: https://docs.korint.io/llms.txt

Use this file to discover all available pages before exploring further.

Path Parameters

​
customerId
string
required

The customer id

Query Parameters

​
whenAt
string

Optional: the whenAt datetime

​
simulatedAt
string

Optional: the simulatedAt datetime

​
branchId
string

Optional: the branchId

Response

​
type
string
required

Type of the customer

​
id
string
required

Unique identifier for the customer

​
createdAt
string
required

Date and time when the customer was created

​
lastModifiedAt
string
required

Date and time when the customer was last modified

​
status
enum<string>
required

Status of the customer

Available options:
CUSTOMER_CREATED,
CUSTOMER_CONFIRMED
​
policies
string[]
required

Policies associated with the customer

​
invoices
string[]
required

Array of invoice identifiers associated with the customer

​
role
string
required

Customer business role

​
paymentMode
enum<string>
required
Available options:
DIRECT_DEBIT,
BANK_TRANSFER
​
customFields
object[]

custom fields per product

​
name
string

Optional: Name of the entity

​
preferredPaymentMethodId
string

Optional: Preferred payment method of the customer