List Bitlinks with the Bitly API

Lists the Bitlinks of a group, with their id, link, long_url, title and tags. The response has links and pagination: pass pagination.search_after as search_after, with the same filters, to read the next page.

Identifier
bitly_list_bitlinks

The request

POST https://connect.reportei.com/api/tools/bitly_list_bitlinks/execute
Authorization: Bearer <merchant token>
x-customer-token: <customer token>
Content-Type: application/json
Accept: application/json

{
  "customer_toolkit": "<connection UUID>",
  "arguments": {
    "group_guid": "<group_guid>"
  }
}

Your system sends your customer's connection id and the tool arguments. The headers are the same as the rest of the Connect API: your product's token and your customer's token.

Parameters

ParameterTypeRequiredDescription
group_guidstringYesGuid of the group, from List groups.
querystringNoText to search for in the links of the group.
tagsarrayNoOnly the links with these tags.
archivedstringNoon lists only archived links, off only the active ones and both lists all. The default is off.Values: on, off, both
created_afterintegerNoOnly links created after this moment, as a Unix timestamp in seconds.
created_beforeintegerNoOnly links created before this moment, as a Unix timestamp in seconds.
sizeintegerNoLinks per page. The default is 50.
search_afterstringNoThe pagination.search_after of the previous response.

Supported connections

Your customer connects their Bitly account once, with one of the modes below. The same connection serves every tool of the toolkit.

API key

Your customer pastes the app's key on a Connect screen, or your system sends the key with POST /api/customer-toolkits, with no screen.

OAuth with your product's app

You register your product's OAuth app once, with POST /api/merchants/credentials/bitly, and your customer authorizes the account on a consent screen. Connect renews the token when it is about to expire.

The response

On success, Connect preserves the app's response status and body. HTTP errors returned by the app use the {error, api_error} envelope; authentication or validation can fail before execution. The X-Toolkit-Execution-Id header identifies the recorded execution, available at GET /api/tools/executions/{uuid}.

Ready for AI agents

This tool's input is a JSON Schema, available at GET /api/tools/bitly_list_bitlinks. It becomes your agent's tool definition with no conversion.

Other Bitly tools

See all 11 tools

Toolkits in the same category

See all 100 toolkits

See Connect applied to your product.

Try it for 15 days with no card, or walk our team through your use case.