Skip to main content
GET
/
agents
/
pending
Retrieve pending agent invitations
curl --request GET \
  --url https://api.getfernand.com/agents/pending \
  --header 'X-API-Key: <api-key>'
[
  {
    "id": 42,
    "name": "Richard Hendricks",
    "email": "richard.hendricks@piedpiper.com",
    "roles": [
      "conversation.create",
      "conversation.reply"
    ],
    "avatar": "https://api.getfernand.com/contacts/richard.hendricks@piedpiper.com/avatar",
    "last_email_sent_ts": 1234567890000
  }
]
Returns all pending agent invitations for the organization.

Authorizations

​
X-API-Key
string
header
required

Authenticate your account by including your secret key in API requests. You can manage your API keys in the Dashboard.

Authentication to the API is performed by using the HTTP Header X-API-Key.

Response

Successfully retrieved pending invitations. Returns empty array if actor lacks teammate.invite permission.

​
id
integer<int32>
required

Unique identifier for the agent invitation

Example:

42

​
name
string
required

Display name derived from the email address (before @ symbol, formatted)

Example:

"Richard Hendricks"

​
email
string<email>
required

Email address of the invited agent

Maximum string length: 250
Example:

"richard.hendricks@piedpiper.com"

​
roles
string[]
required

List of permission roles to be assigned when the invite is accepted

Example:
["conversation.create", "conversation.reply"]
​
avatar
string<uri>
required

Avatar's URL of the user

Example:

"https://api.getfernand.com/contacts/richard.hendricks@piedpiper.com/avatar"

​
last_email_sent_ts
integer<int64>
required

Unix timestamp (milliseconds) when the invitation email was last sent

Example:

1234567890000