Skip to content
Lucero

Returns a list of invites in the organization.

GET
/organization/invites

Authorizations

Parameters

Query Parameters

limit
integer
default: 20

A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20.

after
string

A cursor for use in pagination. after is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include after=obj_foo in order to fetch the next page of the list.

Responses

200

Invites listed successfully.

object
object
required

The object type, which is always list

string
Allowed values: list
data
required
Array<object>

Represents an individual invite to the organization.

object
object
required

The object type, which is always organization.invite

string
Allowed values: organization.invite
id
required

The identifier, which can be referenced in API endpoints

string
email
required

The email address of the individual to whom the invite was sent

string
role
required

owner or reader

string
Allowed values: owner reader
status
required

accepted,expired, or pending

string
Allowed values: accepted expired pending
invited_at
required

The Unix timestamp (in seconds) of when the invite was sent.

integer
expires_at
required

The Unix timestamp (in seconds) of when the invite expires.

integer
accepted_at

The Unix timestamp (in seconds) of when the invite was accepted.

integer
first_id

The first invite_id in the retrieved list

string
last_id

The last invite_id in the retrieved list

string
has_more

The has_more property is used for pagination to indicate there are additional results.

boolean