{
  "opencollection": "1.0.0",
  "info": {
    "name": "Cobot Resource API",
    "version": "2.0"
  },
  "request": {
    "auth": {
      "type": "oauth2",
      "flow": "authorization_code",
      "authorizationUrl": "https://www.cobot.me/oauth/authorize",
      "accessTokenUrl": "https://www.cobot.me/oauth/access_token",
      "credentials": {
        "clientId": "{{clientId}}",
        "clientSecret": "{{clientSecret}}"
      }
    }
  },
  "items": [
    {
      "info": {
        "name": "Resource",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "List network resource availabilities",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.cobot.me/networks/:networkId/resource_availabilities",
            "params": [
              {
                "name": "networkId",
                "value": "",
                "type": "path",
                "description": "The id of the network."
              },
              {
                "name": "filter[from]",
                "value": "",
                "type": "query",
                "description": "The time from when on to return the availability."
              },
              {
                "name": "filter[to]",
                "value": "",
                "type": "query",
                "description": "The time until when to return the availability."
              },
              {
                "name": "filter[resourceIds]",
                "value": "",
                "type": "query",
                "description": "Comma-separated list of resource ids to return availabilities for. Only resources belonging to spaces in this network will be included."
              }
            ],
            "auth": {
              "type": "oauth2",
              "flow": "authorization_code",
              "authorizationUrl": "https://www.cobot.me/oauth/authorize",
              "accessTokenUrl": "https://www.cobot.me/oauth/access_token",
              "credentials": {
                "clientId": "{{clientId}}",
                "clientSecret": "{{clientSecret}}"
              }
            }
          },
          "docs": "List the availability of multiple resources across all spaces in a network for a given time range. Considers existing bookings, each resource's booking times, cutoff, and calendar blockers.\n\nOnly resources that belong to spaces within the specified network will be included in the results. Resource IDs from outside the network will be filtered out.\n\n**Access**: The current user must be an admin or member of any space in the network.\n"
        },
        {
          "info": {
            "name": "List for network",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.cobot.me/networks/:networkId/resources",
            "params": [
              {
                "name": "networkId",
                "value": "",
                "type": "path",
                "description": "Id of the network."
              },
              {
                "name": "filter[usage]",
                "value": "",
                "type": "query",
                "description": "Filter resources by their usage. Defaults to `bookable` for backward compatibility.\n"
              },
              {
                "name": "filter[spaceIds]",
                "value": "",
                "type": "query",
                "description": "Comma-separated list of space IDs to filter resources by.\nIf omitted, returns resources for all spaces in the network.\n"
              }
            ],
            "auth": {
              "type": "oauth2",
              "flow": "authorization_code",
              "authorizationUrl": "https://www.cobot.me/oauth/authorize",
              "accessTokenUrl": "https://www.cobot.me/oauth/access_token",
              "credentials": {
                "clientId": "{{clientId}}",
                "clientSecret": "{{clientSecret}}"
              }
            }
          },
          "docs": "Get a list of resources for all spaces in a network.\n\n**Access**: The current user must be an admin or member of any\nspace in the network.\n"
        },
        {
          "info": {
            "name": "Available resources for network",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.cobot.me/networks/:networkId/resources/available",
            "params": [
              {
                "name": "networkId",
                "value": "",
                "type": "path",
                "description": "Id of the network."
              },
              {
                "name": "filter[from]",
                "value": "",
                "type": "query",
                "description": "The start of the timespan to check for availability."
              },
              {
                "name": "filter[to]",
                "value": "",
                "type": "query",
                "description": "The end of the timespan to check for availability."
              },
              {
                "name": "filter[spaceIds]",
                "value": "",
                "type": "query",
                "description": "Comma-separated list of space IDs to filter resources by.\nIf omitted, returns resources for all spaces in the network.\n"
              },
              {
                "name": "filter[ignoreBookingId]",
                "value": "",
                "type": "query",
                "description": "Id of a booking to not consider when determining availability. Useful for determining availbility before moving a booking to a different time."
              },
              {
                "name": "filter[ignoreBookingTimes]",
                "value": "",
                "type": "query",
                "description": "If set to true, returns resources as available even when the requested time is outside of the resource's booking times setting or blocked by calendar blockers. Option available only for admins of a space."
              },
              {
                "name": "filter[resourceIds]",
                "value": "",
                "type": "query",
                "description": "Limit returned resources to the given resource ids (comma separated)."
              }
            ],
            "auth": {
              "type": "oauth2",
              "flow": "authorization_code",
              "authorizationUrl": "https://www.cobot.me/oauth/authorize",
              "accessTokenUrl": "https://www.cobot.me/oauth/access_token",
              "credentials": {
                "clientId": "{{clientId}}",
                "clientSecret": "{{clientSecret}}"
              }
            }
          },
          "docs": "List the bookable resources that are available to book at a given time across all spaces in a network.\nThis means there are fewer existing bookings than the resources' units.\nFor members, the resources' `booking_times`, cutoff, min/max duration and calendar blockers are also taken into account.\n\nOnly resources with `usage: bookable` are returned. Allocatable resources are not included.\n\n**Access**: The current user must be an admin or member of any\nspace in the network.\n"
        },
        {
          "info": {
            "name": "Create resource",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.cobot.me/resources",
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "oauth2",
              "flow": "authorization_code",
              "authorizationUrl": "https://www.cobot.me/oauth/authorize",
              "accessTokenUrl": "https://www.cobot.me/oauth/access_token",
              "credentials": {
                "clientId": "{{clientId}}",
                "clientSecret": "{{clientSecret}}"
              }
            }
          },
          "docs": "Create a new resource in a space.\n\n**Access**: The current user must be an admin of the space\nthe resource if created in.\n"
        },
        {
          "info": {
            "name": "Get resource",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.cobot.me/resources/:id",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "The id of the resource."
              },
              {
                "name": "include",
                "value": "",
                "type": "query",
                "description": "List of related resources to include in response.\n`media` are the additional photos of a resource (the primary photo is\nin the `photo` attribute).\n"
              }
            ],
            "auth": {
              "type": "oauth2",
              "flow": "authorization_code",
              "authorizationUrl": "https://www.cobot.me/oauth/authorize",
              "accessTokenUrl": "https://www.cobot.me/oauth/access_token",
              "credentials": {
                "clientId": "{{clientId}}",
                "clientSecret": "{{clientSecret}}"
              }
            }
          },
          "docs": "See details of the resource.\n\n**Access**: The current user must be an admin or member of the space. If the\nspace is part of a network, the user must be an admin or member of any\nspace in the network.\n"
        },
        {
          "info": {
            "name": "Update resource",
            "type": "http"
          },
          "http": {
            "method": "PATCH",
            "url": "https://api.cobot.me/resources/:id",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "The id of the resource."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "oauth2",
              "flow": "authorization_code",
              "authorizationUrl": "https://www.cobot.me/oauth/authorize",
              "accessTokenUrl": "https://www.cobot.me/oauth/access_token",
              "credentials": {
                "clientId": "{{clientId}}",
                "clientSecret": "{{clientSecret}}"
              }
            }
          },
          "docs": "Update the details of a resource.\n\n**Access**: The current user must be an admin of the space the resource belongs to.\n"
        },
        {
          "info": {
            "name": "Availability",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.cobot.me/resources/:id/availability",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "The id of the resource."
              },
              {
                "name": "filter[from]",
                "value": "",
                "type": "query",
                "description": "The time from when on to return the availability."
              },
              {
                "name": "filter[to]",
                "value": "",
                "type": "query",
                "description": "The time until when to return the availability."
              }
            ],
            "auth": {
              "type": "oauth2",
              "flow": "authorization_code",
              "authorizationUrl": "https://www.cobot.me/oauth/authorize",
              "accessTokenUrl": "https://www.cobot.me/oauth/access_token",
              "credentials": {
                "clientId": "{{clientId}}",
                "clientSecret": "{{clientSecret}}"
              }
            }
          },
          "docs": "See the times a resource is still available to book. Considers existing\nbookings, the resource's booking times, cutoff and calendar blockers.\n\nOnly resources with `usage: bookable` are supported. Returns an error for allocatable resources.\n\n**Access**: The current user must be an admin or member of the space. If the\nspace is part of a network, the user must be an admin or member of any\nspace in the network.\n"
        },
        {
          "info": {
            "name": "List for space",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.cobot.me/spaces/:spaceId/resources",
            "params": [
              {
                "name": "spaceId",
                "value": "",
                "type": "path",
                "description": "The id of the space to get the resources for."
              },
              {
                "name": "filter[usage]",
                "value": "",
                "type": "query",
                "description": "Filter resources by their usage. Defaults to `bookable` for backward compatibility.\n"
              },
              {
                "name": "include",
                "value": "",
                "type": "query",
                "description": "List of related resources to include in response.\nIncluding `categories` requires the `read_resource_categories` scope.\n`media` are the additional photos of a resource (the primary photo is\nin the `photo` attribute).\n"
              }
            ],
            "auth": {
              "type": "oauth2",
              "flow": "authorization_code",
              "authorizationUrl": "https://www.cobot.me/oauth/authorize",
              "accessTokenUrl": "https://www.cobot.me/oauth/access_token",
              "credentials": {
                "clientId": "{{clientId}}",
                "clientSecret": "{{clientSecret}}"
              }
            }
          },
          "docs": "List the resources (and their categories) for a space.\n\n**Access**: The current user must be an admin or member of the space. If the\nspace is part of a network, the user must be an admin or member of any\nspace in the network.\n"
        },
        {
          "info": {
            "name": "Available resources",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.cobot.me/spaces/:spaceId/resources/available",
            "params": [
              {
                "name": "spaceId",
                "value": "",
                "type": "path",
                "description": "The id of the space to get the resources for."
              },
              {
                "name": "filter[from]",
                "value": "",
                "type": "query",
                "description": "The start of the timespan to check for availability."
              },
              {
                "name": "filter[to]",
                "value": "",
                "type": "query",
                "description": "The end of the timespan to check for availability."
              },
              {
                "name": "filter[ignoreBookingId]",
                "value": "",
                "type": "query",
                "description": "Id of a booking to not consider when determining availability. Useful for determining availbility before moving a booking to a different time."
              },
              {
                "name": "filter[ignoreBookingTimes]",
                "value": "",
                "type": "query",
                "description": "If set to true, returns resources as available even when the requested time is outside of the resource's booking times setting or blocked by calendar blockers. Option available only for admins of a space."
              },
              {
                "name": "filter[resourceIds]",
                "value": "",
                "type": "query",
                "description": "Limit returned resources to the given resource ids (comma separated)."
              },
              {
                "name": "include",
                "value": "",
                "type": "query",
                "description": "List of related resources to include in response.\nIncluding `categories` requires the `read_resource_categories` scope.\n`media` are the additional photos of a resource (the primary photo is\nin the `photo` attribute).\n"
              }
            ],
            "auth": {
              "type": "oauth2",
              "flow": "authorization_code",
              "authorizationUrl": "https://www.cobot.me/oauth/authorize",
              "accessTokenUrl": "https://www.cobot.me/oauth/access_token",
              "credentials": {
                "clientId": "{{clientId}}",
                "clientSecret": "{{clientSecret}}"
              }
            }
          },
          "docs": "List the bookable resources that are available to book at a given time.\nThis means there are fewer existing bookings than the resources' units.\nFor members, the resources' `booking_times`, cutoff, min/max duration and calendar blockers are also taken into account.\n\nOnly resources with `usage: bookable` are returned. Allocatable resources are not included.\n\n**Access**: The current user must be an admin or member of the space. If the\nspace is part of a network, the user must be an admin or member "
        },
        {
          "info": {
            "name": "List resource availabilities",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.cobot.me/spaces/:spaceId/resource_availabilities",
            "params": [
              {
                "name": "spaceId",
                "value": "",
                "type": "path",
                "description": "The id of the space."
              },
              {
                "name": "filter[from]",
                "value": "",
                "type": "query",
                "description": "The time from when on to return the availability."
              },
              {
                "name": "filter[to]",
                "value": "",
                "type": "query",
                "description": "The time until when to return the availability."
              },
              {
                "name": "filter[resource_ids]",
                "value": "",
                "type": "query",
                "description": "Comma-separated list of resource ids to return availabilities for."
              }
            ],
            "auth": {
              "type": "oauth2",
              "flow": "authorization_code",
              "authorizationUrl": "https://www.cobot.me/oauth/authorize",
              "accessTokenUrl": "https://www.cobot.me/oauth/access_token",
              "credentials": {
                "clientId": "{{clientId}}",
                "clientSecret": "{{clientSecret}}"
              }
            }
          },
          "docs": "List the availability of multiple resources in a space for a given time range. Considers existing bookings, each resource's booking times, cutoff, and calendar blockers.\n\n**Access**: The current user must be an admin or member of the space. If the space is part of a network, the user must be an admin or member of any space in the network.\n"
        }
      ]
    }
  ],
  "bundled": true
}