Skip to content
NimlesNimlesNimles Docs

Get an invite

GET
/api/tenant/{tenantId}/Invites/{id}
curl --request GET \
  --url https://api.nimles.com/identity/api/tenant/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/Invites/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0 \
  --header 'Authorization: Bearer <token>'

Gets an invite by ID.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
id
required
string format: uuid

A unique identifier for the invite.

tenantId
required
string format: uuid

Your tenant id.

Responses

Section titled “Responses”

200

Section titled “200”

OK

Media typeapplication/json
object
fields
object
key
additional properties
string
data
object
fields
object
key
additional properties
object
value
required
nullable
valueType
string
nullable
accessibility
string
nullable
id
string format: uuid
relations
Array<object>
nullable
object
fields
object
key
additional properties
object
value
required
nullable
valueType
string
nullable
accessibility
string
nullable
id
string format: uuid
name
string
nullable
entityId
required
string format: uuid
entityType
required
string
>= 1 characters
relationType
required
string
>= 1 characters
tenantId
string format: uuid
nullable
resourceGroupId
string format: uuid
nullable
creatorId
string format: uuid
nullable
createdDate
string format: date-time
nullable
version
integer format: int32
nullable
lastModified
string format: date-time
nullable
email
required
string
>= 1 characters
roleDefinitionId
required
string format: uuid
scope
required
object
data
object
key
additional properties
string
control
required
object
tenantId
string format: uuid
nullable
organizationId
string format: uuid
nullable
resourceGroupId
string format: uuid
nullable
instance
string
nullable
status
required
string
>= 1 characters
expiresAt
string format: date-time
nullable
acceptedAt
string format: date-time
nullable
acceptedByPrincipalId
string format: uuid
nullable
inviteCode
string
nullable
requiresApproval
boolean
requestedByPrincipalId
string format: uuid
nullable
requesterName
string
nullable
requesterPhone
string
nullable
requestMessage
string
nullable
allowAnyAccount
boolean
isExpired
boolean
sendEmail
boolean
lastSentAt
string format: date-time
nullable
invitedByName
string
nullable
invitedByEmail
string
nullable
message
string
nullable
roleName
string
nullable
organizationName
string
nullable

Example generated

{
  "data": {
    "fields": {
      "additionalProperty": {
        "value": "example",
        "valueType": "example"
      }
    },
    "accessibility": "example",
    "id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
    "relations": [
      {
        "fields": {
          "additionalProperty": {
            "value": "example",
            "valueType": "example"
          }
        },
        "accessibility": "example",
        "id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
        "name": "example",
        "entityId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
        "entityType": "example",
        "relationType": "example"
      }
    ],
    "tenantId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
    "resourceGroupId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
    "creatorId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
    "createdDate": "2026-04-15T12:00:00Z",
    "version": 1,
    "lastModified": "2026-04-15T12:00:00Z",
    "email": "example",
    "roleDefinitionId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
    "scope": {
      "data": {
        "additionalProperty": "example"
      },
      "control": {
        "tenantId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
        "organizationId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
        "resourceGroupId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
        "instance": "example"
      }
    },
    "status": "example",
    "expiresAt": "2026-04-15T12:00:00Z",
    "acceptedAt": "2026-04-15T12:00:00Z",
    "acceptedByPrincipalId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
    "inviteCode": "example",
    "requiresApproval": true,
    "requestedByPrincipalId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
    "requesterName": "example",
    "requesterPhone": "example",
    "requestMessage": "example",
    "allowAnyAccount": true,
    "isExpired": true,
    "sendEmail": true,
    "lastSentAt": "2026-04-15T12:00:00Z",
    "invitedByName": "example",
    "invitedByEmail": "example",
    "message": "example",
    "roleName": "example",
    "organizationName": "example"
  }
}

401

Section titled “401”

Unauthorized: no bearer token, or one that is expired or not for this API.

403

Section titled “403”

Forbidden: the caller holds no role that allows this action at this scope. The body is empty, or a problem whose detail names the action.

Media typeapplication/json

An RFC 9457 problem.

object
detail
string
nullable
instance
string
nullable
status
integer format: int32
nullable
title
string
nullable
type
string
nullable
key
additional properties

Example generated

{
  "detail": "example",
  "instance": "example",
  "status": 1,
  "title": "example",
  "type": "example"
}

404

Section titled “404”

Not found: no such item in the tenant.

Media typeapplication/problem+json

An RFC 9457 problem.

object
detail
string
nullable
instance
string
nullable
status
integer format: int32
nullable
title
string
nullable
type
string
nullable
key
additional properties

Example generated

{
  "detail": "example",
  "instance": "example",
  "status": 1,
  "title": "example",
  "type": "example"
}