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
Request parameters
Curl Request
curl --request GET \
--url https://percy.io/api/v1/projects \
--header 'Authorization: Token token=auto_xxxxxxxxxxxx'
-
project_slug* String
Slug for the project.
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",
"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",
"diff-sensitivity-level": 2,
"visual-monitoring-urls": [],
"latest-build-stat": null,
"vm-last-build-baseline": false,
"created-at": "2023-09-21T07:44:55.000Z"
},
"links": {
"self": "/api/v1/projects/9xxxxxxxx/test-auto"
},
"relationships": {
"organization": {
"links": {
"related": "/api/v1/projects/9xxxxxxxx/test-auto/organization"
},
"data": {
"type": "organizations",
"id": "30412"
}
},
"repo": {
"links": {
"related": "/api/v1/projects/9xxxxxxxx/test-auto/repo"
},
"data": null
},
"builds": {
"links": {
"related": "/api/v1/builds?project_id=4xxxxxx"
}
},
"tokens": {
"links": {
"related": "/api/v1/projects/9xxxxxxxx/test-auto/tokens"
}
},
"browser-targets": {
"data": []
},
"project-browser-targets": {
"data": []
},
"webhook-configs": {
"data": []
}
}
},
"included": []
}
-
attributes Object
▶ SHOW VALUESDetails of test session.
-
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
▶ SHOW VALUESDetails of test session.
-
self String
Time stamp when the build was last updated.
-
-
relationships Object
▶ SHOW VALUESDetails of test session.
-
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.