Rooms API

{
  "rooms": [
    {
      "name": "Audit Readiness",
      "description": "Prepare for audits with checklists, templates and expert advice",
      "about": "Checklists, templates and advice from members who have been through an audit.",
      "position": 1,
      "type": "public",
      "contributor_group_uuid": "52218d7c-ff20-4abd-b674-d377d8a8e0ba",
      "member_group_uuid": "52218d7c-ff20-4abd-b674-d377d8a8e0bv"
    },
    {
      "name": "Compliance Practice",
      "description": "Share practical advice on day-to-day compliance work",
      "about": "A space for compliance professionals to compare approaches and ask questions.",
      "position": 2,
      "type": "public",
      "contributor_group_uuid": "52218d7c-ff20-4abd-b674-d377d8a8e0ba",
      "member_group_uuid": "52218d7c-ff20-4abd-b674-d377d8a8e0bv"
    }
  ]
}

{
  "rooms": [
    {
      "name": "Audit Readiness",
      "description": "Prepare for audits with checklists, templates and expert advice",
      "about": "Checklists, templates and advice from members who have been through an audit.",
      "position": 1,
      "type": "public",
      "contributor_group_uuid": "52218d7c-ff20-4abd-b674-d377d8a8e0ba",
      "member_group_uuid": "52218d7c-ff20-4abd-b674-d377d8a8e0bv"
    },
    {
      "name": "Compliance Practice",
      "description": "Share practical advice on day-to-day compliance work",
      "about": "A space for compliance professionals to compare approaches and ask questions.",
      "position": 2,
      "type": "public",
      "contributor_group_uuid": "52218d7c-ff20-4abd-b674-d377d8a8e0ba",
      "member_group_uuid": "52218d7c-ff20-4abd-b674-d377d8a8e0bv"
    }
  ]
}

Get details of the rooms in your community, and create new ones. Before you start, read the API overview for how authentication, headers, pagination and errors work.

List rooms

Return the rooms in your community.

integer

The page of results to return.

integer

The number of results to return per page.

string

A search term to reduce the number of results. Matches name.

List rooms

curl "https://your-community.zapnito.com/api/v1/rooms?page=1&per_page=20" \
  -H "Authorization: Token token=YOUR_API_TOKEN" \
  -H "Content-Type: application/json; charset=utf-8"

GET https://your-community.zapnito.com/api/v1/rooms

{
  "rooms": [
    {
      "name": "Audit Readiness",
      "description": "Prepare for audits with checklists, templates and expert advice",
      "about": "Checklists, templates and advice from members who have been through an audit.",
      "position": 1,
      "type": "public",
      "contributor_group_uuid": "52218d7c-ff20-4abd-b674-d377d8a8e0ba",
      "member_group_uuid": "52218d7c-ff20-4abd-b674-d377d8a8e0bv"
    },
    {
      "name": "Compliance Practice",
      "description": "Share practical advice on day-to-day compliance work",
      "about": "A space for compliance professionals to compare approaches and ask questions.",
      "position": 2,
      "type": "public",
      "contributor_group_uuid": "52218d7c-ff20-4abd-b674-d377d8a8e0ba",
      "member_group_uuid": "52218d7c-ff20-4abd-b674-d377d8a8e0bv"
    }
  ]
}

Get a room

Return a single room.

string

required

The ID of the room.

Get a room

curl "https://your-community.zapnito.com/api/v1/rooms/123" \
  -H "Authorization: Token token=YOUR_API_TOKEN" \
  -H "Content-Type: application/json; charset=utf-8"

GET https://your-community.zapnito.com/api/v1/rooms/:room_id

{
  "room": {
    "name": "Audit Readiness",
    "description": "Prepare for audits with checklists, templates and expert advice",
    "about": "Checklists, templates and advice from members who have been through an audit.",
    "position": 1,
    "type": "public",
    "contributor_group_uuid": "52218d7c-ff20-4abd-b674-d377d8a8e0ba",
    "member_group_uuid": "52218d7c-ff20-4abd-b674-d377d8a8e0bv"
  }
}

200 OK: the room was returned.
404 Not Found: no room matches the ID.

Create a room

Create a new room.

string

required

The name of the room.

string

required

The description of the room.

string

The about text of the room.

integer

The position of the room in your room list.

string

required

The email address of the room’s owner, who becomes the initial contributor. This is usually your own email address, and the user must be able to create rooms.

string

default:"public"

The type of room. Accepts public, private or secret.

Create a room

curl -X POST "https://your-community.zapnito.com/api/v1/rooms" \
  -H "Authorization: Token token=YOUR_API_TOKEN" \
  -H "Content-Type: application/json; charset=utf-8" \
  -d '{
    "room": {
      "name": "Audit Readiness",
      "description": "Prepare for audits with checklists, templates and expert advice",
      "about": "Checklists, templates and advice from members who have been through an audit.",
      "position": 1,
      "owner_email": "sam.jones@example.com"
    }
  }'

POST https://your-community.zapnito.com/api/v1/rooms

{
  "room": {
    "id": 123,
    "name": "Audit Readiness",
    "description": "Prepare for audits with checklists, templates and expert advice",
    "about": "Checklists, templates and advice from members who have been through an audit.",
    "position": 1,
    "contributor_group_uuid": "a1ecad96-8849-45ba-821e-20199cde45cd",
    "member_group_uuid": "a1ecad96-8849-45ba-821e-20199cde45cd"
  }
}

{
  "errors": {
    "description": ["can't be blank"],
    "name": ["has already been taken"]
  }
}

200 OK: the room was created.
422 Unprocessable Entity: a required parameter is missing or taken, or no user matches owner_email. In the second case the response is {"errors": {"owner_email": ["Couldn't find User"]}}.

Getting started

Users

Groups and organisations

Content

Channels and rooms

Badges

List rooms

Get a room

Create a room

​List rooms

​Get a room

​Create a room

List rooms

Get a room

Create a room