GET notifications/receivers

This service allows a sender to obtain the set of receivers matching the query parameters.

The response contains a set of active receivers. For each receiver, the public key and the corresponding ReceiverId is returned.

This allows the sender to create a dedicated end-to-end encryption for the concerned receiver.

Parameters

Name	Type	Required	Description

Name	Type	Required	Description
x-correlation-id	header	Y	ID of the transaction. Use this ID for log tracing and incident handling
limit	query	N	How many results need to be returned
offset	query	N	The first position to return from the results of the query. The default is 0, which starts the page at the first result.
phoneNumber	query	N	Phone number to query receivers for
ssin	query	N	SSIN to query receivers for

Example request

GET /api/v1/pushNotifications/notifications/receivers?phoneNumber=32490000011&limit=100&offset=0
x-correlation-id: 68b8653f-8041-48e3-a68d-28ca8bcae874
Authorization: Bearer ZZZZZZZZ

Example response


  "totalAmount": 1,
  "receivers": [
        {
            "id": "03dcff0a-2a49-4c16-8ae8-79bbdebedc20",
            "publicKey": "qvV6mZtEREtrg-zLbg-3YR2R_1RFfBrURsyX4X-o98q29-4o415HjI_A1z76MulZutomYskNnHlQKR7FSDJKxu5cpQ4a2mt0l0ChaQ_3O6Gz_5TySyGWFjDivxOR5FRPaz65QmZKZ8eNAPmIPvxvuTs-A7tdzV9Hc_1crF5f96S7bPHBl_8oWsQknicVpzEeHk27xVn2hKCx7BPcK45_05PnLBqJs47bYlR3OlTJY4Y3XXLVqMmrc5MreZI2f5vxJcOWZXzywL7ukTMvNQSKCjtl4WC5Lzjfpo29zrhrsES1Cee9vWVpB3QdP2RxG5ewER4J56ofIw-CRKNkf4IctQ=="
        }  
  ]
}

MAGDA Gebruikersomgeving

GET notifications/receivers

Parameters

Related pages

De MAGDA Gebruikersomgeving is een officiële website van de Vlaamse overheid