List all members of an account.
/accounts/{account_identifier}/members
get
Account Members
account-members-list-members
{
"business": true,
"enterprise": true,
"free": true,
"pro": true
}{
"enum": [
"#organization:read"
]
}[
{
"in": "path",
"name": "account_identifier",
"required": true,
"schema": {}
},
{
"in": "query",
"name": "order",
"schema": {
"description": "Field to order results by.",
"enum": [
"user.first_name",
"user.last_name",
"user.email",
"status"
],
"example": "status"
}
},
{
"in": "query",
"name": "status",
"schema": {
"description": "A member's status in the account.",
"enum": [
"accepted",
"pending",
"rejected"
],
"example": "accepted",
"type": "string"
}
},
{
"in": "query",
"name": "page",
"schema": {
"default": 1,
"description": "Page number of paginated results.",
"minimum": 1,
"type": "number"
}
},
{
"in": "query",
"name": "per_page",
"schema": {
"default": 20,
"description": "Maximum number of results per page.",
"maximum": 50,
"minimum": 5,
"type": "number"
}
},
{
"in": "query",
"name": "direction",
"schema": {
"description": "Direction to order results.",
"enum": [
"asc",
"desc"
],
"example": "desc",
"type": "string"
}
}
]null{
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"allOf": [
{
"properties": {
"errors": {
"example": [],
"items": {
"properties": {
"code": {
"minimum": 1000,
"type": "integer"
},
"message": {
"type": "string"
}
},
"required": [
"code",
"message"
],
"type": "object",
"uniqueItems": true
},
"type": "array"
},
"messages": {
"example": [],
"items": {
"properties": {
"code": {
"minimum": 1000,
"type": "integer"
},
"message": {
"type": "string"
}
},
"required": [
"code",
"message"
],
"type": "object",
"uniqueItems": true
},
"type": "array"
},
"result": {
"anyOf": [
{
"type": "object"
},
{
"items": {},
"type": "array"
},
{
"type": "string"
}
]
},
"success": {
"description": "Whether the API call was successful",
"enum": [
true
],
"example": true,
"type": "boolean"
}
},
"required": [
"success",
"errors",
"messages",
"result"
],
"type": "object"
},
{
"properties": {
"result": {
"items": {},
"nullable": true,
"type": "array"
},
"result_info": {
"properties": {
"count": {
"description": "Total number of results for the requested service",
"example": 1,
"type": "number"
},
"page": {
"description": "Current page within paginated list of results",
"example": 1,
"type": "number"
},
"per_page": {
"description": "Number of results per page of results",
"example": 20,
"type": "number"
},
"total_count": {
"description": "Total results available without any search parameters",
"example": 2000,
"type": "number"
}
},
"type": "object"
}
}
}
],
"type": "object"
},
{
"properties": {
"result": {
"items": {
"properties": {
"email": {
"description": "The contact email address of the user.",
"example": "user@example.com",
"maxLength": 90,
"type": "string"
},
"id": {
"description": "Identifier",
"example": "023e105f4ecef8ad9ca31a8372d0c353",
"maxLength": 32,
"readOnly": true,
"type": "string"
},
"name": {
"description": "Member Name.",
"example": "John Smith",
"maxLength": 100,
"nullable": true,
"type": "string"
},
"roles": {
"description": "Roles assigned to this Member.",
"items": {
"properties": {
"description": {
"description": "Description of role's permissions.",
"example": "Administrative access to the entire Organization",
"readOnly": true,
"type": "string"
},
"id": {
"description": "Role identifier tag.",
"example": "3536bcfad5faccb999b47003c79917fb",
"maxLength": 32,
"type": "string"
},
"name": {
"description": "Role Name.",
"example": "Organization Admin",
"maxLength": 120,
"readOnly": true,
"type": "string"
},
"permissions": {
"description": "Access permissions for this User.",
"items": {
"example": "#zones:read",
"maxLength": 160,
"type": "string"
},
"readOnly": true,
"type": "array"
}
},
"required": [
"id",
"name",
"description",
"permissions"
],
"type": "object"
},
"type": "array"
},
"status": {
"description": "A member's status in the organization.",
"enum": [
"accepted",
"invited"
],
"example": "accepted"
}
},
"required": [
"id",
"name",
"email",
"status",
"roles"
],
"type": "object"
},
"type": "array"
}
},
"type": "object"
}
]
}
}
},
"description": "List Members response"
},
"4xx": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"allOf": [
{
"allOf": [
{
"properties": {
"errors": {
"example": [],
"items": {
"properties": {
"code": {
"minimum": 1000,
"type": "integer"
},
"message": {
"type": "string"
}
},
"required": [
"code",
"message"
],
"type": "object",
"uniqueItems": true
},
"type": "array"
},
"messages": {
"example": [],
"items": {
"properties": {
"code": {
"minimum": 1000,
"type": "integer"
},
"message": {
"type": "string"
}
},
"required": [
"code",
"message"
],
"type": "object",
"uniqueItems": true
},
"type": "array"
},
"result": {
"anyOf": [
{
"type": "object"
},
{
"items": {},
"type": "array"
},
{
"type": "string"
}
]
},
"success": {
"description": "Whether the API call was successful",
"enum": [
true
],
"example": true,
"type": "boolean"
}
},
"required": [
"success",
"errors",
"messages",
"result"
],
"type": "object"
},
{
"properties": {
"result": {
"items": {},
"nullable": true,
"type": "array"
},
"result_info": {
"properties": {
"count": {
"description": "Total number of results for the requested service",
"example": 1,
"type": "number"
},
"page": {
"description": "Current page within paginated list of results",
"example": 1,
"type": "number"
},
"per_page": {
"description": "Number of results per page of results",
"example": 20,
"type": "number"
},
"total_count": {
"description": "Total results available without any search parameters",
"example": 2000,
"type": "number"
}
},
"type": "object"
}
}
}
],
"type": "object"
},
{
"properties": {
"result": {
"items": {
"type": "object"
},
"type": "array"
}
},
"type": "object"
}
]
},
{
"properties": {
"errors": {
"allOf": [
{
"example": [],
"items": {
"properties": {
"code": {
"minimum": 1000,
"type": "integer"
},
"message": {
"type": "string"
}
},
"required": [
"code",
"message"
],
"type": "object",
"uniqueItems": true
},
"type": "array"
}
],
"example": [
{
"code": 7003,
"message": "No route for the URI"
}
],
"minLength": 1
},
"messages": {
"allOf": [
{
"example": [],
"items": {
"properties": {
"code": {
"minimum": 1000,
"type": "integer"
},
"message": {
"type": "string"
}
},
"required": [
"code",
"message"
],
"type": "object",
"uniqueItems": true
},
"type": "array"
}
],
"example": []
},
"result": {
"enum": [
null
],
"nullable": true,
"type": "object"
},
"success": {
"description": "Whether the API call was successful",
"enum": [
false
],
"example": false,
"type": "boolean"
}
},
"required": [
"success",
"errors",
"messages",
"result"
],
"type": "object"
}
]
}
}
},
"description": "List Members response failure"
}
}[
{
"api_email": [],
"api_key": []
}
]