> ## Documentation Index
> Fetch the complete documentation index at: https://docs.kinetica.com/llms.txt
> Use this file to discover all available pages before exploring further.

# get_graph_entities

### get\_graph\_entities

<ul>
  <li>
    get\_graph\_entities(\
    &#x20;graph\_name: string,\
    &#x20;offset?: number,\
    &#x20;limit?: number,\
    &#x20;options?: Record\<string, string>,\
    &#x20;callback?: [GPUdbCallback](https://docs.kinetica.com/content/api/typescript/types/GPUdbCallback.md),\
    ): Promise\<[GetGraphEntitiesResponse](https://docs.kinetica.com/content/api/typescript/interfaces/GetGraphEntitiesResponse.md)>

    Retrieves node or edge entities from an existing graph, with pagination support via offset and limit. Use `show_graph` to obtain the total number of nodes and edges.

    #### Parameters

    <ul>
      <li>
        graph\_name: string

        Name of the graph from which to retrieve entities.
      </li>

      <li>
        `Optional`offset: number

        Starting index of the entities to retrieve (0-based).
      </li>

      <li>
        `Optional`limit: number

        Number of entities to retrieve starting from `offset`. A value of -1 returns all entities from the offset to the end. Note: the `entities_int` or `entities_string` array size will be 2x this value for nodes (stride 2) or 4x for edges (stride 4).
      </li>

      <li>
        `Optional`options: Record\<string, string>

        Optional parameters.
      </li>

      <li>
        `Optional`callback: [GPUdbCallback](https://docs.kinetica.com/content/api/typescript/types/GPUdbCallback.md)

        Optional callback function
      </li>
    </ul>

    #### Returns Promise\<[GetGraphEntitiesResponse](https://docs.kinetica.com/content/api/typescript/interfaces/GetGraphEntitiesResponse.md)>

    Promise\<Types.GetGraphEntitiesResponse> - Promise resolving to the response

    <ul>
      <li>Defined in [src/GPUdb.ts:10222](https://github.com/kineticadb/kinetica-api-typescript/blob/master/src/GPUdb.ts#L10222)</li>
    </ul>
  </li>
</ul>

### get\_graph\_entities\_request

<ul>
  <li>
    get\_graph\_entities\_request(\
    &#x20;request: [GetGraphEntitiesRequest](https://docs.kinetica.com/content/api/typescript/interfaces/GetGraphEntitiesRequest.md),\
    &#x20;callback?: [GPUdbCallback](https://docs.kinetica.com/content/api/typescript/types/GPUdbCallback.md),\
    ): Promise\<[GetGraphEntitiesResponse](https://docs.kinetica.com/content/api/typescript/interfaces/GetGraphEntitiesResponse.md)>

    Retrieves node or edge entities from an existing graph, with pagination support via offset and limit. Use `show_graph` to obtain the total number of nodes and edges.

    #### Parameters

    <ul>
      <li>
        request: [GetGraphEntitiesRequest](https://docs.kinetica.com/content/api/typescript/interfaces/GetGraphEntitiesRequest.md)

        Request object containing the parameters for the operation
      </li>

      <li>
        `Optional`callback: [GPUdbCallback](https://docs.kinetica.com/content/api/typescript/types/GPUdbCallback.md)

        Optional callback function
      </li>
    </ul>

    #### Returns Promise\<[GetGraphEntitiesResponse](https://docs.kinetica.com/content/api/typescript/interfaces/GetGraphEntitiesResponse.md)>

    Promise\<Types.GetGraphEntitiesResponse> - Promise resolving to the response

    <ul>
      <li>Defined in [src/GPUdb.ts:10193](https://github.com/kineticadb/kinetica-api-typescript/blob/master/src/GPUdb.ts#L10193)</li>
    </ul>
  </li>
</ul>


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.