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

# Get a surface

> Returns one surface, including the domain it wraps and that domain's slug.



## OpenAPI

````yaml /api-reference/openapi.json get /v1/surfaces/{id}
openapi: 3.1.0
info:
  title: ility API
  version: 1.0.0
  description: Read accessibility results and start scans in your ility workspace.
servers:
  - url: https://app.ilitylabs.com
security:
  - apiKey: []
tags:
  - name: Workspaces
  - name: Surfaces
  - name: Domains
  - name: Scans
  - name: Issues
paths:
  /v1/surfaces/{id}:
    get:
      tags:
        - Surfaces
      summary: Get a surface
      description: >-
        Returns one surface, including the domain it wraps and that domain's
        slug.
      parameters:
        - schema:
            type: string
            format: uuid
          required: true
          name: id
          in: path
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Surface'
        '404':
          description: Not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
components:
  schemas:
    Surface:
      type: object
      properties:
        id:
          type: string
          format: uuid
        workspace_id:
          type: string
          format: uuid
        group_id:
          type:
            - string
            - 'null'
          format: uuid
        type:
          type: string
          enum:
            - web
        name:
          type: string
        config:
          type: object
          additionalProperties: {}
        domain_id:
          type:
            - string
            - 'null'
          format: uuid
        status:
          type: string
          enum:
            - active
            - archived
        archived_at:
          type:
            - string
            - 'null'
          format: date-time
        domain:
          anyOf:
            - $ref: '#/components/schemas/SurfaceDomain'
            - type: 'null'
        created_at:
          type: string
          format: date-time
        updated_at:
          type: string
          format: date-time
      required:
        - id
        - workspace_id
        - group_id
        - type
        - name
        - config
        - domain_id
        - status
        - archived_at
        - domain
        - created_at
        - updated_at
    ErrorResponse:
      type: object
      properties:
        detail:
          type: string
        reason:
          type: string
      required:
        - detail
    SurfaceDomain:
      type: object
      properties:
        id:
          type: string
          format: uuid
        slug:
          type: string
        base_url:
          type: string
        name:
          type:
            - string
            - 'null'
        environment:
          type:
            - string
            - 'null'
      required:
        - id
        - slug
        - base_url
        - name
        - environment
  securitySchemes:
    apiKey:
      type: http
      scheme: bearer
      description: >-
        An ility API key, such as `ilk_1a2b3c4d_…`. Workspace owners create keys
        under Settings → API keys.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.