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

# List inbox placement blacklist & spamassassin report

> Requires one of the following scopes: `inbox_placement_reports:read`, `inbox_placement_reports:all`, `all:read`, `all:all`



## OpenAPI

````yaml https://api.instantly.ai/openapi/api_v2.json get /api/v2/inbox-placement-reports
openapi: 3.1.0
info:
  title: API Explorer
  description: >-
    The entire API V2 documentation is interactive and can be tested here. To
    the right side of every endpoint you will see a box with an example request.
    You can click on the "Try it" button to send a request to the server right
    from the docs. You will need to provide an API key by clicking the
    `ApiKeyAuth_token` blue text.
  version: 2.0.0
servers:
  - url: https://api.instantly.ai
    description: Instantly API Server
security:
  - ApiKeyAuth: []
tags:
  - name: Analytics
    description: Endpoints related to analytics
    x-displayName: Analytics
  - name: OAuth
    description: >-
      OAuth authentication endpoints for connecting Google and Microsoft email
      accounts
    x-displayName: OAuth
  - name: Account
    description: An email account that can be used to send campaigns
    x-displayName: Account
  - name: Campaign
    description: A campaign that can be sent to a list of recipients
    x-displayName: Campaign
  - name: Email
    description: >-
      A campaign email, a reply, a manually sent email, or any other email
      that's visible in the Unibox
    x-displayName: Email
  - name: EmailVerification
    description: A single email verification
    x-displayName: Email Verification
  - name: LeadList
    description: A list used to store leads
    x-displayName: Lead List
  - name: InboxPlacementTest
    description: An inbox placement test
    x-displayName: Inbox Placement Test
  - name: InboxPlacementAnalytics
    description: Analytics data for individual emails in inbox placement tests
    x-displayName: Inbox Placement Analytics
  - name: InboxPlacementBlacklist&SpamAssassinReport
    description: Report data for an inbox placement test
    x-displayName: Inbox Placement Blacklist & SpamAssassin Report
  - name: APIKey
    description: API Key
    x-displayName: API Key
  - name: AccountCampaignMapping
    description: Account Campaign Mapping
    x-displayName: Account Campaign Mapping
  - name: Lead
    description: A lead entity representing an individual lead
    x-displayName: Lead
  - name: BackgroundJob
    description: A background job that can be used to perform long-running tasks
    x-displayName: Background Job
  - name: CustomTag
    description: >-
      A custom tag for organizing and categorizing accounts and campaigns. You
      can use them as filters in apis that list accounts and campaigns.
    x-displayName: Custom Tag
  - name: CustomTagMapping
    description: >-
      This entity represents a tag being assigned to a specific campaign or
      email account. When an email account is assigned a tag, a new custom tag
      mapping entry is created, which connects the tag (`tag_id` field) with the
      email account (`resource_id` field). You can use it to see which tag si
      connected to which resource.
    x-displayName: Custom Tag Mapping
  - name: BlockListEntry
    description: A blocked email or domain
    x-displayName: Block List Entry
  - name: LeadLabel
    description: A custom label for categorizing and managing leads
    x-displayName: Lead Label
  - name: Workspace
    description: A workspace entity representing a workspace
    x-displayName: Workspace
  - name: SuperSearchEnrichment
    description: >-
      An enrichment can take different forms, such as email enrichment or
      LinkedIn enrichment. Leads may be imported from SuperSearch using the
      dedicated endpoint, or enriched directly within a list or campaign by
      attaching an enrichment to it.
    x-displayName: SuperSearch Enrichment
  - name: WorkspaceGroupMember
    description: >-
      A member of a workspace group. You can use the endpoints within this
      entity to manage the members of a workspace group.
    x-displayName: Workspace Group Member
  - name: WorkspaceMember
    description: A member of a workspace with associated user details
    x-displayName: Workspace Member
  - name: CampaignSubsequence
    description: A subsequence entity representing a follow-up sequence
    x-displayName: Campaign Subsequence
  - name: AuditLog
    description: Audit log records for tracking system activities
    x-displayName: Audit Log
  - name: Webhook
    description: A webhook subscription for receiving event notifications
    x-displayName: Webhook
  - name: WebhookEvent
    description: A webhook event that was sent or attempted to be sent
    x-displayName: Webhook Event
  - name: DFYEmailAccountOrder
    description: A Done-For-You email account order
    x-displayName: DFY Email Account Order
  - name: CustomPromptTemplate
    description: Custom prompt templates for creating custom prompts
    x-displayName: Custom Prompt Template
  - name: SalesFlow
    description: >-
      Manages how sales users view and interact with campaign and lead lists
      within the sales flow.
    x-displayName: Sales Flow
  - name: EmailTemplate
    description: A campaign email template
    x-displayName: Email Template
  - name: WorkspaceBilling
    description: Workspace Billing
    x-displayName: Workspace Billing
  - name: CRMActions
    description: CRM related actions
    x-displayName: CRM Actions
