Skip to content
For the complete documentation index, see llms.txt. This page is also available as Markdown.

Registry V3 Principals

List Principals

get

Lists Principals

Query parameters
account_identifierstringRequired

Unique identifier for the Harness account.

org_identifierstringOptional

Unique identifier for the organization within the account.

Example: default or engineering_org

project_identifierstringOptional

Unique identifier for the project within the organization.

Example: my_project or frontend_services

pageinteger · int64Optional

The page number for pagination (0-indexed).

Used to navigate through large result sets. Combined with size parameter to control which subset of results to return.

Example: page=0 returns the first page, page=1 returns the second page

Default: 0
sizeinteger · int64 · min: 1 · max: 100Optional

The number of items to return per page.

Controls the page size for paginated results.

Example: size=50 returns up to 50 items per page

Default: 20
search_termstringOptional

Search term for filtering results.

Example: search_term=prod might match keys like "production", "prod-env", etc.

principal_typestring · enumOptional

filter by principal type

Possible values:
Responses
200

response for list principal

application/json

Pagination metadata.

  • page selects which page of results to return (0 = first page).
  • size controls how many items are returned per page.
  • hasMore is true if more results exist after this page.
hasMorebooleanRequired

True if more results exist after this page.

Example: true
pageinteger · int64Required

The current page (0-indexed)

Example: 0
sizeinteger · int64Required

Number of items per page

Example: 20
get/v3/principals
GET /api/v3/principals?account_identifier=text HTTP/1.1
Accept: */*
{
  "hasMore": true,
  "page": 0,
  "size": 20,
  "items": []
}

Last updated

Was this helpful?