Associated Groups

View as Markdown

Endpoints that need a token: the site owner creates it in their admin (Developers > API reference). AI assistants: how to ask the user for one.

1 endpoints.

Endpoints

GET/associated-groups/:id

Retrieve an associated group

Returns one associated group, found by its ID.

Public

Public - no token needed.

Path parameters

idstringRequired

The ID of the associated group.

Query parameters

topicstring

Only associated groups with this topic.

servicestring

Only associated groups with this service.

donation-topicstring

Only associated groups with this donation topic.

Status codes

200 404 500

GET/associated-groups/:id

curl -X GET 'http://smartman.max-media.io/associated-groups/{id}?ionic=true&topic=...&service=...&donation-topic=...'

Response

{
  "name": "Example",
  "parent_collection": "6543210fedcba98765432100",
  "picture": "6543210fedcba98765432100",
  "about_page": "6543210fedcba98765432100",
  "match_to_option": false,
  "is_color": false,
  "color": "#3557c4",
  "position": 1,
  "items": [
    "6543210fedcba98765432101"
  ],
  "thumbnail": "6543210fedcba98765432100",
  "_id": "6543210fedcba98765432100"
}