Sign in
Start free7-day free trial
Live API contract
API REFERENCE / Events and invitations

Retrieve an event roster

GET/v1/events/{id}

Invitees are returned without email, phone, or their personal invite token: those are contact details the organization uploaded, not data this API hands back.

Authentication

Send an organization-scoped API key in the Authorization header. Keep credentials on your server.

events:read
Authentication and API keys →

Parameters

idpathrequired
string · uuid

Responses

200 Response schema

application/json

idstring · uuidrequired
namestringrequired
templateIdstring · uuidrequired
locationIdstring | nullrequired
startsAtstring | nullrequired
endsAtstring | nullrequired
statusstringrequired

Allowed values: "active", "closed"

countsobjectrequired
View nested fields
invitedintegerrequired

Range: -9007199254740991 to 9007199254740991.

signedintegerrequired

Range: -9007199254740991 to 9007199254740991.

pendingintegerrequired

Range: -9007199254740991 to 9007199254740991.

bouncedintegerrequired

Range: -9007199254740991 to 9007199254740991.

descriptionstring | nullrequired
rosterUrlstringrequired
publicUrlstringrequired
inviteesarrayrequired
View item fields
idstring · uuidrequired
statusstringrequired

Allowed values: "invited", "opened", "signed", "bounced", "cancelled"

sendCountintegerrequired

Range: -9007199254740991 to 9007199254740991.

lastSentAtstring | nullrequired
lastChannelstring | nullrequired
waiverIdstring | nullrequired
View complete response schema
HTTP 200 schema
{
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "format": "uuid",
      "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000)$"
    },
    "name": {
      "type": "string"
    },
    "templateId": {
      "type": "string",
      "format": "uuid",
      "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000)$"
    },
    "locationId": {
      "anyOf": [
        {
          "type": "string",
          "format": "uuid",
          "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000)$"
        },
        {
          "type": "null"
        }
      ]
    },
    "startsAt": {
      "anyOf": [
        {
          "type": "string",
          "format": "date-time"
        },
        {
          "type": "null"
        }
      ]
    },
    "endsAt": {
      "anyOf": [
        {
          "type": "string",
          "format": "date-time"
        },
        {
          "type": "null"
        }
      ]
    },
    "status": {
      "type": "string",
      "enum": [
        "active",
        "closed"
      ]
    },
    "counts": {
      "type": "object",
      "properties": {
        "invited": {
          "type": "integer",
          "minimum": -9007199254740991,
          "maximum": 9007199254740991
        },
        "signed": {
          "type": "integer",
          "minimum": -9007199254740991,
          "maximum": 9007199254740991
        },
        "pending": {
          "type": "integer",
          "minimum": -9007199254740991,
          "maximum": 9007199254740991
        },
        "bounced": {
          "type": "integer",
          "minimum": -9007199254740991,
          "maximum": 9007199254740991
        }
      },
      "required": [
        "invited",
        "signed",
        "pending",
        "bounced"
      ],
      "additionalProperties": false
    },
    "description": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ]
    },
    "rosterUrl": {
      "type": "string"
    },
    "publicUrl": {
      "type": "string"
    },
    "invitees": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "format": "uuid",
            "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000)$"
          },
          "status": {
            "type": "string",
            "enum": [
              "invited",
              "opened",
              "signed",
              "bounced",
              "cancelled"
            ]
          },
          "sendCount": {
            "type": "integer",
            "minimum": -9007199254740991,
            "maximum": 9007199254740991
          },
          "lastSentAt": {
            "anyOf": [
              {
                "type": "string",
                "format": "date-time"
              },
              {
                "type": "null"
              }
            ]
          },
          "lastChannel": {
            "anyOf": [
              {
                "type": "string",
                "enum": [
                  "email",
                  "sms"
                ]
              },
              {
                "type": "null"
              }
            ]
          },
          "waiverId": {
            "anyOf": [
              {
                "type": "string",
                "format": "uuid",
                "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000)$"
              },
              {
                "type": "null"
              }
            ]
          }
        },
        "required": [
          "id",
          "status",
          "sendCount",
          "lastSentAt",
          "lastChannel",
          "waiverId"
        ],
        "additionalProperties": false
      }
    }
  },
  "required": [
    "id",
    "name",
    "templateId",
    "locationId",
    "startsAt",
    "endsAt",
    "status",
    "counts",
    "description",
    "rosterUrl",
    "publicUrl",
    "invitees"
  ],
  "additionalProperties": false
}

