{"info":{"_postman_id":"53646fe7-333c-4bb2-a8c9-dc37939f3949","name":"Sweap Core API","description":"

Endpoints

API Base URL: https://api.sweap.io/core/v1

API Version: 1.5.4

Available endpoints are:

/events
\n
/event-statistics
\n
/guests
\n
/categories
\n
/guest-bulk-imports
\n
/checkins
\n
/visibility-groups
\n
/event-tags
\n
/recipients
\n
/contacts (BETA)
\n
/registration-pages (restricted)
\n
/management
\n

OpenAPI Specification

An OpenAPI specification (OAS) is available at this URL: https://api.sweap.io/openapi/api-docs/core
It can be used to generate an API client as described here.

API Updates

News and updates about API changes are published on our Postman page:

Sweap Postman Workspace
API Updates Feed

Versioning

All API requests should include the X-API-Version HTTP header with the current version that the client is using to make the request. The server will also return the version that it is using as the X-API-Version header.

The current API version is 1.5.4

If the client does not send an X-API-Version header, it is assumed that the latest version is being used.
For future releases, this header will provide backward compatibility for a period of time in case of breaking changes.

Date Format

All timestamps are in ISO 8601 format with UTC / Zulu Time Zone (Z): yyyy-MM-dd'T'HH:mm:ss.SSSZ, for example 2021-09-27T09:52:02.752Z.

Error Handling

In case of an error, instead of returning the resource, the API will return an error resource instead. Every error response also includes a requestId (and the X-Request-Id header) so you can share it with Sweap Support while the human-readable message stays generic.

Example:

{\n  \"code\": 4090,\n  \"error\": \"Stale Resource\",\n  \"message\": \"submitted version 8, but latest version is 9\",\n  \"requestId\": \"c93b0a74-6c5c-4e2e-b3d1-7d8e3d7b01d4\"\n}\n

In this case 4090 doesn't encode more information than plain 409, but in the future there might be a 4091, so this lays the groundwork for it. Please read the next chapter for clarification.

Extended Error Codes

In addition to the default HTTP status codes in certain scenarios, the API will return additional error codes that extend the 3 digit HTTP status code with an additional digit to offer more specific details.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Code	Error	Description
`4000`	Missing Property	Like HTTP 400, specifically when required property is not set (currently only when `version` not set on a PUT, see section Updating Resources)
`4001`	Invalid Property	A key in the request JSON is invalid. E.g. reference to a non existing id.
`4002`	Parent Resource Not Existing	The parent resource doesn't exist. E.g. when a guest's parent event was deleted and `eventId` doesn't exist any longer.
`4003`	Referential Integrity Violation	The resource cannot be deleted as it is still being required by another resource.
`4020`	Insufficient Registration Quota	You have exceeded your registration quota for your Sweap subscription. You must increase your quota before setting an event to ACTIVE. See here for more information: https://www.sweap.io/en/registration-quota
`4031`	Access Denied Missing Permission	The JWT is missing the required role to access this resource, e.g. events_read.
`4040`	Resource Not Found	The resource was not found, e.g. a GET with a wrong id or resource has been deleted.
`4090`	Stale Resource	The server resource already has a higher `version` when trying to update a resource via PUT. This prevents version conflicts, see section Updating Resources.
`5000`	Unknown	Unknown server error which usually should not happen and hints, that something might be broken for the API.

CRUD Requests Overview

Retrieving Resources

A GET request to a resource without an id will return an array of objects.\nThe following example returns all event objects that are assigned to the client making the request. All lists are paginated and return as maximum 1.000 elements:

curl --include --request GET \\\n--url \"https://api.sweap.io/core/v1/events\" \\\n--header \"X-API-Version: 1.5.4\"\n

A specific resource is requested by appending an index to the path, as shown by this example:

curl --include --request GET \\\n--url \"https://api.sweap.io/core/v1/events/a7feb533-b859-43d9-acfc-49b68de5f896\" \\\n--header \"X-API-Version: 1.5.4\"\n

Additionally, by passing the query parameter updatedAfter=, only the resources that were changed after that timestamp will be returned. This allows for incremental updates.

Pagination

All list and paginated endpoints offer and require pagination via page, size, sortBy and sortOrder parameters.

page = page number (default value = 0)
\n
size = number of results on a page (default value = 100, min = 1, max = 1000)
\n
sortBy = sorting the list by a resource variable (default value = createdAt)
\n
sortOrder = sorting order either DESC (descending) or ASC (ascending) (default value = DESC)
\n

When a response is paginated, the response headers will include a link header. If all results fit on a single page, the link header will be omitted.

The link header contains URLs that you can use to fetch additional pages of results. For example, the previous, next, first, and last page of results.

If the response is paginated, the link header will look something like this:

link: <https://api.sweap.io/core/v1/events?page=4&size=10>; rel=\"next\", \n      <https://api.sweap.io/core/v1/events?page=2&size=10>; rel=\"prev\", \n      <https://api.sweap.io/core/v1/events?page=0&size=10>; rel=\"first\",\n      <https://api.sweap.io/core/v1/events?page=50&size=10>; rel=\"last\"\n

The link header provides the URL for the previous, next, first, and last page of results:

The URL for the previous page is followed by rel=\"prev\".
\n
The URL for the next page is followed by rel=\"next\".
\n
The URL for the last page is followed by rel=\"last\".
\n
The URL for the first page is followed by rel=\"first\".
\n

In some cases, only a subset of these links are available. For example, the link to the previous page won't be included if you are on the first page of results, and the link to the last page won't be included if it can't be calculated.

You can use the URLs from the link header to request another page of results. For example, to request the last page of results based on the previous example:

curl --include --request GET \\\n--url \"https://api.sweap.io/core/v1/events?page=50&size=10\" \\\n--header \"X-API-Version: 1.5.4\"\n

The URLs in the link header use query parameters to indicate which page of results to return and include the page and size query parameters.

Creating Resources

A POST request to a resource with an accompanying JSON body will create a new object. The API will return the newly created object with its unique ID.

Additionally, timestamps like createdAt and updatedAt timestamps will be managed by the API. All timestamps are in ISO 8601 format: yyyy-MM-dd'T'HH:mm:ss.SSSZ.

Updating Resources

A PUT request to a specific resource with an accompanying JSON body will update the object and automatically increment the version field, as well as refresh updatedAt.

IMPORTANT: the JSON body of the object must contain the current version tag for the purpose of Optimistic Locking. If you pass an outdated version tag the API will return a 409 error.

Deleting Resources

A DELETE request to a specific resource will delete an object. If the delete request was successful the API will return with a status code of 200.

Common Fields On All Resources

All resources are transmitted in JSON format. Every resource comes with a set of common fields and resource specific fields.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field Name	Type	Access	Description
`id`	`String` (UUID)	read-only	unique identifier assigned by the API
`version`	`Number` (Integer)	read-only	current version number for Optimistic Locking
`updatedAt`	`String`	read-only	ISO 8601 timestamp of last change
`createdAt`	`String`	read-only	ISO 8601 timestamp of creation
`externalId`	`String` (max 255)	read-write	used to reference IDs in externally systems. Free to choose and not unique in the system.

Authentication

The API uses OAuth 2.0 with a client credentials flow (as described by auth0).

You don't need to request scopes. This flow is best suited for machine-to-machine (M2M) applications, \nsuch as CLIs, daemons, or backend services, because the system needs to authenticate \nand authorize the application instead of a user.

The lifetime of the JWT access token is 60 minutes. After that, \nyou must re-request a new token using the client credentials flow \nwith client_id and client_secret and grant_type=client_credentials. \nThe client credentials flow does not include a refresh token (as required \nby the specification).

The JWT defines which resources the application can access. \nYou can find the resource access in the JWT claim resource_access in the core-api roles array. \nEach endpoint usually has an readand a write role. The admin role contains all other roles.\nThese roles are defined in the Sweap application for each API client.\nCurrently, these roles are supported:

events_read
\n
events_write
\n
categories_read
\n
guests_read
\n
guests_write
\n
guest_bulk_imports_read
\n
guest_bulk_imports_write
\n
contacts_read
\n
contacts_write
\n
event_statistics_read
\n
checkins_read
\n
checkins_write
\n
visibility_groups_read
\n
event_tags_read
\n
recipients_read
\n
registration_pages_read
\n
deleted_resources_read
\n

Restricted Access by License

The following roles are restricted and are not included in the default API licenses:

deleted_resources_read
registration_pages_read
checkins_write

⚠️ Please contact the Sweap Support team at support@sweap.io to request access.

Example

Here is an example of how to request an access token:

curl --location 'https://auth.sweap.io/realms/users/protocol/openid-connect/token' \\\n--header 'Content-Type: application/x-www-form-urlencoded' \\\n--data-urlencode 'client_id=<Ask Sweap to get a value>' \\\n--data-urlencode 'client_secret=<Ask Sweap to get a value>' \\\n--data-urlencode 'grant_type=client_credentials'\n

Additional Resources

Contact Support:\n Name: support@sweap.io\n Email: support@sweap.io

\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"2047","collectionId":"53646fe7-333c-4bb2-a8c9-dc37939f3949","publishedId":"2sB34imLSH","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"339cc2"},"publishDate":"2025-07-17T20:47:31.000Z"},"item":[{"name":"Events","item":[{"name":"Get an event by ID","id":"b65d8638-fb4e-4d77-8059-080bddbb09d2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"description":"

(Required) API version the client uses. Current server API version: 1.5.4 (This can only be one of 1.5.4)

\n","key":"X-API-Version","value":"1.5.4"},{"key":"Accept","value":"application/json"}],"url":"https://api.sweap.io/core/v1/events/:id","description":"

Get the event with the specified ID

(Required) ID (UUID) of the event

\n","type":"text/plain"},"type":"any","value":"123e4567-e89b-12d3-a456-426655440000","key":"id"}]}},"response":[{"id":"bd704ac9-cc0e-4e51-9653-adbc88e94106","name":"Events information retrieved successfully","originalRequest":{"method":"GET","header":[{"description":"(Required) API version the client uses. Current server API version: 1.5.4 (This can only be one of 1.5.4)","key":"X-API-Version","value":"1.5.4"},{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"url":{"raw":"https://api.sweap.io/core/v1/events/:id","host":["https://api.sweap.io"],"path":["core","v1","events",":id"],"variable":[{"key":"id","value":"123e4567-e89b-12d3-a456-426655440000","description":"(Required) ID (UUID) of the event"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"384e4567-e89b-12d3-a456-426655440000\",\n \"externalId\": \"abc-1234\",\n \"version\": 1,\n \"createdAt\": \"2025-01-27T09:52:02.752Z\",\n \"updatedAt\": \"2025-01-27T10:11:00.000Z\",\n \"name\": \"My Event\",\n \"startDate\": \"2025-01-27T09:30:00.000Z\",\n \"endDate\": \"2025-01-27T17:00:00.000Z\",\n \"zoneId\": \"Europe/Berlin\",\n \"state\": \"ACTIVE\",\n \"attendanceMode\": \"OFFLINE\",\n \"customFieldDefinitions\": [\n {\n \"id\": \"1af120418d6b431b801e93bcfff840c0\",\n \"name\": \"Text value\",\n \"sortIndex\": 0,\n \"type\": \"TEXT\",\n \"groupName\": \"Personal information\",\n \"options\": {\n \"values\": [\n {\n \"value\": \"S\",\n \"limit\": 25\n },\n {\n \"value\": \"M\",\n \"limit\": 100\n }\n ],\n \"globalLimit\": 50\n }\n },\n {\n \"id\": \"1af120418d6b431b801e93bcfff840c0\",\n \"name\": \"Text value\",\n \"sortIndex\": 0,\n \"type\": \"TEXT\",\n \"groupName\": \"Personal information\",\n \"options\": {\n \"values\": [\n {\n \"value\": \"S\",\n \"limit\": 25\n },\n {\n \"value\": \"M\",\n \"limit\": 100\n }\n ],\n \"globalLimit\": 50\n }\n }\n ],\n \"location\": {\n \"latitude\": 4113.309055519168,\n \"longitude\": 4955.809885483369,\n \"textRepresentation\": \"Sweap Office\",\n \"formattedAddress\": \"Rankestraße 9, 10789 Berlin, Germany\"\n },\n \"visibilityGroupIds\": [\n \"string\"\n ],\n \"eventTagIds\": [\n \"string\"\n ]\n}"},{"id":"fbae33a2-db9a-4ced-afb0-9ffe89ee777b","name":"Bad Request","originalRequest":{"method":"GET","header":[{"description":"(Required) API version the client uses. Current server API version: 1.5.4 (This can only be one of 1.5.4)","key":"X-API-Version","value":"1.5.4"},{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"url":{"raw":"https://api.sweap.io/core/v1/events/:id","host":["https://api.sweap.io"],"path":["core","v1","events",":id"],"variable":[{"key":"id","value":"123e4567-e89b-12d3-a456-426655440000","description":"(Required) ID (UUID) of the event"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"error\": \"Bad Request\",\n \"code\": 4000,\n \"message\": \"These request parameters are not valid (please check their data type, value syntax and if they are required): size=1001 (PageSizeConstraint)\",\n \"requestId\": \"84e2cec6-706c-4060-855c-37b2f2e2b0b5\"\n}\n"},{"id":"108ea76a-6cde-4ef9-872e-fa0b0b82dfda","name":"Forbidden","originalRequest":{"method":"GET","header":[{"description":"(Required) API version the client uses. Current server API version: 1.5.4 (This can only be one of 1.5.4)","key":"X-API-Version","value":"1.5.4"},{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"url":{"raw":"https://api.sweap.io/core/v1/events/:id","host":["https://api.sweap.io"],"path":["core","v1","events",":id"],"variable":[{"key":"id","value":"123e4567-e89b-12d3-a456-426655440000","description":"(Required) ID (UUID) of the event"}]}},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"error\": \"Access Denied Missing Permission\",\n \"code\": 4031,\n \"message\": \"Missing security to access this resource.\",\n \"requestId\": \"abca3c4c-4fd5-45da-8bec-637a9bc62222\"\n}\n"},{"id":"2ccbe374-65cd-4efe-a33f-123d2fab69aa","name":"Not Found","originalRequest":{"method":"GET","header":[{"description":"(Required) API version the client uses. Current server API version: 1.5.4 (This can only be one of 1.5.4)","key":"X-API-Version","value":"1.5.4"},{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"url":{"raw":"https://api.sweap.io/core/v1/events/:id","host":["https://api.sweap.io"],"path":["core","v1","events",":id"],"variable":[{"key":"id","value":"123e4567-e89b-12d3-a456-426655440000","description":"(Required) ID (UUID) of the event"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"error\": \"Resource Not Found\",\n \"code\": 4040,\n \"message\": \"No [resource name] resource with id 123e4567-e89b-12d3-a456-426655440000 found.\",\n \"requestId\": \"08ed380a-2c42-447a-abcb-22cb872da017\"\n}\n"},{"id":"7b96cb41-d43d-4581-91fe-3500eb4744ea","name":"Internal Server Error","originalRequest":{"method":"GET","header":[{"description":"(Required) API version the client uses. Current server API version: 1.5.4 (This can only be one of 1.5.4)","key":"X-API-Version","value":"1.5.4"},{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"url":{"raw":"https://api.sweap.io/core/v1/events/:id","host":["https://api.sweap.io"],"path":["core","v1","events",":id"],"variable":[{"key":"id","value":"123e4567-e89b-12d3-a456-426655440000","description":"(Required) ID (UUID) of the event"}]}},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"error\": \"Internal Server Error\",\n \"code\": 5000,\n \"message\": \"An unexpected error occurred while processing the request.\",\n \"requestId\": \"696ef63e-12c5-4bb8-a3ca-3b555a7b50a2\"\n}\n"}],"_postman_id":"b65d8638-fb4e-4d77-8059-080bddbb09d2"},{"name":"Update the external ID of an event by ID","id":"04c4b1a0-4f3b-4d2f-9f3f-8bf4b1dc5b70","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PATCH","header":[{"description":"

(Required) API version the client uses. Current server API version: 1.5.4 (This can only be one of 1.5.4)

\n","key":"X-API-Version","value":"1.5.4"},{"key":"Content-Type","value":"application/merge-patch+json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"externalId\": \"abc-1234\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://api.sweap.io/core/v1/events/:id","description":"

Update the external ID of the event with the specified ID using the provided JSON merge patch event object containing the new external ID.

(Required) ID (UUID) of the event

\n","type":"text/plain"},"type":"any","value":"123e4567-e89b-12d3-a456-426655440000","key":"id"}]}},"response":[{"id":"f2308885-b897-4f77-8f3b-5f2fba41a6d5","name":"Event information updated successfully","originalRequest":{"method":"PATCH","header":[{"description":"(Required) API version the client uses. Current server API version: 1.5.4 (This can only be one of 1.5.4)","key":"X-API-Version","value":"1.5.4"},{"key":"Content-Type","value":"application/merge-patch+json"},{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"body":{"mode":"raw","raw":"{\n \"externalId\": \"abc-1234\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"https://api.sweap.io/core/v1/events/:id","host":["https://api.sweap.io"],"path":["core","v1","events",":id"],"variable":[{"key":"id","value":"123e4567-e89b-12d3-a456-426655440000","description":"(Required) ID (UUID) of the event"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"externalId\": \"abc-1234\"\n}"},{"id":"bb764180-dc7c-4f4f-97e7-0b78a57a9385","name":"Bad Request","originalRequest":{"method":"PATCH","header":[{"description":"(Required) API version the client uses. Current server API version: 1.5.4 (This can only be one of 1.5.4)","key":"X-API-Version","value":"1.5.4"},{"key":"Content-Type","value":"application/merge-patch+json"},{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"body":{"mode":"raw","raw":"{\n \"externalId\": \"abc-1234\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"https://api.sweap.io/core/v1/events/:id","host":["https://api.sweap.io"],"path":["core","v1","events",":id"],"variable":[{"key":"id","value":"123e4567-e89b-12d3-a456-426655440000","description":"(Required) ID (UUID) of the event"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"error\": \"Bad Request\",\n \"code\": 4000,\n \"message\": \"These request parameters are not valid (please check their data type, value syntax and if they are required): size=1001 (PageSizeConstraint)\",\n \"requestId\": \"84e2cec6-706c-4060-855c-37b2f2e2b0b5\"\n}\n"},{"id":"0dce6840-3b58-407d-ad11-a1d11e0c194f","name":"Forbidden","originalRequest":{"method":"PATCH","header":[{"description":"(Required) API version the client uses. Current server API version: 1.5.4 (This can only be one of 1.5.4)","key":"X-API-Version","value":"1.5.4"},{"key":"Content-Type","value":"application/merge-patch+json"},{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"body":{"mode":"raw","raw":"{\n \"externalId\": \"abc-1234\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"https://api.sweap.io/core/v1/events/:id","host":["https://api.sweap.io"],"path":["core","v1","events",":id"],"variable":[{"key":"id","value":"123e4567-e89b-12d3-a456-426655440000","description":"(Required) ID (UUID) of the event"}]}},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"error\": \"Access Denied Missing Permission\",\n \"code\": 4031,\n \"message\": \"Missing security to access this resource.\",\n \"requestId\": \"abca3c4c-4fd5-45da-8bec-637a9bc62222\"\n}\n"},{"id":"2ee382d9-e494-4746-955f-19034d323afe","name":"Internal Server Error","originalRequest":{"method":"PATCH","header":[{"description":"(Required) API version the client uses. Current server API version: 1.5.4 (This can only be one of 1.5.4)","key":"X-API-Version","value":"1.5.4"},{"key":"Content-Type","value":"application/merge-patch+json"},{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"body":{"mode":"raw","raw":"{\n \"externalId\": \"abc-1234\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"https://api.sweap.io/core/v1/events/:id","host":["https://api.sweap.io"],"path":["core","v1","events",":id"],"variable":[{"key":"id","value":"123e4567-e89b-12d3-a456-426655440000","description":"(Required) ID (UUID) of the event"}]}},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"error\": \"Internal Server Error\",\n \"code\": 5000,\n \"message\": \"An unexpected error occurred while processing the request.\",\n \"requestId\": \"696ef63e-12c5-4bb8-a3ca-3b555a7b50a2\"\n}\n"}],"_postman_id":"04c4b1a0-4f3b-4d2f-9f3f-8bf4b1dc5b70"},{"name":"Update the state of an event by ID","id":"b892b86e-746d-41ba-801c-c363a7fbe966","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PATCH","header":[{"description":"

(Required) API version the client uses. Current server API version: 1.5.4 (This can only be one of 1.5.4)

\n","key":"X-API-Version","value":"1.5.4"},{"key":"Content-Type","value":"application/merge-patch+json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"state\": \"ACTIVE\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://api.sweap.io/core/v1/events/:id/state","description":"

Update the state of the event with the specified ID using the provided JSON merge patch event object containing the new state.

(Required) ID (UUID) of the event

\n","type":"text/plain"},"type":"any","value":"123e4567-e89b-12d3-a456-426655440000","key":"id"}]}},"response":[{"id":"1c2c040c-493a-4c90-b111-d4d0f68e2201","name":"Event information updated successfully","originalRequest":{"method":"PATCH","header":[{"description":"(Required) API version the client uses. Current server API version: 1.5.4 (This can only be one of 1.5.4)","key":"X-API-Version","value":"1.5.4"},{"key":"Content-Type","value":"application/merge-patch+json"},{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"body":{"mode":"raw","raw":"{\n \"state\": \"ACTIVE\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"https://api.sweap.io/core/v1/events/:id/state","host":["https://api.sweap.io"],"path":["core","v1","events",":id","state"],"variable":[{"key":"id","value":"123e4567-e89b-12d3-a456-426655440000","description":"(Required) ID (UUID) of the event"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"state\": \"ACTIVE\"\n}"},{"id":"fa82f031-6153-4d81-9ffe-a1a30edbadb7","name":"Bad Request","originalRequest":{"method":"PATCH","header":[{"description":"(Required) API version the client uses. Current server API version: 1.5.4 (This can only be one of 1.5.4)","key":"X-API-Version","value":"1.5.4"},{"key":"Content-Type","value":"application/merge-patch+json"},{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"body":{"mode":"raw","raw":"{\n \"state\": \"ACTIVE\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"https://api.sweap.io/core/v1/events/:id/state","host":["https://api.sweap.io"],"path":["core","v1","events",":id","state"],"variable":[{"key":"id","value":"123e4567-e89b-12d3-a456-426655440000","description":"(Required) ID (UUID) of the event"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"error\": \"Bad Request\",\n \"code\": 4000,\n \"message\": \"These request parameters are not valid (please check their data type, value syntax and if they are required): size=1001 (PageSizeConstraint)\",\n \"requestId\": \"84e2cec6-706c-4060-855c-37b2f2e2b0b5\"\n}\n"},{"id":"c2bd5735-e975-4654-b2c7-de9861cb1a67","name":"Payment Required","originalRequest":{"method":"PATCH","header":[{"description":"(Required) API version the client uses. Current server API version: 1.5.4 (This can only be one of 1.5.4)","key":"X-API-Version","value":"1.5.4"},{"key":"Content-Type","value":"application/merge-patch+json"},{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"body":{"mode":"raw","raw":"{\n \"state\": \"ACTIVE\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"https://api.sweap.io/core/v1/events/:id/state","host":["https://api.sweap.io"],"path":["core","v1","events",":id","state"],"variable":[{"key":"id","value":"123e4567-e89b-12d3-a456-426655440000","description":"(Required) ID (UUID) of the event"}]}},"status":"Payment Required","code":402,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"error\": \"Insufficient Registration Quota\",\n \"code\": 4020,\n \"message\": \"You have exceeded your registration quota for your Sweap subscription. You must increase your quota before setting an event to ACTIVE. See here for more information: https://www.sweap.io/en/registration-quota.\",\n \"requestId\": \"17ab8fb3-52ad-42d4-a08e-f5623f215da6\"\n}\n"},{"id":"8287dcea-c884-4677-a3eb-1723a32ed719","name":"Forbidden","originalRequest":{"method":"PATCH","header":[{"description":"(Required) API version the client uses. Current server API version: 1.5.4 (This can only be one of 1.5.4)","key":"X-API-Version","value":"1.5.4"},{"key":"Content-Type","value":"application/merge-patch+json"},{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"body":{"mode":"raw","raw":"{\n \"state\": \"ACTIVE\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"https://api.sweap.io/core/v1/events/:id/state","host":["https://api.sweap.io"],"path":["core","v1","events",":id","state"],"variable":[{"key":"id","value":"123e4567-e89b-12d3-a456-426655440000","description":"(Required) ID (UUID) of the event"}]}},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"error\": \"Access Denied Missing Permission\",\n \"code\": 4031,\n \"message\": \"Missing security to access this resource.\",\n \"requestId\": \"abca3c4c-4fd5-45da-8bec-637a9bc62222\"\n}\n"},{"id":"75e9e9da-b23e-4413-8457-f6bce4245d11","name":"Internal Server Error","originalRequest":{"method":"PATCH","header":[{"description":"(Required) API version the client uses. Current server API version: 1.5.4 (This can only be one of 1.5.4)","key":"X-API-Version","value":"1.5.4"},{"key":"Content-Type","value":"application/merge-patch+json"},{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"body":{"mode":"raw","raw":"{\n \"state\": \"ACTIVE\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"https://api.sweap.io/core/v1/events/:id/state","host":["https://api.sweap.io"],"path":["core","v1","events",":id","state"],"variable":[{"key":"id","value":"123e4567-e89b-12d3-a456-426655440000","description":"(Required) ID (UUID) of the event"}]}},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"error\": \"Internal Server Error\",\n \"code\": 5000,\n \"message\": \"An unexpected error occurred while processing the request.\",\n \"requestId\": \"696ef63e-12c5-4bb8-a3ca-3b555a7b50a2\"\n}\n"}],"_postman_id":"b892b86e-746d-41ba-801c-c363a7fbe966"},{"name":"Get events as list","id":"336d11ea-fc7e-44ac-aa01-53aa2f3e48ff","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"description":"

(Required) API version the client uses. Current server API version: 1.5.4 (This can only be one of 1.5.4)

\n","key":"X-API-Version","value":"1.5.4"},{"key":"Accept","value":"application/json"}],"url":"https://api.sweap.io/core/v1/events","description":"

Get a paginated list of events based on the specified filters and sorting parameters

optional, filters case insensitive for exact event name

\n","type":"text/plain"},"key":"name","value":"My Event"},{"disabled":true,"description":{"content":"

optional, filters case insensitive for event name containing the value

\n","type":"text/plain"},"key":"nameContains","value":"event"},{"disabled":true,"description":{"content":"

optional, filters for exact match of one event state (This can only be one of DRAFT,ACTIVE,ARCHIVED)

\n","type":"text/plain"},"key":"state","value":"ACTIVE"},{"disabled":true,"description":{"content":"

optional, filters for startDateBefore equal or less than event startDate

\n","type":"text/plain"},"key":"startDateBefore","value":"2025-01-27T12:15:00.000Z"},{"disabled":true,"description":{"content":"

optional, filters for startDateAfter equal or greater than event startDate

\n","type":"text/plain"},"key":"startDateAfter","value":"2025-01-27T08:00:00.000Z"},{"disabled":true,"description":{"content":"

optional, filters for endDateBefore equal or less than event endDate

\n","type":"text/plain"},"key":"endDateBefore","value":"2025-01-27T20:00:00.000Z"},{"disabled":true,"description":{"content":"

optional, filters for endDateAfter equal or greater than event endDate

\n","type":"text/plain"},"key":"endDateAfter","value":"2025-01-27T16:35:00.000Z"},{"disabled":true,"description":{"content":"

optional, filters for exact match of one visibilityGroupId

\n","type":"text/plain"},"key":"visibilityGroupId","value":"5b05d452-9429-4ba1-a8ce-47dce840982"},{"disabled":true,"description":{"content":"

optional, filters for exact match of one eventTagId

\n","type":"text/plain"},"key":"eventTagId","value":"f4875291-eb66-4b20-9182-8378e5254c20"},{"disabled":true,"description":{"content":"

optional, sorting variable value for pagination (default value = createdAt) (This can only be one of createdAt,updatedAt,startDate,endDate,name)

\n","type":"text/plain"},"key":"sortBy","value":"startDate"},{"disabled":true,"description":{"content":"

optional, filters for id (uuid)

\n","type":"text/plain"},"key":"id","value":"384e4567-e89b-12d3-a456-426655440000"},{"disabled":true,"description":{"content":"

optional, filters case sensitive for externalId

\n","type":"text/plain"},"key":"externalId","value":"abc-1234"},{"disabled":true,"description":{"content":"

optional, filters with createdAfter parameter greater than resource createdAt

\n","type":"text/plain"},"key":"createdAfter","value":"2025-01-27T09:52:02.751Z"},{"disabled":true,"description":{"content":"

optional, filters with updatedAfter parameter greater than resource updatedAt

\n","type":"text/plain"},"key":"updatedAfter","value":"2025-01-27T10:10:59.999Z"},{"disabled":true,"description":{"content":"

optional, sorting order for values (default value = DESC, options : DESC/ ASC) (This can only be one of ASC,DESC)

\n","type":"text/plain"},"key":"sortOrder","value":"ASC"},{"disabled":true,"description":{"content":"

optional, page number for pagination (default value = 0, min = 0)

\n","type":"text/plain"},"key":"page","value":"0"},{"disabled":true,"description":{"content":"

optional, record size per page for pagination (no default value, min = 1, max = 1000)

\n","type":"text/plain"},"key":"size","value":"1000"}],"variable":[]}},"response":[{"id":"71611903-aafc-4732-97e6-f952e81730fc","name":"Events information retrieved successfully","originalRequest":{"method":"GET","header":[{"description":"(Required) API version the client uses. Current server API version: 1.5.4 (This can only be one of 1.5.4)","key":"X-API-Version","value":"1.5.4"},{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"url":{"raw":"https://api.sweap.io/core/v1/events","host":["https://api.sweap.io"],"path":["core","v1","events"],"query":[{"description":"optional, filters case insensitive for exact event name","key":"name","value":"My Event","disabled":true},{"description":"optional, filters case insensitive for event name containing the value","key":"nameContains","value":"event","disabled":true},{"description":"optional, filters for exact match of one event state (This can only be one of DRAFT,ACTIVE,ARCHIVED)","key":"state","value":"ACTIVE","disabled":true},{"description":"optional, filters for startDateBefore equal or less than event startDate","key":"startDateBefore","value":"2025-01-27T12:15:00.000Z","disabled":true},{"description":"optional, filters for startDateAfter equal or greater than event startDate","key":"startDateAfter","value":"2025-01-27T08:00:00.000Z","disabled":true},{"description":"optional, filters for endDateBefore equal or less than event endDate","key":"endDateBefore","value":"2025-01-27T20:00:00.000Z","disabled":true},{"description":"optional, filters for endDateAfter equal or greater than event endDate","key":"endDateAfter","value":"2025-01-27T16:35:00.000Z","disabled":true},{"description":"optional, filters for exact match of one visibilityGroupId","key":"visibilityGroupId","value":"5b05d452-9429-4ba1-a8ce-47dce840982","disabled":true},{"description":"optional, filters for exact match of one eventTagId","key":"eventTagId","value":"f4875291-eb66-4b20-9182-8378e5254c20","disabled":true},{"description":"optional, sorting variable value for pagination (default value = createdAt) (This can only be one of createdAt,updatedAt,startDate,endDate,name)","key":"sortBy","value":"startDate","disabled":true},{"description":"optional, filters for id (uuid)","key":"id","value":"384e4567-e89b-12d3-a456-426655440000","disabled":true},{"description":"optional, filters case sensitive for externalId","key":"externalId","value":"abc-1234","disabled":true},{"description":"optional, filters with createdAfter parameter greater than resource createdAt","key":"createdAfter","value":"2025-01-27T09:52:02.751Z","disabled":true},{"description":"optional, filters with updatedAfter parameter greater than resource updatedAt","key":"updatedAfter","value":"2025-01-27T10:10:59.999Z","disabled":true},{"description":"optional, sorting order for values (default value = DESC, options : DESC/ ASC) (This can only be one of ASC,DESC)","key":"sortOrder","value":"ASC","disabled":true},{"description":"optional, page number for pagination (default value = 0, min = 0)","key":"page","value":"0","disabled":true},{"description":"optional, record size per page for pagination (no default value, min = 1, max = 1000)","key":"size","value":"1000","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"id\": \"384e4567-e89b-12d3-a456-426655440000\",\n \"externalId\": \"abc-1234\",\n \"version\": 1,\n \"createdAt\": \"2025-01-27T09:52:02.752Z\",\n \"updatedAt\": \"2025-01-27T10:11:00.000Z\",\n \"name\": \"My Event\",\n \"startDate\": \"2025-01-27T09:30:00.000Z\",\n \"endDate\": \"2025-01-27T17:00:00.000Z\",\n \"zoneId\": \"Europe/Berlin\",\n \"state\": \"ACTIVE\",\n \"attendanceMode\": \"OFFLINE\",\n \"customFieldDefinitions\": [\n {\n \"id\": \"1af120418d6b431b801e93bcfff840c0\",\n \"name\": \"Text value\",\n \"sortIndex\": 0,\n \"type\": \"TEXT\",\n \"groupName\": \"Personal information\",\n \"options\": {\n \"values\": [\n {\n \"value\": \"S\",\n \"limit\": 25\n },\n {\n \"value\": \"M\",\n \"limit\": 100\n }\n ],\n \"globalLimit\": 50\n }\n },\n {\n \"id\": \"1af120418d6b431b801e93bcfff840c0\",\n \"name\": \"Text value\",\n \"sortIndex\": 0,\n \"type\": \"TEXT\",\n \"groupName\": \"Personal information\",\n \"options\": {\n \"values\": [\n {\n \"value\": \"S\",\n \"limit\": 25\n },\n {\n \"value\": \"M\",\n \"limit\": 100\n }\n ],\n \"globalLimit\": 50\n }\n }\n ],\n \"location\": {\n \"latitude\": 8451.032644154766,\n \"longitude\": 137.52806874033686,\n \"textRepresentation\": \"Sweap Office\",\n \"formattedAddress\": \"Rankestraße 9, 10789 Berlin, Germany\"\n },\n \"visibilityGroupIds\": [\n \"string\"\n ],\n \"eventTagIds\": [\n \"string\"\n ]\n },\n {\n \"id\": \"384e4567-e89b-12d3-a456-426655440000\",\n \"externalId\": \"abc-1234\",\n \"version\": 1,\n \"createdAt\": \"2025-01-27T09:52:02.752Z\",\n \"updatedAt\": \"2025-01-27T10:11:00.000Z\",\n \"name\": \"My Event\",\n \"startDate\": \"2025-01-27T09:30:00.000Z\",\n \"endDate\": \"2025-01-27T17:00:00.000Z\",\n \"zoneId\": \"Europe/Berlin\",\n \"state\": \"ACTIVE\",\n \"attendanceMode\": \"OFFLINE\",\n \"customFieldDefinitions\": [\n {\n \"id\": \"1af120418d6b431b801e93bcfff840c0\",\n \"name\": \"Text value\",\n \"sortIndex\": 0,\n \"type\": \"TEXT\",\n \"groupName\": \"Personal information\",\n \"options\": {\n \"values\": [\n {\n \"value\": \"S\",\n \"limit\": 25\n },\n {\n \"value\": \"M\",\n \"limit\": 100\n }\n ],\n \"globalLimit\": 50\n }\n },\n {\n \"id\": \"1af120418d6b431b801e93bcfff840c0\",\n \"name\": \"Text value\",\n \"sortIndex\": 0,\n \"type\": \"TEXT\",\n \"groupName\": \"Personal information\",\n \"options\": {\n \"values\": [\n {\n \"value\": \"S\",\n \"limit\": 25\n },\n {\n \"value\": \"M\",\n \"limit\": 100\n }\n ],\n \"globalLimit\": 50\n }\n }\n ],\n \"location\": {\n \"latitude\": 5307.318317279805,\n \"longitude\": 2789.7313653099077,\n \"textRepresentation\": \"Sweap Office\",\n \"formattedAddress\": \"Rankestraße 9, 10789 Berlin, Germany\"\n },\n \"visibilityGroupIds\": [\n \"string\"\n ],\n \"eventTagIds\": [\n \"string\"\n ]\n }\n]"},{"id":"cbb20716-c5eb-4359-9ceb-5599c00b984a","name":"Bad Request","originalRequest":{"method":"GET","header":[{"description":"(Required) API version the client uses. Current server API version: 1.5.4 (This can only be one of 1.5.4)","key":"X-API-Version","value":"1.5.4"},{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"url":{"raw":"https://api.sweap.io/core/v1/events","host":["https://api.sweap.io"],"path":["core","v1","events"],"query":[{"description":"optional, filters case insensitive for exact event name","key":"name","value":"My Event","disabled":true},{"description":"optional, filters case insensitive for event name containing the value","key":"nameContains","value":"event","disabled":true},{"description":"optional, filters for exact match of one event state (This can only be one of DRAFT,ACTIVE,ARCHIVED)","key":"state","value":"ACTIVE","disabled":true},{"description":"optional, filters for startDateBefore equal or less than event startDate","key":"startDateBefore","value":"2025-01-27T12:15:00.000Z","disabled":true},{"description":"optional, filters for startDateAfter equal or greater than event startDate","key":"startDateAfter","value":"2025-01-27T08:00:00.000Z","disabled":true},{"description":"optional, filters for endDateBefore equal or less than event endDate","key":"endDateBefore","value":"2025-01-27T20:00:00.000Z","disabled":true},{"description":"optional, filters for endDateAfter equal or greater than event endDate","key":"endDateAfter","value":"2025-01-27T16:35:00.000Z","disabled":true},{"description":"optional, filters for exact match of one visibilityGroupId","key":"visibilityGroupId","value":"5b05d452-9429-4ba1-a8ce-47dce840982","disabled":true},{"description":"optional, filters for exact match of one eventTagId","key":"eventTagId","value":"f4875291-eb66-4b20-9182-8378e5254c20","disabled":true},{"description":"optional, sorting variable value for pagination (default value = createdAt) (This can only be one of createdAt,updatedAt,startDate,endDate,name)","key":"sortBy","value":"startDate","disabled":true},{"description":"optional, filters for id (uuid)","key":"id","value":"384e4567-e89b-12d3-a456-426655440000","disabled":true},{"description":"optional, filters case sensitive for externalId","key":"externalId","value":"abc-1234","disabled":true},{"description":"optional, filters with createdAfter parameter greater than resource createdAt","key":"createdAfter","value":"2025-01-27T09:52:02.751Z","disabled":true},{"description":"optional, filters with updatedAfter parameter greater than resource updatedAt","key":"updatedAfter","value":"2025-01-27T10:10:59.999Z","disabled":true},{"description":"optional, sorting order for values (default value = DESC, options : DESC/ ASC) (This can only be one of ASC,DESC)","key":"sortOrder","value":"ASC","disabled":true},{"description":"optional, page number for pagination (default value = 0, min = 0)","key":"page","value":"0","disabled":true},{"description":"optional, record size per page for pagination (no default value, min = 1, max = 1000)","key":"size","value":"1000","disabled":true}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"error\": \"Bad Request\",\n \"code\": 4000,\n \"message\": \"These request parameters are not valid (please check their data type, value syntax and if they are required): size=1001 (PageSizeConstraint)\",\n \"requestId\": \"84e2cec6-706c-4060-855c-37b2f2e2b0b5\"\n}\n"},{"id":"acbb5817-de3b-440e-886b-d671b27e4d63","name":"Forbidden","originalRequest":{"method":"GET","header":[{"description":"(Required) API version the client uses. Current server API version: 1.5.4 (This can only be one of 1.5.4)","key":"X-API-Version","value":"1.5.4"},{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"url":{"raw":"https://api.sweap.io/core/v1/events","host":["https://api.sweap.io"],"path":["core","v1","events"],"query":[{"description":"optional, filters case insensitive for exact event name","key":"name","value":"My Event","disabled":true},{"description":"optional, filters case insensitive for event name containing the value","key":"nameContains","value":"event","disabled":true},{"description":"optional, filters for exact match of one event state (This can only be one of DRAFT,ACTIVE,ARCHIVED)","key":"state","value":"ACTIVE","disabled":true},{"description":"optional, filters for startDateBefore equal or less than event startDate","key":"startDateBefore","value":"2025-01-27T12:15:00.000Z","disabled":true},{"description":"optional, filters for startDateAfter equal or greater than event startDate","key":"startDateAfter","value":"2025-01-27T08:00:00.000Z","disabled":true},{"description":"optional, filters for endDateBefore equal or less than event endDate","key":"endDateBefore","value":"2025-01-27T20:00:00.000Z","disabled":true},{"description":"optional, filters for endDateAfter equal or greater than event endDate","key":"endDateAfter","value":"2025-01-27T16:35:00.000Z","disabled":true},{"description":"optional, filters for exact match of one visibilityGroupId","key":"visibilityGroupId","value":"5b05d452-9429-4ba1-a8ce-47dce840982","disabled":true},{"description":"optional, filters for exact match of one eventTagId","key":"eventTagId","value":"f4875291-eb66-4b20-9182-8378e5254c20","disabled":true},{"description":"optional, sorting variable value for pagination (default value = createdAt) (This can only be one of createdAt,updatedAt,startDate,endDate,name)","key":"sortBy","value":"startDate","disabled":true},{"description":"optional, filters for id (uuid)","key":"id","value":"384e4567-e89b-12d3-a456-426655440000","disabled":true},{"description":"optional, filters case sensitive for externalId","key":"externalId","value":"abc-1234","disabled":true},{"description":"optional, filters with createdAfter parameter greater than resource createdAt","key":"createdAfter","value":"2025-01-27T09:52:02.751Z","disabled":true},{"description":"optional, filters with updatedAfter parameter greater than resource updatedAt","key":"updatedAfter","value":"2025-01-27T10:10:59.999Z","disabled":true},{"description":"optional, sorting order for values (default value = DESC, options : DESC/ ASC) (This can only be one of ASC,DESC)","key":"sortOrder","value":"ASC","disabled":true},{"description":"optional, page number for pagination (default value = 0, min = 0)","key":"page","value":"0","disabled":true},{"description":"optional, record size per page for pagination (no default value, min = 1, max = 1000)","key":"size","value":"1000","disabled":true}]}},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"error\": \"Access Denied Missing Permission\",\n \"code\": 4031,\n \"message\": \"Missing security to access this resource.\",\n \"requestId\": \"abca3c4c-4fd5-45da-8bec-637a9bc62222\"\n}\n"},{"id":"af72d0be-fd5f-4374-922f-7a30f5fb9560","name":"Internal Server Error","originalRequest":{"method":"GET","header":[{"description":"(Required) API version the client uses. Current server API version: 1.5.4 (This can only be one of 1.5.4)","key":"X-API-Version","value":"1.5.4"},{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"url":{"raw":"https://api.sweap.io/core/v1/events","host":["https://api.sweap.io"],"path":["core","v1","events"],"query":[{"description":"optional, filters case insensitive for exact event name","key":"name","value":"My Event","disabled":true},{"description":"optional, filters case insensitive for event name containing the value","key":"nameContains","value":"event","disabled":true},{"description":"optional, filters for exact match of one event state (This can only be one of DRAFT,ACTIVE,ARCHIVED)","key":"state","value":"ACTIVE","disabled":true},{"description":"optional, filters for startDateBefore equal or less than event startDate","key":"startDateBefore","value":"2025-01-27T12:15:00.000Z","disabled":true},{"description":"optional, filters for startDateAfter equal or greater than event startDate","key":"startDateAfter","value":"2025-01-27T08:00:00.000Z","disabled":true},{"description":"optional, filters for endDateBefore equal or less than event endDate","key":"endDateBefore","value":"2025-01-27T20:00:00.000Z","disabled":true},{"description":"optional, filters for endDateAfter equal or greater than event endDate","key":"endDateAfter","value":"2025-01-27T16:35:00.000Z","disabled":true},{"description":"optional, filters for exact match of one visibilityGroupId","key":"visibilityGroupId","value":"5b05d452-9429-4ba1-a8ce-47dce840982","disabled":true},{"description":"optional, filters for exact match of one eventTagId","key":"eventTagId","value":"f4875291-eb66-4b20-9182-8378e5254c20","disabled":true},{"description":"optional, sorting variable value for pagination (default value = createdAt) (This can only be one of createdAt,updatedAt,startDate,endDate,name)","key":"sortBy","value":"startDate","disabled":true},{"description":"optional, filters for id (uuid)","key":"id","value":"384e4567-e89b-12d3-a456-426655440000","disabled":true},{"description":"optional, filters case sensitive for externalId","key":"externalId","value":"abc-1234","disabled":true},{"description":"optional, filters with createdAfter parameter greater than resource createdAt","key":"createdAfter","value":"2025-01-27T09:52:02.751Z","disabled":true},{"description":"optional, filters with updatedAfter parameter greater than resource updatedAt","key":"updatedAfter","value":"2025-01-27T10:10:59.999Z","disabled":true},{"description":"optional, sorting order for values (default value = DESC, options : DESC/ ASC) (This can only be one of ASC,DESC)","key":"sortOrder","value":"ASC","disabled":true},{"description":"optional, page number for pagination (default value = 0, min = 0)","key":"page","value":"0","disabled":true},{"description":"optional, record size per page for pagination (no default value, min = 1, max = 1000)","key":"size","value":"1000","disabled":true}]}},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"error\": \"Internal Server Error\",\n \"code\": 5000,\n \"message\": \"An unexpected error occurred while processing the request.\",\n \"requestId\": \"696ef63e-12c5-4bb8-a3ca-3b555a7b50a2\"\n}\n"}],"_postman_id":"336d11ea-fc7e-44ac-aa01-53aa2f3e48ff"},{"name":"Get events as RestResponse","id":"d86f36ab-3c3a-46f1-b406-2fefb48da1a5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"description":"

(Required) API version the client uses. Current server API version: 1.5.4 (This can only be one of 1.5.4)

\n","key":"X-API-Version","value":"1.5.4"},{"key":"Accept","value":"application/json"}],"url":"https://api.sweap.io/core/v1/events/paginated","description":"

Get a RestResponse with a paginated list of events based on the specified filters and sorting parameters