CustomInfoField
The CustomInfoField object
The CustomInfoField object looks like this in JSON:
{
"object": "custom_info_field",
"id": 18,
"name": "Business membership number",
"input_type": "text_area",
"type": "organization",
"description": null,
"value_permissions": "default",
"sandbox": true,
"api_version": null
}
| Attribute | Required | Data Type |
|---|---|---|
| id | Yes | int |
| name | No | text (255) |
| input_type | Yes | enum (text, select, checkbox, radio, date, date_time, integer, float, file, decimal, text_area, multiple_files) |
| type | Yes | text (255) |
| description | No | text |
| value_permissions | Yes | enum (default, not_visible_to_profile_owner, visible_to_profile_owner, editable_by_profile_owner) |
| sandbox | No | bool |
| api_version | No | -- |
index (admissions)
Example code to call this method:
curl "https://yourschool.populiweb.com/api2/admissionscustominfofields" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer YOUR_POPULI_API_KEY" \
-X GET
require 'httparty'
response = HTTParty.get(
'https://yourschool.populiweb.com/api2/admissionscustominfofields',
headers: {
'Authorization' => 'Bearer YOUR_POPULI_API_KEY'
},
)
puts response.body
import requests
response = requests.get(
'https://yourschool.populiweb.com/api2/admissionscustominfofields',
headers={
'Authorization': 'Bearer YOUR_POPULI_API_KEY'
},
)
print(response.json())
using Newtonsoft.Json;
using RestSharp;
var client = new RestClient();
var request = new RestRequest(new Uri("https://yourschool.populiweb.com/api2/admissionscustominfofields"), Method.Get);
request.AddHeader("Authorization", "Bearer YOUR_POPULI_API_KEY");
var response = client.Execute(request);
var response_object = JsonConvert.DeserializeObject(response.Content);
Console.Write(response_object);
$curl = curl_init();
curl_setopt($curl, CURLOPT_URL, 'https://yourschool.populiweb.com/api2/admissionscustominfofields');
curl_setopt($curl, CURLOPT_HTTPHEADER, ['Authorization: Bearer YOUR_POPULI_API_KEY']);
curl_setopt($curl, CURLOPT_RETURNTRANSFER, 1);
curl_setopt($curl, CURLOPT_CUSTOMREQUEST, 'GET');
$response = curl_exec($curl);
$response_decoded = json_decode($response);
var_dump($response_decoded);
Example response:
{
"object": "list",
"count": 1,
"results": 1,
"results_per_page": null,
"pages": 1,
"page": 1,
"offset": 0,
"has_more": false,
"data": [
{
"object": "custom_info_field",
"id": 14,
"name": "Favorite ice cream flavor",
"input_type": "text_area",
"type": "admissions",
"description": null,
"value_permissions": "default"
}
],
"sandbox": true,
"api_version": "2026-07-13"
}
Retrieves all CustomInfoField objects, of the admissions type.
HTTP Request
GET /admissionscustominfofields
Parameters
None
Expandable Properties
- options
Permissions
One of the following roles is required to call this method:
- Admissions Admin
index (campus life)
Example code to call this method:
curl "https://yourschool.populiweb.com/api2/campuslifecustominfofields" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer YOUR_POPULI_API_KEY" \
-X GET
require 'httparty'
response = HTTParty.get(
'https://yourschool.populiweb.com/api2/campuslifecustominfofields',
headers: {
'Authorization' => 'Bearer YOUR_POPULI_API_KEY'
},
)
puts response.body
import requests
response = requests.get(
'https://yourschool.populiweb.com/api2/campuslifecustominfofields',
headers={
'Authorization': 'Bearer YOUR_POPULI_API_KEY'
},
)
print(response.json())
using Newtonsoft.Json;
using RestSharp;
var client = new RestClient();
var request = new RestRequest(new Uri("https://yourschool.populiweb.com/api2/campuslifecustominfofields"), Method.Get);
request.AddHeader("Authorization", "Bearer YOUR_POPULI_API_KEY");
var response = client.Execute(request);
var response_object = JsonConvert.DeserializeObject(response.Content);
Console.Write(response_object);
$curl = curl_init();
curl_setopt($curl, CURLOPT_URL, 'https://yourschool.populiweb.com/api2/campuslifecustominfofields');
curl_setopt($curl, CURLOPT_HTTPHEADER, ['Authorization: Bearer YOUR_POPULI_API_KEY']);
curl_setopt($curl, CURLOPT_RETURNTRANSFER, 1);
curl_setopt($curl, CURLOPT_CUSTOMREQUEST, 'GET');
$response = curl_exec($curl);
$response_decoded = json_decode($response);
var_dump($response_decoded);
Example response:
{
"object": "list",
"count": 1,
"results": 1,
"results_per_page": null,
"pages": 1,
"page": 1,
"offset": 0,
"has_more": false,
"data": [
{
"object": "custom_info_field",
"id": 19,
"name": "Preferred sports team",
"input_type": "text_area",
"type": "campus_life",
"description": null,
"value_permissions": "default"
}
],
"sandbox": true,
"api_version": "2026-07-13"
}
Retrieves all CustomInfoField objects, of the campus life type.
HTTP Request
GET /campuslifecustominfofields
Parameters
None
Expandable Properties
- options
Permissions
One of the following roles is required to call this method:
- Academic Admin
- Registrar
index (donation)
Example code to call this method:
curl "https://yourschool.populiweb.com/api2/donationcustominfofields" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer YOUR_POPULI_API_KEY" \
-X GET
require 'httparty'
response = HTTParty.get(
'https://yourschool.populiweb.com/api2/donationcustominfofields',
headers: {
'Authorization' => 'Bearer YOUR_POPULI_API_KEY'
},
)
puts response.body
import requests
response = requests.get(
'https://yourschool.populiweb.com/api2/donationcustominfofields',
headers={
'Authorization': 'Bearer YOUR_POPULI_API_KEY'
},
)
print(response.json())
using Newtonsoft.Json;
using RestSharp;
var client = new RestClient();
var request = new RestRequest(new Uri("https://yourschool.populiweb.com/api2/donationcustominfofields"), Method.Get);
request.AddHeader("Authorization", "Bearer YOUR_POPULI_API_KEY");
var response = client.Execute(request);
var response_object = JsonConvert.DeserializeObject(response.Content);
Console.Write(response_object);
$curl = curl_init();
curl_setopt($curl, CURLOPT_URL, 'https://yourschool.populiweb.com/api2/donationcustominfofields');
curl_setopt($curl, CURLOPT_HTTPHEADER, ['Authorization: Bearer YOUR_POPULI_API_KEY']);
curl_setopt($curl, CURLOPT_RETURNTRANSFER, 1);
curl_setopt($curl, CURLOPT_CUSTOMREQUEST, 'GET');
$response = curl_exec($curl);
$response_decoded = json_decode($response);
var_dump($response_decoded);
Example response:
{
"object": "list",
"count": 1,
"results": 1,
"results_per_page": null,
"pages": 1,
"page": 1,
"offset": 0,
"has_more": false,
"data": [
{
"object": "custom_info_field",
"id": 17,
"name": "Proxy gift description",
"input_type": "text_area",
"type": "donation",
"description": null,
"value_permissions": "default"
}
],
"sandbox": true,
"api_version": "2026-07-13"
}
Retrieves all CustomInfoField objects, of the donation type.
HTTP Request
GET /donationcustominfofields
Parameters
None
Expandable Properties
- options
Permissions
One of the following roles is required to call this method:
- Financial Admin
index (donor)
Example code to call this method:
curl "https://yourschool.populiweb.com/api2/donorcustominfofields" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer YOUR_POPULI_API_KEY" \
-X GET
require 'httparty'
response = HTTParty.get(
'https://yourschool.populiweb.com/api2/donorcustominfofields',
headers: {
'Authorization' => 'Bearer YOUR_POPULI_API_KEY'
},
)
puts response.body
import requests
response = requests.get(
'https://yourschool.populiweb.com/api2/donorcustominfofields',
headers={
'Authorization': 'Bearer YOUR_POPULI_API_KEY'
},
)
print(response.json())
using Newtonsoft.Json;
using RestSharp;
var client = new RestClient();
var request = new RestRequest(new Uri("https://yourschool.populiweb.com/api2/donorcustominfofields"), Method.Get);
request.AddHeader("Authorization", "Bearer YOUR_POPULI_API_KEY");
var response = client.Execute(request);
var response_object = JsonConvert.DeserializeObject(response.Content);
Console.Write(response_object);
$curl = curl_init();
curl_setopt($curl, CURLOPT_URL, 'https://yourschool.populiweb.com/api2/donorcustominfofields');
curl_setopt($curl, CURLOPT_HTTPHEADER, ['Authorization: Bearer YOUR_POPULI_API_KEY']);
curl_setopt($curl, CURLOPT_RETURNTRANSFER, 1);
curl_setopt($curl, CURLOPT_CUSTOMREQUEST, 'GET');
$response = curl_exec($curl);
$response_decoded = json_decode($response);
var_dump($response_decoded);
Example response:
{
"object": "list",
"count": 1,
"results": 1,
"results_per_page": null,
"pages": 1,
"page": 1,
"offset": 0,
"has_more": false,
"data": [
{
"object": "custom_info_field",
"id": 20,
"name": "VIP",
"input_type": "text_area",
"type": "donor",
"description": null,
"value_permissions": "default"
}
],
"sandbox": true,
"api_version": "2026-07-13"
}
Retrieves all CustomInfoField objects, of the donor type.
HTTP Request
GET /donorcustominfofields
Parameters
None
Expandable Properties
- options
Permissions
One of the following roles is required to call this method:
- Financial Admin
index (financial aid)
Example code to call this method:
curl "https://yourschool.populiweb.com/api2/financialaidcustominfofields" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer YOUR_POPULI_API_KEY" \
-X GET
require 'httparty'
response = HTTParty.get(
'https://yourschool.populiweb.com/api2/financialaidcustominfofields',
headers: {
'Authorization' => 'Bearer YOUR_POPULI_API_KEY'
},
)
puts response.body
import requests
response = requests.get(
'https://yourschool.populiweb.com/api2/financialaidcustominfofields',
headers={
'Authorization': 'Bearer YOUR_POPULI_API_KEY'
},
)
print(response.json())
using Newtonsoft.Json;
using RestSharp;
var client = new RestClient();
var request = new RestRequest(new Uri("https://yourschool.populiweb.com/api2/financialaidcustominfofields"), Method.Get);
request.AddHeader("Authorization", "Bearer YOUR_POPULI_API_KEY");
var response = client.Execute(request);
var response_object = JsonConvert.DeserializeObject(response.Content);
Console.Write(response_object);
$curl = curl_init();
curl_setopt($curl, CURLOPT_URL, 'https://yourschool.populiweb.com/api2/financialaidcustominfofields');
curl_setopt($curl, CURLOPT_HTTPHEADER, ['Authorization: Bearer YOUR_POPULI_API_KEY']);
curl_setopt($curl, CURLOPT_RETURNTRANSFER, 1);
curl_setopt($curl, CURLOPT_CUSTOMREQUEST, 'GET');
$response = curl_exec($curl);
$response_decoded = json_decode($response);
var_dump($response_decoded);
Example response:
{
"object": "list",
"count": 1,
"results": 1,
"results_per_page": null,
"pages": 1,
"page": 1,
"offset": 0,
"has_more": false,
"data": [
{
"object": "custom_info_field",
"id": 15,
"name": "Favorite kind of loan",
"input_type": "text_area",
"type": "financial_aid",
"description": null,
"value_permissions": "default"
}
],
"sandbox": true,
"api_version": "2026-07-13"
}
Retrieves all CustomInfoField objects, of the financial aid type.
HTTP Request
GET /financialaidcustominfofields
Parameters
None
Expandable Properties
- options
Permissions
One of the following roles is required to call this method:
- Financial Admin
- Student Billing
- Financial Aid
index (financial)
Example code to call this method:
curl "https://yourschool.populiweb.com/api2/financialcustominfofields" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer YOUR_POPULI_API_KEY" \
-X GET
require 'httparty'
response = HTTParty.get(
'https://yourschool.populiweb.com/api2/financialcustominfofields',
headers: {
'Authorization' => 'Bearer YOUR_POPULI_API_KEY'
},
)
puts response.body
import requests
response = requests.get(
'https://yourschool.populiweb.com/api2/financialcustominfofields',
headers={
'Authorization': 'Bearer YOUR_POPULI_API_KEY'
},
)
print(response.json())
using Newtonsoft.Json;
using RestSharp;
var client = new RestClient();
var request = new RestRequest(new Uri("https://yourschool.populiweb.com/api2/financialcustominfofields"), Method.Get);
request.AddHeader("Authorization", "Bearer YOUR_POPULI_API_KEY");
var response = client.Execute(request);
var response_object = JsonConvert.DeserializeObject(response.Content);
Console.Write(response_object);
$curl = curl_init();
curl_setopt($curl, CURLOPT_URL, 'https://yourschool.populiweb.com/api2/financialcustominfofields');
curl_setopt($curl, CURLOPT_HTTPHEADER, ['Authorization: Bearer YOUR_POPULI_API_KEY']);
curl_setopt($curl, CURLOPT_RETURNTRANSFER, 1);
curl_setopt($curl, CURLOPT_CUSTOMREQUEST, 'GET');
$response = curl_exec($curl);
$response_decoded = json_decode($response);
var_dump($response_decoded);
Example response:
{
"object": "list",
"count": 1,
"results": 1,
"results_per_page": null,
"pages": 1,
"page": 1,
"offset": 0,
"has_more": false,
"data": [
{
"object": "custom_info_field",
"id": 16,
"name": "Favorite coin",
"input_type": "text_area",
"type": "financial",
"description": null,
"value_permissions": "default"
}
],
"sandbox": true,
"api_version": "2026-07-13"
}
Retrieves all CustomInfoField objects, of the financial type.
HTTP Request
GET /financialcustominfofields
Parameters
None
Expandable Properties
- options
Permissions
One of the following roles is required to call this method:
- Financial Admin
- Financial Auditor
- Student Billing
- Financial Admin
index (organization)
Example code to call this method:
curl "https://yourschool.populiweb.com/api2/organizationcustominfofields" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer YOUR_POPULI_API_KEY" \
-X GET
require 'httparty'
response = HTTParty.get(
'https://yourschool.populiweb.com/api2/organizationcustominfofields',
headers: {
'Authorization' => 'Bearer YOUR_POPULI_API_KEY'
},
)
puts response.body
import requests
response = requests.get(
'https://yourschool.populiweb.com/api2/organizationcustominfofields',
headers={
'Authorization': 'Bearer YOUR_POPULI_API_KEY'
},
)
print(response.json())
using Newtonsoft.Json;
using RestSharp;
var client = new RestClient();
var request = new RestRequest(new Uri("https://yourschool.populiweb.com/api2/organizationcustominfofields"), Method.Get);
request.AddHeader("Authorization", "Bearer YOUR_POPULI_API_KEY");
var response = client.Execute(request);
var response_object = JsonConvert.DeserializeObject(response.Content);
Console.Write(response_object);
$curl = curl_init();
curl_setopt($curl, CURLOPT_URL, 'https://yourschool.populiweb.com/api2/organizationcustominfofields');
curl_setopt($curl, CURLOPT_HTTPHEADER, ['Authorization: Bearer YOUR_POPULI_API_KEY']);
curl_setopt($curl, CURLOPT_RETURNTRANSFER, 1);
curl_setopt($curl, CURLOPT_CUSTOMREQUEST, 'GET');
$response = curl_exec($curl);
$response_decoded = json_decode($response);
var_dump($response_decoded);
Example response:
{
"object": "list",
"count": 1,
"results": 1,
"results_per_page": null,
"pages": 1,
"page": 1,
"offset": 0,
"has_more": false,
"data": [
{
"object": "custom_info_field",
"id": 18,
"name": "Business membership number",
"input_type": "text_area",
"type": "organization",
"description": null,
"value_permissions": "default"
}
],
"sandbox": true,
"api_version": "2026-07-13"
}
Retrieves all CustomInfoField objects, of the organization type.
HTTP Request
GET /organizationcustominfofields
Parameters
None
Expandable Properties
- options
Permissions
One of the following roles is required to call this method:
- Staff
index (person)
Example code to call this method:
curl "https://yourschool.populiweb.com/api2/personcustominfofields" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer YOUR_POPULI_API_KEY" \
-X GET
require 'httparty'
response = HTTParty.get(
'https://yourschool.populiweb.com/api2/personcustominfofields',
headers: {
'Authorization' => 'Bearer YOUR_POPULI_API_KEY'
},
)
puts response.body
import requests
response = requests.get(
'https://yourschool.populiweb.com/api2/personcustominfofields',
headers={
'Authorization': 'Bearer YOUR_POPULI_API_KEY'
},
)
print(response.json())
using Newtonsoft.Json;
using RestSharp;
var client = new RestClient();
var request = new RestRequest(new Uri("https://yourschool.populiweb.com/api2/personcustominfofields"), Method.Get);
request.AddHeader("Authorization", "Bearer YOUR_POPULI_API_KEY");
var response = client.Execute(request);
var response_object = JsonConvert.DeserializeObject(response.Content);
Console.Write(response_object);
$curl = curl_init();
curl_setopt($curl, CURLOPT_URL, 'https://yourschool.populiweb.com/api2/personcustominfofields');
curl_setopt($curl, CURLOPT_HTTPHEADER, ['Authorization: Bearer YOUR_POPULI_API_KEY']);
curl_setopt($curl, CURLOPT_RETURNTRANSFER, 1);
curl_setopt($curl, CURLOPT_CUSTOMREQUEST, 'GET');
$response = curl_exec($curl);
$response_decoded = json_decode($response);
var_dump($response_decoded);
Example response:
{
"object": "list",
"count": 11,
"results": 11,
"results_per_page": null,
"pages": 1,
"page": 1,
"offset": 0,
"has_more": false,
"data": [
{
"object": "custom_info_field",
"id": 11,
"name": "Car Model",
"input_type": "text_area",
"type": "person",
"description": null,
"value_permissions": "default"
}
],
"sandbox": true,
"api_version": "2026-07-13"
}
Retrieves all CustomInfoField objects, of the person type.
HTTP Request
GET /personcustominfofields
Parameters
None
Expandable Properties
- options
Permissions
One of the following roles is required to call this method:
- Staff
index (student)
Example code to call this method:
curl "https://yourschool.populiweb.com/api2/studentcustominfofields" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer YOUR_POPULI_API_KEY" \
-X GET
require 'httparty'
response = HTTParty.get(
'https://yourschool.populiweb.com/api2/studentcustominfofields',
headers: {
'Authorization' => 'Bearer YOUR_POPULI_API_KEY'
},
)
puts response.body
import requests
response = requests.get(
'https://yourschool.populiweb.com/api2/studentcustominfofields',
headers={
'Authorization': 'Bearer YOUR_POPULI_API_KEY'
},
)
print(response.json())
using Newtonsoft.Json;
using RestSharp;
var client = new RestClient();
var request = new RestRequest(new Uri("https://yourschool.populiweb.com/api2/studentcustominfofields"), Method.Get);
request.AddHeader("Authorization", "Bearer YOUR_POPULI_API_KEY");
var response = client.Execute(request);
var response_object = JsonConvert.DeserializeObject(response.Content);
Console.Write(response_object);
$curl = curl_init();
curl_setopt($curl, CURLOPT_URL, 'https://yourschool.populiweb.com/api2/studentcustominfofields');
curl_setopt($curl, CURLOPT_HTTPHEADER, ['Authorization: Bearer YOUR_POPULI_API_KEY']);
curl_setopt($curl, CURLOPT_RETURNTRANSFER, 1);
curl_setopt($curl, CURLOPT_CUSTOMREQUEST, 'GET');
$response = curl_exec($curl);
$response_decoded = json_decode($response);
var_dump($response_decoded);
Example response:
{
"object": "list",
"count": 1,
"results": 1,
"results_per_page": null,
"pages": 1,
"page": 1,
"offset": 0,
"has_more": false,
"data": [
{
"object": "custom_info_field",
"id": 12,
"name": "Favorite school subject",
"input_type": "text_area",
"type": "student",
"description": null,
"value_permissions": "default"
}
],
"sandbox": true,
"api_version": "2026-07-13"
}
Retrieves all CustomInfoField objects, of the student type.
HTTP Request
GET /studentcustominfofields
Parameters
None
Expandable Properties
- options
Permissions
One of the following roles is required to call this method:
- Academic Admin
index (term student)
Example code to call this method:
curl "https://yourschool.populiweb.com/api2/termstudentcustominfofields" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer YOUR_POPULI_API_KEY" \
-X GET
require 'httparty'
response = HTTParty.get(
'https://yourschool.populiweb.com/api2/termstudentcustominfofields',
headers: {
'Authorization' => 'Bearer YOUR_POPULI_API_KEY'
},
)
puts response.body
import requests
response = requests.get(
'https://yourschool.populiweb.com/api2/termstudentcustominfofields',
headers={
'Authorization': 'Bearer YOUR_POPULI_API_KEY'
},
)
print(response.json())
using Newtonsoft.Json;
using RestSharp;
var client = new RestClient();
var request = new RestRequest(new Uri("https://yourschool.populiweb.com/api2/termstudentcustominfofields"), Method.Get);
request.AddHeader("Authorization", "Bearer YOUR_POPULI_API_KEY");
var response = client.Execute(request);
var response_object = JsonConvert.DeserializeObject(response.Content);
Console.Write(response_object);
$curl = curl_init();
curl_setopt($curl, CURLOPT_URL, 'https://yourschool.populiweb.com/api2/termstudentcustominfofields');
curl_setopt($curl, CURLOPT_HTTPHEADER, ['Authorization: Bearer YOUR_POPULI_API_KEY']);
curl_setopt($curl, CURLOPT_RETURNTRANSFER, 1);
curl_setopt($curl, CURLOPT_CUSTOMREQUEST, 'GET');
$response = curl_exec($curl);
$response_decoded = json_decode($response);
var_dump($response_decoded);
Example response:
{
"object": "list",
"count": 1,
"results": 1,
"results_per_page": null,
"pages": 1,
"page": 1,
"offset": 0,
"has_more": false,
"data": [
{
"object": "custom_info_field",
"id": 13,
"name": "Favorite color",
"input_type": "text_area",
"type": "term_student",
"description": null,
"value_permissions": "default"
}
],
"sandbox": true,
"api_version": "2026-07-13"
}
Retrieves all CustomInfoField objects, of the term student type.
HTTP Request
GET /termstudentcustominfofields
Parameters
None
Expandable Properties
- options
Permissions
One of the following roles is required to call this method:
- Academic Admin
show (admissions)
Example code to call this method:
curl "https://yourschool.populiweb.com/api2/admissionscustominfofields/(admissionscustominfofield)" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer YOUR_POPULI_API_KEY" \
-X GET
require 'httparty'
response = HTTParty.get(
'https://yourschool.populiweb.com/api2/admissionscustominfofields/(admissionscustominfofield)',
headers: {
'Authorization' => 'Bearer YOUR_POPULI_API_KEY'
},
)
puts response.body
import requests
response = requests.get(
'https://yourschool.populiweb.com/api2/admissionscustominfofields/(admissionscustominfofield)',
headers={
'Authorization': 'Bearer YOUR_POPULI_API_KEY'
},
)
print(response.json())
using Newtonsoft.Json;
using RestSharp;
var client = new RestClient();
var request = new RestRequest(new Uri("https://yourschool.populiweb.com/api2/admissionscustominfofields/(admissionscustominfofield)"), Method.Get);
request.AddHeader("Authorization", "Bearer YOUR_POPULI_API_KEY");
var response = client.Execute(request);
var response_object = JsonConvert.DeserializeObject(response.Content);
Console.Write(response_object);
$curl = curl_init();
curl_setopt($curl, CURLOPT_URL, 'https://yourschool.populiweb.com/api2/admissionscustominfofields/(admissionscustominfofield)');
curl_setopt($curl, CURLOPT_HTTPHEADER, ['Authorization: Bearer YOUR_POPULI_API_KEY']);
curl_setopt($curl, CURLOPT_RETURNTRANSFER, 1);
curl_setopt($curl, CURLOPT_CUSTOMREQUEST, 'GET');
$response = curl_exec($curl);
$response_decoded = json_decode($response);
var_dump($response_decoded);
Example response:
{
"object": "custom_info_field",
"id": 14,
"name": "Favorite ice cream flavor",
"input_type": "text_area",
"type": "admissions",
"description": null,
"value_permissions": "default",
"sandbox": true,
"api_version": "2026-07-13"
}
Retrieves a specific CustomInfoField object, of the admissions type.
HTTP Request
GET /admissionscustominfofields/(admissionscustominfofield)
Parameters
No additional parameters are needed beyond the ID of the object being requested that appears in the URL.
Expandable Properties
- options
Permissions
One of the following roles is required to call this method:
- Admissions Admin
show (campus life)
Example code to call this method:
curl "https://yourschool.populiweb.com/api2/campuslifecustominfofields/(campuslifecustominfofield)" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer YOUR_POPULI_API_KEY" \
-X GET
require 'httparty'
response = HTTParty.get(
'https://yourschool.populiweb.com/api2/campuslifecustominfofields/(campuslifecustominfofield)',
headers: {
'Authorization' => 'Bearer YOUR_POPULI_API_KEY'
},
)
puts response.body
import requests
response = requests.get(
'https://yourschool.populiweb.com/api2/campuslifecustominfofields/(campuslifecustominfofield)',
headers={
'Authorization': 'Bearer YOUR_POPULI_API_KEY'
},
)
print(response.json())
using Newtonsoft.Json;
using RestSharp;
var client = new RestClient();
var request = new RestRequest(new Uri("https://yourschool.populiweb.com/api2/campuslifecustominfofields/(campuslifecustominfofield)"), Method.Get);
request.AddHeader("Authorization", "Bearer YOUR_POPULI_API_KEY");
var response = client.Execute(request);
var response_object = JsonConvert.DeserializeObject(response.Content);
Console.Write(response_object);
$curl = curl_init();
curl_setopt($curl, CURLOPT_URL, 'https://yourschool.populiweb.com/api2/campuslifecustominfofields/(campuslifecustominfofield)');
curl_setopt($curl, CURLOPT_HTTPHEADER, ['Authorization: Bearer YOUR_POPULI_API_KEY']);
curl_setopt($curl, CURLOPT_RETURNTRANSFER, 1);
curl_setopt($curl, CURLOPT_CUSTOMREQUEST, 'GET');
$response = curl_exec($curl);
$response_decoded = json_decode($response);
var_dump($response_decoded);
Example response:
{
"object": "custom_info_field",
"id": 19,
"name": "Preferred sports team",
"input_type": "text_area",
"type": "campus_life",
"description": null,
"value_permissions": "default",
"sandbox": true,
"api_version": "2026-07-13"
}
Retrieves a specific CustomInfoField object, of the campus life type.
HTTP Request
GET /campuslifecustominfofields/(campuslifecustominfofield)
Parameters
No additional parameters are needed beyond the ID of the object being requested that appears in the URL.
Expandable Properties
- options
Permissions
One of the following roles is required to call this method:
- Academic Admin
- Registrar
show (donation)
Example code to call this method:
curl "https://yourschool.populiweb.com/api2/donationcustominfofields/(donationcustominfofield)" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer YOUR_POPULI_API_KEY" \
-X GET
require 'httparty'
response = HTTParty.get(
'https://yourschool.populiweb.com/api2/donationcustominfofields/(donationcustominfofield)',
headers: {
'Authorization' => 'Bearer YOUR_POPULI_API_KEY'
},
)
puts response.body
import requests
response = requests.get(
'https://yourschool.populiweb.com/api2/donationcustominfofields/(donationcustominfofield)',
headers={
'Authorization': 'Bearer YOUR_POPULI_API_KEY'
},
)
print(response.json())
using Newtonsoft.Json;
using RestSharp;
var client = new RestClient();
var request = new RestRequest(new Uri("https://yourschool.populiweb.com/api2/donationcustominfofields/(donationcustominfofield)"), Method.Get);
request.AddHeader("Authorization", "Bearer YOUR_POPULI_API_KEY");
var response = client.Execute(request);
var response_object = JsonConvert.DeserializeObject(response.Content);
Console.Write(response_object);
$curl = curl_init();
curl_setopt($curl, CURLOPT_URL, 'https://yourschool.populiweb.com/api2/donationcustominfofields/(donationcustominfofield)');
curl_setopt($curl, CURLOPT_HTTPHEADER, ['Authorization: Bearer YOUR_POPULI_API_KEY']);
curl_setopt($curl, CURLOPT_RETURNTRANSFER, 1);
curl_setopt($curl, CURLOPT_CUSTOMREQUEST, 'GET');
$response = curl_exec($curl);
$response_decoded = json_decode($response);
var_dump($response_decoded);
Example response:
{
"object": "custom_info_field",
"id": 17,
"name": "Proxy gift description",
"input_type": "text_area",
"type": "donation",
"description": null,
"value_permissions": "default",
"sandbox": true,
"api_version": "2026-07-13"
}
Retrieves a specific CustomInfoField object, of the donation type.
HTTP Request
GET /donationcustominfofields/(donationcustominfofield)
Parameters
No additional parameters are needed beyond the ID of the object being requested that appears in the URL.
Expandable Properties
- options
Permissions
One of the following roles is required to call this method:
- Financial Admin
show (donor)
Example code to call this method:
curl "https://yourschool.populiweb.com/api2/donorcustominfofields/(donorcustominfofield)" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer YOUR_POPULI_API_KEY" \
-X GET
require 'httparty'
response = HTTParty.get(
'https://yourschool.populiweb.com/api2/donorcustominfofields/(donorcustominfofield)',
headers: {
'Authorization' => 'Bearer YOUR_POPULI_API_KEY'
},
)
puts response.body
import requests
response = requests.get(
'https://yourschool.populiweb.com/api2/donorcustominfofields/(donorcustominfofield)',
headers={
'Authorization': 'Bearer YOUR_POPULI_API_KEY'
},
)
print(response.json())
using Newtonsoft.Json;
using RestSharp;
var client = new RestClient();
var request = new RestRequest(new Uri("https://yourschool.populiweb.com/api2/donorcustominfofields/(donorcustominfofield)"), Method.Get);
request.AddHeader("Authorization", "Bearer YOUR_POPULI_API_KEY");
var response = client.Execute(request);
var response_object = JsonConvert.DeserializeObject(response.Content);
Console.Write(response_object);
$curl = curl_init();
curl_setopt($curl, CURLOPT_URL, 'https://yourschool.populiweb.com/api2/donorcustominfofields/(donorcustominfofield)');
curl_setopt($curl, CURLOPT_HTTPHEADER, ['Authorization: Bearer YOUR_POPULI_API_KEY']);
curl_setopt($curl, CURLOPT_RETURNTRANSFER, 1);
curl_setopt($curl, CURLOPT_CUSTOMREQUEST, 'GET');
$response = curl_exec($curl);
$response_decoded = json_decode($response);
var_dump($response_decoded);
Example response:
{
"object": "custom_info_field",
"id": 20,
"name": "VIP",
"input_type": "text_area",
"type": "donor",
"description": null,
"value_permissions": "default",
"sandbox": true,
"api_version": "2026-07-13"
}
Retrieves a specific CustomInfoField object, of the donor type.
HTTP Request
GET /donorcustominfofields/(donorcustominfofield)
Parameters
No additional parameters are needed beyond the ID of the object being requested that appears in the URL.
Expandable Properties
- options
Permissions
One of the following roles is required to call this method:
- Financial Admin
show (financial aid)
Example code to call this method:
curl "https://yourschool.populiweb.com/api2/financialaidcustominfofields/(financialaidcustominfofield)" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer YOUR_POPULI_API_KEY" \
-X GET
require 'httparty'
response = HTTParty.get(
'https://yourschool.populiweb.com/api2/financialaidcustominfofields/(financialaidcustominfofield)',
headers: {
'Authorization' => 'Bearer YOUR_POPULI_API_KEY'
},
)
puts response.body
import requests
response = requests.get(
'https://yourschool.populiweb.com/api2/financialaidcustominfofields/(financialaidcustominfofield)',
headers={
'Authorization': 'Bearer YOUR_POPULI_API_KEY'
},
)
print(response.json())
using Newtonsoft.Json;
using RestSharp;
var client = new RestClient();
var request = new RestRequest(new Uri("https://yourschool.populiweb.com/api2/financialaidcustominfofields/(financialaidcustominfofield)"), Method.Get);
request.AddHeader("Authorization", "Bearer YOUR_POPULI_API_KEY");
var response = client.Execute(request);
var response_object = JsonConvert.DeserializeObject(response.Content);
Console.Write(response_object);
$curl = curl_init();
curl_setopt($curl, CURLOPT_URL, 'https://yourschool.populiweb.com/api2/financialaidcustominfofields/(financialaidcustominfofield)');
curl_setopt($curl, CURLOPT_HTTPHEADER, ['Authorization: Bearer YOUR_POPULI_API_KEY']);
curl_setopt($curl, CURLOPT_RETURNTRANSFER, 1);
curl_setopt($curl, CURLOPT_CUSTOMREQUEST, 'GET');
$response = curl_exec($curl);
$response_decoded = json_decode($response);
var_dump($response_decoded);
Example response:
{
"object": "custom_info_field",
"id": 15,
"name": "Favorite kind of loan",
"input_type": "text_area",
"type": "financial_aid",
"description": null,
"value_permissions": "default",
"sandbox": true,
"api_version": "2026-07-13"
}
Retrieves a specific CustomInfoField object, of the financial aid type.
HTTP Request
GET /financialaidcustominfofields/(financialaidcustominfofield)
Parameters
No additional parameters are needed beyond the ID of the object being requested that appears in the URL.
Expandable Properties
- options
Permissions
One of the following roles is required to call this method:
- Financial Aid
show (financial)
Example code to call this method:
curl "https://yourschool.populiweb.com/api2/financialcustominfofields/(financialcustominfofield)" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer YOUR_POPULI_API_KEY" \
-X GET
require 'httparty'
response = HTTParty.get(
'https://yourschool.populiweb.com/api2/financialcustominfofields/(financialcustominfofield)',
headers: {
'Authorization' => 'Bearer YOUR_POPULI_API_KEY'
},
)
puts response.body
import requests
response = requests.get(
'https://yourschool.populiweb.com/api2/financialcustominfofields/(financialcustominfofield)',
headers={
'Authorization': 'Bearer YOUR_POPULI_API_KEY'
},
)
print(response.json())
using Newtonsoft.Json;
using RestSharp;
var client = new RestClient();
var request = new RestRequest(new Uri("https://yourschool.populiweb.com/api2/financialcustominfofields/(financialcustominfofield)"), Method.Get);
request.AddHeader("Authorization", "Bearer YOUR_POPULI_API_KEY");
var response = client.Execute(request);
var response_object = JsonConvert.DeserializeObject(response.Content);
Console.Write(response_object);
$curl = curl_init();
curl_setopt($curl, CURLOPT_URL, 'https://yourschool.populiweb.com/api2/financialcustominfofields/(financialcustominfofield)');
curl_setopt($curl, CURLOPT_HTTPHEADER, ['Authorization: Bearer YOUR_POPULI_API_KEY']);
curl_setopt($curl, CURLOPT_RETURNTRANSFER, 1);
curl_setopt($curl, CURLOPT_CUSTOMREQUEST, 'GET');
$response = curl_exec($curl);
$response_decoded = json_decode($response);
var_dump($response_decoded);
Example response:
{
"object": "custom_info_field",
"id": 16,
"name": "Favorite coin",
"input_type": "text_area",
"type": "financial",
"description": null,
"value_permissions": "default",
"sandbox": true,
"api_version": "2026-07-13"
}
Retrieves a specific CustomInfoField object, of the financial type.
HTTP Request
GET /financialcustominfofields/(financialcustominfofield)
Parameters
No additional parameters are needed beyond the ID of the object being requested that appears in the URL.
Expandable Properties
- options
Permissions
One of the following roles is required to call this method:
- Financial Admin
- Financial Auditor
- Student Billing
- Financial Admin
show (organization)
Example code to call this method:
curl "https://yourschool.populiweb.com/api2/organizationcustominfofields/(organizationcustominfofield)" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer YOUR_POPULI_API_KEY" \
-X GET
require 'httparty'
response = HTTParty.get(
'https://yourschool.populiweb.com/api2/organizationcustominfofields/(organizationcustominfofield)',
headers: {
'Authorization' => 'Bearer YOUR_POPULI_API_KEY'
},
)
puts response.body
import requests
response = requests.get(
'https://yourschool.populiweb.com/api2/organizationcustominfofields/(organizationcustominfofield)',
headers={
'Authorization': 'Bearer YOUR_POPULI_API_KEY'
},
)
print(response.json())
using Newtonsoft.Json;
using RestSharp;
var client = new RestClient();
var request = new RestRequest(new Uri("https://yourschool.populiweb.com/api2/organizationcustominfofields/(organizationcustominfofield)"), Method.Get);
request.AddHeader("Authorization", "Bearer YOUR_POPULI_API_KEY");
var response = client.Execute(request);
var response_object = JsonConvert.DeserializeObject(response.Content);
Console.Write(response_object);
$curl = curl_init();
curl_setopt($curl, CURLOPT_URL, 'https://yourschool.populiweb.com/api2/organizationcustominfofields/(organizationcustominfofield)');
curl_setopt($curl, CURLOPT_HTTPHEADER, ['Authorization: Bearer YOUR_POPULI_API_KEY']);
curl_setopt($curl, CURLOPT_RETURNTRANSFER, 1);
curl_setopt($curl, CURLOPT_CUSTOMREQUEST, 'GET');
$response = curl_exec($curl);
$response_decoded = json_decode($response);
var_dump($response_decoded);
Example response:
{
"object": "custom_info_field",
"id": 18,
"name": "Business membership number",
"input_type": "text_area",
"type": "organization",
"description": null,
"value_permissions": "default",
"sandbox": true,
"api_version": "2026-07-13"
}
Retrieves a specific CustomInfoField object, of the organization type.
HTTP Request
GET /organizationcustominfofields/(organizationcustominfofield)
Parameters
No additional parameters are needed beyond the ID of the object being requested that appears in the URL.
Expandable Properties
- options
Permissions
One of the following roles is required to call this method:
- Staff
show (person)
Example code to call this method:
curl "https://yourschool.populiweb.com/api2/personcustominfofields/(personcustominfofield)" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer YOUR_POPULI_API_KEY" \
-X GET
require 'httparty'
response = HTTParty.get(
'https://yourschool.populiweb.com/api2/personcustominfofields/(personcustominfofield)',
headers: {
'Authorization' => 'Bearer YOUR_POPULI_API_KEY'
},
)
puts response.body
import requests
response = requests.get(
'https://yourschool.populiweb.com/api2/personcustominfofields/(personcustominfofield)',
headers={
'Authorization': 'Bearer YOUR_POPULI_API_KEY'
},
)
print(response.json())
using Newtonsoft.Json;
using RestSharp;
var client = new RestClient();
var request = new RestRequest(new Uri("https://yourschool.populiweb.com/api2/personcustominfofields/(personcustominfofield)"), Method.Get);
request.AddHeader("Authorization", "Bearer YOUR_POPULI_API_KEY");
var response = client.Execute(request);
var response_object = JsonConvert.DeserializeObject(response.Content);
Console.Write(response_object);
$curl = curl_init();
curl_setopt($curl, CURLOPT_URL, 'https://yourschool.populiweb.com/api2/personcustominfofields/(personcustominfofield)');
curl_setopt($curl, CURLOPT_HTTPHEADER, ['Authorization: Bearer YOUR_POPULI_API_KEY']);
curl_setopt($curl, CURLOPT_RETURNTRANSFER, 1);
curl_setopt($curl, CURLOPT_CUSTOMREQUEST, 'GET');
$response = curl_exec($curl);
$response_decoded = json_decode($response);
var_dump($response_decoded);
Example response:
{
"object": "custom_info_field",
"id": 11,
"name": "Car Model",
"input_type": "text_area",
"type": "person",
"description": null,
"value_permissions": "default",
"sandbox": true,
"api_version": "2026-07-13"
}
Retrieves a specific CustomInfoField object, of the person type.
HTTP Request
GET /personcustominfofields/(personcustominfofield)
Parameters
No additional parameters are needed beyond the ID of the object being requested that appears in the URL.
Expandable Properties
- options
Permissions
One of the following roles is required to call this method:
- Staff
show (student)
Example code to call this method:
curl "https://yourschool.populiweb.com/api2/studentcustominfofields/(studentcustominfofield)" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer YOUR_POPULI_API_KEY" \
-X GET
require 'httparty'
response = HTTParty.get(
'https://yourschool.populiweb.com/api2/studentcustominfofields/(studentcustominfofield)',
headers: {
'Authorization' => 'Bearer YOUR_POPULI_API_KEY'
},
)
puts response.body
import requests
response = requests.get(
'https://yourschool.populiweb.com/api2/studentcustominfofields/(studentcustominfofield)',
headers={
'Authorization': 'Bearer YOUR_POPULI_API_KEY'
},
)
print(response.json())
using Newtonsoft.Json;
using RestSharp;
var client = new RestClient();
var request = new RestRequest(new Uri("https://yourschool.populiweb.com/api2/studentcustominfofields/(studentcustominfofield)"), Method.Get);
request.AddHeader("Authorization", "Bearer YOUR_POPULI_API_KEY");
var response = client.Execute(request);
var response_object = JsonConvert.DeserializeObject(response.Content);
Console.Write(response_object);
$curl = curl_init();
curl_setopt($curl, CURLOPT_URL, 'https://yourschool.populiweb.com/api2/studentcustominfofields/(studentcustominfofield)');
curl_setopt($curl, CURLOPT_HTTPHEADER, ['Authorization: Bearer YOUR_POPULI_API_KEY']);
curl_setopt($curl, CURLOPT_RETURNTRANSFER, 1);
curl_setopt($curl, CURLOPT_CUSTOMREQUEST, 'GET');
$response = curl_exec($curl);
$response_decoded = json_decode($response);
var_dump($response_decoded);
Example response:
{
"object": "custom_info_field",
"id": 12,
"name": "Favorite school subject",
"input_type": "text_area",
"type": "student",
"description": null,
"value_permissions": "default",
"sandbox": true,
"api_version": "2026-07-13"
}
Retrieves a specific CustomInfoField object, of the student type.
HTTP Request
GET /studentcustominfofields/(studentcustominfofield)
Parameters
No additional parameters are needed beyond the ID of the object being requested that appears in the URL.
Expandable Properties
- options
Permissions
One of the following roles is required to call this method:
- Academic Admin
show (term student)
Example code to call this method:
curl "https://yourschool.populiweb.com/api2/termstudentcustominfofields/(termstudentcustominfofield)" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer YOUR_POPULI_API_KEY" \
-X GET
require 'httparty'
response = HTTParty.get(
'https://yourschool.populiweb.com/api2/termstudentcustominfofields/(termstudentcustominfofield)',
headers: {
'Authorization' => 'Bearer YOUR_POPULI_API_KEY'
},
)
puts response.body
import requests
response = requests.get(
'https://yourschool.populiweb.com/api2/termstudentcustominfofields/(termstudentcustominfofield)',
headers={
'Authorization': 'Bearer YOUR_POPULI_API_KEY'
},
)
print(response.json())
using Newtonsoft.Json;
using RestSharp;
var client = new RestClient();
var request = new RestRequest(new Uri("https://yourschool.populiweb.com/api2/termstudentcustominfofields/(termstudentcustominfofield)"), Method.Get);
request.AddHeader("Authorization", "Bearer YOUR_POPULI_API_KEY");
var response = client.Execute(request);
var response_object = JsonConvert.DeserializeObject(response.Content);
Console.Write(response_object);
$curl = curl_init();
curl_setopt($curl, CURLOPT_URL, 'https://yourschool.populiweb.com/api2/termstudentcustominfofields/(termstudentcustominfofield)');
curl_setopt($curl, CURLOPT_HTTPHEADER, ['Authorization: Bearer YOUR_POPULI_API_KEY']);
curl_setopt($curl, CURLOPT_RETURNTRANSFER, 1);
curl_setopt($curl, CURLOPT_CUSTOMREQUEST, 'GET');
$response = curl_exec($curl);
$response_decoded = json_decode($response);
var_dump($response_decoded);
Example response:
{
"object": "custom_info_field",
"id": 13,
"name": "Favorite color",
"input_type": "text_area",
"type": "term_student",
"description": null,
"value_permissions": "default",
"sandbox": true,
"api_version": "2026-07-13"
}
Retrieves a specific CustomInfoField object, of the term student type.
HTTP Request
GET /termstudentcustominfofields/(termstudentcustominfofield)
Parameters
No additional parameters are needed beyond the ID of the object being requested that appears in the URL.
Expandable Properties
- options
Permissions
One of the following roles is required to call this method:
- Academic Admin