List Pending Invitations in Your Shilo Organization

Use this endpoint to fetch all pending invitations in your Shilo organization. This is useful for auditing who has been invited but hasn’t yet accepted, or for building dashboards that surface outstanding onboarding actions for your team administrators.

Endpoint

GET https://api.shilo.ai/api/v1/invitations

Authentication

Include your API key in the request header:

x-api-key: YOUR_API_KEY

Query Parameters

number

default:"50"

Maximum number of results to return per page. Maximum value is 100.

string

Pagination cursor returned from a previous response’s pagination.next_cursor. Omit to start from the beginning of the list.

string

default:"asc"

Sort order for results by creation date. Accepted values: asc, desc.

Response

200 — Success

Returns an InvitationsResponseDto object containing a data array of Invitation objects and a pagination block.

array

Array of pending Invitation objects.

Show Invitation object

string

Unique identifier for the invitation (UUID).

string

Email address the invitation was sent to.

string

Current status of the invitation. Will be pending for all results returned by this endpoint.

string

ISO-8601 timestamp of when the invitation was created.

object

Pagination metadata for iterating through large result sets.

Show pagination object

boolean

Whether additional pages of results exist beyond the current page.

string | null

Cursor to pass as the cursor query parameter to retrieve the next page. null when has_more is false.

401 — Unauthorized

Your API key is missing or invalid. Ensure the x-api-key header is present and correct.

Example Request

curl --request GET \
  --url "https://api.shilo.ai/api/v1/invitations?limit=50&sort=asc" \
  --header "x-api-key: YOUR_API_KEY"

Example Response

{
  "data": [
    {
      "id": "ee6f2136-b94a-4438-9335-3acf5b2a0d31",
      "email": "newagent@example.com",
      "status": "pending",
      "created_date": "2030-09-24T12:34:56Z"
    }
  ],
  "pagination": {
    "has_more": false,
    "next_cursor": null
  }
}

⌘I

Overview

Calls

Appointments

Roleplays

Contacts

Users

Invitations

Metrics

Coaching

List Pending Invitations in Your Shilo Organization

Endpoint

Authentication

Query Parameters

Response

200 — Success

401 — Unauthorized

Example Request

Example Response

​Endpoint

​Authentication

​Query Parameters

​Response

​200 — Success

​401 — Unauthorized

​Example Request

​Example Response

Endpoint

Authentication

Query Parameters

Response

200 — Success

401 — Unauthorized

Example Request

Example Response