folder QUERY
Fetch a single folder by its unique identifier.
folder(
id: ID!
): Folder
Arguments
Type
Folder object
A virtual folder used to organize workspace resources.
The workspace API manages folders, projects and the users who own them, and streams project and folder changes as they happen.
Every operation comes with a ready-to-run example: the query, the variables it takes, and the response it returns — see folder for a start.
Fetch a single folder by its unique identifier.
folder(
id: ID!
): Folder
Folder A virtual folder used to organize workspace resources.
List folders available in the current workspace.
folders(
limit: Int
offset: Int
): [Folder!]!
folders.limit · Int Maximum number of folders to return.
folders.offset · Int Number of folders to skip before returning results.
Folder A virtual folder used to organize workspace resources.
List projects, optionally filtered by lifecycle status.
projects(
status: ProjectStatus
limit: Int
): ProjectConnection!
projects.status · ProjectStatus Limit results to projects in this lifecycle stage.
projects.limit · Int Maximum number of projects to return. Defaults to 20.
ProjectConnection A paginated project result set.
Search folders, projects, and users from a single endpoint.
search(
query: String!
): [SearchResult!]!
search.query · String! Text matched against folder, project, and user names.
SearchResult A result returned from global workspace search.
Archive a project that is no longer active.
archiveProject(
id: ID!
): Project!
archiveProject.id · ID! The unique identifier of the project to archive.
Project A unit of work tracked in the workspace.
Create a virtual folder in the workspace.
createFolder(
name: String!
parentId: ID
): Folder!
createFolder.name · String! The name of the new folder.
createFolder.parentId · ID The optional parent folder identifier.
Folder A virtual folder used to organize workspace resources.
Create a project and assign its initial owner.
createProject(
input: CreateProjectInput!
): Project!
createProject.input · CreateProjectInput! The project attributes to create.
Project A unit of work tracked in the workspace.
Receive folders as they are created in the workspace.
folderCreated(
parentId: ID
): Folder!
folderCreated.parentId · ID Limit events to folders created under this parent.
Folder A virtual folder used to organize workspace resources.
Receive an event whenever a project changes in the workspace.
projectChanged(
projectId: ID
types: [ProjectEventType!]
): ProjectEvent!
projectChanged.projectId · ID Limit events to a single project.
projectChanged.types · ProjectEventType! Limit events to these change kinds.
ProjectEvent A change delivered to subscribers watching a project.
The Boolean scalar type represents true or false.
scalar Boolean
Input used to create a project.
input CreateProjectInput {
name: String!
ownerId: ID!
folderId: ID
status: ProjectStatus
}
CreateProjectInput.name · String! The name for the new project.
CreateProjectInput.ownerId · ID! The identifier of the user who will own the project.
CreateProjectInput.folderId · ID The optional folder that will contain the project.
CreateProjectInput.status · ProjectStatus The initial lifecycle stage for the project.
createProject
An ISO 8601 timestamp in UTC.
scalar DateTime
Folder Project ProjectEvent
Marks an element of a GraphQL schema as no longer supported.
directive @deprecated(
reason: String!
) on
| FIELD_DEFINITION
| ARGUMENT_DEFINITION
| INPUT_FIELD_DEFINITION
| ENUM_VALUE
| DIRECTIVE_DEFINITION
deprecated.reason · String! Explains why this element was deprecated, usually also including a suggestion for how to access supported similar data. Formatted using the Markdown syntax, as specified by CommonMark.
Marks an object type as superseded when standard @deprecated cannot be applied.
directive @deprecatedType(
reason: String!
) on OBJECT
deprecatedType.reason · String! Provides a GraphQL example that is rendered in the generated API reference.
directive @example(
value: String!
) on
| FIELD_DEFINITION
| OBJECT
example.value · String! Provides the JSON response returned by the @example operation, rendered
alongside it in the generated API reference.
directive @exampleResponse(
value: String!
) on FIELD_DEFINITION
exampleResponse.value · String! Provides the JSON variables sent with the @example operation, rendered
under it in the generated API reference.
directive @exampleVariables(
value: String!
) on FIELD_DEFINITION
exampleVariables.value · String! A virtual folder used to organize workspace resources.
type Folder implements Node {
id: ID!
name: String!
parent: String
createdAt: DateTime!
}
Folder.id · ID! The unique identifier of the folder.
Folder.name · String! The human-readable folder name.
Folder.parent · String The identifier of the parent folder, when nested.
Folder.createdAt · DateTime! When the folder was created.
Node A globally unique entity identifier.
createFolder folder folderCreated folders
Project
SearchResult
The ID scalar type represents a unique identifier, often used to refetch an object or as key for a cache. The ID type appears in a JSON response as a String; however, it is not intended to be human-readable. When expected as an input type, any string (such as "4") or integer (such as 4) input value will be accepted as an ID.
scalar ID
archiveProject createFolder CreateProjectInput Folder folder folderCreated LegacyProject Node Project projectChanged User
Directs the executor to include this field or fragment only when the if argument is true.
directive @include(
if: Boolean!
) on
| FIELD
| FRAGMENT_SPREAD
| INLINE_FRAGMENT
include.if · Boolean! Included when true.
The Int scalar type represents non-fractional signed whole numeric values. Int can represent values between -(2^31) and 2^31 - 1.
scalar Int
folders ProjectConnection projects
Use Project instead for active workspace work.
type LegacyProject {
id: ID!
name: String!
}
LegacyProject.id · ID! The unique identifier of the legacy project.
LegacyProject.name · String! The legacy project name.
A globally unique entity identifier.
interface Node {
id: ID!
}
Indicates exactly one field must be supplied and this field must not be null.
directive @oneOf on INPUT_OBJECT
A unit of work tracked in the workspace.
type Project implements Node {
id: ID!
name: String!
status: ProjectStatus!
owner: User!
folder: Folder
updatedAt: DateTime!
state: String @deprecated
}
Project.id · ID! The unique identifier of the project.
Project.name · String! The project name shown to collaborators.
Project.status · ProjectStatus! The current lifecycle stage of the project.
Project.owner · User! The user responsible for the project.
Project.folder · Folder The folder containing this project, when assigned.
Project.updatedAt · DateTime! When the project was last updated.
Project.state · String The project's lifecycle stage.
Node A globally unique entity identifier.
archiveProject createProject
ProjectConnection ProjectEvent
SearchResult
A paginated project result set.
type ProjectConnection {
nodes: [Project!]!
totalCount: Int!
}
ProjectConnection.nodes · Project!! Projects in the current result page.
ProjectConnection.totalCount · Int! The total number of projects matching the query.
projects
A change delivered to subscribers watching a project.
type ProjectEvent {
type: ProjectEventType!
project: Project!
actor: User
occurredAt: DateTime!
}
ProjectEvent.type · ProjectEventType! The kind of change that occurred.
ProjectEvent.project · Project! The project in its state after the change.
ProjectEvent.actor · User The user who triggered the change, when known.
ProjectEvent.occurredAt · DateTime! When the change occurred.
projectChanged
The kind of change that occurred on a project.
enum ProjectEventType {
CREATED
UPDATED
ARCHIVED
}
ProjectEventType.CREATEDThe project was created.
ProjectEventType.UPDATEDOne or more project fields were updated.
ProjectEventType.ARCHIVEDThe project was archived.
projectChanged ProjectEvent
The lifecycle stage of a project.
enum ProjectStatus {
DRAFT
ACTIVE
ARCHIVED
}
ProjectStatus.DRAFTThe project is being planned and is not yet active.
ProjectStatus.ACTIVEThe project is active and available to collaborators.
ProjectStatus.ARCHIVEDThe project is retained for history and no longer active.
CreateProjectInput Project projects
A result returned from global workspace search.
union SearchResult = Folder | Project | User
SearchResult.Folder A virtual folder used to organize workspace resources.
SearchResult.Project A unit of work tracked in the workspace.
SearchResult.User A workspace member who owns and collaborates on projects.
search
Directs the executor to skip this field or fragment when the if argument is true.
directive @skip(
if: Boolean!
) on
| FIELD
| FRAGMENT_SPREAD
| INLINE_FRAGMENT
Exposes a URL that specifies the behavior of this scalar.
directive @specifiedBy(
url: String!
) on SCALAR
specifiedBy.url · String! The URL that specifies the behavior of this scalar.
The String scalar type represents textual data, represented as UTF-8 character sequences. The String type is most often used by GraphQL to represent free-form human-readable text.
scalar String
createFolder CreateProjectInput deprecated deprecatedType example exampleResponse exampleVariables Folder LegacyProject Project search specifiedBy User
A workspace member who owns and collaborates on projects.
type User implements Node {
id: ID!
name: String!
email: String!
role: String!
}
User.id · ID! The unique identifier of the user.
User.name · String! The user's display name.
User.email · String! The user's primary email address.
User.role · String! The user's role in the workspace.
Node A globally unique entity identifier.
Project ProjectEvent
SearchResult