> For the complete documentation index, see [llms.txt](https://hub.equipme.io/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://hub.equipme.io/development/api-reference-app/group-member.md).
# Group member
Membership is what gives a team visibility over the tickets assigned to its group, and the role decides how far it reaches:
| Role | Meaning |
| ---------- | ------------------------------------------------ |
| `ADMIN` | manages the group's membership |
| `MEMBER` | belongs to the group and sees its tickets |
| `OBSERVER` | sees the group's tickets without belonging to it |
## List the members of a group
> Returns who belongs to a group and in which role.\
> \
> \*\*Filterable\*\* — \`groupId\`, \`contactId\`, \`role\`.\
> \
> \*\*Sortable\*\* — \`groupId\`, \`contactId\`.\
> \
> \*\*Searchable\*\* — nothing yet.
```json
{"openapi":"3.1.0","info":{"title":"Solvio REST API","version":"1.0.0-beta"},"tags":[{"description":"Membership is what gives a team visibility over the tickets assigned to its group, and the role\ndecides how far it reaches:\n\n| Role | Meaning |\n| --- | --- |\n| `ADMIN` | manages the group's membership |\n| `MEMBER` | belongs to the group and sees its tickets |\n| `OBSERVER` | sees the group's tickets without belonging to it |\n","name":"group_member"}],"servers":[{"description":"The host serving this document","url":"/api"}],"security":[{"BearerAuth":[]},{"ApiKeyAuth":[]}],"components":{"securitySchemes":{"BearerAuth":{"description":"Token issued by the central equipme authentication, sent as `Bearer `.","scheme":"bearer","type":"http"},"ApiKeyAuth":{"description":"Static key for machine-to-machine access. Alternative to BearerAuth.","in":"header","name":"X-API-Key","type":"apiKey"}},"schemas":{"v1.ListGroupMembersResponse-domain_GroupMember":{"properties":{"count":{"type":"integer"},"data":{"items":{"$ref":"#/components/schemas/domain.GroupMember"},"type":"array","uniqueItems":false}},"type":"object"},"domain.GroupMember":{"properties":{"contact":{"$ref":"#/components/schemas/domain.Contact"},"contactId":{"type":"integer"},"group":{"$ref":"#/components/schemas/domain.Group"},"groupId":{"description":"The composite PK (groupId, contactId) is the by-id analogue for this join\ntable: both key columns are filter+sort (the codegen sort-minimum + what a\nby-key Query(And(Eq,Eq)).Get needs). role reproduces the old GroupMemberFilter.Role.","type":"integer"},"role":{"$ref":"#/components/schemas/domain.GroupMemberRole"}},"type":"object"},"domain.Contact":{"properties":{"assignmentContext":{"type":"string"},"autoAssign":{"description":"AutoAssign / AssignmentContext drive automated ticket routing. Set today only on\nGROUP-kind contacts via the group endpoints; nil/empty on ordinary contacts.","type":"boolean"},"createdAt":{"format":"date-time","type":"string"},"description":{"type":"string"},"email":{"type":"string"},"firstName":{"type":"string"},"id":{"type":"integer"},"kind":{"$ref":"#/components/schemas/domain.ContactKind"},"lastName":{"type":"string"},"mobile":{"type":"string"},"phone":{"type":"string"},"tenant":{"$ref":"#/components/schemas/domain.Tenant"},"tenantId":{"type":"integer"},"title":{"type":"string"},"updatedAt":{"format":"date-time","type":"string"}},"type":"object"},"domain.ContactKind":{"enum":["","PERSON","INTAKE","GROUP"],"type":"string"},"domain.Tenant":{"properties":{"id":{"type":"integer"},"name":{"type":"string"}},"type":"object"},"domain.Group":{"properties":{"assignmentContext":{"type":"string"},"autoAssign":{"description":"AutoAssign / AssignmentContext / ContactID are read-through from the group's\nGROUP-kind Contact (like Email/Phone); they are not stored on the group table.","type":"boolean"},"contactId":{"type":"integer"},"description":{"type":"string"},"email":{"type":"string"},"id":{"type":"integer"},"members":{"items":{"$ref":"#/components/schemas/domain.GroupMember"},"type":"array","uniqueItems":false},"name":{"type":"string"},"phone":{"type":"string"},"tenant":{"$ref":"#/components/schemas/domain.Tenant"},"tenantId":{"type":"integer"}},"type":"object"},"domain.GroupMemberRole":{"enum":["","MEMBER","ADMIN","OBSERVER"],"type":"string"},"middleware.ErrorResponse":{"properties":{"error":{"$ref":"#/components/schemas/middleware.ErrorBody"}},"type":"object"},"middleware.ErrorBody":{"properties":{"code":{"description":"Code is the stable, machine-readable reason. Clients match on this, not on the message.","type":"string"},"details":{"description":"Details carries structured context where an error has any — a conflict names what it\ncollided with. Absent otherwise."},"message":{"type":"string"}},"type":"object"}}},"paths":{"/v1/groups/{groupId}/members":{"get":{"description":"Returns who belongs to a group and in which role.\n\n**Filterable** — `groupId`, `contactId`, `role`.\n\n**Sortable** — `groupId`, `contactId`.\n\n**Searchable** — nothing yet.\n","operationId":"listGroupMembers","parameters":[{"description":"Group id","in":"path","name":"groupId","required":true,"schema":{"type":"integer"}},{"description":"JSON filter expression","in":"query","name":"filter","schema":{"type":"string"}},{"description":"Free-text term — no effect here","in":"query","name":"search","schema":{"type":"string"}},{"description":"Comma-separated field:direction terms","in":"query","name":"sort","schema":{"type":"string"}},{"description":"Selection of fields and relations","in":"query","name":"fields","schema":{"type":"string"}},{"description":"Number of entries to skip","in":"query","name":"offset","schema":{"default":0,"type":"integer"}},{"description":"Page size, 1 to 100","in":"query","name":"limit","schema":{"default":100,"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/v1.ListGroupMembersResponse-domain_GroupMember"}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/middleware.ErrorResponse"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/middleware.ErrorResponse"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/middleware.ErrorResponse"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/middleware.ErrorResponse"}}},"description":"Not Found"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/middleware.ErrorResponse"}}},"description":"Internal Server Error"}},"summary":"List the members of a group","tags":["group_member"]}}}}
```
## Add members to a group
> Adds members to a group. Each entry needs a \`contactId\` and a \`role\` of \`ADMIN\`, \`MEMBER\` or\
> \`OBSERVER\`, and every contact has to belong to the same tenant as the group.\
> \
> A contact that is already a member is \*\*left as it is\*\* — the request succeeds without changing that\
> member's role. Use the PATCH endpoint to change a role.
```json
{"openapi":"3.1.0","info":{"title":"Solvio REST API","version":"1.0.0-beta"},"tags":[{"description":"Membership is what gives a team visibility over the tickets assigned to its group, and the role\ndecides how far it reaches:\n\n| Role | Meaning |\n| --- | --- |\n| `ADMIN` | manages the group's membership |\n| `MEMBER` | belongs to the group and sees its tickets |\n| `OBSERVER` | sees the group's tickets without belonging to it |\n","name":"group_member"}],"servers":[{"description":"The host serving this document","url":"/api"}],"security":[{"BearerAuth":[]},{"ApiKeyAuth":[]}],"components":{"securitySchemes":{"BearerAuth":{"description":"Token issued by the central equipme authentication, sent as `Bearer `.","scheme":"bearer","type":"http"},"ApiKeyAuth":{"description":"Static key for machine-to-machine access. Alternative to BearerAuth.","in":"header","name":"X-API-Key","type":"apiKey"}},"schemas":{"v1.AddGroupMembersRequest":{"properties":{"members":{"items":{"$ref":"#/components/schemas/v1.AddGroupMembersRequestItem"},"minItems":1,"type":"array","uniqueItems":false}},"required":["members"],"type":"object"},"v1.AddGroupMembersRequestItem":{"properties":{"contactId":{"type":"integer"},"role":{"$ref":"#/components/schemas/domain.GroupMemberRole"}},"required":["contactId","role"],"type":"object"},"domain.GroupMemberRole":{"enum":["","MEMBER","ADMIN","OBSERVER"],"type":"string"},"v1.AddGroupMembersResponse":{"properties":{"data":{"items":{"$ref":"#/components/schemas/domain.GroupMember"},"type":"array","uniqueItems":false}},"type":"object"},"domain.GroupMember":{"properties":{"contact":{"$ref":"#/components/schemas/domain.Contact"},"contactId":{"type":"integer"},"group":{"$ref":"#/components/schemas/domain.Group"},"groupId":{"description":"The composite PK (groupId, contactId) is the by-id analogue for this join\ntable: both key columns are filter+sort (the codegen sort-minimum + what a\nby-key Query(And(Eq,Eq)).Get needs). role reproduces the old GroupMemberFilter.Role.","type":"integer"},"role":{"$ref":"#/components/schemas/domain.GroupMemberRole"}},"type":"object"},"domain.Contact":{"properties":{"assignmentContext":{"type":"string"},"autoAssign":{"description":"AutoAssign / AssignmentContext drive automated ticket routing. Set today only on\nGROUP-kind contacts via the group endpoints; nil/empty on ordinary contacts.","type":"boolean"},"createdAt":{"format":"date-time","type":"string"},"description":{"type":"string"},"email":{"type":"string"},"firstName":{"type":"string"},"id":{"type":"integer"},"kind":{"$ref":"#/components/schemas/domain.ContactKind"},"lastName":{"type":"string"},"mobile":{"type":"string"},"phone":{"type":"string"},"tenant":{"$ref":"#/components/schemas/domain.Tenant"},"tenantId":{"type":"integer"},"title":{"type":"string"},"updatedAt":{"format":"date-time","type":"string"}},"type":"object"},"domain.ContactKind":{"enum":["","PERSON","INTAKE","GROUP"],"type":"string"},"domain.Tenant":{"properties":{"id":{"type":"integer"},"name":{"type":"string"}},"type":"object"},"domain.Group":{"properties":{"assignmentContext":{"type":"string"},"autoAssign":{"description":"AutoAssign / AssignmentContext / ContactID are read-through from the group's\nGROUP-kind Contact (like Email/Phone); they are not stored on the group table.","type":"boolean"},"contactId":{"type":"integer"},"description":{"type":"string"},"email":{"type":"string"},"id":{"type":"integer"},"members":{"items":{"$ref":"#/components/schemas/domain.GroupMember"},"type":"array","uniqueItems":false},"name":{"type":"string"},"phone":{"type":"string"},"tenant":{"$ref":"#/components/schemas/domain.Tenant"},"tenantId":{"type":"integer"}},"type":"object"},"middleware.ErrorResponse":{"properties":{"error":{"$ref":"#/components/schemas/middleware.ErrorBody"}},"type":"object"},"middleware.ErrorBody":{"properties":{"code":{"description":"Code is the stable, machine-readable reason. Clients match on this, not on the message.","type":"string"},"details":{"description":"Details carries structured context where an error has any — a conflict names what it\ncollided with. Absent otherwise."},"message":{"type":"string"}},"type":"object"}}},"paths":{"/v1/groups/{groupId}/members":{"post":{"description":"Adds members to a group. Each entry needs a `contactId` and a `role` of `ADMIN`, `MEMBER` or\n`OBSERVER`, and every contact has to belong to the same tenant as the group.\n\nA contact that is already a member is **left as it is** — the request succeeds without changing that\nmember's role. Use the PATCH endpoint to change a role.\n","operationId":"addGroupMembers","parameters":[{"description":"Group id","in":"path","name":"groupId","required":true,"schema":{"type":"integer"}}],"requestBody":{"content":{"application/json":{"schema":{"oneOf":[{"type":"object"},{"$ref":"#/components/schemas/v1.AddGroupMembersRequest","summary":"request","description":"Members to add"}]}}},"description":"Members to add","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/v1.AddGroupMembersResponse"}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/middleware.ErrorResponse"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/middleware.ErrorResponse"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/middleware.ErrorResponse"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/middleware.ErrorResponse"}}},"description":"Not Found"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/middleware.ErrorResponse"}}},"description":"Internal Server Error"}},"summary":"Add members to a group","tags":["group_member"]}}}}
```
## Remove members from a group
> Removes members from a group. Contacts that do not belong to it are ignored, so the request is\
> idempotent, and it answers with \`204\` and no body.\
> \
> Removing a member takes away the visibility that membership granted; the tickets themselves are\
> untouched.
```json
{"openapi":"3.1.0","info":{"title":"Solvio REST API","version":"1.0.0-beta"},"tags":[{"description":"Membership is what gives a team visibility over the tickets assigned to its group, and the role\ndecides how far it reaches:\n\n| Role | Meaning |\n| --- | --- |\n| `ADMIN` | manages the group's membership |\n| `MEMBER` | belongs to the group and sees its tickets |\n| `OBSERVER` | sees the group's tickets without belonging to it |\n","name":"group_member"}],"servers":[{"description":"The host serving this document","url":"/api"}],"security":[{"BearerAuth":[]},{"ApiKeyAuth":[]}],"components":{"securitySchemes":{"BearerAuth":{"description":"Token issued by the central equipme authentication, sent as `Bearer `.","scheme":"bearer","type":"http"},"ApiKeyAuth":{"description":"Static key for machine-to-machine access. Alternative to BearerAuth.","in":"header","name":"X-API-Key","type":"apiKey"}},"schemas":{"v1.RemoveGroupMembersRequest":{"properties":{"members":{"items":{"$ref":"#/components/schemas/v1.RemoveGroupMembersRequestItem"},"minItems":1,"type":"array","uniqueItems":false}},"required":["members"],"type":"object"},"v1.RemoveGroupMembersRequestItem":{"properties":{"contactId":{"type":"integer"}},"required":["contactId"],"type":"object"},"middleware.ErrorResponse":{"properties":{"error":{"$ref":"#/components/schemas/middleware.ErrorBody"}},"type":"object"},"middleware.ErrorBody":{"properties":{"code":{"description":"Code is the stable, machine-readable reason. Clients match on this, not on the message.","type":"string"},"details":{"description":"Details carries structured context where an error has any — a conflict names what it\ncollided with. Absent otherwise."},"message":{"type":"string"}},"type":"object"}}},"paths":{"/v1/groups/{groupId}/members":{"delete":{"description":"Removes members from a group. Contacts that do not belong to it are ignored, so the request is\nidempotent, and it answers with `204` and no body.\n\nRemoving a member takes away the visibility that membership granted; the tickets themselves are\nuntouched.\n","operationId":"removeGroupMembers","parameters":[{"description":"Group id","in":"path","name":"groupId","required":true,"schema":{"type":"integer"}}],"requestBody":{"content":{"application/json":{"schema":{"oneOf":[{"type":"object"},{"$ref":"#/components/schemas/v1.RemoveGroupMembersRequest","summary":"request","description":"Members to remove"}]}}},"description":"Members to remove","required":true},"responses":{"204":{"description":"No Content"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/middleware.ErrorResponse"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/middleware.ErrorResponse"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/middleware.ErrorResponse"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/middleware.ErrorResponse"}}},"description":"Not Found"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/middleware.ErrorResponse"}}},"description":"Internal Server Error"}},"summary":"Remove members from a group","tags":["group_member"]}}}}
```
## Change member roles
> Changes the role of members that already belong to the group. Only a group \`ADMIN\` — or someone with\
> the explicit permission — may do this.
```json
{"openapi":"3.1.0","info":{"title":"Solvio REST API","version":"1.0.0-beta"},"tags":[{"description":"Membership is what gives a team visibility over the tickets assigned to its group, and the role\ndecides how far it reaches:\n\n| Role | Meaning |\n| --- | --- |\n| `ADMIN` | manages the group's membership |\n| `MEMBER` | belongs to the group and sees its tickets |\n| `OBSERVER` | sees the group's tickets without belonging to it |\n","name":"group_member"}],"servers":[{"description":"The host serving this document","url":"/api"}],"security":[{"BearerAuth":[]},{"ApiKeyAuth":[]}],"components":{"securitySchemes":{"BearerAuth":{"description":"Token issued by the central equipme authentication, sent as `Bearer `.","scheme":"bearer","type":"http"},"ApiKeyAuth":{"description":"Static key for machine-to-machine access. Alternative to BearerAuth.","in":"header","name":"X-API-Key","type":"apiKey"}},"schemas":{"v1.PatchGroupMembersRequest":{"properties":{"members":{"items":{"$ref":"#/components/schemas/v1.PatchGroupMembersRequestItem"},"minItems":1,"type":"array","uniqueItems":false}},"required":["members"],"type":"object"},"v1.PatchGroupMembersRequestItem":{"properties":{"contactId":{"type":"integer"},"role":{"$ref":"#/components/schemas/domain.GroupMemberRole"}},"required":["contactId","role"],"type":"object"},"domain.GroupMemberRole":{"enum":["","MEMBER","ADMIN","OBSERVER"],"type":"string"},"v1.PatchGroupMembersResponse":{"properties":{"data":{"items":{"$ref":"#/components/schemas/domain.GroupMember"},"type":"array","uniqueItems":false}},"type":"object"},"domain.GroupMember":{"properties":{"contact":{"$ref":"#/components/schemas/domain.Contact"},"contactId":{"type":"integer"},"group":{"$ref":"#/components/schemas/domain.Group"},"groupId":{"description":"The composite PK (groupId, contactId) is the by-id analogue for this join\ntable: both key columns are filter+sort (the codegen sort-minimum + what a\nby-key Query(And(Eq,Eq)).Get needs). role reproduces the old GroupMemberFilter.Role.","type":"integer"},"role":{"$ref":"#/components/schemas/domain.GroupMemberRole"}},"type":"object"},"domain.Contact":{"properties":{"assignmentContext":{"type":"string"},"autoAssign":{"description":"AutoAssign / AssignmentContext drive automated ticket routing. Set today only on\nGROUP-kind contacts via the group endpoints; nil/empty on ordinary contacts.","type":"boolean"},"createdAt":{"format":"date-time","type":"string"},"description":{"type":"string"},"email":{"type":"string"},"firstName":{"type":"string"},"id":{"type":"integer"},"kind":{"$ref":"#/components/schemas/domain.ContactKind"},"lastName":{"type":"string"},"mobile":{"type":"string"},"phone":{"type":"string"},"tenant":{"$ref":"#/components/schemas/domain.Tenant"},"tenantId":{"type":"integer"},"title":{"type":"string"},"updatedAt":{"format":"date-time","type":"string"}},"type":"object"},"domain.ContactKind":{"enum":["","PERSON","INTAKE","GROUP"],"type":"string"},"domain.Tenant":{"properties":{"id":{"type":"integer"},"name":{"type":"string"}},"type":"object"},"domain.Group":{"properties":{"assignmentContext":{"type":"string"},"autoAssign":{"description":"AutoAssign / AssignmentContext / ContactID are read-through from the group's\nGROUP-kind Contact (like Email/Phone); they are not stored on the group table.","type":"boolean"},"contactId":{"type":"integer"},"description":{"type":"string"},"email":{"type":"string"},"id":{"type":"integer"},"members":{"items":{"$ref":"#/components/schemas/domain.GroupMember"},"type":"array","uniqueItems":false},"name":{"type":"string"},"phone":{"type":"string"},"tenant":{"$ref":"#/components/schemas/domain.Tenant"},"tenantId":{"type":"integer"}},"type":"object"},"middleware.ErrorResponse":{"properties":{"error":{"$ref":"#/components/schemas/middleware.ErrorBody"}},"type":"object"},"middleware.ErrorBody":{"properties":{"code":{"description":"Code is the stable, machine-readable reason. Clients match on this, not on the message.","type":"string"},"details":{"description":"Details carries structured context where an error has any — a conflict names what it\ncollided with. Absent otherwise."},"message":{"type":"string"}},"type":"object"}}},"paths":{"/v1/groups/{groupId}/members":{"patch":{"description":"Changes the role of members that already belong to the group. Only a group `ADMIN` — or someone with\nthe explicit permission — may do this.\n","operationId":"patchGroupMembers","parameters":[{"description":"Group id","in":"path","name":"groupId","required":true,"schema":{"type":"integer"}}],"requestBody":{"content":{"application/json":{"schema":{"oneOf":[{"type":"object"},{"$ref":"#/components/schemas/v1.PatchGroupMembersRequest","summary":"request","description":"Members to change"}]}}},"description":"Members to change","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/v1.PatchGroupMembersResponse"}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/middleware.ErrorResponse"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/middleware.ErrorResponse"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/middleware.ErrorResponse"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/middleware.ErrorResponse"}}},"description":"Not Found"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/middleware.ErrorResponse"}}},"description":"Internal Server Error"}},"summary":"Change member roles","tags":["group_member"]}}}}
```
---
# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.
## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.
Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:
```
GET https://hub.equipme.io/development/api-reference-app/group-member.md?ask=&goal=
```
`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.
Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.