Pylon

https://docs.usepylon.com/pylon-docs/developer/api
Admin
Pylon is a customer support and issue management platform that provides APIs for managing contacts,...
Tokens:148,784
Snippets:378
Trust Score:9.2
Update:4 months ago
Show doc for...
Tokens:
Raw
### Query Documentation

Source: https://docs.usepylon.com/pylon-docs/developer/api/api-reference/tags.md

Dynamically query this documentation page by performing an HTTP GET request with the 'ask' query parameter. Use this to get answers not explicitly present or to clarify information.

```http
GET https://docs.usepylon.com/pylon-docs/developer/api/api-reference/tags.md?ask=<question>
```

--------------------------------

### Query Documentation Dynamically

Source: https://docs.usepylon.com/pylon-docs/developer/api/api-reference/accounts/files.md

To get information not explicitly present on a page, perform an HTTP GET request to the page URL with the `ask` query parameter. The question should be specific and self-contained.

```http
GET https://docs.usepylon.com/pylon-docs/developer/api/api-reference/accounts/files.md?ask=<question>
```

--------------------------------

### Query Documentation with 'ask' Parameter

Source: https://docs.usepylon.com/pylon-docs/developer/api/api-reference/call-recordings.md

To get specific information not explicitly present on the page, perform an HTTP GET request to the page URL with the 'ask' query parameter. The question should be specific and in natural language. The response will include a direct answer and relevant excerpts.

```HTTP
GET https://docs.usepylon.com/pylon-docs/developer/api/api-reference/call-recordings.md?ask=<question>
```

--------------------------------

### Get All Tasks

Source: https://docs.usepylon.com/pylon-docs/developer/api/api-reference/tasks-and-projects.md

Retrieves a paginated list of tasks for the organization. Rate limit is 60 requests per minute.

