External Link Id Lookup via External Url

Right now, we don't have an API endpoint available for performing a link lookup, but the Create Link API endpoint does perform a "create or fetch".

As an example, I might have this link:

{
  "_links": {
    "self": "https://cloud-content-consulting.api.frontapp.com/links/top_4et1p"
  },
  "id": "top_4et1p",
  "name": "Order 0002736",
  "type": "web",
  "external_url": "https://example.com/orders/0002736"
}

I can perform the following call to the Create Link endpoint, and I will get that link back in my result because the link already exists:

➜  ~ curl -XPOST 'https://api2.frontapp.com/links' -d '{"external_url": "https://example.com/orders/0002736"}'

{
  "_links": {
    "self": "https://cloud-content-consulting.api.frontapp.com/links/top_4et1p"
  },
  "id": "top_4et1p",
  "name": "Order 0002736",
  "type": "web",
  "external_url": "https://example.com/orders/0002736"
}

Or, if you're using Postman, it could look like this:

If you do not specify a name field in this create call, the API will return the existing link with the existing name. If you do provide a "name" field, the existing link will be returned, and the name will be updated on the link.

After making this first API call to create or fetch the link, you can issue a call to the list link conversations API endpoint to return all conversations currently tagged with that Link. 

I recognize that while this approach should work, it could perhaps be more effective to offer a specific endpoint for fetching Links by their external_url value. This has been previously requested, and I'll go ahead and your vote as a plus one to that feature request to see if this is something we can introduce in the future.

Let me know if you have any other questions or concerns, and enjoy the rest of your day!

--Leslie