# List

The list endpoint allows you to list [pathways](https://docs.falkor.io/pathways/create-a-pathway) and enrolments for a given array of pathway names or IDs. If either name or ID is not provided it will return all pathways and enrollments

### Parameters

| **Key**        | **Type**                             |
| -------------- | ------------------------------------ |
| **pathways**   | Array String (Name or ID of pathway) |
| **DEPRECATED** |                                      |
| **name**       | String (Name of a pathway)           |
| **ID**         | String (Pathway SKU)                 |

### Example

The example below retrieves a single pathway with related user enrolments. Each user enrolment contains their details and pathway progress.

```
curl -X POST \
  v1/pathways/list \
  -H 'Authorization: Basic <Your Base64 Encoded Token>' \
  -d '{
	"pathways" : ["Pathway B","Pathway B"]
}'
```

### Success Response

The response will contain an array of pathways. In the enrolment property will be an array of user enrolments. The enrolment object is detailed in the [Pathway enrolment webhook](/falkor-dev-docs/pathways/webhooks/enrolments.md#user-enrollment).

```
{
    "status": "success",
    "data": [
        {
            "pathway" : {
                "name": "My Pathway",
                "ID" : "FAPW-GWRG-02HU"
            },
            "enrolments": [
                {
                    "firstname": "Test",
                    "lastname": "User",
                    "email": "test@example.com",
                    "telephone" : "",
                    "country": "South Africa",
                    "city": "Johannesburg",
                    "groups" : ["Group A","Group B"],
                    "status": {
                        "level": 1,
                        "state": "In Progress",
                        "progress": 10,
                        "version": "1.0.1",
                        "timestamp": "2020-10-09T08:43:30+02:00",
                        "joined": "2020-10-09T08:43:30+02:00"
                    }
                },
                ...etc
            ]
        },
        ...etc
    ],
    "hash": "f114aeba57bebe5e53b612d17d24f38d",
    "response_time": 0.10516619682312012
}
```

{% content-ref url="/pages/-MJAyMJxEKYDBU8DOXq5" %}
[Enrolments](/falkor-dev-docs/pathways/webhooks/enrolments.md)
{% endcontent-ref %}


---

# Agent Instructions: Querying This Documentation

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

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://everyday-digital.gitbook.io/falkor-dev-docs/pathways/enrolments/list.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
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.