Cobot Drop-In Pass API

openapi: 3.2.0
info:
  title: Cobot Drop-In Pass 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. You can find version 1.0\nas well as various tutorials under [/api-docs](/api-docs).\n\n## JSON API\n\nThis API follows the [JSON API](http://jsonapi.org) standard. This means:\n\n* requests and responses are sent in JSON\n* all requests MUST send a `Accept: application/vnd.api+json` header\n* non-GET requests MUST send a `Content-Type: application/vnd.api+json` header\n* all responses send a `Content-Type: application/vnd.api+json` header\n* all JSON formats are standardized (requests, responses, errors)\n\n## Cross-Origin Resource Sharing (CORS)\n\nAll endpoints send [CORS](https://developer.mozilla.org/en-US/docs/Web/HTTP/CORS)\nheaders so that the API can be used from within browsers.\n\n## Rate Limiting\n\nIn general, the rate limit for an endpoint is 60 requests per minute per user.\nIf applicable, alternative limits are given in the documentation for\nparticular endpoints.\n\nIf you've exceeded the limit, Cobot will return a 429 status code and a JSON\nerror message. The response will also contain a *Retry-After* header, this\ndenotes the number of seconds to wait before your client may retry.\n\n## Times and Dates\n\nTimes and Dates must be in ISO 8601 formats. e.g. date: `2021-01-07`, datetime: `2021-01-07T16:25:51Z`,  time: `16:25:51`.\nMillisecond are ommited, so `16:25:51.811` will become `16:25:51`.\nTime zone offsets must be provided by the client, e.g. `16:25:51+02:00` or '16:25:51Z' for UTC.\n\nTimes are always returned in UTC.\n## Sparse Fieldsets\n\nThis API supports [sparse fieldsets](https://jsonapi.org/format/#fetching-sparse-fieldsets),\nso clients can request which attributes they are interested in.\n\nExample:\n```\nGET https://api.cobot.me/user?fields[users]=email\n```\nThis will only return the user's email.\n\n## Query params\n\nWhen passing query params, arrays of data are expected to be sent as a string of comma separated values.\n\n## Pagination\n\nAll collections are paginated. Pagination follows [JSON-API standards](https://jsonapi.org/format/#fetching-pagination).\n\nExample:\n```json\n{\n  \"meta\": {\n    \"totalPages\": 2,\n    \"currentPage\": 1\n  },\n  \"data\": [{\n    \"id\": \"1\",\n    \"type\": \"users\",\n  }],\n  \"links\": {\n    \"self\": \"/users?page[size]=100&page[number]=1\",\n    \"first\": \"/users?page[size]=100&page[number]=1\",\n    \"prev\": null,\n    \"next\": \"/users?page[size]=100&page[number]=2\",\n    \"last\": \"/users?page[size]=100&page[number]=1\"\n  }\n}\n```\n\nDefault page size is 72 and can be changed by passing a `page[size]` parameter. Maximum page size is 200.\n\n## Errors\n\nWhen a client sends invalid data in a request, Cobot returns a\n422 status code and a JSON-API error response.\n\nExample:\n```json\n{\n  \"errors\": [\n    {\n      \"source\": {\n        \"pointer\": \"/data/attributes/name\"\n      },\n      \"detail\": \"can't be blank\"\n    },\n    {\n      \"source\": {\n        \"pointer\": \"/data/attributes/password\"\n      },\n      \"detail\": \"is too short\"\n    }\n  ]\n}\n```\n"
  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: Drop-In Pass
  description: Purchased drop-in passes.
