# Plan Rollouts API

Version: v1

## Servers

Sandbox
```
https://api.rollouts.sb3.plannotice.com/
```

Production
```
https://api.planrollouts.com/
```

## Download OpenAPI description

[Plan Rollouts API](https://docs.plannotice.com/_bundle/Plan%20Rollouts%20API/swagger.yaml)

## OAuth

### API Token

 - [POST /api/v1/OAuth/Token](https://docs.plannotice.com/plan-rollouts-api/swagger/oauth/paths/~1api~1v1~1oauth~1token/post.md): Retrieves a token using client credentials provided by Plan Notice.

## Participants

### Request Rollout Notice

 - [POST /api/v1/Participants](https://docs.plannotice.com/plan-rollouts-api/swagger/participants/paths/~1api~1v1~1participants/post.md): This API submits a Participant Rollout Request to initiate the sending of a rollout notice.

### Get Status

 - [GET /api/v1/Participants/status](https://docs.plannotice.com/plan-rollouts-api/swagger/participants/paths/~1api~1v1~1participants~1status/get.md): This API fetches the status of rollout notices based on Erisa EIN, Erisa Plan Number, SSN, and externalReferenceId.
            At least one parameter (Erisa EIN, Erisa Plan Number, ssn, or externalReferenceId) must be provided.
            If multiple parameters are used, they will be ANDed together to create the results.

### Get Status

 - [POST /api/v1/Participants/status](https://docs.plannotice.com/plan-rollouts-api/swagger/participants/paths/~1api~1v1~1participants~1status/post.md): This API fetches the status of notices based on Erisa EIN and Erisa Plan Number or date range.

### Upload PDF File

 - [POST /api/v1/Participants/upload-pdf](https://docs.plannotice.com/plan-rollouts-api/swagger/participants/paths/~1api~1v1~1participants~1upload-pdf/post.md): Accept PDF uploads, validate, store files, and return URLs for use in API requests.