> ## Documentation Index > Fetch the complete documentation index at: https://developers.useqx.com/llms.txt > Use this file to discover all available pages before exploring further. # Listar os pacotes > Lista os pacotes da organização da chave, do mais novo ao mais antigo. A lista traz os pacotes ativos e os inativos. Cada pacote traz os requisitos na ordem do pacote. ## OpenAPI ````yaml /openapi.yaml get /packs openapi: 3.1.0 info: title: QX API version: 1.0.0 description: >- A API do QX cria e lê os contatos, as coletas e os documentos da organização e lista os pacotes. Cada chamada leva a chave de API da organização. servers: - url: https://app.useqx.com/api/v1 description: Produção security: - bearerAuth: [] tags: - name: Coletas description: >- As coletas da organização. A coleta pede ao contato os documentos de um pacote. - name: Contatos description: >- As pessoas e as empresas da organização. A pessoa tem um CPF, e a empresa tem um CNPJ. - name: Documentos description: >- Os documentos da organização. O documento enviado sem coleta entra na Triagem, e o documento enviado com coleta ocupa o slot do tipo. - name: Pacotes description: Os pacotes da organização e os requisitos de cada pacote. paths: /packs: get: tags: - Pacotes summary: Listar os pacotes description: >- Lista os pacotes da organização da chave, do mais novo ao mais antigo. A lista traz os pacotes ativos e os inativos. Cada pacote traz os requisitos na ordem do pacote. operationId: listPacks parameters: - $ref: '#/components/parameters/Limit' - $ref: '#/components/parameters/Cursor' - name: active in: query description: >- Com `true`, a lista traz só os pacotes ativos. Com `false`, a lista traz só os inativos. schema: type: boolean example: true - name: kind in: query description: >- O tipo do pacote. O pacote `kyc` pede o cadastro do cliente. O pacote `operation` pede os documentos de uma operação. schema: type: string enum: - kyc - operation example: operation responses: '200': description: Uma página de pacotes. content: application/json: schema: $ref: '#/components/schemas/PackList' examples: page: summary: Uma página com um pacote de operação e um pacote de cadastro value: data: - id: pck_12 name: Importação marítima kind: operation required_for: pj active: true identification_mode: any requirements: - document_type: id: dtp_31 name: Fatura Comercial (Commercial Invoice) required: true identifier: true accepts_many: true position: 1 - document_type: id: dtp_32 name: Bill of Lading (B/L) required: true identifier: true accepts_many: false position: 2 - document_type: id: dtp_33 name: Romaneio de Carga (Packing List) required: false identifier: false accepts_many: true position: 3 - id: pck_9 name: Cadastro PJ kind: kyc required_for: pj active: true identification_mode: any requirements: - document_type: id: dtp_4 name: Contrato Social required: true identifier: false accepts_many: false position: 1 - document_type: id: dtp_7 name: Cartão CNPJ required: true identifier: false accepts_many: false position: 2 has_more: false next_cursor: null '400': $ref: '#/components/responses/BadRequest' '401': $ref: '#/components/responses/Unauthorized' '402': $ref: '#/components/responses/PaymentRequired' '403': $ref: '#/components/responses/Forbidden' '429': $ref: '#/components/responses/TooManyRequests' components: parameters: Limit: name: limit in: query description: A quantidade de itens da página, de 1 a 100. O padrão é 25. schema: type: integer minimum: 1 maximum: 100 default: 25 example: 25 Cursor: name: cursor in: query description: >- O valor de `next_cursor` da página anterior. Sem este parâmetro, a lista começa no item mais novo. schema: type: string example: WyIyMDI2LTA5LTI1VDEzOjMxOjEyLjAwMDAwMFoiLDQwXQ schemas: PackList: type: object additionalProperties: false required: - data - has_more - next_cursor properties: data: type: array items: $ref: '#/components/schemas/Pack' has_more: type: boolean description: Com `true`, a lista tem mais itens depois desta página. next_cursor: type: - string - 'null' description: >- O valor do parâmetro `cursor` para a próxima página. Na última página, o valor é `null`. Pack: type: object additionalProperties: false required: - id - name - kind - required_for - active - identification_mode - requirements properties: id: type: string pattern: ^pck_[1-9][0-9]*$ description: O id do pacote. examples: - pck_12 name: type: string description: O nome do pacote. examples: - Importação marítima kind: type: string enum: - kyc - operation description: >- O tipo do pacote. O pacote `kyc` pede o cadastro do cliente. O pacote `operation` pede os documentos de uma operação. required_for: type: string enum: - pf - pj - both description: >- O cliente que o pacote atende: `pf` para pessoa física, `pj` para pessoa jurídica e `both` para as duas. active: type: boolean description: Com `false`, o pacote está inativo. identification_mode: type: string enum: - any - all description: >- Quantos requisitos identificadores bastam para identificar a operação: `any` para qualquer um e `all` para todos. requirements: type: array description: Os requisitos do pacote, na ordem do pacote. items: $ref: '#/components/schemas/PackRequirement' Problem: type: object description: Um erro no formato da RFC 9457. required: - type - title - status - detail - code properties: type: type: string const: about:blank description: Sempre `about:blank`. title: type: string description: A frase do status HTTP, em inglês. examples: - Unauthorized status: type: integer description: O status HTTP. examples: - 401 detail: type: string description: A explicação do erro, em português. code: type: string description: O código do erro, em inglês. O código não muda entre versões da v1. PackRequirement: type: object additionalProperties: false required: - document_type - required - identifier - accepts_many - position properties: document_type: $ref: '#/components/schemas/DocumentTypeReference' required: type: boolean description: Com `true`, a coleta exige um documento deste tipo. identifier: type: boolean description: >- Com `true`, o número impresso num documento deste tipo identifica a operação. accepts_many: type: boolean description: >- Com `true`, o requisito aceita mais de um documento. Uma operação pode ter várias faturas, por exemplo. position: type: integer minimum: 1 description: A posição do requisito no pacote. A primeira posição é 1. DocumentTypeReference: type: object additionalProperties: false required: - id - name properties: id: type: string pattern: ^dtp_[1-9][0-9]*$ description: O id do tipo de documento. examples: - dtp_31 name: type: string description: O nome do tipo de documento. examples: - Fatura Comercial (Commercial Invoice) responses: BadRequest: description: Um parâmetro falta ou tem um valor inválido. content: application/problem+json: schema: allOf: - $ref: '#/components/schemas/Problem' - type: object properties: code: enum: - invalid_parameter examples: invalid_parameter: summary: O limit passa de 100 value: type: about:blank title: Bad Request status: 400 detail: O parâmetro limit tem um valor inválido. code: invalid_parameter Unauthorized: description: A chave falta, não existe ou está revogada. headers: WWW-Authenticate: $ref: '#/components/headers/WwwAuthenticate' content: application/problem+json: schema: allOf: - $ref: '#/components/schemas/Problem' - type: object properties: code: enum: - unauthorized examples: unauthorized: summary: A chave falta ou não vale value: type: about:blank title: Unauthorized status: 401 detail: >- A chamada não trouxe uma chave de API válida. Envie a chave no cabeçalho Authorization, no formato Bearer . code: unauthorized PaymentRequired: description: A assinatura da organização está bloqueada. content: application/problem+json: schema: allOf: - $ref: '#/components/schemas/Problem' - type: object properties: code: enum: - subscription_blocked examples: subscription_blocked: summary: A assinatura está bloqueada value: type: about:blank title: Payment Required status: 402 detail: >- A assinatura da organização está bloqueada. Regularize o pagamento no QX para usar a API. code: subscription_blocked Forbidden: description: >- A organização está arquivada, ou o plano da organização não inclui a API. content: application/problem+json: schema: allOf: - $ref: '#/components/schemas/Problem' - type: object properties: code: enum: - organization_archived - plan_required examples: plan_required: summary: O plano gratuito não inclui a API value: type: about:blank title: Forbidden status: 403 detail: >- O plano gratuito não inclui a API. Assine um plano pago no QX para usar a API. code: plan_required TooManyRequests: description: A chave ou o endereço IP passou de um limite. headers: Retry-After: $ref: '#/components/headers/RetryAfter' content: application/problem+json: schema: allOf: - $ref: '#/components/schemas/Problem' - type: object properties: code: enum: - rate_limited - daily_limit_reached - too_many_invalid_keys examples: rate_limited: summary: A chave passou do limite por minuto value: type: about:blank title: Too Many Requests status: 429 detail: >- A chave passou de um limite por minuto. Espere os segundos do cabeçalho Retry-After e chame de novo. code: rate_limited headers: WwwAuthenticate: description: O esquema de autenticação que a API espera. required: true schema: type: string example: Bearer realm="QX API" RetryAfter: description: Os segundos de espera antes da próxima chamada. required: true schema: type: integer minimum: 1 securitySchemes: bearerAuth: type: http scheme: bearer description: >- A chave de API da organização, no cabeçalho `Authorization: Bearer `. A chave começa com `qx_`. ````