Users

This API is used to read the list of users. For information about how to get started using the APIs available, see API Access.

Parameters

  • page (integer)
    Zero-based page number. The query returns up to 50 rows per page. Based on has_more you might increment the page and request the next set of results.
  • role (string)
    One of the built-in roles (air_experience, student, lapsed_student, associate_member, member, lapsed_member, engineer, safety_staff, instructor, office, owner).
  • name (string)
  • email (string)
    Set the name or email parameter to search for a specific user (exact match)

 

Output

  • total (integer)
    Total number of records available (not affected by the page parameter).
  • has_more (boolean)
    True if there are more records available by incrementing the page parameter. When false you have read the whole list.
  • change_id (string)
    A string value which indicates whether any records have changed. If you have read all data previously and the next read returns the same change_id, nothing has changed. However, if the value changes you might discard your current result set and read again from the first page.
  • rows  (array)
    Each row contains information about a user.

 

Each row contains the following fields.

  • id (integer)
  • url (string)
  • name (string)
  • email (string)
  • can_log_in (bool)
  • price_group (string)
  • roles (array)
  • created (integer)
    Timestamp for the time the user account was created.
  • accessed (integer)
    If the user has logged in, this is the last time they were active.
  • date_of_birth (Y-m-d)
  • membership_renewal_date (Y-m-d)
  • medical_renewal_date (Y-m-d)
  • revalidation_next_due (Y-m-d)
  • mobile_phone_number (string)
  • alt_phone_number (string)
  • address (string)
  • next_of_kin_details (string)
  • previous_experience (string)
  • comments (string)
  • internal_notes (string)

Notes

Not all fields are present for every user.

Example

curl -H "Accept: application/json" -H "Authorization: Bearer fb1f233e08aeef0a213dc87cea70cedbd7dbcd0a2229cac4f64e14e3c462cc8e" "https://acme.flightschoolbooking.com/club/user"

(Use your own site's URL, replacing acme with the name of your subdomain and use your own token)