Get Resources

Retrieve a paginated list of resources for your organization. Resources can be documents, consents, forms, or products. You can filter resources by type, search by name, filter by active status, and paginate through results. Only non-deleted resources are returned.

GET /v1/resource

Get Resources

cURL

curl --request GET \
  --url https://api.example.com/v1/resource

200

{
  "data": [
    {
      "id": "507f1f77bcf86cd799439011",
      "type": "DOCUMENT",
      "name": "Identity Document",
      "active": true,
      "required": true,
      "updatedAt": "2025-01-15T10:30:00Z",
      "description": "Official identity document for verification",
      "internalId": "internal-resource-123",
      "groupIds": [
        "507f1f77bcf86cd799439011"
      ],
      "typeFormId": "form-123",
      "formData": {
        "fields": [
          {
            "id": "1",
            "type": "text"
          }
        ]
      },
      "url": "https://s3.amazonaws.com/bucket/file.pdf",
      "link": "https://example.com/consent",
      "text": "I agree to the terms and conditions",
      "price": 9999,
      "photoUrl": "https://example.com/product-photo.jpg"
    }
  ],
  "totalPages": 5
}

Query Parameters

pageIndex · number

Page number (0-indexed). Default is 0.

Example:

0

pageSize · number

Number of items per page. Minimum 5, maximum 100. Default is 20.

Required range: 5 <= x <= 100

Example:

20

active · boolean

Filter resources by active status. Accepts true/false as string or boolean.

Example:

true

search · string

Search query to filter resources by name. Case-insensitive partial match.

Example:

"identity"

types · enum<string>

Filter resources by type. Can be a single value or array. Valid values: CONSENT, FORM, DOCUMENT, PRODUCT.

Available options: CONSENT, FORM, DOCUMENT, PRODUCT

Response

200 - application/json

Successfully retrieved resources. Returns a paginated result with an array of resource items and the total number of pages.

data · object[] · required

Array of resources matching the query parameters

Show child attributes

totalPages · number · required

Total number of pages available based on the page size and total count

Example:

5