v1

latestOpenAPI 3.0.02026-07-24161215397.4 KB

Passes

Get sets of day passes

Retrieve a list of sets of day passes based on provided filters

Required scopes: flex.space.passes.read

get/api/v2/organizations/{orgSlug}/passes

Path parameters

orgSlugstring required

organization slug

Query parameters

_idstring

Example:6080186f490fcf6e0537ec61

Filter by the _id of the set of passes.

companystring

Example:6080186f490fcf6e0537ec62

Filter by the _id of the company with which the passes are associated.

memberstring

Example:6080186f490fcf6e0537ec63

Filter by the _id of the member with which the passes are associated.

modifiedAtstring

Example:modifiedAt[$gte]=YYYY-MM-DDTHH:mm:ssZ

Filter by the modified date. Supports date comparison filters: $gt, $gte, $lt, $lte

createdAtstring

Example:createdAt[$gte]=YYYY-MM-DDTHH:mm:ssZ

Support date comparison filters: $gt, $gte, $lt, $lte

$selectstring

Example:recipient,sender

Select fields to return

$cursorNextstring

$cursorPrevstring

$limitnumber

Response

rangeStartnumber

rangeEndnumber

cursorNextstring

cursorPrevstring

Example response

{
  "results": [
    {
      "_id": "6080186f490fcf6e0537ec52",
      "count": 15,
      "usedCount": 5,
      "startDate": "2024-04-12T00:00:00.000Z",
      "endDate": "2024-05-12T00:00:00.000Z",
      "renewDate": "2024-05-12T00:00:00.000Z",
      "validFrom": "2024-03-06T00:00:00.000Z",
      "validTo": "2024-04-06T00:00:00.000Z",
      "company": "6080186f490fcf6e0537ec62",
      "member": "6080186f490fcf6e0537ec67",
      "isPersonal": true,
      "membership": "6080186f490fcf6e0537ec33",
      "fee": "6080186f490fcf6e0537ec34",
      "shouldGrantActiveStatus": true,
      "resourceType": "hotdesk",
      "createdAt": "2024-04-12T00:00:00.000Z",
      "createdBy": "6080186f490fcf6e0537ec27",
      "modifiedAt": "2024-05-12T00:00:00.000Z",
      "modifiedBy": "6080186f490fcf6e0537ec54"
    }
  ]
}