---
agentTools:
  projectIndex: https://partnerhubapi.stone.com.br/llms.txt
---

# Consulta Segmentos CPF

Lista os seguimentos disponíveis para operação com CPF

## Estrutura Principal do Response

| Campo     | Tipo      | Descrição                                |
| :-------- | :-------- | :--------------------------------------- |
| `success` | `boolean` | Indica se a requisição foi bem-sucedida. |
| `data`    | `object`  | Objeto que contém os dados da resposta.  |

***

## Estrutura do Objeto `data`

| Campo         | Tipo     | Descrição                                              |
| :------------ | :------- | :----------------------------------------------------- |
| `id`          | `string` | O identificador único do recurso criado ou retornado.  |
| `description` | `string` | Uma mensagem descritiva sobre o resultado da operação. |

# OpenAPI definition

```json
{
  "openapi": "3.1.0",
  "info": {
    "title": "Partner Hub API",
    "version": "1.0"
  },
  "servers": [
    {
      "url": "https://partnerhub-sdx-external-api.stone.com.br"
    }
  ],
  "components": {
    "securitySchemes": {
      "sec0": {
        "type": "apiKey",
        "name": "Authorization",
        "in": "header",
        "x-bearer-format": "bearer"
      }
    }
  },
  "security": [
    {
      "sec0": []
    }
  ],
  "paths": {
    "/affiliates/segments": {
      "get": {
        "summary": "Consulta Segmentos CPF",
        "description": "Lista os seguimentos disponíveis para operação com CPF",
        "operationId": "get-cpf-segments",
        "responses": {
          "200": {
            "description": "200",
            "content": {
              "application/json": {
                "examples": {
                  "Result": {
                    "value": "{\n  \"success\": true,\n  \"data\": {\n    \"id\": \"string\",\n    \"description\": \"string\"\n  }\n}"
                  }
                },
                "schema": {
                  "type": "object",
                  "properties": {
                    "success": {
                      "type": "boolean",
                      "example": true,
                      "default": true
                    },
                    "data": {
                      "type": "object",
                      "properties": {
                        "id": {
                          "type": "string",
                          "example": "string"
                        },
                        "description": {
                          "type": "string",
                          "example": "string"
                        }
                      }
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "401",
            "content": {
              "application/json": {
                "examples": {
                  "Result": {
                    "value": "{\n  \"success\": false,\n  \"error\": \"Unauthorized\"\n}"
                  }
                },
                "schema": {
                  "type": "object",
                  "properties": {
                    "success": {
                      "type": "boolean",
                      "example": false,
                      "default": true
                    },
                    "error": {
                      "type": "string",
                      "example": "Unauthorized"
                    }
                  }
                }
              }
            }
          },
          "500": {
            "description": "500",
            "content": {
              "application/json": {
                "examples": {
                  "Result": {
                    "value": "{\n  \"success\": false,\n  \"error\": \"INTERNAL_SERVER_ERROR\"\n}"
                  }
                },
                "schema": {
                  "type": "object",
                  "properties": {
                    "success": {
                      "type": "boolean",
                      "example": false,
                      "default": true
                    },
                    "error": {
                      "type": "string",
                      "example": "INTERNAL_SERVER_ERROR"
                    }
                  }
                }
              }
            }
          }
        },
        "deprecated": false
      }
    }
  },
  "x-readme": {
    "headers": [],
    "explorer-enabled": true,
    "proxy-enabled": true
  },
  "x-readme-fauxas": true,
  "_id": "66fdc0f9b9c59e006159f051:689639a66173f98585c41d9e"
}
```