Artifacts

Get Artifact Results

GET
/api/artifact/{internal_artifact_id}

Retrieve the results of a previously submitted artifact check. You can look up an artifact either by its internal ID path or by your external ID query.

Route Shapes

Use one of these routes:

RouteUse when
GET /api/artifact/{internal_artifact_id}You have the system-generated Artifact ID from a previous response
GET /api/artifact?external_artifact_id=...You want the latest Artifact version for your external ID

environment_id remains optional on both routes. If you omit it, White Circle uses the Environment associated with your API key. The legacy deployment_id parameter is deprecated but still accepted as a predecessor of environment_id.

Authorizations

  • Authorizationstringheaderrequired

    API Key required. Format: Bearer wc-your-api-key

Headers

  • whitecircle-versionstringrequired

    API Version

    Example: "2026-04-15"

Path Parameters

  • internal_artifact_idstringrequired

    Find an artifact by its internal artifact ID

Query Parameters

  • deployment_idstring

    Optional deployment ID to validate artifact ownership

Response

application/json

Success

  • policiesobjectrequired

    Show child attributes
    • policies.{key}object

      Show child attributes
      • policies.{key}.flaggedbooleanrequired

      • policies.{key}.flagged_sourcestring[]required

      • policies.{key}.namestringrequired

  • kindstringrequired

  • statusstringrequired

  • internal_artifact_idstringrequired

  • flaggedboolean | null

  • updated_atstring | null

  • external_artifact_idstring | null

  • external_session_idstring | null

  • internal_session_idstring | null

  • created_atstring | null

  • notestring | null