segments

Get a segment

Returns a single segment. The segment must belong to the active project.

get/api/v1/segments/{segment}

Request

  • Base URL: https://pineprompt.com
  • URL: https://pineprompt.com/api/v1/segments/{segment}
  • Auth: HTTP bearer

Path parameters

segmentinteger required
Example:7

The numeric ID of the segment.

Query parameters

includestring
Example:project

A comma-separated list of related resources to include in the response. Allowed values: project, project.organization.

Headers

Pineprompt-Project-Idinteger required

The active project's numeric ID.

Response

OK

idinteger

The unique ID of the segment.

project_idinteger

The ID of the project this segment belongs to.

namestring

The display label of the segment.

created_atstring date-time

When the segment was created.

updated_atstring date-time

When the segment was last updated.

Example response

{
  "id": 7,
  "project_id": 42,
  "name": "Direct Competitors",
  "project": {
    "id": 42,
    "organization_id": 7,
    "name": "Acme Marketing",
    "brand_id": 555,
    "organization": {
      "id": 7,
      "name": "Acme Inc.",
      "created_at": "2026-05-15T09:11:42+00:00",
      "updated_at": "2026-05-15T09:11:42+00:00"
    },
    "created_at": "2026-05-15T09:11:42+00:00",
    "updated_at": "2026-05-15T09:11:42+00:00"
  },
  "created_at": "2026-05-18T09:11:42+00:00",
  "updated_at": "2026-05-18T09:11:42+00:00"
}

Changes

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