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

# Website Contact Finder API

> Get a company's identity, brand, and every public contact detail for any domain

## Overview

<Badge icon="coins" color="blue" size="sm" shape="pill">1 credit per call</Badge>


## OpenAPI

````yaml openapi.json GET /v1/domain/{domain}
openapi: 3.0.0
info:
  title: ScoutLayer API
  version: 1.0.0
  description: Competitor data. One API.
servers:
  - url: https://scoutlayer.io/api
    description: Production
security:
  - ApiKeyAuth: []
  - BearerAuth: []
paths:
  /v1/domain/{domain}:
    get:
      tags:
        - domain
      summary: >-
        Get a company's identity, brand, and every public contact detail for any
        domain
      description: >-
        Resolve a domain to the company behind it: declared identity, logo and
        brand colours, and every public email, phone and social profile the site
        itself publishes. Result-based pricing: 0 credits when `best_contact` is
        null (no working email found), otherwise 1 credit — a phone number or
        social profile alone never triggers a charge.
      parameters:
        - schema:
            type: string
            minLength: 1
            example: stripe.com
          required: true
          name: domain
          in: path
        - schema:
            type: string
            description: >-
              How many of the site's own pages to read, 1-20. Default 8, which
              covers the conventional contact pages on almost every site.
            example: '8'
          required: false
          description: >-
            How many of the site's own pages to read, 1-20. Default 8, which
            covers the conventional contact pages on almost every site.
          name: maxPages
          in: query
      responses:
        '200':
          description: >-
            Get a company's identity, brand, and every public contact detail for
            any domain
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: string
                    enum:
                      - ok
                      - error
                  domain:
                    type: string
                  information:
                    type: object
                    properties:
                      name:
                        type: string
                        nullable: true
                      legal_name:
                        type: string
                        nullable: true
                        description: >-
                          The registered entity behind the site, when one is
                          stated — e.g. `Stripe, Inc.` rather than `Stripe`.
                          Read from schema.org markup when declared, otherwise
                          from the site's own Terms/Privacy copy or footer
                          copyright line.
                        example: Example Technologies, Inc.
                      website:
                        type: string
                        nullable: true
                      title:
                        type: string
                        nullable: true
                      description:
                        type: string
                        nullable: true
                      language:
                        type: string
                        nullable: true
                      logo:
                        type: object
                        nullable: true
                        properties:
                          url:
                            type: string
                          width:
                            type: integer
                            nullable: true
                          height:
                            type: integer
                            nullable: true
                        required:
                          - url
                          - width
                          - height
                      favicon:
                        type: object
                        nullable: true
                        properties:
                          url:
                            type: string
                        required:
                          - url
                      og_image:
                        type: string
                        nullable: true
                        description: >-
                          The site's declared social-share preview image
                          (`og:image`/`twitter:image`) — a larger marketing
                          image, distinct from `logo`/`favicon`.
                      address:
                        type: object
                        nullable: true
                        properties:
                          street:
                            type: string
                            nullable: true
                          city:
                            type: string
                            nullable: true
                          region:
                            type: string
                            nullable: true
                          postal_code:
                            type: string
                            nullable: true
                          country:
                            type: string
                            nullable: true
                          country_code:
                            type: string
                            nullable: true
                            description: >-
                              ISO 3166-1 alpha-2, when the country name resolves
                              to one
                            example: US
                          formatted:
                            type: string
                            nullable: true
                        required:
                          - street
                          - city
                          - region
                          - postal_code
                          - country
                          - country_code
                          - formatted
                      brand:
                        type: object
                        nullable: true
                        properties:
                          primary_color:
                            type: string
                            nullable: true
                            example: '#635bff'
                          colors:
                            type: array
                            items:
                              type: string
                        required:
                          - primary_color
                          - colors
                    required:
                      - name
                      - legal_name
                      - website
                      - title
                      - description
                      - language
                      - logo
                      - favicon
                      - address
                      - brand
                  best_contact:
                    type: object
                    nullable: true
                    properties:
                      type:
                        type: string
                        enum:
                          - person_email
                          - role_email
                          - generic_email
                        description: >-
                          Always an email. `best_contact` is null rather than
                          falling back to a phone number, a contact form, or a
                          social profile — those still appear in their own
                          arrays.
                      value:
                        type: string
                      person_id:
                        type: string
                        nullable: true
                      name:
                        type: string
                        nullable: true
                      role:
                        type: string
                        nullable: true
                      confidence:
                        type: number
                        minimum: 0
                        maximum: 1
                      source_urls:
                        type: array
                        items:
                          type: string
                        description: Pages this fact was read off
                      email_source:
                        type: string
                        enum:
                          - observed
                          - guessed
                        description: >-
                          `observed` was actually published on the site.
                          `guessed` is inferred from the person's name and the
                          domain, then checked for a valid mail-accepting domain
                          — never confirmed to be that person's real mailbox.
                          See `people[].email_source`.
                    required:
                      - type
                      - value
                      - person_id
                      - name
                      - role
                      - confidence
                      - source_urls
                  emails:
                    type: array
                    items:
                      type: object
                      properties:
                        email:
                          type: string
                        type:
                          type: string
                          enum:
                            - personal
                            - role
                            - generic
                          description: >-
                            `personal` names a person (jane@). `role` addresses
                            a function (sales@, press@). `generic` is a
                            catch-all with no specific function (info@, hello@).
                        person_id:
                          type: string
                          nullable: true
                        confidence:
                          type: number
                          minimum: 0
                          maximum: 1
                        source_urls:
                          type: array
                          items:
                            type: string
                          description: Pages this fact was read off
                      required:
                        - email
                        - type
                        - person_id
                        - confidence
                        - source_urls
                  phones:
                    type: array
                    items:
                      type: object
                      properties:
                        phone:
                          type: string
                        type:
                          type: string
                          enum:
                            - business
                            - mobile
                            - unknown
                        confidence:
                          type: number
                          minimum: 0
                          maximum: 1
                        source_urls:
                          type: array
                          items:
                            type: string
                          description: Pages this fact was read off
                      required:
                        - phone
                        - type
                        - confidence
                        - source_urls
                  socials:
                    type: array
                    items:
                      type: object
                      properties:
                        platform:
                          type: string
                          example: linkedin
                        url:
                          type: string
                        handle:
                          type: string
                          nullable: true
                        source_urls:
                          type: array
                          items:
                            type: string
                          description: Pages this fact was read off
                      required:
                        - platform
                        - url
                        - handle
                        - source_urls
                  people:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: string
                        name:
                          type: string
                        role:
                          type: string
                          nullable: true
                        email:
                          type: string
                          nullable: true
                        email_source:
                          type: string
                          nullable: true
                          enum:
                            - observed
                            - guessed
                            - null
                          description: >-
                            `observed` was actually published on the site.
                            `guessed` is inferred from the person's name and the
                            domain, then checked for a valid mail-accepting
                            domain — never confirmed to be that person's real
                            mailbox. See `people[].email_source`.
                        linkedin_url:
                          type: string
                          nullable: true
                        confidence:
                          type: number
                          minimum: 0
                          maximum: 1
                        source_urls:
                          type: array
                          items:
                            type: string
                          description: Pages this fact was read off
                      required:
                        - id
                        - name
                        - role
                        - email
                        - confidence
                        - source_urls
                      description: >-
                        A person the site itself names with a role (e.g. a team
                        page's "Jane Doe, Founder") — never looked up
                        externally. Empty when the site doesn't publish any.
                  pages:
                    type: array
                    items:
                      type: object
                      properties:
                        type:
                          type: string
                          enum:
                            - contact
                            - about
                            - team
                            - leadership
                            - author
                            - other
                        url:
                          type: string
                        title:
                          type: string
                          nullable: true
                      required:
                        - type
                        - url
                        - title
                  summary:
                    type: object
                    properties:
                      has_contact:
                        type: boolean
                      has_email:
                        type: boolean
                      email_count:
                        type: integer
                      phone_count:
                        type: integer
                      social_count:
                        type: integer
                      people_count:
                        type: integer
                    required:
                      - has_contact
                      - has_email
                      - email_count
                      - phone_count
                      - social_count
                      - people_count
                  meta:
                    type: object
                    properties:
                      credits_consumed:
                        type: integer
                      fetched_at:
                        type: string
                      processing_ms:
                        type: integer
                    required:
                      - credits_consumed
                      - fetched_at
                      - processing_ms
                required:
                  - status
                  - domain
                  - information
                  - best_contact
                  - emails
                  - phones
                  - socials
                  - people
                  - pages
                  - summary
                  - meta
        '400':
          description: Invalid request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '402':
          description: Insufficient credits
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '403':
          description: Email not verified — never charged
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '404':
          description: Not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '429':
          description: Too many requests — never charged, retry shortly
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '501':
          description: This endpoint is declared but not yet implemented — never charged
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '502':
          description: The orchestrator failed or was unreachable
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      security:
        - ApiKeyAuth: []
        - BearerAuth: []
components:
  schemas:
    Error:
      type: object
      properties:
        error:
          type: object
          properties:
            code:
              type: string
              example: NOT_FOUND
            message:
              type: string
          required:
            - code
            - message
      required:
        - error
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: X-API-Key
      description: >-
        API key passed as the X-API-Key request header. Recommended for
        server-to-server calls.
    BearerAuth:
      type: http
      scheme: bearer
      description: >-
        API key (or OAuth token) passed as a Bearer token in the Authorization
        header.

````