Get started with the Zapnito API

With the API, your system sends a request to Zapnito. Use it when you want to look something up or change something in your community, such as finding a user, adding someone to a group or publishing content.

When to use the API

You need to read or update data on demand.
You want to run a task on a schedule, such as a nightly sync.
You are acting on something that happened in your own system.

If you want Zapnito to tell you when something happens instead, use webhooks.

Send your first request

Validate your API token

Send a GET request to the ping endpoint. Replace YOUR_API_TOKEN with your token and https://your-community.zapnito.com with your community’s domain.

Validate your API key

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

A valid token returns 200 OK. See authentication if you get a 401 Unauthorized.

List some users

Use the same token to call a resource endpoint.

List users

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

Next steps

API overview: the base URL and every resource.
Pagination and responses and errors: handle large result sets and failures.

​When to use the API

​Send your first request

​Next steps

When to use the API

Send your first request

Next steps