> 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/nodeworkflowservice.md).

# NodeWorkflowService

nodeWorkflowService Query

Audience: Programmer

Fetches a workflow-related object given its ID. This query follows the Relay Global Object Identification Specification and can retrieve any object that implements the NodeWorkflowService interface.

## Arguments

| Name | Type  | Description                                              |
| ---- | ----- | -------------------------------------------------------- |
| `id` | `ID!` | The unique identifier of the workflow object to retrieve |

## Return Type

`NodeWorkflowService` - An interface that returns an object implementing the NodeWorkflowService interface. This includes:

* `Workflow` - A Temporal workflow instance with execution details
* `WorkflowSignal` - A signal that can be sent to a running workflow

## Usage Example

### GraphQL Query

```graphql
query GetWorkflowObject($id: ID!) {
  nodeWorkflowService(id: $id) {
    id
    ... on Workflow {
      workflowID
      runID
      workflowType
      status
      startTime
      endTime
      execution
      searchAttributes
      createdAt
      updatedAt
    }
    ... on WorkflowSignal {
      signalName
      workflowID
      runID
      payload
      status
      createdAt
      updatedAt
    }
  }
}
```

### Query Variables

```json
{
  "id": "V29ya2Zsb3c6MTIz"
}
```

### JavaScript Example

```javascript
const getWorkflowObject = async (objectId) => {
  const query = `
    query GetWorkflowObject($id: ID!) {
      nodeWorkflowService(id: $id) {
        id
        __typename
        ... on Workflow {
          workflowID
          runID
          workflowType
          status
          startTime
          endTime
          execution
        }
        ... on WorkflowSignal {
          signalName
          workflowID
          runID
          payload
          status
        }
      }
    }
  `;

  const response = await fetch('/graphql', {
    method: 'POST',
    headers: {
      'Content-Type': 'application/json',
      'Authorization': `Bearer ${accessToken}`
    },
    body: JSON.stringify({
      query,
      variables: { id: objectId }
    })
  });

  const { data } = await response.json();
  return data.nodeWorkflowService;
};
```

## Type Detection

Use the `__typename` field to determine which specific type was returned:

```javascript
const object = await getWorkflowObject(id);
switch (object.__typename) {
  case 'Workflow':
    console.log(`Workflow: ${object.workflowID} (${object.status})`);
    break;
  case 'WorkflowSignal':
    console.log(`Signal: ${object.signalName} for workflow ${object.workflowID}`);
    break;
}
```

## Common Use Cases

### Monitor Workflow Status

```javascript
const checkWorkflowStatus = async (workflowId) => {
  const workflow = await getWorkflowObject(workflowId);
  if (workflow.__typename === 'Workflow') {
    return {
      id: workflow.workflowID,
      status: workflow.status,
      isRunning: workflow.status === 'Running',
      isCompleted: workflow.status === 'Completed',
      duration: workflow.endTime ? 
        new Date(workflow.endTime) - new Date(workflow.startTime) : null
    };
  }
};
```

## Related

* [NodeWorkflowService Interface](https://github.com/pyck-ai/docs/blob/main/graphql/interfaces/NodeWorkflowService.md)
* [Workflow Type](/graphql-api/types/workflow.md)
* [WorkflowSignal Type](/graphql-api/types/workflowsignal.md)
* [Temporal Workflow Documentation](/development/workflows.md)


---

# 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/nodeworkflowservice.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.