Sign in

Get API v1 posts

Changed on
get/api/v1/posts/

Request

  • The document declares no server URL.
  • Auth: HTTP bearer

Query parameters

limitinteger

Number of posts to return

Example:50
offsetinteger

Number of posts to skip

Response

OK

$schemastring uri

A URL to the JSON Schema for this object.

totalinteger required

Total number of posts

Example response

{
  "$schema": "https://example.com/schemas/GetAllPostsResponse.json",
  "posts": [
    {
      "$schema": "https://example.com/schemas/PostResponse.json",
      "author": {
        "$schema": "https://example.com/schemas/GetUserResponse.json",
        "bio": "My name is Suli and I'm a pro athlete",
        "college": {
          "academic_rank": 53,
          "city": "Boston",
          "division_rank": 1,
          "name": "Northeastern University",
          "state": "Massachusetts",
          "website": "https://www.northeastern.edu"
        },
        "division": 1,
        "email": "suli123@email.com",
        "expected_grad_year": 2027,
        "first_name": "Suli",
        "id": "1",
        "last_name": "Suli",
        "roles": [
          {
            "$schema": "https://example.com/schemas/RoleResponse.json",
            "id": "1",
            "name": "admin",
            "permissions": [
              {
                "$schema": "https://example.com/schemas/PermissionResponse.json",
                "action": "create",
                "id": "1",
                "resource": "user"
              }
            ]
          }
        ],
        "sport": {
          "name": "Women's Soccer",
          "popularity": 20000
        },
        "username": "suliproathlete",
        "verified_athlete_status": "pending"
      },
      "college": {
        "academic_rank": 53,
        "city": "Boston",
        "division_rank": 1,
        "name": "Northeastern University",
        "state": "Massachusetts",
        "website": "https://www.northeastern.edu"
      },
      "comment_count": 20,
      "content": "My name is Bob Joe and I am a rising senior who just got into NEU. What is the fencing program like? Are they competitive?",
      "is_liked": true,
      "like_count": 20000,
      "popularity_score": 42.5,
      "sport": {
        "name": "Women's Soccer",
        "popularity": 20000
      },
      "tags": [
        {
          "name": "Hockey",
          "type": "sports"
        }
      ],
      "title": "Looking for thoughts on NEU Fencing!"
    }
  ],
  "total": 100
}

Changes

  • 4add4432a667Revision changes
    • ▲

      removed the required property /// from the response with the status

  • 2d3d370006deRevision changes
    • ▲

      the response property /// became optional for the status

    • ▲

      the response property /// became optional for the status

    • ▲

      the response property /// became optional for the status

    • ▲

      the response property /// became optional for the status

    • ▲

      the response property /// became optional for the status

    • ▲

      the response property /// became optional for the status

    • ▲

      the /// response's property type changed from string to object for status

    • ▲

      the /// response's property type changed from string to object for status

    • ▲

      removed the required property /// from the response with the status

    • ▲

      removed the required property /// from the response with the status

    • ▲

      removed the required property /// from the response with the status

    • ▲

      removed the required property /// from the response with the status

    • ○

      added the optional property /// to the response with the status

    • ○

      added the optional property /// to the response with the status

    • ○

      added the optional property //// to the response with the status

    • ○

      added the optional property //// to the response with the status

    • ○

      added the required property //// to the response with the status

    • ○

      added the required property //// to the response with the status

    • ○

      added the required property //// to the response with the status

    • ○

      added the required property //// to the response with the status

    • ○

      added the required property //// to the response with the status

    • ○

      added the required property //// to the response with the status

    • ○

      added the required property //// to the response with the status

    • ○

      added the required property //// to the response with the status

    • ○

      added the required property //// to the response with the status

    • ○

      added the required property //// to the response with the status

    • ○

      added the required property //// to the response with the status

    • ○

      added the required property //// to the response with the status

    • ○

      added the required property //// to the response with the status

    • ○

      added the required property //// to the response with the status

    • ○

      added the required property //// to the response with the status

    • ○

      added the required property /// to the response with the status