Nayya.com
API Reference
API Reference

List nudges for an employer

get
https://integrate.nayya.com/partner-relay/employers//nudges
Path Params
string
required

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

Query Params
boolean

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

string
enum
Allowed:
string

Filter by Nayya internal employee UUID

string

Filter by SOR-native employee identifier

string

Filter by SOR-native employer identifier

string

Filter by nudge source

number
≥ 1
Defaults to 1
number
1 to 100
Defaults to 50

Number of results per page.

Headers
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

Updated 4 months ago

Did this page help you?
Language
Credentials
Bearer
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 4 months ago

Did this page help you?