Activity Messenger Help Center

Organization and network

See API introduction for authentication, request conventions, pagination, rate limits, and errors.

Both endpoints require the X-Activity-Messenger-Api-Key header. The key of the organization in the URL is accepted, as is the key of any organization in the same network and the account key configured for the organization. Replace {organization} with the numeric organization ID.

An organization object contains these fields:

• id: numeric organization ID. Use it as the stable key and in every other endpoint path.
• name: organization name.
• alias: organization alias (short name), or null.
• microsite_url: public URL of the organization microsite.
• iframe_url: URL of the microsite in its embeddable iframe layout.

GET /api/v1/organization/{organization}

Retrieve the organization basic information and URL to the Microsite. The response is a single organization object, not an array.

{
  "id": 1234,
  "name": "Hogwarts Recreation",
  "alias": "hogwartsrec",
  "microsite_url": "https://activitymessenger.com/org/1234",
  "iframe_url": "https://activitymessenger.com/iframe//org/1234"
}

GET /api/v1/organization/{organization}/network

For franchises and federations, retrieves the list of organizations part of the network. Each item is an organization object with the fields listed above; the requesting organization is included.

The response is an empty array ([]) when the organization does not belong to a network or is not allowed to publish to its network. Treat the result as an array of at most 50 organizations. The handler accepts page and per_page, but pagination of this endpoint has not been verified; do not rely on it.