Relations
Define relations like Access Cards with Systems or Members, and Groups with Access Cards or Members.
Authorizations
Path parameters
accessCardIdstringRequired
ID of access card
systemIdstringRequired
ID of system
Body
Responses
200
OK
application/json
Responseobject
404
Not Found
application/json
409
Conflict
application/json
post
POST /api/v1/relation/access-card/{accessCardId}/system/{systemId} HTTP/1.1
Host: integration.goodaccess.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
"message": "Relation created successfully"
}
Authorizations
Path parameters
accessCardIdstringRequired
ID of access card
systemIdstringRequired
ID of system
Responses
200
OK
application/json
Responseobject
404
Not Found
application/json
delete
DELETE /api/v1/relation/access-card/{accessCardId}/system/{systemId} HTTP/1.1
Host: integration.goodaccess.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
"message": "Relation removed successfully"
}
Authorizations
Path parameters
accessCardIdstringRequired
ID of access card
teamMemberIdstringRequired
ID of team member
Body
Responses
200
OK
application/json
Responseobject
404
Not Found
application/json
409
Conflict
application/json
post
POST /api/v1/relation/access-card/{accessCardId}/member/{teamMemberId} HTTP/1.1
Host: integration.goodaccess.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
"message": "Relation created successfully"
}
Authorizations
Path parameters
accessCardIdstringRequired
ID of access card
teamMemberIdstringRequired
ID of team member
Responses
200
OK
application/json
Responseobject
404
Not Found
application/json
delete
DELETE /api/v1/relation/access-card/{accessCardId}/member/{teamMemberId} HTTP/1.1
Host: integration.goodaccess.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
"message": "Relation removed successfully"
}
Authorizations
Path parameters
groupIdstringRequired
ID of access card
accessCardIdstringRequired
ID of access card
Body
Responses
200
OK
application/json
Responseobject
404
Not Found
application/json
409
Conflict
application/json
post
POST /api/v1/relation/group/{groupId}/access-card/{accessCardId} HTTP/1.1
Host: integration.goodaccess.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
"message": "Relation created successfully"
}
Authorizations
Path parameters
groupIdstringRequired
ID of access card
accessCardIdstringRequired
ID of access card
Responses
200
OK
application/json
Responseobject
404
Not Found
application/json
delete
DELETE /api/v1/relation/group/{groupId}/access-card/{accessCardId} HTTP/1.1
Host: integration.goodaccess.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
"message": "Relation removed successfully"
}
Authorizations
Path parameters
groupIdstringRequired
ID of access card
teamMemberIdstringRequired
ID of team member
Body
Responses
200
OK
application/json
Responseobject
404
Not Found
application/json
409
Conflict
application/json
post
POST /api/v1/relation/group/{groupId}/member/{teamMemberId} HTTP/1.1
Host: integration.goodaccess.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
"message": "Relation created successfully"
}
Authorizations
Path parameters
groupIdstringRequired
ID of access card
teamMemberIdstringRequired
ID of team member
Responses
200
OK
application/json
Responseobject
404
Not Found
application/json
delete
DELETE /api/v1/relation/group/{groupId}/member/{teamMemberId} HTTP/1.1
Host: integration.goodaccess.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
"message": "Relation removed successfully"
}
Last updated
Was this helpful?