Skip to main content
GET
Get Testimonial

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

id
string
required

Testimonial ID returned by List Testimonials.

Required string length: 1 - 255

Response

Testimonial details

id
string<uuid>
required

Testimonial ID.

status
enum<string>
required

Submission status. Includes unfinished testimonials.

Available options:
new,
rating,
submit,
ready
source
string
required

Testimonial source. banner means the review banner. May contain a custom value.

rating
integer | null
required

Star rating. Completed submissions have a rating from 1 to 5. Unfinished submissions can be unrated.

created_at
string<date-time>
required

Date the testimonial was created.

product_id
string<uuid> | null
required

Program ID, including programs linked through a milestone step. Null for school testimonials.

products_step_id
string<uuid> | null
required

Milestone step ID, when applicable.

member
object
required
review
string
required

Testimonial text rendered as HTML. Can be empty when no text has been submitted.

video_url
string<uri> | null
required

Attached video URL, or null if absent. Hosted videos use video_id and video_embed_url.

file_url
string<uri> | null
required

URL of the attached testimonial file. Null when absent.

video_id
string | null
required

Hosted video ID, or null if absent. Copied videos retain the original ID.

video_status
string | null
required

Last saved video processing status.

video_embed_url
string<uri> | null
required

Video player URL when processing is complete and the video library is configured. Otherwise null.

video_poster_url
string<uri> | null
required

URL of the attached video poster. Null when absent.