```json
{
  "openapi": "3.0.3",
  "info": {
    "title": "Pylon API.",
    "version": "1.0.0"
  },
  "servers": [
    {
      "url": "https://api.usepylon.com"
    }
  ],
  "security": [
    {
      "bearerAuth": []
    }
  ],
  "components": {
    "securitySchemes": {
      "bearerAuth": {
        "description": "Authorization: Bearer <token>",
        "scheme": "bearer",
        "type": "http"
      }
    },
    "responses": {
      "GetTasksResponse": {
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/GetTasksResponseBody"
            }
          }
        },
        "description": ""
      },
      "ErrorApiResponse": {
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/ErrorApiResponseBody"
            }
          }
        },
        "description": ""
      }
    },
    "schemas": {
      "GetTasksResponseBody": {
        "properties": {
          "data": {
            "description": "The data payload of the response.",
            "items": {
              "$ref": "#/components/schemas/Task"
            },
            "type": "array"
          },
          "pagination": {
            "$ref": "#/components/schemas/Pagination"
          },
          "request_id": {
            "description": "The request ID for tracking.",
            "type": "string"
          }
        },
        "type": "object"
      },
      "Task": {
        "properties": {
          "account": {
            "$ref": "#/components/schemas/MiniAccount"
          },
          "assignee": {
            "$ref": "#/components/schemas/Actor"
          },
          "body_html": {
            "description": "The body of the task in HTML format.",
            "type": "string"
          },
          "created_at": {
            "description": "The created at time of the task.",
            "type": "string"
          },
          "custom_fields": {
            "additionalProperties": {
              "$ref": "#/components/schemas/CustomFieldValue"
            },
            "description": "Custom field values associated with the task, keyed by custom field slug.",
            "type": "object"
          },
          "customer_portal_visible": {
            "description": "The customer portal visible of the task.",
            "type": "boolean"
          },
          "due_date": {
            "description": "The due date of the task in RFC3339 format.",
            "type": "string"
          },
          "id": {
            "description": "The ID of the task.",
            "type": "string"
          },
          "milestone": {
            "$ref": "#/components/schemas/MiniMilestone"
          },
          "parent_task_id": {
            "description": "The ID of the parent task, if this is a subtask.",
            "type": "string"
          },
          "project": {
            "$ref": "#/components/schemas/MiniProject"
          },
          "status": {
            "$ref": "#/components/schemas/TaskStatus"
          },
          "subtask_ids": {
            "description": "The IDs of subtasks belonging to this task.",
            "items": {
              "type": "string"
            },
            "type": "array"
          },
          "title": {
            "description": "The title of the task.",
            "type": "string"
          },
          "updated_at": {
            "description": "The updated at time of the task.",
            "type": "string"
          }
        },
        "type": "object"
      },
      "MiniAccount": {
        "properties": {
          "external_ids": {
            "description": "External IDs associated with the account.",
            "items": {
              "$ref": "#/components/schemas/ExternalID"
            },
            "type": "array"
          },
          "id": {
            "description": "The ID of the account.",
            "type": "string"
          }
        },
        "type": "object"
      },
      "ExternalID": {
        "properties": {
          "external_id": {
            "description": "The external ID. Must be unique per object type (ex. account).",
            "type": "string"
          },
          "label": {
            "description": "The label of the external ID. Must be unique per object.",
            "type": "string"
          }
        },
        "type": "object"
      },
      "Actor": {
        "properties": {
          "contact": {
            "$ref": "#/components/schemas/MiniContact"
          },
          "user": {
            "$ref": "#/components/schemas/MiniUser"
          }
        },
        "type": "object"
      },
      "MiniContact": {
        "properties": {
          "email": {
            "description": "The email of the contact.",
            "type": "string"
          },
          "id": {
            "description": "The ID of the contact.",
            "type": "string"
          }
        },
        "type": "object"
      },
      "MiniUser": {
        "properties": {
          "email": {
            "description": "The email of the user.",
            "type": "string"
          },
          "id": {
            "description": "The ID of the user.",
            "type": "string"
          }
        },
        "type": "object"
      },
      "CustomFieldValue": {
        "properties": {
          "slug": {
            "description": "The slug of the custom field.",
            "type": "string"
          },
          "value": {
            "description": "The value of the custom field. Only to be used for single-valued custom fields. If unset, the custom field will be unset. If the custom field is a select field, the value must be the select option slug, which you can find from the GET /custom-fields endpoint.",
            "type": "string"
          },
          "values": {
            "description": "The values of the custom field. Only to be used for multi-valued custom fields (ex. multiselect). If unset, the custom field will be unset.",
            "type": "array"
          }
        },
        "type": "object"
      }
    }
  }
}
```

--------------------------------

### Get all tasks

Source: https://docs.usepylon.com/pylon-docs/developer/api/api-reference/tasks-and-projects.md

Returns a paginated list of tasks for the organization. Rate limited to 60 requests per minute.

```APIDOC
## Get all tasks

### Description
Returns a paginated list of tasks for the organization.

**Rate limit:** 60 requests per minute

If the custom field is a multiselect field, the values must be the select option slugs which you can find from the GET /custom-fields endpoint.

### Method
GET

### Endpoint
/tasks

### Parameters
#### Query Parameters
- **cursor** (string) - Optional - The cursor to use for pagination.
- **limit** (integer) - Optional - The number of tasks to fetch. Defaults to 100. Must be greater than 0 and less than 1000.

### Response
#### Success Response (200)
- **tasks** (array) - A list of tasks.
- **pagination** (object) - Pagination details.
  - **cursor** (string) - The cursor for the next page of results.
  - **has_next_page** (boolean) - Indicates if there is a next page of results.

#### Error Response (400)
- **errors** (array) - The list of errors.
- **exists_id** (string) - The ID of the object that already exists if this is a duplicate object error.
- **request_id** (string) - The request ID for tracking.
```

--------------------------------

### Get all tasks

Source: https://docs.usepylon.com/pylon-docs/developer/api/api-reference/tasks-and-projects.md

