Cobot logo
API docs by Redocly

Cobot API (2.0)

Download OpenAPI specification:

Cobot Support: support@cobot.me URL: https://dev.cobot.me/ Terms of Service

This is the 2.0 version of the Cobot API. You can find version 1.0 as well as various tutorials under /api-docs.

JSON API

This API follows the JSON API standard. This means:

  • requests and responses are sent in JSON
  • all requests MUST send a Accept: application/vnd.api+json header
  • non-GET requests MUST send a Content-Type: application/vnd.api+json header
  • all responses send a Content-Type: application/vnd.api+json header
  • all JSON formats are standardized (requests, responses, errors)

Cross-Origin Resource Sharing (CORS)

All endpoints send CORS headers so that the API can be used from within browsers.

Rate Limiting

In general, the rate limit for an endpoint is 60 requests per minute per user. If applicable, alternative limits are given in the documentation for particular endpoints.

If you've exceeded the limit, Cobot will return a 429 status code and a JSON error message. The response will also contain a Retry-After header, this denotes the number of seconds to wait before your client may retry.

Times and Dates

Times and Dates must be in ISO 8601 formats. e.g. date: 2021-01-07, datetime: 2021-01-07T16:25:51Z, time: 16:25:51. Millisecond are ommited, so 16:25:51.811 will become 16:25:51. Time zone offsets must be provided by the client, e.g. 16:25:51+02:00 or '16:25:51Z' for UTC.

Times are always returned in UTC.

Sparse Fieldsets

This API supports sparse fieldsets, so clients can request which attributes they are interested in.

Example:

GET https://api.cobot.me/user?fields[users]=email

This will only return the user's email.

Query params

When passing query params, arrays of data are expected to be sent as a string of comma separated values.

Pagination

All collections are paginated. Pagination follows JSON-API standards.

Example:

{
  "meta": {
    "totalPages": 2,
    "currentPage": 1
  },
  "data": [{
    "id": "1",
    "type": "users",
  }],
  "links": {
    "self": "/users?page[size]=100&page[number]=1",
    "first": "/users?page[size]=100&page[number]=1",
    "prev": null,
    "next": "/users?page[size]=100&page[number]=2",
    "last": "/users?page[size]=100&page[number]=1"
  }
}

Default page size is 72 and can be changed by passing a page[size] parameter. Maximum page size is 200.

Errors

When a client sends invalid data in a request, Cobot returns a 422 status code and a JSON-API error response.

Example:

{
  "errors": [
    {
      "source": {
        "pointer": "/data/attributes/name"
      },
      "detail": "can't be blank"
    },
    {
      "source": {
        "pointer": "/data/attributes/password"
      },
      "detail": "is too short"
    }
  ]
}

Approval

Approving terms & conditions, privacy policies etc. as a member of a space.

Missing approvals

List the terms that have not yet been approved by the current user's membership in the given space.

Authorizations:
OAuth2
path Parameters
spaceId
required
string

The id of a space the current user is a member of.

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Create approvals

Approve terms for membership in a space.

Authorizations:
OAuth2
Request Body schema: application/vnd.api+json
required

Approval to be created for a membership in a space.

required
object

Responses

Request samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Article

A help desk article explaning an aspect of the space.

Single article

Access: The current user must be an admin or member of the space the article belongs to. If the space is part of a network, the user must be an admin or member of any space in the network.

Authorizations:
OAuth2
path Parameters
id
required
string

The id of the article.

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

List

Access: The current user must be an admin or member of the space the article belongs to. If the space is part of a network, the user must be an admin or member of any space in the network.

Authorizations:
OAuth2
path Parameters
spaceId
required
string

The id of the space the bookings belong to.

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    ]
}

Allocation

A long-term allocation of a resource to a membership or team.

Show allocation

Show a single resource allocation.

Access: The current user must be an admin of the space the allocation belongs to.

Authorizations:
OAuth2
path Parameters
id
required
string

The id of the allocation.

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

List space allocations

List resource allocations for a space that overlap the given date range (inclusive). An allocation is included if its period intersects filter[from] through filter[to] as calendar dates.

Access: The current user must be an admin of the space (or of another space in the same network). Members cannot use this endpoint.

Authorizations:
OAuth2
path Parameters
spaceId
required
string

The id of the space the allocations belong to.

query Parameters
filter[from]
required
string <date>
Example: filter[from]=2018-01-01

Start of the date range (inclusive).

filter[to]
required
string <date>
Example: filter[to]=2018-12-31

End of the date range (inclusive).

include
Array of strings
Items Value: "allocatee"

Related resources to include. allocatee is the membership or team the resource is allocated to. When used, the access token must include read_memberships and read_teams.

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    ]
}

Booking

A booking of a resource in the booking calendar.

Book as admin

Create booking as an admin. Optionally a booking can be assigned to a membership.

Access: The current user must be an admin of the space. If the space is part of a network, the user must be an admin of any space in the network.

Authorizations:
OAuth2
Request Body schema: application/vnd.api+json
required

Booking to be created

required
object

Responses

Request samples

Content type
application/vnd.api+json
Example
{
  • "data": {
    }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

List recurring

List all the recurring bookings belonging to a booking with recurrence.

The data returned by this endpoint is only eventually consistent.

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.

Authorizations:
OAuth2
path Parameters
recurringId
required
string

The id of the recurrence.

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    ],
  • "meta": {
    }
}

Delete following

Delete a recurring booking and all the following instances.

Access: The current user must be an admin of the space or the member who made the booking.

Authorizations:
OAuth2
path Parameters
bookingId
required
string

The id of the booking to delete.

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Bookings preview

Return all booking previews for given resources for a membership in the given time range.

Access: The current user must be the owner of the membership the booking belongs to or an admin of the space or network.

Authorizations:
OAuth2
Request Body schema: application/vnd.api+json
required

The time range and resource ids list.

required
object

Responses

Request samples

Content type
application/vnd.api+json
Example
{
  • "data": {
    }
}

Response samples

Content type
application/vnd.api+json
Example
{
  • "data": [
    ]
}

Delete booking

Access: The current user must either be an admin or a member of a space or the space's network. A member can only delete their own bookings and additionally only those that are not in the past.

Authorizations:
OAuth2
path Parameters
id
required
string

The id of the booking to be deleted.

Responses

Single booking

Access: The current user must be an admin or member of the space the booking belongs to. If the space is part of a network, the user must be an admin or member of any space in the network.

Authorizations:
OAuth2
path Parameters
id
required
string

The id of the booking.

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Update booking

Access: The current user must either be an admin or a member of a space or the space's network. A member can only update their own bookings and additionally only those that are not in the past.

Authorizations:
OAuth2
path Parameters
id
required
string

The id of the booking to be updated.

Request Body schema: application/vnd.api+json
required

Booking to be updated

required
object

Responses

Request samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

For membership/time

List all bookings of the membership in the given time range. If the membership's space belongs to a network, this includes bookings from all spaces in the network.

Access: The current user must be the owner of the membership or an admin in the space the membership belongs to.

Authorizations:
OAuth2
path Parameters
membershipId
required
string

The id of the membership the bookings belong to.

query Parameters
filter[from]
required
string <date-time>
Example: filter[from]=2012-04-12T10:00:00Z

Start of the time range.

filter[to]
required
string <date-time>
Example: filter[to]=2012-04-12T18:00:00Z

End of the time range.

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    ]
}

Book as member

Create booking for the membership. Access: The current user must be a member of the space. If the space is part of a network, the user must be a member of any space in the network.

Authorizations:
OAuth2
path Parameters
membershipId
required
string

The id of the membership the bookings belong to.

Request Body schema: application/vnd.api+json
required

Booking to be created

required
object

Responses

Request samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

List space bookings

List all the bookings for a space in the given time.

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.

Authorizations:
OAuth2
path Parameters
spaceId
required
string

The id of the space the bookings belong to.

query Parameters
filter[from]
required
string <date-time>
Example: filter[from]=2012-04-12T10:00:00Z

