Members

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

Fetch All Team Members

get

Authorizations

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://integration.goodaccess.com/api/v1/members' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

200

200

[
  {
    "id": "123e1234-aaa1-123b-b1e1-e1aae1af1b12",
    "created_at": "2024-04-03 15:10:48",
    "avatar": "https://example.com",
    "name": "john Doe",
    "username": "[e-mail]",
    "is_user_blocked": true,
    "is_mfa_active": true
  }
]

OK

Fetch Team Member by its ID

get

Authorizations

Path parameters

teamMemberIdstringrequired

ID of team member

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://integration.goodaccess.com/api/v1/member/{teamMemberId}' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

200

404

200

{
  "id": "bdf69b20-5165-4dbc-82da-f4252cac5b8c",
  "name": "John Doe",
  "email": "[e-mail]",
  "avatar_url": "bunny.cdn",
  "is_mfa_active": true,
  "is_blocked": true
}

OK

Create Team Member

post

Authorizations

Body

objectoptional

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

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://integration.goodaccess.com/api/v1/member' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
    "name": "Example name",
    "password": "strongPassword"
  }'

200

200

{
  "created_id": "bdf69b20-5165-4dbc-82da-f4252cac5b8c",
  "message": "Member created successfully"
}

OK

Update Team Member by its ID

put

Authorizations

Path parameters

teamMemberIdstringrequired

ID of team member

Body

objectoptional

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

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request PUT \
  --url 'https://integration.goodaccess.com/api/v1/member/{teamMemberId}' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
    "name": "name",
    "password": "strongPassword"
  }'

200

404

200

{
  "message": "Member with id <member-id> has been modified."
}

OK

Delete Team Member by its ID

delete

Authorizations

Path parameters

teamMemberIdstringrequired

ID of team member

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request DELETE \
  --url 'https://integration.goodaccess.com/api/v1/member/{teamMemberId}' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

200

404

200

{
  "message": "User with id <member-id> has been removed."
}

OK

Relations