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

# Get Slug Availability

> GetSlugAvailability validates and returns whether the slug provided in the URL is available for use. Requests 
to this endpoint are purposefully slow to mitigate automated enumeration of slugs.




## OpenAPI

````yaml /openapi/organisations-api-v1.yaml get /slug/{slug}/availability
openapi: 3.1.0
info:
  title: Organisations API
  description: >-
    The Organisations API provides users the ability to manage their
    organisations.
  version: v1
servers:
  - url: https://platform.versori.com/api/organisations/v1
    description: Production server
  - url: http://localhost:8081/v1
    description: Localhost
security: []
tags:
  - name: organisations
    description: >
      Organisations is the root-level entity for the Versori platform. All
      resources are scoped under an Organisation,

      each Organisation has an owner and can have multiple members.
  - name: signing-keys
    description: >
      Signing keys are used to sign JWTs which can be used to authenticate
      requests to the Versori platform.
paths:
  /slug/{slug}/availability:
    get:
      summary: Get Slug Availability
      description: >
        GetSlugAvailability validates and returns whether the slug provided in
        the URL is available for use. Requests 

        to this endpoint are purposefully slow to mitigate automated enumeration
        of slugs.
      operationId: GetSlugAvailability
      parameters:
        - name: slug
          in: path
          required: true
          schema:
            type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SlugAvailability'
        default:
          description: Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
components:
  schemas:
    SlugAvailability:
      type: object
      properties:
        ok:
          description: >-
            OK is true if the slug is available for use, otherwise false and
            messages will be populated.
          type: boolean
        messages:
          description: >
            Messages is a list of user-friendly messages describing the
            problem(s) with this slug. This will always be

            an empty array if the slug is available.
          type: array
          items:
            type: string
      required:
        - ok
        - messages
    Error:
      type: object
      properties:
        code:
          type: string
          description: Code is a machine-readable error code.
        message:
          type: string
          description: Message is a human-readable error message.
        cause:
          type: string
          x-go-type-skip-optional-pointer: true
      required:
        - code
        - message

````