Third-party resources API

{
  "third_party_resources": [
    {
      "id": 1,
      "third_party_ref": "1",
      "title": "Audit readiness toolkit",
      "description": "Templates and checklists for preparing for an audit.",
      "canonical_url": "https://docs.example.com/audit-readiness-toolkit",
      "thumbnail_url": "https://docs.example.com/audit-readiness-toolkit.png",
      "open_in_new_tab": true,
      "category": "Toolkits",
      "tags": ["Audit"]
    },
    {
      "id": 2,
      "third_party_ref": "ABC123",
      "title": "Data protection guide",
      "description": "A plain-English guide to handling personal data.",
      "canonical_url": "https://docs.example.com/data-protection-guide",
      "thumbnail_url": "https://docs.example.com/data-protection-guide.png",
      "open_in_new_tab": true,
      "category": "Guides",
      "tags": ["Compliance"]
    }
  ]
}

{
  "third_party_resources": [
    {
      "id": 1,
      "third_party_ref": "1",
      "title": "Audit readiness toolkit",
      "description": "Templates and checklists for preparing for an audit.",
      "canonical_url": "https://docs.example.com/audit-readiness-toolkit",
      "thumbnail_url": "https://docs.example.com/audit-readiness-toolkit.png",
      "open_in_new_tab": true,
      "category": "Toolkits",
      "tags": ["Audit"]
    },
    {
      "id": 2,
      "third_party_ref": "ABC123",
      "title": "Data protection guide",
      "description": "A plain-English guide to handling personal data.",
      "canonical_url": "https://docs.example.com/data-protection-guide",
      "thumbnail_url": "https://docs.example.com/data-protection-guide.png",
      "open_in_new_tab": true,
      "category": "Guides",
      "tags": ["Compliance"]
    }
  ]
}

Manage resources that live in your own systems and appear in your community. Each resource has a third_party_ref, which is its ID in your external system. Before you start, read the API overview for how authentication, headers, pagination and errors work.

List resources

Return the third-party resources 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 title or third_party_ref.

List resources

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

{
  "third_party_resources": [
    {
      "id": 1,
      "third_party_ref": "1",
      "title": "Audit readiness toolkit",
      "description": "Templates and checklists for preparing for an audit.",
      "canonical_url": "https://docs.example.com/audit-readiness-toolkit",
      "thumbnail_url": "https://docs.example.com/audit-readiness-toolkit.png",
      "open_in_new_tab": true,
      "category": "Toolkits",
      "tags": ["Audit"]
    },
    {
      "id": 2,
      "third_party_ref": "ABC123",
      "title": "Data protection guide",
      "description": "A plain-English guide to handling personal data.",
      "canonical_url": "https://docs.example.com/data-protection-guide",
      "thumbnail_url": "https://docs.example.com/data-protection-guide.png",
      "open_in_new_tab": true,
      "category": "Guides",
      "tags": ["Compliance"]
    }
  ]
}

Get a resource

Return a single resource by its ID in your external system.

string

required

The ID of the resource in your external system.

Get a resource

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

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

{
  "third_party_resource": {
    "id": 5,
    "third_party_ref": "ABC123",
    "title": "Data protection guide",
    "description": "A plain-English guide to handling personal data.",
    "canonical_url": "https://docs.example.com/data-protection-guide",
    "thumbnail_url": "https://docs.example.com/data-protection-guide.png",
    "open_in_new_tab": false,
    "category": "Guides",
    "tags": ["Compliance"]
  }
}

200 OK: the resource was returned.
404 Not Found: no resource matches the ID. The message reads Resource not found for ID: 1.

Create a resource

Create a new resource. Tags aren’t created for you, so any tags you assign must already exist. You can create tags first.

string

The ID of the resource in your external system.

string

required

The title of the resource.

string

The description, about text or body of the resource.

string

required

The URL of the external resource.

string

The URL of the resource’s thumbnail.

string

required

The category the resource belongs to.

boolean

default:false

