API reference

Download spec
get

Get team

Returns profile fields for the team associated with your API key.

Required API key scope
account:read
/api/v1/team

Code samples

curl --request GET \
  --url https://api.emailguard.co/api/v1/team \
  --header 'Authorization: Bearer YOUR_API_KEY'

Parameters

This endpoint has no parameters.

Responses

200
OK
OK
codestringrequired

Machine-readable status code (for example OK or INVALID_BODY).

emailstring

Contact email for the workspace.

emojistring

Avatar emoji.

idstring

Team UUID.

namestring

Display name.

typestring

Team kind (for example team or personal).

urlstring

Public website URL.

messagestring

Human-readable detail when the code is not OK.

401
Unauthorized
Unauthorized
codestringrequired

Machine-readable status code (for example OK or INVALID_BODY).

messagestring

Human-readable detail when the code is not OK.

403
Forbidden
Forbidden
codestringrequired

Machine-readable status code (for example OK or INVALID_BODY).

messagestring

Human-readable detail when the code is not OK.

404
Not Found
Not Found
codestringrequired

Machine-readable status code (for example OK or INVALID_BODY).

messagestring

Human-readable detail when the code is not OK.