# klink.cloud public api

## Docs
- Root [Introduction](https://developers.klink.cloud/introduction-1913614m0.md): 
- Root [Quickstart](https://developers.klink.cloud/quickstart-1913622m0.md): 
- Root [Authentication](https://developers.klink.cloud/authentication-1913623m0.md): 
- Root [Status codes](https://developers.klink.cloud/status-codes-1913624m0.md): 
- Root [Webhook Setup](https://developers.klink.cloud/webhook-setup-1913619m0.md): 
- Root [Webhook Events and Schema](https://developers.klink.cloud/webhook-events-and-schema-1913621m0.md): 

## API Docs
- Root > Contact [Listing](https://developers.klink.cloud/listing-26393479e0.md): This endpoint allows you to retrieve a paginated list of all your contacts. By default, a maximum of ten contacts are shown per page.
- Root > Contact [Create](https://developers.klink.cloud/create-26393480e0.md): This endpoint allows you to add a new contact to your contact list in klink.cloud. To add a contact, you must provide their klink.cloud username and phone number.
- Root > Contact [Filter By SocialPlatformId](https://developers.klink.cloud/filter-by-socialplatformid-26393481e0.md): This endpoint allows you to retrieve a contact by providing their klink.cloud base on social media platform Id. Refer to the list at the top of this page to see which properties are included with contact objects.
- Root > Contact [Form Fields](https://developers.klink.cloud/form-fields-26393482e0.md): This endpoint allows you to get available contact fields including the custom fields you have created.
- Root > Contact [Detail](https://developers.klink.cloud/detail-26393483e0.md): This endpoint allows you to retrieve a contact by providing their klink.cloud id. Refer to the list at the top of this page to see which properties are included with contact objects.
- Root > Contact [Update](https://developers.klink.cloud/update-26393484e0.md): This endpoint allows you to perform an update on a contact.
- Root > Contact [Delete](https://developers.klink.cloud/delete-26393485e0.md): This endpoint allows you to delete contacts from your contact list in klink.cloud. Note: This will also delete your conversation with the given contact.
- Root > Contact [Fetch Contact Groups](https://developers.klink.cloud/fetch-contact-groups-26464907e0.md): This endpoint allows you to get contact groups. You can use this endpoint to get ids of contact groups to include in create contact endpoint.
- Root > Contact [Update tags](https://developers.klink.cloud/update-tags-27313442e0.md): This endpoint allows you to perform an update only tags on a contact.
- Root > Tag [Listing](https://developers.klink.cloud/listing-26393493e0.md): This endpoint allows you to retrieve a paginated list of all your tags. By default, a maximum of ten tags are shown per page. You can filter tags by group using the group ```query``` parameter.
- Root > Channel [Listing](https://developers.klink.cloud/listing-26393494e0.md): This endpoint allows you to retrieve a paginated list of all your channel. By default, a maximum of ten channel are shown per page.
- Root > Channel [Create](https://developers.klink.cloud/create-26393495e0.md): This endpoint allows you to create a custom channel for your own messaging platform.
- Root > Ticket [Listing](https://developers.klink.cloud/listing-26393498e0.md): This endpoint allows you to retrieve a paginated list of all your tickets. By default, a maximum of ten tickets are shown per page.
- Root > Ticket [Create](https://developers.klink.cloud/create-26393499e0.md): This endpoint allows you to create a new ticket in the system.
- Root > Ticket [Filter by Contact ID](https://developers.klink.cloud/filter-by-contact-id-26393500e0.md): 
- Root > Ticket [Form Fields](https://developers.klink.cloud/form-fields-26393501e0.md): This endpoint allows you to retrieve a paginated list of custom fields available for tickets.
- Root > Ticket [Update](https://developers.klink.cloud/update-26393502e0.md): This endpoint allows you to update an existing ticket by its ID.
- Root > Ticket [Update status](https://developers.klink.cloud/update-status-26393503e0.md): This endpoint allows you to update the status of an existing ticket by its ID.
- Root > Category [Listing](https://developers.klink.cloud/listing-26393504e0.md): 
- Root > CxLog [Listing](https://developers.klink.cloud/listing-26393497e0.md): As the name suggests, cx logs are a core part of klink.cloud — the very reason klink.cloud exists is so you can have check daily call logs conversations with your cx logs. On this page, we'll dive into the different cx logs endpoints you can use to manage cx logs programmatically. We'll look at how to query, create, update, and delete tags.
- Root > Message [Send message](https://developers.klink.cloud/send-message-26393505e0.md): This endpoint allows you to send an outgoing message to a specific contact via the Klink platform.