Get a Person

Owned by Jonathan Hoffman
Last updated: Jun 27, 2023 by Tony Erskine
12 min read



This Example Project demonstrates how to consume this API endpoint within a C# project.

 

URI: https://api.cloudcard.us/person/{id}

           Example URI: https://api.cloudcard.us/person/123 
           Example URI: https://api.cloudcard.us/person/jon.doe@foo.edu?findBy=email
           Example URI: https://api.cloudcard.us/person/A1234567?findBy=identifier

Optional URL Parameters: findBy=[id|email|identifier] (default id). Note, findBy must be used when querying email/identifier


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, "organization": { "id": 100133, "isPaid": true, "downloadLabel": "Download Photos", "allowAutoCrop": false, "logoutUrl": "", "allowAutoRotate": false, "allowAutoDenial": false, "allowDeprecatedEndpoints": false, "maxNumberOfInvitations": 0, "photoDimensions": { "id": 6, "width": 300, "height": 300, "description": "300:300 (1:1)", "domainClass": "us.cloudcard.api.PhotoDimensions", "version": 0, "value": 1.0, "longSide": 300, "shortSide": 300 }, "name": "Postman Test", "badPhotoThreshold": 0.4, "helpScoutBeacons": [], "allowAutoBackgroundReplacement": false, "sendEmailFrom": "Online Photo Submission <sent.from.customer@onlinephotosubmission.com>", "identifier": null, "emailReplyTo": null, "approvalsPerDay": 10, "expirationDate": null, "backgroundColor": null, "parent": null, "allowAutoApproval": false, "termsOfService": null, "siteURL": "", "autoArchiveAction": null, "daysBetweenInvitations": 14, "lastUpdated": "2022-01-31T18:17:29Z", "backgroundImage": null, "sendAutomaticFeedback": false, "usePersonIdentifier": true, "emailDomains": [], "autoArchiveStatus": null, "additionalPhotoTypes": [], "defaultGroup": { "id": 108, "organization": { "id": 100133 }, "receivableEmails": ",empty", "name": "Default", "domainClass": "us.cloudcard.api.EmailGroup", "version": 0 }, "goodPhotoThreshold": 0.8, "personIdentifierLabel": "ID Number", "preventMultiplePhotos": false, "customCssUrl": "", "useEmailAsUsername": true, "helperBotDelay": 600000, "downloadStrategy": { "id": "ZIP", "name": "Zip File" }, "approvalsMadeToday": 0, "backgroundReplacementEnabled": false, "canApproveMorePhotosToday": true, "customFields": [], "photoRequirements": [ { "id": 100851, "listIndex": 0, "lastUpdated": "2019-04-26T20:30:09Z", "organization": { "id": 100133 }, "uniqueName": "Crop", "classifierUrl": null, "hidden": false, "requirement": "Should be cropped slightly above head to middle of chest", "version": 0, "domainClass": "us.cloudcard.api.PhotoRequirement" }, { "id": 100852, "listIndex": 1, "lastUpdated": "2019-04-26T20:30:09Z", "organization": { "id": 100133 }, "uniqueName": "Plain Background", "classifierUrl": null, "hidden": false, "requirement": "Should be taken against a plain, light background", "version": 0, "domainClass": "us.cloudcard.api.PhotoRequirement" }, { "id": 100853, "listIndex": 2, "lastUpdated": "2019-04-26T20:30:09Z", "organization": { "id": 100133 }, "uniqueName": "Color Photo", "classifierUrl": null, "hidden": false, "requirement": "Must be a color photo", "version": 0, "domainClass": "us.cloudcard.api.PhotoRequirement" }, { "id": 100854, "listIndex": 3, "lastUpdated": "2019-04-26T20:30:09Z", "organization": { "id": 100133 }, "uniqueName": "No Accessories", "classifierUrl": null, "hidden": false, "requirement": "Must not include sunglasses or hat", "version": 0, "domainClass": "us.cloudcard.api.PhotoRequirement" }, { "id": 100855, "listIndex": 4, "lastUpdated": "2019-04-26T20:30:09Z", "organization": { "id": 100133 }, "uniqueName": "Face Camera", "classifierUrl": null, "hidden": false, "requirement": "Must be positioned directly facing the camera", "version": 0, "domainClass": "us.cloudcard.api.PhotoRequirement" }, { "id": 100856, "listIndex": 5, "lastUpdated": "2019-04-26T20:30:09Z", "organization": { "id": 100133 }, "uniqueName": "Look At Camera", "classifierUrl": null, "hidden": false, "requirement": "Eyes should be open and looking at the camera", "version": 0, "domainClass": "us.cloudcard.api.PhotoRequirement" }, { "id": 100857, "listIndex": 6, "lastUpdated": "2019-04-26T20:30:09Z", "organization": { "id": 100133 }, "uniqueName": "Generic", "classifierUrl": "https://helper-bot.onlinephotosubmission.com/generic", "hidden": true, "requirement": "Must be a good photo", "version": 0, "domainClass": "us.cloudcard.api.PhotoRequirement" } ] }, "preArchiveEmail": null, "accountExpired": false, "dateArchived": null, "unsubscribe": false, "identifier": "12345600", "emailGroup": { "id": 108, "organization": { "id": 100133 }, "receivableEmails": ",empty", "name": "Default", "domainClass": "us.cloudcard.api.EmailGroup", "version": 0 }, "preArchiveIdentifier": null, "dateTermsAccepted": null, "passwordExpired": false, "lastUpdated": "2022-01-31T18:16:49Z", "additionalPhotoRequired": true, "quicksightArn": null, "preArchiveUsername": null, "username": "api_example@cloudcard.us", "accountLocked": false, "activatedDate": null, "enabled": true, "email": "api_example@cloudcard.us", "domainClass": "us.cloudcard.api.Person", "authorities": [ { "id": 3, "authority": "ROLE_CARDHOLDER", "domainClass": "us.cloudcard.api.Role", "version": 0 } ], "canViewOrganizationList": false, "canSwitchOrganizations": false, "customFields": {}, "homeOrganization": { "id": 100133, "hasDescendents": false, "descendents": [] }, "links": null, "email": "api_example@cloudcard.us", "identifier": "12345600", "username": "api_example@cloudcard.us", "readOnly": false, "restorable": false, "status": "ACTIVE", "additionalPhotos": {}, "currentPhoto": { "id": 3678, "dateCreated": "2023-06-26T15:01:12Z", "upVotes": 0, "width": 600, "dateApproved": null, "externalURL": "https://s3-ca-central-1.amazonaws.com/photos.cloudcard/000002.23.177.F02ug3PUI9Fns3ca4MhQ8I3lIUETI8rQRTUQHU30hhfSe4n52va5u4lB58RBFc7OoSr9Jr21VjPQM4ji.jpg", "lastUpdated": "2023-06-26T15:01:12Z", "helperBotReviewed": false, "aspectRatio": 1.0, "height": 600, "backgroundReplaced": false, "downVotes": 0, "automaticallyApprovedOrDenied": false, "publicKey": "000002.23.177.F02ug3PUI9Fns3ca4MhQ8I3lIUETI8rQ52va5u4lB58RBFc7OoRTUQSr9Jr21HU30hhfSe4nVjPQM4ji", "manuallyEdited": false, "status": "PENDING", "domainClass": "us.cloudcard.api.Photo", "person": {...removed for brevity...}, "classifications": [], "lowestClassification": null, "isAspectRatioCorrect": true, "links": { "bytes": "https://s3-ca-central-1.amazonaws.com/photos.cloudcard/000002.23.177.F02ug3PUI9Fns3ca4MhQ8I3lIUETI8rQRTUQHU30hhfSe4n52va5u4lB58RBFc7OoSr9Jr21VjPQM4ji.jpg" }, "originalPhoto": null, "personHasApprovedPhoto": false, "version": 0, "onHoldReasons": [] }, "helpScoutBeacon": null, "previouslyApprovedPhoto": null }