> For the complete documentation index, see [llms.txt](https://docs.pyck.cloud/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.pyck.cloud/graphql-api/queries.md).

# Queries

GraphQL Queries

This section documents all available queries in the pyck GraphQL API. Queries allow you to fetch data from the system without making any changes.

## Available Queries

### Management Service

* [**devices**](https://github.com/pyck-ai/docs/blob/main/graphql/queries/devices.md): List and filter devices (scanners, printers, terminals)
* [**deviceLocations**](https://github.com/pyck-ai/docs/blob/main/graphql/queries/deviceLocations.md): List and filter device-location assignments
* [**deviceUsers**](https://github.com/pyck-ai/docs/blob/main/graphql/queries/deviceUsers.md): List and filter device-user assignments
* [**locations**](https://github.com/pyck-ai/docs/blob/main/graphql/queries/locations.md): List and filter warehouse locations
* [**companies**](/graphql-api/queries/companies.md): List and filter companies
* [**customers**](/graphql-api/queries/customers.md): List and filter customers
* [**dataTypeEntities**](/graphql-api/queries/datatypeentities.md): Get all available entity types for data types
* [**dataTypes**](/graphql-api/queries/datatypes.md): Retrieve data type definitions
* [**nodeDataType**](/graphql-api/queries/nodedatatype.md): Retrieve management objects by ID
* [**suppliers**](/graphql-api/queries/suppliers.md): List and filter suppliers
* [**users**](/graphql-api/queries/users.md): List and filter users
* [**me**](/graphql-api/queries/me.md): Get information about the current user

### Inventory Service

* [**inventoryCollections**](/graphql-api/queries/inventorycollections.md): List and filter inventory collections
* [**inventoryItems**](/graphql-api/queries/inventoryitems.md): List and filter inventory items
* [**inventoryItemSets**](/graphql-api/queries/inventoryitemsets.md): List and filter inventory item sets
* [**itemMovements**](/graphql-api/queries/itemmovements.md): List and filter item movements
* [**nodeInventory**](/graphql-api/queries/nodeinventory.md): Retrieve inventory objects by ID
* [**repositories**](/graphql-api/queries/repositories.md): List and filter repositories
* [**repositoryMovements**](/graphql-api/queries/repositorymovements.md): List and filter repository movements
* [**stocks**](/graphql-api/queries/stocks.md): Get current or historical stock levels
* [**transactions**](/graphql-api/queries/transactions.md): List and filter inventory transactions

### Picking Service

* [**pickingOrderItems**](/graphql-api/queries/pickingorderitems.md): List and filter picking order items
* [**pickingOrders**](/graphql-api/queries/pickingorders.md): List and filter picking orders
* [**pickingOutboundShipmentNotifications**](/graphql-api/queries/pickingoutboundshipmentnotifications.md): List and filter outbound shipment notifications
* [**nodePicking**](/graphql-api/queries/nodepicking.md): Retrieve picking objects by ID

### Receiving Service

* [**receivingInbounds**](/graphql-api/queries/receivinginbounds.md): List and filter receiving inbounds
* [**receivingInboundItems**](/graphql-api/queries/receivinginbounditems.md): List and filter receiving inbound items
* [**receivingInboundShipmentNotifications**](/graphql-api/queries/receivinginboundshipmentnotifications.md): List and filter inbound shipment notifications
* [**nodeReceiving**](/graphql-api/queries/nodereceiving.md): Retrieve receiving objects by ID

### Workflow Service

* [**assignableWorkflowExecutions**](/graphql-api/queries/assignableworkflowexecutions.md): List workflow executions with pending user tasks
* [**workflows**](/graphql-api/queries/workflows.md): List and filter workflows
* [**workflowActions**](/graphql-api/queries/workflowactions.md): Retrieve the queries and updates currently available for a workflow execution
* [**workflowAssignee**](/graphql-api/queries/workflowassignee.md): Retrieve the assignee of a specific workflow run
* [**workflowExecutions**](/graphql-api/queries/workflowexecutions.md): List and filter workflow executions with pagination
* [**workflowHistory**](/graphql-api/queries/workflowhistory.md): Fetch workflow history events
* [**workflowSignals**](/graphql-api/queries/workflowsignals.md): List and filter workflow signals
* [**workflowTargets**](/graphql-api/queries/workflowtargets.md): Read the current target surfaces of a workflow execution
* [**nodeWorkflow**](https://github.com/pyck-ai/docs/blob/main/graphql/queries/nodeWorkflow.md): Retrieve workflow objects by ID

### File Service

* [**files**](/graphql-api/queries/files.md): List and filter files
* [**nodeFile**](https://github.com/pyck-ai/docs/blob/main/graphql/queries/nodeFile.md): Retrieve files by ID

### System

* [**events**](/graphql-api/queries/events.md): List and filter system events

## Pagination and Filtering

Most list queries support pagination using the Relay connection specification. This allows you to efficiently navigate large result sets.

Example of paginated query:

```graphql
query {
  inventoryItems(
    first: 10
    after: "cursor-value"
    where: { 
      name: { contains: "product" }
    }
    orderBy: { createdAt: DESC }
  ) {
    edges {
      node {
        id
        name
        sku
      }
      cursor
    }
    pageInfo {
      hasNextPage
      hasPreviousPage
      startCursor
      endCursor
    }
    totalCount
  }
}
```

## Common Query Parameters

Many queries support similar parameters:

* `where`: Filter criteria specific to the queried entity
* `orderBy`: Sorting criteria for the results
* Pagination parameters: `first`, `after`, `last`, `before`


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.pyck.cloud/graphql-api/queries.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
