Skip to main content
GET
/
api
/
agents
List Agents
curl --request GET \
  --url https://{organization_id}.platform.barndoor.ai/api/agents \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z",
      "organization_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "application_directory_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "application_directory": {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "created_at": "2023-11-07T05:31:56Z",
        "updated_at": "2023-11-07T05:31:56Z",
        "name": "<string>",
        "description": "<string>",
        "organization_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "external_id": "<string>",
        "public": true,
        "dcr": true,
        "post_login_success": true,
        "callbacks": [
          "<string>"
        ]
      }
    }
  ],
  "pagination": {
    "page": 123,
    "limit": 123,
    "total": 123,
    "pages": 123,
    "previous_page": 123,
    "next_page": 123
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.barndoor.ai/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

Authorization
string
header
required

JWT token obtained through Auth0 OAuth 2.0 flow with PKCE.

The token should be included in the Authorization header: Authorization: Bearer <your-jwt-token>

Use the Barndoor SDK's loginInteractive() function to obtain tokens automatically.

Query Parameters

search
string | null

Search applications by name or description

agent_type
enum<string> | null

Filter by agent type Agent type classification for applications.

Available options:
internal,
external
page
integer
default:1

Page number (1-based)

Required range: x >= 1
limit
integer
default:10

Number of items per page (max 100)

Required range: 1 <= x <= 100

Response

Successful Response

data
AgentResponse · object[]
required

Array of items for current page

pagination
PaginationMeta · object
required

Pagination metadata