> ## Documentation Index > Fetch the complete documentation index at: https://docs.politicalcomms.com/llms.txt > Use this file to discover all available pages before exploring further. # Get Project Throughput > Pre-flight estimate of how carrier limits will affect this project: recipients expected on T-Mobile and AT&T, whether the project will pause at the T-Mobile daily cap, and how many days or minutes the send needs. Political (Campaign Verify) brands return `carrier_metered: false`. When the project has `daily_cap_bypass` on, `will_pause` is false and `estimated_send_days` is 1. Results are cached for up to 60 seconds, so numbers can lag by that much. Returns 503 `CARRIER_ESTIMATE_TIMEOUT` if the estimate query times out; retry later. See [Carrier throughput limits](/api-reference/best-practices#carrier-throughput-limits). ## OpenAPI ````yaml /api-reference/openapi.json get /projects/{id}/throughput openapi: 3.1.0 info: title: Political Comms API summary: >- Direct-to-carrier political texting API for campaigns, PACs, advocacy organizations, fundraisers, and elected officials. description: >- Public REST API for the Political Comms platform. Surfaces include Projects (compose, test, schedule, send), Conversations (read inbound threads and reply inside them), Contact Lists (S3 import and analysis), Media Files, Organizations and hierarchy, Brands, Campaigns, Tracking Domains, Phone Numbers, Analytics, and Billing. Authentication is an API key passed in the `X-API-Key` header. Keys are generated from the dashboard at Admin → API and are prefixed `pc_live_`. All POST and PATCH endpoints that mutate state are designed to be safe to retry, with optional `Idempotency-Key` headers for stronger guarantees. Rate limit is 600 requests per minute per key (bursts up to 600, refilling at 10 per second, the same for every scope; the `X-RateLimit-Limit` header reports your key's exact limit, and `Retry-After` on a 429 is the seconds until your next request is allowed). Webhooks emit `message.sent`, `message.delivered`, `message.failed`, `message.replied`, and `link.clicked` events. Payloads are HMAC-signed; validate the signature before trusting any payload. A Model Context Protocol (MCP) server is available at https://docs.politicalcomms.com/mcp for AI agents that need to search the documentation programmatically. The developer hub at https://politicalcomms.com/developers/ has quickstart examples in cURL, raw HTTP, and Python. version: 1.4.1 termsOfService: https://politicalcomms.com/terms/ contact: name: Political Comms Support email: support@politicalcomms.com url: https://docs.politicalcomms.com license: name: Proprietary url: https://politicalcomms.com/terms/ x-logo: url: https://politicalcomms.com/images/brand/pcomms-logo-left-of-text.png altText: Political Comms backgroundColor: '#ffffff' href: https://politicalcomms.com/ x-mcp: url: https://docs.politicalcomms.com/mcp discovery_url: https://docs.politicalcomms.com/.well-known/mcp transport: http auth: none tools: - search_political_comms - query_docs_filesystem_political_comms - submit_feedback servers: - url: https://api.politicalcomms.com/v1 description: Production security: - ApiKeyAuth: [] tags: - name: Projects description: Create, edit, test, schedule, and inspect projects. - name: Conversations description: >- Read inbound threads and reply inside them from the same number. Conversations are created by project sends; the API never starts one. - name: Phone Numbers description: List phone numbers across 10DLC campaigns and toll-free verifications. - name: Toll-Free Verifications description: >- List toll-free verifications (carrier registrations) across your organization hierarchy. - name: Brands description: List brands across your organization hierarchy. - name: 10DLC Campaigns description: >- List 10DLC campaigns (carrier registrations) across your organization hierarchy. - name: Email Campaigns description: >- Create, schedule, and report on email campaigns. Pause, resume, and test sends are deliverability decisions a human makes while watching a send, and live in the dashboard. - name: Email Templates description: Create and read saved email templates. - name: Email Senders description: >- Read the sender identities (From addresses) on your verified domains. Identities carry the physical mailing address and paid-for-by disclaimer, so they are created and edited in the dashboard. - name: Email Suppressions description: >- Read, add, and lift suppressions in bulk. This is the primitive for keeping your own opt-out record in sync with ours. - name: Contact Lists description: List, import, and analyze contact lists. - name: Email Lists description: >- Create email lists, read their contacts, and bulk-upsert or import addresses. To stop mailing someone use Email Suppressions, which survives a re-import. - name: Media Files description: List, import, and fetch media files. - name: Sending Domains description: >- Read the sending domains in your organization and the DNS records to publish. Domains are added in the dashboard: DNS is published by hand, so creation is not part of the API. - name: Tracking Domains description: >- List active link-tracking domains. Use the returned ids as `link_tracking_domain_id` on project create/update. - name: Organizations description: List descendant organizations and hierarchy. - name: Billing description: Usage and billing data across your organization. - name: Analytics description: Message statistics and delivery performance. paths: /projects/{id}/throughput: get: tags: - Projects summary: Get Project Throughput description: >- Pre-flight estimate of how carrier limits will affect this project: recipients expected on T-Mobile and AT&T, whether the project will pause at the T-Mobile daily cap, and how many days or minutes the send needs. Political (Campaign Verify) brands return `carrier_metered: false`. When the project has `daily_cap_bypass` on, `will_pause` is false and `estimated_send_days` is 1. Results are cached for up to 60 seconds, so numbers can lag by that much. Returns 503 `CARRIER_ESTIMATE_TIMEOUT` if the estimate query times out; retry later. See [Carrier throughput limits](/api-reference/best-practices#carrier-throughput-limits). operationId: getProjectThroughput parameters: - $ref: '#/components/parameters/IdPath' responses: '200': description: Successful response content: application/json: schema: type: object required: - success - data properties: success: type: boolean data: type: object properties: project_id: type: string carrier_metered: type: boolean description: >- false for political (Campaign Verify) brands; `t_mobile` and `att` are then null and `recipients` and `carrier_coverage` are omitted. t_mobile: type: - object - 'null' properties: daily_cap: type: - integer - 'null' used_today: type: - integer - 'null' description: >- Messages counted against the cap so far in the current Pacific day. null (not 0) when usage is temporarily unavailable. remaining_today: type: - integer - 'null' description: >- `daily_cap` minus `used_today`, never below 0. null when `used_today` is null. estimated_recipients: type: integer description: >- Estimated recipients on T-Mobile. Recipients with an unknown carrier are counted using the platform-wide carrier split. will_pause: type: boolean description: >- true when the project will use up the remaining daily cap and auto-pause (`pause_reason` `brand_daily_cap`). Start it again with `POST /projects/{id}/schedule`. Always false when the project has `daily_cap_bypass` on, or when `used_today` is null. estimated_send_days: type: integer description: >- Pacific days needed to finish the T-Mobile recipients at the current cap. 1 when the project will not pause, and always 1 when the project has `daily_cap_bypass` on. att: type: - object - 'null' properties: tpm: type: integer description: >- AT&T messages per minute for this project's protocol. estimated_recipients: type: integer estimated_minutes: type: integer description: >- Minutes AT&T recipients take at `tpm`. AT&T slows sending; it does not pause. recipients: type: integer description: >- Total recipients. Present only when `carrier_metered` is true. carrier_coverage: type: number minimum: 0 maximum: 1 description: >- Share of recipients whose carrier is known (0 to 1). When low, the per-carrier estimates use the platform-wide carrier split instead. Present only when `carrier_metered` is true. additionalProperties: true additionalProperties: true example: success: true data: project_id: 8a3f5c7e-2d91-4b64-ae08-6f1c9d3e7b52 carrier_metered: true t_mobile: daily_cap: 10000 used_today: 7250 remaining_today: 2750 estimated_recipients: 6400 will_pause: true estimated_send_days: 2 att: tpm: 4500 estimated_recipients: 4100 estimated_minutes: 1 recipients: 11800 carrier_coverage: 0.93 '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '404': $ref: '#/components/responses/NotFound' '429': $ref: '#/components/responses/RateLimited' '500': $ref: '#/components/responses/InternalError' '503': description: >- `CARRIER_ESTIMATE_TIMEOUT`: the estimate query timed out and had no effect. Retry later. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' components: parameters: IdPath: name: id in: path required: true description: Resource ID schema: type: string responses: Unauthorized: description: Missing, malformed, revoked, or expired API key. content: application/json: schema: $ref: '#/components/schemas/AuthErrorResponse' example: error: API key required message: Please provide an API key in the X-API-Key header Forbidden: description: >- The API key lacks the required permission scope, or the requested resource belongs to an organization outside the key's hierarchy. content: application/json: schema: oneOf: - $ref: '#/components/schemas/AuthErrorResponse' - $ref: '#/components/schemas/ErrorResponse' examples: missingScope: summary: Key lacks the required permission scope value: error: Insufficient permissions message: >- This API key does not have the required permissions: public:read orgAccessDenied: summary: Resource outside the key's organization hierarchy value: error: >- Access denied: You do not have permission to access this organization's data code: ORG_ACCESS_DENIED correlationId: de038205-7c9c-4d4a-99bc-d7275a52f07e NotFound: description: Resource not found or not visible to this API key. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' example: error: Project not found code: PROJECT_NOT_FOUND correlationId: de038205-7c9c-4d4a-99bc-d7275a52f07e RateLimited: description: Rate limit exceeded. Check the Retry-After header. headers: Retry-After: description: Seconds until the window resets. schema: type: integer content: application/json: schema: $ref: '#/components/schemas/RateLimitErrorResponse' example: success: false error: Rate limit exceeded message: Maximum 600 requests per 60 seconds code: RATE_LIMIT_EXCEEDED statusCode: 429 retryAfter: 3 InternalError: description: Unexpected server error. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' example: error: An unexpected error occurred. Please try again later. code: INTERNAL_ERROR correlationId: de038205-7c9c-4d4a-99bc-d7275a52f07e schemas: ErrorResponse: type: object properties: error: type: string description: Human-readable error message. code: type: string description: >- Machine-readable error code, e.g. VALIDATION_ERROR, ORG_ACCESS_DENIED, PROJECT_NOT_FOUND. correlationId: type: string description: Request correlation ID; include it in support requests. details: type: - array - object description: >- Present on some errors. For VALIDATION_ERROR, an array of { field, message, code } with one entry per rejected field (field is the dotted path); an object for other codes (e.g. insufficient-balance shortfall). required: - error - code additionalProperties: true description: >- Standard error body produced by the API error handler for 4xx/5xx responses. AuthErrorResponse: type: object properties: error: type: string description: Short error summary. message: type: string description: Human-readable detail. required: - error - message additionalProperties: true description: >- Error body returned by the API-key authentication layer (401 and permission 403s). RateLimitErrorResponse: type: object properties: success: type: boolean enum: - false error: type: string message: type: string code: type: string enum: - RATE_LIMIT_EXCEEDED statusCode: type: integer enum: - 429 retryAfter: type: integer description: >- Seconds until the rate-limit window resets. Also sent as the Retry-After header. required: - success - error - code - statusCode - retryAfter additionalProperties: true securitySchemes: ApiKeyAuth: type: apiKey in: header name: X-API-Key description: >- Authenticate every request by passing your API key in the X-API-Key header. Keys are scoped to your organization hierarchy. ````