paths:
  /drop_in_passes/{id}:
    get:
      summary: Get a single pass
      description: 'Get a single drop-in pass.

        These represent a drop-in pass a person bought from a space.


        **Access**: The current user must be an admin of the space.

        '
      operationId: get-drop-in-pass
      parameters:
      - name: id
        in: path
        required: true
        description: The id of the pass.
        schema:
          type: string
      security:
      - OAuth2:
        - read_drop_in_passes
      tags:
      - Drop-In Pass
      responses:
        '200':
          description: Details of a drop-in pass.
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/drop-in-pass'
              examples:
                default:
                  value:
                    data:
                      id: bc302cc2-f3f6-563e-8c09-37fcae5088b8
                      type: dropInPasses
                      attributes:
                        name: Day Pass
                        validOn: '2019-01-01'
                        onboardingInstructions: Come in and pick any free desk.
                        email: diwihru@cod.bh
                        phone: (219) 840-5295
                        taxId: 12345678A
                        price:
                          net: '89.0'
                          gross: '98.35'
                          currency: EUR
                          taxes:
                          - name: VAT
                            rate: '10.5'
                            amount: '9.35'
                        timeAvailability:
                        - from: 01:00
                          to: 05:00
                          weekdays:
                          - 1
                          - 2
                          - 5
                        comments: Looking forward to my visit!
                        status: confirmed
                        billingAddress:
                          name: Lucinda Moody
                          company: Moody Inc.
                          fullAddress: 1690 Belwog Street
                      relationships:
                        space:
                          data:
                            id: f9a99a71ac8df98d29de357180d273d3
                            type: spaces
                        dropInPassTemplate:
                          data:
                            id: a4a99a71ac8df98d29de357180d273d3
                            type: dropInPassTemplates
                        contact:
                          data:
                            id: 23c37a61ac8df98d29de357180d273d3
                            type: contacts
                        invoices:
                          data:
                          - id: fjwn437783tj98d29de357180d27hjk
                            type: invoices
                        dropInPassPurchase:
                          data:
                            id: b4d2ab8822fced7625f14918d18be64a
                            type: dropInPassPurchases
  /drop_in_passes/{id}/cancellation:
    post:
      summary: Cancel a drop-in pass
      description: 'Cancel a drop-in pass. The pass must not already be canceled.


        **Access**: The current user must be an admin of the space.

        '
      operationId: drop-in-pass-cancellation
      parameters:
      - name: id
        in: path
        required: true
        description: The id of the drop-in pass.
        schema:
          type: string
      security:
      - OAuth2:
        - write_drop_in_passes
      tags:
      - Drop-In Pass
      responses:
        '200':
          description: The drop-in pass has been canceled.
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/drop-in-pass'
              examples:
                default:
                  value:
                    data:
                      id: bc302cc2-f3f6-563e-8c09-37fcae5088b8
                      type: dropInPasses
                      attributes:
                        name: Day Pass
                        validOn: '2019-01-01'
                        onboardingInstructions: Come in and pick any free desk.
                        email: visitor@example.com
                        phone: (219) 840-5295
                        taxId: 12345678A
                        price:
                          net: '89.0'
                          gross: '98.35'
                          currency: EUR
                          taxes:
                          - name: VAT
                            rate: '10.5'
                            amount: '9.35'
                        timeAvailability:
                        - from: 01:00
                          to: 05:00
                          weekdays:
                          - 1
                          - 2
                          - 5
                        comments: Looking forward to my visit!
                        status: canceled
                        billingAddress:
                          name: Lucinda Moody
                          company: Moody Inc.
                          fullAddress: 1690 Belwog Street
                      relationships:
                        space:
                          data:
                            id: f9a99a71ac8df98d29de357180d273d3
                            type: spaces
                        dropInPassTemplate:
                          data:
                            id: a4a99a71ac8df98d29de357180d273d3
                            type: dropInPassTemplates
                        contact:
                          data:
                            id: 23c37a61ac8df98d29de357180d273d3
                            type: contacts
                        invoices:
                          data:
                          - id: fjwn437783tj98d29de357180d27hjk
                            type: invoices
                        dropInPassPurchase:
                          data:
                            id: b4d2ab8822fced7625f14918d18be64a
                            type: dropInPassPurchases
        '409':
          description: The drop-in pass is already canceled.
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/failure'
              examples:
                already_canceled:
                  value:
                    errors:
                    - detail: This drop-in pass is already canceled.
  /spaces/{spaceId}/drop_in_passes:
    get:
      summary: List for space
      description: 'List/filter drop-in passes for a time range.


        **Access**: Only admins of the space can see the list of passes.

        '
      operationId: list-space-drop-in-passes
      security:
      - OAuth2:
        - read_drop_in_passes
      tags:
      - Drop-In Pass
      parameters:
      - name: spaceId
        in: path
        required: true
        description: The id of the space to get the drop-in passes for.
        schema:
          type: string
      - name: filter[valid_on_from]
        in: query
        required: true
        description: The start of the time range.
        schema:
          type: string
          format: date
        example: '2012-04-12'
      - name: filter[valid_on_to]
        in: query
        required: true
        description: The end of the time range.
        schema:
          type: string
          format: date
        example: '2012-04-30'
      - name: filter[sortOrder]
        in: query
        required: false
        description: Whether to sort drop-in passes by ascending or descending date.
        schema:
          type: string
          default: asc
          enum:
          - asc
          - desc
      responses:
        '200':
          description: List of passes filtered by their valid_on date property.
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/drop-in-passes'
              examples:
                default:
                  value:
                    data:
                    - id: 3fab7e63-3f6d-58e7-8a22-cf97569511b2
                      type: dropInPasses
                      attributes:
                        name: Day Pass
                        onboardingInstructions: Come in and pick any free desk.
                        validOn: '2023-04-30'
                        email: pe@aj.hk
                        phone: (688) 621-8058
                        taxId: 12345678A
                        comments: Looking forward to my visit!
                        status: confirmed
                        price:
                          net: '100.0'
                          gross: '110.0'
                          currency: EUR
                          taxes:
                          - rate: '10.0'
                            amount: '10.0'
                            name: VAT
                        billingAddress:
                          name: Lucinda Moody
                          company: Bogisich LLC
                          fullAddress: 1553 Luzim Mill
                        timeAvailability:
                        - from: 01:00
                          to: 05:00
                          weekdays:
                          - 1
                          - 2
                          - 5
                      relationships:
                        space:
                          data:
                            id: f9a99a71ac8df98d29de357180d273d3
                            type: spaces
                        invoices:
                          data:
                          - id: fjwn437783tj98d29de357180d27hjk
                            type: invoices
                        dropInPassTemplate:
                          data:
                            id: kljmf42375jmfd29de357186sa4d444d
                            type: dropInPassTemplates
                        contact:
                          data:
                            id: u2374d68h2j067d708qhj6whgn372872
                            type: contacts
                        dropInPassPurchase:
                          data:
                            id: b4d2ab8822fced7625f14918d18be64a
                            type: dropInPassPurchases
