Get team invitation

Show a pending invitation for the team.

Processing mode: sync

GET /orgs/{organization}/teams/{team}/invites/{invitation}

Get team invitation

PHP

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://forge.laravel.com/api/orgs/{organization}/teams/{team}/invites/{invitation}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

200

{
  "data": {
    "id": "<string>",
    "type": "teamInvitations",
    "links": {
      "self": {
        "href": "<string>",
        "rel": "<string>",
        "describedby": "<string>",
        "title": "<string>",
        "type": "<string>",
        "hreflang": "<string>",
        "meta": {}
      }
    },
    "attributes": {
      "email": "<string>",
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z"
    },
    "relationships": {
      "role": {
        "data": {
          "type": "predefinedRoles",
          "id": "<string>"
        }
      },
      "team": {
        "data": {
          "type": "teams",
          "id": "<string>"
        }
      },
      "organization": {
        "data": {
          "type": "organizations",
          "id": "<string>"
        }
      }
    }
  },
  "included": [
    {
      "id": "<string>",
      "type": "predefinedRoles",
      "links": {
        "self": {
          "href": "<string>",
          "rel": "<string>",
          "describedby": "<string>",
          "title": "<string>",
          "type": "<string>",
          "hreflang": "<string>",
          "meta": {}
        }
      },
      "attributes": {
        "name": "<string>",
        "created_at": "2023-11-07T05:31:56Z",
        "updated_at": "2023-11-07T05:31:56Z"
      },
      "relationships": {
        "permissions": {
          "data": [
            {
              "type": "permissions",
              "id": "<string>"
            }
          ]
        }
      }
    }
  ]
}

Authorizations

Authorization · string · header · required

The access token received from the authorization server in the OAuth 2.0 flow.

Scopes

team:view

Allow members to view teams

Path Parameters

organization · string · required

The organization slug

team · integer · required

The team ID

invitation · integer · required

The invitation ID

Response

200

application/vnd.api+json

TeamInvitationResource

data · TeamInvitationResource · object · required

Show child attributes

included · (RoleResource · object | TeamResource · object | OrganizationResource · object)[]

RoleResource

TeamResource

OrganizationResource

Show child attributes