{"openapi":"3.1.0","info":{"title":"SDEP - Reporting (REP) API","description":"Read-only endpoints for the national statistics office to view all registered activity data. Status: beta.","version":"PRD-1.3.0"},"paths":{"/activities":{"get":{"tags":["rep"],"summary":"Get all activities across all competent authorities and platforms","description":"Get all current activities across all competent authorities and platforms, for statistical analysis. Returns at most 1000 activities per request (the default and maximum `limit`), including current records whose lifecycle `status` is `cancelled`. Use the `offset` and `limit` pagination parameters to page through results. Optional filters use AND semantics: every provided filter narrows the result set. `filterCreatedAtFrom` and `filterCreatedAtTo` form an inclusive `createdAt` range; `filterPlatformId`, `filterAreaId` and `filterCompetentAuthorityId` are exact-match filters.\n\n**Each activity contains:**\n- `activityId`: Functional ID identifying this activity\n- `activityName`: Display name (optional) of the activity\n- `status`: Lifecycle status of the activity: `finished` or `cancelled`\n- `areaId`: Functional ID referencing the area where the activity took place\n- `competentAuthorityId`: Functional ID referencing the competent authority that owns the area\n- `competentAuthorityName`: Display name (optional) of the competent authority\n- `url`: URL of the originating listing/advertisement\n- `address`: Address composite (`thoroughfare`, `locatorDesignatorNumber` (optional), `locatorDesignatorLetter` (optional), `locatorDesignatorAddition` (optional), `postCode`, `postName`, `fullAddress`)\n- `registrationNumber`: Registration number of the address\n- `numberOfGuests`: Number of guests (1-1024)\n- `countryOfGuests`: Array of country codes of guests (each element is ISO 3166-1 alpha-3 or `N/A`; array length equals `numberOfGuests`)\n- `temporal`: Temporal composite (`startDatetime`, `endDatetime`)\n- `platformId`: Functional ID referencing the platform that owns the activity\n- `platformName`: Display name (optional) of the platform\n- `createdAt`: Timestamp when this activity version was created (UTC)","operationId":"getAllActivities","security":[{"OAuth2ClientCredentials":[]}],"parameters":[{"name":"offset","in":"query","required":false,"schema":{"type":"integer","minimum":0,"description":"Number of records to skip (default: 0)","default":0,"title":"Offset"},"description":"Number of records to skip (default: 0)"},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":1000,"minimum":1,"description":"Maximum number of records to return (default: 1000, max: 1000)","default":1000,"title":"Limit"},"description":"Maximum number of records to return (default: 1000, max: 1000)"},{"name":"filterCreatedAtFrom","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"description":"Filter activities whose createdAt timestamp is greater than or equal to this value","examples":["2025-06-01T00:00:00Z"],"title":"Filtercreatedatfrom"},"description":"Filter activities whose createdAt timestamp is greater than or equal to this value"},{"name":"filterCreatedAtTo","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"description":"Filter activities whose createdAt timestamp is less than or equal to this value","examples":["2025-06-30T23:59:59Z"],"title":"Filtercreatedatto"},"description":"Filter activities whose createdAt timestamp is less than or equal to this value"},{"name":"filterPlatformId","in":"query","required":false,"schema":{"anyOf":[{"type":"string","minLength":1,"maxLength":64,"pattern":"^[A-Za-z0-9-]+$"},{"type":"null"}],"description":"Filter by platform functional ID","examples":["sdep-str01"],"title":"Filterplatformid"},"description":"Filter by platform functional ID"},{"name":"filterAreaId","in":"query","required":false,"schema":{"anyOf":[{"type":"string","minLength":1,"maxLength":64,"pattern":"^[A-Za-z0-9-]+$"},{"type":"null"}],"description":"Filter by area functional ID","examples":["959a7439-7cad-4009-96ec-353b44723db9"],"title":"Filterareaid"},"description":"Filter by area functional ID"},{"name":"filterCompetentAuthorityId","in":"query","required":false,"schema":{"anyOf":[{"type":"string","minLength":1,"maxLength":64,"pattern":"^[A-Za-z0-9-]+$"},{"type":"null"}],"description":"Filter by competent authority functional ID","examples":["c4ac8ccf-a281-5789-bad7-28dfac20ca7f"],"title":"Filtercompetentauthorityid"},"description":"Filter by competent authority functional ID"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ActivityListResponse"},"example":{"activities":[{"activityId":"550e8400-e29b-41d4-a716-446655440000","activityName":"Amsterdam Summer Rental","status":"finished","areaId":"58ff0814-3aa1-5019-9afb-3cd9f398602c","competentAuthorityId":"c4ac8ccf-a281-5789-bad7-28dfac20ca7f","competentAuthorityName":"Gemeente Amsterdam","url":"http://example.com/amsterdam-myhouse-1","address":{"thoroughfare":"Prinsengracht","locatorDesignatorNumber":263,"postCode":"1016GV","postName":"Amsterdam","fullAddress":"Prinsengracht 263, 1016GV Amsterdam"},"registrationNumber":"REG0001","numberOfGuests":4,"countryOfGuests":["NLD","DEU","BEL","N/A"],"temporal":{"startDatetime":"2025-06-01T14:00:00Z","endDatetime":"2025-06-07T11:00:00Z"},"platformId":"8e70f1e2-4c61-477b-89b8-0dbf25ab8b21","platformName":"Test STR 01 (interactive usage, persistent)","createdAt":"2025-06-01T12:00:00Z"}]}}}},"500":{"description":"Internal Server Error - an unexpected issue occurred that prevented the request from being completed"},"503":{"description":"Service Unavailable - temporarily unable to process requests due to overload, maintenance, or dependency issues (database/authorization server)"},"400":{"description":"Bad request - invalid query parameters","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Unauthorized - missing or invalid token","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"Forbidden - insufficient permissions"}}}},"/activities/count":{"get":{"tags":["rep"],"summary":"Get the count of all activities across all competent authorities and platforms (optional, to support pagination)","description":"Get the count of all current activities across all competent authorities and platforms (optional, to support pagination). Counts all current activity records, including those whose lifecycle `status` is `cancelled`. Optional filters use AND semantics: every provided filter narrows the count. `filterCreatedAtFrom` and `filterCreatedAtTo` form an inclusive `createdAt` range; `filterPlatformId`, `filterAreaId` and `filterCompetentAuthorityId` are exact-match filters.","operationId":"countAllActivities","security":[{"OAuth2ClientCredentials":[]}],"parameters":[{"name":"filterCreatedAtFrom","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"description":"Filter activities whose createdAt timestamp is greater than or equal to this value","examples":["2025-06-01T00:00:00Z"],"title":"Filtercreatedatfrom"},"description":"Filter activities whose createdAt timestamp is greater than or equal to this value"},{"name":"filterCreatedAtTo","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"description":"Filter activities whose createdAt timestamp is less than or equal to this value","examples":["2025-06-30T23:59:59Z"],"title":"Filtercreatedatto"},"description":"Filter activities whose createdAt timestamp is less than or equal to this value"},{"name":"filterPlatformId","in":"query","required":false,"schema":{"anyOf":[{"type":"string","minLength":1,"maxLength":64,"pattern":"^[A-Za-z0-9-]+$"},{"type":"null"}],"description":"Filter by platform functional ID","examples":["sdep-str01"],"title":"Filterplatformid"},"description":"Filter by platform functional ID"},{"name":"filterAreaId","in":"query","required":false,"schema":{"anyOf":[{"type":"string","minLength":1,"maxLength":64,"pattern":"^[A-Za-z0-9-]+$"},{"type":"null"}],"description":"Filter by area functional ID","examples":["959a7439-7cad-4009-96ec-353b44723db9"],"title":"Filterareaid"},"description":"Filter by area functional ID"},{"name":"filterCompetentAuthorityId","in":"query","required":false,"schema":{"anyOf":[{"type":"string","minLength":1,"maxLength":64,"pattern":"^[A-Za-z0-9-]+$"},{"type":"null"}],"description":"Filter by competent authority functional ID","examples":["c4ac8ccf-a281-5789-bad7-28dfac20ca7f"],"title":"Filtercompetentauthorityid"},"description":"Filter by competent authority functional ID"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ActivityCountResponse"}}}},"500":{"description":"Internal Server Error - an unexpected issue occurred that prevented the request from being completed"},"503":{"description":"Service Unavailable - temporarily unable to process requests due to overload, maintenance, or dependency issues (database/authorization server)"},"401":{"description":"Unauthorized - missing or invalid token","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"Forbidden - insufficient permissions"}}}}},"components":{"schemas":{"ActivityCountResponse":{"properties":{"count":{"type":"integer","minimum":0.0,"title":"Count","description":"Total number of activity records","examples":[42]}},"type":"object","required":["count"],"title":"Activity.CountResponse","description":"Count of activities response schema."},"ActivityListResponse":{"properties":{"activities":{"items":{"$ref":"#/components/schemas/ActivityResponse"},"type":"array","title":"Activities","description":"List of activities"}},"type":"object","required":["activities"],"title":"Activity.ListResponse","description":"List of activities for GET responses."},"ActivityResponse":{"properties":{"activityId":{"type":"string","maxLength":64,"minLength":1,"pattern":"^[A-Za-z0-9-]+$","title":"Activityid","description":"Functional ID identifying this activity","examples":["550e8400-e29b-41d4-a716-446655440000","550E8400-E29B-41D4-A716-446655440000"]},"activityName":{"anyOf":[{"type":"string","maxLength":64},{"type":"null"}],"title":"Activityname","description":"Display name (optional) of the activity"},"status":{"$ref":"#/components/schemas/ActivityStatus","description":"Lifecycle status of the activity: `finished` or `cancelled`.","examples":["finished","cancelled"]},"areaId":{"type":"string","maxLength":64,"minLength":1,"pattern":"^[A-Za-z0-9-]+$","title":"Areaid","description":"Functional ID referencing the area where this activity took place","examples":["3ab7c2b9-5c8d-4100-bc3e-00ac115f0495","3AB7C2B9-5C8D-4100-BC3E-00AC115F0495"]},"competentAuthorityId":{"type":"string","maxLength":64,"minLength":1,"pattern":"^[A-Za-z0-9-]+$","title":"Competentauthorityid","description":"Functional ID referencing the competent authority that owns the area","examples":["c4ac8ccf-a281-5789-bad7-28dfac20ca7f","a30df3a7-7e38-534c-b9c0-7666bad077d2"]},"competentAuthorityName":{"anyOf":[{"type":"string","maxLength":64},{"type":"null"}],"title":"Competentauthorityname","description":"Display name (optional) of the competent authority"},"url":{"type":"string","title":"Url","description":"URL of the originating listing/advertisement"},"address":{"$ref":"#/components/schemas/CommonAddressResponse","description":"Address composite (`thoroughfare`, `locatorDesignatorNumber` (optional), `locatorDesignatorLetter` (optional), `locatorDesignatorAddition` (optional), `postCode`, `postName`, `fullAddress`)"},"registrationNumber":{"type":"string","title":"Registrationnumber","description":"Registration number of the address"},"numberOfGuests":{"type":"integer","title":"Numberofguests","description":"Number of guests (1-1024)"},"countryOfGuests":{"items":{"type":"string"},"type":"array","title":"Countryofguests","description":"Array of country codes of guests (each element is ISO 3166-1 alpha-3 or 'N/A'); array length equals numberOfGuests."},"temporal":{"$ref":"#/components/schemas/CommonTemporalResponse","description":"Temporal composite (`startDatetime`, `endDatetime`)"},"platformId":{"type":"string","maxLength":64,"minLength":1,"pattern":"^[A-Za-z0-9-]+$","title":"Platformid","description":"Functional ID referencing the platform that owns the activity","examples":["8e70f1e2-4c61-477b-89b8-0dbf25ab8b21","227e07d4-37c4-4ceb-aa16-80346d258f6b"]},"platformName":{"anyOf":[{"type":"string","maxLength":64},{"type":"null"}],"title":"Platformname","description":"Display name (optional) of the platform"},"createdAt":{"type":"string","format":"date-time","title":"Createdat","description":"Timestamp when this activity version was created (UTC)"}},"type":"object","required":["activityId","status","areaId","competentAuthorityId","url","address","registrationNumber","numberOfGuests","countryOfGuests","temporal","platformId","createdAt"],"title":"Activity.Response","description":"Activity response schema."},"ActivityStatus":{"type":"string","enum":["finished","cancelled"],"title":"Activity.Status","description":"Lifecycle status for an activity record."},"CommonAddressResponse":{"properties":{"thoroughfare":{"type":"string","title":"Thoroughfare","description":"Street / public space name"},"locatorDesignatorNumber":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Locatordesignatornumber","description":"Numeric house number component (optional)"},"locatorDesignatorLetter":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Locatordesignatorletter","description":"Letter/character suffix (optional)"},"locatorDesignatorAddition":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Locatordesignatoraddition","description":"Additional qualifier (optional)"},"postCode":{"type":"string","title":"Postcode","description":"Postal code"},"postName":{"type":"string","title":"Postname","description":"City / town / village"},"fullAddress":{"type":"string","title":"Fulladdress","description":"Full address as a single string"}},"type":"object","required":["thoroughfare","postCode","postName","fullAddress"],"title":"Common.AddressResponse","description":"Address composite schema for activity responses (INSPIRE/STR-AP field names)."},"CommonTemporalResponse":{"properties":{"startDatetime":{"type":"string","format":"date-time","title":"Startdatetime","description":"Start date and time of the rental activity"},"endDatetime":{"type":"string","format":"date-time","title":"Enddatetime","description":"End date and time of the rental activity"}},"type":"object","required":["startDatetime","endDatetime"],"title":"Common.TemporalResponse","description":"Temporal composite schema for activity responses."},"ErrorDetail":{"properties":{"msg":{"type":"string","title":"Msg","description":"Human-readable error message"},"type":{"type":"string","title":"Type","description":"Error type identifier"},"loc":{"anyOf":[{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array"},{"type":"null"}],"title":"Loc","description":"Location of the error (e.g. ['body', 'fieldName'])"}},"type":"object","required":["msg","type"],"title":"Error.Detail","description":"Detail of a single error."},"ErrorResponse":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ErrorDetail"},"type":"array","title":"Detail","description":"List of error details"}},"type":"object","required":["detail"],"title":"Error.Response","description":"Standardized error response format."}},"securitySchemes":{"OAuth2ClientCredentials":{"type":"oauth2","flows":{"clientCredentials":{"scopes":{},"tokenUrl":"https://sdep.gov.nl/api/auth/v1/token"}}}}},"servers":[{"url":"/api/rep/v1"}]}