---
updatedAt: 2026-08-24T09:14:57.000Z
agentTools:
projectIndex: https://developers.vibe.co/llms.txt
---
# List interest segments
Returns audience interest segments available to use in strategy targeting.
**Scopes:**
`campaigns:read`
*Rate limits*:
Burst: `10/s`
Steady: `300/m`
# OpenAPI definition
```json
{
"openapi": "3.1.0",
"paths": {
"/segments/interests": {
"get": {
"description": "Returns audience interest segments available to use in strategy targeting.\n**Scopes:**\n`campaigns:read`\n
*Rate limits*:
Burst: `10/s`
Steady: `300/m`\n",
"operationId": "listInterestSegments",
"parameters": [
{
"name": "search",
"required": false,
"in": "query",
"description": "Search interest segments by name (case-insensitive)",
"schema": {
"type": "string"
}
},
{
"name": "limit",
"required": false,
"in": "query",
"description": "Maximum number of segments to return",
"schema": {
"minimum": 1,
"type": "number"
}
},
{
"name": "offset",
"required": false,
"in": "query",
"description": "Number of segments to skip",
"schema": {
"minimum": 0,
"type": "number"
}
}
],
"responses": {
"200": {
"description": "Interest segment list",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/InterestSegmentList"
}
}
}
},
"400": {
"description": "Bad request error response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
},
"examples": {
"missingApiKey": {
"summary": "Missing API key",
"value": {
"error": {
"type": "validation",
"message": "Missing API Key",
"status": 400,
"detail": null,
"request_id": "req_8f3a4b2c",
"doc_url": null
}
}
},
"validationError": {
"summary": "Validation error",
"value": {
"error": {
"type": "validation",
"message": "Validation error",
"status": 400,
"detail": {
"validation": [
"id must be a string"
]
},
"request_id": "req_8f3a4b2c",
"doc_url": null
}
}
}
}
}
}
},
"401": {
"description": "Unauthorized error response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
},
"examples": {
"invalidApiKey": {
"summary": "Invalid API key",
"value": {
"error": {
"type": "invalid_token",
"message": "Unauthorized",
"status": 401,
"detail": null,
"request_id": "req_8f3a4b2c",
"doc_url": "https://developers.vibe.co/errors/invalid-token"
}
}
}
}
}
}
},
"403": {
"description": "Insufficient scope error response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
},
"examples": {
"insufficientScope": {
"summary": "Missing required scope",
"value": {
"error": {
"type": "insufficient_scope",
"message": "Missing required scope",
"status": 403,
"detail": {
"required": "campaigns:read",
"granted": [
"test"
]
},
"request_id": "req_8f3a4b2c",
"doc_url": "https://developers.vibe.co/reference/oauth2token"
}
}
}
}
}
}
}
},
"summary": "List interest segments",
"tags": [
"Reference Data"
],
"x-rate-limit": {
"rps": 10,
"rpm": 300
},
"x-scopes": [
"campaigns:read"
]
}
}
},
"info": {
"title": "Vibe Public API",
"description": "Vibe Public API revision 2026-06-01",
"version": "2026-06-01",
"contact": {}
},
"tags": [
{
"name": "Reference Data",
"description": "Read-only catalogs you'll query while building a Strategy's `targeting` object: the apps, channels, and live sports inventory available to target, and the audience interest segments Vibe can match. The catalogs reflect Vibe's current inventory and audience taxonomies.\n\n> 💡 **Developer note**\n>\n> Catalogs update on a weekly cadence. Cache responses for at least 24 hours — partners that re-query on every campaign creation hit unnecessary rate-limit pressure."
}
],
"servers": [
{
"url": "https://api.vibe.co",
"description": "Production API"
}
],
"components": {
"securitySchemes": {
"bearer": {
"scheme": "bearer",
"bearerFormat": "JWT",
"type": "http"
}
},
"schemas": {
"ErrorDetail": {
"type": "object",
"properties": {
"required": {
"type": "string",
"example": "audiences:write"
},
"granted": {
"example": [
"audiences:read",
"reporting:read"
],
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [
"required",
"granted"
]
},
"ApiError": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"insufficient_scope",
"invalid_token",
"validation",
"internal_error"
]
},
"message": {
"type": "string"
},
"status": {
"type": "number",
"example": 403
},
"detail": {
"nullable": true,
"allOf": [
{
"$ref": "#/components/schemas/ErrorDetail"
}
]
},
"request_id": {
"type": "string",
"example": "req_8f3a4b2c"
},
"doc_url": {
"type": "string",
"example": "https://developers.vibe.co/reference/oauth2token",
"nullable": true
}
},
"required": [
"type",
"message",
"status",
"request_id"
]
},
"ErrorResponse": {
"type": "object",
"properties": {
"error": {
"$ref": "#/components/schemas/ApiError"
}
},
"required": [
"error"
]
},
"InterestSegment": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Segment identifier"
},
"name": {
"type": "string",
"description": "Segment display name"
},
"parent": {
"type": "object",
"nullable": true,
"description": "Parent segment identifier"
},
"size": {
"type": "object",
"nullable": true,
"description": "Estimated audience size"
}
},
"required": [
"id",
"name",
"parent",
"size"
]
},
"InterestSegmentList": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/InterestSegment"
}
},
"total": {
"type": "number",
"description": "Total number of segments matching the filters"
},
"limit": {
"type": "number",
"description": "Maximum number of items returned"
},
"offset": {
"type": "number",
"description": "Number of items skipped"
}
},
"required": [
"data",
"total",
"limit",
"offset"
]
}
}
},
"security": [
{
"bearer": []
}
]
}
```