API Reference

Retrieve the plans selected by the employee during the decision support process.

These plans should be mapped to the plans in your system using the plan_id attribute.

Path Params
string
required

The unique ID from Nayya or your internal unique ID prefixed with the external: indicator that represents an employee (Ex. external:3438yht-hg8ht39-h23uh9th-uewht0o).

Body Params
integer
≥ 1
Defaults to 1

Page number for pagination.

integer
1 to 2000
Defaults to 50

Quantity of records per page.

Responses

Response body
object
data
array of objects
data
object
string

Nayya's unique id representing the plan that the employee has selected.

string | null

Your internal ID that represents this plan. If you are using our API with your internal IDs, use this ID any time you want to refer to this plan at a later date.

meta
object
integer
integer
integer
401

Unauthorized

404

Not Found

Language
Credentials
URL