Start of the time range.

filter[to]
required
string <date-time>
Example: filter[to]=2012-04-12T18:00:00Z

End of the time range.

include
Array of strings
Items Enum: "membership" "event" "externalBooking"

List of related resources to include in response. Provide a comma separated list of relationship names. When requesting events, the access token needs the read_events scope. When requesting external bookings, the access token needs the read_external_bookings scope.

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    ]
}

Booking Credit

Booking credits are added to plans and give memberships free booking time or a fixed amount of free bookings. The hourly rate of a resource can also be customized.

For membership

List the total and remaing booking credits for a membership and each resource.

Access: The current user must be the owner of the membership or an admin in the space the membership belongs to.

Authorizations:
OAuth2
path Parameters
membershipId
required
string

The id of the membership the booking credits belong to.

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    ]
}

Built-in Email Customizations

Email customizations for emails that can be sent via Cobot.

For Space

List all email customizations for built-in emails for a space, including used placeholders.

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

Authorizations:
OAuth2
path Parameters
spaceId
required
string

The id of the space to get the email customizations for.

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    ]
}

Get built-in email customization

Get a built-in email customization via its key.

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

Authorizations:
OAuth2
path Parameters
spaceId
required
string

The id of the space to get the email customization for.

key
required
string

The key by which the email customization is requested.

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Calendar Blocker

Blocks off a space for member/external bookings and drop-in passes.

Show calendar blocker

Show a single calendar blocker.

Access: Any user can read any space's calendar blockers.

Authorizations:
OAuth2
path Parameters
id
required
string

The id of the calendar blocker.

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

List for space

List all the calendar blockers for a space in the given time.

Access: Any user can read any space's calendar blockers.

Authorizations:
OAuth2
path Parameters
spaceId
required
string

The id of the space the calendar blockers belong to.

query Parameters
filter[from]
required
string <date>
Example: filter[from]=2012-04-12

Start of the date range.

filter[to]
required
string <date>
Example: filter[to]=2012-04-12

End of the date range.

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    ]
}

Check-in

Members check in to a space for attendance tracking and for using up their time passes.

Check membership in

Checks a membership in at a space, after validating that checking in is possible (enough time passes, time restrictions). Potentially uses a time pass.

If the space is part of a network, the membership can be checked in to any space of the network.

Access: The current user must be an admin of the space the membership belongs to.

Authorizations:
OAuth2
Request Body schema: application/vnd.api+json
required

Data required to check in.

required
object

Responses

Request samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Check membership out

Checks a membership (that is currently checked in at a space) out.

If the space is part of a network, the membership can be checked out of any space of the network.

Access: The current user must be an admin of the space the membership belongs to.

Authorizations:
OAuth2
path Parameters
id
required
string

The id of the check-in to update.

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

For membership/time

List all check-ins of the membership starting in the given time range. If the membership's space belongs to a network, this includes check-ins from all spaces in the network.

Access: The current user must be the owner of the membership or an admin in the space the membership belongs to.

Authorizations:
OAuth2
path Parameters
membershipId
required
string

The id of the membership the bookings belong to.

query Parameters
filter[from]
required
string <date-time>
Example: filter[from]=2012-04-12T10:00:00Z

Start of the time range.

filter[to]
required
string <date-time>
Example: filter[to]=2012-04-12T18:00:00Z

End of the time range.

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    ]
}

Current by token

List check-ins for a membership in a space that are still current, i.e. their validUntil attribute is in the future.

The membership is determined by passing a checkInToken. If the space is part of a network, check-ins can be fetched for any space of the network.

Access: The current user must be an admin of the space the membership belongs to.

Authorizations:
OAuth2
path Parameters
spaceId
required
string

The id of the space the check-ins belong to.

query Parameters
filter[checkInToken]
required
string

A check-in token of the membership the check-ins belong to. Check-in tokens are created via the check-in token API and are typically MAC addresses or RFID tokens.

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    ]
}

Contact

Non-member contacts a space has.

Single contact

Show a single contact.

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

Authorizations:
OAuth2
path Parameters
id
required
string

The id of the contact.

Responses

Response samples

Content type
application/vnd.api+json
{}

List contacts

List contacts for a space.

Access: Only admins of the space can see the list of contacts.

Authorizations:
OAuth2
path Parameters
spaceId
required
string

The id of the space to get the contacts for.

Responses

Response samples

Content type
application/vnd.api+json
{}

Search contacts

Search contacts in a space by name, email, company, or tags.

Access: Only admins of the space can search contacts.

Authorizations:
OAuth2
path Parameters
spaceId
required
string

The id of the space to search contacts in.

query Parameters
filter[query]
required
string

The search query. Contact names, emails, companies and tags are searched.

sort
string
Example: sort=-name

Sort results. Prefix with - for descending order.

Responses

Response samples

Content type
application/vnd.api+json
{}

Cost Center

Cost centers are used to categorize invoice items. Anything that can be invoiced can be assigned a cost center. When a service/charge is added to an invoice, its cost center will be assigned to the respective invoice item.

List for space

Lists all cost centers a space has set up.

Access: Only admins of the space can see the list of cost centers.

Authorizations:
OAuth2
path Parameters
spaceId
required
string

The id of the space to get the cost centers for.

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    ]
}

Customer

A trial space can be converted to a customer

Create

Convert a trial space to a customer. The space must have valid billing details and payment method.

Authorizations:
OAuth2
Request Body schema: application/vnd.api+json
required

The space to convert.

required
object

Responses

Request samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Discount Code

A discount code can be used to offer a discount for various products in a space.

Find

Look up a discount code by its code string and discounted object id.

Returns the code details if the code exists and is valid (not expired, redemption limit not reached, and is valid for the object given via the discounted_id parameter).

Access: Any user can look up discount codes for any space.

Authorizations:
OAuth2
path Parameters
spaceId
required
string

The id of the space the discount code belongs to.

query Parameters
filter[code]
required
string

The discount code to look up.

filter[discounted_id]
required
string

The id of the discounted object (e.g. a plan id, external resource id, etc.)

Responses

Response samples

Content type
application/vnd.api+json
Example
{
  • "data": {
    }
}

Drop-In Pass

Purchased drop-in passes.

Get a single pass

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.

Authorizations:
OAuth2
path Parameters
id
required
string

The id of the pass.

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Cancel a drop-in pass

Cancel a drop-in pass. The pass must not already be canceled.

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

Authorizations:
OAuth2
path Parameters
id
required
string

The id of the drop-in pass.

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

List for space

List/filter drop-in passes for a time range.

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

Authorizations:
OAuth2
path Parameters
spaceId
required
string

The id of the space to get the drop-in passes for.

query Parameters
filter[valid_on_from]
required
string <date>
Example: filter[valid_on_from]=2012-04-12

The start of the time range.

filter[valid_on_to]
required
string <date>
Example: filter[valid_on_to]=2012-04-30

The end of the time range.

filter[sortOrder]
string
Default: "asc"
Enum: "asc" "desc"

Whether to sort drop-in passes by ascending or descending date.

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    ]
}

Drop-In Pass Purchase

A purchase of drop-in-passes, currently only supports buying one pass at a time.

Create

Create a drop-in pass purchase.

Access: Any user can create a drop-in pass purchase.

Authorizations:
OAuth2
Request Body schema: application/vnd.api+json
required

Data needed to create a drop-in pass purchase.

required
object

Responses

Request samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Drop-In Pass Template

Drop-in pass templates are templates for drop-in passes that can be bought by visitors.

Get a template

Get a single drop-in pass template. These represent the drop-in passes a space offers to visitors.

Access: Any user can access any space's drop-in pass templates.

Authorizations:
OAuth2
path Parameters
id
required
string

The id of the template.

Responses

Response samples

Content type
application/vnd.api+json
{}

Get the availability of a template

Get the dates a drop-in pass template is available for purchase. Considers time availability of the template, max daily purchases, and calendar blockers.

Access: Any user can access any space's drop-in pass templates.