Returns a paginated list of tasks for the organization. Rate limited to 60 requests per minute.

```APIDOC
## GET /tasks

### Description
Returns a paginated list of tasks for the organization.

### Method
GET

### Endpoint
/tasks

### Parameters
#### Query Parameters
- **limit** (integer) - Optional - The maximum number of tasks to return.
- **offset** (integer) - Optional - The number of tasks to skip before returning results.

### Response
#### Success Response (200)
- **data** (array) - The data payload of the response, containing a list of Task objects.
- **pagination** (object) - Pagination details for the response.
- **request_id** (string) - The request ID for tracking.

#### Response Example
{
  "data": [
    {
      "id": "task_123",
      "title": "Implement feature X",
      "body_html": "<p>Details about implementing feature X.</p>",
      "created_at": "2023-10-27T10:00:00Z",
      "updated_at": "2023-10-27T10:30:00Z",
      "due_date": "2023-11-15T23:59:59Z",
      "customer_portal_visible": false,
      "assignee": {
        "user": {
          "id": "user_abc",
          "email": "user@example.com"
        }
      },
      "project": {
        "id": "proj_xyz"
      },
      "milestone": {
        "id": "milestone_456"
      },
      "status": "open",
      "parent_task_id": null,
      "subtask_ids": [],
      "custom_fields": {}
    }
  ],
  "pagination": {
    "limit": 10,
    "offset": 0,
    "total_count": 50
  },
  "request_id": "req_789"
}
```

--------------------------------

### Get all knowledge bases

Source: https://docs.usepylon.com/pylon-docs/developer/api/api-reference/knowledge-base.md

Returns all knowledge bases for the organization. Rate limited to 60 requests per minute.

```APIDOC
## Get all knowledge bases

### Description
Returns all knowledge bases for the organization.

### Method
GET

### Endpoint
/knowledge-bases

### Rate Limiting
60 requests per minute

### Responses
#### Success Response (200)
- **data** (array) - The data payload of the response.
  - **default_language** (string) - The default language of the knowledge base.
  - **id** (string) - The ID of the knowledge base.
  - **slug** (string) - The slug of the knowledge base.
  - **supported_languages** (array) - The list of supported languages for the knowledge base.
  - **title** (string) - The name of the knowledge base.
- **pagination** (object) - Pagination details.
  - **cursor** (string) - The cursor for the next page of results.
  - **has_next_page** (boolean) - Indicates if there is a next page of results.
- **request_id** (string) - The request ID for tracking.

#### Error Response (400, 404, 500)
- **errors** (array) - The list of errors.
- **exists_id** (string) - The ID of the object that already exists if this is a duplicate object error.
- **request_id** (string) - The request ID for tracking.
```

--------------------------------

### Query Documentation with GET Request

Source: https://docs.usepylon.com/pylon-docs/developer/api/api-reference/issues.md

Use this method to ask questions about the documentation dynamically. The response includes a direct answer, excerpts, and sources.

```http
GET https://docs.usepylon.com/pylon-docs/developer/api/api-reference/issues.md?ask=<question>
```

--------------------------------

### Get Team by ID

Source: https://docs.usepylon.com/pylon-docs/developer/api/api-reference/teams.md

Retrieves details for a specific team using its unique identifier. Use this endpoint to get information about a single team.

```APIDOC
## GET /teams/{id}

### Description
Retrieves details for a specific team using its unique identifier.

### Method
GET

### Endpoint
/teams/{id}

#### Path Parameters
- **id** (string) - Required - The unique identifier of the team.
```

--------------------------------

### Get Training Data by ID

Source: https://docs.usepylon.com/pylon-docs/developer/api/api-reference/training-data.md

Retrieves a specific training data entry by its unique identifier. Use this to get details about a particular knowledge source.

```APIDOC
## GET /training-data/{id}

### Description
Retrieves a specific training data entry by its unique identifier.

### Method
GET

### Endpoint
/training-data/{id}

#### Path Parameters
- **id** (string) - Required - The unique identifier of the training data entry.
```

