Skip to main content
Retrieve a milestone

Authorizations

Authorization
string
header
required

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

Path Parameters

milestone_id
string
required

The milestone's id.

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

Query Parameters

expand

Repeatable. Returns the named relation inline. One of: created_by.

Available options:
created_by

Response

Success

object
enum<string>
required

Always milestone.

Available options:
milestone
id
string
required

Unique identifier for the object.

Example:

"mile_5v8b1c6d2fgh"

created_at
string<date-time>
required

When the object was created.

updated_at
string<date-time>
required

When the object was last changed.

label
string
required

The milestone’s name, as members see it.

action
enum<string>
required

What a member does to make progress on the milestone. One of:

  • join_workspace: the member joins the Slack workspace.
  • register_for_event: the member registers for an event, counted once per event.
  • num_reactions_given_not_to_self: the member reacts to another member’s message, counted per reaction.
  • num_reactions_received_not_from_self: the member receives a reaction from another member on their message, counted per reaction.
  • send_post_in_channel: the member sends a top-level message in a channel.
  • send_reply_in_channel_not_to_self: the member replies in a thread on another member’s message, counted once per thread.
  • num_msgs_reacted_to_not_to_self: the member reacts to another member’s message, counted once per message.
  • num_msgs_that_received_react_not_from_self: the member has a message receive a reaction from another member, counted once per message.
  • send_message_in_channel_not_to_self: the member sends a top-level message, or a reply to another member’s message, in a channel.
  • num_polls_voted_in: the member votes in a poll that is not anonymous, counted once per poll.
  • log_in_to_forums_site: the member signs in to the community site, counted per sign-in.
  • update_slack_profile_photo: the member sets a custom Slack profile photo in place of the default avatar.
  • num_replies_selected_as_answer_not_from_self: the member has a reply marked as an answer by someone else, counted once per reply.
  • join_slack_channel: the member joins one of the Slack channels the milestone names.
Available options:
join_workspace,
register_for_event,
num_reactions_given_not_to_self,
num_reactions_received_not_from_self,
send_post_in_channel,
send_reply_in_channel_not_to_self,
num_msgs_reacted_to_not_to_self,
num_msgs_that_received_react_not_from_self,
send_message_in_channel_not_to_self,
num_polls_voted_in,
log_in_to_forums_site,
update_slack_profile_photo,
num_replies_selected_as_answer_not_from_self,
join_slack_channel
sort_order
integer
required

Where the milestone sits in its journey, lowest first. A journey’s milestones expansion comes in this order; a list of milestones comes newest first.

multiplier
integer | null
required

How many times the action must be done to complete the milestone. Null for a once-only action, and on older milestones saved without one, which cannot be completed.

scoped_to_emoji_name
string | null
required

The emoji a reaction must use to count, by its Slack name without colons or skin tone. A reaction with any skin tone of it counts. Null when any emoji counts.

achievements_count
integer
required

How many members have completed the milestone.

Required range: x >= 0
journey_id
string
required

The id of the journey the milestone belongs to.

created_by_id
string | null
required

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

integrations
object
required

The milestone’s settings in connected platforms.

created_by
object | null

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