--- updatedAt: 2026-06-09T16:19:20.000Z agentTools: projectIndex: https://docs.smartsurvey.io/llms.txt --- # Get By Id Get a single invitation by its id # OpenAPI definition ```json { "openapi": "3.0.1", "info": { "title": "SS Public API", "version": "v2" }, "servers": [ { "url": "https://{host}/v2", "description": "Select the host for the region your account's data is stored in.", "variables": { "host": { "default": "api.smartsurvey.io", "description": "The regional hostname for your account.", "enum": [ "api.smartsurvey.io", "api-eu.smartsurvey.io", "api-us.smartsurvey.io" ] } } } ], "paths": { "/surveys/{surveyId}/invitations/{invitationId}": { "get": { "tags": [ "SurveyInvitations" ], "summary": "Get By Id", "description": "Get a single invitation by its id", "parameters": [ { "name": "surveyId", "in": "path", "description": "The survey id whose Invitation you are querying", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "invitationId", "in": "path", "description": "The invitation id that you are querying", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/SmartSurvey.Public.API.Models.ContactList.MailListUseResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/SmartSurvey.Public.API.Models.ContactList.MailListUseResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SmartSurvey.Public.API.Models.ContactList.MailListUseResponse" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/SmartSurvey.Public.API.Models.ContactList.MailListUseResponse" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/SmartSurvey.Public.API.Models.ContactList.MailListUseResponse" } } } }, "403": { "description": "Forbidden", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "404": { "description": "Survey or Invitation not found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } } } } } }, "components": { "schemas": { "Microsoft.AspNetCore.Mvc.ProblemDetails": { "type": "object", "properties": { "type": { "type": "string", "description": "A URI reference [RFC3986] that identifies the problem type. This specification encourages that, when\r\ndereferenced, it provide human-readable documentation for the problem type\r\n(e.g., using HTML [W3C.REC-html5-20141028]). When this member is not present, its value is assumed to be\r\n\"about:blank\".", "nullable": true }, "title": { "type": "string", "description": "A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence\r\nof the problem, except for purposes of localization(e.g., using proactive content negotiation;\r\nsee[RFC7231], Section 3.4).", "nullable": true }, "status": { "type": "integer", "description": "The HTTP status code([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.", "format": "int32", "nullable": true }, "detail": { "type": "string", "description": "A human-readable explanation specific to this occurrence of the problem.", "nullable": true }, "instance": { "type": "string", "description": "A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.", "nullable": true } }, "additionalProperties": {}, "description": "A machine-readable format for specifying errors in HTTP API responses based on ." }, "SmartSurvey.Public.API.Models.ContactList.MailListUseResponse": { "type": "object", "properties": { "id": { "type": "integer", "description": "The unique id for this invitation", "format": "int32" }, "href": { "type": "string", "description": "A Hyperlink pointing to the API endpoint for this invitation", "nullable": true }, "date_created": { "type": "string", "description": "The date this invitation was created in UTC", "format": "date-time" }, "date_sent": { "type": "string", "description": "The date this invitation was last sent (in UTC) or the created date if not yet sent", "format": "date-time", "nullable": true }, "contact_list_id": { "type": "integer", "description": "The id of the Contact List that this invitation was sent to", "format": "int32" }, "link_id": { "type": "integer", "description": "The id of the tracking link that was sent in this invitation", "format": "int32" }, "type": { "type": "string", "description": "The type of invitation, either email or sms", "nullable": true }, "status": { "type": "string", "description": "The status of this invitation (draft,scheduled,sending or sent)", "nullable": true, "readOnly": true }, "message_subject": { "type": "string", "description": "The subject of the invitation email", "nullable": true }, "message_body": { "type": "string", "description": "The body of the invitation", "nullable": true }, "message_sender": { "type": "string", "description": "The email that the invitation was sent from", "nullable": true }, "message_sender_name": { "type": "string", "description": "The name of the sender", "nullable": true }, "contact_count": { "type": "integer", "description": "The number of contacts that this invitation was sent to", "format": "int32" }, "continuous_sending": { "type": "boolean", "description": "Whether this invitation is driven by continuous API sending (created ready to send,\r\ncontacts are added and sent one by one through the send endpoints, no reminders)" } }, "additionalProperties": false, "description": "A DTO for an invitation response" } }, "securitySchemes": { "Basic": { "type": "http", "description": "Basic Authorization", "scheme": "basic" } } }, "security": [ { "Basic": [] } ] } ```