Skip to main content
GET
/
v1
/
{tenantId}
/
customers
/
by-reference-id
/
{referenceId}
Get customer by reference id
curl --request GET \
  --url https://api.debbiecollect.com/v1/{tenantId}/customers/by-reference-id/{referenceId} \
  --header 'Authorization: Bearer <token>'
{
  "creditorId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "createdAt": "<string>",
  "customerId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "tenantId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "referenceId": "<string>",
  "isCompany": true,
  "users": [
    {
      "userId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "id": 123,
      "relation": "debtor",
      "contact": true,
      "customerId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "lang": "bm",
      "details": {
        "name": "<string>",
        "cpr": "<string>",
        "cvr": "<string>",
        "email": "<string>",
        "phone": {
          "number": "<string>",
          "locale": "<string>"
        },
        "address": {
          "address": "<string>",
          "coAddress": "<string>",
          "zipcode": "<string>",
          "city": "<string>",
          "country": "<string>"
        },
        "geocode": {
          "latitude": 123,
          "longitude": 123
        }
      }
    }
  ],
  "cases": [
    {
      "caseId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "id": 123,
      "status": "PENDING",
      "endReason": "PAID",
      "statusTime": "<string>",
      "createdAt": "<string>"
    }
  ]
}

Authorizations

Authorization
string
header
required

Authentication can be done by using a bearer token in the Authorization header. This is done using the following format Authorization: Bearer {token}.

Path Parameters

tenantId
string<uuid>
required

Id of the tenant the customer is related to

referenceId
string
required

Customer id that the customer is related to

Query Parameters

creditorId
string
required

Creditor id that the customer is related to

Response

Successful operation

creditorId
string<uuid>

Id of creditor

createdAt
string

Customer created at

customerId
string<uuid>

Id of the customer

tenantId
string<uuid>

Id of the tenant

referenceId
string

Reference id of the customer. Typically id of the customer, client, patient or similar.

isCompany
boolean

Whether the customer is a company.

users
object[]

List of users related to this customer

cases
object[]

List of cases related to this customer