# Kustomer Access Management API

> Kustomer Access Management API on Apizie: 374 endpoints (Query events associated with your organization, Create attachment, Get attachments by ID [Outbound Only], Update or upsert attachment, …) returned as clean JSON through one API key. Send your own provider key in the x-upstream-key header. Call it over REST at https://apizie.tech/v1/security:kustomer/{endpoint} or from Claude, ChatGPT and Cursor through the Apizie MCP server. Free plan: 1,000 requests a month.

- Project key: `security:kustomer`
- Category: Security
- Status: byok
- Source: https://kustomer.com
- Page: https://apizie.tech/api/security/kustomer
- OpenAPI: https://apizie.tech/api/security/kustomer/openapi.json

This category describes endpoints related to managing user access, roles, teams, permissions, and authentication in Kustomer. To learn more, see [Manage User…

## Endpoints

### Query events associated with your organization
`GET https://apizie.tech/v1/security:kustomer/audit-logs-query-events` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| count | string | no | Limits the number audit-log documents to be returned. Default 100, maximum 1000. |
| after | string | no | Paginates by the ID of the audit-log which marks the end of the pagination range. Requires "before". |
| before | string | no | Paginates by the ID of the audit-log which marks the beginning of the pagination range. Requires "after". |
| filter[objectType] | string | no | Filters by the type of database object the event relates to. |
| filter[objectId] | string | no | Filters by the id of database object the event relates to. Requires `filter[objectType]`. |
| filter[userId] | string | no | Filters by the ID of the user the event relates to. |
| filter[include] | string | no | Adds additional OR query logic to include results for additional objectTypes. For available objectTypes to use in this query param, see… |
| filter[start] | string | no | Filter by the date range start. |
| filter[end] | string | no | Filter by the date range end. |

### Create attachment
`POST https://apizie.tech/v1/security:kustomer/attachments-create-attachment-document` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | no | JSON request body |

### Get attachments by ID [Outbound Only]
`GET https://apizie.tech/v1/security:kustomer/attachments-get-by-ids` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | ID of attachment to retrieve. #### NOTE >You can provide a comma-delimited list of IDs to receive an array of attchments matching those IDs. |

### Update or upsert attachment
`POST https://apizie.tech/v1/security:kustomer/attachments-update-or-upsert` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | ID of attachment to update. |
| body | object | no | JSON request body |

### Get attachment by message ID and attachment ID (inbound or outbound)
`GET https://apizie.tech/v1/security:kustomer/attachments-get-message-attachment` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| message_id | string | yes | ID of message with attachment |
| id | string | yes | ID of attachment to retrieve |

### Get brands
`GET https://apizie.tech/v1/security:kustomer/brands-list` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| page | number | no | Number of pages to return for results. Default value: 1. |
| pageSize | number | no | Number of results to return per page. Default value: 100. |

### Create brand
`POST https://apizie.tech/v1/security:kustomer/brands-create-brand-resource` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | no | JSON request body |

### Get default brand
`GET https://apizie.tech/v1/security:kustomer/brands-get-default-brand` (byok)

### Get brand by ID
`GET https://apizie.tech/v1/security:kustomer/brands-get-by-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | Brand ID |

### Update brand
`POST https://apizie.tech/v1/security:kustomer/brands-update-brand-resource` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | Brand ID |
| body | object | no | JSON request body |

### Get all business schedules
`GET https://apizie.tech/v1/security:kustomer/business-schedules-get-all` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| page | number | no | Number of pages to return for results. Default value: 1. |
| pageSize | number | no | Number of results to return per page. Default value: 100. |

### Create a business schedule
`POST https://apizie.tech/v1/security:kustomer/business-schedules-create-schedule` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | no | JSON request body |

### Get default business schedule
`GET https://apizie.tech/v1/security:kustomer/business-schedules-get-default` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| include | string | no | Option to include holidays. Accepted values: `holidays`. |

### Get business schedule by ID
`GET https://apizie.tech/v1/security:kustomer/business-schedules-get-by-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | Business Schedule ID |
| include | string | no | Option to include holidays. Accepted values: `holidays`. |

### Update business schedule by ID
`POST https://apizie.tech/v1/security:kustomer/business-schedules-update-by-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | Business Schedule ID |
| body | object | no | JSON request body |

### Delete a business schedule by ID
`POST https://apizie.tech/v1/security:kustomer/business-schedules-delete-by-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | Business Schedule ID |

### Get companies
`GET https://apizie.tech/v1/security:kustomer/companies-get-all` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| externalId | string | no | Unique external ID of the company |
| filter | string | no | Company name to use as a filter |

### Create company
`POST https://apizie.tech/v1/security:kustomer/companies-create-new-company` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | no | JSON request body |

### Get company by ID
`GET https://apizie.tech/v1/security:kustomer/companies-get-by-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | Unique ID of the company. |

### Update company attributes
`POST https://apizie.tech/v1/security:kustomer/companies-update-attributes` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | Unique ID of the company. |
| body | object | no | JSON request body |

### Find company KObjects (custom Objects)
`GET https://apizie.tech/v1/security:kustomer/companies-get-kobjects-by-company-id-and-klass-name` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | Unique ID of the company. |
| name | string | yes | Unique Klass name. |

### Bulk create companies
`POST https://apizie.tech/v1/security:kustomer/companies-bulk-create-bulk-companies` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | no | JSON request body |

### Bulk batch update companies
`POST https://apizie.tech/v1/security:kustomer/companies-bulk-batch-update` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | no | JSON request body |

### Get conversations
`GET https://apizie.tech/v1/security:kustomer/conversations-get-paginated-list` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| page | number | no | Number of pages to return for results. Default value: 1. |
| pageSize | number | no | Number of results to return per page. Default value: 100. |
| sort | string | no | Option to sort the results in descending order. |

### Create conversation
`POST https://apizie.tech/v1/security:kustomer/conversations-create-new-conversation` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | no | JSON request body |

### Get conversation by ID
`GET https://apizie.tech/v1/security:kustomer/conversations-get-by-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | Unique ID of the conversation. |

### Update conversation
`POST https://apizie.tech/v1/security:kustomer/conversations-update-by-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | Unique ID of the conversation. |
| replace | boolean | no | Set to `true` to update the document. Otherwise, performs the same update as a PATCH request. Default value: `false`. |
| body | object | no | JSON request body |

### Update conversation attributes
`POST https://apizie.tech/v1/security:kustomer/conversations-update-attributes-by-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | Unique ID of the conversation. |
| body | object | no | JSON request body |

### Delete conversation
`POST https://apizie.tech/v1/security:kustomer/conversations-delete-by-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | Unique ID of the conversation. |

### Get conversation by external ID
`GET https://apizie.tech/v1/security:kustomer/conversations-get-by-external-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| externalId | string | yes | Unique external ID of the conversation |

### Get conversation attachments
`GET https://apizie.tech/v1/security:kustomer/conversations-get-attachments` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | Unique ID of the conversation. |
| page | number | no | Number of pages to return for results. Default value: 1. |
| pageSize | number | no | Number of results to return per page. Default value: 100. |

### Get conversation events
`GET https://apizie.tech/v1/security:kustomer/conversations-get-events-by-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | Unique ID of the conversation. |
| page | number | no | Number of pages to return for results. Default value: 1. |
| pageSize | number | no | Number of results to return per page. Default value: 100. |
| sort | string | no | Option to sort results in ascending or descending order. |

### Bulk create conversations
`POST https://apizie.tech/v1/security:kustomer/conversations-bulk-create-multiple` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | no | JSON request body |

### Bulk batch update conversations
`POST https://apizie.tech/v1/security:kustomer/conversations-bulk-batch-update` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| ids | string | no | Comma-separated list of unique conversation IDs. |
| body | object | no | JSON request body |

### Get messages by conversation
`GET https://apizie.tech/v1/security:kustomer/conversations-messages-get-by-conversation` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | Unique ID of the conversation. |
| page | number | no | Number of pages to return for results. Default value: 1. |
| pageSize | number | no | Number of results to return per page. Default value: 100. |
| include | string | no | List of resources to include in this response. Use a comma to separate resources. Supports the `attachments` resource. |

### Create message from conversation
`POST https://apizie.tech/v1/security:kustomer/conversations-messages-create-new-message` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | Unique ID of the conversation. |
| body | object | no | JSON request body |

### Append tags to conversation
`POST https://apizie.tech/v1/security:kustomer/conversations-tags-append-tags-to-conversation` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | Unique ID of the conversation. |
| body | object | no | JSON request body |

### Remove tags from conversation
`POST https://apizie.tech/v1/security:kustomer/conversations-tags-remove-tags` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | Unique ID of the conversation. |
| body | object | no | JSON request body |

### Get all forwards by conversation
`GET https://apizie.tech/v1/security:kustomer/conversations-forwards-get-all-by-conversation-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | Unique ID of the conversation. |
| page | number | no | Number of pages to return for results. Default value: 1. |
| pageSize | number | no | Number of results to return per page. Default value: 100. |

### Create forward by conversation
`POST https://apizie.tech/v1/security:kustomer/conversations-forwards-create-forward` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | Unique ID of the conversation. |
| body | object | no | JSON request body |

### Get conversation times by conversation
`GET https://apizie.tech/v1/security:kustomer/conversations-time-list-by-conversation` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | Unique ID of the conversation. |

### Get conversation time by ids
`GET https://apizie.tech/v1/security:kustomer/conversations-time-get-by-unique-ids` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| ids | string | yes | Unique ID of the `conversation_time`. |

### Get notes by conversation
`GET https://apizie.tech/v1/security:kustomer/conversations-notes-get-by-conversation-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | Unique ID of the conversation. |
| page | number | no | Number of pages to return for results. Default value: 1. |
| pageSize | number | no | Number of results to return per page. Default value: 100. |

### Create note within conversation
`POST https://apizie.tech/v1/security:kustomer/notes-conversations-create-note-within-conversation` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | Unique ID of the Conversation |
| body | object | no | JSON request body |

### Bulk create customers
`POST https://apizie.tech/v1/security:kustomer/customers-bulk-create-bulk-customers` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | no | JSON request body |

### Bulk batch update customers
`POST https://apizie.tech/v1/security:kustomer/customers-bulk-bulk-update-customers` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| ids | string | no | Comma-separated list of unique customer IDs. |
| body | object | no | JSON request body |

### Bulk delete customers
`POST https://apizie.tech/v1/security:kustomer/customers-bulk-delete-multiple` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| ids | string | no | Comma-separated list of unique customer IDs. |

### Get conversations by customer
`GET https://apizie.tech/v1/security:kustomer/customers-conversations-get-list` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | Unique ID of the customer. |
| page | number | no | Number of pages to return for results. Default value: 1. |
| pageSize | number | no | Number of results to return per page. Default value: 100. |
| fromDate | string | no | `date-time` string in Internet Date/Time format ([ISO 8601](https://datatracker.ietf.org/doc/html/rfc3339#section-5.6)). |

### Create conversation for customer
`POST https://apizie.tech/v1/security:kustomer/customers-conversations-create-empty-conversation` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | Unique ID of the customer. |
| body | object | no | JSON request body |

### Get all drafts for customer
`GET https://apizie.tech/v1/security:kustomer/customers-drafts-list` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | Unique ID of the customer. |
| page | number | no | Number of pages to return for results. Default value: 1. |
| pageSize | number | no | Number of results to return per page. Default value: 100. |
| include | string | no | List of resources to include in this response. Use a comma to separate resources. Supports the `attachments` resource. |

### Create draft for customer
`POST https://apizie.tech/v1/security:kustomer/customers-drafts-create-draft` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | Unique ID of the customer. |
| body | object | no | JSON request body |

### Get customer event
`GET https://apizie.tech/v1/security:kustomer/customers-events-get-single-event` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| customerId | string | yes | Unique ID of the customer. |
| id | string | yes | Unique ID of the event. |

### Get all events by customer for session
`GET https://apizie.tech/v1/security:kustomer/customers-events-get-all-by-session` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| customerId | string | yes | Unique ID of the customer. |
| sessionId | string | yes | Unique ID of the session. |
| page | number | no | Number of pages to return for results. Default value: 1. |
| pageSize | number | no | Number of results to return per page. Default value: 100. |

### Get all customer sessions
`GET https://apizie.tech/v1/security:kustomer/customers-events-get-customer-sessions` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | Unique ID of the customer. |
| page | number | no | Number of pages to return for results. Default value: 1. |
| pageSize | number | no | Number of results to return per page. Default value: 100. |

### Find customer KObjects (custom Objects)
`GET https://apizie.tech/v1/security:kustomer/customers-kobjects-find-by-klass` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | Unique ID of the customer. |
| name | string | yes | Name of the Klass. |

### Create customer KObject (custom Object)
`POST https://apizie.tech/v1/security:kustomer/customers-kobjects-create-kobject` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | Unique ID of the customer. |
| name | string | yes | Name of the Klass. |
| body | object | no | JSON request body |

### Create customer merge
`POST https://apizie.tech/v1/security:kustomer/customers-merges-create-merge-rule` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | no | JSON request body |

### Get customer merge
`GET https://apizie.tech/v1/security:kustomer/customers-merges-get-by-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | Unique ID of the customer merge. |

### Get customer merges by customer ID
`GET https://apizie.tech/v1/security:kustomer/customers-merges-get-by-customer-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | Unique ID of the customer. |
| page | number | no | Number of pages to return for results. Default value: 1. |
| pageSize | number | no | Number of results to return per page. Default value: 100. |

### Get messages by customer ID
`GET https://apizie.tech/v1/security:kustomer/customers-messages-get-by-customer-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | Unique ID of the customer |
| page | number | no | Number of pages to return for results. Default value: 1. |
| pageSize | number | no | Number of results to return per page. Default value: 100. |
| include | string | no | List of resources to include in this response. Use a comma to separate resources. Supports the `attachments` resource. |

### Create message by customer ID
`POST https://apizie.tech/v1/security:kustomer/customers-messages-create-message-by-customer-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | Unique ID of the customer. |
| body | object | no | JSON request body |

### Get notes by customer ID
`GET https://apizie.tech/v1/security:kustomer/customers-notes-get-by-customer-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | Unique ID of the customer. |
| page | number | no | Number of pages to return for results. Default value: 1. |
| pageSize | number | no | Number of results to return per page. Default value: 100. |

### Create unmasking window by customer ID
`POST https://apizie.tech/v1/security:kustomer/customers-unmasking-windows-create-window-by-customer-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | Unique ID of the customer. |

### Deletes unmasking window by customer ID
`POST https://apizie.tech/v1/security:kustomer/customers-unmasking-windows-delete-by-customer-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | Unique ID of the customer. |

### Get customers
`GET https://apizie.tech/v1/security:kustomer/customers-get-all-customers` (byok)

### Create customer
`POST https://apizie.tech/v1/security:kustomer/customers-create-new-customer-record` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | no | JSON request body |

### Get customer by ID
`GET https://apizie.tech/v1/security:kustomer/customers-get-by-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | Unique ID of the customer. |

### Update customer
`POST https://apizie.tech/v1/security:kustomer/customers-update-customer-by-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | Unique ID of the customer. |
| replace | boolean | no | Set to `true` to update the document. Otherwise, performs the same update as a PATCH request. Default value: `false`. |
| body | object | no | JSON request body |

### Update customer attributes
`POST https://apizie.tech/v1/security:kustomer/customers-update-attributes` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | Unique ID of the customer. |
| body | object | no | JSON request body |

### Delete customer
`POST https://apizie.tech/v1/security:kustomer/customers-delete-record` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | Unique ID of the customer. |

### Get customer by email
`GET https://apizie.tech/v1/security:kustomer/customers-get-by-email` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| email | string | yes | Email address of the customer. |

### Get customer by external ID
`GET https://apizie.tech/v1/security:kustomer/customers-get-by-external-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| externalId | string | yes | External ID of the customer. |

### Get customer by phone number
`GET https://apizie.tech/v1/security:kustomer/customers-get-by-phone` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| phone | string | yes | Phone number of the customer (E.164 format). |

### Get custom attribute metadata
`GET https://apizie.tech/v1/security:kustomer/custom-attributes-get-metadata` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| resource | string | yes | Resource for custom attribute metadata retrieval. Valid values: `company`, `conversation`, `customer`, `message`, and `kobject.*`. |

### Update custom attribute metadata
`POST https://apizie.tech/v1/security:kustomer/custom-attributes-update-attribute-metadata` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| resource | string | yes | Resource for custom attribute metadata retrieval. Valid values: `company`, `conversation`, `customer`, `message`, and `kobject.*`. |
| body | object | no | JSON request body |

### Get draft attachments
`GET https://apizie.tech/v1/security:kustomer/drafts-attachments-get-all` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | Unique draft ID. |

### Create draft attachment
`POST https://apizie.tech/v1/security:kustomer/drafts-attachments-create-attachment` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | Unique draft ID. |
| body | object | no | JSON request body |

### Get draft attachment
`GET https://apizie.tech/v1/security:kustomer/drafts-attachments-get-attachment` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | Unique draft ID. |
| attachmentId | string | yes | Unique attachment ID. |

### Delete draft attachment
`POST https://apizie.tech/v1/security:kustomer/drafts-attachments-delete-resource` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | Unique draft ID. |
| attachmentId | string | yes | Unique attachment ID. |

### Get draft forward by ID
`GET https://apizie.tech/v1/security:kustomer/drafts-get-by-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | Unique draft forward ID. |

### Update draft forward
`POST https://apizie.tech/v1/security:kustomer/drafts-update-draft-forward` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | Unique draft forward ID. |
| body | object | no | JSON request body |

### Get forward attachments
`GET https://apizie.tech/v1/security:kustomer/forwards-attachments-get-all` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | Unique forward ID. |

### Create forward attachment
`POST https://apizie.tech/v1/security:kustomer/forwards-attachments-create-attachment` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | Unique forward ID. |
| body | object | no | JSON request body |

### Get forward attachment
`GET https://apizie.tech/v1/security:kustomer/forwards-attachments-get-pre-signed-url` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | Unique forward ID. |
| attachmentId | string | yes | Unique attachment ID. |

### Delete Forward Attachment
`POST https://apizie.tech/v1/security:kustomer/forwards-attachments-delete-resource` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | Unique attachment ID. |
| attachmentId | string | yes | Unique attachment ID. |

### Get outbound accounts
`GET https://apizie.tech/v1/security:kustomer/drafts-get-outbound-accounts` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| pageSize | number | no | Number of results to return per page. Default value: 100. |
| page | number | no | Number of pages to return for results. Default value: 1. |

### Update draft
`POST https://apizie.tech/v1/security:kustomer/drafts-update-by-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | Unique draft ID. |
| body | object | no | JSON request body |

### Delete draft
`POST https://apizie.tech/v1/security:kustomer/drafts-delete-draft` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | Unique draft ID. |

### Bulk create KObjects (custom objects)
`POST https://apizie.tech/v1/security:kustomer/kobjects-custom-objects-bulk-create-in-bulk` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| name | string | yes | Klass name of KObjects (custom objects). |
| body | object | no | JSON request body |

### Bulk batch update KObjects (custom objects)
`POST https://apizie.tech/v1/security:kustomer/kobjects-custom-objects-bulk-update-batch` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| name | string | yes | Klass name of KObjects (custom objects). |
| ids | string | no | Comma-separated list of unique KObject IDs. |
| body | object | no | JSON request body |

### Bulk delete KObjects (custom objects)
`POST https://apizie.tech/v1/security:kustomer/kobjects-custom-objects-bulk-delete-multiple` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| name | string | yes | Klass name of KObjects (custom objects). |
| ids | string | yes | Comma-separated list of unique KObject IDs. |

### Get KObjects (custom objects)
`GET https://apizie.tech/v1/security:kustomer/kobjects-custom-objects-get-by-klass-name` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| name | string | yes | Klass name of the KObjects (custom objects). |
| fromDate | string | no | `date-time` string in Internet Date/Time format ([ISO 8601](https://datatracker.ietf.org/doc/html/rfc3339#section-5.6)). |

### Create KObject
`POST https://apizie.tech/v1/security:kustomer/kobjects-custom-objects-create-new-kobject` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| name | string | yes | Klass name of the KObjects (custom objects). |
| body | object | no | JSON request body |

### Get KObject (custom object) by ID
`GET https://apizie.tech/v1/security:kustomer/kobjects-custom-objects-get-by-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| name | string | yes | Klass name of the KObject. |
| id | string | yes | Unique ID of the KObject. |

### Update KObject (custom object) by ID
`POST https://apizie.tech/v1/security:kustomer/kobjects-custom-objects-update-by-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| name | string | yes | Klass name of the KObject. |
| id | string | yes | Unique ID of the KObject. |
| body | object | no | JSON request body |

### Delete KObject (custom object) by ID
`POST https://apizie.tech/v1/security:kustomer/kobjects-custom-objects-delete-by-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| name | string | yes | Klass name of the KObject. |
| id | string | yes | Unique ID of the KObject. |

### Get Klasses
`GET https://apizie.tech/v1/security:kustomer/klasses-get-all` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| pageSize | number | no | Number of results to return per page. Default value: 100. |
| page | number | no | Number of pages to return for results. Default value: 1. |
| status | string | no | Option to filter Klass based on the status. Default value: `enabled`. |

### Create Klass
`POST https://apizie.tech/v1/security:kustomer/klasses-create-new-klass` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | no | JSON request body |

### Get Klass by ID
`GET https://apizie.tech/v1/security:kustomer/klasses-get-by-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | Unique Klass ID. |

### Update Klass by ID
`POST https://apizie.tech/v1/security:kustomer/klasses-update-by-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | Unique Klass ID. |
| body | object | no | JSON request body |

### Delete Klass
`POST https://apizie.tech/v1/security:kustomer/klasses-delete-by-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | Unique Klass ID. |

### Create media
`POST https://apizie.tech/v1/security:kustomer/media-upload-document` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | no | JSON request body |

### Get media by ID
`GET https://apizie.tech/v1/security:kustomer/media-get-by-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | Unique media object ID. Provide a comma-separated list of `id`s to retrieve an array of media objects instead. |

### Update media by ID
`POST https://apizie.tech/v1/security:kustomer/media-update-by-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | Unique media object ID. |
| body | object | no | JSON request body |

### Bulk create messages
`POST https://apizie.tech/v1/security:kustomer/messages-bulk-create-batch` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | no | JSON request body |

### Bulk batch update messages
`POST https://apizie.tech/v1/security:kustomer/messages-bulk-update-batch` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| ids | string | no | Comma-separated list of unique message IDs. |
| body | object | no | JSON request body |

### Redact a message
`POST https://apizie.tech/v1/security:kustomer/messages-redact-message` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | Unique message object ID. |
| body | object | no | JSON request body |

### Get messages
`GET https://apizie.tech/v1/security:kustomer/messages-get-all` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| page | number | no | Number of pages to return for results. Default value: 1. |
| pageSize | number | no | Number of results to return per page. Default value: 100. |
| include | string | no | List of resources to include in this response. Use a comma to separate resources. Supports the `attachments` resource. |
| sort | string | no | Option to sort results in descending order. |

### Create message
`POST https://apizie.tech/v1/security:kustomer/messages-add-instance-to-conversation` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | no | JSON request body |

### Get message by ID
`GET https://apizie.tech/v1/security:kustomer/messages-get-message-by-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | Unique message ID. |

### Update message by ID
`POST https://apizie.tech/v1/security:kustomer/messages-update-by-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | Unique message ID. |
| replace | boolean | no | Set to `true` to update the document. Otherwise, performs the same update as a PATCH request. Default value: `false`. |
| body | object | no | JSON request body |

### Update message attributes by ID
`POST https://apizie.tech/v1/security:kustomer/messages-update-attributes-by-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | Unique message ID. |
| body | object | no | JSON request body |

### Get a Message by External ID
`GET https://apizie.tech/v1/security:kustomer/messages-get-message-by-external-id` (byok)

### Bulk create notes
`POST https://apizie.tech/v1/security:kustomer/notes-bulk-create-batch` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | no | JSON request body |

### Bulk batch update notes
`POST https://apizie.tech/v1/security:kustomer/notes-bulk-batch-update` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| ids | string | no | Comma-separated list of unique note IDs. |
| body | object | no | JSON request body |

### Get notes
`GET https://apizie.tech/v1/security:kustomer/notes-get-all` (byok)

### Create note
`POST https://apizie.tech/v1/security:kustomer/notes-create-note` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | no | JSON request body |

### Get note by ID
`GET https://apizie.tech/v1/security:kustomer/notes-get-by-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | Unique note ID. |

### Update note by ID
`POST https://apizie.tech/v1/security:kustomer/notes-update-by-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | Unique note ID. |
| replace | boolean | no | Set to `true` to update the document. Otherwise, performs the same update as a PATCH request. Default value: `false`. |
| body | object | no | JSON request body |

### Update note attributes by ID
`POST https://apizie.tech/v1/security:kustomer/notes-update-attributes-by-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | Unique note ID. |
| body | object | no | JSON request body |

…and 254 more. See the OpenAPI spec.

## Example
```
curl "https://apizie.tech/v1/security:kustomer/audit-logs-query-events" \
  -H "x-api-key: $APIZIE_KEY" \
  -H "x-upstream-key: $PROVIDER_KEY"
```

## FAQ

### How do I call the Kustomer Access Management API?
Create a free Apizie key, then send GET https://apizie.tech/v1/security:kustomer/audit-logs-query-events with the header x-api-key. Every endpoint returns { project, data, timestamp }.

### Is the Kustomer Access Management API free on Apizie?
Yes. The Free plan includes 1,000 requests a month at 100 requests a minute, no credit card. Kustomer Access Management itself also needs your own key from api.kustomerapp.com.

### Can AI agents use the Kustomer Access Management API?
Yes. Add the Apizie MCP server (https://apizie.tech/mcp) to Claude, ChatGPT, Cursor or VS Code, then ask in plain language. The agent calls run_scraper with project key security:kustomer.

### What is the status of the Kustomer Access Management API?
Needs your own provider key (bring your own key)