GET/api/v2/referrals/reviews/{reviewId}

GET /api/v2/referrals/reviews/{reviewId}

Authentication

Send your API key in the x-api-key header on every request.

Parameters

Request parameters
FieldTypeRequiredDescription
reviewId (path)string (uuid)Yes

Responses

200 — OK

Response 200 fields
FieldTypeRequiredDescription
Idstring (uuid)Yes
ProgramIdstring (uuid)Yes
RelationshipIdstring (uuid)Yes
InviterUserIdunknownYes
FriendUserIdunknownYes
StatusstringYes
RevisionunknownYes
CreatedAtstring (date-time)Yes
UpdatedAtstring (date-time)Yes
Signalsarray of ReferralRiskSignalResponseYes

Example request

curl -X GET "https://{base_url}/api/v2/referrals/reviews/{reviewId}" \
  -H "x-api-key: YOUR_API_KEY"

This page is generated from the live OpenAPI specification and always matches the current API.