v1

latestOpenAPI 3.0.02026-07-24161215397.4 KB

Assignments

Retrieve assignments by resource and/or membership

Get paged assignments. At least one of resource or membership is required. Supports single ids and array filters via $in (e.g. "/assignments?resource[$in]=id1,id2").

Required scopes: flex.space.assignments.read

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

Path parameters

orgSlugstring required

organization slug

Query parameters

resourcestring

Filter by resource id. Supports resource=value and resource[$in]=id1,id2.

membershipstring

Filter by membership id. Supports membership=value and membership[$in]=id1,id2.

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

Select fields to return

$cursorNextstring

$cursorPrevstring

$limitnumber

Response

rangeStartnumber

rangeEndnumber

cursorNextstring

cursorPrevstring

Example response

{
  "results": [
    {
      "_id": "61f273a906afd1846de1fbb3",
      "resource": "61f2736224071037dea8956c",
      "membership": "6262b4de9d02c386771e3923",
      "startDate": "2024-08-21T16:00:00.000Z",
      "endDate": "2024-08-21T16:00:00.000Z"
    }
  ]
}