Get a segment

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

GET /api/v1/segments/{segment}

Path parameters

Name	Type	Required	Description
segment	integer	Required	The numeric ID of the segment.

Query parameters

Name	Type	Required	Description
include	string	Optional	A comma-separated list of related resources to include in the response. Allowed values: `project`, `project.organization`.

Response

The segment object

Field	Type	Description
id	integer	The unique ID of the segment.
project_id	integer	The ID of the project this segment belongs to.
name	string	The display label of the segment.
created_at	datetime	When the segment was created.
updated_at	datetime	When the segment was last updated.

import os import requests response = requests.get( "https://pineprompt.com/api/v1/segments/7", headers={ "Authorization": f"Bearer {os.environ['PINEPROMPT_TOKEN']}", "Pineprompt-Project-Id": "1", }, ) response.raise_for_status() payload = response.json()

use GuzzleHttp\Client; $response = (new Client())->get('https://pineprompt.com/api/v1/segments/7', [ 'headers' => [ 'Authorization' => 'Bearer '.getenv('PINEPROMPT_TOKEN'), 'Pineprompt-Project-Id' => '1', ], ]); // Guzzle throws on 4xx/5xx by default, so no manual check needed. $payload = json_decode((string) $response->getBody(), true);