Authorizations:
OAuth2
path Parameters
id
required
string

The id of the template.

query Parameters
filter[from]
required
string <date>

The date from when on to return the availability. Must not be in the past and not be more than 2 months before the to date.

filter[to]
required
string <date>

The date until when to return the availability. Must not be more than 2 months after the from date.

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Event

Spaces can run events for their members or the public. Events are created and later published by admins, at which point members are able to see and attend them. Admins can also create messages for events, which are sent to attendees based on triggers such as someone having just attended an event.

Create event

Create events as an admin. To become visible to members, events have to be published after being created. Events can be associated with resources, in which cases the resources will be booked for the duration of the event. Access: The current user must be an admin of the space.

Authorizations:
OAuth2
Request Body schema: application/vnd.api+json
required

Event to be created for a space.

required
object

Responses

Request samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Response samples

Content type
application/vnd.api+json
{}

Single event

Show a single event.

Access: The current user must either be an admin or a member of a space or the space's network unless the event is public. Including attendances or attendances.attendee requires the current user to be an admin or member of the space or the space's network.

Authorizations:
OAuth2
path Parameters
id
required
string

The id of the event.

query Parameters
include
Array of strings
Items Enum: "attendances" "attendances.attendee"

List of related resources to include in response as comma separated string.

Including attendances.attendee will also return attendances. A maximum of 5 attendances per event is returned. If the current user is attending, their attendance will be included in the 5. The full count is returned in the meta section.

Including attendances requires the read_event_attendances scope. Including attendances.attendee requires the read_event_attendances, read_memberships and read_contacts scopes.

Responses

Response samples

Content type
application/vnd.api+json
{}

Update event

Update the details of an event. Note that the publishedStatus attribute can only be changed via the publish/depublish endpoints.

Access: The current user must be an admin of the space the event belongs to.

Authorizations:
OAuth2
path Parameters
id
required
string

The id of the event.

Request Body schema: application/vnd.api+json
required

Event to be updated.

required
object

Responses

Request samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Response samples

Content type
application/vnd.api+json
{}

Delete event

Deleting an event will notify all attendees and refund their tickets if applicable. Access: The current user must be an admin of the space the event belongs to.

Authorizations:
OAuth2
path Parameters
id
required
string

The id of the event.

Responses

Attend event

Attend an event as member. Automatically creates a Charge on the membership if the event has a price.

Access: The current user must be a member of the space.

Authorizations:
OAuth2
Request Body schema: application/vnd.api+json
required

The membership that wants to attend and the event to attend.

required
object

Responses

Request samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Single event attendance

Get details of a single event attendance.

Access: The current user must be an admin of the space the event belongs to, or the event attendee, or a member of the space if the attendance visibility is 'members', or anyone if the attendance has 'public' visibility.

Authorizations:
OAuth2
path Parameters
id
required
string

The id of the event attendance to get.

query Parameters
include
Array of strings
Items Value: "attendee"

Include attendee. Requires read_memberships and read_contacts scope.

Responses

Response samples

Content type
application/vnd.api+json
{}

Unattend event

Unattend an event as member. This refunds the ticket price if applicable.

Access: The current user must be connected to the membership the attendance belongs to.

Authorizations:
OAuth2
path Parameters
id
required
string

The id of the event attendance to delete.

Responses

Response samples

Content type
application/vnd.api+json
{
  • "errors": [
    ]
}

List attendances

List all the attendances for an event. Attendances connect an event with a membership or contact and can have an optional price.

Access: The current user must be an admin or member of the space the event belongs to.

Authorizations:
OAuth2
path Parameters
id
required
string

The id of the event.

query Parameters
include
Array of strings
Items Value: "attendee"

Include attendees. Requires read_memberships scope.

Responses

Response samples

Content type
application/vnd.api+json
{}

Create message

Create a message for an event. Messages are sent by email based on triggers such as someone attending an event.

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

Authorizations:
OAuth2
Request Body schema: application/vnd.api+json
required

Message to be created for an event.

required
object

Responses

Request samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Single message

Returns a message for an event.

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

Authorizations:
OAuth2
path Parameters
id
required
string

The id of the message.

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Update message

Updates a message.

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

Authorizations:
OAuth2
path Parameters
id
required
string

The id of the message.

Request Body schema: application/vnd.api+json
required

The message content to update.

required
object

Responses

Request samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Delete message

Delete a message.

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

Authorizations:
OAuth2
path Parameters
id
required
string

The id of the message.

Responses

List messages

Returns the messages for an event.

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

Authorizations:
OAuth2
path Parameters
id
required
string

The id of the event.

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    ]
}

Publish as admin

Publish an event as an admin. To become visible to members, events have to be published. This changes the publishedState of the event from draft to published.

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

Authorizations:
OAuth2
path Parameters
id
required
string

The id of the event to publish.

Responses

Response samples

Content type
application/vnd.api+json
{}

Depublish as admin

Depublish an event as an admin. This changes the publishedState of the event from published to draft and members cannot see the event anymore.

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

Authorizations:
OAuth2
path Parameters
id
required
string

The id of the event to depublish.

Responses

Response samples

Content type
application/vnd.api+json
{}

Create an event ticket purchase

A purchase of event tickets, currently only supports buying one ticket at a time. This is for visitors / non-members attending events.

Access: Any user can create an event ticket purchase.

Authorizations:
OAuth2
Request Body schema: application/vnd.api+json
required

Data needed to create an event ticket purchase.

required
object

Responses

Request samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

List events

List/filter events for a time range. Access: Any user can see the list of events. Only admins of the space can see draft events.

Authorizations:
OAuth2
path Parameters
spaceId
required
string

The id of the space to get the events for.

query Parameters
include
Array of strings
Items Enum: "attendances" "attendances.attendee"

List of related resources to include in response as comma separated string.

Including attendances.attendee will also return attendances. A maximum of 5 attendances per event is returned. If the current user is attending, their attendance will be included in the 5. The full count is returned in the meta section.

Including attendances requires the read_event_attendances scope. Including attendances.attendee requires the read_event_attendances and read_memberships scopes.

filter[from]
required
string <date-time>
Example: filter[from]=2012-04-12T10:00:00Z

The start of the time range.

filter[to]
required
string <date-time>
Example: filter[to]=2012-04-30T23:59:59Z

The end of the time range.

filter[publishedState]
required
Array of strings
Items Enum: "draft" "published"
Example: filter[publishedState]=draft,published

Return draft/published events. Pass a comma separated list of states. Only admins can request draft events.

filter[tags]
Array of strings
Example: filter[tags]=party,free

Comma separated list of tags to filter events by. To include events with no tags pass an empty tag (alone: filter[tags]=, with other tags: filter[tags]=tag1,,tag2). When this parameter is left out, events with any or no tags are returned.

filter[resourceIds]
Array of strings
Example: filter[resourceIds]=a4a99a71ac8df98d29de357180d273d3,13b73f71ac8df98129de357180d219a6

Filter events by the resources they use (list of resource ids separated by commas). To include events with no resources pass an empty resource id (alone: filter[resourceIds]=, with other ids: filter[resourceIds]=r1,,r2). When this parameter is left out, events with any or no resources are returned.

filter[attendeeIds]
Array of strings
Example: filter[attendeeIds]=c2a99a71ac8df98d29de357180d273d2,9a673f71ac8df98129de357180d219a8

Filter events by who is attending. Pass a comma separated list of ids (for now only membership ids).

filter[sortOrder]
string
Default: "asc"
Enum: "asc" "desc"

Whether to sort events by date ascending or descending.

Responses

Response samples

Content type
application/vnd.api+json
Example
{}

List Tags

List the most popular tags used when creating events. Returns tags for events with the start or end date within specified time range (last 365 days by default). 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.

Authorizations:
OAuth2
path Parameters
spaceId
required
string

The id of the space to get the event tags for.

query Parameters
filter[from]
string <date-time>
Example: filter[from]=2012-01-01T00:00:00Z

