API Get Info - Revision history

Trent: Remove username/password API auth; ApiKey only

2026-07-25T18:55:06Z

Remove username/password API auth; ApiKey only

← Older revision		Revision as of 11:55, 25 July 2026
Line 9:		Line 9:
	! Field !! Required !! Description		! 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>Username</code> / <code>Password</code> \|\| Yes* \|\| Alternate auth if not using ApiKey~~.
	\|-		\|-
	\| <code>FairId</code> \|\| Yes \|\| Fair GUID from the site URL (<code>f</code> query parameter).		\| <code>FairId</code> \|\| Yes \|\| Fair GUID from the site URL (<code>f</code> query parameter).
Line 18:		Line 16:
	\|}		\|}

	* Provide '''either''' <code>ApiKey</code> '''or''' <code>Username</code>+<code>Password</code>.

	Calls must be run '''server-side''' — do not expose your API key in a browser.		Calls must be run '''server-side''' — do not expose your API key in a browser.

2026-07-25T18:49:35Z

Document full response shape for /api/data/info from current API

2024-04-11T03:50:25Z

← Older revision		Revision as of 20:50, 10 April 2024
Line 8:		Line 8:
	headers:{'Content-Type': 'application/json'},		headers:{'Content-Type': 'application/json'},
	body: JSON.stringify({		body: JSON.stringify({
	~~Username~~:'~~admin username',~~		ApiKey:'<Private key>',
	~~Password: 'password~~',
	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', //This value can be found in your url it's the value of f
	Body: {}		Body: {}

2021-11-22T19:36:33Z

← Older revision		Revision as of 12:36, 22 November 2021
Line 64:		Line 64:
	Values : ["small","large"] // this is only populated if the question has preset values.		Values : ["small","large"] // this is only populated if the question has preset values.
	}, ...],		}, ...],
			EntryTypes: [{
			Id: 123,
			PublicId: "9df61f13-474b-442f-ac1f-edca7348ef71",
			Name: "Research Entry"
			}]
	}		}

2021-11-03T21:08:04Z

2021-02-16T15:02:37Z

← Older revision		Revision as of 08:02, 16 February 2021
Line 54:		Line 54:
	Id: 123,		Id: 123,
	Name: "form 1c",		Name: "form 1c",
	}, ...]		}, ...],
	Rounds: [{		Rounds: [{
	Id: 123,		Id: 123,
	Name: "Round One",		Name: "Round One",
	}, ...]		}, ...],
			ProjectCustomQuestions: [{
			Id: 123,
			Name: "How big is your project",
			Values : ["small","large"] // this is only populated if the question has preset values.
			}, ...],
	}		}


	</syntaxhighlight>		</syntaxhighlight>

2020-12-12T22:04:09Z

2020-12-03T02:01:03Z

@@ Line 17: / Line 17: @@
 .then(data=>{console.log('Success: ',data);})
 .catch((error)=>{console.log('Error: ', error);});
 </syntaxhighlight>

2020-09-09T01:21:14Z

Get Info

← Older revision		Revision as of 18:21, 8 September 2020
Line 10:		Line 10:
	Username:'admin username',		Username:'admin username',
	Password: 'password',		Password: 'password',
	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', //This value can be found in your url it's the value of f
	Body: {}		Body: {}
	})		})

2020-09-09T01:20:46Z

← Older revision		Revision as of 18:20, 8 September 2020
Line 10:		Line 10:
	Username:'admin username',		Username:'admin username',
	Password: 'password',		Password: 'password',
			FairId: '9df61f13-474b-442f-ac1f-edca7348ef71', //This value can be found in your url it's the value of '''f'''
	Body: {}		Body: {}
	})		})