Skip to content
Baack
Book a stack auditBook an audit
Menu

Group

A group of identities (people) which can be used for various purposes like permissions or collections of identities like a mailing list or a community

Browse the docs

Endpoints

  • GET/n/v1/group/{urn}

    Endpoint for managing membership groups used for collections of identities with metadata associated with the group lifecycle. Groups can be used for general identity groups, permissions or even mailing list management as they support membership state with opt in context and opt out state

    Parameters

    urn (path, required)
    String representation of a Unique Resource Name. Typically a UUID with 36 characters.

    Responses

    200 OK
    returns GroupREAD_SUCCESS
    404 Not found
    returns ErrorNOT_FOUND
    curl -H "Authorization: Bearer $BAACK_API_TOKEN" \
  https://api.baack.co/n/v1/group/{urn}

Fields

Group fields
FieldTypeDescription
urnstring (uuid)
ownerCompany

Required on create.

namestring

Up to 255 characters.

urlstring (uri)
entityEntity

Ignored on update.

Used by: Group Membership, Message Thread, Search Item