Cobot Space Profile API

openapi: 3.2.0
info:
  title: Cobot Space Profile 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: Space Profile
  description: Public profile information such as location, phone, website, social media links.
paths:
  /space_profiles/{id}:
    get:
      summary: Get a space profile
      description: 'To obtain the link to a space profile, see the relationships of the corresponding space.


        **Access**: Any user can access any space''s profile information.


        The `location` attribute is a free-form string. When a structured address is

        available, it is returned in the `structuredAddress` attribute.'
      operationId: get-space-profile
      parameters:
      - name: id
        in: path
        required: true
        description: The id of the space profile.
        schema:
          type: string
      security:
      - OAuth2:
        - read_space_profiles
      tags:
      - Space Profile
      responses:
        '200':
          description: Space profile data.
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/space_profile'
              examples:
                default:
                  value:
                    data:
                      id: f9a99a71ac8df98d29de357180d273d3
                      type: spaceProfiles
                      attributes:
                        location: Berlin, DE
                        phone: 555-123 456
                        contactEmail: info@cobot.me
                        externalLinks:
                        - type: website
                          url: https://cobot.me
                        - type: facebook
                          url: https://www.facebook.com/cobot.me/
                        - type: googleMaps
                          url: https://goo.gl/maps/WhosLiufwZktBPgN6
                        - type: twitter
                          url: https://twitter.com/cobot_me
                        - type: instagram
                          url: https://instagram.com/cobot_me
                        openStatus:
                          status: closed
                          additionalInformation: We are closed and all events are canceled due to Covid-19.
                        openHours:
                        - weekday: 1
                          from: 09:00
                          to: '17:00'
                        - weekday: 2
                          from: 09:00
                          to: '17:00'
                      relationships:
                        space:
                          links:
                            related: https://api.cobot.me/spaces/f9a99a71ac8df98d29de357180d273d3
                separateAddressFields:
                  summary: With structured address
                  value:
                    data:
                      id: f9a99a71ac8df98d29de357180d273d3
                      type: spaceProfiles
                      attributes:
                        location: Berlin, DE
                        structuredAddress:
                          name: co.up
                          company: null
                          street: 123 Main St
                          postCode: '10115'
                          city: Berlin
                          state: null
                          countryCode: BE
                          fullAddress: '123 Main St

                            10115 Berlin'
                          latitude: 52.5284295
                          longitude: 13.3800763
                        phone: 555-123 456
                        contactEmail: info@cobot.me
                        externalLinks:
                        - type: website
                          url: https://cobot.me
                        openStatus:
                          status: open
                          additionalInformation: null
                      relationships:
                        space:
                          links:
                            related: https://api.cobot.me/spaces/f9a99a71ac8df98d29de357180d273d3
components:
  schemas:
    invoiceAddress:
      type: object
      additionalProperties: false
      required:
      - name
      - company
      - fullAddress
      - city
      - postCode
      - state
      - street
      - countryCode
      properties:
        name:
          oneOf:
          - type: string
          - type: 'null'
        company:
          oneOf:
          - type: string
          - type: 'null'
        fullAddress:
          type: string
        street:
          oneOf:
          - type: string
          - type: 'null'
        postCode:
          oneOf:
          - type: string
          - type: 'null'
        city:
          oneOf:
          - type: string
          - type: 'null'
        state:
          oneOf:
          - type: string
          - type: 'null'
        countryCode:
          oneOf:
          - type: string
          - type: 'null'
        latitude:
          type: number
        longitude:
          type: number
      dependencies:
        latitude:
        - longitude
        longitude:
        - latitude
    space_profile:
      id: space_profile.json#
      type: object
      required:
      - data
      additionalProperties: false
      properties:
        data:
          type: object
          required:
          - id
          - type
          additionalProperties: false
          properties:
            id:
              type: string
            type:
              type: string
              pattern: spaceProfiles
            attributes:
              type: object
              additionalProperties: false
              properties:
                location:
                  oneOf:
                  - type: 'null'
                  - type: string
                  description: Free-form location string.
                structuredAddress:
                  oneOf:
                  - type: 'null'
                  - $ref: '#/components/schemas/invoiceAddress'
                  description: Structured address when available; null otherwise.
                phone:
                  oneOf:
                  - type: 'null'
                  - type: string
                contactEmail:
                  oneOf:
                  - type: 'null'
                  - type: string
                    format: email
                externalLinks:
                  type: array
                  items:
                    type: object
                    required:
                    - url
                    - type
                    additionalProperties: false
                    properties:
                      url:
                        type: string
                        format: uri-reference
                      type:
                        type: string
                        enum:
                        - website
                        - yelp
                        - facebook
                        - googleMaps
                        - instagram
                        - twitter
                        - linkedin
                openStatus:
                  type: object
                  additionalProperties: false
                  properties:
                    status:
                      oneOf:
                      - type: 'null'
                      - type: string
                        enum:
                        - open
                        - membersOnly
                        - closed
                    additionalInformation:
                      oneOf:
                      - type: 'null'
                      - type: string
                openHours:
                  type: array
                  description: Active opening hours only. Days without hours are omitted.
                  items:
                    type: object
                    required:
                    - weekday
                    - from
                    - to
                    additionalProperties: false
                    properties:
                      weekday:
                        type: integer
                        minimum: 1
                        maximum: 7
                        description: 1 is Monday, 7 is Sunday (ISO 8601).
                      from:
                        oneOf:
                        - type: 'null'
                        - type: string
                          pattern: ^([01]\d|2[0-3]):[0-5]\d$
                        description: Opening time in the space's time zone, 24h format.
                      to:
                        oneOf:
                        - type: 'null'
                        - type: string
                          pattern: ^([01]\d|2[0-3]):[0-5]\d$
                        description: Closing time in the space's time zone, 24h format.
            relationships:
              type: object
              additionalProperties: false
              properties:
                space:
                  type: object
  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.