> ## 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. # Get campaign frequency cap > Returns the team's contact frequency cap: the most campaign messages one phone number receives from the team in any rolling 24 hours and any rolling 7 days. Every campaign message counts, first messages and later messages of a sequence, from every campaign, project and number in the team. Test sends and messages sent outside campaigns do not count. `null` means no limit for that window. A team that never saved a cap receives both limits `null` and `revision` 0. A campaign can set its own, stricter cap with `frequencyCap`. Accepts a team API key or a live signed-in team member. API keys require `campaigns:read`. Project tokens are not accepted. ## OpenAPI ````yaml api-reference/features/campaigns.json GET /platform/campaign-settings/frequency-cap 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/campaign-settings/frequency-cap: get: tags: - Campaign Settings summary: Get campaign frequency cap description: >- Returns the team's contact frequency cap: the most campaign messages one phone number receives from the team in any rolling 24 hours and any rolling 7 days. Every campaign message counts, first messages and later messages of a sequence, from every campaign, project and number in the team. Test sends and messages sent outside campaigns do not count. `null` means no limit for that window. A team that never saved a cap receives both limits `null` and `revision` 0. A campaign can set its own, stricter cap with `frequencyCap`. Accepts a team API key or a live signed-in team member. API keys require `campaigns:read`. Project tokens are not accepted. operationId: managementGetCampaignFrequencyCap 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: allOf: - $ref: >- #/components/schemas/management__CampaignFrequencyCapSettings description: Structured data carried by this object. required: - data '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__CampaignFrequencyCapSettings: type: object additionalProperties: false description: The team's contact frequency cap. properties: teamId: type: string format: uuid description: |- Identifier for the team. **Value constraints** | Constraint | Accepted input | | --- | --- | | Format | `uuid` | maxPer24Hours: type: integer minimum: 1 maximum: 50 nullable: true description: >- Most campaign messages one phone number receives from the team in any rolling 24 hours, 1 to 50. `null` sets no 24-hour limit. **Accepted alternatives** | Alternative | Accepted input | | --- | --- | | Alternative 1 | Type: `integer`; Numeric value: `1` through `50` (inclusive) | | Alternative 2 | `null` | **Value constraints** | Constraint | Accepted input | | --- | --- | | Numeric value | `1` through `50` (inclusive) | maxPer7Days: type: integer minimum: 1 maximum: 200 nullable: true description: >- Most campaign messages one phone number receives from the team in any rolling 7 days, 1 to 200. `null` sets no 7-day limit. Must not be lower than `maxPer24Hours`. **Accepted alternatives** | Alternative | Accepted input | | --- | --- | | Alternative 1 | Type: `integer`; Numeric value: `1` through `200` (inclusive) | | Alternative 2 | `null` | **Value constraints** | Constraint | Accepted input | | --- | --- | | Numeric value | `1` through `200` (inclusive) | revision: type: integer minimum: 0 description: >- Send this value back to change the cap. 0 until the team first saves. **Value constraints** | Constraint | Accepted input | | --- | --- | | Numeric value | `0` or greater | updatedAt: type: integer format: int64 nullable: true description: >- Unix time in milliseconds of the last change; null until the team first saves. **Accepted alternatives** | Alternative | Accepted input | | --- | --- | | Alternative 1 | Type: `integer`; Format: `int64` | | Alternative 2 | `null` | **Value constraints** | Constraint | Accepted input | | --- | --- | | Format | `int64` | required: - teamId - maxPer24Hours - maxPer7Days - revision - updatedAt 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` | 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.