Vero OMS Docs

GET

https://api-oms.verolabs.co

api

util

groups

members

List the members (accounts) of a group

curl --request GET \
  --url https://api-oms.verolabs.co/api/v1/util/groups/members \
  --header 'Authorization: Bearer <token>'

{
  "group_id": 123,
  "members": [
    {
      "account_code": "<string>",
      "group_id": 123,
      "group_name": "<string>",
      "moved_by": "<string>",
      "updated_at": "2023-11-07T05:31:56Z"
    }
  ]
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Response

200 - application/json

GroupMembersResponse schema.

group_id

integer<int64>

Group identifier.

members

object[]

Group members returned by the response.

Hide child attributes

members.account_code

string

Account code used by administration and mapping records.

members.group_id

integer<int64>

Group identifier.

members.group_name

string

Group name.

members.moved_by

string

User that moved the account between groups.

members.updated_at

string<date-time>

Timestamp when the record was last updated.

Remove an account from its groupRemove an account from its group

⌘I

List the members (accounts) of a group

curl --request GET \
  --url https://api-oms.verolabs.co/api/v1/util/groups/members \
  --header 'Authorization: Bearer <token>'

{
  "group_id": 123,
  "members": [
    {
      "account_code": "<string>",
      "group_id": 123,
      "group_name": "<string>",
      "moved_by": "<string>",
      "updated_at": "2023-11-07T05:31:56Z"
    }
  ]
}