The start of the time range. If omitted, 12 months ago.

filter[to]
string <date-time>
Example: filter[to]=2012-06-30T23:59:59Z

The end of the time range. If omitted, now.

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    ]
}

External Booking

After a resource has been enabled for external booking (see External Resource) it can be booked by visitors (non-members) using external booking endpoints. Making an external booking also results in a Booking to be created.

Create

Create an external booking.

Pass timeUnit (hour by default, or day) to use hourly or daily pricing respectively. When timeUnit is day, from and to are ISO 8601 dates.

Access: Any user can create external bookings.

Authorizations:
OAuth2
Request Body schema: application/vnd.api+json
required

Booking data needed to make the booking.

required
object

Responses

Request samples

Content type
application/vnd.api+json
Example
{
  • "data": {
    }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Single booking

Show an external booking.

Access: Any user can see external bookings.

Authorizations:
OAuth2
path Parameters
id
required
string

The id of the booking.

query Parameters
include
Array of strings
Items Value: "invoices"

List of related resources to include in response as comma separated string.

Including invoices requires the read_invoices scope.

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Cancel as admin

Cancel an external booking as an admin of a space. The external booking is marked as canceled and removed from the booking calendar (i.e. from any /bookings endpoints).

Past bookings can only be canceled while they are still pending.

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

Authorizations:
OAuth2
path Parameters
id
required
string

The id of the booking.

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Update booking

Update an external booking.

Access: The current user must be an admin of the space the booking belongs to.

Authorizations:
OAuth2
path Parameters
id
required
string

The id of the booking.

Request Body schema: application/vnd.api+json
required

Booking data to update.

required
object

Responses

Request samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Request cancellation

Request to cancel an external booking as a visitor. This will not cancel the booking but send an email with a cancellation link to the email address used to make the booking.

Access: Any user can request to cancel a booking.

Authorizations:
OAuth2
path Parameters
id
required
string

The id of the booking.

Responses

Response samples

Content type
application/vnd.api+json
{
  • "errors": [
    ]
}

Preview

Preview creating an external booking. Depending on the resource pricing, returned attributes will contain either appliedFixedRates array, or appliedDiscounts and appliedPriceCap. appliedPriceCaps is deprecated and always empty.

Optionally pass bookerType and billingAddress so the preview totals reflect EU reverse-charge tax treatment (same fields as creating a payment for an external booking).

Access: Any user can preview external bookings.

Authorizations:
OAuth2
Request Body schema: application/vnd.api+json
required

Booking data needed to generate a preview.

required
object

Responses

Request samples

Content type
application/vnd.api+json
Example
{
  • "data": {
    }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

List for space

List a space's external bookings for a given timespan. The bookings are filtered by their from attribute, not by testing for overlap.

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

Authorizations:
OAuth2
path Parameters
spaceId
required
string

The id of the space to get the bookings for.

query Parameters
filter[from]
required
string <date-time>
Example: filter[from]=2012-04-12T10:00:00Z

The start of the time range to return external bookings for.

filter[to]
required
string <date-time>
Example: filter[to]=2012-04-14T20:00:00Z

The end of the time range to return external bookings for.

filter[sortOrder]
string
Default: "asc"
Enum: "asc" "desc"

Whether to sort external bookings by date ascending or descending date.

include
Array of strings
Items Value: "invoices"

List of related resources to include in response. Provide a comma separated list of relationship names. invoices requires the read_invoices scope.

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    ]
}

External Resource

A space's resources can be enabled for external booking, which means they can be booked by guests without a Cobot account or space membership. All resources enabled for external booking appear under external resources.

Create

Create an external resource for a resource. Attributes set on the external resource override the attributes of the related resource. Attributes left null on the external resource will fall back to the related resource.

Access: The current user must be an admin of the space the resource belongs to.

Authorizations:
OAuth2
Request Body schema: application/vnd.api+json
required

External resource data needed to create the external resource. At the very least a relationship to a resource is required.

required
object

Responses

Request samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Single resource

Show a single resource enabled for external booking.

Access: Any user can access any space's external resources.

Authorizations:
OAuth2
path Parameters
id
required
string

The id of the resource.

query Parameters
fields[externalResources]
string

Sparse fieldset for external resources. Include media to return the media relationship (the primary photo stays in the photo attribute). List every external resource field the response should contain.

include
Array of strings
Items Value: "media"

List of related resources to sideload in the included array. media sideloads additional photos into included. Also pass fields[externalResources] including media so the relationship is present.

Responses

Response samples

Content type
application/vnd.api+json
Example
{
  • "data": {
    }
}

Update resource

Update a resource enabled for external booking.

Access: The current user must be an admin of the space the resource belongs to.

Authorizations:
OAuth2
path Parameters
id
required
string

The id of the external resource.

Request Body schema: application/vnd.api+json
required

The external resource attributes to update.

required
object

Responses

Request samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Delete

Delete an external resource. The original resource the external resource is connected to is not deleted.

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

Authorizations:
OAuth2
path Parameters
id
required
string

The id of the resource.

Responses

Response samples

Content type
application/vnd.api+json
{
  • "errors": [
    ]
}

Availability

See the times an external resource is still available to book. Considers existing bookings, the resource's booking times and calendar blockers.

Use filter[timeUnit] to check availability for hourly or daily bookings. Hour mode (default) requires an hour rate on the resource. Day mode requires a day rate. If the resource is not bookable for the requested time unit, availableTimes is an empty array.

Access: Any user can access any space's external resources.

Authorizations:
OAuth2
path Parameters
id
required
string

The id of the external resource.

query Parameters
filter[timeUnit]
string
Default: "hour"
Enum: "hour" "day"

Whether to check availability for hourly or daily booking. Defaults to hour. When day, filter[from] and filter[to] must be dates (yyyy-mm-dd), not date-times. The same date for from and to means a single full day.

filter[from]
required
string

The start of the timespan to return availability for. ISO 8601 date-time when filter[timeUnit] is hour (default). ISO 8601 date (yyyy-mm-dd) when filter[timeUnit] is day (interpreted as the beginning of that day in the space's time zone).

filter[to]
required
string

The end of the timespan to return availability for. ISO 8601 date-time when filter[timeUnit] is hour (default). ISO 8601 date (yyyy-mm-dd) when filter[timeUnit] is day (interpreted as the end of that day in the space's time zone). For day mode, from and to may be the same date (one full day).

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

List for space

List the resources enabled for external booking for a space.

These resources can be booked and paid for by non-members of a space.

Access: Any user can access any space's external resources.

Authorizations:
OAuth2
path Parameters
spaceId
required
string

The id of the space to get the resources for.

query Parameters
fields[externalResources]
string

Sparse fieldset for external resources. Include media to return the media relationship (the primary photo stays in the photo attribute). List every external resource field the response should contain.

include
Array of strings
Items Value: "media"

List of related resources to sideload in the included array. media sideloads additional photos into included. Also pass fields[externalResources] including media so the relationship is present.

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    ]
}

Available resources

List the external resources that are available to book at a given time. This means there are fewer existing bookings than the resources' units. booking_times, min/max duration and calendar blockers are also taken into account.

Use filter[timeUnit] to list resources for hourly or daily bookings. Hour mode (default) returns resources with an hour rate. Day mode returns only resources that have a day rate.

Access: Any user can access any space's external resources.

Authorizations:
OAuth2
path Parameters
spaceId
required
string

The id of the space to get the resources for.

query Parameters
filter[timeUnit]
string
Default: "hour"
Enum: "hour" "day"

Whether to check availability for hourly or daily booking. Defaults to hour. When day, filter[from] and filter[to] must be dates (yyyy-mm-dd), not date-times. The same date for from and to means a single full day.

filter[from]
required
string

