Search customer - client mode

Only the client needs to be logged in to use this endpoint. The user does not need to be logged in, click here to read more.

This API allows to retrieve information about one or more customers.

Search results may be one or more customers, depending on the arguments used and what is actually present in the database.

In combination with customer number and name, you can also fill in the product. This will "shrink" search result.

Requirements for fields:

Searching by name or address require following fields to be set in request:

companyName or lastName

streetAddress

postalCode or postalPlace

Otherwise one of following fields to be set in request:

phoneNumber

email

Response

The response is a list of customers found. The list is empty if no customer is found.

Number of customers in response are limited to 5 customers.

curl --location --request POST 'https://api.mediaconnect.no/capi/v1/client/customer/search' \ --header 'Content-Type: application/json' \ --data-raw '{ "productCode": "CO27409", "companyName": "Company International Ltd", "departmentName": "Support", "firstName": "Ola", "middleName": "Fjordstrand", "lastName": "Nordmann", "careOfAddress": "", "streetAddress": "Grubbegata", "streetNumber": 6, "entrance": "A", "postalCode": 179, "postalPlace": "Oslo", "countryCode": "NO", "phoneNumber": "+4712345678", "email": "ola.nordmann@company.com" }'

{ "customers": [ { "customerNumber": 563457, "companyName": "Company International Ltd", "departmentName": "Support", "firstName": "Ola", "middleName": "Fjordstrand", "lastName": "Nordmann", "streetAddress": "Grubbegata", "streetNumber": 6, "postalCode": 179, "postalPlace": "Oslo", "postalAddress": "Postboks 265 Økern", "postalAddressPostalCode": "0510", "postalAddressPostalPlace": "Oslo", "countryCode": "NO", "emails": { "email": [ "ola.nordmann@company.com", "ola.nordmann@hotmail.no" ] }, "phoneNumbers": [ { "phoneNumber": "+4712345678", "isMobile": true }, { "phoneNumber": "+4723339100", "isMobile": false } ] } ] }

Request

Authorization

OAuth 2.0

Client Credentials

Add the parameter

Authorization

to Headers，whose value is to concatenate the Token after the Bearer.

Example:

Authorization: Bearer ********************

Token URL: https://connectid.no/user/oauth/token

Refresh URL: https://connectid.no/user/oauth/token

Scopes:

read-For all access

Body Params application/json

productCode

string

optional

Product code to match in search.

<= 12 characters

companyName

string

optional

Company name to match in a name/address search.

<= 40 characters

departmentName

string

optional

Department name to match in a name/address search.

<= 40 characters

firstName

string

optional

First name to match in a name/address search.

<= 30 characters

middleName

string

optional

Middle name to match in a name/address search.

<= 30 characters

lastName

string

optional

Last name to match in a name/address search.

<= 30 characters

careOfAddress

string

optional

Care of address to match in a name/address search.

<= 40 characters

streetAddress

string

optional

Street name to match in a name/address search.

<= 40 characters

streetNumber

integer

optional

Street number to match in a name/address search.

entrance

string

optional

Entrance to match in a name/address search.

<= 12 characters

postalCode

string

optional

Postal code to match in a name/address search.

<= 10 characters

postalPlace

string

optional

Postal place to match in a name/address search.

<= 30 characters

countryCode

string

optional

Country code, in ISO 3166-2 format, to match in a search.

<= 3 characters

phoneNumber

string

optional

Phone number to match in a search.

A phone number has to follow the telephone number standard E.164

<= 20 characters

string <email>

optional

Email to match in a search.

<= 255 characters

Examples

Responses

🟢200OK

application/json

Body

customers

array [object {16}]

optional

<= 5 items

customerNumber

integer

optional

Customer number

companyName

string

optional

Company name

<= 40 characters

departmentName

string

optional

Department name

<= 40 characters

firstName

string

optional

First name

<= 30 characters

middleName

string

optional

Middle name

<= 30 characters

lastName

string

optional

last name

<= 30 characters

streetAddress

string

optional

Street address

<= 40 characters

streetNumber

integer

optional

Street number

postalCode

string

optional

Postal code street address

<= 10 characters

postalPlace

string

optional

Postal place street address

<= 30 characters

postalAddress

string

optional

Postal address

<= 40 characters

postalAddressPostalCode

string

optional

Postal code postal address

<= 10 characters

postalAddressPostalPlace

string

optional

Postal place postal address

<= 30 characters

countryCode

string

optional

Country code, in ISO 3166-2 format

<= 3 characters

emails

object

optional

List with emails

phoneNumbers

array [object {2}]

optional

List with phone numbers

🟠400Bad Request

🟠403Forbidden

🟠429429

🔴500Server Error