Sign in

v50

latestOpenAPI 3.0.0raw.githubusercontent.com2026-07-27107348584.3 KB
Invites

List Invites

List the list of invites sent out to users.

get/invites

Query parameters

sizeinteger
Example:50

The number of objects you want returned in a collection.

cursorstring

Uses the filter values of the previous page to determine the next set of items.

Response

OK

code'OK' | 'CREATED' | 'INVALID_CREDENTIALS' | 'INVALID_PARAMETERS' | 'INVALID_TOKEN' | 'UNAUTHORIZED_ACCESS' | 'MISSING_RESOURCE' | 'REQUEST_LIMIT_EXCEEDED' | 'SERVER_ERROR' | 'UNSUPPORTED_METHOD' | 'SERVER_UNAVAILABLE' | 'TIME_LIMIT_EXCEEDED'

Request status code

messagestring

Message response to the request

requestIdstring

Unique ID that is added to the body of every response for easy traceability of the request in our logs.

Example response

{
  "code": "OK",
  "message": "Success",
  "requestId": "5b79399a-6852-4234-bb0e-ad472648282d",
  "data": {
    "nextCursor": "1259723474",
    "items": [
      {
        "id": "17bbf36498de4d68a0d4f86c7b62f69f",
        "createdAt": "2021-04-14T09:30:24Z",
        "fullName": "George Cimafranca Palomero, Jr",
        "firstName": "George",
        "lastName": "Palomero",
        "email": "gpalomero1234@smileapi.io",
        "templateId": "tpl-b2c5e816-65ad-4130-819d-db89acc5869a",
        "winkTemplateId": "wtpl-db89acc5869a-b2c5e816-65ad-4130-819d",
        "userId": "tenantId-b2c5e816-65ad-4130-819d-db89acc5869a",
        "updatedAt": "2021-04-14T09:30:24Z",
        "invitedAt": "2021-04-14T09:30:24Z",
        "linkedAt": "2021-04-14T09:30:24Z"
      }
    ]
  }
}