1. RunSignup
  2. API
  3. Methods
  4. Club Information
API Overview Getting Started API Keys Documentation API Methods Error Codes Code Examples

Club Information

Gets information about a specific club, including the club name, URL, location. Additional membership levels, custom sections, etc. can be retrieved with the appropriate parameters.

Question Data

Each question has the following fields:

  • question_id - Question id
  • question_text - Question text
  • question_type - Question type as human readable string
  • question_type_code - Question type code:
    • F: Freeform
    • B: Boolean (T/F)
    • S: Select box list of predefined responses.
    • R: Radio buttons of predefined responses.
    • C: Checkboxes of predefined responses (Allows multiple selection).
  • individual - "T" if this question should be asked for each registrant. "F" if it should be asked once per transaction.
  • required - Is the question required? T/F
  • responses - Predefined responses if applicable.

URL

https://www.givesignup.org/rest/club/:club_id

HTTP Method

GET

Standard Parameters

Parameter HTTP Method Default Description Datatype
api_key GET API Key string
api_secret GET API Secret string
tmp_key GET Temporary API Key from login API call. This should NOT be used in combination with API Key. string
tmp_secret GET Temporary API Secret from login API call. This should NOT be used in combination with API Secret. string
rsu_api_key GET API v2 key. If used, you must send the API secret in an HTTP header named X-RSU-API-SECRET. string
sp_api_key GET Super partner API key. If used, you must send the API secret in an HTTP header named X-RSU-API-SECRET. string
X-RSU-API-SECRET HTTP Header API v2 or super partner secret. string
format GET xml Format of response. The default if not sent is `xml`, but `json` is preferred. format

Parameters

Parameter HTTP Method Default Description Datatype
club_id
Required		 GET ID of club. uint
include_waiver GET F Should waiver be included? bool
include_membership_levels GET F Should membership levels details be included? bool
include_membership_level_pricing GET F Should membership levels include pricing information? bool
include_questions GET F Should questions be included? bool
include_deleted_questions GET F Should deleted questions be included if questions are included? bool
include_internal_questions GET F Should internal questions be included if questions are included? bool
include_officers GET F Should club officer information be included? bool
include_custom_sections GET F Should custom section information be included? bool
include_coaching_categories GET F Should coaching club categories be included? bool

If you continue to use this site, you consent to use all cookies. We use cookies to offer you a better browsing experience. Read how we use cookies and how you can control them by visiting our Privacy Policy.

If you continue to use this site, you consent to use all cookies.