Skip to main content
GET
/
invitation
/
{invitation_id}
Get Invitation Detail
curl --request GET \
  --url https://external.nectarclimate.com/v2.2/invitation/{invitation_id} \
  --header 'X-API-KEY: <api-key>'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "token": "<string>",
  "invitationType": "<string>",
  "status": "<string>",
  "invitationUrl": "<string>",
  "companyId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "connectionId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "allowedEmails": [
    "[email protected]"
  ],
  "expiresAt": "2023-11-07T05:31:56Z",
  "maxUses": 123,
  "useCount": 123,
  "createdAt": "2023-11-07T05:31:56Z",
  "prefill": {
    "url": "<string>",
    "initialSites": [
      "3c90c3cc-0d44-4b50-8888-8dd25736052a"
    ],
    "utilityTypes": [
      "ELECTRICITY"
    ],
    "country": "AF",
    "connectionOwnerEmail": "[email protected]",
    "dataCollectionStartDate": "2023-12-25"
  },
  "createdConnections": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "datasourceName": "<string>",
      "status": "<string>",
      "created": "2023-11-07T05:31:56Z"
    }
  ],
  "events": [
    {
      "eventType": "<string>",
      "actorEmail": "[email protected]",
      "createdAt": "2023-11-07T05:31:56Z",
      "metadata": "<unknown>"
    }
  ]
}

Authorizations

​
X-API-KEY
string
header
required

Path Parameters

​
invitation_id
string<uuid>
required

ID of the invitation.

Response

Full invitation detail including the audit event log. Returned by the detail endpoint.

​
id
string<uuid>
required

Unique identifier of the invitation.

​
token
string
required

Opaque token used in the invitation URL. This is the value embedded in invitationUrl.

​
invitationType
string
required

CREATE_CONNECTION — invitation to connect a new utility account. EDIT_CONNECTION — invitation to update credentials on an existing connection.

​
status
string
required

ACTIVE — can still be used. EXPIRED — past its expiration time. REVOKED — manually invalidated. FULFILLED — reached its maximum use count.

​
invitationUrl
string
required

Full URL to send to the recipient. Opening this link takes them to the connection form.

​
companyId
string<uuid>
required

The company this invitation belongs to.

​
connectionId
string<uuid> | null
required

For EDIT_CONNECTION invitations, the ID of the connection to update. Null for CREATE_CONNECTION invitations.

​
allowedEmails
string<email>[]
required

Email addresses allowed to use this invitation. Empty list means anyone with the link can use it.

​
expiresAt
string<date-time> | null
required

When the invitation expires. Null means it never expires.

​
maxUses
integer | null
required

Maximum number of times this invitation can be used. Null means unlimited.

​
useCount
integer
required

How many times this invitation has been used so far.

​
createdAt
string<date-time>
required

When the invitation was created.

​
prefill
object
required

Pre-populated form data for CREATE_CONNECTION invitations. Empty object for EDIT_CONNECTION invitations.

​
createdConnections
object[]
required

Connections that were created by recipients of this invitation. Only populated for CREATE_CONNECTION invitations; empty list for EDIT_CONNECTION.

​
events
object[]
required

Chronological audit log of all events on this invitation (views, email verifications, uses, revocations).