V1.1 Get IP Notifications by Inquiry

Owned by Marko Milojevic
Last updated: Apr 22, 2024 by Timm Weitzel
7 min read

Introduction

To obtain the payload of multiple inquiries, belonging to one single broker, the Thinksurance Public API V2, denoted as "the API," offers a specialised endpoint. This endpoint allows consumers to retrieve all relevant inquiry information

Endpoint

To search for a list of inquiries belonging to the specific broker, consumers should send a HTTP GET request to endpoint /api/ipn/inquiries. As essential components of the JSON payload within the body of the request, consumers are required to include bToken (functioning as the broker identifier).

Action name

search inquiries

HTTP path

/api/ipn/inquiries

HTTP method

GET

Attributes of the HTTP request

HTTP Request Header

HTTP Request Header

Authorization

string

required

A security token provided from Authentication endpoint.
Required to provide as a Bearer Token (in format: “Bearer {{token}}“).

X-Broker-Token

string

optional1

An unique identifier of the broker.

X-Account-Token

string

optional1

An unique identifier of the account.

HTTP GET parameters

inquiryId

int

optional

An unique identifier of the inquiry.

lastDays

int

optional

If defined, only inquiries that were created or updated that last number of days, will be included in the result. Otherwise, inquiries created or updated in last three months will be included.

Explanations:

1 at least one of bToken and aToken is required in the payload

Attributes of the HTTP response

See IP Notification Response

Examples

This section shows examples of different HTTP requests and responses associated with the endpoint.

HTTP Request with simple payload

# HTTP GET # https://ipn.dev.thinksurance.de/api/ipn/inquiries # # HTTP headers # 'Accept': 'application/json' # 'Authorization': 'Bearer <some long string value>' # 'X-Broker-Token': '<some hash>' #

HTTP Request with inquiry identifier

# HTTP GET # https://ipn.dev.thinksurance.de/api/ipn/inquiries?inquiryId=123456 # # HTTP headers # 'Accept': 'application/json' # 'Authorization': 'Bearer <some long string value>' # 'X-Broker-Token': '<some hash>' #

HTTP Request with last days specified

# HTTP GET # https://ipn.dev.thinksurance.de/api/ipn/inquiries?inquiryId=123456&lastDays=1 # # HTTP headers # 'Accept': 'application/json' # 'Authorization': 'Bearer <some long string value>' # 'X-Broker-Token': '<some hash>' #

Successful HTTP Response

Failed HTTP Response