Get API key

    Reference/Agents

    GET/v1/agents/:id

    Get one agent

    Put the agent id in the URL where you see :id.

    Full URL

    GET https://api.tryleadreach.com/v1/agents/:id

    Headers

    • X-Api-Key (required): your API key from the app Keys tab.

    Path params (in the URL)

    NameTypeRequiredMeaning
    iduuidYesThe agent's id (from Create agent or List agents).

    Query params (after ?)

    None

    Request body (JSON)

    None

    Example request (JSON)

    What you send: headers, and path / query / body when used.

    {
      "headers": {
        "X-Api-Key": "lr_your_key_here"
      },
      "path": {
        "id": "a1111111-1111-1111-1111-111111111111"
      }
    }

    Example response (JSON)

    Typical successful response shape.

    {
      "id": "a1111111-1111-1111-1111-111111111111",
      "name": "Outbound",
      "status": "active",
      "campaignId": "c1111111-1111-1111-1111-111111111111"
    }

    Response

    The agent object, or 404 if it is not in your workspace.

    Credits

    0