Skip to main content
Retrieve an award

Authorizations

Authorization
string
header
required

A Tightknit admin API key, sent as Authorization: Bearer <key>.

Path Parameters

award_id
string
required

The award's id.

Pattern: ^awrd_[a-zA-Z0-9]{12}$

Query Parameters

expand

Repeatable. Returns the named relation inline. One of: created_by, badge_image_file, overlay_frame_image_file, cert_template_image_file, announcement_channel.

Available options:
created_by,
badge_image_file,
overlay_frame_image_file,
cert_template_image_file,
announcement_channel

Response

Success

object
enum<string>
required

Always award.

Available options:
award
id
string
required

Unique identifier for the object.

Example:

"awrd_7k3m2p9x4nqr"

created_at
string<date-time>
required

When the object was created.

updated_at
string<date-time> | null
required

When the award was last changed. Null on awards not edited since before edits were tracked.

label
string
required

The award's name, as members see it.

slug
string
required

The award's path segment on the community site's achievements page.

Example:

"completion-badge"

description
object | null
required

What the award means and how it is earned, as a rich text document. Null when none is set.

description_html
string | null
required

The description rendered as sanitized HTML. Null when none is set.

default_message
object | null
required

The message sent with the award notification when the giver writes none, as a rich text document. Null when none is set.

default_message_html
string | null
required

The default_message rendered as sanitized HTML. Null when none is set.

requires_approval
boolean
required

Whether the award is marked as needing admin approval when a non-admin gives it. Tightknit does not enforce it.

can_be_given_by_non_admin
boolean
required

Whether members with the give award permission may give it, rather than admins only.

created_by_id
string | null
required

The id of the profile that created the award. Null when no member is recorded as its creator.

badge_image_file_id
string | null
required

The id of the badge image file. Null when the award has no badge.

overlay_frame_image_file_id
string | null
required

The id of the frame image overlaid on a recipient's profile photo. Null when the award has no frame.

cert_template_image_file_id
string | null
required

The id of the background image certificates are generated on. Null when the award has no certificate.

settings
object
required

How the award is presented to recipients.

integrations
object
required

The award's settings in connected platforms.

created_by
object | null

The profile that created the award. Present only when created_by is expanded.

badge_image_file
object | null

The badge image. Present only when badge_image_file is expanded.

overlay_frame_image_file
object | null

The profile photo frame image. Present only when overlay_frame_image_file is expanded.

cert_template_image_file
object | null

The certificate template image. Present only when cert_template_image_file is expanded.