Turtle profiles
List turtle profiles
Search and filter your organization’s turtle profiles. Each profile includes identity photos and a sighting summary.
/api/integration/v1/individualsAuthentication
X-API-Key required header
The organization’s active integration key.
Set up accessParameters
qstring | nullquery · optional- Search text for turtle profiles.
speciesarray of TurtleSpecies | nullquery · optional- A turtle species. Repeat the query parameter to select multiple species.Values hawksbill, green, loggerhead, leatherback, olive_ridley, unknown
conditionHealthStatus | nullquery · optional- Filter profiles by condition.Values unknown, healthy, scarred, injured
sortstringquery · optional- Use name or last_seen_desc.Default "name"
limitintegerquery · optional- Maximum number of records to return.Minimum 1 · Maximum 200 · Default 50
offsetintegerquery · optional- Number of records to skip.Minimum 0 · Default 0
Responses
200Successful Response
application/jsonPage[TurtleProfile]
itemsarray of TurtleProfilerequiredShow fields
idstring · uuidrequiredprofile_codestringrequirednamestringrequiredspeciesTurtleSpeciesrequiredValues hawksbill, green, loggerhead, leatherback, olive_ridley, unknown
sexTurtleSexrequiredValues male, female, unknown
identity_photosIdentityPhotosrequiredShow fields
leftPhoto | nullrequiredShow fields
idstring · uuidrequiredurlstringrequireddownload_urlstring | nullrequiredexpires_atstring · date-time | nullrequiredcaptured_atstring · date-time | nullrequireduploaded_atstring · date-timerequired
rightPhoto | nullrequiredShow fields
idstring · uuidrequiredurlstringrequireddownload_urlstring | nullrequiredexpires_atstring · date-time | nullrequiredcaptured_atstring · date-time | nullrequireduploaded_atstring · date-timerequired
summaryTurtleSummaryrequiredShow fields
total_sightingsintegerrequiredlatest_sightingSightingPreview | nullrequiredShow fields
idstring · uuidrequiredobserved_atstring · date-timerequiredeventSightingEvent | NestingEvent | FalseCrawlEvent | StrandedEvent | DeceasedEvent | OtherEventrequiredShow variants
SightingEvent
typesightingrequired
NestingEvent
typenestingrequiredegg_countinteger | nullrequiredMinimum 0
FalseCrawlEvent
typefalse_crawlrequired
StrandedEvent
typestrandedrequiredis_injuredboolean | nullrequired
DeceasedEvent
typedeceasedrequiredsuspected_causestring | nullrequired
OtherEvent
typeotherrequireddescriptionstringrequired
locationLocationrequiredShow fields
namestringrequiredcoordinatesCoordinates | nullrequiredShow fields
latitudenumberrequiredMinimum -90 · Maximum 90
longitudenumberrequiredMinimum -180 · Maximum 180
conditionCondition | nullrequiredShow fields
statusBodyCondition | nullrequiredValues healthy, scarred, injured
notesstring | nullrequiredmarkingsarray of MarkingrequiredShow fields
idstring · uuidrequiredregionBodyRegionrequiredValues head, carapace, front_flipper_left, front_flipper_right, rear_flipper_left, rear_flipper_right, tail
kindMarkingKindrequiredValues scratch, wound, missing_limb, deformity, barnacles, fibropapilloma, tag_scar, other
severitySeverityrequiredValues minor, moderate, severe
notesstring | nullrequiredis_permanentbooleanrequiredcreated_atstring · date-timerequiredupdated_atstring · date-timerequired
last_recorded_conditionRecordedCondition | nullrequiredShow fields
log_idstring · uuidrequiredobserved_atstring · date-timerequiredstatusBodyConditionrequiredValues healthy, scarred, injured
latest_measurementsRecordedMeasurements | nullrequiredShow fields
log_idstring · uuidrequiredobserved_atstring · date-timerequiredvaluesMeasurementsrequiredShow fields
carapace_length_cmnumber | nullrequiredcarapace_width_cmnumber | nullrequiredweight_kgnumber | nullrequired
first_seen_atstring · date-timerequiredcreated_atstring · date-timerequiredupdated_atstring · date-timerequired
totalintegerrequiredlimitintegerrequiredoffsetintegerrequired
401Missing, invalid, expired, or revoked authentication credentials
application/jsonApiErrorOut
detailstring | array of ValidationIssueOut | objectrequiredShow fields
locarray of string | integerrequiredmsgstringrequiredtypestringrequired
codestring | null
WWW-Authenticate · Authentication challenge for the required credential scheme
422Invalid fields, body, image, or current password
application/jsonApiErrorOut
detailstring | array of ValidationIssueOut | objectrequiredShow fields
locarray of string | integerrequiredmsgstringrequiredtypestringrequired
codestring | null
429Request quota exceeded; wait according to Retry-After
application/jsonApiErrorOut
detailstring | array of ValidationIssueOut | objectrequiredShow fields
locarray of string | integerrequiredmsgstringrequiredtypestringrequired
codestring | null
Retry-After · Advised delay in seconds (currently fixed at 60)
500Unexpected server error; internal details are withheld
application/jsonApiErrorOut
detailstring | array of ValidationIssueOut | objectrequiredShow fields
locarray of string | integerrequiredmsgstringrequiredtypestringrequired
codestring | null