GET List

Returns information for a list.

Request URL

https://{school}.myschoolapp.com/api/list/[listID]?t={token}

Parameters

listID intThe ID of the list. To learn how to find the list ID for the API call, see KB article 108336.

Note: Queried lists must have access permissions enabled for users with the Web Services API role.

Response 200

Returned when the operation succeeds. In this example, our list contains first name, last name, email, graduation year, greeting, and maiden name.


[
  {
    "FirstName": "Jaya",
    "LastName": "Abelle",
    "EMail": "JayaAbelle@gmail.com",
    "GradYear": "2013",
    "Greeting": null,
    "MaidenName": null
  },
  {
    "FirstName": "Jonathan",
    "LastName": "Adams",
    "EMail": "JonathanAdams@gmail.com",
    "GradYear": "2011",
    "Greeting": null,
    "MaidenName": null
  },
  {
    "FirstName": "Frank",
    "LastName": "Aguirre",
    "EMail": "FrankAguirre@gmail.com",
    "GradYear": "2014",
    "Greeting": null,
    "MaidenName": null
  },
  ...
]