Organization
An individual organization.
Attributes
Minimal Representation
Included when the resource is returned as part of another resource.
| Name | Type | Description |
|---|---|---|
| id | Integer | Value uniquely identifying the organization. |
| login | String | Login set on GitHub. |
| name | String | Name set on GitHub. |
| vcs_type | Unknown | The organization's vcs_type. |
| ro_mode | Unknown | The organization's ro_mode. |
Standard Representation
Included when the resource is the main response of a request, or is eager loaded.
| Name | Type | Description |
|---|---|---|
| id | Integer | Value uniquely identifying the organization. |
| login | String | Login set on GitHub. |
| name | String | Name set on GitHub. |
| github_id | Integer | Id set on GitHub. |
| vcs_id | Unknown | The organization's vcs_id. |
| vcs_type | Unknown | The organization's vcs_type. |
| avatar_url | String | Avatar_url set on GitHub. |
| education | Boolean | Whether or not the organization has an education account. |
| allow_migration | Unknown | The organization's allow_migration. |
| allowance | Unknown | The organization's allowance. |
| ro_mode | Unknown | The organization's ro_mode. |
| custom_keys | Unknown | The organization's custom_keys. |
| trial_allowed | Unknown | The organization's trial_allowed. |
| account_env_vars | Unknown | The organization's account_env_vars. |
Additional Attributes
| Name | Type | Description |
|---|---|---|
| repositories | [Repository] | Repositories belonging to this organization. |
| installation | Installation | Installation belonging to the organization. |
| trial_allowed | Unknown | The organization's trial_allowed. |
Actions
Find
This returns an individual organization.
GET
/org/{organization.id}
| Template Variable | Type | Description |
|---|---|---|
| organization.id | Integer | Value uniquely identifying the organization. |
| Query Parameter | Type | Description |
|---|---|---|
| include | [String] | List of attributes to eager load. |
Example:GET /org/87
Update Billing Permission
Document resources/organization/actions/update_billing_permission not found.
PATCH
/org/{organization.id}/update_billing_permission
| Template Variable | Type | Description |
|---|---|---|
| organization.id | Integer | Value uniquely identifying the organization. |
| Accepted Parameter | Type | Description |
|---|---|---|
| organization.billing_admin_only | Unknown | Documentation missing. |
Example:PATCH /org/87/update_billing_permission
Suspend
Document resources/organization/actions/suspend not found.
POST
/org/{organization.id}/suspend
| Template Variable | Type | Description |
|---|---|---|
| organization.id | Integer | Value uniquely identifying the organization. |
Example:POST /org/87/suspend
Unsuspend
Document resources/organization/actions/unsuspend not found.
POST
/org/{organization.id}/unsuspend
| Template Variable | Type | Description |
|---|---|---|
| organization.id | Integer | Value uniquely identifying the organization. |
Example:POST /org/87/unsuspend
User Activity
Document resources/organization/actions/user_activity not found.
GET
/org/{organization.id}/user_activity
| Template Variable | Type | Description |
|---|---|---|
| organization.id | Integer | Value uniquely identifying the organization. |
| Query Parameter | Type | Description |
|---|---|---|
| date | Unknown | Alias for organization.date. |
| id | Integer | Alias for organization.id. |
| include | [String] | List of attributes to eager load. |
| limit | Integer | How many organization to include in the response. Used for pagination. |
| offset | Integer | How many organization to skip before the first entry in the response. Used for pagination. |
| organization.date | Unknown | Documentation missing. |
| organization.id | Integer | Value uniquely identifying the organization. |
| organization.status | Unknown | Documentation missing. |
| status | Unknown | Alias for organization.status. |
Example:GET /org/87/user_activity?limit=5