System Groups

This endpoint allows you to perform actions on a specific System Group of your Team.

Fetch All System Groups

get
Authorizations
Responses
200
OK
application/json
Responseobject
get
GET /api/v1/system-groups HTTP/1.1
Host: integration.goodaccess.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
200

OK

[
  {
    "name": "GoodAccess System Group",
    "id": "162b441d-6c72-4597-92ea-185af41078cb"
  }
]

Fetch System Group by its ID

get
Authorizations
Path parameters
systemGroupIdstringRequired

ID of System Group

Responses
200
OK
application/json
Responseobject
get
GET /api/v1/system-group/{systemGroupId} HTTP/1.1
Host: integration.goodaccess.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
200

OK

{
  "name": "GoodAccess System Group",
  "id": "162b441d-6c72-4597-92ea-185af41078cb"
}

Create System Group

post
Authorizations
Body
objectOptionalExample: {"name":"GoodAccess System Group"}
Responses
200
OK
application/json
Responseobject
post
POST /api/v1/system-group HTTP/1.1
Host: integration.goodaccess.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 34

{
  "name": "GoodAccess System Group"
}
200

OK

{
  "created_id": "4514960a-2b6d-46a2-9c22-c02cc727abb7",
  "message": "System Group created successfully"
}

Update System Group by its ID

put
Authorizations
Path parameters
systemGroupIdstringRequired

ID of System Group

Body
objectOptionalExample: {"name":"GoodAccess System Group"}
Responses
200
OK
application/json
Responseobject
put
PUT /api/v1/system-group/{systemGroupId} HTTP/1.1
Host: integration.goodaccess.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 34

{
  "name": "GoodAccess System Group"
}
{
  "status": 200,
  "message": "System Group updated successfully"
}

Remove System Group by its ID

delete
Authorizations
Path parameters
systemGroupIdstringRequired

ID of System Group

Responses
200
OK
application/json
Responseobject
delete
DELETE /api/v1/system-group/{systemGroupId} HTTP/1.1
Host: integration.goodaccess.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
  "status": 200,
  "message": "System Group successfully removed"
}

Last updated

Was this helpful?