List People

URI: https://api.cloudcard.us/person

Optional URL Parameters:

max=[0...1000]

{Custom Field Name}={Custom Field Value}
This parameter allows you to filter the results to people who have a matching custom field value
Example: /person?Campus=Downtown

HTTP Method: GET

Required Headers: X-Auth-Token (see: Authentication)

Example HTTP Request Body

(LEAVE REQUEST BODY EMPTY)

Example Response

200 OK

[
    {
        "id": 577782,
        "dateCreated": "2022-01-31T18:16:40Z",
        "passwordResetRequired": false,
        "preArchiveEmail": null,
        "accountExpired": false,
        "dateArchived": null,
        "unsubscribe": false,
        "identifier": "12345600",
        "emailGroup": {
            "id": 108
        },
        "preArchiveIdentifier": null,
        "dateTermsAccepted": null,
        "passwordExpired": false,
        "lastUpdated": "2022-01-31T18:16:49Z",
        "additionalPhotoRequired": true,
        "quicksightArn": null,
        "homeOrganization": {
            "id": 100133
        },
        "preArchiveUsername": null,
        "username": "api_example@cloudcard.us",
        "accountLocked": false,
        "activatedDate": null,
        "enabled": true,
        "email": "api_example@cloudcard.us",
        "domainClass": "us.cloudcard.api.Person",
        "version": 1,
        "authorities": [
            "ROLE_CARDHOLDER"
        ],
        "customFields": {
			"Campus": "Home"
		},
        "organization": {
            "id": 100133,
            "name": "Postman Test"
        }
    },
    {
        "id": 577783,
        "dateCreated": "2022-01-31T18:18:36Z",
        "passwordResetRequired": false,
        "preArchiveEmail": null,
        "accountExpired": false,
        "dateArchived": null,
        "unsubscribe": false,
        "identifier": null,
        "emailGroup": {
            "id": 108
        },
        "preArchiveIdentifier": null,
        "dateTermsAccepted": null,
        "passwordExpired": false,
        "lastUpdated": "2022-01-31T18:19:13Z",
        "additionalPhotoRequired": true,
        "quicksightArn": null,
        "homeOrganization": {
            "id": 100133
        },
        "preArchiveUsername": null,
        "username": "apiTest+postman@cloudcard.us",
        "accountLocked": false,
        "activatedDate": null,
        "enabled": true,
        "email": "apiTest+postman@cloudcard.us",
        "domainClass": "us.cloudcard.api.Person",
        "version": 3,
        "authorities": [
            "ROLE_OFFICE",
            "ROLE_CARDHOLDER",
            "ROLE_DIRECTOR",
            "ROLE_EMAIL_EDITOR"
        ],
        "customFields": {
			"Campus": "Home"
		},
        "organization": {
            "id": 100133,
            "name": "Postman Test"
        }
    }
]