v1

latestOpenAPI 3.0.02026-07-24161215397.4 KB

Credits

Retrieve all credits.

Required scopes: flex.space.credits.read

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

Path parameters

orgSlugstring required

organization slug

Query parameters

companystring

Example:603dfbc260f4054084125d30

Filter by company id.

memberstring

Example:603dfbc260f4054084125d33

Filter by member id.

validFromstring

Example:validFrom[$gte]=2024-01-01T00:00:00Z

Filter by from date of the credits. Supports date comparison filters: $gt, $gte, $lt, $lte

validTostring

Example:validTo[$gte]=2024-01-01T00:00:00Z

Filter by to date of the credits. Supports date comparison filters: $gt, $gte, $lt, $lte

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": "603dfbc260f4054084125d30",
      "company": "603dfbc260f4054084125d30",
      "member": "603dfbc260f4054084125d33",
      "fee": "603dfbc260f4054084125d33",
      "membership": "603dfbc260f4054084125d33",
      "startDate": "2024-01-01T00:00:00Z",
      "endDate": "2024-01-01T00:00:00Z",
      "validFrom": "2024-01-01T00:00:00Z",
      "validTo": "2024-01-01T00:00:00Z",
      "resourceTypes": [
        "603dfbc260f4054084125d30"
      ],
      "bookings": [
        {
          "count": 2,
          "booking": "603dfbc260f4054084125d30",
          "occurrenceDate": "2024-01-01T00:00:00Z"
        }
      ],
      "parent": "603dfbc260f4054084125d30",
      "resourceRates": [
        "603dfbc260f4054084125d30"
      ],
      "count": 2,
      "usedCount": 1
    }
  ]
}