Filter

Endpoint for exporting data through generated filters.

📥 Postman Collection

Download Collection - Filter Export

URLs

Method	URL	Action	Description
GET	/api/filter	List	Lists all available filters
GET	/api/filter/{id}/export	View	Exports registrations from a filter
POST	/api/filter/{id}/update	Update	Updates filter data

Production:

{connect-producao}/api/filter

Staging:

{connect-homologacao}/api/filter

Authentication

All requests require an access token obtained from the Security endpoint. The token must be sent in the AccessToken header.

List Filters

Request

Endpoint: GET {connect-producao}/api/filter

Headers:

AccessToken: {access_token}

Success Response

Status: 200 OK

{
  "header": {
    "codigo": 1,
    "msg": "ok."
  },
  "data": [
    {
      "filterId": "123",
      "filterNome": "Example Filter"
    }
  ]
}

Export Registrations

Request

Endpoint: GET {connect-producao}/api/filter/{id}/export

Headers:

AccessToken: {access_token}

Parameters:

• id (path): Filter ID
• updatedFrom (query, optional): Last update date (ISO 8601 format)
• exportAttributes (query, optional): List of attributes to export (comma-separated)

Request Example

GET {connect-producao}/api/filter/123/export?updatedFrom=2025-12-26T12:00:00&exportAttributes=FanType,RegistrationType

Success Response

Status: 200 OK

{
  "header": {
    "codigo": 1,
    "msg": "ok."
  },
  "data": {
    "total": 1000,
    "items": [
      {
        "userId": 123456,
        "cpf": "12345678900",
        "email": "user@example.com",
        "nome": "John Silva",
        "atributos": {
          "FanType": "Member",
          "RegistrationType": "Premium"
        }
      }
    ]
  }
}

Update Filter

Request

Endpoint: POST {connect-producao}/api/filter/{id}/update

Headers:

AccessToken: {access_token}
Content-Type: application/json

Parameters:

• id (path): Filter ID

Body:

{
  "configuracao": "new_configuration"
}

Success Response

Status: 200 OK

{
  "header": {
    "codigo": 1,
    "msg": "Filter updated successfully"
  }
}

Implementation Example

async function listFilters(accessToken) {
  const response = await fetch('{connect-producao}/api/filter', {
    method: 'GET',
    headers: {
      'AccessToken': accessToken
    }
  });

  if (!response.ok) {
    throw new Error(`Error ${response.status}: ${response.statusText}`);
  }

  return await response.json();
}

async function exportFilter(filterId, updatedFrom, exportAttributes, accessToken) {
  const params = new URLSearchParams();
  if (updatedFrom) params.append('updatedFrom', updatedFrom);
  if (exportAttributes) params.append('exportAttributes', exportAttributes);

  const response = await fetch(`{connect-producao}/api/filter/${filterId}/export?${params}`, {
    method: 'GET',
    headers: {
      'AccessToken': accessToken
    }
  });

  if (!response.ok) {
    throw new Error(`Error ${response.status}: ${response.statusText}`);
  }

  return await response.json();
}