Segments

Get a segment

One segment of the scope the call names: the workspace, or the keyword group in groupId. A segment saved in another scope is a 404.

get/v1/segments/{id}

Request

  • Base URL: https://api.mentio.dev
  • URL: https://api.mentio.dev/v1/segments/{id}
  • Auth: HTTP bearer

Path parameters

idstring required

Segment id (seg_...).

Example:seg_abc123

Query parameters

groupIdstring

Scope to one keyword group (grp_...): only people who mentioned that group's keywords, with that group's own tags, notes, mute, merges, activities and segments. Omit for the whole workspace.

Response

One segment, with its current size

idstring required

Segment id (seg_...).

namestring required
descriptionstring required
groupIdstring nullable required

The group this segment belongs to, or null for a workspace segment.

countinteger required

People in the segment right now; it is evaluated on every read.

createdAtstring required

ISO 8601 timestamp, UTC.

updatedAtstring required

ISO 8601 timestamp, UTC.

Changes

No recorded changes to this operation across all 1 revision of this API.