RiderHQSIGN IN

API Reference

Use our API to access your data and build apps on our platform

SETUP
  1. Go to Account Dashboard > Integrations and select 'use RiderHQ API'
  2. Note down your account ID and private key values (under Account Dashboard > Integrations)
  3. Use http BASIC auth with each request account ID:private key
  4. Use https for all calls
ENDPOINTS

Events

api/v2/events?o=hammer-sportive
Lists all the events in your account
EXAMPLE
api/v2/events/{ ID }/entrants
List entrants of the event identified by { ID }
EXAMPLE

Groups

api/v2/groups?o=hammer-sportive
Lists all the groups in your account
EXAMPLE
api/v2/membershiptypes/{ ID }?o=hammer-sportive
Retrieve a membershiptype object
EXAMPLE
api/v2/groups/{ ID }/members
List members of the group identified by { ID }
EXAMPLE

Forms

api/v2/forms/{ ID }?o=hammer-sportive
Retrieve a form object
EXAMPLE
NOTES

Custom questions

You can request answers corresponding to custom questions you have defined on entry forms, join forms etc. in API responses.

You can also filter on custom question answer values and sort by answer values

Custom question data types
number boolean text date timestamp time
Question typeData typeExample
Explanationtextquestion[q_dke3lake]='abc'
Texttextquestion[q_dke3lake]='abc'
Checkboxtextquestion[q_dke3lake]='abc'
Multiline texttextquestion[q_dke3lake]='abc'
Daydatequestion[q_dke3lake]=1966-12-31
Durationtimequestion[q_dke3lake]=04:22
question[q_dke3lake]=04:22:33.222
Dropdowntextquestion[q_dke3lake]='abc'
Multiple choicetextquestion[q_dke3lake]='abc'

Sorting

Syntax for sorting the results is similar to SQL.

Specify an ordered list of sort fields, separated by commas. Use 'asc' 'desc' to indicate direction. The default, if direction is not specified, is 'asc'.

Sort fields can be the valid values suggested in the endpoint documentation, and/or custom question IDs (e.g. q_ekaleeeek,q_393lema)

Example:
	-data-urlencode sort="last_name desc, first_names"

Filtering

Syntax is similar to SQL expressions.

Join expressions with and, or, use parentheses to indicate precedence.

Operators
like <> >= <= = > <
Grouping
( )
Literals
string number true false null

string values must be enclosed in single quotes '

If a string itself value contains one or more single quotes, escape each of them by prepending an additional single quote character.

The like operator works as in SQL: include the % character as a zero-or-more-character wildcard e.g. lastname like '%mith' matches 'Smith', 'Paisley-Smith', 'Hindemith' etc.

If you need to include a literal % character in the match string, escape it by prepending an additional % character e.g. question[q_abce12l] like '%400%%' matches values: '3400%', 'over 400%' but not: 'over 4005'

Examples:
	--data-urlencode filter="last_name like '%cde' and (joined_day > 17-jan-2000 or expiry_day <= 17-jan-2025)"
	--data-urlencode filter="last_modified <> '17-jan-2000'"
	--data-urlencode filter="last_modified is null"