Get all clients

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

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

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_clients.sh

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

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

   get_all_clients_response.json

   [
     {
       "id": "550e8400-e29b-41d4-a716-446655440000",
       "first_name": "John",
       "last_name": "Doe",
       "city": "Oxford",
       "state": "OH",
       "zip_code": "45056",
       "email": "john.doe@example.com",
       "phone_number": "+12161231234",
       "created_at": "2026-05-21T10:00:00Z"
     },
     {
       "id": "550e8400-e29b-41d4-a716-446655440001",
       "first_name": "Jane",
       "last_name": "Smith",
       "city": "Columbus",
       "state": "OH",
       "zip_code": "43215",
       "email": "jane.smith@example.com",
       "phone_number": "+12161235678",
       "created_at": "2026-05-21T10:05:00Z"
     }
   ]

2. Using the Python SDK:

   get_all_clients.py

   from fstop import Fstop
   
   with Fstop(jwt_auth="YOUR_ACCESS_TOKEN") as f_client:
       clients = f_client.clients.list_clients()
   
       for c in clients:
           print(f"{c.first_name} {c.last_name} - {c.email}")

You can use the data from the GET request in your application. For example, you could display a list of all clients to your photographers or use the client IDs to query related projects and bookings.

What to do next

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