# 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): 
- Root [@klink.cloud/call-sdk](https://developers.klink.cloud/klink-cloudcall-sdk-2202660m0.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 > Contact [Filter By Phone Number](https://developers.klink.cloud/filter-by-phone-number-43044631e0.md): Retrieve a single contact by phone number.
- 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.
- Root > Message [Create comments](https://developers.klink.cloud/create-comments-28729820e0.md): Create a new comment in a specified room, optionally mentioning one or more users.
- Root > Message [Get Comments](https://developers.klink.cloud/get-comments-28730403e0.md): Retrieve a paginated list of comments in a chat room.
- Root > Media Manager [Get Folders](https://developers.klink.cloud/get-folders-28132967e0.md): List folders with pagination and optional filters.
- Root > Media Manager [Get Folder By ID](https://developers.klink.cloud/get-folder-by-id-28132968e0.md): Get a single folder by ID.
- Root > Media Manager [Create Folder](https://developers.klink.cloud/create-folder-28132969e0.md): Create a new folder.
- Root > Media Manager [Update Folder](https://developers.klink.cloud/update-folder-28132970e0.md): Update folder properties.
- Root > Media Manager [Delete Folder](https://developers.klink.cloud/delete-folder-28132971e0.md): Delete a folder and its descendant folders and files.
- Root > Media Manager [Get Files](https://developers.klink.cloud/get-files-28132972e0.md): List files with pagination and filters.
- Root > Media Manager [Get File By ID](https://developers.klink.cloud/get-file-by-id-28132974e0.md): Get file details by ID.
- Root > Media Manager [Create File](https://developers.klink.cloud/create-file-28132975e0.md): Create a media file using base64 data
- Root > Media Manager [Update File](https://developers.klink.cloud/update-file-28132976e0.md): Update file properties.
- Root > Media Manager [Delete File](https://developers.klink.cloud/delete-file-28132977e0.md): Soft-delete a file.
- Root > Agent Activity [Get Agents Activities](https://developers.klink.cloud/get-agents-activities-30903856e0.md): 
- Root > Telephony [Get Telephony CDR](https://developers.klink.cloud/get-telephony-cdr-30920752e0.md): 
- Root > User [Create](https://developers.klink.cloud/create-41463376e0.md): Creates a user (agent) in your workspace. The account is usable immediately — the person does not need to be invited or to log in first, which is the point of this endpoint.
- Root > User [Listing](https://developers.klink.cloud/listing-41463377e0.md): Returns a paginated list of the users in your workspace.
- Root > User [Detail](https://developers.klink.cloud/detail-41463378e0.md): Returns a single user. Also the quickest way to confirm that a newly created account has finished provisioning.
- Root > User [Update](https://developers.klink.cloud/update-41463379e0.md): Updates a user. **Send only the fields you want to change** — anything you omit is left exactly as it was, including roles.
- Root > User [Delete](https://developers.klink.cloud/delete-41463380e0.md): Deactivates a user and removes them from every queue they belong to.
- Root > Automation Queue [Create](https://developers.klink.cloud/create-41463381e0.md): Creates an automation queue — the mechanism that routes incoming conversations to agents.
- Root > Automation Queue [Listing](https://developers.klink.cloud/listing-41463383e0.md): Returns every automation queue in your workspace, each with its full member list. This endpoint is not paginated.
- Root > Automation Queue [Detail](https://developers.klink.cloud/detail-41463384e0.md): Returns a single queue with its members and routing settings.
- Root > Automation Queue [Update](https://developers.klink.cloud/update-41463385e0.md): Updates a queue. **Send only the fields you want to change** — omitted fields keep their current values, and the member list is left untouched.
- Root > Automation Queue [Delete](https://developers.klink.cloud/delete-41463386e0.md): Deletes a queue and its membership records.
- Root > Automation Queue [Add Member](https://developers.klink.cloud/add-member-41463387e0.md): Adds one user to a queue, as either an agent or a manager.
- Root > Automation Queue [Remove Member](https://developers.klink.cloud/remove-member-41463388e0.md): Removes a user from a queue. Their other queue memberships are unaffected, and the account itself is not deleted.
- Root > Role [Listing](https://developers.klink.cloud/listing-41463389e0.md): Returns the roles defined in your workspace. A role is a bundle of permissions.