{"meta":{"title":"Pontos de extremidade da API REST para interações com a organização","intro":"Use a API REST para restringir temporariamente o tipo de usuário que pode comentar, abrir problemas ou criar solicitações de pull no repositório público de uma organização.","product":"API REST","breadcrumbs":[{"href":"/pt/rest","title":"API REST"},{"href":"/pt/rest/interactions","title":"Interações"},{"href":"/pt/rest/interactions/orgs","title":"Organização"}],"documentType":"article"},"body":"# Pontos de extremidade da API REST para interações com a organização\n\nUse a API REST para restringir temporariamente o tipo de usuário que pode comentar, abrir problemas ou criar solicitações de pull no repositório público de uma organização.\n\n## Sobre as interações de organização\n\nOs proprietários da organização podem restringir temporariamente o tipo de usuário que pode comentar, abrir problemas ou criar solicitações de pull no repositório público da organização. Quando as restrições são habilitadas, apenas o tipo especificado de usuário do GitHub poderá participar das interações. As restrições expiram automaticamente após uma duração definida. Veja mais informações sobre os tipos de usuários GitHub:\n\n* **Usuários existentes:** quando você limita as interações a `existing_users`, os novos usuários que têm contas com menos de 24 horas, que ainda não contribuíram e que não são colaboradores ficarão temporariamente restritos na organização.\n* **Somente colaboradores:** quando você limitar as interações aos `contributors_only`, os usuários que ainda não contribuíram e que não são colaboradores ficarão temporariamente restritos na organização.\n* **Somente colaboradores:** quando você limita as interações com `collaborators_only`, os usuários que não são colaboradores são temporariamente restringidos de interagir na organização.\n\nDefinir o limite de interação no nível da organização sobrescreverá quaisquer limites de interação definidos para repositórios individuais pertencentes à organização. Para definir diferentes limites de interação em repositórios individuais pertencentes à organização, use os pontos de extremidade das interações do [Repositório](/pt/rest/interactions/repos).\n\n> \\[!NOTE]\n> Most endpoints use `Authorization: Bearer <YOUR-TOKEN>` and `Accept: application/vnd.github+json` headers, plus `X-GitHub-Api-Version: 2026-03-10`. Curl examples below omit these standard headers for brevity.\n\n## Get interaction restrictions for an organization\n\n```\nGET /orgs/{org}/interaction-limits\n```\n\nShows which type of GitHub user can interact with this organization and when the restriction expires. If there is no restrictions, you will see an empty response.\n\n### Parameters\n\n#### Headers\n\n* **`accept`** (string)\n  Setting to `application/vnd.github+json` is recommended.\n\n#### Path and query parameters\n\n* **`org`** (string) (required)\n  The organization name. The name is not case sensitive.\n\n### HTTP response status codes\n\n* **200** - OK\n\n### Code examples\n\n#### Example\n\n**Request:**\n\n```curl\ncurl -L \\\n  -X GET \\\n  https://api.github.com/orgs/ORG/interaction-limits\n```\n\n**Response schema (Status: 200):**\n\n* any of:\n  * **Interaction Limits**\n    * `limit`: required, string, enum: `existing_users`, `contributors_only`, `collaborators_only`\n    * `origin`: required, string\n    * `expires_at`: required, string, format: date-time\n  * **object**\n\n## Set interaction restrictions for an organization\n\n```\nPUT /orgs/{org}/interaction-limits\n```\n\nTemporarily restricts interactions to a certain type of GitHub user in any public repository in the given organization. You must be an organization owner to set these restrictions. Setting the interaction limit at the organization level will overwrite any interaction limits that are set for individual repositories owned by the organization.\n\n### Parameters\n\n#### Headers\n\n* **`accept`** (string)\n  Setting to `application/vnd.github+json` is recommended.\n\n#### Path and query parameters\n\n* **`org`** (string) (required)\n  The organization name. The name is not case sensitive.\n\n#### Body parameters\n\n* **`limit`** (string) (required)\n  The type of GitHub user that can comment, open issues, or create pull requests while the interaction limit is in effect.\n  Can be one of: `existing_users`, `contributors_only`, `collaborators_only`\n\n* **`expiry`** (string)\n  The duration of the interaction restriction. Default: one\\_day.\n  Can be one of: `one_day`, `three_days`, `one_week`, `one_month`, `six_months`\n\n### HTTP response status codes\n\n* **200** - OK\n\n* **422** - Validation failed, or the endpoint has been spammed.\n\n### Code examples\n\n#### Example\n\n**Request:**\n\n```curl\ncurl -L \\\n  -X PUT \\\n  https://api.github.com/orgs/ORG/interaction-limits \\\n  -d '{\n  \"limit\": \"collaborators_only\",\n  \"expiry\": \"one_month\"\n}'\n```\n\n**Response schema (Status: 200):**\n\n* `limit`: required, string, enum: `existing_users`, `contributors_only`, `collaborators_only`\n* `origin`: required, string\n* `expires_at`: required, string, format: date-time\n\n## Remove interaction restrictions for an organization\n\n```\nDELETE /orgs/{org}/interaction-limits\n```\n\nRemoves all interaction restrictions from public repositories in the given organization. You must be an organization owner to remove restrictions.\n\n### Parameters\n\n#### Headers\n\n* **`accept`** (string)\n  Setting to `application/vnd.github+json` is recommended.\n\n#### Path and query parameters\n\n* **`org`** (string) (required)\n  The organization name. The name is not case sensitive.\n\n### HTTP response status codes\n\n* **204** - No Content\n\n### Code examples\n\n#### Example\n\n**Request:**\n\n```curl\ncurl -L \\\n  -X DELETE \\\n  https://api.github.com/orgs/ORG/interaction-limits\n```\n\n**Response schema (Status: 204):**\n\n## Get pull request creation cap for an org\n\n```\nGET /orgs/{org}/interaction-limits/pulls/creation-cap\n```\n\nGets the pull request creation cap configuration for an organization.\nThe cap limits the total number of open pull requests a user can have across all public\nrepositories in the organization at one time.\nOnly users with admin access to the organization can view the cap configuration.\n\n### Parameters\n\n#### Headers\n\n* **`accept`** (string)\n  Setting to `application/vnd.github+json` is recommended.\n\n#### Path and query parameters\n\n* **`org`** (string) (required)\n  The organization name. The name is not case sensitive.\n\n### HTTP response status codes\n\n* **200** - OK\n\n* **403** - Forbidden\n\n* **404** - Resource not found\n\n* **405** - Method Not Allowed\n\n### Code examples\n\n#### Example\n\n**Request:**\n\n```curl\ncurl -L \\\n  -X GET \\\n  https://api.github.com/orgs/ORG/interaction-limits/pulls/creation-cap\n```\n\n**Response schema (Status: 200):**\n\n* `enabled`: required, boolean\n* `max_open_pull_requests`: required, integer, minimum: 1, maximum: 1000\n\n## Update pull request creation cap for an org\n\n```\nPATCH /orgs/{org}/interaction-limits/pulls/creation-cap\n```\n\nUpdates the pull request creation cap for an organization. The cap limits the total number\nof open pull requests a user can have across all public repositories in the organization\nat one time.\nOnly users with admin access to the organization can configure the cap.\n\n### Parameters\n\n#### Headers\n\n* **`accept`** (string)\n  Setting to `application/vnd.github+json` is recommended.\n\n#### Path and query parameters\n\n* **`org`** (string) (required)\n  The organization name. The name is not case sensitive.\n\n#### Body parameters\n\n* **`enabled`** (boolean) (required)\n  Whether the pull request creation cap is enabled\n\n* **`max_open_pull_requests`** (integer)\n  The maximum number of open pull requests a user can have at one time\n\n### HTTP response status codes\n\n* **200** - OK\n\n* **403** - Forbidden\n\n* **404** - Resource not found\n\n* **405** - Method Not Allowed\n\n* **422** - Validation failed, or the endpoint has been spammed.\n\n### Code examples\n\n#### Example request body\n\n**Request:**\n\n```curl\ncurl -L \\\n  -X PATCH \\\n  https://api.github.com/orgs/ORG/interaction-limits/pulls/creation-cap \\\n  -d '{\n  \"enabled\": true,\n  \"max_open_pull_requests\": 1\n}'\n```\n\n**Response schema (Status: 200):**\n\nSame response schema as [Get pull request creation cap for an org](#get-pull-request-creation-cap-for-an-org)."}