Members
This endpoint allows you to perform actions on a specific Member of your Team.
Authorizations
Responses
200
OK
application/json
Responseobject
get
GET /api/v1/members HTTP/1.1
Host: integration.goodaccess.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
200
OK
[
{
"id": "123e1234-aaa1-123b-b1e1-e1aae1af1b12",
"created_at": "2024-04-03 15:10:48",
"avatar": "https://example.com",
"name": "john Doe",
"username": "[email protected]",
"is_user_blocked": true,
"is_mfa_active": true
}
]
Authorizations
Path parameters
teamMemberIdstringRequired
ID of team member
Responses
200
OK
application/json
Responseobject
404
Not Found
application/json
get
GET /api/v1/member/{teamMemberId} HTTP/1.1
Host: integration.goodaccess.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
"id": "bdf69b20-5165-4dbc-82da-f4252cac5b8c",
"name": "John Doe",
"email": "[email protected]",
"avatar_url": "bunny.cdn",
"is_mfa_active": true,
"is_blocked": true
}
Authorizations
Body
objectOptionalExample:
{"name":"Example name","password":"strongPassword"}
Responses
200
OK
application/json
Responseobject
post
POST /api/v1/member HTTP/1.1
Host: integration.goodaccess.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 51
{
"name": "Example name",
"password": "strongPassword"
}
200
OK
{
"created_id": "bdf69b20-5165-4dbc-82da-f4252cac5b8c",
"message": "Member created successfully"
}
Authorizations
Path parameters
teamMemberIdstringRequired
ID of team member
Body
objectOptionalExample:
{"name":"name","password":"strongPassword"}
Responses
200
OK
application/json
Responseobject
404
Not Found
application/json
put
PUT /api/v1/member/{teamMemberId} HTTP/1.1
Host: integration.goodaccess.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 43
{
"name": "name",
"password": "strongPassword"
}
{
"message": "Member with id <member-id> has been modified."
}
Authorizations
Path parameters
teamMemberIdstringRequired
ID of team member
Responses
200
OK
application/json
Responseobject
404
Not Found
application/json
delete
DELETE /api/v1/member/{teamMemberId} HTTP/1.1
Host: integration.goodaccess.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
"message": "User with id <member-id> has been removed."
}
Last updated
Was this helpful?