Users API

Find users on your community and update their profile data. Before you start, read the API overview for how authentication, headers, pagination and errors work.

List users

Return the users 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, title or company.

List users

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

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

{
  "users": [
    {
      "id": 1,
      "email": "alex.smith@example.com",
      "name": "Alex Smith",
      "title": "Compliance Analyst",
      "company": "Harbour Capital",
      "professional_reg_number": "ABC123",
      "country_code": "GB",
      "custom_field_options": []
    },
    {
      "id": 2,
      "email": "sam.jones@example.com",
      "name": "Sam Jones",
      "title": "Community Manager",
      "company": "Fernhill Institute",
      "professional_reg_number": "XYZ345",
      "country_code": "GB",
      "custom_field_options": []
    }
  ]
}

Get a user

Return a single user by email address.

string

required

The email address of the user.

Get a user

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

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

{
  "user": {
    "id": 1,
    "email": "alex.smith@example.com",
    "name": "Alex Smith",
    "title": "Compliance Analyst",
    "company": "Harbour Capital",
    "professional_reg_number": "ABC123",
    "country_code": "GB",
    "custom_field_options": []
  }
}

200 OK: the user was returned.
404 Not Found: no user matches the email address. The message reads User not found for email: 'jane.doe@example.com'.

Update a user

Update a user’s profile information, such as their name, job title, company and country. You can also assign or remove their custom field options. Send the attributes you want to change inside a user object. Attributes you leave out aren’t modified.

string

required

The email address of the user you want to update.

string

The user’s name. If you provide it, the user’s name changes to this value.

string

The user’s job title. If you provide it, the user’s job title changes to this value.

string

The name of the user’s company.

string

The two-letter ISO country code of the user, for example GB or US.

integer[]

The IDs of the custom field options that the user is matched to.

Update a user

curl -X PUT "https://your-community.zapnito.com/api/v1/users/alex.smith@example.com" \
  -H "Authorization: Token token=YOUR_API_TOKEN" \
  -H "Content-Type: application/json; charset=utf-8" \
  -d '{
    "user": {
      "name": "Alex Smith",
      "title": "Senior Compliance Analyst",
      "country_code": "GB",
      "company": "Harbour Capital",
      "custom_field_option_ids": [2508, 2509]
    }
  }'

PUT https://your-community.zapnito.com/api/v1/users/:email

{
  "user": {
    "name": "Alex Smith",
    "title": "Senior Compliance Analyst",
    "country_code": "GB",
    "company": "Harbour Capital",
    "custom_field_option_ids": [2508, 2509]
  }
}

200 OK: the user was updated. The response confirms the saved attributes.
404 Not Found: no user matches the email address. The message reads User not found for email: 'jane.doe@example.com'.

Getting started

Users

Groups and organisations

Content

Channels and rooms

Badges

List users

Get a user

Update a user

​List users

​Get a user

​Update a user

List users

Get a user

Update a user