GET/api/suppliers/search

Buscar Fornecedores

Busca fornecedores

Access Token

Para realizar requisições GET, POST, PUT, DELETE e PATCH nos endpoints da API você precisa de uma chave de autorização. Chamamos essa chave de accessToken.

Para ter acesso ao accessToken, é necessário que o usuário master da licença efetue a liberação deste pela interface do ImageMais Clinic. O accessToken tem validade de 1 hora.

Headers

AuthorizationOBRIGATÓRIO
Tipo:string
Token de autenticação no formato Bearer {accessToken}

Parâmetros

limitOPCIONAL
Tipo:number
Limite de fornecedores a serem retornados

Este parâmetro define o número máximo de fornecedores que serão retornados na resposta. É um parâmetro opcional que permite controlar a paginação dos resultados.

Exemplo:

?limit=10

Atenção: Caso o limite exceda o número 100, a API retornará um erro 400 Bad Request com a mensagem: "limit must not be greater than 100".

offsetOPCIONAL
Tipo:number
Offset de fornecedores a serem retornados

Este parâmetro define o número de fornecedores que serão ignorados antes de começar a retornar os resultados. É um parâmetro opcional que permite controlar a paginação dos resultados, geralmente usado em conjunto com o parâmetro limit.

Exemplo:

?offset=0

Observação: O valor padrão do offset é 0. Para paginar os resultados, você pode usar combinações como ?limit=10&offset=0 para a primeira página, ?limit=10&offset=10 para a segunda página, e assim por diante.

nameOPCIONAL
Tipo:string
Pesquisar por nome do fornecedor

Este parâmetro permite filtrar os fornecedores pelo nome. A busca é realizada de forma parcial, ou seja, retornará todos os fornecedores cujo nome contenha o texto informado.

Exemplo:

?name=ImageMais

Observação: A busca por nome é case-insensitive (não diferencia maiúsculas de minúsculas) e pode ser combinada com outros parâmetros como limit e offset para paginar os resultados filtrados.

Request URL

https://api-dev.imagemais.com/api/suppliers/search?limit=10&offset=0&name=ImageMais

Respostas

[
  {
    "id": 3,
  ...
[
  {
    "id": 3,
    "name": "ImageMais",
    "accountId": 1,
    "createdAt": "2025-08-04T13:31:33.762Z",
    "updatedAt": "2025-08-11T10:07:17.052Z",
    "deletedAt": null
  }
]
{
  "message": "limit must not be greater than 100",
  "error": "Bad Request"
  ...
{
  "message": "limit must not be greater than 100",
  "error": "Bad Request"
}
{
  "statusCode": 401,
  "message": "invalid token"
  ...
{
  "statusCode": 401,
  "message": "invalid token"
}
{
  "statusCode": 401,
  "message": "jwt expired"
  ...
{
  "statusCode": 401,
  "message": "jwt expired"
}
{
  "statusCode": 500,
  "message": "Internal server error"
  ...
{
  "statusCode": 500,
  "message": "Internal server error"
}