Organisations API

List, create and update the organisations in your community. To manage the users in an organisation, see Organisation users. Before you start, read the API overview for how authentication, headers, pagination and errors work.

List organisations

Return the organisations 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.

List organisations

curl "https://your-community.zapnito.com/api/v1/organisations?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/organisations

{
  "organisations": [
    {
      "id": 1,
      "name": "Harbour Capital",
      "email": "info@example.com",
      "profile": "Investment manager serving UK clients.",
      "address": "1 Harbour Street",
      "country": "GB",
      "website_url": "https://example.com"
    },
    {
      "id": 2,
      "name": "Fernhill Institute",
      "email": "contact@example.com",
      "profile": "Professional body for compliance teams.",
      "address": "2 Fernhill Road",
      "country": "GB",
      "website_url": "https://example.com"
    }
  ]
}

Create an organisation

Create a new organisation.

string

required

The name of the organisation.

string

required

The email address of the organisation.

string

The public-facing email address of the organisation.

string

The profile content of the organisation.

string

The address of the organisation.

string

The country of the organisation.

string

The URL of the organisation’s website.

string

The public-facing phone number of the organisation.

string

The URL of the organisation’s profile image, usually a logo.

Create an organisation

curl -X POST "https://your-community.zapnito.com/api/v1/organisations" \
  -H "Authorization: Token token=YOUR_API_TOKEN" \
  -H "Content-Type: application/json; charset=utf-8" \
  -d '{
    "organisation": {
      "name": "Brightwell Advisory",
      "email": "info@example.com",
      "public_email": "hello@example.com",
      "profile": "Independent compliance and risk advisory.",
      "address": "123 Your Street, AB1 2CD",
      "country": "GB",
      "website_url": "https://example.com",
      "public_phone_number": "07123 456 789",
      "remote_avatar_url": "https://example.com/image/123"
    }
  }'

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

{
  "organisation": {
    "id": 123,
    "name": "Brightwell Advisory",
    "email": "info@example.com",
    "public_email": "hello@example.com",
    "profile": "Independent compliance and risk advisory.",
    "address": "123 Your Street, AB1 2CD",
    "country": "GB",
    "website_url": "https://example.com",
    "public_phone_number": "07123 456 789",
    "remote_avatar_url": "https://example.com/image/123"
  }
}

{
  "errors": "Organisation with this email address already exists",
  "id": 123
}

{
  "errors": {
    "name": ["can't be blank"],
    "email": ["can't be blank"]
  }
}

200 OK: the organisation was created.
409 Conflict: an organisation with that email address already exists. The id in the response is the ID of the existing organisation.
422 Unprocessable Entity: a required parameter is missing.

Update an organisation

Update an organisation’s details. Send only the attributes you want to change.

string

required

The ID of the organisation.

string

The name of the organisation.

string

The email address of the organisation.

string

The public-facing email address of the organisation.

string

The profile content of the organisation.

string

The address of the organisation.

string

The country of the organisation.

string

The public-facing phone number of the organisation.

string

The URL of the organisation’s website.

Update an organisation

curl -X PUT "https://your-community.zapnito.com/api/v1/organisations/123" \
  -H "Authorization: Token token=YOUR_API_TOKEN" \
  -H "Content-Type: application/json; charset=utf-8" \
  -d '{"organisation": {"name": "Brightwell Advisory Group", "public_phone_number": "+44 20 7946 0000"}}'

PUT https://your-community.zapnito.com/api/v1/organisations/:id

{
  "organisation": {
    "id": 123,
    "name": "Brightwell Advisory Group",
    "email": "info@example.com",
    "public_email": "hello@example.com",
    "profile": "<p>Independent compliance and risk advisory.</p>",
    "address": "123 Your Street, AB1 2CD",
    "country": "GB",
    "website_url": "https://example.com",
    "public_phone_number": "+44 20 7946 0000"
  }
}

200 OK: the organisation was updated. The response confirms the saved attributes.

Getting started

Users

Groups and organisations

Content

Channels and rooms

Badges

List organisations

Create an organisation

Update an organisation

​List organisations

​Create an organisation

​Update an organisation

List organisations

Create an organisation

Update an organisation