API Get participants - Revision history

Trent: Remove username/password API auth; ApiKey only

2026-07-25T18:55:08Z

Remove username/password API auth; ApiKey only

Trent: Document full participant response for /api/data/participants

2026-07-25T18:49:36Z

Document full participant response for /api/data/participants

Peter at 03:51, 11 April 2024

2024-04-11T03:51:42Z

Michael at 21:09, 3 November 2021

2021-11-03T21:09:13Z

Trent: Created page with "== Get Participants == Get a list of participants from our API. fetch('/api/data/participants', { method:'POST', headers:{'C..."

2021-06-15T20:58:56Z

Created page with "== Get Participants == Get a list of participants from our API. <syntaxhighlight lang="JavaScript" line> fetch('/api/data/participants', { method:'POST', headers:{'C..."

New page

== Get Participants ==
Get a list of participants from our API.

<syntaxhighlight lang="JavaScript" line>

fetch('/api/data/participants', {
method:'POST',
headers:{'Content-Type': 'application/json'},
body: JSON.stringify({
Username:'admin username',
Password: 'password',
FairId: '9df61f13-474b-442f-ac1f-edca7348ef71', //This value can be found in your url it's the value of f
Body: {}
})
})
.then(response => response.json())
.then(data=>{console.log('Success: ',data);})
.catch((error)=>{console.log('Error: ', error);});

</syntaxhighlight>

@@ Line 9: / Line 9: @@
 ! Field !! Required !! Description
 |-
-| <code>ApiKey</code> || Yes* || Private API key for your site. Prefer this over username/password.
+| <code>ApiKey</code> || Yes || Private API key for your site.
 |-
 | <code>FairId</code> || Yes || Fair GUID from the site URL (<code>f</code> query parameter).
@@ Line 18: / Line 16: @@
 |}
 Calls must be run '''server-side''' — do not expose your API key in a browser.

← Older revision		Revision as of 21:09, 3 November 2021
Line 19:		Line 19:

	</syntaxhighlight>		</syntaxhighlight>
		+
		+
		+
		+	<br/><br/><br/><br/>
		+	[[Category: API]]

@@ Line 1: / Line 1: @@
 == Get Participants ==
-Get a list of participants from our API.
+Returns all student/participant records for a fair, including project links, school/teacher, tags, waivers, and fee status when fees are tracked.
 <syntaxhighlight lang="JavaScript" line>
 fetch('/api/data/participants', {
      method:'POST',
@@ Line 9: / Line 41: @@
      body: JSON.stringify({
              ApiKey:'<Private key>',
-             FairId: '9df61f13-474b-442f-ac1f-edca7348ef71', //This value can be found in your url it's the value of f
+             FairId: '9df61f13-474b-442f-ac1f-edca7348ef71', // value of f in your URL
              Body: {}
          })
@@ Line 16: / Line 48: @@
 .then(data=>{console.log('Success: ',data);})
 .catch((error)=>{console.log('Error: ', error);});
 </syntaxhighlight>
-<br/><br/><br/><br/>
+<br/><br/>
 [[Category: API]]