Skip to main content
GET
/
organizations
/
{id}
/
invitations
TypeScript
import { ManagementClient } from "auth0";

async function main() {
    const client = new ManagementClient({
        token: "<token>",
    });
    await client.organizations.invitations.list("id", {
        page: 1,
        perPage: 1,
        includeTotals: true,
        fields: "fields",
        includeFields: true,
        sort: "sort",
    });
}
main();
[
  {
    "id": "uinv_0000000000000001",
    "organization_id": "<string>",
    "inviter": {
      "name": "Jane Doe"
    },
    "invitee": {
      "email": "john.doe@gmail.com"
    },
    "invitation_url": "https://mycompany.org/login?invitation=f81dWWYW6gzGGicxT8Ha0txBkGNcAcYr&organization=org_0000000000000001&organization_name=acme",
    "created_at": "2020-08-20T19:10:06.299Z",
    "expires_at": "2020-08-27T19:10:06.299Z",
    "client_id": "AaiyAPdpYdesoKnqjj8HJqRn4T5titww",
    "connection_id": "con_0000000000000001",
    "app_metadata": {},
    "user_metadata": {},
    "roles": [
      "<string>"
    ],
    "ticket_id": "<string>"
  }
]

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
id
string
required

Organization identifier.

Maximum string length: 50

Query Parameters

​
page
integer

Page index of the results to return. First page is 0.

Required range: x >= 0
​
per_page
integer

Number of results per page. Defaults to 50.

Required range: 1 <= x <= 100
​
include_totals
boolean

When true, return results inside an object that also contains the start and limit. When false (default), a direct array of results is returned. We do not yet support returning the total invitations count.

​
fields
string

Comma-separated list of fields to include or exclude (based on value provided for include_fields) in the result. Leave empty to retrieve all fields.

Pattern: ^((app_metadata)|(user_metadata)|(client_id)|(connection_id)|(created_at)|(expires_at)|(id)|(invitation_url)|(invitee)|(inviter)|(organization_id)|(roles))(,((app_metadata)|(user_metadata)|(client_id)|(connection_id)|(created_at)|(expires_at)|(id)|(invitation_url)|(invitee)|(inviter)|(organization_id)|(roles)))*$
​
include_fields
boolean

Whether specified fields are to be included (true) or excluded (false). Defaults to true.

​
sort
string

Field to sort by. Use field:order where order is 1 for ascending and -1 for descending Defaults to created_at:-1.

Pattern: ^((created_at))\:(1|-1)$

Response

Invitations successfully retrieved.

​
id
string<user-invitation-id>
default:uinv_0000000000000001

The id of the user invitation.

​
organization_id
string<organization-id>

Organization identifier.

Maximum string length: 50
​
inviter
object
​
invitee
object
​
invitation_url
string<strict-https-uri>
default:https://mycompany.org/login?invitation=f81dWWYW6gzGGicxT8Ha0txBkGNcAcYr&organization=org_0000000000000001&organization_name=acme

The invitation url to be send to the invitee.

​
created_at
string<date-time>
default:2020-08-20T19:10:06.299Z

The ISO 8601 formatted timestamp representing the creation time of the invitation.

​
expires_at
string<date-time>
default:2020-08-27T19:10:06.299Z

The ISO 8601 formatted timestamp representing the expiration time of the invitation.

​
client_id
string<client-id>
default:AaiyAPdpYdesoKnqjj8HJqRn4T5titww

Auth0 client ID. Used to resolve the application's login initiation endpoint.

​
connection_id
string<connection-id>
default:con_0000000000000001

The id of the connection to force invitee to authenticate with.

​
app_metadata
object

Data related to the user that does affect the application's core functionality.

​
user_metadata
object

Data related to the user that does not affect the application's core functionality.

​
roles
string<role-id>[]

List of roles IDs to associated with the user.

Minimum array length: 1
​
ticket_id
string<ticket-id>

The id of the invitation ticket