B2Core API REST API The Front Office API Client types

Client types

Use these methods to obtain information about the available client types.

GET[host]/api/v2/my/types	Get a list of client types
GET[host]/api/v2/my/types/{typeId}	Get client type details

Get a list of client types

Use this method to obtain a list of the available client types.

Request

Header parameters:

• accept-language: <string>

• Accept: application/json

• Authorization: Bearer <token>

GET[host]/api/v2/my/types

curl --location --request GET 'https://host.name/api/v2/my/types?limit=10&offset=0&sort_order=desc' \
--header 'accept-language: <string>' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer <token>'

Response

A response includes an array of Client Type objects providing information about the available client types.

Get client type details

Use this method to obtain detailed information about a specified client type.

Request

Header parameters:

• accept-language: <string>

• Accept: application/json

• Authorization: Bearer <token>

Path parameters:

typeId required

The client type identifier.

GET[host]/api/v2/my/types/{typeId}

curl --location --request GET 'https://host.name/api/v2/my/types/1' \
--header 'accept-language: <string>' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer <token>'

Response

A response includes a Client Type object providing information about the specified client type.