Buscar Participantes por Companhia Produtora

Descrição: Busca participantes associados a uma Companhia Produtora específica.

Endpoint

GET/api/v1/integration/guest-users/-/producers/{producer_id}

Regras

Atributos	Descrição	Tipo	Obrigatório	Validações
producer_id	Identificador da Companhia Produtora	UUID	Sim	-

Exemplo de Requisição

cURL

curl -X GET \
  -H "Authorization: {SUA_API_KEY}" \
  "https://api.merx.tech/api/v1/integration/guest-users/-/producers/{producer_id}"

Java

import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://api.merx.tech/api/v1/integration/guest-users/-/producers/{producer_id}"))
    .header("Authorization", "{SUA_API_KEY}")
    .GET()
    .build();

HttpClient client = HttpClient.newHttpClient();
try {
    HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
    System.out.println(response.body());
} catch (Exception e) {
    e.printStackTrace();
}

JavaScript

const response = await fetch(
  'https://api.merx.tech/api/v1/integration/guest-users/-/producers/{producer_id}',
  {
    method: 'GET',
    headers: {
      'Authorization': '{SUA_API_KEY}',
    },
  }
);
const data = await response.json();
console.log(data);

Python

import requests

url = "https://api.merx.tech/api/v1/integration/guest-users/-/producers/{producer_id}"

headers = {
    "Authorization": "{SUA_API_KEY}",
}

response = requests.get(url, headers=headers)
print(response.json())

SDK Java

import com.merx.sdk.api.MerxClient;
import com.merx.sdk.core.Environment;
import java.util.UUID;

MerxClient merx = MerxClient.builder()
    .apiKey("{SUA_API_KEY}")
    .environment(Environment.SANDBOX)
    .build();

var guests = merx.guestUsers().findByProducer(UUID.fromString("00000000-0000-0000-0000-000000000000"));

Parâmetros

Parâmetros de Caminho:

Nome	Descrição	Tipo	Obrigatório
producer_id	Identificador da Companhia Produtora	String	Sim

Parâmetros de Cabeçalho

Nome	Descrição	Tipo	Obrigatório
Authorization	Chave de API obtida via support-api@merx.tech	String	Sim

Respostas

• 200 - Ok

[
    {
        "id": "string",
        "name": "string",
        "identity_card": "string",
        "email": "string",
        "social_security": "string",
        "phone": "string",
        "sign_as": "string",
        "default_signer": true,
        "auth": "string",
        "marital_status": "string",
        "company_id": "string",
        "address_id": "string",
        "enabled": true,
        "removed": false,
        "created_at": 1709837511.870898,
        "updated_at": 1709837511.870898
    }
]

O endpoint devolve sempre um array — vazio quando a Companhia Produtora não tem guest users vinculados. Campos sem valor são omitidos da resposta.

O endereço não vem resolvido nesta listagem

Cada item traz apenas address_id. O objeto address completo é montado somente pela consulta por identificador (GET /api/v1/integration/guest-users/{guest_user_id}). Não itere item.address a partir desta resposta: para obter o endereço, chame a consulta por identificador de cada guest user.

• 400 - Bad Request

{
  "messages": ["message.entidade.campo-inválido"]
}

• 401 - Unauthorized

• 404 - NotFound