Whether the canonical URL opens in a new tab.

string

The date and time the resource was published. ISO 8601 format is best for accuracy.

string[]

required

The names of the tags to assign to the resource.

Create a resource

curl -X POST "https://your-community.zapnito.com/api/v1/third_party_resources" \
  -H "Authorization: Token token=YOUR_API_TOKEN" \
  -H "Content-Type: application/json; charset=utf-8" \
  -d '{
    "third_party_resource": {
      "third_party_ref": "ABC123",
      "title": "Data protection guide",
      "description": "A plain-English guide to handling personal data.",
      "canonical_url": "https://docs.example.com/data-protection-guide",
      "thumbnail_url": "https://docs.example.com/data-protection-guide.png",
      "category_name": "Guides",
      "open_in_new_tab": true,
      "published_at": "2026-03-04T09:25:00",
      "tags": ["Compliance"]
    }
  }'

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

{
  "third_party_resource": {
    "id": 1,
    "third_party_ref": "ABC123",
    "title": "Data protection guide",
    "description": "A plain-English guide to handling personal data.",
    "canonical_url": "https://docs.example.com/data-protection-guide",
    "thumbnail_url": "https://docs.example.com/data-protection-guide.png",
    "open_in_new_tab": false,
    "category": "Guides",
    "tags": ["Compliance"]
  }
}

{
  "errors": {
    "title": ["can't be blank"]
  }
}

200 OK: the resource was created.
422 Unprocessable Entity: a required parameter is missing.

Update a resource

Update an existing resource. Send only the attributes you want to change. As when you create a resource, any tags you assign must already exist.

string

required

The ID of the resource in your external system.

string

The ID of the resource in your external system.

string

The title of the resource.

string

The description, about text or body of the resource.

string

The URL of the external resource.

string

The URL of the resource’s thumbnail.

string

The category the resource belongs to.

boolean

default:false

Whether the canonical URL opens in a new tab.

string

The date and time the resource was published. ISO 8601 format is best for accuracy.

string[]

The names of the tags to assign to the resource.

Update a resource

curl -X PUT "https://your-community.zapnito.com/api/v1/third_party_resources/ABC123" \
  -H "Authorization: Token token=YOUR_API_TOKEN" \
  -H "Content-Type: application/json; charset=utf-8" \
  -d '{
    "third_party_resource": {
      "title": "Data protection guide",
      "description": "A plain-English guide to handling personal data.",
      "canonical_url": "https://docs.example.com/data-protection-guide",
      "category_name": "Guides",
      "open_in_new_tab": true,
      "tags": ["Compliance"]
    }
  }'

PUT https://your-community.zapnito.com/api/v1/third_party_resources/:third_party_ref

{
  "third_party_resource": {
    "id": 1,
    "third_party_ref": "ABC123",
    "title": "Data protection guide",
    "description": "A plain-English guide to handling personal data.",
    "canonical_url": "https://docs.example.com/data-protection-guide",
    "thumbnail_url": "https://docs.example.com/data-protection-guide.png",
    "open_in_new_tab": false,
    "category": "Guides",
    "tags": ["Compliance"]
  }
}

{
  "errors": {
    "title": ["can't be blank"]
  }
}

200 OK: the resource was updated.
422 Unprocessable Entity: a required parameter is missing.

Delete a resource

Delete a resource.

string

required

The ID of the resource in your external system.

Delete a resource

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

DELETE https://your-community.zapnito.com/api/v1/third_party_resources/:third_party_ref

{
  "message": "Resource ABC123 deleted"
}

200 OK: the resource was deleted.
404 Not Found: no resource matches the ID. The message reads Resource not found for ID: 1.

Getting started

Users

Groups and organisations

Content

Channels and rooms

Badges

Third-party resources API

List resources

Get a resource

Create a resource

Update a resource

Delete a resource

​List resources

​Get a resource

​Create a resource

​Update a resource

​Delete a resource

List resources

Get a resource

Create a resource

Update a resource

Delete a resource