---
title: List cookies from a Website Audit
description: Bounded page of cookies including evidence and attributes.
  available=false means results are unavailable. Includes coverage and
  dataQuality. Requires projects.read and website-audit.read.
type: api-reference
source: ./openapi/inth-api.json
method: get
path: /v1/website-audit/scans/{scanId}/cookies
operationId: listWebsiteScanCookies
server: https://api.inth.com
apiVersion: 1.0.0
tags:
  - Website Audit
canonicalUrl: https://inth.com/docs/rest-api/website-audit/list-website-scan-cookies
lastModified: "2026-10-30T13:05:44.605Z"
---
```http
GET /v1/website-audit/scans/{scanId}/cookies
```

Server: `https://api.inth.com`

Operation ID: `listWebsiteScanCookies`

## Authentication

* bearerAuth

### Schemes

* bearerAuth: http / bearer - Use an Inth API key or OAuth access token in the Authorization header.

  Product operations need a capability. Feedback intake only requires authentication. An OAuth access token carries the capabilities it was granted as scopes; an organization API key carries a fixed set (\`organizations.read\`, \`projects.read\`, \`projects.write\`, \`api-keys.read\`, \`inbox.read\`, \`billing.read\`), so writes that name the person who made them, such as \`inbox.write\` and \`vendors.write\`, need a user token. A credential without the capability an operation needs is answered with \`403 INSUFFICIENT\_SCOPE\`. \`GET /v1/me\` reports the capabilities of the calling credential.

  OAuth scopes:
  - \`organizations.read\`: List the organizations you belong to.
  - \`organizations.write\`: Create organizations you will own.
  - \`projects.read\`: Read projects, their consent configuration, and the vendors seen on them.
  - \`projects.write\`: Create, update, and delete projects and their consent configuration.
  - \`members.read\`: Read member names, email addresses, profile images, roles, and pending invitation email addresses.
  - \`members.write\`: Invite members, change member roles, remove members, and cancel invitations.
  - \`api-keys.read\`: List organization API keys.
  - \`api-keys.write\`: Create, roll, and delete organization API keys.
  - \`code-audit.read\`: Read Code Audit scans, their findings, and connected repositories.
  - \`code-audit.write\`: Start Code Audit scans and unlock their reports.
  - \`inbox.read\`: Read Inbox findings.
  - \`inbox.write\`: Change Inbox status or assignment and open GitHub issues for findings.
  - \`vendors.write\`: Approve or ignore vendors detected on your projects, which resolves their Inbox findings.
  - \`billing.read\`: Read the plan and credit balance of an organization.
  - \`billing.details.read\`: Read invoices, billing profiles, and payment method summaries for organizations you own.
  - \`consent.read\`: Read consent records, analytics, configuration, and runtime status.
  - \`consent.write\`: Update consent settings, translations, IAB configuration, and policies.
  - \`consent.keys.read\`: Read consent runtime key metadata. Secret values are never returned.
  - \`website-audit.read\`: Read website audit targets, scans, reports, cookies, and evidence.
  - \`website-audit.write\`: Manage website audit targets, verify domains, review findings, and start scans.
  - \`account.read\`: Read your account profile.
  - \`notifications.read\`: Read your notification preferences and organization routing.
  - \`organization-retention.read\`: Read organization provider data retention policy.
  - \`support.read\`: Read support conversations you own or can access through sharing.
  - \`support.write\`: Create support conversations, send messages, share or close them, and upload support attachments.
  - \`consent.lifecycle.write\`: Update, upgrade or delete Consent runtimes.
  - \`consent.keys.write\`: Create, rotate and revoke Consent runtime keys.
  - \`billing.write\`: Preview and change plans, buy credits, manage billing details and subscriptions, and open hosted payment flows.
  - \`account.security.read\`: Read your active browser sessions and connected device grants.
  - \`account.security.write\`: Revoke your browser sessions and connected device grants.
  - \`integrations.read\`: Read connected integration accounts, repositories, provider properties and project links.
  - \`integrations.write\`: Connect and sync providers, manage repository settings, project links and paid pull request monitoring.
  - \`account.write\`: Update your name, avatar and PII masking preference.
  - \`account.delete\`: Permanently delete your account after ownership checks and confirmation.
  - \`notifications.write\`: Update your notification preferences.
  - \`notifications.routing.write\`: Manage organization notification routing.
  - \`organization-retention.write\`: Change organization provider data retention policy.
  - \`organizations.settings.write\`: Update organization name, logo and slug.
  - \`organizations.delete\`: Permanently delete organizations you own after confirmation.
  - \`agents.read\`: Read your Inth Agent chats and chats shared with your organization.
  - \`agents.write\`: Start Inth Agent chats, send messages, share your chats with the organization, and delete your chats. Agent replies use organization credits.

## Request

### Path Parameters

|Name|Type|Required|Description|
|:--|:--|:--|:--|
|`scanId`|string|required||

### Query Parameters

|Name|Type|Required|Description|
|:--|:--|:--|:--|
|`limit`|integer|optional||
|`cursor`|string|optional|Opaque cursor returned by this operation with these same filters.|

## Code Examples

### cURL

```bash
curl -X GET "https://api.inth.com/v1/website-audit/scans/{scanId}/cookies" \
  -H "Authorization: Bearer <token>"
```

### JavaScript

```ts
const response = await fetch("https://api.inth.com/v1/website-audit/scans/{scanId}/cookies", {
  method: "GET",
  headers: {
    "Authorization": "Bearer <token>"
  },
});
const data = await response.json();
```

## Responses

### 200

Success

Content type: application/json

|Property|Type|Required|Description|
|:--|:--|:--|:--|
|`success`|unknown|required||
|`data`|object|required||
|`data.items`|object\[]|required||
|`data.items[].conditions`|object\[]|required||
|`data.items[].conditions[].consentScenario`|"pre\_consent" \|"pre\_consent\_gpc" \|"accept\_all" \|"reject\_all" \|"accept\_measurement\_only" \|"accept\_marketing\_only"|required||
|`data.items[].conditions[].key`|string|required||
|`data.items[].conditions[].regionProfile`|"uk\_gdpr" \|"eu\_eea\_gdpr" \|"us\_ca\_cpra" \|"us\_tx\_baseline" \|"custom"|required||
|`data.items[].conditions[].runId`|string|required||
|`data.items[].evidence`|object\[]|required||
|`data.items[].evidence[].evidenceId`|string \|null|required||
|`data.items[].evidence[].key`|string|required||
|`data.items[].evidence[].kind`|"script" \|"cookie" \|"storage" \|"network" \|"global\_object" \|"package" \|"iframe" \|"header"|required||
|`data.items[].evidence[].observationId`|string|required||
|`data.items[].evidence[].observedAt`|string|required||
|`data.items[].evidence[].pagePath`|string \|null|required||
|`data.items[].evidence[].runId`|string|required||
|`data.items[].evidence[].url`|string \|null|required||
|`data.items[].evidence[].value`|string \|null|required||
|`data.items[].evidenceIds`|string\[]|required||
|`data.items[].lastSeenAt`|string|required||
|`data.items[].observationCount`|integer|required||
|`data.items[].pagePaths`|string\[]|required||
|`data.items[].attributes`|object|required||
|`data.items[].attributes.expiresAt`|string \|"varies" \|null|required||
|`data.items[].attributes.httpOnly`|boolean \|"varies" \|null|required||
|`data.items[].attributes.lifetime`|string \|"varies" \|null|required||
|`data.items[].attributes.sameSite`|string \|"varies" \|null|required||
|`data.items[].attributes.secure`|boolean \|"varies" \|null|required||
|`data.items[].attributes.session`|boolean \|"varies" \|null|required||
|`data.items[].domain`|string \|null|required||
|`data.items[].id`|string|required||
|`data.items[].name`|string|required||
|`data.items[].party`|"first\_party" \|"third\_party" \|"unknown"|required||
|`data.items[].path`|string \|null|required||
|`data.items[].vendors`|object\[]|required||
|`data.items[].vendors[].name`|string|required||
|`data.items[].vendors[].projectVendorId`|string \|null|required||
|`data.items[].vendors[].reviewState`|"accepted" \|"suggested" \|"rejected" \|"needs\_review"|required||
|`data.items[].vendors[].vendorId`|string|required||
|`data.available`|boolean|required||
|`data.nextCursor`|string \|null|required||
|`data.hasMore`|boolean|required||
|`data.coverage`|object \|null|required||
|`data.dataQuality`|object \|null|required||

Example:

```json
{
  "success": {},
  "data": {
    "items": [
      {
        "conditions": [
          {
            "consentScenario": "pre_consent",
            "key": "string",
            "regionProfile": "uk_gdpr",
            "runId": "string"
          }
        ],
        "evidence": [
          {
            "evidenceId": "string",
            "key": "string",
            "kind": "script",
            "observationId": "string",
            "observedAt": "string",
            "pagePath": "string",
            "runId": "string",
            "url": "string",
            "value": "string"
          }
        ],
        "evidenceIds": [
          "string"
        ],
        "lastSeenAt": "string",
        "observationCount": 0,
        "pagePaths": [
          "string"
        ],
        "attributes": {
          "expiresAt": "string",
          "httpOnly": true,
          "lifetime": "string",
          "sameSite": "string",
          "secure": true,
          "session": true
        },
        "domain": "string",
        "id": "string",
        "name": "string",
        "party": "first_party",
        "path": "string",
        "vendors": [
          {
            "name": "string",
            "projectVendorId": "string",
            "reviewState": "accepted",
            "vendorId": "string"
          }
        ]
      }
    ],
    "available": true,
    "nextCursor": "string",
    "hasMore": true,
    "coverage": {},
    "dataQuality": {}
  }
}
```

JSON Schema:

```json
{
  "type": "object",
  "required": [
    "success",
    "data"
  ],
  "properties": {
    "success": {
      "const": true
    },
    "data": {
      "type": "object",
      "properties": {
        "items": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "conditions": {
                "type": "array",
                "items": {
                  "type": "object",
                  "properties": {
                    "consentScenario": {
                      "type": "string",
                      "enum": [
                        "pre_consent",
                        "pre_consent_gpc",
                        "accept_all",
                        "reject_all",
                        "accept_measurement_only",
                        "accept_marketing_only"
                      ]
                    },
                    "key": {
                      "type": "string"
                    },
                    "regionProfile": {
                      "type": "string",
                      "enum": [
                        "uk_gdpr",
                        "eu_eea_gdpr",
                        "us_ca_cpra",
                        "us_tx_baseline",
                        "custom"
                      ]
                    },
                    "runId": {
                      "type": "string"
                    }
                  },
                  "required": [
                    "consentScenario",
                    "key",
                    "regionProfile",
                    "runId"
                  ],
                  "additionalProperties": false
                }
              },
              "evidence": {
                "type": "array",
                "items": {
                  "type": "object",
                  "properties": {
                    "evidenceId": {
                      "anyOf": [
                        {
                          "type": "string"
                        },
                        {
                          "type": "null"
                        }
                      ]
                    },
                    "key": {
                      "type": "string"
                    },
                    "kind": {
                      "type": "string",
                      "enum": [
                        "script",
                        "cookie",
                        "storage",
                        "network",
                        "global_object",
                        "package",
                        "iframe",
                        "header"
                      ]
                    },
                    "observationId": {
                      "type": "string"
                    },
                    "observedAt": {
                      "type": "string"
                    },
                    "pagePath": {
                      "anyOf": [
                        {
                          "type": "string"
                        },
                        {
                          "type": "null"
                        }
                      ]
                    },
                    "runId": {
                      "type": "string"
                    },
                    "url": {
                      "anyOf": [
                        {
                          "type": "string"
                        },
                        {
                          "type": "null"
                        }
                      ]
                    },
                    "value": {
                      "anyOf": [
                        {
                          "type": "string"
                        },
                        {
                          "type": "null"
                        }
                      ]
                    }
                  },
                  "required": [
                    "evidenceId",
                    "key",
                    "kind",
                    "observationId",
                    "observedAt",
                    "pagePath",
                    "runId",
                    "url",
                    "value"
                  ],
                  "additionalProperties": false
                }
              },
              "evidenceIds": {
                "type": "array",
                "items": {
                  "type": "string"
                }
              },
              "lastSeenAt": {
                "type": "string"
              },
              "observationCount": {
                "type": "integer",
                "minimum": 0
              },
              "pagePaths": {
                "type": "array",
                "items": {
                  "type": "string"
                }
              },
              "attributes": {
                "type": "object",
                "properties": {
                  "expiresAt": {
                    "anyOf": [
                      {
                        "type": "string"
                      },
                      {
                        "type": "string",
                        "enum": [
                          "varies"
                        ]
                      },
                      {
                        "type": "null"
                      }
                    ]
                  },
                  "httpOnly": {
                    "anyOf": [
                      {
                        "type": "boolean"
                      },
                      {
                        "type": "string",
                        "enum": [
                          "varies"
                        ]
                      },
                      {
                        "type": "null"
                      }
                    ]
                  },
                  "lifetime": {
                    "anyOf": [
                      {
                        "type": "string"
                      },
                      {
                        "type": "string",
                        "enum": [
                          "varies"
                        ]
                      },
                      {
                        "type": "null"
                      }
                    ]
                  },
                  "sameSite": {
                    "anyOf": [
                      {
                        "type": "string"
                      },
                      {
                        "type": "string",
                        "enum": [
                          "varies"
                        ]
                      },
                      {
                        "type": "null"
                      }
                    ]
                  },
                  "secure": {
                    "anyOf": [
                      {
                        "type": "boolean"
                      },
                      {
                        "type": "string",
                        "enum": [
                          "varies"
                        ]
                      },
                      {
                        "type": "null"
                      }
                    ]
                  },
                  "session": {
                    "anyOf": [
                      {
                        "type": "boolean"
                      },
                      {
                        "type": "string",
                        "enum": [
                          "varies"
                        ]
                      },
                      {
                        "type": "null"
                      }
                    ]
                  }
                },
                "required": [
                  "expiresAt",
                  "httpOnly",
                  "lifetime",
                  "sameSite",
                  "secure",
                  "session"
                ],
                "additionalProperties": false
              },
              "domain": {
                "anyOf": [
                  {
                    "type": "string"
                  },
                  {
                    "type": "null"
                  }
                ]
              },
              "id": {
                "type": "string"
              },
              "name": {
                "type": "string"
              },
              "party": {
                "type": "string",
                "enum": [
                  "first_party",
                  "third_party",
                  "unknown"
                ]
              },
              "path": {
                "anyOf": [
                  {
                    "type": "string"
                  },
                  {
                    "type": "null"
                  }
                ]
              },
              "vendors": {
                "type": "array",
                "items": {
                  "type": "object",
                  "properties": {
                    "name": {
                      "type": "string"
                    },
                    "projectVendorId": {
                      "anyOf": [
                        {
                          "type": "string"
                        },
                        {
                          "type": "null"
                        }
                      ]
                    },
                    "reviewState": {
                      "type": "string",
                      "enum": [
                        "accepted",
                        "suggested",
                        "rejected",
                        "needs_review"
                      ]
                    },
                    "vendorId": {
                      "type": "string"
                    }
                  },
                  "required": [
                    "name",
                    "projectVendorId",
                    "reviewState",
                    "vendorId"
                  ],
                  "additionalProperties": false
                }
              }
            },
            "required": [
              "conditions",
              "evidence",
              "evidenceIds",
              "lastSeenAt",
              "observationCount",
              "pagePaths",
              "attributes",
              "domain",
              "id",
              "name",
              "party",
              "path",
              "vendors"
            ],
            "additionalProperties": false
          }
        },
        "available": {
          "type": "boolean"
        },
        "nextCursor": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ]
        },
        "hasMore": {
          "type": "boolean"
        },
        "coverage": {
          "anyOf": [
            {
              "type": "object",
              "properties": {
                "absenceClaimEligible": {
                  "type": "boolean"
                },
                "attemptedPageCount": {
                  "type": "integer",
                  "minimum": 0
                },
                "completedConditionCount": {
                  "type": "integer",
                  "minimum": 0
                },
                "completedPageCount": {
                  "type": "integer",
                  "minimum": 0
                },
                "conditions": {
                  "type": "array",
                  "items": {
                    "type": "object",
                    "properties": {
                      "attemptedPageCount": {
                        "type": "integer",
                        "minimum": 0
                      },
                      "completedPageCount": {
                        "type": "integer",
                        "minimum": 0
                      },
                      "failedPageCount": {
                        "type": "integer",
                        "minimum": 0
                      },
                      "key": {
                        "type": "string"
                      },
                      "status": {
                        "type": "string",
                        "enum": [
                          "pending",
                          "completed",
                          "failed"
                        ]
                      }
                    },
                    "required": [
                      "attemptedPageCount",
                      "completedPageCount",
                      "failedPageCount",
                      "key",
                      "status"
                    ],
                    "additionalProperties": false
                  }
                },
                "failedPageCount": {
                  "type": "integer",
                  "minimum": 0
                },
                "pages": {
                  "type": "array",
                  "items": {
                    "type": "object",
                    "properties": {
                      "status": {
                        "type": "string",
                        "enum": [
                          "completed",
                          "partial",
                          "failed"
                        ]
                      },
                      "url": {
                        "type": "string"
                      }
                    },
                    "required": [
                      "status",
                      "url"
                    ],
                    "additionalProperties": false
                  }
                },
                "totalConditionCount": {
                  "type": "integer",
                  "minimum": 0
                }
              },
              "required": [
                "absenceClaimEligible",
                "attemptedPageCount",
                "completedConditionCount",
                "completedPageCount",
                "conditions",
                "failedPageCount",
                "totalConditionCount"
              ],
              "additionalProperties": false
            },
            {
              "type": "null"
            }
          ]
        },
        "dataQuality": {
          "anyOf": [
            {
              "type": "object",
              "properties": {
                "changes": {
                  "type": "string",
                  "enum": [
                    "frozen_at_completion",
                    "no_comparable_scan"
                  ]
                },
                "cookieAttributes": {
                  "type": "string",
                  "enum": [
                    "point_in_time_snapshot",
                    "legacy_unavailable"
                  ]
                }
              },
              "required": [
                "changes",
                "cookieAttributes"
              ],
              "additionalProperties": false
            },
            {
              "type": "null"
            }
          ]
        }
      },
      "required": [
        "items",
        "available",
        "nextCursor",
        "hasMore",
        "coverage",
        "dataQuality"
      ],
      "additionalProperties": false
    }
  }
}
```

### 400

The request payload or parameters are invalid.

Content type: application/json

|Property|Type|Required|Description|
|:--|:--|:--|:--|
|`success`|boolean|required||
|`error`|object|required||
|`error.code`|"UNAUTHORIZED" \|"FORBIDDEN" \|"INSUFFICIENT\_SCOPE" \|"PLAN\_LIMIT\_REACHED" \|"PLAN\_REQUIRED" \|"INVALID\_ORIGIN" \|"INVALID\_REGION" \|"INVALID\_PAYLOAD" \|"NOT\_FOUND" \|"CONFLICT" \|"KEY\_LIMIT\_REACHED" \|"INSUFFICIENT\_CREDITS" \|"SCAN\_IN\_PROGRESS" \|"UNLOCK\_REQUIRED" \|"REPOSITORY\_NOT\_LINKED" \|"PAYLOAD\_TOO\_LARGE" \|"RATE\_LIMITED" \|"SERVICE\_UNAVAILABLE" \|"INTERNAL\_ERROR"|required||
|`error.message`|string|required||
|`error.details`|unknown|optional|Optional structured error details.|

Example: default

```json
{
  "success": false,
  "error": {
    "code": "INVALID_PAYLOAD",
    "message": "Invalid request payload",
    "details": [
      {
        "code": "too_small",
        "message": "Too small: expected string to have >=1 characters",
        "path": [
          "name"
        ]
      }
    ]
  }
}
```

JSON Schema:

```json
{
  "type": "object",
  "required": [
    "success",
    "error"
  ],
  "properties": {
    "success": {
      "type": "boolean",
      "const": false
    },
    "error": {
      "type": "object",
      "required": [
        "code",
        "message"
      ],
      "properties": {
        "code": {
          "type": "string",
          "enum": [
            "UNAUTHORIZED",
            "FORBIDDEN",
            "INSUFFICIENT_SCOPE",
            "PLAN_LIMIT_REACHED",
            "PLAN_REQUIRED",
            "INVALID_ORIGIN",
            "INVALID_REGION",
            "INVALID_PAYLOAD",
            "NOT_FOUND",
            "CONFLICT",
            "KEY_LIMIT_REACHED",
            "INSUFFICIENT_CREDITS",
            "SCAN_IN_PROGRESS",
            "UNLOCK_REQUIRED",
            "REPOSITORY_NOT_LINKED",
            "PAYLOAD_TOO_LARGE",
            "RATE_LIMITED",
            "SERVICE_UNAVAILABLE",
            "INTERNAL_ERROR"
          ]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "description": "Optional structured error details."
        }
      }
    }
  }
}
```

### 401

Authentication is missing, invalid, or expired.

Content type: application/json

|Property|Type|Required|Description|
|:--|:--|:--|:--|
|`success`|boolean|required||
|`error`|object|required||
|`error.code`|"UNAUTHORIZED" \|"FORBIDDEN" \|"INSUFFICIENT\_SCOPE" \|"PLAN\_LIMIT\_REACHED" \|"PLAN\_REQUIRED" \|"INVALID\_ORIGIN" \|"INVALID\_REGION" \|"INVALID\_PAYLOAD" \|"NOT\_FOUND" \|"CONFLICT" \|"KEY\_LIMIT\_REACHED" \|"INSUFFICIENT\_CREDITS" \|"SCAN\_IN\_PROGRESS" \|"UNLOCK\_REQUIRED" \|"REPOSITORY\_NOT\_LINKED" \|"PAYLOAD\_TOO\_LARGE" \|"RATE\_LIMITED" \|"SERVICE\_UNAVAILABLE" \|"INTERNAL\_ERROR"|required||
|`error.message`|string|required||
|`error.details`|unknown|optional|Optional structured error details.|

Example: default

```json
{
  "success": false,
  "error": {
    "code": "UNAUTHORIZED",
    "message": "Authentication required"
  }
}
```

JSON Schema:

```json
{
  "type": "object",
  "required": [
    "success",
    "error"
  ],
  "properties": {
    "success": {
      "type": "boolean",
      "const": false
    },
    "error": {
      "type": "object",
      "required": [
        "code",
        "message"
      ],
      "properties": {
        "code": {
          "type": "string",
          "enum": [
            "UNAUTHORIZED",
            "FORBIDDEN",
            "INSUFFICIENT_SCOPE",
            "PLAN_LIMIT_REACHED",
            "PLAN_REQUIRED",
            "INVALID_ORIGIN",
            "INVALID_REGION",
            "INVALID_PAYLOAD",
            "NOT_FOUND",
            "CONFLICT",
            "KEY_LIMIT_REACHED",
            "INSUFFICIENT_CREDITS",
            "SCAN_IN_PROGRESS",
            "UNLOCK_REQUIRED",
            "REPOSITORY_NOT_LINKED",
            "PAYLOAD_TOO_LARGE",
            "RATE_LIMITED",
            "SERVICE_UNAVAILABLE",
            "INTERNAL_ERROR"
          ]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "description": "Optional structured error details."
        }
      }
    }
  }
}
```

### 403

The credential is valid but may not perform the operation.

\`INSUFFICIENT\_SCOPE\`: the credential was never granted the capability the operation needs. \`details.requiredScope\` names it, and the \`WWW-Authenticate\` header carries \`Bearer error="insufficient\_scope"\`. An OAuth client fixes this by requesting the scope; an organization API key cannot gain it.

\`FORBIDDEN\`: the capability is present but the membership behind the credential lacks the role, or the resource belongs to another organization.

Content type: application/json

|Property|Type|Required|Description|
|:--|:--|:--|:--|
|`success`|boolean|required||
|`error`|object|required||
|`error.code`|"UNAUTHORIZED" \|"FORBIDDEN" \|"INSUFFICIENT\_SCOPE" \|"PLAN\_LIMIT\_REACHED" \|"PLAN\_REQUIRED" \|"INVALID\_ORIGIN" \|"INVALID\_REGION" \|"INVALID\_PAYLOAD" \|"NOT\_FOUND" \|"CONFLICT" \|"KEY\_LIMIT\_REACHED" \|"INSUFFICIENT\_CREDITS" \|"SCAN\_IN\_PROGRESS" \|"UNLOCK\_REQUIRED" \|"REPOSITORY\_NOT\_LINKED" \|"PAYLOAD\_TOO\_LARGE" \|"RATE\_LIMITED" \|"SERVICE\_UNAVAILABLE" \|"INTERNAL\_ERROR"|required||
|`error.message`|string|required||
|`error.details`|unknown|optional|Optional structured error details.|

Example: insufficientScope

```json
{
  "success": false,
  "error": {
    "code": "INSUFFICIENT_SCOPE",
    "message": "This token was not granted the projects.write scope",
    "details": {
      "requiredScope": "projects.write"
    }
  }
}
```

Example: forbidden

```json
{
  "success": false,
  "error": {
    "code": "FORBIDDEN",
    "message": "Organization membership is required"
  }
}
```

JSON Schema:

```json
{
  "type": "object",
  "required": [
    "success",
    "error"
  ],
  "properties": {
    "success": {
      "type": "boolean",
      "const": false
    },
    "error": {
      "type": "object",
      "required": [
        "code",
        "message"
      ],
      "properties": {
        "code": {
          "type": "string",
          "enum": [
            "UNAUTHORIZED",
            "FORBIDDEN",
            "INSUFFICIENT_SCOPE",
            "PLAN_LIMIT_REACHED",
            "PLAN_REQUIRED",
            "INVALID_ORIGIN",
            "INVALID_REGION",
            "INVALID_PAYLOAD",
            "NOT_FOUND",
            "CONFLICT",
            "KEY_LIMIT_REACHED",
            "INSUFFICIENT_CREDITS",
            "SCAN_IN_PROGRESS",
            "UNLOCK_REQUIRED",
            "REPOSITORY_NOT_LINKED",
            "PAYLOAD_TOO_LARGE",
            "RATE_LIMITED",
            "SERVICE_UNAVAILABLE",
            "INTERNAL_ERROR"
          ]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "description": "Optional structured error details."
        }
      }
    }
  }
}
```

#### Headers

|Name|Type|Required|Description|
|:--|:--|:--|:--|
|`WWW-Authenticate`|string|optional|Present on \`INSUFFICIENT\_SCOPE\`: \`Bearer error="insufficient\_scope", scope="\<required scope>"\`.|

### 404

The requested resource was not found.

Content type: application/json

|Property|Type|Required|Description|
|:--|:--|:--|:--|
|`success`|boolean|required||
|`error`|object|required||
|`error.code`|"UNAUTHORIZED" \|"FORBIDDEN" \|"INSUFFICIENT\_SCOPE" \|"PLAN\_LIMIT\_REACHED" \|"PLAN\_REQUIRED" \|"INVALID\_ORIGIN" \|"INVALID\_REGION" \|"INVALID\_PAYLOAD" \|"NOT\_FOUND" \|"CONFLICT" \|"KEY\_LIMIT\_REACHED" \|"INSUFFICIENT\_CREDITS" \|"SCAN\_IN\_PROGRESS" \|"UNLOCK\_REQUIRED" \|"REPOSITORY\_NOT\_LINKED" \|"PAYLOAD\_TOO\_LARGE" \|"RATE\_LIMITED" \|"SERVICE\_UNAVAILABLE" \|"INTERNAL\_ERROR"|required||
|`error.message`|string|required||
|`error.details`|unknown|optional|Optional structured error details.|

Example:

```json
{
  "success": true,
  "error": {
    "code": "UNAUTHORIZED",
    "message": "string",
    "details": {}
  }
}
```

JSON Schema:

```json
{
  "type": "object",
  "required": [
    "success",
    "error"
  ],
  "properties": {
    "success": {
      "type": "boolean",
      "const": false
    },
    "error": {
      "type": "object",
      "required": [
        "code",
        "message"
      ],
      "properties": {
        "code": {
          "type": "string",
          "enum": [
            "UNAUTHORIZED",
            "FORBIDDEN",
            "INSUFFICIENT_SCOPE",
            "PLAN_LIMIT_REACHED",
            "PLAN_REQUIRED",
            "INVALID_ORIGIN",
            "INVALID_REGION",
            "INVALID_PAYLOAD",
            "NOT_FOUND",
            "CONFLICT",
            "KEY_LIMIT_REACHED",
            "INSUFFICIENT_CREDITS",
            "SCAN_IN_PROGRESS",
            "UNLOCK_REQUIRED",
            "REPOSITORY_NOT_LINKED",
            "PAYLOAD_TOO_LARGE",
            "RATE_LIMITED",
            "SERVICE_UNAVAILABLE",
            "INTERNAL_ERROR"
          ]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "description": "Optional structured error details."
        }
      }
    }
  }
}
```

## Related

* [REST API overview](/docs/rest-api): Every operation in this API.