--------------------------------

### Querying Documentation Dynamically

Source: https://docs.usepylon.com/pylon-docs/developer/api/api-reference/attachments.md

Demonstrates how to perform an HTTP GET request to query the documentation dynamically. This is useful for asking specific questions about the content and receiving direct answers with supporting excerpts.

```http
GET https://docs.usepylon.com/pylon-docs/developer/api/api-reference/attachments.md?ask=<question>
```

--------------------------------

### Get Custom Field by ID

Source: https://docs.usepylon.com/pylon-docs/developer/api/api-reference/custom-fields.md

Retrieves a specific custom field by its unique identifier. Use this endpoint to get detailed information about a single custom field.

```APIDOC
## GET /custom-fields/{id}

### Description
Retrieves a specific custom field by its unique identifier.

### Method
GET

### Endpoint
/custom-fields/{id}

### Parameters
#### Path Parameters
- **id** (string) - Required - The unique identifier of the custom field.
```

--------------------------------

### Query Documentation with 'ask' Parameter

Source: https://docs.usepylon.com/pylon-docs/developer/api/api-reference/audit-logs.md

Perform an HTTP GET request to query the documentation dynamically. Include your specific question in the 'ask' query parameter. The response will contain a direct answer and relevant excerpts.

```http
GET https://docs.usepylon.com/pylon-docs/developer/api/api-reference/audit-logs.md?ask=<question>
```

--------------------------------

### Query Documentation with GET Request

Source: https://docs.usepylon.com/pylon-docs/developer/api.md

Use this method to ask questions about the documentation. The response includes direct answers and relevant excerpts.

```http
GET https://docs.usepylon.com/pylon-docs/developer/api.md?ask=<question>
```

--------------------------------

### Query Documentation with 'ask' Parameter

Source: https://docs.usepylon.com/pylon-docs/developer/api/api-reference/messages.md

Perform an HTTP GET request to query the documentation dynamically. Include your question as the value for the 'ask' query parameter.

```http
GET https://docs.usepylon.com/pylon-docs/developer/api/api-reference/messages.md?ask=<question>
```

--------------------------------

### Query Documentation with 'ask' Parameter

Source: https://docs.usepylon.com/pylon-docs/developer/api/api-reference/accounts/activities.md

Perform an HTTP GET request to the documentation URL with the 'ask' query parameter to ask a question about the content. The response will include a direct answer and relevant excerpts.

```bash
GET https://docs.usepylon.com/pylon-docs/developer/api/api-reference/accounts/activities.md?ask=<question>
```

--------------------------------

### Get All Surveys OpenAPI Specification

Source: https://docs.usepylon.com/pylon-docs/developer/api/api-reference/surveys.md

This snippet provides the OpenAPI 3.0 specification for the 'Get all surveys' endpoint. It details the request method, path, parameters, and response schemas, including error handling.

