# Bitly Integration via LowCodeAPI
## Overview
URL shortening and link management
## Base Endpoint
```
https://api.lowcodeapi.com/bitly/
```
## Authentication
LowCodeAPI handles authentication automatically. You only need to:
1. **Sign up** at [https://bitly.com](https://bitly.com)
2. **Get your credentials** from [https://bitly.com/a/oauth_apps](https://bitly.com/a/oauth_apps)
3. **Connect your account** in LowCodeAPI dashboard
4. **Use your `api_token`** in all requests
The `api_token` is your LowCodeAPI authentication token. LowCodeAPI will automatically:
- Fetch your Bitly API key
- Apply it to each request with `Authorization` header
**Auth Type**: API Key (Authorization header)
## API Categories
- Utilities
## Common Endpoints
### Category: App
#### Retrieve OAuth App
**Method**: `GET` | **LowCodeAPI Path**: `/v4/apps/client_id`
**Full URL**:
```
https://api.lowcodeapi.com/bitly/v4/apps/client_id?client_id={client_id}&api_token={api_token}
```
**Path Parameters**:
| `client_id` | string | The client ID of an OAuth app |
**Note**: Path parameters are passed in the URL path. The LowCodeAPI path uses static parameter names, and the actual values are passed as query parameters with the same names.
**Example Request**:
```bash
curl -X GET "https://api.lowcodeapi.com/bitly/v4/apps/client_id?client_id=VALUE&&api_token=YOUR_API_TOKEN" \
-H "Content-Type: application/json"
```
**Official Documentation**: [https://dev.bitly.com/api-reference](https://dev.bitly.com/api-reference)
---
### Category: BSDs
#### Group Overrides
**Method**: `GET` | **LowCodeAPI Path**: `/v4/groups/group_guid/overrides`
**Full URL**:
```
https://api.lowcodeapi.com/bitly/v4/groups/group_guid/overrides?group_guid={group_guid}&...&api_token={api_token}
```
**Query Parameters**:
| `created_after` | integer | No | Timestamp as an integer unix epoch |
| `limit` | integer | No | limit the amount of results returned |
| `offset` | integer | No | set the starting index of the result set |
| `bsd` | array | No | a branded short domains to filter results |
**Path Parameters**:
| `group_guid` | string | A GUID for a Bitly group |
**Note**: Path parameters are passed in the URL path. The LowCodeAPI path uses static parameter names, and the actual values are passed as query parameters with the same names.
**Example Request**:
```bash
curl -X GET "https://api.lowcodeapi.com/bitly/v4/groups/group_guid/overrides?group_guid=VALUE&...&api_token=YOUR_API_TOKEN" \
-H "Content-Type: application/json"
```
**Official Documentation**: [https://dev.bitly.com/api-reference](https://dev.bitly.com/api-reference)
---
#### Get BSDs
**Method**: `GET` | **LowCodeAPI Path**: `/v4/bsds`
**Full URL**:
```
https://api.lowcodeapi.com/bitly/v4/bsds&api_token={api_token}
```
**Example Request**:
```bash
curl -X GET "https://api.lowcodeapi.com/bitly/v4/bsds&api_token=YOUR_API_TOKEN" \
-H "Content-Type: application/json"
```
**Official Documentation**: [https://dev.bitly.com/api-reference](https://dev.bitly.com/api-reference)
---
### Category: Bitlinks
#### Get Metrics for a Bitlink by Country
**Method**: `GET` | **LowCodeAPI Path**: `/v4/bitlinks/bitlink/countries`
**Full URL**:
```
https://api.lowcodeapi.com/bitly/v4/bitlinks/bitlink/countries?bitlink={bitlink}&...&api_token={api_token}
```
**Query Parameters**:
| `unit` | string | Yes | A unit of time |
| `units` | integer | Yes | An integer representing the time units to query data for |
| `size` | integer | No | The quantity of items to be be returned |
| `unit_reference` | string | No | An ISO-8601 timestamp indicating the most recent time for which to pull metrics |
**Path Parameters**:
| `bitlink` | string | A Bitlink made of the domain and hash |
**Note**: Path parameters are passed in the URL path. The LowCodeAPI path uses static parameter names, and the actual values are passed as query parameters with the same names.
**Example Request**:
```bash
curl -X GET "https://api.lowcodeapi.com/bitly/v4/bitlinks/bitlink/countries?bitlink=VALUE&...&api_token=YOUR_API_TOKEN" \
-H "Content-Type: application/json"
```
**Official Documentation**: [https://dev.bitly.com/api-reference](https://dev.bitly.com/api-reference)
---
#### Get a Clicks Summary for a Bitlink
**Method**: `GET` | **LowCodeAPI Path**: `/v4/bitlinks/bitlink/clicks/summary`
**Full URL**:
```
https://api.lowcodeapi.com/bitly/v4/bitlinks/bitlink/clicks/summary?bitlink={bitlink}&...&api_token={api_token}
```
**Query Parameters**:
| `unit` | string | Yes | A unit of time |
| `units` | integer | Yes | An integer representing the time units to query data for |
| `unit_reference` | string | No | An ISO-8601 timestamp indicating the most recent time for which to pull metrics |
**Path Parameters**:
| `bitlink` | string | A Bitlink made of the domain and hash |
**Note**: Path parameters are passed in the URL path. The LowCodeAPI path uses static parameter names, and the actual values are passed as query parameters with the same names.
**Example Request**:
```bash
curl -X GET "https://api.lowcodeapi.com/bitly/v4/bitlinks/bitlink/clicks/summary?bitlink=VALUE&...&api_token=YOUR_API_TOKEN" \
-H "Content-Type: application/json"
```
**Official Documentation**: [https://dev.bitly.com/api-reference](https://dev.bitly.com/api-reference)
---
#### Expand a Bitlink
**Method**: `POST` | **LowCodeAPI Path**: `/v4/expand`
**Full URL**:
```
https://api.lowcodeapi.com/bitly/v4/expand&api_token={api_token}
```
**Body Parameters**:
| `bitlink_id` | string | No | |
**Example Request**:
```bash
curl -X POST "https://api.lowcodeapi.com/bitly/v4/expand?&api_token=YOUR_API_TOKEN" \
-H "Content-Type: application/json" \
-d '{"bitlink_id":"value"}'
```
**Official Documentation**: [https://dev.bitly.com/api-reference](https://dev.bitly.com/api-reference)
---
#### Delete a Bitlink
**Method**: `DELETE` | **LowCodeAPI Path**: `/v4/bitlinks/bitlink`
**Full URL**:
```
https://api.lowcodeapi.com/bitly/v4/bitlinks/bitlink?bitlink={bitlink}&api_token={api_token}
```
**Path Parameters**:
| `bitlink` | string | A Bitlink made of the domain and hash |
**Note**: Path parameters are passed in the URL path. The LowCodeAPI path uses static parameter names, and the actual values are passed as query parameters with the same names.
**Example Request**:
```bash
curl -X DELETE "https://api.lowcodeapi.com/bitly/v4/bitlinks/bitlink?bitlink=VALUE&&api_token=YOUR_API_TOKEN" \
-H "Content-Type: application/json"
```
**Official Documentation**: [https://dev.bitly.com/api-reference](https://dev.bitly.com/api-reference)
---
#### Update a Bitlink
**Method**: `PATCH` | **LowCodeAPI Path**: `/v4/bitlinks/bitlink`
**Full URL**:
```
https://api.lowcodeapi.com/bitly/v4/bitlinks/bitlink?bitlink={bitlink}&api_token={api_token}
```
**Path Parameters**:
| `bitlink` | string | A Bitlink made of the domain and hash |
**Note**: Path parameters are passed in the URL path. The LowCodeAPI path uses static parameter names, and the actual values are passed as query parameters with the same names.
**Body Parameters**:
| `archived` | boolean | No | |
| `tags` | array | No | |
| `deeplinks` | array | No | |
| `title` | string | No | |
**Example Request**:
```bash
curl -X PATCH "https://api.lowcodeapi.com/bitly/v4/bitlinks/bitlink?bitlink=VALUE&&api_token=YOUR_API_TOKEN" \
-H "Content-Type: application/json" \
-d '{"archived":"value","tags":"value","deeplinks":"value"}'
```
**Official Documentation**: [https://dev.bitly.com/api-reference](https://dev.bitly.com/api-reference)
---
#### Retrieve a Bitlink
**Method**: `GET` | **LowCodeAPI Path**: `/v4/bitlinks/bitlink`
**Full URL**:
```
https://api.lowcodeapi.com/bitly/v4/bitlinks/bitlink?bitlink={bitlink}&api_token={api_token}
```
**Path Parameters**:
| `bitlink` | string | A Bitlink made of the domain and hash |
**Note**: Path parameters are passed in the URL path. The LowCodeAPI path uses static parameter names, and the actual values are passed as query parameters with the same names.
**Example Request**:
```bash
curl -X GET "https://api.lowcodeapi.com/bitly/v4/bitlinks/bitlink?bitlink=VALUE&&api_token=YOUR_API_TOKEN" \
-H "Content-Type: application/json"
```
**Official Documentation**: [https://dev.bitly.com/api-reference](https://dev.bitly.com/api-reference)
---
#### Create a QR Code
**Method**: `POST` | **LowCodeAPI Path**: `/v4/bitlinks/bitlink/qr`
**Full URL**:
```
https://api.lowcodeapi.com/bitly/v4/bitlinks/bitlink/qr?bitlink={bitlink}&api_token={api_token}
```
**Path Parameters**:
| `bitlink` | string | A Bitlink made of the domain and hash |
**Note**: Path parameters are passed in the URL path. The LowCodeAPI path uses static parameter names, and the actual values are passed as query parameters with the same names.
**Body Parameters**:
| `color` | string | No | A color denoted in hexadecimal format ei |
| `logo_image_guid` | string | No | Logo must first be uploaded through Bitly's QR Code Modal located on the "All links" page |
| `image_format` | string | No | Determines the image format of the returned QR code |
| `exclude_bitly_logo` | boolean | No | Removes the Bitly logo from the center of the generated QR image |
| `is_hidden` | boolean | No | Determine whether to hide the QR code |
**Example Request**:
```bash
curl -X POST "https://api.lowcodeapi.com/bitly/v4/bitlinks/bitlink/qr?bitlink=VALUE&&api_token=YOUR_API_TOKEN" \
-H "Content-Type: application/json" \
-d '{"color":"value","logo_image_guid":"value","image_format":"value"}'
```
**Official Documentation**: [https://dev.bitly.com/api-reference](https://dev.bitly.com/api-reference)
---
#### Retrieve a QR Code
**Method**: `GET` | **LowCodeAPI Path**: `/v4/bitlinks/bitlink/qr`
**Full URL**:
```
https://api.lowcodeapi.com/bitly/v4/bitlinks/bitlink/qr?bitlink={bitlink}&...&api_token={api_token}
```
**Query Parameters**:
| `image_format` | string | No | Determines the image format of the returned QR code |
**Path Parameters**:
| `bitlink` | string | A Bitlink made of the domain and hash |
**Note**: Path parameters are passed in the URL path. The LowCodeAPI path uses static parameter names, and the actual values are passed as query parameters with the same names.
**Example Request**:
```bash
curl -X GET "https://api.lowcodeapi.com/bitly/v4/bitlinks/bitlink/qr?bitlink=VALUE&...&api_token=YOUR_API_TOKEN" \
-H "Content-Type: application/json"
```
**Official Documentation**: [https://dev.bitly.com/api-reference](https://dev.bitly.com/api-reference)
---
#### Update a QR Code
**Method**: `PATCH` | **LowCodeAPI Path**: `/v4/bitlinks/bitlink/qr`
**Full URL**:
```
https://api.lowcodeapi.com/bitly/v4/bitlinks/bitlink/qr?bitlink={bitlink}&api_token={api_token}
```
**Path Parameters**:
| `bitlink` | string | A Bitlink made of the domain and hash |
**Note**: Path parameters are passed in the URL path. The LowCodeAPI path uses static parameter names, and the actual values are passed as query parameters with the same names.
**Body Parameters**:
| `color` | string | No | A color denoted in hexadecimal format ei |
| `logo_image_guid` | string | No | Logo must first be uploaded through Bitly's QR Code Modal located on the "All links" page |
| `image_format` | string | No | Determines the image format of the returned QR code |
| `exclude_bitly_logo` | boolean | No | Removes the Bitly logo from the center of the generated QR image |
| `is_hidden` | boolean | No | Determine whether to hide the QR code |
**Example Request**:
```bash
curl -X PATCH "https://api.lowcodeapi.com/bitly/v4/bitlinks/bitlink/qr?bitlink=VALUE&&api_token=YOUR_API_TOKEN" \
-H "Content-Type: application/json" \
-d '{"color":"value","logo_image_guid":"value","image_format":"value"}'
```
**Official Documentation**: [https://dev.bitly.com/api-reference](https://dev.bitly.com/api-reference)
---
#### Get Metrics for a Bitlink by City
**Method**: `GET` | **LowCodeAPI Path**: `/v4/bitlinks/bitlink/cities`
**Full URL**:
```
https://api.lowcodeapi.com/bitly/v4/bitlinks/bitlink/cities?bitlink={bitlink}&...&api_token={api_token}
```
**Query Parameters**:
| `unit` | string | Yes | A unit of time |
| `units` | integer | Yes | An integer representing the time units to query data for |
| `size` | integer | No | The quantity of items to be be returned |
| `unit_reference` | string | No | An ISO-8601 timestamp indicating the most recent time for which to pull metrics |
**Path Parameters**:
| `bitlink` | string | A Bitlink made of the domain and hash |
**Note**: Path parameters are passed in the URL path. The LowCodeAPI path uses static parameter names, and the actual values are passed as query parameters with the same names.
**Example Request**:
```bash
curl -X GET "https://api.lowcodeapi.com/bitly/v4/bitlinks/bitlink/cities?bitlink=VALUE&...&api_token=YOUR_API_TOKEN" \
-H "Content-Type: application/json"
```
**Official Documentation**: [https://dev.bitly.com/api-reference](https://dev.bitly.com/api-reference)
---
#### Get Metrics for a Bitlink by Device Type
**Method**: `GET` | **LowCodeAPI Path**: `/v4/bitlinks/bitlink/devices`
**Full URL**:
```
https://api.lowcodeapi.com/bitly/v4/bitlinks/bitlink/devices?bitlink={bitlink}&...&api_token={api_token}
```
**Query Parameters**:
| `unit` | string | Yes | A unit of time |
| `units` | integer | Yes | An integer representing the time units to query data for |
| `size` | integer | No | The quantity of items to be be returned |
| `unit_reference` | string | No | An ISO-8601 timestamp indicating the most recent time for which to pull metrics |
**Path Parameters**:
| `bitlink` | string | A Bitlink made of the domain and hash |
**Note**: Path parameters are passed in the URL path. The LowCodeAPI path uses static parameter names, and the actual values are passed as query parameters with the same names.
**Example Request**:
```bash
curl -X GET "https://api.lowcodeapi.com/bitly/v4/bitlinks/bitlink/devices?bitlink=VALUE&...&api_token=YOUR_API_TOKEN" \
-H "Content-Type: application/json"
```
**Official Documentation**: [https://dev.bitly.com/api-reference](https://dev.bitly.com/api-reference)
---
#### Get Metrics for a Bitlink by Referrers by Domain
**Method**: `GET` | **LowCodeAPI Path**: `/v4/bitlinks/bitlink/referrers_by_domains`
**Full URL**:
```
https://api.lowcodeapi.com/bitly/v4/bitlinks/bitlink/referrers_by_domains?bitlink={bitlink}&...&api_token={api_token}
```
**Query Parameters**:
| `unit` | string | Yes | A unit of time |
| `units` | integer | Yes | An integer representing the time units to query data for |
| `size` | integer | No | The quantity of items to be be returned |
| `unit_reference` | string | No | An ISO-8601 timestamp indicating the most recent time for which to pull metrics |
**Path Parameters**:
| `bitlink` | string | A Bitlink made of the domain and hash |
**Note**: Path parameters are passed in the URL path. The LowCodeAPI path uses static parameter names, and the actual values are passed as query parameters with the same names.
**Example Request**:
```bash
curl -X GET "https://api.lowcodeapi.com/bitly/v4/bitlinks/bitlink/referrers_by_domains?bitlink=VALUE&...&api_token=YOUR_API_TOKEN" \
-H "Content-Type: application/json"
```
**Official Documentation**: [https://dev.bitly.com/api-reference](https://dev.bitly.com/api-reference)
---
#### Retrieve Sorted Bitlinks for Group
**Method**: `GET` | **LowCodeAPI Path**: `/v4/groups/group_guid/bitlinks/sort`
**Full URL**:
```
https://api.lowcodeapi.com/bitly/v4/groups/group_guid/bitlinks/sort?group_guid={group_guid}&sort={sort}&...&api_token={api_token}
```
**Query Parameters**:
| `unit` | string | No | A unit of time |
| `units` | integer | No | An integer representing the time units to query data for |
| `unit_reference` | string | No | An ISO-8601 timestamp indicating the most recent time for which to pull metrics |
| `size` | integer | No | The quantity of items to be be returned |
**Path Parameters**:
| `group_guid` | string | A GUID for a Bitly group |
| `sort` | string | The type of sorting that you would like to do |
**Note**: Path parameters are passed in the URL path. The LowCodeAPI path uses static parameter names, and the actual values are passed as query parameters with the same names.
**Example Request**:
```bash
curl -X GET "https://api.lowcodeapi.com/bitly/v4/groups/group_guid/bitlinks/sort?group_guid=VALUE&...&api_token=YOUR_API_TOKEN" \
-H "Content-Type: application/json"
```
**Official Documentation**: [https://dev.bitly.com/api-reference](https://dev.bitly.com/api-reference)
---
#### Create a Bitlink
**Method**: `POST` | **LowCodeAPI Path**: `/v4/bitlinks`
**Full URL**:
```
https://api.lowcodeapi.com/bitly/v4/bitlinks&api_token={api_token}
```
**Body Parameters**:
| `domain` | string | No | |
| `title` | string | No | |
| `group_guid` | string | No | Always include a specific group and custom domain in your shorten calls |
| `tags` | array | No | |
| `deeplinks` | array | No | |
| `long_url` | string | Yes | |
**Example Request**:
```bash
curl -X POST "https://api.lowcodeapi.com/bitly/v4/bitlinks?&api_token=YOUR_API_TOKEN" \
-H "Content-Type: application/json" \
-d '{"domain":"value","title":"value","group_guid":"value"}'
```
**Official Documentation**: [https://dev.bitly.com/api-reference](https://dev.bitly.com/api-reference)
---
#### Get Clicks for a Bitlink
**Method**: `GET` | **LowCodeAPI Path**: `/v4/bitlinks/bitlink/clicks`
**Full URL**:
```
https://api.lowcodeapi.com/bitly/v4/bitlinks/bitlink/clicks?bitlink={bitlink}&...&api_token={api_token}
```
**Query Parameters**:
| `unit` | string | Yes | A unit of time |
| `units` | integer | Yes | An integer representing the time units to query data for |
| `unit_reference` | string | No | An ISO-8601 timestamp indicating the most recent time for which to pull metrics |
**Path Parameters**:
| `bitlink` | string | A Bitlink made of the domain and hash |
**Note**: Path parameters are passed in the URL path. The LowCodeAPI path uses static parameter names, and the actual values are passed as query parameters with the same names.
**Example Request**:
```bash
curl -X GET "https://api.lowcodeapi.com/bitly/v4/bitlinks/bitlink/clicks?bitlink=VALUE&...&api_token=YOUR_API_TOKEN" \
-H "Content-Type: application/json"
```
**Official Documentation**: [https://dev.bitly.com/api-reference](https://dev.bitly.com/api-reference)
---
### Category: Campaigns
#### Create Channel
**Method**: `POST` | **LowCodeAPI Path**: `/v4/channels`
**Full URL**:
```
https://api.lowcodeapi.com/bitly/v4/channels&api_token={api_token}
```
**Example Request**:
```bash
curl -X POST "https://api.lowcodeapi.com/bitly/v4/channels&api_token=YOUR_API_TOKEN" \
-H "Content-Type: application/json"
```
**Official Documentation**: [https://dev.bitly.com/api-reference](https://dev.bitly.com/api-reference)
---
#### Retrieve Channels
**Method**: `GET` | **LowCodeAPI Path**: `/v4/channels`
**Full URL**:
```
https://api.lowcodeapi.com/bitly/v4/channels?...&api_token={api_token}
```
**Query Parameters**:
| `group_guid` | string | No | A GUID for a Bitly group |
| `campaign_guid` | string | No | A GUID for a Bitly campaign |
**Example Request**:
```bash
curl -X GET "https://api.lowcodeapi.com/bitly/v4/channels?...&api_token=YOUR_API_TOKEN" \
-H "Content-Type: application/json"
```
**Official Documentation**: [https://dev.bitly.com/api-reference](https://dev.bitly.com/api-reference)
---
#### Retrieve a Campaign
**Method**: `GET` | **LowCodeAPI Path**: `/v4/campaigns/campaign_guid`
**Full URL**:
```
https://api.lowcodeapi.com/bitly/v4/campaigns/campaign_guid?campaign_guid={campaign_guid}&api_token={api_token}
```
**Path Parameters**:
| `campaign_guid` | string | A GUID for a Bitly campaign |
**Note**: Path parameters are passed in the URL path. The LowCodeAPI path uses static parameter names, and the actual values are passed as query parameters with the same names.
**Example Request**:
```bash
curl -X GET "https://api.lowcodeapi.com/bitly/v4/campaigns/campaign_guid?campaign_guid=VALUE&&api_token=YOUR_API_TOKEN" \
-H "Content-Type: application/json"
```
**Official Documentation**: [https://dev.bitly.com/api-reference](https://dev.bitly.com/api-reference)
---
#### Update Campaign
**Method**: `PATCH` | **LowCodeAPI Path**: `/v4/campaigns/campaign_guid`
**Full URL**:
```
https://api.lowcodeapi.com/bitly/v4/campaigns/campaign_guid?campaign_guid={campaign_guid}&api_token={api_token}
```
**Path Parameters**:
| `campaign_guid` | string | A GUID for a Bitly campaign |
**Note**: Path parameters are passed in the URL path. The LowCodeAPI path uses static parameter names, and the actual values are passed as query parameters with the same names.
**Body Parameters**:
| `group_guid` | string | No | |
| `channel_guids` | array | No | |
| `description` | string | No | |
| `name` | string | No | |
**Example Request**:
```bash
curl -X PATCH "https://api.lowcodeapi.com/bitly/v4/campaigns/campaign_guid?campaign_guid=VALUE&&api_token=YOUR_API_TOKEN" \
-H "Content-Type: application/json" \
-d '{"group_guid":"value","channel_guids":"value","description":"value"}'
```
**Official Documentation**: [https://dev.bitly.com/api-reference](https://dev.bitly.com/api-reference)
---
#### Create Campaign
**Method**: `POST` | **LowCodeAPI Path**: `/v4/campaigns`
**Full URL**:
```
https://api.lowcodeapi.com/bitly/v4/campaigns&api_token={api_token}
```
**Body Parameters**:
| `group_guid` | string | No | |
| `channel_guids` | array | No | |
| `description` | string | No | |
| `name` | string | No | |
**Example Request**:
```bash
curl -X POST "https://api.lowcodeapi.com/bitly/v4/campaigns?&api_token=YOUR_API_TOKEN" \
-H "Content-Type: application/json" \
-d '{"group_guid":"value","channel_guids":"value","description":"value"}'
```
**Official Documentation**: [https://dev.bitly.com/api-reference](https://dev.bitly.com/api-reference)
---
#### Retrieve Campaigns
**Method**: `GET` | **LowCodeAPI Path**: `/v4/campaigns`
**Full URL**:
```
https://api.lowcodeapi.com/bitly/v4/campaigns?...&api_token={api_token}
```
**Query Parameters**:
| `group_guid` | string | No | A GUID for a Bitly group |
**Example Request**:
```bash
curl -X GET "https://api.lowcodeapi.com/bitly/v4/campaigns?...&api_token=YOUR_API_TOKEN" \
-H "Content-Type: application/json"
```
**Official Documentation**: [https://dev.bitly.com/api-reference](https://dev.bitly.com/api-reference)
---
#### Get a Channel
**Method**: `GET` | **LowCodeAPI Path**: `/v4/channels/channel_guid`
**Full URL**:
```
https://api.lowcodeapi.com/bitly/v4/channels/channel_guid?channel_guid={channel_guid}&api_token={api_token}
```
**Path Parameters**:
| `channel_guid` | string | A GUID for a Bitly Channel |
**Note**: Path parameters are passed in the URL path. The LowCodeAPI path uses static parameter names, and the actual values are passed as query parameters with the same names.
**Example Request**:
```bash
curl -X GET "https://api.lowcodeapi.com/bitly/v4/channels/channel_guid?channel_guid=VALUE&&api_token=YOUR_API_TOKEN" \
-H "Content-Type: application/json"
```
**Official Documentation**: [https://dev.bitly.com/api-reference](https://dev.bitly.com/api-reference)
---
#### Update a Channel
**Method**: `PATCH` | **LowCodeAPI Path**: `/v4/channels/channel_guid`
**Full URL**:
```
https://api.lowcodeapi.com/bitly/v4/channels/channel_guid?channel_guid={channel_guid}&api_token={api_token}
```
**Path Parameters**:
| `channel_guid` | string | A GUID for a Bitly Channel |
**Note**: Path parameters are passed in the URL path. The LowCodeAPI path uses static parameter names, and the actual values are passed as query parameters with the same names.
**Example Request**:
```bash
curl -X PATCH "https://api.lowcodeapi.com/bitly/v4/channels/channel_guid?channel_guid=VALUE&&api_token=YOUR_API_TOKEN" \
-H "Content-Type: application/json"
```
**Official Documentation**: [https://dev.bitly.com/api-reference](https://dev.bitly.com/api-reference)
---
### Category: Custom Bitlinks
#### Add Custom Bitlink
**Method**: `POST` | **LowCodeAPI Path**: `/v4/custom_bitlinks`
**Full URL**:
```
https://api.lowcodeapi.com/bitly/v4/custom_bitlinks&api_token={api_token}
```
**Body Parameters**:
| `bitlink_id` | string | No | |
| `custom_bitlink` | string | No | |
**Example Request**:
```bash
curl -X POST "https://api.lowcodeapi.com/bitly/v4/custom_bitlinks?&api_token=YOUR_API_TOKEN" \
-H "Content-Type: application/json" \
-d '{"bitlink_id":"value","custom_bitlink":"value"}'
```
**Official Documentation**: [https://dev.bitly.com/api-reference](https://dev.bitly.com/api-reference)
---
#### Get Metrics for a Custom Bitlink by Destination
**Method**: `GET` | **LowCodeAPI Path**: `/v4/custom_bitlinks/custom_bitlink/clicks_by_destination`
**Full URL**:
```
https://api.lowcodeapi.com/bitly/v4/custom_bitlinks/custom_bitlink/clicks_by_destination?custom_bitlink={custom_bitlink}&...&api_token={api_token}
```
**Query Parameters**:
| `unit` | string | Yes | A unit of time |
| `units` | integer | Yes | An integer representing the time units to query data for |
| `unit_reference` | string | No | An ISO-8601 timestamp indicating the most recent time for which to pull metrics |
**Path Parameters**:
| `custom_bitlink` | string | A Custom Bitlink made of the domain and keyword |
**Note**: Path parameters are passed in the URL path. The LowCodeAPI path uses static parameter names, and the actual values are passed as query parameters with the same names.
**Example Request**:
```bash
curl -X GET "https://api.lowcodeapi.com/bitly/v4/custom_bitlinks/custom_bitlink/clicks_by_destination?custom_bitlink=VALUE&...&api_token=YOUR_API_TOKEN" \
-H "Content-Type: application/json"
```
**Official Documentation**: [https://dev.bitly.com/api-reference](https://dev.bitly.com/api-reference)
---
#### Get Clicks for a Custom Bitlink's Entire History
**Method**: `GET` | **LowCodeAPI Path**: `/v4/custom_bitlinks/custom_bitlink/clicks`
**Full URL**:
```
https://api.lowcodeapi.com/bitly/v4/custom_bitlinks/custom_bitlink/clicks?custom_bitlink={custom_bitlink}&...&api_token={api_token}
```
**Query Parameters**:
| `unit` | string | Yes | A unit of time |
| `units` | integer | Yes | An integer representing the time units to query data for |
| `unit_reference` | string | No | An ISO-8601 timestamp indicating the most recent time for which to pull metrics |
**Path Parameters**:
| `custom_bitlink` | string | A Custom Bitlink made of the domain and keyword |
**Note**: Path parameters are passed in the URL path. The LowCodeAPI path uses static parameter names, and the actual values are passed as query parameters with the same names.
**Example Request**:
```bash
curl -X GET "https://api.lowcodeapi.com/bitly/v4/custom_bitlinks/custom_bitlink/clicks?custom_bitlink=VALUE&...&api_token=YOUR_API_TOKEN" \
-H "Content-Type: application/json"
```
**Official Documentation**: [https://dev.bitly.com/api-reference](https://dev.bitly.com/api-reference)
---
#### Update Custom Bitlink
**Method**: `PATCH` | **LowCodeAPI Path**: `/v4/custom_bitlinks/custom_bitlink`
**Full URL**:
```
https://api.lowcodeapi.com/bitly/v4/custom_bitlinks/custom_bitlink?custom_bitlink={custom_bitlink}&api_token={api_token}
```
**Path Parameters**:
| `custom_bitlink` | string | A Custom Bitlink made of the domain and keyword |
**Note**: Path parameters are passed in the URL path. The LowCodeAPI path uses static parameter names, and the actual values are passed as query parameters with the same names.
**Body Parameters**:
| `bitlink_id` | string | No | |
**Example Request**:
```bash
curl -X PATCH "https://api.lowcodeapi.com/bitly/v4/custom_bitlinks/custom_bitlink?custom_bitlink=VALUE&&api_token=YOUR_API_TOKEN" \
-H "Content-Type: application/json" \
-d '{"bitlink_id":"value"}'
```
**Official Documentation**: [https://dev.bitly.com/api-reference](https://dev.bitly.com/api-reference)
---
#### Retrieve Custom Bitlink
**Method**: `GET` | **LowCodeAPI Path**: `/v4/custom_bitlinks/custom_bitlink`
**Full URL**:
```
https://api.lowcodeapi.com/bitly/v4/custom_bitlinks/custom_bitlink?custom_bitlink={custom_bitlink}&api_token={api_token}
```
**Path Parameters**:
| `custom_bitlink` | string | A Custom Bitlink made of the domain and keyword |
**Note**: Path parameters are passed in the URL path. The LowCodeAPI path uses static parameter names, and the actual values are passed as query parameters with the same names.
**Example Request**:
```bash
curl -X GET "https://api.lowcodeapi.com/bitly/v4/custom_bitlinks/custom_bitlink?custom_bitlink=VALUE&&api_token=YOUR_API_TOKEN" \
-H "Content-Type: application/json"
```
**Official Documentation**: [https://dev.bitly.com/api-reference](https://dev.bitly.com/api-reference)
---
### Category: Groups
#### Get Click Metrics for a Group by Referring Networks
**Method**: `GET` | **LowCodeAPI Path**: `/v4/groups/group_guid/referring_networks`
**Full URL**:
```
https://api.lowcodeapi.com/bitly/v4/groups/group_guid/referring_networks?group_guid={group_guid}&api_token={api_token}
```
**Path Parameters**:
| `group_guid` | string | A GUID for a Bitly group |
**Note**: Path parameters are passed in the URL path. The LowCodeAPI path uses static parameter names, and the actual values are passed as query parameters with the same names.
**Example Request**:
```bash
curl -X GET "https://api.lowcodeapi.com/bitly/v4/groups/group_guid/referring_networks?group_guid=VALUE&&api_token=YOUR_API_TOKEN" \
-H "Content-Type: application/json"
```
**Official Documentation**: [https://dev.bitly.com/api-reference](https://dev.bitly.com/api-reference)
---
#### Get clicks by group
**Method**: `GET` | **LowCodeAPI Path**: `/v4/groups/group_guid/clicks`
**Full URL**:
```
https://api.lowcodeapi.com/bitly/v4/groups/group_guid/clicks?group_guid={group_guid}&...&api_token={api_token}
```
**Query Parameters**:
| `unit` | string | Yes | A unit of time |
| `units` | integer | Yes | An integer representing the time units to query data for |
| `unit_reference` | string | No | An ISO-8601 timestamp indicating the most recent time for which to pull metrics |
**Path Parameters**:
| `group_guid` | string | A GUID for a Bitly group |
**Note**: Path parameters are passed in the URL path. The LowCodeAPI path uses static parameter names, and the actual values are passed as query parameters with the same names.
**Example Request**:
```bash
curl -X GET "https://api.lowcodeapi.com/bitly/v4/groups/group_guid/clicks?group_guid=VALUE&...&api_token=YOUR_API_TOKEN" \
-H "Content-Type: application/json"
```
**Official Documentation**: [https://dev.bitly.com/api-reference](https://dev.bitly.com/api-reference)
---
#### Get Click Metrics for a Group by Device Type
**Method**: `GET` | **LowCodeAPI Path**: `/v4/groups/group_guid/devices`
**Full URL**:
```
https://api.lowcodeapi.com/bitly/v4/groups/group_guid/devices?group_guid={group_guid}&...&api_token={api_token}
```
**Query Parameters**:
| `unit` | string | Yes | A unit of time |
| `units` | integer | Yes | An integer representing the time units to query data for |
| `size` | integer | No | The quantity of items to be be returned |
| `unit_reference` | string | No | An ISO-8601 timestamp indicating the most recent time for which to pull metrics |
**Path Parameters**:
| `group_guid` | string | A GUID for a Bitly group |
**Note**: Path parameters are passed in the URL path. The LowCodeAPI path uses static parameter names, and the actual values are passed as query parameters with the same names.
**Example Request**:
```bash
curl -X GET "https://api.lowcodeapi.com/bitly/v4/groups/group_guid/devices?group_guid=VALUE&...&api_token=YOUR_API_TOKEN" \
-H "Content-Type: application/json"
```
**Official Documentation**: [https://dev.bitly.com/api-reference](https://dev.bitly.com/api-reference)
---
#### Get Click Metrics for a Group by Country
**Method**: `GET` | **LowCodeAPI Path**: `/v4/groups/group_guid/countries`
**Full URL**:
```
https://api.lowcodeapi.com/bitly/v4/groups/group_guid/countries?group_guid={group_guid}&...&api_token={api_token}
```
**Query Parameters**:
| `unit` | string | Yes | A unit of time |
| `units` | integer | Yes | An integer representing the time units to query data for |
| `size` | integer | No | The quantity of items to be be returned |
| `unit_reference` | string | No | An ISO-8601 timestamp indicating the most recent time for which to pull metrics |
**Path Parameters**:
| `group_guid` | string | A GUID for a Bitly group |
**Note**: Path parameters are passed in the URL path. The LowCodeAPI path uses static parameter names, and the actual values are passed as query parameters with the same names.
**Example Request**:
```bash
curl -X GET "https://api.lowcodeapi.com/bitly/v4/groups/group_guid/countries?group_guid=VALUE&...&api_token=YOUR_API_TOKEN" \
-H "Content-Type: application/json"
```
**Official Documentation**: [https://dev.bitly.com/api-reference](https://dev.bitly.com/api-reference)
---
#### Retrieve QR Code Logo Images
**Method**: `GET` | **LowCodeAPI Path**: `/v4/groups/group_guid/qr/images`
**Full URL**:
```
https://api.lowcodeapi.com/bitly/v4/groups/group_guid/qr/images?group_guid={group_guid}&api_token={api_token}
```
**Path Parameters**:
| `group_guid` | string | A GUID for a Bitly group |
**Note**: Path parameters are passed in the URL path. The LowCodeAPI path uses static parameter names, and the actual values are passed as query parameters with the same names.
**Example Request**:
```bash
curl -X GET "https://api.lowcodeapi.com/bitly/v4/groups/group_guid/qr/images?group_guid=VALUE&&api_token=YOUR_API_TOKEN" \
-H "Content-Type: application/json"
```
**Official Documentation**: [https://dev.bitly.com/api-reference](https://dev.bitly.com/api-reference)
---
#### Update a Group
**Method**: `PATCH` | **LowCodeAPI Path**: `/v4/groups/group_guid`
**Full URL**:
```
https://api.lowcodeapi.com/bitly/v4/groups/group_guid?group_guid={group_guid}&api_token={api_token}
```
**Path Parameters**:
| `group_guid` | string | A GUID for a Bitly group |
**Note**: Path parameters are passed in the URL path. The LowCodeAPI path uses static parameter names, and the actual values are passed as query parameters with the same names.
**Body Parameters**:
| `bsds` | array | No | |
| `name` | string | No | |
| `organization_guid` | string | No | |
**Example Request**:
```bash
curl -X PATCH "https://api.lowcodeapi.com/bitly/v4/groups/group_guid?group_guid=VALUE&&api_token=YOUR_API_TOKEN" \
-H "Content-Type: application/json" \
-d '{"bsds":"value","name":"value","organization_guid":"value"}'
```
**Official Documentation**: [https://dev.bitly.com/api-reference](https://dev.bitly.com/api-reference)
---
#### Retrieve a Group
**Method**: `GET` | **LowCodeAPI Path**: `/v4/groups/group_guid`
**Full URL**:
```
https://api.lowcodeapi.com/bitly/v4/groups/group_guid?group_guid={group_guid}&api_token={api_token}
```
**Path Parameters**:
| `group_guid` | string | A GUID for a Bitly group |
**Note**: Path parameters are passed in the URL path. The LowCodeAPI path uses static parameter names, and the actual values are passed as query parameters with the same names.
**Example Request**:
```bash
curl -X GET "https://api.lowcodeapi.com/bitly/v4/groups/group_guid?group_guid=VALUE&&api_token=YOUR_API_TOKEN" \
-H "Content-Type: application/json"
```
**Official Documentation**: [https://dev.bitly.com/api-reference](https://dev.bitly.com/api-reference)
---
#### Get Click Metrics for a Group by City
**Method**: `GET` | **LowCodeAPI Path**: `/v4/groups/group_guid/cities`
**Full URL**:
```
https://api.lowcodeapi.com/bitly/v4/groups/group_guid/cities?group_guid={group_guid}&...&api_token={api_token}
```
**Query Parameters**:
| `unit` | string | Yes | A unit of time |
| `units` | integer | Yes | An integer representing the time units to query data for |
| `size` | integer | No | The quantity of items to be be returned |
| `unit_reference` | string | No | An ISO-8601 timestamp indicating the most recent time for which to pull metrics |
**Path Parameters**:
| `group_guid` | string | A GUID for a Bitly group |
**Note**: Path parameters are passed in the URL path. The LowCodeAPI path uses static parameter names, and the actual values are passed as query parameters with the same names.
**Example Request**:
```bash
curl -X GET "https://api.lowcodeapi.com/bitly/v4/groups/group_guid/cities?group_guid=VALUE&...&api_token=YOUR_API_TOKEN" \
-H "Content-Type: application/json"
```
**Official Documentation**: [https://dev.bitly.com/api-reference](https://dev.bitly.com/api-reference)
---
#### Retrieve Group Shorten Counts
**Method**: `GET` | **LowCodeAPI Path**: `/v4/groups/group_guid/shorten_counts`
**Full URL**:
```
https://api.lowcodeapi.com/bitly/v4/groups/group_guid/shorten_counts?group_guid={group_guid}&...&api_token={api_token}
```
**Query Parameters**:
| `unit` | string | Yes | A unit of time |
| `units` | integer | Yes | An integer representing the time units to query data for |
| `unit_reference` | string | No | An ISO-8601 timestamp indicating the most recent time for which to pull metrics |
**Path Parameters**:
| `group_guid` | string | A GUID for a Bitly group |
**Note**: Path parameters are passed in the URL path. The LowCodeAPI path uses static parameter names, and the actual values are passed as query parameters with the same names.
**Example Request**:
```bash
curl -X GET "https://api.lowcodeapi.com/bitly/v4/groups/group_guid/shorten_counts?group_guid=VALUE&...&api_token=YOUR_API_TOKEN" \
-H "Content-Type: application/json"
```
**Official Documentation**: [https://dev.bitly.com/api-reference](https://dev.bitly.com/api-reference)
---
#### Retrieve Groups
**Method**: `GET` | **LowCodeAPI Path**: `/v4/groups`
**Full URL**:
```
https://api.lowcodeapi.com/bitly/v4/groups?...&api_token={api_token}
```
**Query Parameters**:
| `organization_guid` | string | No | A GUID for a Bitly organization |
**Example Request**:
```bash
curl -X GET "https://api.lowcodeapi.com/bitly/v4/groups?...&api_token=YOUR_API_TOKEN" \
-H "Content-Type: application/json"
```
**Official Documentation**: [https://dev.bitly.com/api-reference](https://dev.bitly.com/api-reference)
---
#### Retrieve Group Preferences
**Method**: `GET` | **LowCodeAPI Path**: `/v4/groups/group_guid/preferences`
**Full URL**:
```
https://api.lowcodeapi.com/bitly/v4/groups/group_guid/preferences?group_guid={group_guid}&api_token={api_token}
```
**Path Parameters**:
| `group_guid` | string | A GUID for a Bitly group |
**Note**: Path parameters are passed in the URL path. The LowCodeAPI path uses static parameter names, and the actual values are passed as query parameters with the same names.
**Example Request**:
```bash
curl -X GET "https://api.lowcodeapi.com/bitly/v4/groups/group_guid/preferences?group_guid=VALUE&&api_token=YOUR_API_TOKEN" \
-H "Content-Type: application/json"
```
**Official Documentation**: [https://dev.bitly.com/api-reference](https://dev.bitly.com/api-reference)
---
#### Update Group Preferences
**Method**: `PATCH` | **LowCodeAPI Path**: `/v4/groups/group_guid/preferences`
**Full URL**:
```
https://api.lowcodeapi.com/bitly/v4/groups/group_guid/preferences?group_guid={group_guid}&api_token={api_token}
```
**Path Parameters**:
| `group_guid` | string | A GUID for a Bitly group |
**Note**: Path parameters are passed in the URL path. The LowCodeAPI path uses static parameter names, and the actual values are passed as query parameters with the same names.
**Body Parameters**:
| `group_guid` | string | No | |
| `domain_preference` | string | No | |
**Example Request**:
```bash
curl -X PATCH "https://api.lowcodeapi.com/bitly/v4/groups/group_guid/preferences?group_guid=VALUE&&api_token=YOUR_API_TOKEN" \
-H "Content-Type: application/json" \
-d '{"group_guid":"value","domain_preference":"value"}'
```
**Official Documentation**: [https://dev.bitly.com/api-reference](https://dev.bitly.com/api-reference)
---
#### Retrieve Tags by Group
**Method**: `GET` | **LowCodeAPI Path**: `/v4/groups/group_guid/tags`
**Full URL**:
```
https://api.lowcodeapi.com/bitly/v4/groups/group_guid/tags?group_guid={group_guid}&api_token={api_token}
```
**Path Parameters**:
| `group_guid` | string | A GUID for a Bitly group |
**Note**: Path parameters are passed in the URL path. The LowCodeAPI path uses static parameter names, and the actual values are passed as query parameters with the same names.
**Example Request**:
```bash
curl -X GET "https://api.lowcodeapi.com/bitly/v4/groups/group_guid/tags?group_guid=VALUE&&api_token=YOUR_API_TOKEN" \
-H "Content-Type: application/json"
```
**Official Documentation**: [https://dev.bitly.com/api-reference](https://dev.bitly.com/api-reference)
---
### Category: Organizations
#### Get Shorten Counts for an Organization
**Method**: `GET` | **LowCodeAPI Path**: `/v4/organizations/organization_guid/shorten_counts`
**Full URL**:
```
https://api.lowcodeapi.com/bitly/v4/organizations/organization_guid/shorten_counts?organization_guid={organization_guid}&...&api_token={api_token}
```
**Query Parameters**:
| `unit` | string | Yes | A unit of time |
| `units` | integer | Yes | An integer representing the time units to query data for |
| `unit_reference` | string | No | An ISO-8601 timestamp indicating the most recent time for which to pull metrics |
**Path Parameters**:
| `organization_guid` | string | A GUID for a Bitly organization |
**Note**: Path parameters are passed in the URL path. The LowCodeAPI path uses static parameter names, and the actual values are passed as query parameters with the same names.
**Example Request**:
```bash
curl -X GET "https://api.lowcodeapi.com/bitly/v4/organizations/organization_guid/shorten_counts?organization_guid=VALUE&...&api_token=YOUR_API_TOKEN" \
-H "Content-Type: application/json"
```
**Official Documentation**: [https://dev.bitly.com/api-reference](https://dev.bitly.com/api-reference)
---
#### Retrieve an Organization
**Method**: `GET` | **LowCodeAPI Path**: `/v4/organizations/organization_guid`
**Full URL**:
```
https://api.lowcodeapi.com/bitly/v4/organizations/organization_guid?organization_guid={organization_guid}&api_token={api_token}
```
**Path Parameters**:
| `organization_guid` | string | A GUID for a Bitly organization |
**Note**: Path parameters are passed in the URL path. The LowCodeAPI path uses static parameter names, and the actual values are passed as query parameters with the same names.
**Example Request**:
```bash
curl -X GET "https://api.lowcodeapi.com/bitly/v4/organizations/organization_guid?organization_guid=VALUE&&api_token=YOUR_API_TOKEN" \
-H "Content-Type: application/json"
```
**Official Documentation**: [https://dev.bitly.com/api-reference](https://dev.bitly.com/api-reference)
---
#### Get Plan Limits
**Method**: `GET` | **LowCodeAPI Path**: `/v4/organizations/organization_guid/plan_limits`
**Full URL**:
```
https://api.lowcodeapi.com/bitly/v4/organizations/organization_guid/plan_limits?organization_guid={organization_guid}&api_token={api_token}
```
**Path Parameters**:
| `organization_guid` | string | A GUID for a Bitly organization |
**Note**: Path parameters are passed in the URL path. The LowCodeAPI path uses static parameter names, and the actual values are passed as query parameters with the same names.
**Example Request**:
```bash
curl -X GET "https://api.lowcodeapi.com/bitly/v4/organizations/organization_guid/plan_limits?organization_guid=VALUE&&api_token=YOUR_API_TOKEN" \
-H "Content-Type: application/json"
```
**Official Documentation**: [https://dev.bitly.com/api-reference](https://dev.bitly.com/api-reference)
---
#### Retrieve Organizations
**Method**: `GET` | **LowCodeAPI Path**: `/v4/organizations`
**Full URL**:
```
https://api.lowcodeapi.com/bitly/v4/organizations&api_token={api_token}
```
**Example Request**:
```bash
curl -X GET "https://api.lowcodeapi.com/bitly/v4/organizations&api_token=YOUR_API_TOKEN" \
-H "Content-Type: application/json"
```
**Official Documentation**: [https://dev.bitly.com/api-reference](https://dev.bitly.com/api-reference)
---
### Category: User
#### Update a User
**Method**: `PATCH` | **LowCodeAPI Path**: `/v4/user`
**Full URL**:
```
https://api.lowcodeapi.com/bitly/v4/user&api_token={api_token}
```
**Body Parameters**:
| `default_group_guid` | string | No | |
| `name` | string | No | |
**Example Request**:
```bash
curl -X PATCH "https://api.lowcodeapi.com/bitly/v4/user?&api_token=YOUR_API_TOKEN" \
-H "Content-Type: application/json" \
-d '{"default_group_guid":"value","name":"value"}'
```
**Official Documentation**: [https://dev.bitly.com/api-reference](https://dev.bitly.com/api-reference)
---
#### Retrieve a User
**Method**: `GET` | **LowCodeAPI Path**: `/v4/user`
**Full URL**:
```
https://api.lowcodeapi.com/bitly/v4/user&api_token={api_token}
```
**Example Request**:
```bash
curl -X GET "https://api.lowcodeapi.com/bitly/v4/user&api_token=YOUR_API_TOKEN" \
-H "Content-Type: application/json"
```
**Official Documentation**: [https://dev.bitly.com/api-reference](https://dev.bitly.com/api-reference)
---
#### Get Platform Limits
**Method**: `GET` | **LowCodeAPI Path**: `/v4/user/platform_limits`
**Full URL**:
```
https://api.lowcodeapi.com/bitly/v4/user/platform_limits?...&api_token={api_token}
```
**Query Parameters**:
| `path` | string | No | The specific path for which information is requested |
**Example Request**:
```bash
curl -X GET "https://api.lowcodeapi.com/bitly/v4/user/platform_limits?...&api_token=YOUR_API_TOKEN" \
-H "Content-Type: application/json"
```
**Official Documentation**: [https://dev.bitly.com/api-reference](https://dev.bitly.com/api-reference)
---
### Category: Webhooks
#### Verify Webhook
**Method**: `POST` | **LowCodeAPI Path**: `/v4/webhooks/webhook_guid/verify`
**Full URL**:
```
https://api.lowcodeapi.com/bitly/v4/webhooks/webhook_guid/verify?webhook_guid={webhook_guid}&api_token={api_token}
```
**Path Parameters**:
| `webhook_guid` | string | A GUID for a Bitly webhook |
**Note**: Path parameters are passed in the URL path. The LowCodeAPI path uses static parameter names, and the actual values are passed as query parameters with the same names.
**Example Request**:
```bash
curl -X POST "https://api.lowcodeapi.com/bitly/v4/webhooks/webhook_guid/verify?webhook_guid=VALUE&&api_token=YOUR_API_TOKEN" \
-H "Content-Type: application/json"
```
**Official Documentation**: [https://dev.bitly.com/api-reference](https://dev.bitly.com/api-reference)
---
#### Retrieve Webhook
**Method**: `GET` | **LowCodeAPI Path**: `/v4/webhooks/webhook_guid`
**Full URL**:
```
https://api.lowcodeapi.com/bitly/v4/webhooks/webhook_guid?webhook_guid={webhook_guid}&api_token={api_token}
```
**Path Parameters**:
| `webhook_guid` | string | A GUID for a Bitly webhook |
**Note**: Path parameters are passed in the URL path. The LowCodeAPI path uses static parameter names, and the actual values are passed as query parameters with the same names.
**Example Request**:
```bash
curl -X GET "https://api.lowcodeapi.com/bitly/v4/webhooks/webhook_guid?webhook_guid=VALUE&&api_token=YOUR_API_TOKEN" \
-H "Content-Type: application/json"
```
**Official Documentation**: [https://dev.bitly.com/api-reference](https://dev.bitly.com/api-reference)
---
#### Update Webhook
**Method**: `PATCH` | **LowCodeAPI Path**: `/v4/webhooks/webhook_guid`
**Full URL**:
```
https://api.lowcodeapi.com/bitly/v4/webhooks/webhook_guid?webhook_guid={webhook_guid}&api_token={api_token}
```
**Path Parameters**:
| `webhook_guid` | string | A GUID for a Bitly webhook |
**Note**: Path parameters are passed in the URL path. The LowCodeAPI path uses static parameter names, and the actual values are passed as query parameters with the same names.
**Body Parameters**:
| `name` | string | No | |
| `url` | string | No | |
| `group_guid` | string | No | |
| `fetch_tags` | boolean | No | |
| `is_active` | boolean | No | |
| `organization_guid` | string | No | |
| `client_id` | string | No | |
| `client_secret` | string | No | |
**Example Request**:
```bash
curl -X PATCH "https://api.lowcodeapi.com/bitly/v4/webhooks/webhook_guid?webhook_guid=VALUE&&api_token=YOUR_API_TOKEN" \
-H "Content-Type: application/json" \
-d '{"name":"value","url":"value","group_guid":"value"}'
```
**Official Documentation**: [https://dev.bitly.com/api-reference](https://dev.bitly.com/api-reference)
---
#### Delete Webhook
**Method**: `DELETE` | **LowCodeAPI Path**: `/v4/webhooks/webhook_guid`
**Full URL**:
```
https://api.lowcodeapi.com/bitly/v4/webhooks/webhook_guid?webhook_guid={webhook_guid}&api_token={api_token}
```
**Path Parameters**:
| `webhook_guid` | string | A GUID for a Bitly webhook |
**Note**: Path parameters are passed in the URL path. The LowCodeAPI path uses static parameter names, and the actual values are passed as query parameters with the same names.
**Example Request**:
```bash
curl -X DELETE "https://api.lowcodeapi.com/bitly/v4/webhooks/webhook_guid?webhook_guid=VALUE&&api_token=YOUR_API_TOKEN" \
-H "Content-Type: application/json"
```
**Official Documentation**: [https://dev.bitly.com/api-reference](https://dev.bitly.com/api-reference)
---
#### Create Webhook
**Method**: `POST` | **LowCodeAPI Path**: `/v4/webhooks`
**Full URL**:
```
https://api.lowcodeapi.com/bitly/v4/webhooks&api_token={api_token}
```
**Body Parameters**:
| `name` | string | Yes | |
| `url` | string | Yes | |
| `group_guid` | string | No | |
| `fetch_tags` | boolean | No | |
| `is_active` | boolean | No | |
| `organization_guid` | string | Yes | |
| `client_id` | string | No | |
| `client_secret` | string | No | |
**Example Request**:
```bash
curl -X POST "https://api.lowcodeapi.com/bitly/v4/webhooks?&api_token=YOUR_API_TOKEN" \
-H "Content-Type: application/json" \
-d '{"name":"value","url":"value","group_guid":"value"}'
```
**Official Documentation**: [https://dev.bitly.com/api-reference](https://dev.bitly.com/api-reference)
---
#### Get Webhooks
**Method**: `GET` | **LowCodeAPI Path**: `/v4/organizations/organization_guid/webhooks`
**Full URL**:
```
https://api.lowcodeapi.com/bitly/v4/organizations/organization_guid/webhooks?organization_guid={organization_guid}&api_token={api_token}
```
**Path Parameters**:
| `organization_guid` | string | A GUID for a Bitly organization |
**Note**: Path parameters are passed in the URL path. The LowCodeAPI path uses static parameter names, and the actual values are passed as query parameters with the same names.
**Example Request**:
```bash
curl -X GET "https://api.lowcodeapi.com/bitly/v4/organizations/organization_guid/webhooks?organization_guid=VALUE&&api_token=YOUR_API_TOKEN" \
-H "Content-Type: application/json"
```
**Official Documentation**: [https://dev.bitly.com/api-reference](https://dev.bitly.com/api-reference)
---
## Usage Examples
### Example 1: Basic Usage
Get started with Bitly API by making your first request.
```bash
# Your example code here
# This demonstrates basic usage
curl -X GET "https://api.lowcodeapi.com/bitly/?api_token=YOUR_API_TOKEN"
```
### Example 2: Advanced Usage
Explore more advanced features and parameters.
```bash
# Your example code here
# This demonstrates advanced usage
curl -X GET "https://api.lowcodeapi.com/bitly/?api_token=YOUR_API_TOKEN"
```
## Complete Endpoint Reference
For a complete list of all endpoints and their parameters, refer to:
- **OpenAPI Definition**: `https://backend.lowcodeapi.com/bitly/definition`
- **Official Provider Documentation**: [https://dev.bitly.com/api-reference](https://dev.bitly.com/api-reference)
## Rate Limits & Best Practices
- Check your Bitly account for specific rate limits
- Use appropriate error handling and retry logic
- Cache responses when appropriate to reduce API calls
## Error Handling
Standard HTTP status codes apply:
- `400` - Invalid request parameters
- `401` - Unauthorized (check your API key)
- `429` - Rate limit exceeded
- `500` - Internal server error