Public
Join links

Preview a business join link

Public (unauthenticated) preview of a business's shareable join link — the unguessable code in the URL is the credential. Returns the business, who shared the link and the role the visitor will land in. A code that is unknown, switched off, reset or expired all return the same 404, so a stranger cannot tell which. A client that keeps presenting codes that do not resolve is answered with 404 for everything for the rest of the hour.

get/join/{join_code}

Request

  • Base URL: https://api.purplegrain.com/api/v1
  • URL: https://api.purplegrain.com/api/v1/join/{join_code}
  • Auth: none declared

Path parameters

join_codestring required

The code from the join link.

Response

The join link preview.

Changes

No recorded changes to this operation across all 1 revision of this API.