```json
{
  "openapi": "3.0.3",
  "info": {
    "title": "Pylon API.",
    "version": "1.0.0"
  },
  "servers": [
    {
      "url": "https://api.usepylon.com"
    }
  ],
  "security": [
    {
      "bearerAuth": []
    }
  ],
  "components": {
    "securitySchemes": {
      "bearerAuth": {
        "description": "Authorization: Bearer <token>",
        "scheme": "bearer",
        "type": "http"
      }
    },
    "responses": {
      "GetSurveysResponse": {
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/GetSurveysResponseBody"
            }
          }
        },
        "description": ""
      },
      "ErrorApiResponse": {
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/ErrorApiResponseBody"
            }
          }
        },
        "description": ""
      }
    },
    "schemas": {
      "GetSurveysResponseBody": {
        "properties": {
          "data": {
            "description": "The data payload of the response.",
            "items": {
              "$ref": "#/components/schemas/Survey"
            },
            "type": "array"
          },
          "request_id": {
            "description": "The request ID for tracking.",
            "type": "string"
          }
        },
        "type": "object"
      },
      "Survey": {
        "properties": {
          "id": {
            "description": "The unique identifier of the survey.",
            "type": "string"
          },
          "name": {
            "description": "The name of the survey.",
            "type": "string"
          },
          "type": {
            "description": "The type of the survey.\n\n`nps`: Represents an NPS survey.\n\n`csat`: Represents a CSAT survey.\n\n`custom`: Represents a custom survey.",
            "enum": [
              "nps",
              "csat",
              "custom"
            ],
            "type": "string"
          },
          "updated_at": {
            "description": "When the survey was last updated (RFC3339 format).",
            "type": "string"
          }
        },
        "title": "Survey represents a survey in the API response.",
        "type": "object"
      },
      "ErrorApiResponseBody": {
        "properties": {
          "errors": {
            "description": "The list of errors.",
            "items": {
              "type": "string"
            },
            "type": "array"
          },
          "exists_id": {
            "description": "The ID of the object that already exists if this is a duplicate object error.",
            "type": "string"
          },
          "request_id": {
            "description": "The request ID for tracking.",
            "type": "string"
          }
        },
        "type": "object"
      }
    }
  },
  "paths": {
    "/surveys": {
      "get": {
        "description": "Returns all surveys for the organization.\n\n**Rate limit:** 60 requests per minute",
        "operationId": "GetSurveys",
        "responses": {
          "200": {
            "$ref": "#/components/responses/GetSurveysResponse"
          },
          "400": {
            "$ref": "#/components/responses/ErrorApiResponse"
          },
          "500": {
            "$ref": "#/components/responses/ErrorApiResponse"
          }
        },
        "summary": "Get all surveys",
        "tags": [
          "surveys"
        ]
      }
    }
  }
}

```

--------------------------------

### Create a project

Source: https://docs.usepylon.com/pylon-docs/developer/api/api-reference/tasks-and-projects.md

Creates a new project for an account. Rate limit: 60 requests per minute.

```APIDOC
## POST /projects

### Description
Creates a new project for an account.

### Method
POST

### Endpoint
/projects

### Request Body
- **name** (string) - Required - The name of the project.
- **template_id** (string) - Optional - The ID of the project template to use.
- **custom_fields** (object) - Optional - A dictionary of custom field slugs and their values.
  - **field_slug** (string or array) - Required - The value for the custom field. For multiselect fields, provide an array of select option slugs.
```

--------------------------------

### Get Account by ID

Source: https://docs.usepylon.com/pylon-docs/developer/api/api-reference/accounts.md

Retrieves a specific account by its ID.

```APIDOC
## GET /accounts/{id}

### Description
Retrieves a specific account by its ID.

### Method
GET

### Endpoint
/accounts/{id}

### Parameters
#### Path Parameters
- **id** (string) - Required - The ID of the account to retrieve.

### Response
#### Success Response (200)
- **id** (string) - The account ID.
- **name** (string) - The name of the account.
- **account_type** (string) - The type of the account.
- **created_at** (string) - The timestamp when the account was created.
- **updated_at** (string) - The timestamp when the account was last updated.
- **custom_fields** (array) - An array of custom fields associated with the account.
- **owner_id** (string) - The ID of the user who owns the account.
- **tags** (array) - An array of tags associated with the account.

#### Response Example
{
  "id": "acc_123",
  "name": "Example Account",
  "account_type": "customer",
  "created_at": "2023-01-01T12:00:00Z",
  "updated_at": "2023-01-01T12:00:00Z",
  "custom_fields": [],
  "owner_id": "usr_abc",
  "tags": ["active"]
}
```

--------------------------------

### Get Contact by ID

Source: https://docs.usepylon.com/pylon-docs/developer/api/api-reference/contacts.md

Retrieves a specific contact by its ID.