paths:
  /api/v2/inbox-placement-reports:
    get:
      tags:
        - InboxPlacementBlacklist&SpamAssassinReport
      summary: List inbox placement blacklist & spamassassin report
      description: >-
        Requires one of the following scopes: `inbox_placement_reports:read`,
        `inbox_placement_reports:all`, `all:read`, `all:all`
      operationId: listInboxPlacementBlacklist&SpamAssassinReport
      parameters:
        - schema:
            type: integer
            minimum: 1
            maximum: 100
            example: 10
          in: query
          name: limit
          required: false
          description: The number of items to return
        - schema:
            type: string
            example: 01956fbd-0eb1-72db-a565-82977a586084
          in: query
          name: starting_after
          required: false
          description: >-
            The ID of the last item in the previous page - used for pagination.
            You can use the value of the `next_starting_after` field from the
            previous response.
        - schema:
            type: string
            format: uuid
            example: d290f1ee-6c54-4b01-90e6-d701748f0851
          in: query
          name: test_id
          required: true
        - schema:
            type: string
            example: '2026-05-11T21:12:47.281Z'
          in: query
          name: date_from
          required: false
        - schema:
            type: string
            example: '2026-05-11T21:12:47.281Z'
          in: query
          name: date_to
          required: false
        - schema:
            type: boolean
            example: false
          in: query
          name: skip_spam_assassin_report
          required: false
          description: Flag to skip including spam_assassin_report JSON
        - schema:
            type: boolean
            example: false
          in: query
          name: skip_blacklist_report
          required: false
          description: Flag to skip including blacklist_report JSON
      responses:
        '200':
          description: The list of Inbox Placement Blacklist & SpamAssassin Report
          content:
            application/json:
              schema:
                type: object
                properties:
                  items:
                    type: array
                    description: >-
                      The list of Inbox Placement Blacklist & SpamAssassin
                      Report
                    items:
                      $ref: '#/components/schemas/def-7'
                  next_starting_after:
                    type: string
                    description: >-
                      The filter for getting the next items after this one, this
                      could either be a UUID, a timestamp, on an email depending
                      on the specific API
                    example: 019e18e2-a5b1-7894-adb7-d3d8091a2f22
                additionalProperties: false
                required:
                  - items
        '401':
          description: >-
            This request is unauthorized (either the Authorization header is
            missing or invalid, or the API key has been revoked)
          content:
            application/json:
              schema:
                type: object
                properties:
                  statusCode:
                    type: number
                    enum:
                      - 401
                    example: 401
                  error:
                    type: string
                    enum:
                      - Unauthorized
                    example: Unauthorized
                  message:
                    type: string
                    example: Missing Authorization header
                required:
                  - statusCode
                  - error
                  - message
        '402':
          description: >-
            This request cannot be fulfilled because the workspace does not have
            an active paid plan
          content:
            application/json:
              schema:
                type: object
                properties:
                  statusCode:
                    type: number
                    enum:
                      - 402
                    example: 402
                  error:
                    type: string
                    enum:
                      - Payment Required
                    example: Payment Required
                  message:
                    type: string
                    example: Workspace does not have an active paid plan
                required:
                  - statusCode
                  - error
                  - message
        '404':
          description: The requested resource was not found
          content:
            application/json:
              schema:
                type: object
                properties:
                  statusCode:
                    type: number
                    enum:
                      - 404
                    example: 404
                  error:
                    type: string
                    enum:
                      - Not Found
                    example: Not Found
                  message:
                    type: string
                    example: Resource not found
                required:
                  - statusCode
                  - error
                  - message
        '429':
          description: >-
            You have exceeded the rate limit. Please check the rate limit docs
            for more information.
          content:
            application/json:
              schema:
                type: object
                properties:
                  statusCode:
                    type: number
                    enum:
                      - 429
                    example: 429
                  error:
                    type: string
                    enum:
                      - Too Many Requests
                    example: Too Many Requests
                  message:
                    type: string
                    example: Rate limit exceeded
                required:
                  - statusCode
                  - error
                  - message
