GET /groups/{group_guid}/bitlinks

Returns a paginated collection of Bitlinks for a group. The list of custom bitlinks has newest entries first.

Servers

Path parameters

Name Type Required Description
group_guid String Yes

A GUID for a Bitly group

Query parameters

Name Type Required Description
encoding_login[] Array No

Filter by the login of the authenticated user that created the Bitlink

size Integer No

The quantity of items to be be returned

Default value: 50

archived String No

Whether or not to include archived resources

Valid values:

  • "on"
  • "both"
  • "off"

Default value: "off"

campaign_guid String No

Filter to return only links for the given campaign GUID, can be provided

has_qr_codes String No

a filter value if the resource has any QR codes

Valid values:

  • "on"
  • "both"
  • "off"

Default value: "both"

is_expired String No

filter bitlinks by expiration status

Valid values:

  • "on"
  • "both"
  • "off"

Default value: "both"

launchpad_ids[] Array No

Filter by launchpad id

created_before Integer No

Timestamp as an integer unix epoch (seconds only)

has_expiration String No

filter bitlinks by presence of expiration

Valid values:

  • "on"
  • "both"
  • "off"

Default value: "both"

deeplinks String No

Filter to only Bitlinks that contain deeplinks

Valid values:

  • "on"
  • "both"
  • "off"

Default value: "both"

custom_bitlink String No

Valid values:

  • "on"
  • "both"
  • "off"

Default value: "both"

search_after String No

Token used to search next batch, only use response from API as input value.

query String No

The value that you would like to search

hostname_path_query String No

The hostname and/or path you would like to search (case-insensitive). Subdomains included; query params and fragment ignored.

tags[] Array No

Filter by given tags

domain_deeplinks String No

Filter to only Bitlinks that contain deeplinks configured with a custom domain

Valid values:

  • "on"
  • "both"
  • "off"

Default value: "both"

created_after Integer No

Timestamp as an integer unix epoch (seconds only)

channel_guid String No

Filter to return only links for the given channel GUID, can be provided, overrides all other parameters

How to start integrating

  1. Add HTTP Task to your workflow definition.
  2. Search for the API you want to integrate with and click on the name.
    • This loads the API reference documentation and prepares the Http request settings.
  3. Click Test request to test run your request to the API and see the API's response.