```APIDOC
## GET /contacts/{id}

### Description
Retrieves a specific contact by its ID.

### Method
GET

### Endpoint
/contacts/{id}

#### Path Parameters
- **id** (string) - Required - The ID of the contact to retrieve.
```

--------------------------------

### Query Documentation with 'ask' Parameter

Source: https://docs.usepylon.com/pylon-docs/developer/api/api-reference/accounts/highlights.md

Perform an HTTP GET request to query the documentation dynamically. Use this when the answer is not explicitly present, you need clarification, or want to retrieve related sections.

```http
GET https://docs.usepylon.com/pylon-docs/developer/api/api-reference/accounts/highlights.md?ask=<question>
```

--------------------------------

### Get Tag by ID

Source: https://docs.usepylon.com/pylon-docs/developer/api/api-reference/tags.md

Retrieves a specific tag by its unique identifier.

```APIDOC
## GET /tags/{id}

### Description
Retrieves a specific tag by its ID.

### Method
GET

### Endpoint
/tags/{id}

### Parameters
#### Path Parameters
- **id** (string) - Required - The unique identifier of the tag.

### Request Example
None

### Response
#### Success Response (200)
- id (string) - The unique identifier of the tag.
- name (string) - The name of the tag.

#### Response Example
```json
{
  "id": "tag_123",
  "name": "example_tag"
}
```
```

--------------------------------

### Create Account

Source: https://docs.usepylon.com/pylon-docs/developer/api/api-reference/accounts.md

Creates a new account. This is useful for onboarding new users or entities.

```json
{
  "openapi": "3.0.3",
  "info": {
    "title": "Pylon API.",
    "version": "1.0.0"
  },
  "servers": [
    {
      "url": "https://api.usepylon.com"
    }
  ],
  "security": [
    {
      "bearerAuth": []
    }
  ],
  "components": {
    "securitySchemes": {
      "bearerAuth": {
        "description": "Authorization: Bearer <token>",
        "scheme": "bearer",
        "type": "http"
      }
    },
    "schemas": {
      "Account": {
        "properties": {
          "account_id": {
            "description": "The account ID.",
            "type": "string"
          },
          "account_type": {
            "description": "The type of the account.",
            "type": "string"
          },
          "created_at": {
            "description": "Timestamp of account creation.",
            "type": "string"
          },
          "custom_fields": {
            "description": "An array of custom fields.",
            "items": {
              "$ref": "#/components/schemas/CustomFieldValue"
            },
            "type": "array"
          },
          "owner_id": {
            "description": "The ID of the account owner.",
            "type": "string"
          },
          "tags": {
            "description": "An array of tags.",
            "items": {
              "type": "string"
            },
            "type": "array"
          },
          "updated_at": {
            "description": "Timestamp of last account update.",
            "type": "string"
          }
        },
        "type": "object"
      },
      "CustomFieldValue": {
        "properties": {
          "slug": {
            "description": "The slug of the custom field.",
            "type": "string"
          },
          "value": {
            "description": "The value of the custom field. Only to be used for single-valued custom fields. If unset, the custom field will be unset. If the custom field is a select field, the value must be the select option slug, which you can find from the GET /custom-fields endpoint.",
            "type": "string"
          },
          "values": {
            "description": "The values of the custom field. Only to be used for multi-valued custom fields (ex. multiselect). If unset, the custom field will be unset. If the custom field is a multiselect field, the values must be the select option slugs which you can find from the GET /custom-fields endpoint.",
            "items": {
              "type": "string"
            },
            "type": "array"
          }
        },
        "type": "object"
      },
      "CreateAccountRequest": {
        "properties": {
          "account_type": {
            "description": "The type of the account. Can only be "customer" or "partner".",
            "type": "string"
          },
          "custom_fields": {
            "description": "An array of custom fields to be set on the account.",
            "items": {
              "$ref": "#/components/schemas/CustomFieldValue"
            },
            "type": "array"
          },
          "owner_id": {
            "description": "The ID of the owner. If empty string is passed in, the owner will be removed.",
            "type": "string"
          },
          "tags": {
            "description": "An array of tags to be set on the account.",
            "items": {
              "type": "string"
            },
            "type": "array"
          }
        },
        "required": [
          "account_type"
        ],
        "type": "object"
      },
      "CreateAccountResponseBody": {
        "properties": {
          "account_id": {
            "description": "The ID of the created account.",
            "type": "string"
          },
          "request_id": {
            "description": "The request ID for tracking.",
            "type": "string"
          }
        },
        "type": "object"
      },
      "ErrorApiResponseBody": {
        "properties": {
          "errors": {
            "description": "The list of errors.",
            "items": {
              "type": "string"
            },
            "type": "array"
          },
          "exists_id": {
            "description": "The ID of the object that already exists if this is a duplicate object error.",
            "type": "string"
          },
          "request_id": {
            "description": "The request ID for tracking.",
            "type": "string"
          }
        },
        "type": "object"
      }
    }
  },
  "responses": {
    "CreateAccountResponse": {
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/CreateAccountResponseBody"
          }
        }
      },
      "description": ""
    },
    "ErrorApiResponse": {
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/ErrorApiResponseBody"
          }
        }
      },
      "description": ""
    }
  },
  "paths": {
    "/accounts": {
      "post": {
        "description": "Creates a new account.

**Rate limit:** 20 requests per minute",
        "operationId": "CreateAccount",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/CreateAccountRequest"
              }
            }
          }
        },
        "responses": {
          "201": {
            "$ref": "#/components/responses/CreateAccountResponse"
          },
          "400": {
            "$ref": "#/components/responses/ErrorApiResponse"
          },
          "500": {
            "$ref": "#/components/responses/ErrorApiResponse"
          }
        },
        "summary": "Create account",
        "tags": [
          "accounts"
        ]
      }
    }
  }
}
```