components:
  schemas:
    currency:
      description: ISO 4217 3 letter currency code.
      type: string
      pattern: ^[A-Z]{3}$
    links:
      type: object
      additionalProperties:
        $ref: '#/components/schemas/link'
    drop-in-pass:
      id: drop-in-pass.json#
      type: object
      required:
      - data
      additionalProperties: false
      properties:
        data:
          $ref: '#/components/schemas/-drop-in-pass-data'
        included:
          type: array
          items:
            $ref: '#/components/schemas/-invoice-data'
    tax:
      type: object
      additionalProperties: false
      properties:
        name:
          type: string
        rate:
          $ref: '#/components/schemas/decimal'
        amount:
          $ref: '#/components/schemas/decimal'
    date:
      description: A date in the form YYYY-MM-DD.
      type: string
      pattern: ^\d{4}-\d{2}-\d{2}$
    error:
      type: object
      properties:
        id:
          description: A unique identifier for this particular occurrence of the problem.
          type: string
        links:
          $ref: '#/components/schemas/links'
        status:
          description: The HTTP status code applicable to this problem, expressed as a string value.
          type: string
        code:
          description: An application-specific error code, expressed as a string value.
          type: string
        title:
          description: A short, human-readable summary of the problem. It **SHOULD NOT** change from occurrence to occurrence of the problem, except for purposes of localization.
          type: string
        detail:
          description: A human-readable explanation specific to this occurrence of the problem.
          type: string
        source:
          type: object
          properties:
            pointer:
              description: A JSON Pointer [RFC6901] to the associated entity in the request document [e.g. "/data" for a primary data object, or "/data/attributes/title" for a specific attribute].
              type: string
            parameter:
              description: A string indicating which query parameter caused the error.
              type: string
        meta:
          $ref: '#/components/schemas/meta'
      additionalProperties: false
    revenue-account:
      type: object
      additionalProperties: false
      required:
      - name
      - number
      properties:
        name:
          type: string
        number:
          type: string
    decimal:
      description: A decimal number.
      type: string
      pattern: ^-?\d+(\.\d+)?$
    -drop-in-pass-data:
      id: -drop-in-pass-data.json
      type: object
      additionalProperties: false
      required:
      - id
      - type
      properties:
        id:
          type: string
        type:
          type: string
          enum:
          - dropInPasses
        attributes:
          type: object
          required:
          - name
          - email
          - phone
          - price
          - comments
          - taxId
          - billingAddress
          - validOn
          - onboardingInstructions
          - timeAvailability
          - status
          additionalProperties: false
          properties:
            name:
              type: string
            email:
              type:
              - string
              - 'null'
            phone:
              type:
              - string
              - 'null'
            price:
              $ref: '#/components/schemas/price'
            comments:
              type:
              - string
              - 'null'
            taxId:
              type:
              - string
              - 'null'
            billingAddress:
              $ref: '#/components/schemas/address'
            validOn:
              $ref: '#/components/schemas/date'
            onboardingInstructions:
              type:
              - string
              - 'null'
            timeAvailability:
              $ref: '#/components/schemas/bookingTimes'
            status:
              type: string
              enum:
              - confirmed
              - canceled
        relationships:
          type: object
          additionalProperties: false
          properties:
            space:
              type: object
              additionalProperties: false
              required:
              - data
              properties:
                data:
                  type: object
                  required:
                  - id
                  - type
                  additionalProperties: false
                  properties:
                    id:
                      type: string
                    type:
                      type: string
                      enum:
                      - spaces
            dropInPassTemplate:
              type: object
              additionalProperties: false
              required:
              - data
              properties:
                data:
                  oneOf:
                  - type: 'null'
                  - type: object
                    required:
                    - id
                    - type
                    additionalProperties: false
                    properties:
                      id:
                        type: string
                      type:
                        type: string
                        enum:
                        - dropInPassTemplates
            invoices:
              type: object
              additionalProperties: false
              properties:
                data:
                  type: array
                  items:
                    type: object
                    required:
                    - id
                    - type
                    additionalProperties: false
                    properties:
                      id:
                        type: string
                      type:
                        type: string
                        enum:
                        - invoices
            contact:
              type: object
              additionalProperties: false
              required:
              - data
              properties:
                data:
                  oneOf:
                  - type: 'null'
                  - type: object
                    required:
                    - id
                    - type
                    additionalProperties: false
                    properties:
                      id:
                        type: string
                      type:
                        type: string
                        enum:
                        - contacts
            dropInPassPurchase:
              type: object
              additionalProperties: false
              required:
              - data
              properties:
                data:
                  oneOf:
                  - type: 'null'
                  - type: object
                    required:
                    - id
                    - type
                    additionalProperties: false
                    properties:
                      id:
                        type: string
                      type:
                        type: string
                        enum:
                        - dropInPassPurchases
    pagination-links:
      type: object
      required:
      - first
      - self
      - next
      additionalProperties: false
      properties:
        first:
          type: string
          description: Link to the first results page.
        prev:
          oneOf:
          - type: string
          - type: 'null'
          description: Link to the previous results page. Null when on the first page.
        self:
          type: string
          description: Link to the current results page.
        next:
          oneOf:
          - type: string
          - type: 'null'
          description: Link to the next results page. Null when on the last page.
        last:
          type: string
          description: Link to the last results page.
    hours-minutes:
      type: string
      pattern: ^\d{2}:\d{2}$
    link:
      description: 'A link **MUST** be represented as either: a string containing the link''s URL or a link object.'
      oneOf:
      - description: A string containing the link's URL.
        type: string
        format: uri-reference
      - type: object
        required:
        - href
        properties:
          href:
            description: A string containing the link's URL.
            type: string
            format: uri-reference
          meta:
            $ref: '#/components/schemas/meta'
    price:
      description: Price including net/gross value and all taxes.
      type: object
      required:
      - net
      - gross
      - currency
      - taxes
      additionalProperties: false
      properties:
        net:
          $ref: '#/components/schemas/decimal'
        gross:
          $ref: '#/components/schemas/decimal'
        currency:
          $ref: '#/components/schemas/currency'
        taxes:
          type: array
          items:
            $ref: '#/components/schemas/tax'
    pagination-meta:
      type: object
      additionalProperties: false
      properties:
        totalPages:
          type: number
        currentPage:
          type: number
    cost-center:
      type: object
      additionalProperties: false
      required:
      - name
      - number
      properties:
        name:
          type: string
        number:
          type: string
    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
    drop-in-passes:
      id: drop-in-passes.json#
      type: object
      required:
      - data
      additionalProperties: false
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/-drop-in-pass-data'
        meta:
          $ref: '#/components/schemas/pagination-meta'
        links:
          $ref: '#/components/schemas/pagination-links'
        included:
          type: array
          items:
            $ref: '#/components/schemas/-invoice-data'
    address:
      type: object
      additionalProperties: false
      properties:
        name:
          oneOf:
          - type: string
          - type: 'null'
        company:
          oneOf:
          - type: string
          - type: 'null'
        fullAddress:
          type: string
          description: Only admins can see it.
    failure:
      type: object
      required:
      - errors
      properties:
        errors:
          type: array
          items:
            $ref: '#/components/schemas/error'
          uniqueItems: true
        meta:
          $ref: '#/components/schemas/meta'
        jsonapi:
          $ref: '#/components/schemas/jsonapi'
        links:
          $ref: '#/components/schemas/links'
      additionalProperties: false
    jsonapi:
      description: An object describing the server's implementation
      type: object
      properties:
        version:
          type: string
        meta:
          $ref: '#/components/schemas/meta'
      additionalProperties: false
    meta:
      description: Non-standard meta-information that can not be represented as an attribute or relationship.
      type: object
      additionalProperties: true
    bookingTimes:
      type: array
      description: Times/days or durations for which the resource can be booked. If empty, resource can be booked at any time.
      items:
        oneOf:
        - type: object
          additionalProperties: false
          required:
          - from
          - to
          - weekdays
          properties:
            from:
              $ref: '#/components/schemas/hours-minutes'
            to:
              $ref: '#/components/schemas/hours-minutes'
            weekdays:
              description: If empty, times are valid on any weekday. 1 = monday, 7 = sunday (see ISO 8601).
              type: array
              items:
                type: number
                minimum: 1
                maximum: 7
        - type: object
          additionalProperties: false
          required:
          - hours
          - minutes
          properties:
            hours:
              type: integer
            minutes:
              type: integer
    -invoice-data:
      id: -invoice-data.json
      type: object
      required:
      - id
      - type
      additionalProperties: false
      properties:
        id:
          type: string
        type:
          type: string
          enum:
          - invoices
        attributes:
          type: object
          required:
          - invoiceDate
          - dueDate
          - eInvoicingReady
          - remindAt
          - number
          - recipientAddress
          - senderAddress
          - items
          - payableAmount
          - paidAmount
          - totalAmount
          - paidStatus
          - sentStatus
          - reminderStatus
          - canUpdate
          - sentRemindersCount
          - senderTaxId
          - taxId
          - billingEmails
          additionalProperties: false
          properties:
            invoiceText:
              type:
              - string
              - 'null'
            billingEmails:
              type:
              - array
              items:
                type: string
                format: email
            invoiceDate:
              $ref: '#/components/schemas/date'
            paidDate:
              oneOf:
              - $ref: '#/components/schemas/date'
              - type: 'null'
            paidStatus:
              type: string
              enum:
              - unpaid
              - paid
              - pending
              - canceled
              - writtenOff
            dueDate:
              $ref: '#/components/schemas/date'
            eInvoicingReady:
              type: boolean
            remindAt:
              $ref: '#/components/schemas/date'
            number:
              type: string
            sentStatus:
              type: string
              enum:
              - unsent
              - sent
              - sending
              - sendingRequested
              - failedToSend
            reminderStatus:
              type: string
              description: The status of the last invoice reminder.
              enum:
              - notSent
              - sending
              - sent
              - failedToSend
            sentRemindersCount:
              type: integer
              minimum: 0
              description: The number of invoice reminders already sent.
            lastReminderSentAt:
              oneOf:
              - type: string
                format: date-time
              - type: 'null'
            senderTaxId:
              description: The tax id of the invoice sender.
              oneOf:
              - type: string
              - type: 'null'
            taxId:
              description: The tax id of the invoice recipient.
              oneOf:
              - type: string
              - type: 'null'
            taxIdName:
              type: string
              description: What the tax id is called (differs by country).
            pdf:
              type: object
              required:
              - url
              - archived
              - eInvoiceStandard
              - eInvoice
              additionalProperties: false
              properties:
                eInvoice:
                  type: boolean
                eInvoiceStandard:
                  oneOf:
                  - type: string
                  - type: 'null'
                url:
                  type: string
                  format: uri
                  description: The URL to the PDF version of the invoice. Note that the URL is not stable and will only work for a few minutes. It works without API authentication.
                archived:
                  type: boolean
                  description: Whether the PDF is archived, i.e. a PDF has been uploaded for the invoice. Before it is archived, a new PDF is generated on the fly on every request. Once archived, the PDF is guaranteed to never change.
            chargeAt:
              oneOf:
              - type: string
                format: date-time
              - type: 'null'
              description: If set, the invoice will automatically be charged at the given time.
            canCharge:
              type: boolean
              description: Whether the invoice can automatically be charged by Cobot.
            canUpdate:
              type: boolean
              description: Whether the invoice can be edited. Invoices can be edited until they are locked.
            customerNumber:
              oneOf:
              - type: string
              - type: 'null'
            recipientAddress:
              $ref: '#/components/schemas/invoiceAddress'
            senderAddress:
              $ref: '#/components/schemas/invoiceAddress'
            notes:
              oneOf:
              - type: string
              - type: 'null'
            items:
              type: array
              items:
                type: object
                additionalProperties: false
                required:
                - description
                - quantity
                - amount
                - totalAmount
                properties:
                  description:
                    type: string
                  paid:
                    type: boolean
                    description: Indicates an item that was already paid when the invoice was generated, i.e. does not contribute to the payable amount.
                  quantity:
                    $ref: '#/components/schemas/decimal'
                  accountingCode:
                    oneOf:
         

# --- truncated at 32 KB (42 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/cobot/refs/heads/main/openapi/cobot-drop-in-pass-api-openapi.yml