Gym API

Get Clients

GET /clients
Bearer auth

Get information about all clients (pagination to be added).

Responses

  • 200 application/json

    Successful retrieval of clients' information.

    Hide response attributes Show response attributes object
    • success boolean

      Whether the retrieval is successful

    • client array[object]
      Hide client attributes Show client attributes object
      • client_id integer Required

        Id of the client in database

      • created_at string(date) Required

        Account creation date

      • email_address string Required

        Client's email address

      • first_name string Required

        Client's first name

      • last_name string Required

        Client's last name

      • patronymic string Required

        Client's patronymic/middle name

      • phone_number string Required

        Client's phone number

      • profile_picture_url string Required

        Link to client's profile picture, typically uploaded using POST /profile-picture
  • 401 application/json

    User is not unauthorized or permissions are missing.

    Hide response attributes Show response attributes object
    • success boolean

      Whether query is successful

    • error string

      Error message
  • 429 application/json

    Rate limit exceeded - 100 queries per 15 minutes.

    Hide response attributes Show response attributes object
    • success boolean

      Whether query is successful

    • error string

      Error message
GET /clients 
curl \
 --request GET 'http://63.141.232.244:25540/v0/clients' \
 --header "Authorization: Bearer $ACCESS_TOKEN"
Response examples (200) 
{
  "success": true,
  "client": [
    {
      "client_id": 1,
      "last_name": "Иванов",
      "created_at": "2024-10-10T18:36:47Z",
      "first_name": "Иван",
      "patronymic": "Иванович",
      "phone_number": "79174236278",
      "email_address": "Og0rB@example.com",
      "profile_picture_url": "https://example.com/profile_picture.jpg"
    }
  ]
}
Response examples (401) 
{
  "success": false,
  "error": "Unauthorized"
}
Response examples (429) 
{
  "success": false,
  "error": "Too many requests, please try again later"
}