Skip to content

Invites

This group of endpoints allows you to create, list, and cancel pending user invitations. An invite exists until the recipient accepts it, at which point they appear as a user in the Users endpoints.

Operations

List invites

Request

Returns a paginated list of invites for the given business. Includes both pending and accepted invites; excludes cancelled invites.

Security
BearerAuth
Path
client_idintegerrequired

The ID of the business.

Example:123
Query
offsetinteger

Offset to retrieve items from.

Default:0
Example:offset=50
limitinteger, <= 500

Number of items per page.

Default:50
Example:limit=50
curl -i -X GET \
  'https://public.letsweel.com/v1/businesses/123/invites?offset=50&limit=50' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

OK

Bodyapplication/json
countinteger

The total number of invites that match the query.

Example:10
nextstring or null

The URL to the next page of invites.

Example:"offset=50&limit=50"
previousstring or null

The URL to the previous page of invites.

Example:null
resultsArray of objects(Invite)
Response
{
  "count": 10,
  "next": "offset=50&limit=50",
  "previous": null,
  "results": [
    { … }
  ]
}