System Groups
This endpoint allows you to perform actions on a specific System Group of your Team.
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"
}
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"
}
Authorizations
Path parameters
systemGroupIdstringRequired
ID of System Group
Body
objectOptionalExample:
{"name":"GoodAccess System Group"}
Responses
200
OK
application/json
Responseobject
404
Not Found
application/json
409
Conflict
application/json
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"
}
Authorizations
Path parameters
systemGroupIdstringRequired
ID of System Group
Responses
200
OK
application/json
Responseobject
404
Not Found
application/json
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?