Saltar al contenido principal

Documentation Index

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

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

Usa la API de usuarios para gestionar personas en tu espacio de trabajo. Puedes crear usuarios vinculados a cuentas existentes, actualizar perfiles y roles, y ver proyectos o artefactos asociados.

​
Solicitud básica y respuesta

Usa GET /api/v1/app/me para verificar tu token y contexto. 
curl "https://{BASE_URL}/api/v1/app/me" \
  -H "Authorization: Bearer {API_TOKEN}"
  -H "x-org: {org_slug}"

{
  "id": "user_4b7c2a1d9e5f3c8b",
  "org_id": "org_2f3a9d1c7b5e4a8f",
  "account_id": "acct_6c8a1f3b2d4e5f7a",
  "name": "Sasha Patel",
  "email": "sasha@auroralabs.com",
  "job_position_name": "Product Ops Lead",
  "job_position_description": "Owns release coordination and analytics.",
  "state": "Active",
  "roles": ["AppAdmin"],
  "created_at": "2026-02-08T14:12:45Z"
}

​
Listar usuarios

curl "https://{BASE_URL}/api/v1/app/user?page=1&page_size=20" \
  -H "Authorization: Bearer {API_TOKEN}"
  -H "x-org: {org_slug}"

{
  "data": [
    {
      "id": "user_4b7c2a1d9e5f3c8b",
      "org_id": "org_2f3a9d1c7b5e4a8f",
      "account_id": "acct_6c8a1f3b2d4e5f7a",
      "name": "Sasha Patel",
      "email": "sasha@auroralabs.com",
      "state": "Active",
      "roles": ["AppAdmin"],
      "created_at": "2026-02-08T14:12:45Z"
    }
  ],
  "has_next_page": false,
  "has_previous_page": false,
  "total_count": 1
}

​
Crear un usuario

curl -X POST "https://{BASE_URL}/api/v1/app/user" \
  -H "Authorization: Bearer {API_TOKEN}" \
  -H "x-org: {org_slug}" \
  -H "Content-Type: application/json" \
  -d '{
    "account_id": "{accountID}",
    "role": "AppMember",
    "user_info": {
      "email": "sasha@auroralabs.com",
      "name": "Sasha Patel",
      "given_name": "Sasha",
      "family_name": "Patel"
    }
  }'

{
  "id": "user_4b7c2a1d9e5f3c8b",
  "org_id": "org_2f3a9d1c7b5e4a8f",
  "account_id": "acct_6c8a1f3b2d4e5f7a",
  "name": "Sasha Patel",
  "email": "sasha@auroralabs.com",
  "state": "Active",
  "roles": ["AppMember"],
  "created_at": "2026-02-08T14:12:45Z"
}

​
Obtener o actualizar un usuario

curl "https://{BASE_URL}/api/v1/app/user/{userID}" \
  -H "Authorization: Bearer {API_TOKEN}"
  -H "x-org: {org_slug}"

{
  "id": "user_4b7c2a1d9e5f3c8b",
  "org_id": "org_2f3a9d1c7b5e4a8f",
  "account_id": "acct_6c8a1f3b2d4e5f7a",
  "name": "Sasha Patel",
  "email": "sasha@auroralabs.com",
  "state": "Active",
  "roles": ["AppMember"],
  "created_at": "2026-02-08T14:12:45Z"
}

​
Activar o desactivar un usuario

curl -X POST "https://{BASE_URL}/api/v1/app/user/{userID}/deactivate" \
  -H "Authorization: Bearer {API_TOKEN}"
  -H "x-org: {org_slug}"

{
  "id": "user_9d1c3b5a7f2e4c6d",
  "state": "Inactive"
}

​
Listar proyectos de un usuario

curl "https://{BASE_URL}/api/v1/app/user/{userID}/project" \
  -H "Authorization: Bearer {API_TOKEN}"
  -H "x-org: {org_slug}"

{
  "data": [
    {
      "id": "proj_7a5c3e1b9d2f4a6c",
      "name": "Customer Insights",
      "goal": "Summarize weekly support trends.",
      "deadline": "2026-03-01T00:00:00Z",
      "visibility": "Private",
      "member_count": 4,
      "default_member_role": "Editor",
      "default_role_enabled": true,
      "project_context": "Support analytics for Q1.",
      "answer_context": "Use approved templates.",
      "is_pinned": true
    }
  ],
  "has_next_page": false,
  "has_previous_page": false,
  "total_count": 1
}

​
Últimos artefactos de un usuario

curl "https://{BASE_URL}/api/v1/app/user/{userID}/latest-artifacts" \
  -H "Authorization: Bearer {API_TOKEN}"
  -H "x-org: {org_slug}"

[
  {
    "id": "artifact_2b4d6f8a1c3e5a7b",
    "project_id": "proj_7a5c3e1b9d2f4a6c",
    "name": "Q1 Support Summary",
    "type": "Document",
    "source": "User",
    "state": "Ready",
    "ingest_status": "Done",
    "has_content": true,
    "created_at": "2026-02-08T14:30:12Z"
  }
]

​
Integraciones del usuario

curl "https://{BASE_URL}/api/v1/app/user/integrations" \
  -H "Authorization: Bearer {API_TOKEN}"
  -H "x-org: {org_slug}"

[
  {
    "id": "conf_8a7b6c5d4e3f2a1b",
    "user_id": "user_4b7c2a1d9e5f3c8b",
    "org_id": "org_2f3a9d1c7b5e4a8f",
    "type": "Confluence",
    "created_at": "2026-02-05T09:10:00Z",
    "updated_at": "2026-02-08T10:02:11Z"
  }
]

​
Errores y casos límite

  • 409: correo electrónico duplicado o cuenta ya vinculada.
  • 400: rol inválido.
  • 404: usuario no encontrado.