| Note |
|---|
This request can return a large amount of data (> 10 MB). |
This endpoint returns a lightweight report of all people in your organization.
URI: https://api.onlinephotosubmission.com/api/reports/people
...
https://api.
...
cloudcard.
...
us/
...
report/people
Example URI: https://api.onlinephotosubmission.com/api/reports/people?include=3,4,5,username2@your-org.com,AB123
Optional URL Parameters: include={value}[,{value},{value},{value}]
The optional include instructs the report to only include people whose database ID, email address, or customer identifier (i.e. Student ID Number) match a value in the list of comma separated values. See above example.
HTTP Method: GET
Optional HTTP Method: POST (allows you to post a list of database IDs, email addresses, or customer identifiers[i.e. Student ID Number] in the request body)
Required Headers: X-Auth-Token (see: Authentication)
Optional Headers: accept: text/csv (returns a comma separated values response)
Example HTTP Request Body (GET)
| Code Block |
|---|
[Leave Empty] |
Example HTTP Request Body (POST)
| Code Block |
|---|
{
"include": [3,4,5,"cardholder@sharptop.co","AB123"]
} |
Example JSON Response
| Code Block |
|---|
200 OK
[
{
"id": 3,
"email": "username@your-org.com",
"identifier": "123456",
"enabled": true,
"date_person_created": "2023-06-01T12:50:42Z",
"date_photo_created": "2023-06-01T12:51:17Z",
"First_Name": "John",
"Last_Name": "Doe",
"Campus": "Eastside"
},
{
"id": 42,
"email": "username2@your-org.com",
"identifier": "234567",
"enabled": false,
"date_person_created": "2023-04-06T12:50:42Z",
"date_photo_created": "2023-05-01T12:51:17Z",
"First_Name": "Jane",
"Last_Name": "Doe",
"Campus": "Westside"
},
{
"id": 14,
"email": "username3@your-org.com",
"identifier": "AB123",
"enabled": true,
"date_person_created": "2023-06-01T12:50:42Z",
"date_photo_created": "2023-06-01T12:51:17Z",
"First_Name": "Bob",
"Last_Name": "Ross",
"Campus": "PBS"
}
...
] |
Example CSV Response (with accept: text/csv request header)
| Code Block |
|---|
id,email,identifier,enabled,date_person_created,date_photo_created,First_Name,Last_Name,Campus
3,username@your-org.com,123456,true,2023-06-01T12:50:42Z,2023-06-01T12:51:17Z,John,Doe,Eastside
42,username2@your-org.com,234567,false,2023-04-06T12:50:42Z,2023-05-01T12:51:17Z,Jane,Doe,Westside
14,username3@your-org.com,AB123,true,2023-06-01T12:50:42Z,2023-06-01T12:51:17Z,Bob,Ross,PBS |