v1 personas

Get all personas for the organization

Get all personas accessible to the caller.

This endpoint:
- Returns **all** personas across the organization (personas are shared org-wide)
- All users in the org can see all org personas
- Includes persona metadata (name, description, creation date)

**Authentication**: Requires valid API key or JWT token
get/v1/personas

Response

Successful Response

total_countinteger required

Total number of personas

user_idstring nullable

User ID (set when filtering by user)

org_idstring nullable

Organization ID (set when returning org-wide personas)

Example response

{
  "personas": [
    {
      "created_at": "2023-01-01T00:00:00Z",
      "description": "A persona focused on professional writing",
      "name": "Professional Writer",
      "persona_id": "123e4567-e89b-12d3-a456-426614174000",
      "user_email": "john@example.com",
      "user_id": "456e7890-e89b-12d3-a456-426614174001",
      "user_name": "John Doe"
    }
  ],
  "total_count": 1,
  "user_id": "456e7890-e89b-12d3-a456-426614174001"
}

Changes

Changed in 3 of the 29 revisions of this API.211

    • the response property user_id became optional for the status 200

      response-property-became-optional

    • response property user_id list-of-types was widened by adding types null to media type application/json of response 200

      response-property-list-of-types-widened

    • added the optional property org_id to the response with the 200 status

      response-optional-property-added

    • added the optional property details to the response with the 400 status

      response-optional-property-added

    • added the optional property details to the response with the 401 status

      response-optional-property-added

    • added the optional property details to the response with the 500 status

      response-optional-property-added

    • added the optional property request_id to the response with the 400 status

      response-optional-property-added

    • added the optional property request_id to the response with the 401 status

      response-optional-property-added

    • added the optional property request_id to the response with the 500 status

      response-optional-property-added

    • added the required property error_code to the response with the 400 status

      response-required-property-added

    • added the required property error_code to the response with the 401 status

      response-required-property-added

    • added the required property error_code to the response with the 500 status

      response-required-property-added

    This revision also has 7 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

    • endpoint added

      endpoint-added

    This revision also has 5 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog