API Reference
  1. API Pública Soft CS
  2. Contratos

Listar contratos

get
https://admin.softcs.com.br/api/public/v1/contracts

Retorna uma página countless de contratos. Use limit e offset para paginação e combine os filtros disponíveis para restringir os resultados.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
string
length ≥ 1

Busca textual ampla sobre os principais campos da entidade.

string
length ≥ 1

Nome do registro.

string
length ≥ 1

ID externo usado pela integração.

string

Status atual do registro.

string

Ciclo de cobrança do contrato.

boolean | null

Indica se o contrato deve ser renovado automaticamente.

number | null
≥ 0

MRR mínimo para filtrar contratos.

number | null
≥ 0

MRR máximo para filtrar contratos.

string
length ≥ 1

Data inicial mínima para filtrar a listagem.

string
length ≥ 1

Data inicial máxima para filtrar a listagem.

string
length ≥ 1

Data final mínima para filtrar a listagem.

string
length ≥ 1

Data final máxima para filtrar a listagem.

string
enum

Campo usado para ordenar a listagem.

Allowed:
string
enum

Direção da ordenação. Use asc ou desc.

Allowed:
string
required
length ≥ 1
string
required
length ≥ 1
integer
1 to 200

Quantidade máxima de itens retornados. Máximo permitido: 200.

integer | null
0 to 10000

Posição inicial da página. Máximo permitido: 10000.

Responses

Updated about 1 month ago

Did this page help you?
Language
Credentials
OAuth2
Missing 1 required scope
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated about 1 month ago

Did this page help you?