segments

List segments

Returns every segment belonging to the active project. The response is paginated. Every new project is seeded with a Direct Competitors segment.

get/api/v1/segments

Request

Base URL: https://pineprompt.com
URL: https://pineprompt.com/api/v1/segments
Auth: HTTP bearer

Query parameters

pageinteger

Example:1

The page number to return. Defaults to 1.

per_pageinteger

Example:25

The number of items per page. Defaults to 25, maximum 100.

sort_by'created_at' | 'updated_at' | 'name'

The column to sort by. Defaults to created_at.

sort_order'asc' | 'desc'

The direction to sort by. Each endpoint has its own default.

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

Example response

{
  "data": [
    {
      "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"
    }
  ],
  "links": {
    "first": "https://pineprompt.com/api/v1/monitors?page=1",
    "last": "https://pineprompt.com/api/v1/monitors?page=1"
  },
  "meta": {
    "current_page": 1,
    "from": 1,
    "last_page": 1,
    "path": "https://pineprompt.com/api/v1/monitors",
    "per_page": 25,
    "to": 1,
    "total": 1,
    "links": [
      {
        "url": "https://pineprompt.com/api/v1/monitors?page=2",
        "label": "2",
        "page": 2
      }
    ]
  }
}

Changes

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