---
title: "List all agents."
method: GET
path: "/api/v1/projects"
tags: ["Agents"]
---

# List all agents.

`GET /api/v1/projects`

Returns a list of your agents (formerly known as projects). The agents are returned sorted by creation date, with the most recent agents appearing first. It is a paginated API and you can use the page parameter to fetch the next page of agents. The default page size is 10.

Here is an example to list agents: using [API](https://github.com/Poll-The-People/customgpt-cookbook/blob/main/examples/List_all_projects_for_an_account_with_pagination.ipynb) and using our python [SDK](https://github.com/Poll-The-People/customgpt-cookbook/blob/main/examples/SDK_List_all_projects_using_pagination.ipynb).

## Query parameters

- `page` integer
- `duration` integer
- `order` 'asc' | 'desc'
- `orderBy` 'id' | 'created_at'
- `width` string
- `height` string
- `name` string

## Response `200`

Successfully retrieved list of agents that belong to the user.

- object
  - `status` 'error' | 'success' — The status of the response
  - `data` object
    - `current_page` integer — The current page number
    - `data` Project[]
      - `id` integer — Agent ID
      - `project_name` string — Agent name
      - `sitemap_path` string — Agent sitemap
      - `is_chat_active` boolean — Whether the agent is active or not
      - `user_id` integer — User ID of the agent owner
      - `team_id` integer — Team ID of the agent owner
      - `created_at` string, date-time — Date and time when the agent was created
      - `updated_at` string, date-time — Date and time when the agent was last updated
      - `deleted_at` string, date-time, nullable — Date and time when the agent was deleted
      - `type` 'SITEMAP' | 'URL' — Agent type
      - `is_shared` boolean — Is the agent public or not
      - `shareable_slug` string, md5, nullable — Shareable slug that can be used to share the agent
      - `shareable_link` string, url, nullable — Shareable link that can be used to share the agent
      - `embed_code` string, html, nullable — Embed code that can be used to embed the agent
      - `live_chat_code` string, html, nullable — Live chat code that can be used to embed the live chat
      - `are_licenses_allowed` boolean — Whether licenses are allowed or not
      - `subdomain_slug` string, md5, nullable — Subdomain slug that can be used to share the agent
    - `first_page_url` string — The first page url
    - `from` integer — The first item number of the current page
    - `last_page` integer — The last page number
    - `last_page_url` string — The last page url
    - `next_page_url` string — The next page url
    - `path` string — The current page url
    - `per_page` integer — The number of items per page
    - `prev_page_url` string — The previous page url
    - `to` integer — The last item number of the current page
    - `total` integer — The total number of items

## Other responses

- `401` — API Token is either missing or invalid
- `500` — Internal Server Error

---

[API](https://skmtc.net/poll-the-people/apis/customgpt-ai.md) · [All operations](https://skmtc.net/poll-the-people/apis/customgpt-ai/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/poll-the-people/customgpt-ai/revisions/b80e6dfcf78d/schema)