The start of the timespan to check for availability. ISO 8601 date-time when filter[timeUnit] is hour (default). ISO 8601 date (yyyy-mm-dd) when filter[timeUnit] is day (interpreted as the beginning of that day in the space's time zone).

filter[to]
required
string

The end of the timespan to check for availability. ISO 8601 date-time when filter[timeUnit] is hour (default). ISO 8601 date (yyyy-mm-dd) when filter[timeUnit] is day (interpreted as the end of that day in the space's time zone). For day mode, from and to may be the same date (one full day).

filter[ignoreBookingTimes]
boolean

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.

filter[ignoreExternalBookingId]
string

Id of an external booking to not consider when determining availability. Useful for determining availbility before moving an external booking to a different time.

filter[minimumCapacity]
integer

If set, returns only resources where capacity is greater than or equal to requested value.

fields[externalResources]
string

Sparse fieldset for external resources. Include media to return the media relationship (the primary photo stays in the photo attribute). List every external resource field the response should contain.

include
Array of strings
Items Value: "media"

List of related resources to sideload in the included array. media sideloads additional photos into included. Also pass fields[externalResources] including media so the relationship is present.

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    ]
}

Invoice

Invoices are automatically generated once a month, based on members' activity. In addition, manual invoices can be generated at any time.

Charge invoices

Bulk-charge invoices. The invoices will be charged in the background.

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

Authorizations:
OAuth2
Request Body schema: application/vnd.api+json
required

Invoices to be charged.

required
object

Responses

Request samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Create custom

Create a custom invoice in a space.

Pass a membership relationship to assign the invoice to a membership. Pass a correctedInvoice relationship and optional writeOffCorrectedInvoice flag to create a correction invoice.

Access: The current user must be an admin of the space where the invoice is created.

Authorizations:
OAuth2
Request Body schema: application/vnd.api+json
required

Data required to create an invoice.

required
object

Responses

Request samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Single invoice

Show a single invoice.

Access: The current user must be an admin of the space where the invoice was created, and admin of any space in the network, or the user of the membership the invoice belongs to.

Authorizations:
OAuth2
path Parameters
id
required
string

The id of the invoice.

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Single invoice PDF

Show a single invoice PDF.

Access: The current user must be an admin of the space where the invoice was created, and admin of any space in the network, or the user of the membership the invoice belongs to.

Alternatively, a token parameter can be provided to acces the PDF.

Authorizations:
OAuth2
path Parameters
id
required
string

The id of the invoice.

query Parameters
token
string

Optional token to access the PDF without API authentication.

e_invoice
boolean

If set to true, returns the PDF without any payment related information.

Responses

Lock invoice

Locks an invoice so it can not be edited anymore.

Access: The current user must be an admin of the space where the invoice was created.

Authorizations:
OAuth2
path Parameters
id
required
string

The id of the invoice.

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Remove invoice lock

Removes the invoice lock so the invoice can be edited again (for example after external e-invoice generation failed). This is not allowed if the invoice already has a final PDF or e-invoicing data attached; in that case the request fails with HTTP 409.

Access: The current user must be an admin of the space where the invoice was created.

Authorizations:
OAuth2
path Parameters
id
required
string

The id of the invoice.

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Create an e-invoice for invoice

Create an e-invoice for the passed invoice and attach it to the PDF. This will lock the invoice, preventing it from being changed manually afterwards. If generation fails before a PDF is attached, call DELETE /invoices/{id}/lock so the invoice can be edited again. After an e-invoice or final PDF is attached, DELETE /invoices/{id}/lock returns HTTP 409 and does not unlock.

Supports e-invoicing in Germany (ZUGFeRD) and Poland (KSeF).

For Polish KSeF e-invoices, pass e_invoice_standard: "KSeF" along with ksef_reference_number and ksef_acceptance_timestamp in the request body. These will be stored on the invoice and the reference number will be displayed on the PDF.

Access: The current user must be an admin of the space where the invoice was created.

Authorizations:
OAuth2
path Parameters
id
required
string

The id of the invoice.

Request Body schema: application/vnd.api+json
optional

Optional e-invoicing metadata (required for Polish KSeF).

object

Responses

Request samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Attach PDF to invoice

Attaches a PDF to an invoice. This can be used to create an e-invoice externally to replace the regular invoice pdf.

The invoice has to be locked. An invoice that has been requested to be sent will be sent after the PDF is attached.

Access: The current user must be an admin of the space where the invoice was created.

Authorizations:
OAuth2
path Parameters
invoice_id
required
string

The id of the invoice.

Request Body schema: multipart/form-data
required

The file to attach.

eInvoice
boolean

Set to true if the PDF fulfills the e-invoicing criteria for the space.

eInvoiceStandard
string

The e-invoicing standard of the uploaded PDF, e.g. 'Zugferd' in Germany.

pdf
required
file

Responses

Request samples

Content type
multipart/form-data
{
  "eInvoice": true,
  "eInvoiceStandard": "Zugferd",
  "pdf": "new_invoice.pdf"
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Payment methods

Lists the payment methods used to pay an invoice.

Access: The current user must be an admin of the space where the invoice was created.

Authorizations:
OAuth2
path Parameters
id
required
string

The id of the invoice.

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    ]
}

Previews

List the previews of the invoices that will be generated in a space for a timespan.

Access: The current user must be an admin of the space where the invoice is created.

Authorizations:
OAuth2
path Parameters
spaceId
required
string

The id of the space the invoices belong to.

query Parameters
filter[from]
required
string <date>

The start of the timespan to list previews for. Must be today or in the future.

filter[to]
required
string <date>

The end of the timespan to list previews for.

filter[dateFilterField]
string
Enum: "dueDate" "invoiceDate"

What field to use for filtering the invoice previews by date.

  • When using invoiceDate (default), previews are filtered based on the date the invoice would be generated (this respects when invoices are generated before their due date).
  • When using dueDate, previews are filtered based on the due date of the future invoice (disregarding that invoices might be generated before their due date).

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    ]
}

List

List the invoices issued by a space:

  • all invoices in a given time (pass filter[to/from])
  • for a single membership or team (pass filter[debitorId])
  • all invoices with a specific paid status (pass filter[paidStatus])

Access: The current user must be an admin of the space where the invoice was created. If the space is part of a network, the user must be an admin of any space in the network.

Authorizations:
OAuth2
path Parameters
spaceId
required
string

The id of the space the invoices belong to.

query Parameters
filter[debitorId]
string

To list invoices that belong to a single debitor (membership or team), pass the id of that membership or team.

filter[membershipId]
string

Same as filter[debitorId], left for backward compatibility. Will be deprecated.

filter[from]
string <date>

List invoices for all debitors whose invoice date is within the given timespan.

filter[to]
string <date>

List invoices for all debitors whose invoice date is within the given timespan.

filter[dateFilterField]
string
Enum: "dueDate" "invoiceDate" "remindAt"

What field to use for filtering the invoices by date.

  • When using invoiceDate (default), invoices are filtered based on the date the invoice was generated (this respects when invoices are generated before their due date).
  • When using dueDate, invoices are filtered based on their due date (disregarding that invoices might be generated before their due date).
  • When using remindAt, invoices are filtered based on the date the invoice's reminder is due. Only unpaid invoices are included.
filter[paidStatus]
Array of strings
Items Enum: "unpaid" "paid" "writtenOff" "pending"

Filter the invoices by their paid status. Can not be combined with any of the other filters.

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    ]
}

Search

Text query searches through invoice number, invoice items and recipient name or company. Returns paginated list of invoices and number of pages in total.

Access: The current user must be an admin of the space. If the space is part of a network, the user must be an admin of any space in the network.

Authorizations:
OAuth2
path Parameters
spaceId
required
string

The id of the space the invoices belong to.

query Parameters
filter[query]
required
string

The text query to search for.

filter[paidStatus]
Array of strings
Items Enum: "paid" "unpaid" "pending" "writtenOff" "late"

Provide a comma separated list. Default: all. paidStatus=late returns unpaid invoices with remind_at date in the past.

filter[sentStatus]
Array of strings
Items Enum: "sent" "unsent"

Provide a comma separated list. Default: all.

filter[sortBy]
string
Enum: "invoiceDate" "number" "paidStatus" "sentStatus" "company" "name" "totalAmount"

