1. RunSignup
  2. API
  3. Methods
  4. Get Tickets

Get Tickets

Get the tickets for a ticket event. Please note that this API returns results in pages. The page and num parameters can be used to control paging. You should consider using modified_since_timestamp to download tickets since the last API request when you download tickets over time. For timed entry events, we recommend also setting final_time_slot_min_timestamp and final_time_slot_max_timestamp. As of November 2021, gender will always be null, but is retained in the response so that existing integrations will not break.

Ticket Statuses

By default, this API returns only active tickets. If you need tickets with other statuses such as transferred or refunded, you can use include_non_active_tickets to get non-active tickets. The following are the ticket statuses:

  • 1: Active
  • 2: Cleared
  • 3: Cancelled
  • 4: Transferred
  • 5: Ticket Holder Transferred
  • Response Format

    Note that the following fields are only included for timed entry events.

    Field Definition
    time_slot_rule_id Time slot rule ID.
    time_slot_rule_original_start_ts Original start time of the time slot.
    time_slot_rule_final_start_ts The final start time of the time slot. This may be different from the original if the director moved the start time for a time slot. It may be null if the time slot was cancelled.
    time_slot_rule_original_end_ts Original end time of the time slot.
    time_slot_rule_final_end_ts The final end time of the time slot. This may be different from the original if the director moved the start time for a time slot or extended the duration. It may be null if the time slot was cancelled.
    {
    	"tickets": [
    		{
    			"ticket_id": 49,
    			"ticket_event_id": 1,
    			"ticket_group_id": 1,
    			"ticket_group_level_id": 1,
    			"ticket_confirmation_code": "NDk6NhIjJiE2",
    			"ticket_status": 1,
    			"first_name": "John",
    			"middle_name": null,
    			"last_name": "Doe",
    			"email": "john.doe@runsignup.com",
    			"address1": "300 Mill St",
    			"address2": null,
    			"city": "Moorestown",
    			"state": null,
    			"zipcode": null,
    			"dob": null,
    			"age": null,
    			"gender": null,
    			"phone": "888-888-8888",
    			"countrycode": "US",
    			"amount_paid_in_cents": 1050,
    			"processing_fee_in_cents": 100,
    			"last_modified_ts": 1620956647,
    			"purchase": {
    				"ticket_purchase_id": 47,
    				"purchaser_first_name": "John",
    				"purchaser_middle_name": null,
    				"purchaser_last_name": "Doe",
    				"purchaser_address1": "300 Mill Street",
    				"purchaser_address2": null,
    				"purchaser_city": "Moorestown",
    				"purchaser_state": "NJ",
    				"purchaser_zipcode": "08057",
    				"purchaser_countrycode": "US",
    				"purchaser_phone": "856-555-5555",
    				"purchase_confirmation_code": "NDc6uUqYs8cF",
    				"raffle_tickets": [
    					1,
    					2
    				]
    			},
    			"ticket_number": "1",
    			"checked_in": "F",
    			"max_checkins": 3,
    			"checked_in_count": 0,
    			"window_max_checkins": 2,
    			"window_checkin_duration_in_seconds": 3600,
    			"window_checkin_duration_in_calendar_days": null,
    			"time_slot_rule_id": 8,
    			"time_slot_rule_original_start_ts": 1679356800,
    			"time_slot_rule_final_start_ts": 1679356800,
    			"time_slot_rule_original_end_ts": 1679360400,
    			"time_slot_rule_final_end_ts": 1679360400,
    			"question_responses": {
    				{
    					"question_id": 1,
    					"response_ids": [
    						1,
    						2
    					],
    					"responses": [
    						"Coffee",
    						"Tea"
    					]
    				},
    				{
    					"question_id": 2,
    					"response_ids": [],
    					"responses": [
    						"Fruit"
    					]
    				},
    				{
    					"question_id": 3,
    					"response_ids": [],
    					"responses": [
    						"F"
    					]
    				}
    			}
    		}
    	]
    }
    

    URL

    https://www.givesignup.org/rest/v2/tickets/get-tickets.json

    HTTP Method

    GET

    Parameters

    Parameter HTTP Method Default Description Datatype
    ticket_event_id
    Required
    GET Ticket event ID. uint
    rsu_api_key GET API key. string
    X-RSU-API-SECRET HTTP Header API secret. string
    sort GET ticket_id Sort field. Accepted sort fields: "ticket_id". string
    sort_direction GET ASC Sort by ascending ("ASC") or descending ("DESC") order. string
    after_ticket_id GET Get tickets after the given ticket ID. int
    before_ticket_id GET Get tickets before the given ticket ID. int
    num GET 100 Number of results per page (max 1,250). uint
    page GET 1 Number of pages. uint
    modified_since_timestamp GET Get tickets modified since a given time. uint
    final_time_slot_min_timestamp GET Get tickets with a final time slot start timestamp of no less than a given time. (Applicable to timed entry events only) uint
    final_time_slot_max_timestamp GET Get tickets with a final time slot start timestamp of no greater than a given time. (Applicable to timed entry events only) uint
    supports_timed_entry_events GET F Are timed entry events supported? bool
    include_question_responses GET F Should question responses be included? bool
    include_deleted_question_responses GET F Should question responses for deleted questions and deleted question responses be included if question responses are included? bool
    include_non_active_tickets GET F Should non-active tickets be included? bool
    include_raffle_tickets GET F Include raffle tickets? bool
    include_ticket_checkin_counts GET F Include ticket checkin counts? bool

    Search

    Parameter HTTP Method Default Description Datatype
    ticket_first_name GET Search tickets by ticket first name. string
    ticket_last_name GET Search tickets by ticket last name. string
    ticket_email GET Search tickets by ticket email. string
    purchaser_first_name GET Search tickets by purchaser first name. string
    purchaser_last_name GET Search tickets by purchaser last name. string
    purchaser_email GET Search tickets by purchaser email. string
    ticket_confirmation_code GET Search tickets by ticket confirmation code. string
    purchase_confirmation_code GET Search tickets by purchase confirmation code. string
    ticket_number GET Search tickets by ticket number. string

    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.