List nudges for an employee

get

https://integrate.nayya.com/partner-relay/employers/{employerId}/employees/{employeeId}/nudges

Path Params

employerId

string

required

Nayya employer UUID or external ID prefixed with external: (e.g. external:abc-123)

employeeId

string

required

Nayya employee UUID or external ID prefixed with external: (e.g. external:abc-123)

Query Params

includeExpired

boolean

Include expired nudges. Defaults to false — only active, in-window nudges are returned.

nudgeType

string

enum

Allowed:

externalEmployeeId

string

Filter by SOR-native employee identifier

externalEmployerId

string

Filter by SOR-native employer identifier

nudgeSource

string

Filter by nudge source

page

number

≥ 1

Defaults to 1

perPage

number

1 to 100

Defaults to 50

Number of results per page.

Headers

X-API-Version

string

Defaults to 1

Optional API major version. Omit this header for the same behavior as 1 (this specification).

Responses

401

Missing or invalid JWT

403

Employer not in token scope

Language

Credentials

Bearer

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200