GET /orgs/{org}/invitations

The return hash contains a role field which refers to the Organization Invitation role and will be one of the following values: direct_member, admin, billing_manager, or hiring_manager. If the invitee is not a GitHub member, the login field in the return hash will be null.

Servers

Path parameters

Name Type Required Description
org String Yes

The organization name. The name is not case sensitive.

Query parameters

Name Type Required Description
page Integer No

The page number of the results to fetch. For more information, see "Using pagination in the REST API."

Default value: 1

per_page Integer No

The number of results per page (max 100). For more information, see "Using pagination in the REST API."

Default value: 30

invitation_source String No

Filter invitations by their invitation source.

Possible values:

  • "member"
  • "scim"
  • "all"

Default value: "all"

role String No

Filter invitations by their member role.

Possible values:

  • "billing_manager"
  • "direct_member"
  • "admin"
  • "hiring_manager"
  • "all"

Default value: "all"

How to start integrating

  1. Add HTTP Task to your workflow definition.
  2. Search for the API you want to integrate with and click on the name.
    • This loads the API reference documentation and prepares the Http request settings.
  3. Click Test request to test run your request to the API and see the API's response.