Organization Join Links

Get the business's join link

Read the business's current join link. Anyone holding that link can join the business in the link's role, after they confirm a mobile number on PurpleGrain's own page. This is the read to use before updateOrganizationJoinLink or resetOrganizationJoinLink.

Returns the newest link that has not been reset, whether it is on, off or lapsed, so the card can still show how many people joined with it. 404 when the business has never had one. Only an owner may call this. API keys are refused.

get/organizations/{organization_id}/join-link

Request

  • Base URL: https://api.purplegrain.com/api/v1
  • URL: https://api.purplegrain.com/api/v1/organizations/{organization_id}/join-link
  • Auth: HTTP bearer

Path parameters

organization_idstring required

Id of the organization.

Response

The current join link.

Example response

{
  "data": {
    "type": "organization_join_link"
  }
}

Changes

No recorded changes to this operation across all 5 revisions of this API.