Skip to content

index.md

Latest commit

 

History

History
66 lines (53 loc) · 2.79 KB

index.md

File metadata and controls

66 lines (53 loc) · 2.79 KB
Raw

GET /api/v1/posts

Retrieves a list of posts, with support for filtering by profile type, profile ID, search, and order.

Permissions

Permission Description
posts.view View your own posts and posts on any public profile
posts.view_all View all posts, including drafts, on any profile (admin only)

Query Parameters

Name Type Required Description Example
type string No Profile type (App\Models\Gym, App\Models\User). Comma-separated for multiple "App\Models\Gym,App\Models\User"
item_id int No Profile ID(s) to filter by (comma-separated for multiple) "1,2,3"
in_blog bool No Filter posts by blog publication status (true for blog posts, false for regular posts) "true"
search string No Search term for post title or content "workout"
order string No Order of results: ASC or DESC (default: DESC) "DESC"

Response

200 OK

Returns a paginated list of post resources.

{
  "data": [
    {
      "id": 123,
      "profile_type": "App\\Models\\User",
      "profile_id": 42,
      "title": "My Workout",
      "content": "Today I did squats and deadlifts.",
      "is_draft": false,
      "media": [
        {
          "id": 10,
          "attachable_type": "App\\Models\\Posts\\Post",
          "attachable_id": 123,
          "link": "https://example.com/media/10.jpg"
        }
      ]
    }
  ],
  "links": { /* pagination data */ },
  "meta": { /* pagination data */ }
}

See Post Resource and Pagination Data (per page: 30).

Error Responses

Status Description Reference
401 Unauthorized Authentication error
403 Forbidden (no permission) Permission error
404 Not found Not-found error