List the files in a fix set, optionally with their content.

GEThttps://app.softsolz.uk/api/v1/services/seo/code/fixes/{fix_set_id}/files

Recent Requests

TimeStatusUser Agent

Make a request to see history.

Path Params

fix_set_idstringrequired

Headers

Authorizationstringrequired

Bearer token: `Bearer sk_live_...` (or `sk_test_...` for sandbox). A login token will not work here.

Query Params

include_contentboolean

true returns before_content and after_content.

limitinteger

Page size, 1 to 200 (default 50).

offsetinteger

Rows to skip before the first result.

Response

Response Body · array of objects

idstringFix file id. Use it as file_id.

fix_set_idstringParent fix set.

file_pathstringRepository path.

change_kindstringupdate for an existing file, create for a new one.

titlestringShort description of the change.

reasonstring | nullWhy the change helps.

page_pathstring | nullURL path the file renders.

check_idsarray of stringsAudit checks the change addresses.

includedbooleanWhether the file will be part of the pull request.

after_bytesinteger | nullSize of the new content.

before_contentstring | nullOriginal content, only when include_content=true.

after_contentstring | nullNew content, only when include_content=true.

Request

import { SoftSolz } from '@softsolz/sdk';

const client = new SoftSolz({ apiKey: process.env.SOFTSOLZ_API_KEY });

const result = await client.seo.listFixSetFiles('<fix_set_id>', {});
console.log(result);

Credentials

Authorization

Sent as a Bearer token. Stored only in your browser.

Response · 200

{
  "data": [
    {
      "id": "string",
      "fix_set_id": "string",
      "file_path": "string",
      "change_kind": "string",
      "title": "string",
      "reason": "string",
      "page_path": "string",
      "check_ids": [],
      "included": true,
      "after_bytes": 0,
      "before_content": "string",
      "after_content": "string"
    }
  ]
}