# Subscriber

Subscriber represents a consumer of StatusHub notifications that
can have multiple subscriptions.<br>
Those endpoints are typically used in one of two situations:
- User is interested in subscriptions only for specific person or entity
  instead of seeing or managing subscriptions for the whole Hub,
- SAML Hub protection method is being used. This results in subscriber
  record containing SAML NameID value in `idp_id` field.


## Create a Subscriber

 - [POST /hubs/{subdomain}/subscribers](https://api-docs.statushub.com/api-v3-openapi/subscriber/createsubscriber.md): Creates a new Subscriber. Main purpose of Subscriber is to create a record to which later one or many subscriptions can be added. One Subscriber can have multiple methods of communication associated with it. It also allows to set SAML NameID that can be then used to recognize Subscriber after sign-in into protected Hub Page.

## List Subscribers

 - [GET /hubs/{subdomain}/subscribers](https://api-docs.statushub.com/api-v3-openapi/subscriber/listsubscribers.md): Filters and returns Subscribers for current Hub with basic info.

## Retrieve a Subscriber

 - [GET /hubs/{subdomain}/subscribers/{subscriber_id}](https://api-docs.statushub.com/api-v3-openapi/subscriber/getsubscriber.md): Returns data about single Subscriber.

## Updates a Subscriber

 - [PUT /hubs/{subdomain}/subscribers/{subscriber_id}](https://api-docs.statushub.com/api-v3-openapi/subscriber/updatesubscriber.md): Modifies existing Subscriber. Only modified attributes may be passed in payload. All other attributes will remain unchanged.

## Delete a Subscriber

 - [DELETE /hubs/{subdomain}/subscribers/{subscriber_id}](https://api-docs.statushub.com/api-v3-openapi/subscriber/deletesubscriber.md): Deletes Subscriber record. Records are soft-deleted which means that such deleted record can still be viewed. Deleting Subscriber also deletes all its Subscriptions.