Skip to content
Komplett LogoKomplett Platform

Get customer by ID

GET
/v1/{customerId}
curl --request GET \
  --url https://example.com/customers/v1/example

Retrieves a single customer by their unique ID.

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
customerId
required
string

Responses

Section titled “Responses”

200

Section titled “200”

OK

Media typeapplication/json
object
customer
required
object
customerId
required
string
name
required
string
email
null | string
mobile
null | string
customerType
required
string
isB2B
boolean
isPublic
boolean
country
required
string
primaryAddress
One of:
null
organizationNumber
null | string
organizationData
One of:
null
Examplegenerated
{
  "customer": {
    "customerId": "example",
    "name": "example",
    "email": "example",
    "mobile": "example",
    "customerType": "example",
    "isB2B": true,
    "isPublic": true,
    "country": "example",
    "primaryAddress": {
      "streetLine1": "example",
      "streetLine2": "example",
      "postalCode": "example",
      "city": "example",
      "country": "example"
    },
    "organizationNumber": "example",
    "organizationData": {
      "subOrganizationName": "example",
      "subOrganizationNumber": "example",
      "organizationCountry": "example",
      "organizationIds": "example"
    }
  }
}

400

Section titled “400”

Bad Request

Media typeapplication/json
object
type
null | string
title
null | string
status
null | integer | string format: int32
/^-?(?:0|[1-9]\d*)$/
detail
null | string
instance
null | string
errors
required
Array<object>
object
fieldName
required
string
message
required
string
code
required
string
traceId
required
string
Examplegenerated
{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "example",
  "errors": [
    {
      "fieldName": "example",
      "message": "example"
    }
  ],
  "code": "example",
  "traceId": "example"
}

401

Section titled “401”

Unauthorized

Media typeapplication/json
object
type
null | string
title
null | string
status
null | integer | string format: int32
/^-?(?:0|[1-9]\d*)$/
detail
null | string
instance
null | string
code
required
string
traceId
required
string
Examplegenerated
{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "example",
  "code": "example",
  "traceId": "example"
}

403

Section titled “403”

Forbidden

Media typeapplication/json
object
type
null | string
title
null | string
status
null | integer | string format: int32
/^-?(?:0|[1-9]\d*)$/
detail
null | string
instance
null | string
code
required
string
traceId
required
string
Examplegenerated
{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "example",
  "code": "example",
  "traceId": "example"
}

404

Section titled “404”

Not Found

Media typeapplication/json
object
type
null | string
title
null | string
status
null | integer | string format: int32
/^-?(?:0|[1-9]\d*)$/
detail
null | string
instance
null | string
code
required
string
traceId
required
string
Examplegenerated
{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "example",
  "code": "example",
  "traceId": "example"
}

500

Section titled “500”

Internal Server Error

Media typeapplication/json
object
type
null | string
title
null | string
status
null | integer | string format: int32
/^-?(?:0|[1-9]\d*)$/
detail
null | string
instance
null | string
code
required
string
traceId
required
string
Examplegenerated
{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "example",
  "code": "example",
  "traceId": "example"
}