For Developers

People

List People

people.list(options);

Retrieve a list of People.

Function Arguments

This query allows for standard paging options.

Fetch Person

people.fetch(person_id, options);

Retrieve an individual Person.

Function Arguments

ParameterTypeDescription
person_idstringThe UUID of the person.

List Person Enrollments

people.listEnrollments(person_id, options);

Retrieve a list of Enrollments for a Person.

Function Arguments

This query allows for standard paging options.

ParameterTypeDescription
person_idstringThe UUID of the person.

List Person Districts

people.listDistricts(person_id, options);

Retrieve a list of Districts for a Person.

Function Arguments

This query allows for standard paging options.

ParameterTypeDescription
person_idstringThe UUID of the person.

List Person Schools

people.listSchools(person_id, options);

Retrieve a list of Schools for a Person.

Function Arguments

This query allows for standard paging options.

ParameterTypeDescription
person_idstringThe UUID of the person.

List Person Classes

people.listClasses(person_id, options);

Retrieve a list of Classes for a Person.

Function Arguments

This query allows for standard paging options.

ParameterTypeDescription
person_idstringThe UUID of the person.

List Person Sections

people.listSections(person_id, options);

Retrieve a list of Sections for a Person.

Function Arguments

This query allows for standard paging options.

ParameterTypeDescription
person_idstringThe UUID of the person.

List Person Agents

people.listAgents(person_id, options);

Retrieve a list of Agents for a Person.

Function Arguments

This query allows for standard paging options.

ParameterTypeDescription
person_idstringThe UUID of the person.