List Export Resources

curl --request GET \
  --url https://api.example.com/api/v1/ops/export-resources \
  --header 'Authorization: Bearer <token>'

{
  "data": [
    {
      "exportResourceId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "resource": "<string>",
      "label": "<string>",
      "description": "<string>",
      "permission": "<string>",
      "formats": [],
      "defaultColumns": [
        "<string>"
      ],
      "columns": [
        {
          "field": "<string>",
          "label": "<string>",
          "values": [
            "<string>"
          ],
          "sensitive": true
        }
      ],
      "filters": [
        {
          "field": "<string>",
          "label": "<string>",
          "operators": [],
          "values": [
            "<string>"
          ],
          "required": true
        }
      ],
      "maxRows": 123,
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z",
      "deletedAt": "2023-11-07T05:31:56Z"
    }
  ],
  "meta": {
    "page": 1,
    "limit": 20,
    "total": 125,
    "totalPages": 7
  }
}

GET

api

ops

export-resources

List Export Resources

curl --request GET \
  --url https://api.example.com/api/v1/ops/export-resources \
  --header 'Authorization: Bearer <token>'

{
  "data": [
    {
      "exportResourceId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "resource": "<string>",
      "label": "<string>",
      "description": "<string>",
      "permission": "<string>",
      "formats": [],
      "defaultColumns": [
        "<string>"
      ],
      "columns": [
        {
          "field": "<string>",
          "label": "<string>",
          "values": [
            "<string>"
          ],
          "sensitive": true
        }
      ],
      "filters": [
        {
          "field": "<string>",
          "label": "<string>",
          "operators": [],
          "values": [
            "<string>"
          ],
          "required": true
        }
      ],
      "maxRows": 123,
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z",
      "deletedAt": "2023-11-07T05:31:56Z"
    }
  ],
  "meta": {
    "page": 1,
    "limit": 20,
    "total": 125,
    "totalPages": 7
  }
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

limit

number

default:10

Items per page

Required range: 1 <= x <= 100

Example:

10

page

number

default:1

Page number

Required range: x >= 1

Example:

1

status

enum<string>

Export resource status.

Available options:

ACTIVE,

INACTIVE

sortBy

enum<string>

default:resource

Field to sort by

Available options:

resource,

createdAt

Example:

"resource"

sortOrder

enum<string>

default:desc

Sort order

Available options:

asc,

desc

Example:

"desc"

fields

string

Comma-separated list of fields to include in the response. Supports dot notation for nested projection (e.g. id,name,user.email,trips.route.id). Unknown fields are silently dropped.

Response

data

object[]

required

Show child attributes