Skip to main content
POST
/
api
/
directory
/
resources.list
List resources
curl --request POST \
  --url https://api.example.com/api/directory/resources.list \
  --header 'Content-Type: application/json' \
  --data '
{
  "kind_id": "872815618512410358",
  "at_date": "2019-11-11",
  "attributes": [
    "<string>"
  ],
  "with_teams": false,
  "with_relations": false,
  "with_total_count": false,
  "filters": [
    {
      "key": "resource.ids",
      "value": [
        "872815618512410358"
      ]
    }
  ],
  "orders": [
    {
      "key": "resource.attribute",
      "direction": "asc",
      "attribute": "<string>"
    }
  ]
}
'
{
  "data": [
    {
      "id": "872815618512410358",
      "kind_id": "872815618512410358",
      "label": "<string>",
      "short_label": "<string>",
      "sort_label": "<string>",
      "picture": {
        "shape": "round",
        "initial": "<string>",
        "url": "<string>"
      },
      "attributes": {},
      "teams": [
        {
          "id": "872815618512410358",
          "head": true,
          "name": "<string>"
        }
      ],
      "relations": [
        {
          "relation_type_id": "872815618512410358",
          "related_to": "872815618512410358",
          "related_by": [
            "872815618512410358"
          ]
        }
      ]
    }
  ],
  "next_token": "<string>",
  "total_count": 123
}

Body

application/json
​
kind_id
string<snowflake>
required
Example:

"872815618512410358"

​
at_date
string<local-date>
Example:

"2019-11-11"

​
attributes
string[]
​
with_teams
boolean
default:false
​
with_relations
boolean | null
default:false
​
with_total_count
boolean
default:false
​
filters
object[]
​
orders
object[]
​
pagination
object

Response

200 - application/json
​
data
object[]
required
​
next_token
string | null
required
​
total_count
integer

Total number of resources matching filters in the request; only present if parameter "with_total_count" is set to "true".