Nimriz icon

Nimriz

Manage Nimriz short links and outbound connections

Actions16

Link → Find

AI-generated

Summary

Retrieves a single Nimriz short link record based on either its full short URL or its domain and short code.

Inputs

  • authentication (required) — The authentication method to use: API Key or OAuth2.
  • findBy (required) — Specifies the lookup method: 'shortUrl' for the full URL or 'domainAndCode' for the domain and short code separately.
  • shortUrl (required) — The full short URL to look up (e.g., https://go.example.com/launch). Required when findBy is set to 'shortUrl'.
  • findDomainId (required) — The ID of the domain to search on. Required when findBy is set to 'domainAndCode'.
  • findShortCode (required) — The short code (slug) on the domain. Required when findBy is set to 'domainAndCode'.

Output shape

A single record containing the link details.

Returns the full link object. If the link is not found, the API typically returns an error.

Examples

Example 1: Find a link by its full URL

Set findBy to 'shortUrl' and provide the full URL (e.g., https://go.example.com/launch).

Example 2: Find a link by domain and code

Set findBy to 'domainAndCode', select a domain from the list, and enter the short code (slug).

Links

Discussion