Members

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

Fetch All Team Members

get

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Responses

200

OK

application/json

Responseobject

get

/api/v1/members

HTTPcURLJavaScriptPython

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
  }
]

Fetch Team Member by its ID

get

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

teamMemberIdstringRequired

ID of team member

Responses

200

OK

application/json

Responseobject

404

Not Found

application/json

get

/api/v1/member/{teamMemberId}

HTTPcURLJavaScriptPython

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
}

Create Team Member

post

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

objectOptionalExample: {"name":"Example name","password":"strongPassword"}

Responses

200

OK

application/json

Responseobject

post

/api/v1/member

HTTPcURLJavaScriptPython

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"
}

Update Team Member by its ID

put

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

teamMemberIdstringRequired

ID of team member

Body

application/json

objectOptionalExample: {"name":"name","password":"strongPassword"}

Responses

200

OK

application/json

Responseobject

404

Not Found

application/json

put

/api/v1/member/{teamMemberId}

HTTPcURLJavaScriptPython

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."
}

Delete Team Member by its ID

delete

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

teamMemberIdstringRequired

ID of team member

Responses

200

OK

application/json

Responseobject

404

Not Found

application/json

delete

/api/v1/member/{teamMemberId}

HTTPcURLJavaScriptPython

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."
}

Relations