--- updatedAt: 2026-06-04T19:57:42.000Z agentTools: projectIndex: https://docs.wristband.dev/llms.txt --- # Query Existing User Invitation Requests Filtered By User This API allows for querying existing user invitation requests scoped to a given user. ### Query Filter Attributes | Name | Type | Case Sensitive | Supported Comparison Operators | | -------- | ------ | -------------- | ------------------------------ | | `status` | String | No | eq, ne, in, nin | ### Sort Attributes * `status` ### Required Permissions Below is the list of required permissions needed to interact with this API. For each permission the allowed permission boundaries are also specified. | Permission | Boundary | Description | | ----------------------------------------- | --------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | **existing-user-invitation-request:read** | Application | The subject can perform this query if the user specified in the URL path is associated with the subject's application. | | | Tenant | The subject can perform this query if the user specified in the URL path belongs to the subject's associated tenant. | | | Tenant Inclusion List | The subject can perform this query if the user specified in the URL path belongs to a tenant included in the tenant inclusion list. | | | Tenant Exclusion List | The subject can perform this query if the user specified in the URL path belongs to the subject's associated application but is not associated with a tenant in the tenant exclusion list. |
# OpenAPI definition ```json { "openapi": "3.1.0", "info": { "title": "Workflow APIs", "version": "1.0.0", "description": "Workflow APIs", "license": { "name": "Private", "url": "https://wristband.dev/terms/" }, "termsOfService": "https://wristband.dev/terms/", "contact": { "name": "Wristband Support", "email": "support@wristband.dev", "url": "https://wristband.dev/contact/" } }, "servers": [ { "url": "https://{application_vanity_domain}", "description": "Wristband application scoped URL.", "variables": { "application_vanity_domain": { "default": "yourapp-yourorg.us.wristband.dev", "description": "Wristband vanity domain scoped to a specific application." } } } ], "tags": [ { "name": "Existing User Invitation", "description": "Existing User Invitation", "x-displayName": "Existing User Invitation" } ], "paths": { "/api/v1/users/{userId}/existing-user-invitation-requests": { "parameters": [ { "$ref": "#/components/parameters/Workflow_APIs_UserId" } ], "get": { "summary": "Query Existing User Invitation Requests Filtered By User", "operationId": "queryExistingUserInvitationRequestsFilteredByUserV1", "tags": [ "Existing User Invitation" ], "security": [ { "Workflow_APIs_BearerAuth": [] } ], "parameters": [ { "$ref": "#/components/parameters/Workflow_APIs_Query" }, { "$ref": "#/components/parameters/Workflow_APIs_SortBy" }, { "$ref": "#/components/parameters/Workflow_APIs_StartIndex" }, { "$ref": "#/components/parameters/Workflow_APIs_Count" }, { "$ref": "#/components/parameters/Workflow_APIs_Fields" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Workflow_APIs_ExistingUserInvitationRequestOffsetPaginatedResults" }, "examples": { "Example 1": { "$ref": "#/components/examples/Workflow_APIs_ExistingUserInvitationRequestOffsetPaginatedResults" } } } } }, "400": { "$ref": "#/components/responses/Workflow_APIs_400-default" }, "401": { "$ref": "#/components/responses/Workflow_APIs_401" }, "403": { "$ref": "#/components/responses/Workflow_APIs_403" }, "404": { "$ref": "#/components/responses/Workflow_APIs_404-user-not-found" }, "405": { "$ref": "#/components/responses/Workflow_APIs_405" }, "406": { "$ref": "#/components/responses/Workflow_APIs_406" }, "500": { "$ref": "#/components/responses/Workflow_APIs_500" }, "503": { "$ref": "#/components/responses/Workflow_APIs_503" } } } } }, "components": { "securitySchemes": { "Workflow_APIs_BearerAuth": { "type": "http", "scheme": "bearer", "bearerFormat": "JWT" } }, "parameters": { "Workflow_APIs_Fields": { "name": "fields", "in": "query", "required": false, "schema": { "type": "string", "default": "*", "example": "field1,field2", "minLength": 0 }, "description": "List of resource fields that should be returned in a response. The wildcard value of `*` can be used to return all fields for the resource.", "style": "form" }, "Workflow_APIs_UserId": { "name": "userId", "description": "The ID of the user that the resource or action is scoped to.", "in": "path", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 26, "example": "fjffnbwairfhzkakzjtemooh7e" } }, "Workflow_APIs_Query": { "name": "query", "in": "query", "required": false, "schema": { "type": "string", "default": "\"\"", "example": "foo eq 'bar'", "minLength": 0 }, "description": "Query expression used to filter returned results in a query API call." }, "Workflow_APIs_SortBy": { "name": "sort_by", "in": "query", "required": false, "schema": { "type": "string", "example": "foo:desc,bar:asc" }, "description": "List of attributes that the results of a query should be sorted by along with their corresponding sort orders. The items that occur earlier in the list will have higher sorting precedence than those that occur later in the list." }, "Workflow_APIs_StartIndex": { "name": "start_index", "in": "query", "required": false, "schema": { "type": "number", "default": 1, "example": 1, "minimum": 1 }, "description": "A 1-based index indicating the position of the first item that should be returned in the query response." }, "Workflow_APIs_Count": { "name": "count", "in": "query", "required": false, "schema": { "type": "number", "minimum": 0, "default": 20, "example": 20 }, "description": "The maximum number of results that can be returned in a query response. If the value is set to 0 then the items array in the response will be empty; however the total results will still be set so you can see how many items this query matched." } }, "responses": { "Workflow_APIs_401": { "description": "Unauthorized", "headers": { "WWW-Authenticate": { "description": "Includes details on the failed authentication condition. This header is set in accordance with the [OAuth2 specification](https://datatracker.ietf.org/doc/html/rfc6750#section-3).", "schema": { "type": "string", "example": "Bearer error=\"invalid_token\", error_description=\"The provided access token was invalid\"" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Workflow_APIs_api-error" }, "examples": { "code - unauthenticated": { "value": { "type": "base_error", "code": "invalid_access_token", "message": "The provided access token was invalid", "ticket": "1u0d0edhwbjsd" } } } } } }, "Workflow_APIs_403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Workflow_APIs_api-error" }, "examples": { "code - unauthorized": { "value": { "type": "base_error", "code": "unauthorized", "message": "The request failed authorization", "ticket": "11t7n71hi5e6t" } } } } } }, "Workflow_APIs_405": { "description": "Method Not Allowed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Workflow_APIs_api-error" }, "examples": { "code - method_not_supported": { "value": { "type": "base_error", "code": "method_not_supported", "message": "The specified HTTP method is not supported", "ticket": "11t7n71hi5e6t" } } } } } }, "Workflow_APIs_406": { "description": "Not Acceptable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Workflow_APIs_api-error" }, "examples": { "code - not_acceptable": { "value": { "type": "base_error", "code": "not_acceptable", "message": "The Accept header was invalid", "ticket": "11t7n71hi5e6t" } } } } } }, "Workflow_APIs_500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Workflow_APIs_api-error" }, "examples": { "code - internal_server_failure ": { "value": { "type": "base_error", "code": "internal_server_failure", "message": "An unexpected error occurred while processing the request", "ticket": "11t7n71hi5e6t" } } } } } }, "Workflow_APIs_503": { "description": "Service Unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Workflow_APIs_api-error" }, "examples": { "code - service_unavailable": { "value": { "type": "base_error", "code": "service_unavailable", "message": "The service is currently unavailable", "ticket": "11t7n71hi5e6t" } } } } } }, "Workflow_APIs_400-default": { "description": "Bad Request", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Workflow_APIs_api-error" }, { "$ref": "#/components/schemas/Workflow_APIs_constraint-violations-api-error" } ] }, "examples": { "code - invalid_request": { "value": { "type": "base_error", "code": "invalid_request", "message": "The request was invalid", "ticket": "11t7n71hi5e6t" } }, "code - request_constraint_violations": { "value": { "type": "constraint_violations_error", "code": "message_body_constraint_violations", "message": "The message body contained invalid fields", "ticket": "11t7n71hi5e6t", "violations": { "field1": { "code": "too_long", "constraintAttributes": { "maxLength": 10 } }, "field2": { "code": "not_null" } } } } } } } }, "Workflow_APIs_404-user-not-found": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Workflow_APIs_api-error" }, "examples": { "code - user_not_found": { "value": { "type": "base_error", "code": "user_not_found", "message": "User could not be found", "ticket": "11t7n71hi5e6t" } } } } } } }, "schemas": { "Workflow_APIs_version-metadata": { "title": "VersionMetadata", "type": "object", "description": "Version metadata associated to a resource.", "properties": { "version": { "type": "string", "example": "1.0", "description": "The version of the resource", "readOnly": true }, "lastModifiedTime": { "type": "string", "format": "date-time", "example": "2016-06-13T19:49:31.686Z", "description": "The time at which the resource was last modified", "readOnly": true }, "creationTime": { "type": "string", "format": "date-time", "example": "2016-06-13T19:49:31.686Z", "description": "The time at which the resource was created", "readOnly": true } } }, "Workflow_APIs_workflow-request": { "title": "WorkflowRequest", "type": "object", "description": "An object containing common fields shared amongst all types of workflow request objects.", "properties": { "id": { "description": "Unique, immutable ID of the workflow request.", "type": "string", "readOnly": true, "minLength": 1, "maxLength": 26, "example": "imypz2gzzvbsbfdepwyqprenke" }, "expirationTime": { "description": "Time at which the request will expire.", "type": "string", "format": "date-time", "readOnly": true, "example": "2021-07-13T19:49:31.686Z" }, "metadata": { "$ref": "#/components/schemas/Workflow_APIs_version-metadata" } }, "x-examples": { "Example 1": { "value": { "id": "imypz2gzzvbsbfdepwyqprenke", "expirationTime": "2021-07-13T19:49:31.686Z", "metadata": { "version": "1.0", "lastModifiedTime": "2021-06-13T19:49:31.686Z", "creationTime": "2021-06-13T19:49:31.686Z" } } } } }, "Workflow_APIs_api-error": { "title": "ApiError", "type": "object", "description": "API error object", "x-examples": { "Example 1": { "code": "invalid_request", "message": "The request was invalid", "ticket": "11t7n71hi5e6t" } }, "properties": { "type": { "type": "string", "example": "base_error", "minLength": 1, "description": "The type of the API error.", "readOnly": true }, "code": { "type": "string", "example": "invalid_request", "minLength": 1, "description": "A code identifying the error that occurred.", "readOnly": true }, "message": { "type": "string", "example": "The request was invalid", "description": "A free text message describing the error. This error message is only meant to help developers understand the cause of the error. It should not be used for programmatic purposes.", "readOnly": true }, "ticket": { "type": "string", "example": "11t7n71hi5e6t", "description": "Ticket that can help correlate the error to the backend", "readOnly": true }, "details": { "type": "object", "description": "A map of details about the error. The keys are defined by the API.", "additionalProperties": {}, "example": { "attemptsRemaining": 4 } } }, "required": [ "type", "code" ] }, "Workflow_APIs_constraint-violations-api-error": { "title": "ConstraintViolationsApiError", "description": "An API error that occurred due to a constraint violation", "allOf": [ { "$ref": "#/components/schemas/Workflow_APIs_api-error" }, { "type": "object", "readOnly": true, "required": [ "violations" ], "properties": { "violations": { "type": "object", "readOnly": true, "required": [ "code" ], "properties": { "code": { "type": "string", "description": "A code identifying the constraint violation.", "minLength": 1, "example": "too_long" }, "constraintAttributes": { "type": "object", "description": "A map of constraint attribute values.", "additionalProperties": { "type": "string" }, "example": { "maxLength": "10" } } } } } } ], "x-examples": { "Example 1": { "type": "constraint_violations_error", "code": "message_body_constraint_violations", "message": "The request contained invalid fields", "ticket": "11t7n71hi5e6t", "violations": { "field1": { "code": "too_long", "constraintAttributes": { "maxLength": "10" } }, "field2": { "code": "not_null" } } } } }, "Workflow_APIs_offset-paginated-results": { "title": "OffsetPaginatedResults", "type": "object", "description": "Offset paginated results returned from a query API call.", "x-examples": { "Example 1": { "totalResults": 200, "startIndex": 1, "itemsPerPage": 10 } }, "properties": { "totalResults": { "type": "integer", "format": "int64", "example": 200, "minimum": 0, "description": "The total number of results that satisfied the query expression.", "readOnly": true }, "startIndex": { "type": "integer", "format": "int32", "example": 1, "minimum": 1, "description": "A 1-based index representing the position of the first result in the returned query response.", "readOnly": true }, "itemsPerPage": { "type": "integer", "format": "int32", "example": 10, "minimum": 0, "description": "The number of results returned in a page.", "readOnly": true } }, "required": [ "totalResults", "startIndex", "itemsPerPage" ] }, "Workflow_APIs_ExistingUserInvitationRequest": { "title": "Existing User Invitation Request", "description": "Object representing an existing user invitation request.", "type": "object", "x-tags": [ "Models" ], "allOf": [ { "$ref": "#/components/schemas/Workflow_APIs_workflow-request" }, { "type": "object", "properties": { "status": { "description": "Enum representing the status of the existing user invitation request.\n\n**Supported Status:**\n- `PENDING_INVITE_ACCEPTANCE`: The invitation is awaiting acceptance.\n- `PENDING_SESSION_CREATION`: The invitation has been accepted and a session can now be created for the invited user.\n- `CANCELED`: The invitation request has been cancelled.\n- `COMPLETED`: The invitation request has completed.", "type": "string", "readOnly": true, "enum": [ "PENDING_INVITE_ACCEPTANCE", "PENDING_SESSION_CREATION", "CANCELED", "COMPLETED" ], "minLength": 1, "maxLength": 60, "example": "PENDING_INVITE_ACCEPTANCE" }, "userId": { "description": "ID of the user that is being invited.", "type": "string", "readOnly": true, "minLength": 1, "maxLength": 26, "example": "x25rpgafgvgedcvjw52ooul3xm" }, "tenantId": { "description": "The ID of the tenant associated to the request.", "type": "string", "readOnly": true, "minLength": 1, "maxLength": 26, "example": "lu4a47jcm2ejayovsgbgbpkihb" }, "applicationId": { "description": "The ID of the application associated to the request.", "type": "string", "readOnly": true, "minLength": 1, "maxLength": 26, "example": "wlmx73uqlzuujghvfunxy6kez4" }, "email": { "description": "The email that the invitation was sent to.", "type": "string", "format": "email", "readOnly": true, "minLength": 1, "maxLength": 200, "example": "bob.smith@example.com" } } } ], "example": { "id": "imypz2gzzvbsbfdepwyqprenke", "expirationTime": "2021-07-13T19:49:31.686Z", "status": "PENDING_INVITE_ACCEPTANCE", "userId": "x25rpgafgvgedcvjw52ooul3xm", "tenantId": "lu4a47jcm2ejayovsgbgbpkihb", "applicationId": "wlmx73uqlzuujghvfunxy6kez4", "email": "bob.smith@example.com", "metadata": { "version": "1.0", "lastModifiedTime": "2021-06-13T19:49:31.686Z", "creationTime": "2021-06-13T19:49:31.686Z" } } }, "Workflow_APIs_ExistingUserInvitationRequestOffsetPaginatedResults": { "title": "Existing User Invitation Request Offset Paginated Results", "description": "Offset paginated existing user invitation requests.", "x-tags": [ "Models" ], "allOf": [ { "$ref": "#/components/schemas/Workflow_APIs_offset-paginated-results" }, { "type": "object", "description": "Existing User Invitation Request Offset Paginated Results", "properties": { "items": { "type": "array", "description": "Array of users that satisfied the query criteria", "uniqueItems": true, "readOnly": true, "items": { "$ref": "#/components/schemas/Workflow_APIs_ExistingUserInvitationRequest" } } }, "required": [ "items" ] } ], "example": { "totalResults": 200, "startIndex": 1, "itemsPerPage": 10, "items": [ { "id": "imypz2gzzvbsbfdepwyqprenke", "expirationTime": "2021-07-13T19:49:31.686Z", "status": "PENDING_INVITE_ACCEPTANCE", "userId": "x25rpgafgvgedcvjw52ooul3xm", "tenantId": "lu4a47jcm2ejayovsgbgbpkihb", "applicationId": "wlmx73uqlzuujghvfunxy6kez4", "email": "bob.smith@example.com", "metadata": { "version": "1.0", "lastModifiedTime": "2021-06-13T19:49:31.686Z", "creationTime": "2021-06-13T19:49:31.686Z" } } ] } } }, "examples": { "Workflow_APIs_ExistingUserInvitationRequestOffsetPaginatedResults": { "description": "Existing User Invitation Request Offset Paginated Results JSON object.", "value": { "totalResults": 200, "startIndex": 1, "itemsPerPage": 10, "items": [ { "id": "imypz2gzzvbsbfdepwyqprenke", "expirationTime": "2021-07-13T19:49:31.686Z", "status": "PENDING_INVITE_ACCEPTANCE", "userId": "x25rpgafgvgedcvjw52ooul3xm", "tenantId": "lu4a47jcm2ejayovsgbgbpkihb", "applicationId": "wlmx73uqlzuujghvfunxy6kez4", "email": "bob.smith@example.com", "metadata": { "version": "1.0", "lastModifiedTime": "2021-06-13T19:49:31.686Z", "creationTime": "2021-06-13T19:49:31.686Z" } } ] } } } }, "x-tagGroups": [ { "name": "Workflow APIs", "tags": [ "Change Email", "Change Password", "Email Verification", "Existing User Invitation", "Login", "MFA Challenge", "Workflow APIs", "Workflow Request Object APIs", "MFA Enrollment", "New User Invitation", "Password Reset", "Signup", "Tenant Discovery", "User Activation" ] } ] } ```