PEpermit
Projects

List Projects

Lists all the projects under the active organization.

get/v2/projects

Request

  • Base URL
    https://api.permit.io (the document declares no server; this is the origin it was published from)
  • Auth
    HTTP bearer

Query parameters

pageinteger

Page number of the results to fetch, starting at 1.

per_pageinteger

The number of results per page (max 100).

Response

Successful Response

keystring required

A URL-friendly name of the project (i.e: slug). You will be able to query later using this key instead of the id (UUID) of the project.

urn_namespacestring

Optional namespace for URNs. If empty, URNs will be generated from project key.

idstring uuid required

Unique id of the project

organization_idstring uuid required

Unique id of the organization that the project belongs to.

created_atstring date-time required

Date and time when the project was created (ISO_8601 format).

updated_atstring date-time required

Date and time when the project was last updated/modified (ISO_8601 format).

namestring required

The name of the project

descriptionstring

a longer description outlining the project objectives

settingsobject

the settings for this project

active_policy_repo_idstring uuid

the id of the policy repo to use for this project

Changes

No recorded changes to this operation across all 25 revisions of this API.