List Members of Organization
GET
https://deploygate.com/api/organizations/{ORGANIZATION_NAME}/members
Acquire a list containing user information of all members within an Organization.
Invited Users
Unregistered users even if they should receive the invitations are listed with the property "inviting": true
. In this case, the email addresses will be returned as member's name.
Path Params
Name | Type | Required | Description |
---|---|---|---|
ORGANIZATION_NAME | string | true | Organization Name |
Example
curl \
-X GET \
--url "https://deploygate.com/api/organizations/${ORGANIZATION_NAME}/members" \
-H "Accept: application/json" \
-H "Authorization: Bearer ${API_TOKEN}"
Result 200
{
"error": false,
"members": [
{
"type": "User",
"name": "${USER_NAME}",
"display_name": "${USER_DISPLAY_NAME}",
"icon_url": "https://secure.gravatar.com/avatar/${USER_NAME}",
"url": "https://deploygate.com/users/${USER_NAME}"
},
{
"type": "User",
"name": "${EMAIL}",
"display_name": null,
"icon_url": "https://secure.gravatar.com/avatar/default",
"inviting": true,
"url": "https://deploygate.com/users/${EMAIL}"
}
]
}
Result 400
{}