Cobot URL API

openapi: 3.2.0
info:
  title: Cobot URL API
  termsOfService: https://www.cobot.me/terms
  x-logo:
    url: /api2_logo.webp
    backgroundColor: '#FFFFFF'
    altText: Cobot logo
  description: This is the 2.0 version of the Cobot API.
  version: '2.0'
  contact:
    name: Cobot Support
    url: https://dev.cobot.me/
    email: support@cobot.me
servers:
- url: https://api.cobot.me
security:
- OAuth2: []
tags:
- name: Url
  description: 'These URLs/URL templates enable API clients to provide

    links to the Cobot web interface without having to hard-code them.


    Each Url includes a unique, never changing `identifier` and either a `url`

    or `urlTemplate`. Templates must be expanded according to RFC 6570.'
paths:
  /spaces/{spaceId}/urls:
    get:
      summary: List for space
      description: 'This endpoints lists URLs and URL templates for a space. Some URLs might be missing in some spaces

        depending on the space''s settings.


        More URLs will be added over time.


        **Access**: Any user can access the URLs for a space.'
      operationId: get-space-urls
      parameters:
      - name: spaceId
        in: path
        required: true
        description: The id of the space.
        schema:
          type: string
      security:
      - OAuth2:
        - read_urls
      tags:
      - Url
      responses:
        '200':
          description: "List of URLs/URL templates for a space. For a list of all URL \nidentifiers refer to the schema below. The sample response only shows a \nsmall selection.\n"
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/space-urls'
              examples:
                default:
                  value:
                    data:
                    - id: eeb87942-e855-5310-89c2-9b2e75ff3402
                      type: urls
                      attributes:
                        identifier: admin:accounting-codes
                        label: Manage a space's accounting codes in the admin section
                        url: https://demo.cobot.me/admin/accounting_codes
                    - id: 95334eb24-g5eg-dge4-weff-2342ze4tt22e
                      type: urls
                      attributes:
                        identifier: admin:contact
                        label: A single space contact
                        urlTemplate: https://demo.cobot.me/admin/contact/{contactId}
                    - id: 9a1f2875-45f6-50c6-b943-e4b2d90de5cb
                      type: urls
                      attributes:
                        identifier: admin:new-membership
                        label: New membership form
                        urlTemplate: https://demo.cobot.me/admin/memberships/new{?external_booking_id,contact_id}