One from the list, default: invoiceDate.

filter[sortOrder]
string
Enum: "asc" "desc"

Default: desc.

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    ]
}

Invoice Reminder

Admins can send invoice reminders for overdue invoices.

Create invoice reminder

Sends an invoice reminder for an overdue invoice.

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

Authorizations:
OAuth2
Request Body schema: application/vnd.api+json
required

Invoice reminder to be sent.

required
object

Responses

Request samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Issue

A help desk issue reported by a member or admin.

Create issue

Create a help desk issue in a space.

Access: The current user must be an admin or a member of the space.

Members cannot pass an issuer. The issue is created with their membership.

Admins may pass a membership as issuer. If they omit it, the issue is created as the admin (issuer is null), even if they are also a member.

Authorizations:
OAuth2
Request Body schema: application/vnd.api+json
required

Issue to create.

required
object

Responses

Request samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Membership

Represents a person being a member in a space. Can optionally be connected to a User.

Single Membership

Get a single membership.

Access: The current user must be an admin of the space the membership belongs to or the owner of the membership.

Authorizations:
OAuth2
path Parameters
id
required
string

Id of the membership.

Responses

Response samples

Content type
application/vnd.api+json
{}

For network

Get a list of memberships for a network.

Access: The current user must be an admin of the space or any space in the network.

Authorizations:
OAuth2
path Parameters
networkId
required
string

Id of the network.

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    ]
}

Search network

Search the list of memberships in the network.

Access: The current user must be an admin of the space or any space in the network.

Authorizations:
OAuth2
path Parameters
networkId
required
string

Id of the network.

query Parameters
filter[query]
required
string

The search query. Membership names, company and emails are searched.

sort
string
Example: sort=-name

Sort results. Prefix with - for descending order.

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    ]
}

For space

Get a list of memberships for a space.

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

Authorizations:
OAuth2
path Parameters
spaceId
required
string

Id of the space.

query Parameters
filter[from]
required
string <date>
Example: filter[from]=2020-04-20

Only return memberships that have not been canceled or been canceled on or after the given date.

filter[to]
required
string <date>
Example: filter[to]=2020-04-20

Only return memberships that have been confirmed before or on the given date.

Responses

Response samples

Content type
application/vnd.api+json
{}

Search

Search memberships in a space. Membership names, company and emails are searched. Returns a paginated list of current (confirmed, not canceled) memberships.

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

Authorizations:
OAuth2
path Parameters
spaceId
required
string

The id of the space the memberships belong to.

query Parameters
filter[query]
required
string

The text query to search for.

Responses

Response samples

Content type
application/vnd.api+json
{}

Membership Plan

The plans belonging to a membership. When a membership is signed up one of the space's plans is selected and a copy is created for the membership. A membership's plan can be customized or changed over time, creating a new membership plan object every time.

For space

Get the plan history for the given time and for each membership that was active during the given time.

Data is returned as a flat list of membership plans. Each plan has a relationship pointing to the membership it belongs to and startsAt/canceledAt attributes to determine the time it was active.

Access: The current user must be an admin of the space or any space in the network.

Authorizations:
OAuth2
path Parameters
spaceId
required
string

Id of the space.

query Parameters
filter[from]
required
string <date>
Example: filter[from]=2020-04-20

Only return membership plans that have been active from the given date on.

filter[to]
required
string <date>
Example: filter[to]=2020-04-20

Only return membership plans that have been active until the given date.

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    ]
}

Membership Profile

Social profile for a membership.

Single profile

Get a single membership profile by its id.

Access: The current user must be an admin or member of the space the membership profile belongs to. If the space is part of a network, the user must be an admin or member of any space in the network.

Authorizations:
OAuth2
path Parameters
id
required
string

Id of the membership profile.

Responses

Response samples

Content type
application/vnd.api+json
{}

Update profile

Lets members update their profile.

Access: The current user must be the owner of the membership that the profile belongs to.

Authorizations:
OAuth2
path Parameters
id
required
string

Id of the membership profile.

Request Body schema: application/vnd.api+json
required

The attributes to be updated.

required
object

Responses

Request samples

Content type
application/vnd.api+json
{}

Response samples

Content type
application/vnd.api+json
{}

For network

Get a list of membership profiles for a network.

Access: The current user must be an admin of the space or any space in the network.

Authorizations:
OAuth2
path Parameters
networkId
required
string

Id of the network.

Responses

Response samples

Content type
application/vnd.api+json
{}

Search network

Search the list of membership profiles for a network.

Access: The current user must be an admin of the space or any space in the network.

Authorizations:
OAuth2
path Parameters
networkId
required
string

Id of the network.

query Parameters
filter[query]
required
string

The search query. All profile fields are searched.

Responses

Response samples

Content type
application/vnd.api+json
{}

For space

Get a list of membership profiles for a space.

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

Authorizations:
OAuth2
path Parameters
spaceId
required
string

Id of the space.

query Parameters
filter[membershipIds]
Array of strings
Example: filter[membershipIds]=c2a99a71ac8df98d29de357180d273d2,9a673f71ac8df98129de357180d219a8

Only return profiles for the given memberships ids.

Responses

Response samples

Content type
application/vnd.api+json
{}

Published for space

Get a list of published membership profiles for a space.

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

Authorizations:
OAuth2
path Parameters
spaceId
required
string

Id of the space.

query Parameters
filter[membershipIds]
Array of strings
Example: filter[membershipIds]=c2a99a71ac8df98d29de357180d273d2,9a673f71ac8df98129de357180d219a8

Only return profiles for the given memberships ids.

Responses

Response samples

Content type
application/vnd.api+json
{}

Network

Multiple spaces can form a network. This allows their members to access multiple spaces, for example to book resources.

Get single network

Get a network by its id. Spaces that are in a network expose a link to it. Access: The current user must be an admin or member of any space in the network.

Authorizations:
OAuth2
path Parameters
id
required
string

The id of the network.

query Parameters
include
Array of strings
Items Value: "memberSpaces"

List of related resources to include in response. Provide a comma separated list of relationship names. Including memberSpaces requires the read_spaces scope.

Responses

Response samples

Content type
application/vnd.api+json
Example
{}

List network resource availabilities

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.

Only 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.

Access: The current user must be an admin or member of any space in the network.

Authorizations:
OAuth2
path Parameters
networkId
required
string

The id of the network.

query Parameters
filter[from]
required
string <date-time>

The time from when on to return the availability.

filter[to]
required
string <date-time>

The time until when to return the availability.

filter[resourceIds]
Array of strings

Comma-separated list of resource ids to return availabilities for. Only resources belonging to spaces in this network will be included.

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    ]
}

Payment

The payment API is in development. Endpoints may be missing or not working yet.

Payments allow any user (i.e. non-members) to pay for items on Cobot via the payment methods a space has set up. For now this only covers external bookings, but more could be added in the future.

Initiate payment

Initiates a new payment for a purchase, but does not complete it. Supported purchases are:

  • external bookings - initiate a payment for an external booking (needs to happen before making the booking)
    • discount codes can be applied only to external bookings for now
    • pass timeUnit (hour by default, or day) to use hourly or daily pricing respectively. When timeUnit is day, from and to are ISO 8601 dates.
  • drop-in passes - initiate a payment for a drop-in pass (needs to happen before buying the pass)
  • event attendances - initiate a payment for an event attendance (needs to happen before before creating the event attendance)

After creating a payment, payment details such as credit card numbers need to be added via the user's browser. This can happen via JavaScript calls or a browser redirect.

Supported payment providers:

Stripe

Stripe uses payment intents and Stripe.js to process payments. Calling this endpoint will return a payment intent client secret which you need in order to collect payment data and complete the payment in the browser. See https://stripe.com/docs/payments/accept-a-payment?ui=elements.

PayPal

Calling this endpoint will return an orderId which you need in order to collect payment data and complete the payment in the browser.

Note: currently in development, created orders can be paid but are not yet linked, automatically.

