v1

latestOpenAPI 3.0.12026-07-245303882.5 MB

Participants

Lista as detentoras participantes do ITP.

Método para retornar a lista de detentoras participantes do ITP. O retorno é paginado e pode ser filtrado pelo nome da detentora.

get/baas/v1/open/itp/participants/brands

Query parameters

pageinteger

Example:123

Page number.

pageSizeinteger

Example:123

Size of a page.

searchstring

Search text.

searchFieldsstring

Fields for searching.

sortstring

Sorted fields.

apiFamilyTypestring

Api Family Type

flagsstring

Flags

priorityIds[]string[]

List of priority ids.

Response

Retorna a lista de detentoras com paginação.

Example response

{
  "data": [
    {
      "createdAt": "2024-01-01T20:32:44.581Z",
      "updatedAt": "2024-01-01T20:32:44.581Z",
      "deletedAt": "2024-01-01T20:32:44.581Z",
      "settings": {
        "brandId": "66f4d9e296f18bc4606e1618",
        "sandboxUsersTests": [
          {
            "username": "usuario_teste",
            "password": "senha1234",
            "document": {
              "identification": "11122233344",
              "rel": "CPF"
            }
          }
        ],
        "updatedAt": "2024-09-26T03:51:03.642Z",
        "uptimeStatus": "OPERATIONAL",
        "id": "66f4da2796f18bc4606e2b87"
      }
    }
  ],
  "meta": {
    "total": 12,
    "page": 1,
    "pageSize": 10,
    "totalPages": 2
  }
}