Account8

AccountPlan6

Aggregation5

Auth1

BalanceChargeSchedule6

Balances8

BalanceTransactionSchedule6

Bill20

BillConfig2

BillGroupingKey5

BillJob5

Charge5

Commitments6

CompoundAggregation5

Contract6

Counter5

CounterAdjustments5

CounterPricing5

CreditReason5

Credits5

Currency5

CustomField2

DataExplorer20

DataExplorerV26

DebitReason5

Debits5

Events4

ExportAdHoc1

ExportDestination6

ExportJob2

ExportSchedule5

External Mapping8

ExternalMappings2

IntegrationConfigs12

IntegrationCredentials5

IntegrationDestinations22

IntegrationRuns7

IntegrationTransformations7

Invitations3

Line Item1

LookupTable5

LookupTableRevision6

LookupTableRevisionData13

Marketplace Integrations1

Measurements6

Meter5

MeterGroup5

Notifications6

OrganizationConfig2

OrgUsers6

PermissionPolicy13

Plan5

PlanGroup5

PlanGroupLink5

PlanTemplate5

Pricing5

Product5

ResourceGroup9

ScheduledEventConfigurations5

ServiceUser6

ServiceUserCredentials6

StatementDefinition5

StatementJob5

Support3

TransactionType5

User1

Invitations

Retrieve Invitation

Changed on Oct 16, 2026

Retrieve the specified invitation with the given UUID.

get/organizations/{orgId}/invitations/{id}

Request

Base URL
https://api.m3ter.com
Auth
OAuth 2
Authorization codehttps://m3ter.auth.us-east-1.amazoncognito.com/oauth2/authorize, token URL https://m3ter.auth.us-east-1.amazoncognito.com/oauth2/token
Client credentialsToken URL /oauth/token
TypeScript
https://skmtc.dev/m3ter-com/apis/m3ter-api/docs/organizations/:orgId/invitations/:id/get.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

orgIdstring required

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

idstring required

UUID of the specific invitation to retrieve.

Response

Returns the specified invitation

idstring required

The UUID of the entity.

versioninteger

The version number:

Create: On initial Create to insert a new entity, the version is set at 1 in the response.
Update: On successful Update, the version is incremented by 1 in the response.

emailstring

The email address of the invitee. The invitation will be sent to this email address.

permissionPolicyIdsstring[]

The IDs of the permission policies the invited user has been assigned. This controls the access rights and privileges that this user will have when working in the m3ter Organization.

firstNamestring

The first name of the invitee.

lastNamestring

The surname of the invitee.

dtEndAccessstring date-time

The date that access will end for the user (in ISO-8601 format). If this is blank, there is no end date meaning that the user has permanent access.

dtExpirystring date-time

The date when the invite expires (in ISO-8601 format). After this date the invited user can no longer accept the invite. By default, any invite is valid for 30 days from the date the invite is sent.

invitingPrincipalIdstring

The UUID of the user who sent the invite.

acceptedboolean

Boolean indicating whether the user has accepted the invitation.

TRUE - the invite has been accepted.
FALSE - the invite has not yet been accepted.

dtCreatedstring date-time

The DateTime when the invitation was created (in ISO-8601 format).

dtLastModifiedstring date-time

The DateTime when the invitation was last modified (in ISO-8601 format).

createdBystring

The UUID of the user who created the invitation.

lastModifiedBystring

The UUID of the user who last modified the invitation.

Changes

Oct 16, 202685c514abc692 Revision changes
- breaking
  the response property / became optional for the status
- breaking
  the response property / became optional for the status
- breaking
  the response property / became optional for the status
- breaking
  the response property / became optional for the status
- breaking
  the response property / became optional for the status
- breaking
  the response property / became optional for the status
- breaking
  the response property / became optional for the status
- breaking
  the response property / became optional for the status
- breaking
  the response's property type changed from no type to object for status
Dec 3, 2025ac93d1a9e6d9 Revision changes
- breaking
  removed the required property from the response with the status
- breaking
  removed the required property from the response with the status
- breaking
  removed the required property from the response with the status
- breaking
  removed the required property from the response with the status
- breaking
  removed the required property from the response with the status
- breaking
  removed the required property from the response with the status
- breaking
  removed the required property from the response with the status
- breaking
  removed the required property from the response with the status
- breaking
  removed the required property from the response with the status
- breaking
  removed the required property from the response with the status
- warning
  removed the optional property from the response with the status
- warning
  removed the optional property from the response with the status
- warning
  removed the optional property from the response with the status
- warning
  removed the optional property from the response with the status
- info
  added subschema #2 to the response body allOf list for the response status

Operation history

Retrieve Invitation

Request

Path parameters

Response 200OK

Changes

Response