get http://{{formsmanagementsystemurl}}/v1/external/forms/61f2a5d0b629594fcfe63fda/responses
Returns a list of form responses.
Authentication
The request must supply valid API key headers:
- X-APP-ID
- X-API-KEY
As of July 2023, the following header is expected by new clients:
- X-CLIENT-ID
Response
| Field | Type | Nullable | Description |
|---|---|---|---|
id | string | N | Response ID. Note: This is also used as the submission reference given to fans in emails (if the reference merge tag is used). |
authId | integer | Y | If the user is logged in at the time of submission, their FanScore ID. Previously, this included anonymous user IDs. However, that behaviour was deprecated. |
createdAt | string | N | ISO 8601 datetime of when the form submission was made. |
fields | See fields below. | N |
Fields
| Field | Type | Nullable | Description |
|---|---|---|---|
id | integer | N | Field ID. Typically a uuidv4, but there is not strict requirement on what type of identifier is used. |
value | Varies depending on field type (unrelated to type below) and subtype) | N | See the 'GET Form By ID' documentation for context on what data types each field type/subtype expects. |
type | string | Y | Used to identify the reserved PII fields used to push user data to the data lake, values: email, first_name, last_name |