API Reference - User Submitted Forms

Link: https://support.brilliantdirectories.com/support/solutions/articles/12000108078

← Back to API Reference | Getting Started

User Submitted Forms

User Submitted Forms tracks which members have submitted specific forms on your directory website. Each record links a user ID to a form name and records the timestamp of submission. This is useful for tracking profile completion, onboarding steps, and whether a member has submitted a particular form at least once.

Model name in URL: user_submitted_forms — DB table: user_submitted_forms

The User Submitted Forms Object

FieldTypeDescription
idintegerUnique record ID (primary key, read-only)
user_idintegerID of the member who submitted the form
form_namestringMachine name of the form that was submitted
submitted_attimestampDate and time the form was submitted (auto-set on create)

List User Submitted Forms Records

GET /api/v2/user_submitted_forms/get

Returns a paginated list of user submitted form records.

Example Request

Copy
curl -X GET "https://www.yourdomain.com/api/v2/user_submitted_forms/get?limit=25" \
  -H "X-Api-Key: your-api-key-here"

Example Response

Copy
{
  "status": "success",
  "message": [
    {
      "tablesExists": true,
      "id": "1",
      "user_id": "1210",
      "form_name": "contact_general_user",
      "submitted_at": "2024-11-03 23:19:35"
    },
    {
      "tablesExists": true,
      "id": "2",
      "user_id": "1208",
      "form_name": "profile",
      "submitted_at": "2025-12-22 11:14:34"
    },
    {
      "tablesExists": true,
      "id": "3",
      "user_id": "1",
      "form_name": "blog_article_fields",
      "submitted_at": "2024-11-22 18:40:04"
    }
  ],
  "total": "45",
  "current_page": 1,
  "total_pages": 15,
  "next_page": "MipfKjM="
}

Retrieve a User Submitted Form Record

GET /api/v2/user_submitted_forms/get/{id}
The single-record GET endpoint is not functional for this model. Requests return an empty response. Use the list endpoint with property=id&property_value={id} to retrieve a specific record instead.

Example Workaround

Copy
curl -X GET "https://www.yourdomain.com/api/v2/user_submitted_forms/get?property=id&property_value=1" \
  -H "X-Api-Key: your-api-key-here"

Example Response

Copy
{
  "status": "success",
  "message": [
    {
      "tablesExists": true,
      "id": "1",
      "user_id": "1210",
      "form_name": "contact_general_user",
      "submitted_at": "2024-11-03 23:19:35"
    }
  ],
  "total": "1",
  "current_page": 1,
  "total_pages": 1
}

Create a User Submitted Form Record

POST /api/v2/user_submitted_forms/create

Example Request

Copy
curl -X POST "https://www.yourdomain.com/api/v2/user_submitted_forms/create" \
  -H "X-Api-Key: your-api-key-here" \
  -d "user_id=42" \
  -d "form_name=profile"

Example Response

Copy
{
  "status": "success",
  "message": {
    "id": "910082",
    "user_id": "42",
    "form_name": "profile",
    "submitted_at": null
  }
}

Update a User Submitted Form Record

PUT /api/v2/user_submitted_forms/update
The update endpoint is not functional for this model. Requests return an empty response and no data is modified.

Example Request

Copy
curl -X PUT "https://www.yourdomain.com/api/v2/user_submitted_forms/update" \
  -H "X-Api-Key: your-api-key-here" \
  -d "id=910082" \
  -d "form_name=profile_updated"

Delete a User Submitted Form Record

DELETE /api/v2/user_submitted_forms/delete
The delete endpoint is not functional for this model. Requests return an empty response and the record is not removed.

Example Request

Copy
curl -X DELETE "https://www.yourdomain.com/api/v2/user_submitted_forms/delete" \
  -H "X-Api-Key: your-api-key-here" \
  -d "id=910082"