Skip to main content
No Result Found

Project

Each project represents a logical grouping of builds executed on Percy. Use our REST API to manage your projects and fetch the project details in real-time.

Get project details

GET https://percy.io/api/v1/projects

Retrieves the details of the project associated with the given token. If no token is provided, this API returns details of all public projects.

Request parameters

No parameters required.

Curl Request

curl --request GET \
     --url https://percy.io/api/v1/projects \
     --header 'Authorization: Token token=auto_xxxxxxxxxxxx'

Response attributes 200 OK JSON

Response

{
  "data": {
    "type": "projects",
    "id": "4xxxxxx",
    "attributes": {
      "name": "test-auto",
      "slug": "test-auto",
      "type": "automate",
      "full-slug": "9xxxxxxxx/test-auto",
      "is-enabled": true,
      "diff-base": "automatic",
      "auto-approve-branch-filter": "",
      "approval-required-branch-filter": "*",
      "default-base-branch": "master",
      "created-at": "2020-12-25T11:24:41.000Z",
      "updated-at": "2023-10-03T10:17:51.000Z",
      "publicly-readable": false,
      "is-demo": false,
      "is-auto-browser-upgrade": true,
      "wait-for-base-build": false,
      "current-period-usage": 5,
      "screenshot-limit": null,
      "workflow": "git",
      "intelli-ignore-enabled": false,
      "intelli-ignore-diff-ignore-percentage": 0,
      "default-ignore-diff-ignore-percentage": 0.2,
      "diff-sensitivity-level": 2,
      "delay-seconds": "3.0",
      "visual-monitoring-urls-count": null,
      "schedule": null,
      "next-schedule-time": null,
      "latest-build-stat": null,
      "visual-monitoring-urls": [],
      "vm-staging-base-url": null,
      "vm-last-build-baseline": false,
      "vm-diff-ignore-enabled": null,
      "vm-diff-ignore-percentage": null,
      "auth-type": null,
      "auth-config-name": null,
      "auth-params": null,
      "sitemap-ids": null,
      "cron": null,
      "schedule-start": null,
      "schedule-end": null,
      "tag-ids": []
    },
    "links": {
      "self": "/api/v1/projects/9xxxxxxxx/test-auto"
    },
    "relationships": {
       "repo": {
        "links": {
          "related": "/api/v1/projects/9xxxxxxx/test-auto/repo"
        },
        "data": {
          "type": "repos",
          "id": "39xxxx"
        }
      },
      "organization": {
        "links": {
          "related": "/api/v1/projects/9xxxxxxxx/test-auto/organization"
        },
        "data": {
          "type": "organizations",
          "id": "30xxx"
        }
      },
      "builds": {
        "links": {
          "related": "/api/v1/builds?project_id=4xxxxxx"
        }
      },
      "tokens": {
        "links": {
          "related": "/api/v1/projects/9xxxxxxxx/test-auto/tokens"
        }
      },
      "browser-targets": {
        "data": [
          {
            "type": "browser-targets",
            "id": "6x"
          }
        ]
      },
      "project-browser-targets": {
        "data": [
          {
            "type": "project-browser-targets",
            "id": "7xxxxxx"
          }
        ]
      },
      "webhook-configs": {
        "data": []
      }
    }
  },
  "included": [
    {
      "type": "repos",
      "id": "39xxxx",
      "attributes": {
        "name": "example",
        "slug": "browserstack/example",
        "html-url": "https://github.com/browserstack/example",
        "hostname": "github.com",
        "source": "github"
      },
      "relationships": {
        "version-control-integration": {
          "links": {
            "self": "/relationships/version-control-integration",
            "related": "/version-control-integration"
          },
          "data": {
            "type": "version-control-integrations",
            "id": "49xx"
          }
        }
      }
    },
    {
      "type": "browser-targets",
      "id": "60",
      "attributes": {
        "version-target": "121.0.6167.85",
        "deprecation-period-start": null,
        "deprecation-period-end": null
      },
      "relationships": {
        "operating-system": {},
        "browser-family": {
          "data": {
            "type": "browser-families",
            "id": "2"
          }
        }
      }
    },
    {
      "type": "browser-families",
      "id": "2",
      "attributes": {
        "name": "Chrome",
        "slug": "chrome"
      }
    },
    {
      "type": "project-browser-targets",
      "id": "74xxxxx",
      "relationships": {
        "browser-target": {
          "data": {
            "type": "browser-targets",
            "id": "6x"
          }
        },
        "project": {
          "data": {
            "type": "projects",
            "id": "1xxxxx"
          }
        }
      }
    }
  ]
}
  • attributes Object

    Details of test session.

    SHOW VALUES
    • name String

      Name of the project.

    • slug String

      Slug of the project.

    • type String

      Web or App project.

    • full-slug String

      Path of full slug.

    • is-enabled Boolean

      Project is archieved or not.

    • diff-base String

      (Can be ignored. Used for projects prior to 2019).

    • auto-approve-branch-filter String

      Specifies the name of the branches for auto-approval.

    • approval-required-branch-fitler String

      Specifies the name of the branches where manual approval is required.

    • default-base-branch String

      Specifies the name of the default baseline branch.

    • updated-at Integer

      Time stamp when the project was last updated.

    • publicly-readable Boolean

      Specifies if the project is publicly viewable.

    • is-demo Boolean

      Specifies if the project is a demo project.

    • is-auto-browser-upgrade Boolean

      Specifies if the browser version is set to auto-upgrade.

    • wait-for-base-build Boolean

      Specifies if the “wait for base build” option has been configured in the project settings.

    • current-period-usage Boolean

      Specifies the current period usage for a project.

    • screenshot-limit Boolean

      Specifies the screenshot limit for a project.

    • workflow Boolean

      Specifies workflow that has been configured in the project settings.

    • diff-sensitivity-levels Integer

      Specifies the diff-sensitivity-levels based on your project settings.

    • visual-monitoring-urls String

      Specifies the URLs targetted for visual monitoring.

    • latest-build-stat String

      Specifies the latest build stats.

    • vm-last-build-baseline String

      Specifies the baseline for a monitoring project.

    • created-at Integer

      Specifies the project creation time stamp.

  • links Object

    Details of test session.

    SHOW VALUES
    • self String

      Time stamp when the build was last updated.

  • relationships Object

    Details of test session.

    SHOW VALUES
    • organisation Object

      Specifies details of the org and the API endpoint.

    • repo Object

      Specifies details of the repo and URL path for the API endpoint.

    • builds Object

      Specifies API endpoint to fetch builds.

    • tokens Object

      Specifies API endpoint to fetch the token.

    • browser-targets Object

      Specifies browser-targets and respective IDs

    • project-browser-targets Object

      Specifies project-browser-targets and respective IDs.

    • webhook-configs Object

      Specifies on what events would we be notified, » project settings.

We're sorry to hear that. Please share your feedback so we can do better

Contact our Support team for immediate help while we work on improving our docs.

We're continuously improving our docs. We'd love to know what you liked





Thank you for your valuable feedback

Download Copy Check Circle