Search documentation
karat

+

K

User Documentation ↗
Version 2.0

List Project Resource References

GET/api/v2/filesystem/projects/{projectRid}/references

List all references in the given project

Third-party applications using this endpoint via OAuth2 must request the following operation scope: api:filesystem-read.

Path parameters

projectRid
string

The unique resource identifier (RID) of a Project.

Query parameters

referenceType
string (enum)
optional

Filter references by type. If not provided, all references are returned.

Enum values: EXTERNAL, FILESYSTEM

pageSize
integer
optional

The page size to use for the endpoint.

pageToken
string
optional

The page token indicates where to start paging. This should be omitted from the first page's request. To fetch the next page, clients should take the value from the nextPageToken field of the previous response and use it to populate the pageToken field of the next request.

Response body

ListProjectResourceReferencesResponse
object
Hide child attributes

Hide child attributes

data
list<ProjectResourceReference>
optional
Show child attributes

Show child attributes

nextPageToken
string
optional

The page token indicates where to start paging. This should be omitted from the first page's request. To fetch the next page, clients should take the value from the nextPageToken field of the previous response and use it to populate the pageToken field of the next request.

Examples

Request

Copied!
1 2 3 curl \ \t-H "Authorization: Bearer $TOKEN" \ "https://$HOSTNAME/api/v2/filesystem/projects/ri.compass.main.folder.01a79a9d-e293-48db-a585-9ffe221536e8/references?referenceType=EXTERNAL"

Response

Copied!
1 2 3 { "nextPageToken": "v1.QnVpbGQgdGhlIEZ1dHVyZTogaHR0cHM6Ly93d3cucGFsYW50aXIuY29tL2NhcmVlcnMvP2xldmVyLXNvdXJjZSU1YiU1ZD1BUElEb2NzI29wZW4tcG9zaXRpb25z" }

Error responses

Error Name
ProjectNotFoundError CodeNOT_FOUND
Status Code404
DescriptionThe given Project could not be found.
ParametersprojectRid