Copy page

Common workflows

Find customer by phone number

Use this workflow to find one or more Customers by phone number.

This is typically used when an external system has a customer phone number and needs to find the corresponding UtilityCloud customer GUID.

Endpoint

Code
POST /v1/cm/customers/phone

When to use

Use this workflow when an external system needs to find a customer based on a known phone number.

Typical use cases include:

• looking up a customer from a self-service solution
• finding a customer from a CRM or customer support system
• matching incoming customer requests to existing UtilityCloud customers
• retrieving the UtilityCloud customer GUID before calling other customer-related endpoints

Request structure

The request contains a PhoneNumber field.

Code
{
  "PhoneNumber": "23232323"
}

The phone number can be provided with or without the Norwegian +47 country calling code.

Example request

Code
{
  "PhoneNumber": "23232323"
}

Response

The response contains a CustomerGuids array with one or more matching UtilityCloud customer GUIDs.

Code
{
  "CustomerGuids": [
    "0d419e7c-e7a6-4b8f-a3b7-70382f39081b"
  ]
}

Response fields

Field	Description
CustomerGuids	List of UtilityCloud customer GUIDs matching the provided phone number.

Notes

The response may contain more than one customer GUID if the same phone number is registered on multiple customers.

Use the returned customer GUID when calling endpoints that require the UtilityCloud customer identifier.

Always verify that the returned customer is the expected customer before using the result in a business process such as contract creation, customer update, or synchronization.

For broader customer search, use the free text customer search workflow.

Related endpoints

Code
POST /v1/cm/customers/phone
POST /v1/cm/customers/search
POST /v1/cm/search/customer
GET /v1/cm/customer/{guid}
POST /v1/cm/contracts