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

# Retrieve guides

> Retrieve all guides for an organization. Requires locationRef. When using bearer token (non-basic auth), results are filtered by the user's access. <h3>OAuth</h3>Required scopes: <code>support.readonly</code> or <code>support</code>



## OpenAPI

````yaml /assets/openapi.json get /guides/v1
openapi: 3.0.2
info:
  title: Spacebring
  version: 1.0.0
  termsOfService: https://www.spacebring.com/terms
servers:
  - url: https://api.spacebring.com
security: []
paths:
  /guides/v1:
    get:
      tags:
        - Guides
      summary: Retrieve guides
      description: >-
        Retrieve all guides for an organization. Requires locationRef. When
        using bearer token (non-basic auth), results are filtered by the user's
        access. <h3>OAuth</h3>Required scopes: <code>support.readonly</code> or
        <code>support</code>
      operationId: getGuides
      parameters:
        - in: query
          name: locationRef
          description: The id of the organization (location).
          schema:
            type: string
            format: uuid
          required: true
        - in: query
          name: nextPageToken
          schema:
            $ref: '#/components/schemas/nextPageToken'
          description: Token to retrieve the next page of results.
          required: false
        - in: query
          name: limit
          schema:
            type: integer
            format: int64
            minimum: 1
            maximum: 100
            default: 25
          description: The number of items to return.
          required: false
        - in: header
          name: spacebring-network-id
          schema:
            type: string
            format: uuid
          required: false
          description: >-
            The id of the network. Required when using bearer token
            authentication
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  guides:
                    type: array
                    items:
                      $ref: '#/components/schemas/guide'
                  nextPageToken:
                    $ref: '#/components/schemas/nextPageToken'
                  searchQueryNext:
                    $ref: '#/components/schemas/searchQueryNext'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/responseError'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/responseError'
      security:
        - BasicAuth: []
        - OAuth2:
            - support
            - support.readonly
components:
  schemas:
    nextPageToken:
      type: string
      description: >-
        Opaque cursor token for retrieving the next page of results. Pass this
        value as the `nextPageToken` query parameter in your next request.
    guide:
      type: object
      properties:
        createDate:
          description: ISO timestamp of when the guide was created.
          type: string
          format: date-time
        description:
          description: Markdown content of the guide.
          type: string
        id:
          description: Unique identifier of the guide.
          type: string
          format: uuid
        locale:
          description: Detected language code of the guide content.
          type: string
        locationRef:
          description: ID of the organization (location) this guide belongs to.
          type: string
          format: uuid
        media:
          description: Images extracted from the guide description.
          type: array
          items:
            type: object
            properties:
              height:
                description: Image height in pixels.
                type: number
              key:
                description: Storage key of the image.
                type: string
              mime:
                description: MIME type of the image.
                type: string
              url:
                description: Public URL of the image.
                type: string
              width:
                description: Image width in pixels.
                type: number
            required:
              - height
              - key
              - mime
              - url
              - width
            additionalProperties: false
        title:
          description: Display name of the guide.
          type: string
        visibility:
          description: Who can see this guide.
          type: string
          enum:
            - public
            - admins
            - members
            - networkMembers
      required:
        - createDate
        - id
        - locationRef
        - media
        - title
        - visibility
      additionalProperties: false
    searchQueryNext:
      type: string
      description: >-
        Pre-built query string for the next page of results. Contains all active
        filter parameters combined with the next page token, ready to append to
        the endpoint URL.
    responseError:
      type: object
      properties:
        message:
          type: string
        type:
          type: string
  securitySchemes:
    BasicAuth:
      type: http
      description: >-
        See our [authentication
        documentation](https://www.spacebring.com/docs/api-reference/authentication#basic-authentication)
        for how to authorize your requests
      scheme: basic
    OAuth2:
      type: oauth2
      description: >-
        See our [authentication
        documentation](https://www.spacebring.com/docs/api-reference/authentication#oauth2)
        for how to authorize your requests
      flows:
        authorizationCode:
          authorizationUrl: https://api.spacebring.com/oauth2/authorize
          tokenUrl: https://api.spacebring.com/oauth2/token
          refreshUrl: https://api.spacebring.com/oauth2/token
          scopes:
            benefits.readonly: Read benefits and applications
            benefits: Read and write benefits and applications
            community.readonly: Read community companies and memberships
            community: Read and write community companies and memberships
            events.readonly: Read events and tickets
            events: Read and write events and tickets
            feed.readonly: Read feed posts
            feed: Read and write feed posts
            invoices.readonly: Read invoices
            invoices: Read and write invoices
            locations.readonly: Read locations
            locations: Read and write locations
            plans.readonly: Read plans
            plans: Read and write plans
            resources.readonly: Read resources and bookings
            resources: Read and write resources and bookings
            subscriptions.readonly: Read subscriptions
            subscriptions: Read and write subscriptions
            shop.readonly: Read products and orders
            shop: Read and write products and orders
            support.readonly: Read support tickets
            support: Read and write support tickets
            transactions.readonly: Read transactions
            transactions: Read and write transactions
            visitors.readonly: Read visitors
            visitors: Read and write visitors

````