components:
  schemas:
    def-7:
      title: Inbox Placement Blacklist & SpamAssassin Report
      description: Report data for an inbox placement test
      x-tags:
        - Schemas
        - InboxPlacementBlacklist&SpamAssassinReport
      type: object
      properties:
        id:
          type: string
          description: Unique identifier for the inbox placement report entry
          readOnly: true
          format: uuid
          example: 019e18e2-78f6-7cae-9b04-fe6c6a4b5944
        timestamp_created:
          type: string
          description: Timestamp when the inbox placement report was created
          readOnly: true
          example: '2026-05-11T21:12:35.830Z'
        timestamp_created_date:
          type: string
          description: Date when the inbox placement report was created
          readOnly: true
          example: '2026-05-11'
        organization_id:
          type: string
          description: Organization ID
          readOnly: true
          format: uuid
          example: 019e18e2-78f6-7cae-9b04-fe6dcb7e8449
        test_id:
          type: string
          description: Inbox Placement Test ID
          readOnly: true
          format: uuid
          example: 019e18e2-78f6-7cae-9b04-fe6eb488dcc9
        domain_blacklist_count:
          type:
            - 'null'
            - number
          description: Count of blacklists the domain is listed on
          readOnly: true
          example: 5
        domain:
          type: string
          description: Domain of the inbox placement report
          readOnly: true
          example: growinstantly.com
        domain_ip:
          type: string
          description: IP address of the domain
          readOnly: true
          example: 192.168.1.1
        domain_ip_blacklist_count:
          type:
            - 'null'
            - number
          description: Count of blacklists the domain IP is listed on
          readOnly: true
          example: 3
        spam_assassin_score:
          type: number
          description: SpamAssassin score for the email, indicating spam likelihood
          readOnly: true
          example: 2.5
        spam_assassin_report:
          type: object
          description: Detailed SpamAssassin analysis report
          readOnly: true
          properties:
            is_spam:
              type: boolean
              description: Indicates if the message is classified as spam by SpamAssassin
              example: false
            report:
              type: array
              description: List of individual SpamAssassin rule evaluations
              items:
                type: object
                properties:
                  description:
                    type: string
                    description: The section or type of the rule triggered
                    example: BODY
                  name:
                    type: string
                    description: The name of the SpamAssassin rule
                    example: HTML_MESSAGE
                  score:
                    type: string
                    description: The score assigned to this rule evaluation
                    example: '0.0'
                required:
                  - description
                  - name
                  - score
            spam_score:
              type: integer
              description: Overall spam score assigned to the message by SpamAssassin
              example: 0
        blacklist_report:
          type: object
          description: Detailed blacklist report for the domain or IP
          readOnly: true
          properties:
            address:
              type: string
              description: The address or domain associated with the report
              example: growinstantly.com
            blacklisted_count:
              type: integer
              description: The count of blacklists the address is listed on
              example: 5
            details:
              type: array
              description: List of individual blacklist details
              items:
                properties:
                  blacklist:
                    type: string
                    description: The name of the blacklist
                    example: zen.spamhaus.org
                  is_listed:
                    type: boolean
                    description: Whether the address is listed on this blacklist
                    example: true
                  test_type:
                    type: string
                    description: The type of test
                    example: ip
                type: object
            ip:
              type: string
              description: The IP address associated with the blacklist check
              example: 104.21.62.47
            is_blacklisted:
              type: boolean
              description: Overall status indicating if the address is blacklisted
              example: true
            is_domain:
              type: boolean
              description: Whether the address is a domain
              example: true
      required:
        - id
        - timestamp_created
        - timestamp_created_date
        - organization_id
        - test_id
        - domain
        - domain_ip
        - spam_assassin_score
      additionalProperties: false
  securitySchemes:
    ApiKeyAuth:
      type: http
      scheme: bearer

````