> ## Documentation Index > Fetch the complete documentation index at: https://docs.polymorfa.com/llms.txt > Use this file to discover all available pages before exploring further. # List audience segments > Lists the team's saved segments with cursor pagination. Reads stay available after beta withdrawal. API keys require `campaigns:read`. Project tokens are not accepted. ## OpenAPI ````yaml api-reference/features/campaigns.json GET /platform/audience-segments openapi: 3.0.3 info: title: Campaigns API methods version: 1.0.0 description: Task-focused campaigns methods across supported Polymorfa connection types. servers: [] security: [] paths: /platform/audience-segments: get: tags: - Audience Segments summary: List audience segments description: >- Lists the team's saved segments with cursor pagination. Reads stay available after beta withdrawal. API keys require `campaigns:read`. Project tokens are not accepted. operationId: managementListAudienceSegments parameters: - name: cursor in: query required: false schema: type: string description: Specifies cursor for this query parameter. - name: limit in: query required: false schema: type: integer minimum: 1 maximum: 100 default: 25 description: |- Specifies limit for this query parameter. **Value constraints** | Constraint | Accepted input | | --- | --- | | Numeric value | `1` through `100` (inclusive) | responses: '200': description: Success headers: X-Request-Id: schema: type: string description: Stable request correlation identifier. X-Trace-Id: schema: type: string pattern: ^[0-9a-f]{32}$ description: >- W3C trace ID of this request. Your `traceparent` trace ID when you sent a valid one. Polymorfa-Version: schema: type: string description: API version applied to this response. content: application/json: schema: type: object additionalProperties: false properties: data: type: array items: $ref: '#/components/schemas/management__AudienceSegment' description: Structured data carried by this object. page: allOf: - $ref: '#/components/schemas/management__CursorPageMetadata' description: Specifies page for this schema. required: - data - page '400': $ref: '#/components/responses/management__BadRequest' '401': $ref: '#/components/responses/management__Unauthorized' '403': $ref: '#/components/responses/management__Forbidden' security: - management__ApiKeyAuth: [] servers: - url: https://api.polymorfa.com components: schemas: management__AudienceSegment: type: object additionalProperties: false properties: id: type: string format: uuid description: |- Identifier for this resource. **Value constraints** | Constraint | Accepted input | | --- | --- | | Format | `uuid` | name: type: string minLength: 1 maxLength: 100 description: |- Human-readable name for this resource. **Value constraints** | Constraint | Accepted input | | --- | --- | | String length | `1` through `100` characters | revision: type: integer minimum: 1 description: |- Specifies revision for this management audience segment. **Value constraints** | Constraint | Accepted input | | --- | --- | | Numeric value | `1` or greater | rules: allOf: - $ref: '#/components/schemas/management__AudienceSegmentRules' description: Specifies rules for this management audience segment. createdAt: type: integer minimum: 0 description: |- Unix timestamp in milliseconds when this resource was created. **Value constraints** | Constraint | Accepted input | | --- | --- | | Numeric value | `0` or greater | updatedAt: type: integer minimum: 0 description: |- Unix timestamp in milliseconds when this resource was last updated. **Value constraints** | Constraint | Accepted input | | --- | --- | | Numeric value | `0` or greater | required: - id - name - revision - rules - createdAt - updatedAt management__CursorPageMetadata: type: object additionalProperties: false properties: nextCursor: type: string nullable: true description: |- Specifies next cursor for this management cursor page metadata. **Accepted alternatives** | Alternative | Accepted input | | --- | --- | | Alternative 1 | Type: `string` | | Alternative 2 | `null` | hasMore: type: boolean description: Whether more. required: - nextCursor - hasMore management__AudienceSegmentRules: type: object additionalProperties: false description: >- Groups combined with `all` or `any`. At most 10 groups, 20 conditions per group, 40 conditions, 5 campaign conditions and 16 KiB. properties: match: type: string enum: - all - any description: |- Specifies match for this management audience segment rule. **Allowed values** | Value | Meaning | | --- | --- | | `all` | All. | | `any` | Any. | groups: type: array minItems: 1 maxItems: 10 items: type: object additionalProperties: false properties: match: type: string enum: - all - any description: |- Specifies match for this group. **Allowed values** | Value | Meaning | | --- | --- | | `all` | All. | | `any` | Any. | negate: type: boolean description: Inverts the group's result. Defaults to false. conditions: type: array minItems: 1 maxItems: 20 items: $ref: '#/components/schemas/management__AudienceSegmentCondition' description: >- Conditions associated with this group. **Accepted alternatives** | Item alternative | Accepted input | | --- | --- | | Item alternative 1 | Type: `object`; Field `field`: `tag`; Field `operator`: `contains`; Required fields: `field`, `operator`, `value` | | Item alternative 2 | Type: `object`; Field `field`: `tag`; Field `operator`: `in`; Required fields: `field`, `operator`, `values` | | Item alternative 3 | Type: `object`; Field `field`: `tag`; Field `operator`: `exists`; Required fields: `field`, `operator` | | Item alternative 4 | Type: `object`; Field `field`: `attribute`; Field `operator`: `equals`; Required fields: `field`, `name`, `operator`, `value` | | Item alternative 5 | Type: `object`; Field `field`: `attribute`; Field `operator`: `contains`; Required fields: `field`, `name`, `operator`, `value` | | Item alternative 6 | Type: `object`; Field `field`: `attribute`; Field `operator`: `in`; Required fields: `field`, `name`, `operator`, `values` | | Item alternative 7 | Type: `object`; Field `field`: `attribute`; Field `operator`: `greater_than` or `less_than`; Required fields: `field`, `name`, `operator`, `value` | | Item alternative 8 | Type: `object`; Field `field`: `attribute`; Field `operator`: `before` or `after`; Required fields: `field`, `name`, `operator`, `value` | | Item alternative 9 | Type: `object`; Field `field`: `attribute`; Field `operator`: `exists`; Required fields: `field`, `name`, `operator` | | Item alternative 10 | Type: `object`; Field `field`: `consent`; Field `operator`: `equals`; Required fields: `field`, `operator`, `value` | | Item alternative 11 | Type: `object`; Field `field`: `campaign`; Field `outcome`: `delivered` or `not_delivered` or `read` or `not_read` or `replied` or `not_replied` or `failed`; Required fields: `field`, `campaignId`, `outcome` | **Value constraints** | Constraint | Accepted input | | --- | --- | | Array size | `1` through `20` items | required: - match - conditions description: |- Groups associated with this management audience segment rule. **Value constraints** | Constraint | Accepted input | | --- | --- | | Array size | `1` through `10` items | required: - match - groups management__ErrorEnvelope: type: object required: - error - data - docs properties: error: type: object required: - type - code - message - param - request_id properties: type: type: string enum: - invalid_request_error - authentication_error - permission_error - conflict_error - rate_limit_error - api_error - upstream_error description: |- Type discriminator for this object. **Allowed values** | Value | Meaning | | --- | --- | | `invalid_request_error` | Invalid request error. | | `authentication_error` | Authentication error. | | `permission_error` | Permission error. | | `conflict_error` | Conflict error. | | `rate_limit_error` | Rate limit error. | | `api_error` | Api error. | | `upstream_error` | Upstream error. | code: type: string description: Stable failure code. Use this value for programmatic handling. message: type: string description: Safe explanation of the failure. param: type: string nullable: true description: |- Invalid request field, or null when no field applies. **Accepted alternatives** | Alternative | Accepted input | | --- | --- | | Alternative 1 | Type: `string` | | Alternative 2 | `null` | request_id: type: string description: >- Matches the X-Request-Id response header. Include it when you contact support. request_log_url: type: string format: uri description: >- Console page that shows this request. Returned only to organization and project credentials whose request was logged. **Value constraints** | Constraint | Accepted input | | --- | --- | | Format | `uri` | description: Error details returned when the operation fails. data: type: string nullable: true enum: - null description: |- Always null for a failed request. **Allowed values** | Value | Meaning | | --- | --- | | `null` | Null. | **Accepted alternatives** | Alternative | Accepted input | | --- | --- | | Alternative 1 | Type: `string` | | Alternative 2 | `null` | docs: type: string format: uri description: |- Documentation link to this failure code. **Value constraints** | Constraint | Accepted input | | --- | --- | | Format | `uri` | management__AudienceSegmentCondition: description: >- One condition. A condition on a missing or null attribute, or a value of another type, is false. oneOf: - type: object additionalProperties: false description: The profile has this tag. properties: field: type: string enum: - tag description: |- Specifies field for this one of. **Allowed values** | Value | Meaning | | --- | --- | | `tag` | Tag. | operator: type: string enum: - contains description: |- Specifies operator for this one of. **Allowed values** | Value | Meaning | | --- | --- | | `contains` | Contains. | value: type: string minLength: 1 x-max-utf8-bytes: 48 description: >- 1-48 UTF-8 bytes without control characters. The byte limit can be reached before 48 Unicode characters. **Value constraints** | Constraint | Accepted input | | --- | --- | | String length | At least `1` characters | required: - field - operator - value - type: object additionalProperties: false description: The profile has at least one of these tags. properties: field: type: string enum: - tag description: |- Specifies field for this one of. **Allowed values** | Value | Meaning | | --- | --- | | `tag` | Tag. | operator: type: string enum: - in description: |- Specifies operator for this one of. **Allowed values** | Value | Meaning | | --- | --- | | `in` | In. | values: type: array minItems: 1 maxItems: 50 items: type: string minLength: 1 x-max-utf8-bytes: 48 description: >- 1-48 UTF-8 bytes without control characters. The byte limit can be reached before 48 Unicode characters. description: |- Values associated with this one of. **Value constraints** | Constraint | Accepted input | | --- | --- | | Array size | `1` through `50` items | | Item string length | At least `1` characters | required: - field - operator - values - type: object additionalProperties: false description: The profile has at least one tag. properties: field: type: string enum: - tag description: |- Specifies field for this one of. **Allowed values** | Value | Meaning | | --- | --- | | `tag` | Tag. | operator: type: string enum: - exists description: |- Specifies operator for this one of. **Allowed values** | Value | Meaning | | --- | --- | | `exists` | Exists. | required: - field - operator - type: object additionalProperties: false description: The attribute equals this value, with the same type. properties: field: type: string enum: - attribute description: |- Specifies field for this one of. **Allowed values** | Value | Meaning | | --- | --- | | `attribute` | Attribute. | name: type: string pattern: ^[A-Za-z_][A-Za-z0-9_]{0,47}$ description: |- Human-readable name for this resource. **Value constraints** | Constraint | Accepted input | | --- | --- | | Pattern | `^[A-Za-z_][A-Za-z0-9_]{0,47}$` | operator: type: string enum: - equals description: |- Specifies operator for this one of. **Allowed values** | Value | Meaning | | --- | --- | | `equals` | Equals. | value: anyOf: - type: string minLength: 1 x-max-utf8-bytes: 256 description: >- 1-256 UTF-8 bytes. The byte limit can be reached before 256 Unicode characters. - type: number - type: boolean description: >- Value assigned to this field. **Accepted alternatives** | Alternative | Accepted input | | --- | --- | | Alternative 1 | Type: `string`; String length: At least `1` characters | | Alternative 2 | Type: `number` | | Alternative 3 | Type: `boolean` | required: - field - name - operator - value - type: object additionalProperties: false description: The text attribute contains this text, ignoring case. properties: field: type: string enum: - attribute description: |- Specifies field for this one of. **Allowed values** | Value | Meaning | | --- | --- | | `attribute` | Attribute. | name: type: string pattern: ^[A-Za-z_][A-Za-z0-9_]{0,47}$ description: |- Human-readable name for this resource. **Value constraints** | Constraint | Accepted input | | --- | --- | | Pattern | `^[A-Za-z_][A-Za-z0-9_]{0,47}$` | operator: type: string enum: - contains description: |- Specifies operator for this one of. **Allowed values** | Value | Meaning | | --- | --- | | `contains` | Contains. | value: type: string minLength: 1 x-max-utf8-bytes: 256 description: >- 1-256 UTF-8 bytes. The byte limit can be reached before 256 Unicode characters. **Value constraints** | Constraint | Accepted input | | --- | --- | | String length | At least `1` characters | required: - field - name - operator - value - type: object additionalProperties: false description: The attribute equals one of these values. properties: field: type: string enum: - attribute description: |- Specifies field for this one of. **Allowed values** | Value | Meaning | | --- | --- | | `attribute` | Attribute. | name: type: string pattern: ^[A-Za-z_][A-Za-z0-9_]{0,47}$ description: |- Human-readable name for this resource. **Value constraints** | Constraint | Accepted input | | --- | --- | | Pattern | `^[A-Za-z_][A-Za-z0-9_]{0,47}$` | operator: type: string enum: - in description: |- Specifies operator for this one of. **Allowed values** | Value | Meaning | | --- | --- | | `in` | In. | values: type: array minItems: 1 maxItems: 50 items: anyOf: - type: string minLength: 1 x-max-utf8-bytes: 256 description: >- 1-256 UTF-8 bytes. The byte limit can be reached before 256 Unicode characters. - type: number description: >- Values associated with this one of. **Accepted alternatives** | Item alternative | Accepted input | | --- | --- | | Item alternative 1 | Type: `string`; String length: At least `1` characters | | Item alternative 2 | Type: `number` | **Value constraints** | Constraint | Accepted input | | --- | --- | | Array size | `1` through `50` items | required: - field - name - operator - values - type: object additionalProperties: false description: The number attribute is greater or less than this number. properties: field: type: string enum: - attribute description: |- Specifies field for this one of. **Allowed values** | Value | Meaning | | --- | --- | | `attribute` | Attribute. | name: type: string pattern: ^[A-Za-z_][A-Za-z0-9_]{0,47}$ description: |- Human-readable name for this resource. **Value constraints** | Constraint | Accepted input | | --- | --- | | Pattern | `^[A-Za-z_][A-Za-z0-9_]{0,47}$` | operator: type: string enum: - greater_than - less_than description: |- Specifies operator for this one of. **Allowed values** | Value | Meaning | | --- | --- | | `greater_than` | Greater than. | | `less_than` | Less than. | value: type: number description: Value assigned to this field. required: - field - name - operator - value - type: object additionalProperties: false description: >- The date attribute is before or after this instant. Both bounds are exclusive. properties: field: type: string enum: - attribute description: |- Specifies field for this one of. **Allowed values** | Value | Meaning | | --- | --- | | `attribute` | Attribute. | name: type: string pattern: ^[A-Za-z_][A-Za-z0-9_]{0,47}$ description: |- Human-readable name for this resource. **Value constraints** | Constraint | Accepted input | | --- | --- | | Pattern | `^[A-Za-z_][A-Za-z0-9_]{0,47}$` | operator: type: string enum: - before - after description: |- Specifies operator for this one of. **Allowed values** | Value | Meaning | | --- | --- | | `before` | Before. | | `after` | After. | value: type: string maxLength: 40 description: >- ISO 8601 date (`YYYY-MM-DD`, read as midnight UTC) or date-time with `Z` or an offset. **Value constraints** | Constraint | Accepted input | | --- | --- | | String length | At most `40` characters | required: - field - name - operator - value - type: object additionalProperties: false description: The attribute is set and not null. properties: field: type: string enum: - attribute description: |- Specifies field for this one of. **Allowed values** | Value | Meaning | | --- | --- | | `attribute` | Attribute. | name: type: string pattern: ^[A-Za-z_][A-Za-z0-9_]{0,47}$ description: |- Human-readable name for this resource. **Value constraints** | Constraint | Accepted input | | --- | --- | | Pattern | `^[A-Za-z_][A-Za-z0-9_]{0,47}$` | operator: type: string enum: - exists description: |- Specifies operator for this one of. **Allowed values** | Value | Meaning | | --- | --- | | `exists` | Exists. | required: - field - name - operator - type: object additionalProperties: false description: >- The profile's latest campaign consent assertion has this `allowed` value. properties: field: type: string enum: - consent description: |- Specifies field for this one of. **Allowed values** | Value | Meaning | | --- | --- | | `consent` | Consent. | operator: type: string enum: - equals description: |- Specifies operator for this one of. **Allowed values** | Value | Meaning | | --- | --- | | `equals` | Equals. | value: type: boolean description: Value assigned to this field. required: - field - operator - value - type: object additionalProperties: false description: >- The phone was a recipient of this team campaign with this outcome, with the same meaning as a retargeting audience. properties: field: type: string enum: - campaign description: |- Specifies field for this one of. **Allowed values** | Value | Meaning | | --- | --- | | `campaign` | Campaign. | campaignId: type: string format: uuid description: |- Identifier for the campaign. **Value constraints** | Constraint | Accepted input | | --- | --- | | Format | `uuid` | outcome: type: string enum: - delivered - not_delivered - read - not_read - replied - not_replied - failed description: |- Specifies outcome for this one of. **Allowed values** | Value | Meaning | | --- | --- | | `delivered` | Delivered. | | `not_delivered` | Not delivered. | | `read` | Read. | | `not_read` | Not read. | | `replied` | Replied. | | `not_replied` | Not replied. | | `failed` | Failed. | required: - field - campaignId - outcome responses: management__BadRequest: description: A path, query, or request-body value did not pass validation. headers: X-Request-Id: schema: type: string description: Stable request correlation identifier. X-Trace-Id: schema: type: string pattern: ^[0-9a-f]{32}$ description: >- W3C trace ID of this request. Your `traceparent` trace ID when you sent a valid one. Polymorfa-Version: schema: type: string description: API version applied to this response. content: application/json: schema: $ref: '#/components/schemas/management__ErrorEnvelope' management__Unauthorized: description: Missing/invalid credential for this audience. headers: X-Request-Id: schema: type: string description: Stable request correlation identifier. X-Trace-Id: schema: type: string pattern: ^[0-9a-f]{32}$ description: >- W3C trace ID of this request. Your `traceparent` trace ID when you sent a valid one. Polymorfa-Version: schema: type: string description: API version applied to this response. content: application/json: schema: $ref: '#/components/schemas/management__ErrorEnvelope' management__Forbidden: description: Authenticated but lacks the required scope/role/audience. headers: X-Request-Id: schema: type: string description: Stable request correlation identifier. X-Trace-Id: schema: type: string pattern: ^[0-9a-f]{32}$ description: >- W3C trace ID of this request. Your `traceparent` trace ID when you sent a valid one. Polymorfa-Version: schema: type: string description: API version applied to this response. content: application/json: schema: $ref: '#/components/schemas/management__ErrorEnvelope' securitySchemes: management__ApiKeyAuth: type: http scheme: bearer description: >- Send your team API key or project token as `Authorization: Bearer `. The credential must have the required permissions. Project tokens can access only their own project. ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.