Skip to content

UTM

UTM attribution lookup and write endpoints

Operations

List UTM attribution records

Request

Retrieve a keyset-paginated list of UTM attribution records for the account. Filter by appointmentId or selfSchedulingAttemptId to fetch a single record's attribution, or by capture-date range and funnel stage for bulk pulls. Returns an empty list (not 404) when nothing matches.

Security
PartnerApiKey and PartnerOAuth
Query
appointmentIdinteger, (int64)

Filter to the UTM attributed to this appointment

Example:appointmentId=12345
selfSchedulingAttemptIdinteger, (int64)

Filter to the UTM captured on this self-scheduling attempt

Example:selfSchedulingAttemptId=678
startDatestring

Start of UTM capture-date range (ISO 8601)

Example:startDate=2025-01-01T00:00:00Z
endDatestring

End of UTM capture-date range (ISO 8601)

Example:endDate=2025-01-31T23:59:59Z
stagestring(?i)CONVERTED|LANDED

Filter by funnel stage: CONVERTED (appointment-linked) or LANDED (attempt-only)

Enum:"CONVERTED""LANDED"
sortDirstring(?i)ASC|DESC

Sort direction (by capture date); newest first by default

Default:"DESC"
Enum:"ASC""DESC"
cursorstring, [ 0 .. 2048 ] characters

Pagination cursor from previous response

limitinteger, (int32), [ 1 .. 1000 ]

Number of results per page (max 1000)

Default:20
Example:limit=20
curl -i -X GET \
  'https://api-docs.lobbie.com/_mock/openapi/partner/v2/account/{accountId}/utm?appointmentId=12345&selfSchedulingAttemptId=678&startDate=2025-01-01T00%3A00%3A00Z&endDate=2025-01-31T23%3A59%3A59Z&stage=CONVERTED&sortDir=ASC&cursor=string&limit=20' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'x-api-key: YOUR_API_KEY_HERE'

Responses

UTM records retrieved successfully

Bodyapplication/json
nextCursorstring

Opaque cursor for fetching the next page. Null if no more results.

utmsArray of objects(PartnerUtmDTO)

UTM records in this page

Response
{
  "nextCursor": "string",
  "utms": [
    { … }
  ]
}