PEpermit
Organizations

List Organizations

Changed on

Lists all the organizations that can be accessed by the authenticated actor (i.e: human team member or api key).

get/v2/orgs

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

string uuid
OR
string
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 organization (i.e: slug). You will be able to query later using this key instead of the id (UUID) of the organization.

idstring uuid required

Unique id of the organization

is_enterpriseboolean required

Is this an enterprise account?

created_atstring date-time required

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

updated_atstring date-time required

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

namestring required

The name of the organization, usually it's your company's name.

settingsobject

the settings for this project

Changes

  • 05b99f06db87Revision changes
    • info

      for the query request parameter search, the type was generalized from string to no type

    • info

      added to the /// response property allOf list for the response status

    • info

      removed from the /// response property allOf list for the response status

    • info

      the response's property default value changed from free to trial for the status

    • info

      the response's property default value changed from 1000 to 5000 for the status

    • info

      the response's property default value changed from 20 to 50 for the status

    • info

      the response's property default value changed from {"mau":1000,"tenants":20,"billing_tier":"free"} to {"mau":5000,"tenants":50,"billing_tier":"trial"} for the status