Get all projects

The Fstop API includes an endpoint that allows client applications to retrieve all projects from the database.

In this guide, you’ll make a GET request to the /api/projects/ endpoint to retrieve a list of all projects.

Before you begin

Before you make a GET request, ensure that you have an access token. For instructions on requesting an access token, see Getting started with the Fstop API.

Make a GET request

1. Open a terminal and run the following command:

   get_all_projects.sh

   curl -X GET http://localhost:8000/api/projects/ \
     -H "Authorization: Bearer YOUR_ACCESS_TOKEN"

   The API returns a 200 OK and a list of all projects:

   get_all_projects_response.json

   [
     {
       "id": "cc0dd84d-a50d-4ad5-8e94-e9dcb33d00e3",
       "project_name": "Bob's Birthday Party",
       "project_type": "party",
       "client": {
         "id": "88e0de45-8197-4425-a390-3401348cc0bb",
         "first_name": "Bob",
         "last_name": "Barker",
         "city": "New York",
         "state": "NY",
         "zip_code": "07008",
         "email": "bob.barker@gmail.com",
         "phone_number": "+12126885200",
         "created_at": "2026-05-21T01:23:38.570263Z"
       },
       "created_at": "2026-05-21T01:30:04.766552Z"
     },
     {
       "id": "660e8400-e29b-41d4-a716-446655440000",
       "project_name": "Wedding",
       "project_type": "event",
       "client": {
         "id": "550e8400-e29b-41d4-a716-446655440000",
         "first_name": "John",
         "last_name": "Doe",
         "city": "Cleveland",
         "state": "OH",
         "zip_code": "44122",
         "email": "john.doe@example.com",
         "phone_number": "+12161231234",
         "created_at": "2026-05-21T10:00:00Z"
       },
       "created_at": "2026-05-21T10:15:00Z"
     }
   ]

2. Using the Python SDK:

   get_all_projects.py

   from fstop import Fstop
   
   with Fstop(jwt_auth="YOUR_ACCESS_TOKEN") as f_client:
       projects = f_client.projects.list_projects()
   
       for project in projects:
           print(f"{project.project_name} ({project.project_type}) - {project.client.first_name} {project.client.last_name}")

You can use the data from the GET request in your application. For example, you could display a list of all projects or filter projects by type.

What to do next

See GET /api/projects/ for a full list of request parameters and response schemas.