> ## Documentation Index
> Fetch the complete documentation index at: https://docs.sagescreen.dev/llms.txt
> Use this file to discover all available pages before exploring further.

# Get council data for Zapier

> Returns full council data including all meta fields, status,
and a list of council users with their roles.

Accepts numeric WordPress post ID or council UUID (`council_id` meta).

Requires the `X-API-Key` header (Zapier API key).




## OpenAPI

````yaml /openapi/private/specs/wp/wp-webhooks.yml get /zapier/council/{id}
openapi: 3.1.0
info:
  title: >-
    SageScreen — Webhooks & CRM Integrations (Billing · Council · User · Deal ·
    Sage)
  version: 1.0.0
servers:
  - url: https://{domain}/wp-json/sagescreen/v1
    description: WordPress REST API
    variables:
      domain:
        default: api.sagescreen.app
security: []
tags:
  - name: Billing – Stripe
    description: Stripe webhook and subscription endpoints
  - name: Billing – Broadcast
    description: Postmark broadcast unsubscribe endpoint
  - name: Billing – Pipedrive
    description: Pipedrive CRM ID set-* webhook endpoints (called by Zapier)
  - name: Billing – AJAX
    description: Credit ledger, reactivation, and portal AJAX endpoints
  - name: Council – REST
    description: Zapier-facing REST endpoints for council data sync
  - name: Council – AJAX
    description: Council user and sage management AJAX endpoints
  - name: User – REST
    description: Zapier-facing REST endpoints
  - name: User – AJAX
    description: Council user management AJAX endpoints
  - name: User – Profile
    description: Self-service profile updates
  - name: Deal REST
    description: REST API endpoints authenticated via X-API-Key
  - name: Deal AJAX
    description: AJAX endpoints authenticated via WordPress nonce + capability check
  - name: Sage – REST
    description: REST API endpoints for sage operations and Python callbacks
  - name: Sage – CRUD
    description: AJAX endpoints for sage creation, editing, and status management
  - name: Sage – Build Workflow
    description: AJAX endpoints for the multi-step sage build process
paths:
  /zapier/council/{id}:
    get:
      tags:
        - Council – REST
      summary: Get council data for Zapier
      description: |
        Returns full council data including all meta fields, status,
        and a list of council users with their roles.

        Accepts numeric WordPress post ID or council UUID (`council_id` meta).

        Requires the `X-API-Key` header (Zapier API key).
      operationId: zapierGetCouncil
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
            description: WordPress post ID (numeric) or council_id UUID
            examples:
              - '123'
              - c9d8e7f6-5a4b-3c2d-1e0f-a1b2c3d4e5f6
      responses:
        '200':
          description: Council data retrieved
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ZapierCouncilResponse'
              example:
                success: true
                data:
                  post_id: 123
                  council_id: c9d8e7f6-5a4b-3c2d-1e0f-a1b2c3d4e5f6
                  council_name: Greenville City Council
                  status: ss_active
                  created: '2024-01-15T10:30:00'
                  modified: '2024-02-19T15:45:00'
                  council_type: enterprise
                  email_header: Greenville HR
                  email_body: Please complete your SageScreen
                  email_subject: Your SageScreen Invitation
                  email_from: HR Department
                  email_from_address: hr@greenville.gov
                  support_link: https://greenville.gov/hr
                  support_phone: '18005551234'
                  custom_url: greenville
                  branding_addon: '1'
                  url_addon: '1'
                  branding_expire_date: '2025-12-31'
                  custom_url_expire_date: '2025-12-31'
                  branding_renew: '1'
                  custom_url_renew: '1'
                  credits_remaining: 50
                  credits_used_total: 25
                  credits_used_current: 10
                  sage_credits: 5
                  sage_credits_used_total: 2
                  pack_expire: '2025-06-30'
                  sub_renew: '2025-03-01'
                  credit_override: ''
                  credit_rewind: ''
                  credit_advanced_screen: ''
                  credit_core_screen: ''
                  credit_lite_screen: ''
                  credit_sage: ''
                  credit_system_sage: ''
                  credit_branding: ''
                  credit_custom_domain: ''
                  credit_addon_language: ''
                  credit_addon_audio: ''
                  ss_phone: '18005551234'
                  address_line1: 123 Main St
                  address_line2: Suite 100
                  address_city: Greenville
                  address_state: SC
                  address_postal_code: '29601'
                  address_country: US
                  datetime_format: m/d/Y
                  css: ''
                  logo: ''
                  stripe_customer_id: cus_ABC123
                  stripe_subscription_id: sub_DEF456
                  pipedrive_company_id: '12345'
                  users:
                    - user_id: 456
                      actor_id: a1b2c3d4-e5f6-7890-abcd-ef1234567890
                      first_name: Jane
                      last_name: Doe
                      email: jane@greenville.gov
                      role: council_admin
        '401':
          description: Missing or invalid API key
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CouncilPublicWPError'
              example:
                code: invalid_api_key
                message: Invalid or missing API key
                data:
                  status: 401
        '404':
          description: Council not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CouncilPublicWPError'
              example:
                code: council_not_found
                message: Council not found
                data:
                  status: 404
        '500':
          description: API key not configured
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CouncilPublicWPError'
              example:
                code: api_not_configured
                message: Zapier API key not configured
                data:
                  status: 500
      security:
        - apiKey: []
