API Reference / Lead Sources

GET /lead_sources/{lead_source_id}

Get a specific lead source

Returns one lead source with its contact counts. The path id is the source's system_id — the value contacts carry in their lead_source field — which is separate from the record's internal id. Built-in sources use short slugs like advertisement; ones you create get an ObjectId-style id.

Path parameters

Name Type Description
lead_source_id req string Lead Source ID

Responses

200 OK
  • statusintegerint32

    Response code

  • messagestring

    Response message

  • timestampintegerunix-timestamp

    Response time

  • dataobject

    A way to classify the source of any contact that is added to OnePageCRM. Like Statuses, this list is pre-populated, and can be later edited to fit individual needs.

    object fields →
    • idstring

      ID of the lead source

    • textstringrequired

      Description of the lead source

    • countsintegerint32

      Number of contacts the (logged API) user owns, with the lead source

    • total_countintegerint32

      Number of contacts the entire team owns, with the lead source

    • action_stream_countintegerint32

      Number of contacts the (logged API) user has actions with, who also have the lead source

    • team_countsarray<object>

      Number of contacts, with the lead source (for each team member)

      array item fields →
      • user_idstringbson-id

        ID of the user

      • countsintegerint32

        Number of contacts the team member owns, with the lead source

Standard error responses: 400 · 401 · 403 · 404 · 409 · 500 — shared across the API. See Errors.

Related guides