Access: Any user can initiate payments.

Authorizations:
OAuth2
Request Body schema: application/vnd.api+json
required

Data needed to initiate a payment. Varies with each payment provider.

required
object

Responses

Request samples

Content type
application/vnd.api+json
Example
{
  • "data": {
    }
}

Response samples

Content type
application/vnd.api+json
Example
{
  • "data": {
    }
}

Payment Method

Spaces can set up payment methods that members can use to make payments to the space. Payment methods can be automated via a payment provider such as Stripe or manual (e.g. cash, bank transfer).

List externals

List the payment methods of a space that can be used to pay for an external booking. Payment methods can have a payment provider. In this case, custom attributes needed for payment processing are returned via the providerAttributes.

Access: Any user can list a space's payment methods.

Authorizations:
OAuth2
path Parameters
spaceId
required
string

The id of the space to get the payment methods for.

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    ]
}

List

List the payment methods of a space. Payment methods can have a payment provider. In this case, custom attributes needed for payment processing are returned via the providerAttributes.

Access: Any user can list a space's payment methods.

Authorizations:
OAuth2
path Parameters
spaceId
required
string

The id of the space to get the payment methods for.

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    ]
}

Product

Products can be set up by a space and then used as booking extras or to create charges from. Examples are coffee, projectors, additional cleaning services etc.

Single product

A single product.

Access: Any user can view products.

Authorizations:
OAuth2
path Parameters
id
required
string

The id of the product.

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

List for space

List the products for a space. The products are returned in the order set up by admins, so should not be sorted again by the client.

Access: Any user can view products.

Authorizations:
OAuth2
path Parameters
spaceId
required
string

The id of the space to get the products for.

query Parameters
filter[scope]
Array of strings
Items Enum: "externalBookings" "bookings"

Only return products enabled for the given scopes. Returns products matching any of the provided scopes. Returns all products if no scope is provided.

include
string
Value: "category"

Include product categories. The categories are returned in the order set up by admins, so should not be sorted again by the client.

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    ]
}

Refund

A full or partial refund of an invoice.

Create refund

Create a new refund for an invoice.

Access: The current user must be an admin of the space the invoice was created in.

Authorizations:
OAuth2
Request Body schema: application/vnd.api+json
required

Data to create a refund.

required
object

Responses

Request samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Resource

A resource can be booked on an hourly basis using the booking calendar. Examples are conference rooms, presentation equipment, bikes etc.

List network resource availabilities

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.

Only 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.

Access: The current user must be an admin or member of any space in the network.

Authorizations:
OAuth2
path Parameters
networkId
required
string

The id of the network.

query Parameters
filter[from]
required
string <date-time>

The time from when on to return the availability.

filter[to]
required
string <date-time>

The time until when to return the availability.

filter[resourceIds]
Array of strings

Comma-separated list of resource ids to return availabilities for. Only resources belonging to spaces in this network will be included.

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    ]
}

List for network

Get a list of resources for all spaces in a network.

Access: The current user must be an admin or member of any space in the network.

Authorizations:
OAuth2
path Parameters
networkId
required
string

Id of the network.

query Parameters
filter[usage]
string
Default: "bookable"
Enum: "bookable" "allocatable" "all"

Filter resources by their usage. Defaults to bookable for backward compatibility.

filter[spaceIds]
string
Example: filter[spaceIds]=space1,space2,space3

Comma-separated list of space IDs to filter resources by. If omitted, returns resources for all spaces in the network.

fields[resources]
string

Sparse fieldset for resources. Include media to return the media relationship (the primary photo stays in the photo attribute). List every resource field the response should contain.

include
Array of strings
Items Value: "media"

List of related resources to sideload in the included array. media sideloads additional photos into included. Also pass fields[resources] including media so the relationship is present.

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    ]
}

Available resources for network

List the bookable resources that are available to book at a given time across all spaces in a network. This means there are fewer existing bookings than the resources' units. For members, the resources' booking_times, cutoff, min/max duration and calendar blockers are also taken into account.

Only resources with usage: bookable are returned. Allocatable resources are not included.

Access: The current user must be an admin or member of any space in the network.

Authorizations:
OAuth2
path Parameters
networkId
required
string

Id of the network.

query Parameters
filter[from]
required
string <date-time>

The start of the timespan to check for availability.

filter[to]
required
string <date-time>

The end of the timespan to check for availability.

filter[spaceIds]
string
Example: filter[spaceIds]=space1,space2,space3

Comma-separated list of space IDs to filter resources by. If omitted, returns resources for all spaces in the network.

filter[ignoreBookingId]
string

Id of a booking to not consider when determining availability. Useful for determining availbility before moving a booking to a different time.

filter[ignoreBookingTimes]
string
Enum: true false

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.

filter[resourceIds]
Array of strings

Limit returned resources to the given resource ids (comma separated).

fields[resources]
string

Sparse fieldset for resources. Include media to return the media relationship (the primary photo stays in the photo attribute). List every resource field the response should contain.

include
Array of strings
Items Value: "media"

List of related resources to sideload in the included array. media sideloads additional photos into included. Also pass fields[resources] including media so the relationship is present.

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    ]
}

Create resource

Create a new resource in a space.

Access: The current user must be an admin of the space the resource if created in.

Authorizations:
OAuth2
Request Body schema: application/vnd.api+json
required

Data to create a resource.

required
object

Responses

Request samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Get resource

See details of the resource.

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.

Authorizations:
OAuth2
path Parameters
id
required
string

The id of the resource.

query Parameters
fields[resources]
string

Sparse fieldset for resources. Include media to return the media relationship (the primary photo stays in the photo attribute). List every resource field the response should contain.

include
Array of strings
Items Value: "media"

List of related resources to sideload in the included array. media sideloads additional photos into included. Also pass fields[resources] including media so the relationship is present.

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Update resource

Update the details of a resource.

Access: The current user must be an admin of the space the resource belongs to.

Authorizations:
OAuth2
path Parameters
id
required
string

The id of the resource.

Request Body schema: application/vnd.api+json
required

The resource attributes to update.

required
object

Responses

Request samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Availability

See the times a resource is still available to book. Considers existing bookings, the resource's booking times, cutoff and calendar blockers.

Only resources with usage: bookable are supported. Returns an error for allocatable resources.

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.

Authorizations:
OAuth2
path Parameters
id
required
string

The id of the resource.

query Parameters
filter[from]
required
string <date-time>

The time from when on to return the availability.

filter[to]
required
string <date-time>

The time until when to return the availability.

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

List for space

List the resources (and their categories) for a space.

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.

Authorizations:
OAuth2
path Parameters
spaceId
required
string

The id of the space to get the resources for.

query Parameters
filter[usage]
string
Default: "bookable"
Enum: "bookable" "allocatable" "all"

Filter resources by their usage. Defaults to bookable for backward compatibility.

fields[resources]
string

Sparse fieldset for resources. Include media to return the media relationship (the primary photo stays in the photo attribute). List every resource field the response should contain.

include
Array of strings
Items Enum: "categories" "media"

List of related resources to sideload in the included array. Including categories requires the read_resource_categories scope. media sideloads additional photos into included. Also pass fields[resources] including media so the relationship is present.

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    ],
  • "included": [
    ]
}

Available resources

List the bookable resources that are available to book at a given time. This means there are fewer existing bookings than the resources' units. For members, the resources' booking_times, cutoff, min/max duration and calendar blockers are also taken into account.

Only resources with usage: bookable are returned. Allocatable resources are not included.

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.

Authorizations:
OAuth2
path Parameters
spaceId
required
string

The id of the space to get the resources for.

query Parameters
filter[from]
required
string <date-time>

The start of the timespan to check for availability.

filter[to]
required
string <date-time>

The end of the timespan to check for availability.

filter[ignoreBookingId]
string

Id of a booking to not consider when determining availability. Useful for determining availbility before moving a booking to a different time.

filter[ignoreBookingTimes]
string
Enum: true false

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.

filter[resourceIds]
Array of strings

