Agents

List all agents.

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 and using our python SDK.

get/api/v1/projects

Query parameters

pageinteger

Example:1

Page number to return

durationinteger

The duration of the agents to list.

order'asc' | 'desc'

Example:desc

The order of the agents to list. Defaults to desc.

orderBy'id' | 'created_at'

Example:id

The orderBy to sort the results by given field

widthstring

Example:50rem

The width of the embed code. Defaults to 100%.

heightstring

Example:50rem

The height of the embed code. Defaults to 100%.

namestring

Example:Sample agent

Filter the results by agent name

Response

Successfully retrieved list of agents that belong to the user.

status'error' | 'success'

The status of the response

Example response

{
  "status": "success",
  "data": {
    "current_page": 1,
    "data": [
      {
        "id": 1,
        "project_name": "My Agent",
        "sitemap_path": "https://www.example.com/sitemap.xml",
        "is_chat_active": true,
        "user_id": 1,
        "team_id": 1,
        "created_at": "2021-01-01 00:00:00",
        "updated_at": "2021-01-01 00:00:00",
        "deleted_at": "2021-01-01 00:00:00",
        "type": "SITEMAP",
        "is_shared": true,
        "shareable_slug": "1234567890abcdef1234567890abcdef",
        "are_licenses_allowed": true
      }
    ],
    "first_page_url": "https://app.customgpt.ai/api/v1/users?page=1",
    "from": 1,
    "last_page": 1,
    "last_page_url": "https://app.customgpt.ai/api/v1/users?page=1",
    "next_page_url": "https://app.customgpt.ai/api/v1/users?page=1",
    "path": "https://app.customgpt.ai/api/v1/users?page=1",
    "per_page": 10,
    "prev_page_url": "https://app.customgpt.ai/api/v1/users?page=1",
    "to": 1,
    "total": 1
  }
}

Changes

Changed in 4 of the 9 revisions of this API.2610

Jul 17, 2026b80e6dfcf78d7See the full diff
- ○
  api tag Agents added
  api-tag-added
- ○
  api tag Projects removed
  api-tag-removed
- ○
  added the new optional query request parameter name
  new-optional-request-parameter
- ○
  added the new optional query request parameter orderBy
  new-optional-request-parameter
- ○
  added the optional property /// to the response with the status
  response-optional-property-added
- ○
  added the optional property /// to the response with the status
  response-optional-property-added
- ○
  added the optional property /// to the response with the status
  response-optional-property-added
This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Jul 27, 20232cd2d58839d01See the full diff
- ▲
  for the query request parameter duration, default value 90 was removed
  request-parameter-default-value-removed
Jun 20, 2023ee92d035d6521See the full diff
- ●
  removed the optional property / from the response with the status
  response-optional-property-removed
Jun 2, 20231842d7fd0430153See the full diff
- ▲
  for the query request parameter duration, default value 90 was added
  request-parameter-default-value-added
- ●
  deleted the query request parameter name
  request-parameter-removed
- ●
  deleted the query request parameter orderBy
  request-parameter-removed
- ●
  removed the optional property /// from the response with the status
  response-optional-property-removed
- ●
  removed the optional property /// from the response with the status
  response-optional-property-removed
- ●
  removed the optional property /// from the response with the status
  response-optional-property-removed
- ○
  api tag Projects added
  api-tag-added
- ○
  api tag Agents removed
  api-tag-removed
- ○
  added the optional property / to the response with the status
  response-optional-property-added
This revision also has 11 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

Full history