--------------------------------

### Create an account highlight

Source: https://docs.usepylon.com/pylon-docs/developer/api/api-reference/accounts/highlights.md

Creates a new highlight on an account. Rate limited to 10 requests per minute.

```APIDOC
## POST /accounts/{account_id}/highlights

### Description
Creates a new highlight on an account.

**Rate limit:** 10 requests per minute

### Method
POST

### Endpoint
/accounts/{account_id}/highlights

### Parameters
#### Path Parameters
- **account_id** (string) - Required - The ID or external ID of the account that the highlight belongs to.

#### Request Body
- **content_html** (string) - Required - The HTML content for this highlight.
- **expires_at** (string) - Optional - Optional RFC3339 timestamp of when this highlight will expire.

### Response
#### Success Response (200)
- **data** (object) - Contains the created account highlight details.
  - **account_id** (string) - The ID of the account this highlight belongs to.
  - **content_html** (string) - The HTML content of the highlight.
  - **created_at** (string) - The timestamp of when the highlight was created.
  - **expires_at** (string) - The timestamp of when the highlight expires, if set.
  - **id** (string) - The ID of the account highlight.
  - **updated_at** (string) - The timestamp of when the highlight was last updated.
- **request_id** (string) - The request ID for tracking.

#### Error Response (400, 404, 500)
- **errors** (array of strings) - The list of errors.
- **exists_id** (string) - The ID of the object that already exists if this is a duplicate object error.
- **request_id** (string) - The request ID for tracking.
```

--------------------------------

### Get Current User Information

Source: https://docs.usepylon.com/pylon-docs/developer/api/api-reference/me.md

Retrieves information about the currently authenticated user.

```APIDOC
## GET /me

### Description
Retrieves information about the currently authenticated user.

### Method
GET

### Endpoint
/me

### Parameters
#### Query Parameters
- **ask** (string) - Optional - Used to query the documentation dynamically.

### Request Example
```http
GET https://docs.usepylon.com/pylon-docs/developer/api/api-reference/me.md?ask=<question>
```

### Response
#### Success Response (200)
(Response schema not explicitly defined in the provided text, but typically includes user details.)

#### Response Example
(Response example not explicitly defined in the provided text.)
```