components:
  schemas:
    ZapierCouncilResponse:
      type: object
      properties:
        success:
          type: boolean
          const: true
        data:
          allOf:
            - $ref: '#/components/schemas/Council'
            - type: object
              properties:
                users:
                  type: array
                  items:
                    $ref: '#/components/schemas/ZapierCouncilUserEntry'
    CouncilPublicWPError:
      type: object
      description: WordPress REST API error envelope
      required:
        - code
        - message
        - data
      properties:
        code:
          type: string
          examples:
            - council_not_found
        message:
          type: string
          examples:
            - Council not found
        data:
          type: object
          required:
            - status
          properties:
            status:
              type: integer
              description: HTTP status code
              examples:
                - 404
    Council:
      type: object
      description: |
        Council (organization) entity. Stored as `ss_council` CPT with
        37 meta fields covering email settings, branding, credits,
        billing, address, and display configuration.
      properties:
        post_id:
          type: integer
          description: WordPress post ID
          examples:
            - 123
        council_id:
          type: string
          format: uuid
          description: Unique council UUID
          examples:
            - c9d8e7f6-5a4b-3c2d-1e0f-a1b2c3d4e5f6
        council_name:
          type: string
          description: Council name (post_title)
          examples:
            - Greenville City Council
        status:
          type: string
          enum:
            - publish
            - ss_active
            - ss_paused
            - ss_inactive
          description: Council post status
          examples:
            - ss_active
        created:
          type: string
          format: date-time
          description: Post creation date
          examples:
            - '2024-01-15T10:30:00'
        modified:
          type: string
          format: date-time
          description: Last modification date
          examples:
            - '2024-02-19T15:45:00'
        council_type:
          type: string
          enum:
            - trial
            - pack
            - enterprise
          description: Council subscription type
          examples:
            - enterprise
        email_header:
          type: string
          description: Custom email header text
          examples:
            - Greenville HR
        email_body:
          type: string
          description: Custom email body text
          examples:
            - Please complete your SageScreen
        email_subject:
          type: string
          description: Custom email subject line
          examples:
            - Your SageScreen Invitation
        email_from:
          type: string
          description: Custom from name
          examples:
            - HR Department
        email_from_address:
          type: string
          format: email
          description: Custom from email address
          examples:
            - hr@greenville.gov
        support_link:
          type: string
          description: Custom support URL
          examples:
            - https://greenville.gov/hr
        support_phone:
          type: string
          description: Support phone number (digits only)
          examples:
            - '18005551234'
        custom_url:
          type: string
          description: Custom URL slug
          examples:
            - greenville
        branding_addon:
          type: string
          description: Branding add-on enabled flag
          examples:
            - '1'
        url_addon:
          type: string
          description: Custom URL add-on enabled flag
          examples:
            - '1'
        branding_expire_date:
          type: string
          description: Branding add-on expiry date
          examples:
            - '2025-12-31'
        custom_url_expire_date:
          type: string
          description: Custom URL add-on expiry date
          examples:
            - '2025-12-31'
        branding_renew:
          type: string
          description: Branding auto-renew flag
          examples:
            - '1'
        custom_url_renew:
          type: string
          description: Custom URL auto-renew flag
          examples:
            - '1'
        credits_remaining:
          type: integer
          description: Screen credits remaining
          examples:
            - 50
        credits_used_total:
          type: integer
          description: Total screen credits ever used
          examples:
            - 25
        credits_used_current:
          type: integer
          description: Screen credits used in current period
          examples:
            - 10
        sage_credits:
          type: integer
          description: Sage credits remaining
          examples:
            - 5
        sage_credits_used_total:
          type: integer
          description: Total sage credits ever used
          examples:
            - 2
        pack_expire:
          type: string
          description: Pack expiry date
          examples:
            - '2025-06-30'
        sub_renew:
          type: string
          description: Subscription renewal date
          examples:
            - '2025-03-01'
        credit_override:
          type: string
          description: Whether custom credit pricing is enabled
          examples:
            - ''
        credit_rewind:
          type: string
          description: Custom rewind credit cost
          examples:
            - ''
        credit_advanced_screen:
          type: string
          description: Custom advanced screen credit cost
          examples:
            - ''
        credit_core_screen:
          type: string
          description: Custom core screen credit cost
          examples:
            - ''
        credit_lite_screen:
          type: string
          description: Custom lite screen credit cost
          examples:
            - ''
        credit_sage:
          type: string
          description: Custom sage credit cost
          examples:
            - ''
        credit_system_sage:
          type: string
          description: Custom system sage credit cost
          examples:
            - ''
        credit_branding:
          type: string
          description: Custom branding credit cost
          examples:
            - ''
        credit_custom_domain:
          type: string
          description: Custom domain credit cost
          examples:
            - ''
        credit_addon_language:
          type: string
          description: Custom language add-on credit cost
          examples:
            - ''
        credit_addon_audio:
          type: string
          description: Custom audio add-on credit cost
          examples:
            - ''
        ss_phone:
          type: string
          description: Council phone number (digits only)
          examples:
            - '18005551234'
        address_line1:
          type: string
          description: Street address line 1
          examples:
            - 123 Main St
        address_line2:
          type: string
          description: Street address line 2
          examples:
            - Suite 100
        address_city:
          type: string
          description: City
          examples:
            - Greenville
        address_state:
          type: string
          description: State / province
          examples:
            - SC
        address_postal_code:
          type: string
          description: Postal code
          examples:
            - '29601'
        address_country:
          type: string
          description: Country code
          examples:
            - US
        datetime_format:
          type: string
          description: PHP date format string
          examples:
            - m/d/Y
        css:
          type: string
          description: Custom CSS overrides
          examples:
            - ''
        logo:
          type: string
          description: Custom logo URL or attachment ID
          examples:
            - ''
        stripe_customer_id:
          type: string
          description: Stripe customer ID
          examples:
            - cus_ABC123
        stripe_subscription_id:
          type: string
          description: Stripe subscription ID
          examples:
            - sub_DEF456
        pipedrive_company_id:
          type: string
          description: Pipedrive CRM company ID
          examples:
            - '12345'
    ZapierCouncilUserEntry:
      type: object
      description: User entry within the Zapier council response
      properties:
        user_id:
          type: integer
          examples:
            - 456
        actor_id:
          type: string
          format: uuid
          examples:
            - a1b2c3d4-e5f6-7890-abcd-ef1234567890
        first_name:
          type: string
          examples:
            - Jane
        last_name:
          type: string
          examples:
            - Doe
        email:
          type: string
          format: email
          examples:
            - jane@greenville.gov
        role:
          type: string
          enum:
            - council_admin
            - council_power_user
            - council_member
          examples:
            - council_admin
  securitySchemes:
    apiKey:
      type: apiKey
      in: header
      name: X-API-Key
      description: SageScreen API key stored in `ss_zapier_api_key` option

````