Get Note

Retrieve details about a specific community note, including its content, author information, and voting statistics.

Endpoint

GET /v1/:id

Retrieves a note by its ID or content ID.

Parameters

The ID parameter can be either:

  • • A note‘s ID (the one you get back from creating a note)

  • • The content ID the note is associated with

Response

Success Response (200 OK):

{
  "status": "ok",
  "note": {
    "id": "string",
    "content_id": "string",
    "created_at": "timestamp",
    "context": "string",
    "author": {
      "id": "string",
      "name": "string"
    },
    "votes": {
      "helpful": number,
      "not_helpful": number,
      "total": number,
      "score": "helpful" | "not_helpful" | "not_enough_votes"
    }
  }
}

Note Score Calculation:

  • • Requires minimum 5 votes to calculate score

  • • helpful if >= 65% of votes are helpful

  • • not_helpful if < 65% of votes are helpful

  • • not_enough_votes if total votes < 5

Error Responses:

  • • 401 Unauthorized - Invalid or missing API key

  • • 404 Not Found - Note not found

Example

Request using note ID:

curl https://communitynotes.dev/v1/note_abc123 \
  -H "Authorization: Bearer your_api_key"

Request using content ID:

curl https://communitynotes.dev/v1/post_123 \
  -H "Authorization: Bearer your_api_key"

Success Response:

{
  "status": "ok",
  "note": {
    "id": "note_abc123",
    "content_id": "post_123",
    "created_at": "2024-02-01T12:00:00Z",
    "context": "This claim needs context. According to official sources...",
    "author": {
      "id": "external_user_123",
      "name": "John Doe"
    },
    "votes": {
      "helpful": 8,
      "not_helpful": 2,
      "total": 10,
      "score": "helpful"
    }
  }
}

See Also