Skip to content

Turtle profiles

List turtle profiles

Search and filter your organization’s turtle profiles. Each profile includes identity photos and a sighting summary.

GET/api/integration/v1/individuals
View examples

Authentication

X-API-Key required header

The organization’s active integration key.

Set up access

Parameters

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 TurtleProfilerequired
    Show fields
    • idstring · uuidrequired
    • profile_codestringrequired
    • namestringrequired
    • speciesTurtleSpeciesrequired

      Values hawksbill, green, loggerhead, leatherback, olive_ridley, unknown

    • sexTurtleSexrequired

      Values male, female, unknown

    • identity_photosIdentityPhotosrequired
      Show fields
      • leftPhoto | nullrequired
        Show fields
        • idstring · uuidrequired
        • urlstringrequired
        • download_urlstring | nullrequired
        • expires_atstring · date-time | nullrequired
        • captured_atstring · date-time | nullrequired
        • uploaded_atstring · date-timerequired
      • rightPhoto | nullrequired
        Show fields
        • idstring · uuidrequired
        • urlstringrequired
        • download_urlstring | nullrequired
        • expires_atstring · date-time | nullrequired
        • captured_atstring · date-time | nullrequired
        • uploaded_atstring · date-timerequired
    • summaryTurtleSummaryrequired
      Show fields
      • total_sightingsintegerrequired
      • latest_sightingSightingPreview | nullrequired
        Show fields
        • idstring · uuidrequired
        • observed_atstring · date-timerequired
        • eventSightingEvent | NestingEvent | FalseCrawlEvent | StrandedEvent | DeceasedEvent | OtherEventrequired
          Show variants

          SightingEvent

          • typesightingrequired

          NestingEvent

          • typenestingrequired
          • egg_countinteger | nullrequired

            Minimum 0

          FalseCrawlEvent

          • typefalse_crawlrequired

          StrandedEvent

          • typestrandedrequired
          • is_injuredboolean | nullrequired

          DeceasedEvent

          • typedeceasedrequired
          • suspected_causestring | nullrequired

          OtherEvent

          • typeotherrequired
          • descriptionstringrequired
        • locationLocationrequired
          Show fields
          • namestringrequired
          • coordinatesCoordinates | nullrequired
            Show fields
            • latitudenumberrequired

              Minimum -90 · Maximum 90

            • longitudenumberrequired

              Minimum -180 · Maximum 180

        • conditionCondition | nullrequired
          Show fields
          • statusBodyCondition | nullrequired

            Values healthy, scarred, injured

          • notesstring | nullrequired
          • markingsarray of Markingrequired
            Show fields
            • idstring · uuidrequired
            • regionBodyRegionrequired

              Values head, carapace, front_flipper_left, front_flipper_right, rear_flipper_left, rear_flipper_right, tail

            • kindMarkingKindrequired

              Values scratch, wound, missing_limb, deformity, barnacles, fibropapilloma, tag_scar, other

            • severitySeverityrequired

              Values minor, moderate, severe

            • notesstring | nullrequired
            • is_permanentbooleanrequired
            • created_atstring · date-timerequired
            • updated_atstring · date-timerequired
      • last_recorded_conditionRecordedCondition | nullrequired
        Show fields
        • log_idstring · uuidrequired
        • observed_atstring · date-timerequired
        • statusBodyConditionrequired

          Values healthy, scarred, injured

      • latest_measurementsRecordedMeasurements | nullrequired
        Show fields
        • log_idstring · uuidrequired
        • observed_atstring · date-timerequired
        • valuesMeasurementsrequired
          Show fields
          • carapace_length_cmnumber | nullrequired
          • carapace_width_cmnumber | nullrequired
          • weight_kgnumber | nullrequired
    • first_seen_atstring · date-timerequired
    • created_atstring · date-timerequired
    • updated_atstring · date-timerequired
  • totalintegerrequired
  • limitintegerrequired
  • offsetintegerrequired
401Missing, invalid, expired, or revoked authentication credentials

application/jsonApiErrorOut

  • detailstring | array of ValidationIssueOut | objectrequired
    Show fields
    • locarray of string | integerrequired
    • msgstringrequired
    • typestringrequired
  • codestring | null

WWW-Authenticate · Authentication challenge for the required credential scheme

422Invalid fields, body, image, or current password

application/jsonApiErrorOut

  • detailstring | array of ValidationIssueOut | objectrequired
    Show fields
    • locarray of string | integerrequired
    • msgstringrequired
    • typestringrequired
  • codestring | null
429Request quota exceeded; wait according to Retry-After

application/jsonApiErrorOut

  • detailstring | array of ValidationIssueOut | objectrequired
    Show fields
    • locarray of string | integerrequired
    • msgstringrequired
    • typestringrequired
  • 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 | objectrequired
    Show fields
    • locarray of string | integerrequired
    • msgstringrequired
    • typestringrequired
  • codestring | null