Limit returned resources to the given resource ids (comma separated).

fields[resources]
string

Sparse fieldset for resources. Include media to return the media relationship (the primary photo stays in the photo attribute). List every resource field the response should contain.

include
Array of strings
Items Enum: "categories" "media"

List of related resources to sideload in the included array. Including categories requires the read_resource_categories scope. media sideloads additional photos into included. Also pass fields[resources] including media so the relationship is present.

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    ]
}

List resource availabilities

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.

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.

Authorizations:
OAuth2
path Parameters
spaceId
required
string

The id of the space.

query Parameters
filter[from]
required
string <date-time>

The time from when on to return the availability.

filter[to]
required
string <date-time>

The time until when to return the availability.

filter[resource_ids]
required
Array of strings

Comma-separated list of resource ids to return availabilities for.

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    ]
}

Revenue Account

Revenue accounts are used to categorize invoice items. Anything that can be invoiced can be assigned a revenue account. When a service/charge is added to an invoice, its revenue account will be assigned to the respective invoice item.

List for space

Lists all revenue accounts a space has set up.

Access: Only admins of the space can see the list of revenue accounts.

Authorizations:
OAuth2
path Parameters
spaceId
required
string

The id of the space to get the revenue accounts for.

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    ]
}

Single page app

A single page app consists of HTML, CSS and JavaScript code. It can be embedded into the Cobot UI via navigation links.

List

List single page apps. All apps that were created by the current OAuth client (determined via the access token) are returned.

Authorizations:
OAuth2

Responses

Response samples

Content type
application/vnd.api+json
{}

Create

Create single page app. To embed the app into the Cobot API, you need to create a navigation link for a space that references the single page app.

Authorizations:
OAuth2
Request Body schema: application/vnd.api+json
required

App data, i.e. URLs of the JS and CSS files.

required
object

Responses

Request samples

Content type
application/vnd.api+json
{}

Response samples

Content type
application/vnd.api+json
{}

Update

Update a single page app's JavaScript and CSS.

Authorizations:
OAuth2
path Parameters
id
required
string

The id of the single page app.

Request Body schema: application/vnd.api+json
required

App data, i.e. URLs of the JS and CSS files.

required
object

Responses

Request samples

Content type
application/vnd.api+json
{}

Response samples

Content type
application/vnd.api+json
{}

Single app

Fetch a single page app.

Authorizations:
OAuth2
path Parameters
id
required
string

The id of the single page app.

Responses

Response samples

Content type
application/vnd.api+json
{}

Space

A coworking space. Spaces can form a network to allow members access to multiple spaces.

Get a space

Access: Any user can access any space. Members and admins of the space see more details.

Authorizations:
OAuth2
path Parameters
spaceId
required
string

The id of the space.

Responses

Response samples

Content type
application/vnd.api+json
{}

Space Billing Details

Billing details of a space.

Show

Returns a space's billing details.

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

Authorizations:
OAuth2
path Parameters
spaceId
required
string

The id of the space.

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Update

Update a space's billing details.

Access: Only admins of a space can update the billing details.

Authorizations:
OAuth2
path Parameters
spaceId
required
string

The id of the space to update the billing details for.

Request Body schema: application/vnd.api+json
required

Data needed to update the billing details.

required
object

Responses

Request samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Space Payment Method

The payment method a space uses to pay their Cobot subscription.

Space payment method

Get a space's payment method.

Access: Only admins of a space can get its payment method.

Authorizations:
OAuth2
path Parameters
spaceId
required
string

The id of the space to get the payment method for.

Responses

Response samples

Content type
application/vnd.api+json
Example
{
  • "data": {
    }
}

Space payment method

Update a space's payment method. Currently only Stripe is supported.

Access: Only admins of a space can update its payment method.

Authorizations:
OAuth2
path Parameters
spaceId
required
string

The id of the space to update the payment method for.

Request Body schema: application/vnd.api+json
required

Data needed to update a space's payment method.

required
object

Responses

Request samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Space Preview

Preview of a to-be-created space.

Preview

Preview creating a space. For now only returns an available subdomain for a given space name.

Access: Any user can preview spaces.

Authorizations:
OAuth2
Request Body schema: application/vnd.api+json
required

Data needed to create a preview.

required
object

Responses

Request samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Space Profile

Public profile information such as location, phone, website, social media links.

Get a space profile

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.

Authorizations:
OAuth2
path Parameters
id
required
string

The id of the space profile.

Responses

Response samples

Content type
application/vnd.api+json
Example
{}

Subscription

How much a space pays Cobot, how many members they can have and the extras they have booked.

Preview

Preview a space's subscription for the specified number of members and extras. Send a request without extras to get the available extra/tier ids.

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

Authorizations:
OAuth2
path Parameters
spaceId
required
string

The id of the space.

Request Body schema: application/vnd.api+json
required

Parameters of the subscription to preview.

required
object

Responses

Request samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Current

Returns a space's current subscription, including member limit and any extras (subscribed and unsubscribed).

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

Authorizations:
OAuth2
path Parameters
spaceId
required
string

The id of the space.

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Change

Update or change a space's subscription.

To update the extras but not change the subscription, pass the id of a space's current subscription as the chosenSubscription relationship.

To change the subscriptipn to one returned by the list subscriptions endpoint, pass the id of one of these subscriptions.

If the space had a previous subscription, custom extras (type subscriptionExtras) are kept automatically and cannot be modified.

Other extras are dropped and extras whose id is passed in the request payload are added. The id needs to be taken from the extras of the chosenSubscription.

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

Authorizations:
OAuth2
path Parameters
spaceId
required
string

The id of the space.

Request Body schema: application/vnd.api+json
required

New subscription data.

required
object

Responses

Request samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

List

Returns all subscriptions available to spaces, including member limit, whether they are available and any extras.

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

Authorizations:
OAuth2
path Parameters
spaceId
required
string

The id of the space.

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    ]
}

Url

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.

List for space

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.

Authorizations:
OAuth2
path Parameters
spaceId
required
string

The id of the space.

Responses

Response samples

Content type
application/vnd.api+json
{}

User

A user is used to log in to Cobot via email/password. Users can be admins/members (see Membership) in multiple spaces.

Get current user

The adminOf/membershipOf relationships return the spaces that the user is an admin or member of.

The memberships relationship returns the actual membership data.

Authorizations:
OAuth2
query Parameters
include
Array of strings
Items Enum: "memberOf" "adminOf" "memberships"

List of related resources to include in response. Provide a comma separated list of relationship names. memberOf and adminOf require the read_spaces scope. memberships requires the read_memberships scope.

Responses

Response samples

Content type
application/vnd.api+json
Example
{
  • "data": {
    }
}

User Email Preview

Confirms if a given email address is free to take.

User Email Preview

Preview creating a user email. Returns 409 status if email is taken or 204 status if email address is free.

Authorizations:
OAuth2
Request Body schema: application/vnd.api+json
required

Data needed to create a preview.

required
object

Responses

Request samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Response samples

Content type
application/vnd.api+json
{
  • "errors": [
    ]
}

Charge

Create Charge

Creates a charge for a membership or team in a space.

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

Authorizations:
OAuth2
Request Body schema: application/vnd.api+json
required

Data required to create a charge.

required
object

Responses

Request samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Team

For space

Get a list of teams for a space.

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

Authorizations:
OAuth2
path Parameters
spaceId
required
string

Id of the space.

query Parameters
filter[from]
required
string <date>
Example: filter[from]=2020-04-20

Only return teams that have not been canceled or been canceled on or after the given date.

filter[to]
required
string <date>
Example: filter[to]=2020-04-20

Only return teams that have been confirmed before or on the given date.

Responses

Response samples

Content type
application/vnd.api+json
{}

Single Team

Get a single team.

Access: The current user must be an admin of the space the team belongs to.

Authorizations:
OAuth2
path Parameters
id
required
string

Id of the team.

Responses

Response samples

Content type
application/vnd.api+json
{}