components:
  schemas:
    space-urls:
      id: space-urls.json#
      type: object
      required:
      - data
      additionalProperties: false
      properties:
        data:
          type: array
          items:
            type: object
            required:
            - type
            - id
            - attributes
            additionalProperties: false
            properties:
              id:
                type: string
              type:
                type: string
                pattern: urls
              attributes:
                oneOf:
                - type: object
                  required:
                  - identifier
                  - label
                  - url
                  additionalProperties: false
                  properties:
                    identifier:
                      type: string
                      description: A unique string identifying the type of URL.
                      enum:
                      - admin:accounting-codes
                      - admin:admins
                      - admin:bookings
                      - admin:cancel-subscription
                      - admin:customize-emails
                      - admin:cost-centers
                      - admin:dashboard
                      - admin:events
                      - admin:external-bookings
                      - admin:getting-started
                      - admin:guides
                      - admin:invoice-settings
                      - admin:memberships
                      - admin:new-customer
                      - admin:new-sepa-space-payment-method
                      - admin:resources
                      - admin:revenue-accounts
                      - admin:subscription-memberships
                      - space:events
                      - space:terms
                      - space:homepage
                      - space:imprint
                    label:
                      type: string
                      description: A human readable description of the URL.
                    url:
                      type: string
                      format: uri-reference
                      description: The URL of the page described by 'label' on the Cobot website.
                - type: object
                  required:
                  - identifier
                  - label
                  - url
                  additionalProperties: false
                  properties:
                    identifier:
                      type: string
                      description: A unique string identifying the type of  URL.
                      enum:
                      - space:privacy-policy
                    label:
                      type: string
                      description: A human readable description of the URL.
                    url:
                      type:
                      - 'null'
                      - string
                      format: uri-reference
                      description: The URL of the page described by 'label' on the Cobot website, or null if the page does not exist for this space.
                - type: object
                  required:
                  - identifier
                  - label
                  - urlTemplate
                  additionalProperties: false
                  properties:
                    identifier:
                      type: string
                      description: A unique string identifying the type of  URL.
                      enum:
                      - admin:booking.ics
                      - admin:contact
                      - admin:external-booking
                      - admin:edit-external-booking
                      - admin:new-external-booking
                      - admin:invoice
                      - admin:invoice-preview-items
                      - admin:membership
                      - admin:new-membership
                      - admin:team
                      - space:booking.ics
                      - space:invoice
                      - space:events
                      - space:member-event
                      - space:new-external-booking
                    label:
                      type: string
                      description: A human readable description of the URL.
                    urlTemplate:
                      type: string
                      description: A URL template (see RFC 6570) of the page described by 'label' on the Cobot website. Placeholders need to be replaced before the URL can be used.
  securitySchemes:
    OpenId:
      type: openIdConnect
      openIdConnectUrl: https://www.cobot.me/.well-known/openid-configuration
    OAuth2:
      type: oauth2
      description: "OAuth is \"an open protocol to allow secure API authorization in a simple and\nstandard method from desktop and web applications.\". \"OAuth 2.0 is the\nnext evolution of the OAuth protocol [..]. OAuth 2.0 focuses on client\ndeveloper simplicity [...]. It is supported by many popular sites such as\nFacebook and there are client libraries available for many programming\nlanguages.\n\nFor information about OAuth2 see the [oauth website](http://oauth.net/2/).\n\n**For OAuth2 you need a client id and secret. In order to get those you have\nto [register your application](/oauth2_clients).**\n\nAPI authorization works by passing a bearer token via the HTTP Authorization header:\n\n    Authorization: bearer <token>\n\n## Permissions (Scope)\n\nOAuth2 [defines scopes](https://tools.ietf.org/html/rfc6749#section-3.3) to\nrestrict access to certain resources.\n\nThe required scope for each resource can be found within the documentation\nfor each endpoint.\n\nPlease note that a user's scope can be limited when they access the API as\nan admin of a space and some of their admin permissions have been revoked.\n"
      flows:
        authorizationCode:
          authorizationUrl: https://www.cobot.me/oauth/authorize
          tokenUrl: https://www.cobot.me/oauth/access_token
          scopes:
            read_articles: Read help desk articles.
            read_allocations: Read resource allocation data.
            read_booking_credits: Read information about a membership's booking credits.
            read_bookings: Read booking data.
            read_built_in_email_customizations: Read built in email customizations.
            read_calendar_blockers: Read calendar blockers.
            read_check_ins: Read memberships' check-in data.
            read_contacts: Read contacts.
            read_drop_in_passes: Read drop-in passes.
            read_drop_in_pass_templates: Read drop-in pass templates.
            read_discount_codes: Read discount codes.
            read_event_attendances: Read who is attending an event.
            read_event_messages: Read messages sent about events.
            read_events: Read events of a space.
            read_external_bookings: Read external booking data.
            read_external_resources: Read resources enabled for external booking.
            read_invoices: Read invoices created for a membership in a space.
            read_memberships: Read information about memberships in a space.
            read_teams: Read information about teams in a space.
            read_membership_profiles: Read members' profile data.
            read_navigation_links: Read/list navigation links for a space.
            read_payment_methods: Read payment methods in order to process payments.
            read_published_membership_profiles: Read published members' profile data.
            read_networks: Read information about a network.
            read_products: Read information about products.
            read_resource_categories: Read information about booking calendar categories.
            read_resources: Read information about booking calendar resources.
            read_single_page_apps: Read information about single page apps.
            read_space_profiles: Read space profile information.
            read_spaces: Read basic space information.
            read_space_billing_details: Read information relevant to billing the space.
            read_space_payment_method: Read a space's payment method used to pay for the space's Cobot subscription.
            read_space_subscriptions: Read a space's subscription.
            read_terms_approvals: Shows missing approvals for the current member.
            read_urls: Read the URLs to the Cobot web interface.
            read_user: Read the current user's information.
            write_bookings: Write booking data.
            write_check_ins: Check a member in at a space.
            write_customers: Convert a space to a customer.
            write_drop_in_pass_purchases: Create drop-in pass purchases.
            write_drop_in_passes: Cancel drop-in passes.
            write_event_ticket_purchases: Create event ticket purchases.
            write_event_attendances: Attend/unattend events.
            write_event_messages: Create/update messages sent about events.
            write_events: Write to events of a space.
            write_external_bookings: Create/update bookings as a non-member.
            write_external_resources: Create/update/delete resources enabled for non-memberss
            write_resources: Create/update/delete booking calendar resources.
            write_invoices: Create invoices for members in a space.
            write_invoice_reminders: Send invoice reminder emails.
            write_membership_profiles: Manage the social profiles of members.
            write_navigation_links: Create/update/delete navigation links for a space.
            write_payments: Initiate payments for external bookings.
            write_single_page_apps: Create and update single page apps to be embedded on Cobot.
            write_space_billing_details: Update a space's billing details.
            write_space_payment_method: Update a space's payment method used to pay for the space's Cobot subscription.
            write_space_subscriptions: Change a space's subscription. Only trusted clients can request this scope. Contact support.
            write_terms_approvals: Approve different kinds of terms as a member.