--------------------------------

### Get All Accounts

Source: https://docs.usepylon.com/pylon-docs/developer/api/api-reference/accounts.md

Retrieves a list of all accounts. This is useful for overview or initial data loading.

```json
{
  "openapi": "3.0.3",
  "info": {
    "title": "Pylon API.",
    "version": "1.0.0"
  },
  "servers": [
    {
      "url": "https://api.usepylon.com"
    }
  ],
  "security": [
    {
      "bearerAuth": []
    }
  ],
  "components": {
    "securitySchemes": {
      "bearerAuth": {
        "description": "Authorization: Bearer <token>",
        "scheme": "bearer",
        "type": "http"
      }
    },
    "schemas": {
      "Account": {
        "properties": {
          "account_id": {
            "description": "The account ID.",
            "type": "string"
          },
          "account_type": {
            "description": "The type of the account.",
            "type": "string"
          },
          "created_at": {
            "description": "Timestamp of account creation.",
            "type": "string"
          },
          "custom_fields": {
            "description": "An array of custom fields.",
            "items": {
              "$ref": "#/components/schemas/CustomFieldValue"
            },
            "type": "array"
          },
          "owner_id": {
            "description": "The ID of the account owner.",
            "type": "string"
          },
          "tags": {
            "description": "An array of tags.",
            "items": {
              "type": "string"
            },
            "type": "array"
          },
          "updated_at": {
            "description": "Timestamp of last account update.",
            "type": "string"
          }
        },
        "type": "object"
      },
      "CustomFieldValue": {
        "properties": {
          "slug": {
            "description": "The slug of the custom field.",
            "type": "string"
          },
          "value": {
            "description": "The value of the custom field. Only to be used for single-valued custom fields. If unset, the custom field will be unset. If the custom field is a select field, the value must be the select option slug, which you can find from the GET /custom-fields endpoint.",
            "type": "string"
          },
          "values": {
            "description": "The values of the custom field. Only to be used for multi-valued custom fields (ex. multiselect). If unset, the custom field will be unset. If the custom field is a multiselect field, the values must be the select option slugs which you can find from the GET /custom-fields endpoint.",
            "items": {
              "type": "string"
            },
            "type": "array"
          }
        },
        "type": "object"
      },
      "UpdateAccountsResponseBody": {
        "properties": {
          "request_id": {
            "description": "The request ID for tracking.",
            "type": "string"
          },
          "success": {
            "description": "Whether the update was successfully initiated.",
            "type": "boolean"
          }
        },
        "type": "object"
      },
      "ErrorApiResponseBody": {
        "properties": {
          "errors": {
            "description": "The list of errors.",
            "items": {
              "type": "string"
            },
            "type": "array"
          },
          "exists_id": {
            "description": "The ID of the object that already exists if this is a duplicate object error.",
            "type": "string"
          },
          "request_id": {
            "description": "The request ID for tracking.",
            "type": "string"
          }
        },
        "type": "object"
      }
    }
  },
  "responses": {
    "UpdateAccountsResponse": {
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/UpdateAccountsResponseBody"
          }
        }
      },
      "description": ""
    },
    "ErrorApiResponse": {
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/ErrorApiResponseBody"
          }
        }
      },
      "description": ""
    }
  },
  "paths": {
    "/accounts": {
      "get": {
        "description": "Returns a list of all accounts.",
        "operationId": "ListAccounts",
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "items": {
                    "$ref": "#/components/schemas/Account"
                  },
                  "type": "array"
                }
              }
            },
            "description": ""
          },
          "400": {
            "$ref": "#/components/responses/ErrorApiResponse"
          },
          "500": {
            "$ref": "#/components/responses/ErrorApiResponse"
          }
        },
        "summary": "List accounts",
        "tags": [
          "accounts"
        ]
      }
    }
  }
}
```
Tokens:
Raw