Skip to content
Headless Comments

Authors

Adding authors

An author is created when a user comments on your site. Each author has a unique ID, name, and email address, which can be used to identify them.

If an author does not exist, a new author will be created when they comment on your site. You can view all authors in the Dashboard.

External ID

You can assign an external ID to an author to link them to an existing user in your system. This can be useful for syncing comments with your user database.

Notifications

You can enable email notifications when a new Author is created in the Site’s Settings

Via the API

List all authors

Get all authors related to a site via the x-site-id header.

Request

GET /authors

Available query parameters

  • page - The page number to return, defaults to 1

Response

{
  "data": [
    {
      "id": "01j4sjct4ra51vskjhs3r257wz",
      "created_at": "2024-08-11T08:37:54.000000Z",
      "updated_at": "2024-08-11T08:37:54.000000Z",
      "name": "Tim Apple",
      "email": "[email protected]",
      "site_id": "01j509cg4wwxtdtef3xws5kgf2",
      "team_id": "01j4sjct8ps0dntdjthexpqwxh"
    }
  ],
  "meta": {
    "current_page": 1,
    "per_page": 25,
    "total": 1
  }
}

Get an author

Get a single author by ID, ensure you have the x-site-id header set to the site ID.

Request

GET /authors/:id

Response

{
  "id": "01j4sjct4ra51vskjhs3r257wz",
  "created_at": "2024-08-11T08:37:54.000000Z",
  "updated_at": "2024-08-11T08:37:54.000000Z",
  "name": "Tim Apple",
  "email": "[email protected]",
  "site_id": "01j509cg4wwxtdtef3xws5kgf2",
  "team_id": "01j4sjct8ps0dntdjthexpqwxh"
}