GET /projects/{project_reference}/membersLists the project's members with their role and resolved capabilities, one page at a time by user ID cursor. Requires project.members.read.
Servers
[
{
"url": "https://api.veryfront.com"
}
]Authentication
[
{
"bearerAuth": []
},
{
"apiKeyAuth": []
}
]{
"bearerAuth": {
"type": "http",
"scheme": "bearer",
"bearerFormat": "JWT or API Key",
"description": "Use a JWT bearer token or a Veryfront API key in the `Authorization` header."
},
"apiKeyAuth": {
"type": "apiKey",
"in": "header",
"name": "X-API-Key",
"description": "Alternative API key header for `vf_<prefix>_<secret>` tokens."
}
}Parameters
Parameter contracts
[
{
"schema": {
"$ref": "#/components/schemas/ProjectReference"
},
"required": true,
"description": "Project slug, UUID, or domain that identifies the project.",
"name": "project_reference",
"in": "path"
},
{
"schema": {
"type": "string",
"format": "uuid",
"description": "Cursor from page_info.next: the user ID of the last member on the previous page. Omit it to read the first page."
},
"required": false,
"description": "Cursor from page_info.next: the user ID of the last member on the previous page. Omit it to read the first page.",
"name": "cursor",
"in": "query"
},
{
"schema": {
"type": "integer",
"minimum": 1,
"maximum": 100,
"default": 20,
"description": "Maximum entries per page. Integer from 1 to 100; defaults to 20."
},
"required": false,
"description": "Maximum entries per page. Integer from 1 to 100; defaults to 20.",
"name": "limit",
"in": "query"
}
]Responses
200
One page of project members, ordered by user ID
{
"description": "One page of project members, ordered by user ID",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"user_id": {
"type": "string",
"format": "uuid",
"description": "User ID of the project member."
},
"email": {
"type": "string",
"description": "Email address of the member."
},
"name": {
"type": [
"string",
"null"
],
"description": "Display name of the member; null when the member has none."
},
"avatar_src": {
"type": [
"string",
"null"
],
"description": "Avatar URL of the member; null when the member has none."
},
"role": {
"type": "string",
"enum": [
"owner",
"admin",
"editor",
"viewer"
],
"description": "Project role of the member: owner, admin, editor or viewer."
},
"capabilities": {
"type": "array",
"items": {
"type": "string",
"enum": [
"project.read",
"project.settings.manage",
"project.delete",
"project.members.read",
"project.members.manage",
"project.invites.read",
"project.invites.manage",
"project.files.read",
"project.files.write",
"project.realtime.connect",
"project.realtime.write",
"project.files.admin",
"project.uploads.read",
"project.uploads.write",
"project.uploads.admin",
"project.knowledge.read",
"project.knowledge.write",
"project.releases.read",
"project.releases.write",
"project.deployments.read",
"project.deployments.write",
"project.deploy.execute",
"project.runtime.manage",
"project.channels.read",
"project.channels.write",
"project.sandboxes.manage",
"project.domains.write",
"project.environments.manage",
"project.env_vars.write",
"project.runs.read",
"project.runs.write",
"project.runs.admin",
"project.agents.read",
"project.agents.write",
"project.evals.read",
"project.evals.write",
"project.evals.run",
"project.conversations.read",
"project.conversations.write",
"project.conversations.create",
"project.integrations.read",
"project.integrations.connect",
"project.integrations.configure",
"project.api_keys.read",
"project.api_keys.manage",
"project.cache.read",
"project.cache.write",
"project.logs.read",
"project.metrics.read",
"project.resources.read"
]
},
"description": "Project capabilities the role grants, as the permission checks resolve them."
}
},
"required": [
"user_id",
"email",
"name",
"avatar_src",
"role",
"capabilities"
]
}
},
"page_info": {
"$ref": "#/components/schemas/PageInfo"
}
},
"required": [
"data",
"page_info"
]
}
}
}
}400
Invalid limit, or a cursor that names no member of this project
{
"description": "Invalid limit, or a cursor that names no member of this project",
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
}
}401
Unauthorized
{
"description": "Unauthorized",
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
}
}403
Forbidden - insufficient permissions
{
"description": "Forbidden - insufficient permissions",
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
}
}404
Project not found
{
"description": "Project not found",
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
}
}500
Server error
{
"description": "Server error",
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
}
}503
internal: authentication state is temporarily unavailable and the request was not processed; retry shortly.
{
"description": "internal: authentication state is temporarily unavailable and the request was not processed; retry shortly.",
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
}
}Referenced contracts
components/parameters/ProjectReference
{
"schema": {
"$ref": "#/components/schemas/ProjectReference"
},
"required": true,
"description": "Project slug, UUID, or domain that identifies the project.",
"name": "project_reference",
"in": "path"
}components/schemas/ProjectReference
{
"type": "string"
}components/schemas/PageInfo
{
"type": "object",
"properties": {
"self": {
"type": [
"string",
"null"
],
"description": "Cursor pointing to the current page"
},
"first": {
"type": "null",
"description": "First page cursor (always null for cursor-based pagination)"
},
"next": {
"type": [
"string",
"null"
],
"description": "Cursor for the next page (null if no more pages)"
},
"prev": {
"type": [
"string",
"null"
],
"description": "Cursor for the previous page (null if on first page)"
}
},
"required": [
"self",
"first",
"next",
"prev"
]
}components/schemas/Problem
{
"type": "object",
"properties": {
"cause": {
"type": "string",
"enum": [
"schedule_concurrency_forbidden",
"schedule_fire_in_progress",
"schedule_run_limit_reached"
],
"description": "Schedule admission refusal."
},
"idempotency": {
"type": "object",
"properties": {
"state": {
"type": "string",
"enum": [
"in_progress",
"payload_mismatch",
"outcome_unknown"
]
},
"operation": {
"type": "string",
"minLength": 1
},
"retryable": {
"type": "boolean"
},
"retry_after_seconds": {
"type": [
"integer",
"null"
],
"minimum": 0
},
"expires_at": {
"type": [
"string",
"null"
]
},
"recovery": {
"type": "object",
"properties": {
"available": {
"type": "boolean"
},
"description": {
"type": "string"
},
"resource_url": {
"type": "string"
}
},
"required": [
"available",
"description"
]
}
},
"required": [
"state",
"operation",
"retryable",
"retry_after_seconds",
"expires_at"
],
"description": "Replay status, retry timing, and recovery lookup."
},
"type": {
"type": "string",
"description": "URI reference identifying the problem type",
"example": "https://api.veryfront.com/errors/validation-failed"
},
"title": {
"type": "string",
"description": "Short human-readable summary of the problem",
"example": "Validation Failed"
},
"status": {
"type": "integer",
"minimum": 100,
"maximum": 599,
"description": "HTTP status code",
"example": 400
},
"code": {
"type": "string",
"description": "Stable machine-readable error code",
"example": "RUN_INVALID_INPUT"
},
"detail": {
"type": "string",
"description": "Human-readable explanation specific to this occurrence",
"example": "The 'email' field must be a valid email address"
},
"instance": {
"type": "string",
"description": "URI reference identifying the specific occurrence",
"example": "/projects/my-project/members"
},
"slug": {
"type": "string",
"description": "Stable identifier for the problem type",
"example": "validation-failed"
},
"category": {
"type": "string",
"enum": [
"AUTH",
"RESOURCE",
"VALIDATION",
"DATABASE",
"SUBSCRIPTION",
"INTEGRATION",
"INTERNAL"
],
"description": "API error category",
"example": "VALIDATION"
},
"suggestion": {
"type": "string",
"description": "Suggested action to resolve the problem",
"example": "Check the request body and query parameters against the API documentation."
},
"errors": {
"type": "array",
"items": {
"type": "object",
"properties": {
"field": {
"type": "string",
"description": "Field path that caused the error",
"example": "email"
},
"message": {
"type": "string",
"description": "Error message for this field",
"example": "Invalid email format"
},
"code": {
"type": "string",
"description": "Error code for this field",
"example": "INVALID_FORMAT"
}
},
"required": [
"field",
"message"
]
},
"description": "Detailed field-level errors for validation failures"
}
},
"required": [
"type",
"title",
"status"
]
}Operation contract
{
"operationId": "listProjectMembers",
"tags": [
"identity-access/Users/Project members"
],
"summary": "List project members",
"description": "Lists the project's members with their role and resolved capabilities, one page at a time by user ID cursor. Requires project.members.read.",
"parameters": [
{
"$ref": "#/components/parameters/ProjectReference"
},
{
"schema": {
"type": "string",
"format": "uuid",
"description": "Cursor from page_info.next: the user ID of the last member on the previous page. Omit it to read the first page."
},
"required": false,
"description": "Cursor from page_info.next: the user ID of the last member on the previous page. Omit it to read the first page.",
"name": "cursor",
"in": "query"
},
{
"schema": {
"type": "integer",
"minimum": 1,
"maximum": 100,
"default": 20,
"description": "Maximum entries per page. Integer from 1 to 100; defaults to 20."
},
"required": false,
"description": "Maximum entries per page. Integer from 1 to 100; defaults to 20.",
"name": "limit",
"in": "query"
}
],
"responses": {
"200": {
"description": "One page of project members, ordered by user ID",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"user_id": {
"type": "string",
"format": "uuid",
"description": "User ID of the project member."
},
"email": {
"type": "string",
"description": "Email address of the member."
},
"name": {
"type": [
"string",
"null"
],
"description": "Display name of the member; null when the member has none."
},
"avatar_src": {
"type": [
"string",
"null"
],
"description": "Avatar URL of the member; null when the member has none."
},
"role": {
"type": "string",
"enum": [
"owner",
"admin",
"editor",
"viewer"
],
"description": "Project role of the member: owner, admin, editor or viewer."
},
"capabilities": {
"type": "array",
"items": {
"type": "string",
"enum": [
"project.read",
"project.settings.manage",
"project.delete",
"project.members.read",
"project.members.manage",
"project.invites.read",
"project.invites.manage",
"project.files.read",
"project.files.write",
"project.realtime.connect",
"project.realtime.write",
"project.files.admin",
"project.uploads.read",
"project.uploads.write",
"project.uploads.admin",
"project.knowledge.read",
"project.knowledge.write",
"project.releases.read",
"project.releases.write",
"project.deployments.read",
"project.deployments.write",
"project.deploy.execute",
"project.runtime.manage",
"project.channels.read",
"project.channels.write",
"project.sandboxes.manage",
"project.domains.write",
"project.environments.manage",
"project.env_vars.write",
"project.runs.read",
"project.runs.write",
"project.runs.admin",
"project.agents.read",
"project.agents.write",
"project.evals.read",
"project.evals.write",
"project.evals.run",
"project.conversations.read",
"project.conversations.write",
"project.conversations.create",
"project.integrations.read",
"project.integrations.connect",
"project.integrations.configure",
"project.api_keys.read",
"project.api_keys.manage",
"project.cache.read",
"project.cache.write",
"project.logs.read",
"project.metrics.read",
"project.resources.read"
]
},
"description": "Project capabilities the role grants, as the permission checks resolve them."
}
},
"required": [
"user_id",
"email",
"name",
"avatar_src",
"role",
"capabilities"
]
}
},
"page_info": {
"$ref": "#/components/schemas/PageInfo"
}
},
"required": [
"data",
"page_info"
]
}
}
}
},
"400": {
"description": "Invalid limit, or a cursor that names no member of this project",
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
}
},
"403": {
"description": "Forbidden - insufficient permissions",
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
}
},
"404": {
"description": "Project not found",
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
}
},
"500": {
"description": "Server error",
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
}
},
"503": {
"description": "internal: authentication state is temporarily unavailable and the request was not processed; retry shortly.",
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
}
}
},
"x-documentation-source-tag": "Project Members",
"x-canonical-documentation": {
"domain": "identity-access",
"resource": "Users",
"subgroup": "Project members",
"name": "List project members",
"description": "Lists the project's members with their role and resolved capabilities, one page at a time by user ID cursor. Requires project.members.read.",
"operationId": "listProjectMembers"
},
"x-mint": {
"href": "/cloud/rest/api-reference/identity-access-users-project-members/list-project-members"
}
}