About the APIs
Last updated
Last updated
Documentation Version: 1.3 Last update: 31 January 2019
Live Endpoint: https://api.englandsquash.com/
Access: Every request must include a header of 'APIToken', the value of this should be your API Key.
Please contact to request an API token.
Two levels of access are available to England Squash data via the API. Depending on the agreement with England Squash, access will be granted to one or both of these.
Level 1 – access to England Squash data, not including personal data. This includes:
Membership status check for individuals (based on input values of Surname + England Squash ID or membership number)
Affiliation status check for clubs
Information on county associations
Information on facilities
Level 2 – access to England Squash personal data. Access to this level requires a signed Data Processing Agreement between England Squash and the system provider as well as any other consumers of the data (e.g. system provider’s customers such as county associations or clubs). In addition to data available under Level 1, this access level provides access to:
Personal data about individual users
Information about clubs (contains personal data)
Character set is UTF-8
API calls require all parameters, but these can be left blank
Where values are missing in the database, a value of ‘NULL’ is returned
Partial name matches in query strings are supported, though regular expression searches currently are not
Only one membership type can be held at the same time. Membership types are currently ‘Junior’, ‘Adult’ and ‘Coach’. All are classified as active
Affiliation refers to clubs, membership refers to individuals
All clubs are associated with a single county, as designated by England Squash
IDs for users, clubs and counties are unique and are not re-used