Skip to main content
GET
/
organizations
/
{orgId}
/
invitations
Retrieve Invitations
curl --request GET \
  --url https://api.m3ter.com/organizations/{orgId}/invitations \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "id": "<string>",
      "version": 123,
      "email": "<string>",
      "permissionPolicyIds": [
        "<string>"
      ],
      "firstName": "<string>",
      "lastName": "<string>",
      "dtEndAccess": "2023-11-07T05:31:56Z",
      "dtExpiry": "2023-11-07T05:31:56Z",
      "invitingPrincipalId": "<string>",
      "accepted": true,
      "dtCreated": "2023-11-07T05:31:56Z",
      "dtLastModified": "2023-11-07T05:31:56Z",
      "createdBy": "<string>",
      "lastModifiedBy": "<string>"
    }
  ],
  "nextToken": "<string>"
}

Authorizations

​
Authorization
string
header
required

m3ter supports machine to machine authentication using the clientCredentials OAuth2 flow.

The authorizationCode flow controls access for human users via the m3ter Console application.

Path Parameters

​
orgId
string
required

UUID of the organization. The Organization represents your company as a direct customer of the m3ter service.

Query Parameters

​
pageSize
integer<int32>

Number of invitations to retrieve per page.

Required range: 1 <= x <= 200
​
nextToken
string

nextToken for multi page retrievals.

Response

Returns the list of invitations

​
data
object[]
​
nextToken
string