Measure MapAPI
Help CenterGet an API key

List guests

GET/guests
guests:read Open GuestSince v2

Your Open Guest leads, one per guest project: who the guest was, the message they left, and whether they have asked for your estimate. Most recently opened first, a page at a time.

Returns people's contact details, so it needs Guests: read, which a key only has when it was chosen for it.

Query parameters

  • pageinteger
    The page to read, starting at 1.
    Default1≥ 1
  • limitinteger
    How many guests a page holds. At most 200; a larger number is read as 200.
    Default501 to 200

Responses

  • A list ofGuestLead:

    • typestringrequired
      Always"guest"
    • projectIdstringrequired
    • projectNamestring
    • namestring
      The guest's name, as they gave it. Empty when they gave none.
    • emailstring
    • phonestring
    • messagestring
      What they wrote when they asked for the estimate.
    • createdOninteger(int64)
    • lastOpenedOninteger(int64)
    • estimateRequestedboolean
      Whether they have finished measuring and asked for your estimate.
    • estimateRequestedOninteger(int64)
      When they asked; 0 when they have not.
    • totalPolygonsinteger
    • totalSpotsinteger
    • thumbnailUrlstring

Errors

A failed request answers with one of these, in an Error body.

400pagination_invalid_page_limitThe limit query parameter is missing or not a number above 0.
400pagination_invalid_page_numberThe page query parameter is missing or not a number.
403insufficient_scopeThe key does not have the access this endpoint needs. Create a key with that access.
403invalid_api_keyNo key was sent in the Authorization header, or the key is unknown, revoked, or past the time it kept working after being replaced.
403scope_not_in_planYour plan does not include this endpoint, for example members on Open Guest.
403subscription_expiredYour subscription is not active. Update your payment method in the app.

Try it

This key is

The key stays in this tab and goes only to the API. Use a sandbox key while you try things: requests are real, and what they change is changed.

GET https://api.measuremaponline.com/api/v2/guests

Fill in your API key to send.

As a cURL command
Shell
curl 'https://api.measuremaponline.com/api/v2/guests' \
  -H "Authorization: $MMO_API_KEY"