Skip to main content

How to get a list of entries in a tabular format using Postman?

  • Updated

For reporting purposes, you might need a comprehensive list or table summarizing all entries—such as experiments, protocols, projects, or samples, stored within your group. At eLabNext, we’ve got you covered with our flexible API.

Using the API, you can easily retrieve your data in a tabular or list format, giving you full visibility into everything stored in your eLabNext group and making reporting, analysis, and integrations a breeze.

 

Step 1: Prepare your API credentials

  1. You need a valid API Key for your eLabJournal account.

  2. Log in to your eLabJournal instance → go to User Profile → Apps & Connections → generate a new key if you don’t already have one. More information is available here!

Step 2: Open Postman

  1. Download and install Postman if you haven’t already.

  2. Launch Postman and create a new request.

Step 3: Set up the request

  1. Method: GET

  2. URL:

    https://<your-elab-domain>/api/v2/experiment/getExperiments

    Replace <your-elab-domain> with your eLabJournal domain.

  3. Headers:
    Add the following header:

    Authorization: Token <YOUR_API_KEY>

    Replace <YOUR_API_KEY> with your actual API key.

  4. Optional Parameters:

    • You can add query parameters such as projectID, status, limit, or offset to filter or paginate results depending on the item you'd like to fetch.
      Example:

    https://<your-elab-domain>/api/v2/experiment/getExperiments?projectID=123&limit=50

Please note that entries are paginated; if more than 1000 entries are present, the "page" parameter should be adjusted.

Step 4: Send the request

  1. Click Send in Postman.

  2. The response will appear in JSON format. It will contain a list of your entries.

Step 5: Export the data (optional)

  1. In Postman, you can Save Response → Save to File to export the JSON response. 

  2. If needed, convert the JSON to CSV using postman to a tabular format using their build-in visualization tools!

Screenshot 2025-10-24 115443.png

This table is visualized with the following example visualization script:

var template = `
<style type="text/css">
    .tftable {font-size:14px;color:#333333;width:100%;border-width: 1px;border-color: #87ceeb;border-collapse: collapse;}
    .tftable th {font-size:18px;background-color:#87ceeb;border-width: 1px;padding: 8px;border-style: solid;border-color: #87ceeb;text-align:left;}
    .tftable tr {background-color:#ffffff;}
    .tftable td {font-size:14px;border-width: 1px;padding: 8px;border-style: solid;border-color: #87ceeb;}
    .tftable tr:hover {background-color:#e0ffff;}
</style>

<table class="tftable" border="1">
    <tr>
        <th>Group Name</th>
        <th>Num Studies</th>
        <th>Project ID</th>
        <th>Group ID</th>
        <th>User ID</th>
        <th>Creator ID</th>
        <th>Name</th>
        <th>Long Name</th>
        <th>Description</th>
        <th>Notes</th>
        <th>Created</th>
        <th>Active</th>
    </tr>
    
    {{#each response.data}}
        <tr>
            <td>{{groupName}}</td>
            <td>{{numStudies}}</td>
            <td>{{projectID}}</td>
            <td>{{groupID}}</td>
            <td>{{userID}}</td>
            <td>{{creatorID}}</td>
            <td>{{name}}</td>
            <td>{{longName}}</td>
            <td>{{description}}</td>
            <td>{{notes}}</td>
            <td>{{created}}</td>
            <td>{{active}}</td>
        </tr>
    {{/each}}
</table>
`;

function constructVisualizerPayload() {
    return {response: pm.response.json()}
}

pm.visualizer.set(template, constructVisualizerPayload());

Step 6: Automate (optional)

  • You can write scripts in Python, R, Node.js, or other languages to call this API and automatically process experiments.

  • Example Python snippet using requests:

import requests

url = "https://<your-elab-domain>/api/v2/experiment/getExperiments"
headers = {"Authorization": "Token <YOUR_API_KEY>"}

response = requests.get(url, headers=headers)
data = response.json()

for experiment in data['data']:
    print(experiment['experimentID'], experiment['title'])

Related articles