401 Response schema

application/json

errorobjectrequired
View nested fields
codestringrequired
messagestringrequired
requestIdstringrequired
detailsvalue
View complete response schema
HTTP 401 schema
{
  "type": "object",
  "properties": {
    "error": {
      "type": "object",
      "properties": {
        "code": {
          "type": "string"
        },
        "message": {
          "type": "string"
        },
        "requestId": {
          "type": "string"
        },
        "details": {}
      },
      "required": [
        "code",
        "message",
        "requestId"
      ],
      "additionalProperties": false
    }
  },
  "required": [
    "error"
  ],
  "additionalProperties": false
}

403 Response schema

application/json

errorobjectrequired
View nested fields
codestringrequired
messagestringrequired
requestIdstringrequired
detailsvalue
View complete response schema
HTTP 403 schema
{
  "type": "object",
  "properties": {
    "error": {
      "type": "object",
      "properties": {
        "code": {
          "type": "string"
        },
        "message": {
          "type": "string"
        },
        "requestId": {
          "type": "string"
        },
        "details": {}
      },
      "required": [
        "code",
        "message",
        "requestId"
      ],
      "additionalProperties": false
    }
  },
  "required": [
    "error"
  ],
  "additionalProperties": false
}

404 Response schema

application/json

errorobjectrequired
View nested fields
codestringrequired
messagestringrequired
requestIdstringrequired
detailsvalue
View complete response schema
HTTP 404 schema
{
  "type": "object",
  "properties": {
    "error": {
      "type": "object",
      "properties": {
        "code": {
          "type": "string"
        },
        "message": {
          "type": "string"
        },
        "requestId": {
          "type": "string"
        },
        "details": {}
      },
      "required": [
        "code",
        "message",
        "requestId"
      ],
      "additionalProperties": false
    }
  },
  "required": [
    "error"
  ],
  "additionalProperties": false
}

422 Response schema

application/json

errorobjectrequired
View nested fields
codestringrequired
messagestringrequired
requestIdstringrequired
detailsvalue
View complete response schema
HTTP 422 schema
{
  "type": "object",
  "properties": {
    "error": {
      "type": "object",
      "properties": {
        "code": {
          "type": "string"
        },
        "message": {
          "type": "string"
        },
        "requestId": {
          "type": "string"
        },
        "details": {}
      },
      "required": [
        "code",
        "message",
        "requestId"
      ],
      "additionalProperties": false
    }
  },
  "required": [
    "error"
  ],
  "additionalProperties": false
}

429 Response schema

application/json

errorobjectrequired
View nested fields
codestringrequired
messagestringrequired
requestIdstringrequired
detailsvalue
View complete response schema
HTTP 429 schema
{
  "type": "object",
  "properties": {
    "error": {
      "type": "object",
      "properties": {
        "code": {
          "type": "string"
        },
        "message": {
          "type": "string"
        },
        "requestId": {
          "type": "string"
        },
        "details": {}
      },
      "required": [
        "code",
        "message",
        "requestId"
      ],
      "additionalProperties": false
    }
  },
  "required": [
    "error"
  ],
  "additionalProperties": false
}

Authentication and validation failures use the shared error envelope. Save the request ID when diagnosing a failed call.

Build the surrounding workflow

Read the events and invitations guide for ordering, verification and recovery. Browse the other events and invitations endpoints when you need the next operation.