Get a project

GET/projects/{pid}

One project's details. Its measurements come from Get a project's measurements.

Request

curl 'https://api.measuremaponline.com/api/v1/projects/Xr7Lp2Qm9KdT4wZs' \
  -H "Authorization: $MMO_API_KEY"

Response

{
  "type": "project",
  "id": "Xr7Lp2Qm9KdT4wZs",
  "creatorUid": "m3K8qZxLpV4NrT2w",
  "folderId": "fld_8Jk2LmQ4",
  "name": "14 Harbour Road",
  "createdOn": 1791980000000,
  "description": "Front and back lawns, quote by Friday",
  "thumbnailUrl": "https://storage.googleapis.com/example/thumbnails/Xr7Lp2Qm9KdT4wZs.png",
  "totalPolygons": 3,
  "totalSpots": 1,
  "members": [
    "m3K8qZxLpV4NrT2w"
  ],
  "commentsEnabled": true,
  "defaultProductId": "prd_Lw7Qm2Xc"
}

Path parameters

pidstringrequired
The project's ID, the part after /p/ in its address in the app.

Responses

Project:
- typestringrequired
  Always"project"
- idstringrequired
  The project's ID.
- creatorUidstringrequired
  The account that owns the project.
- folderIdstringor null
  The folder it is filed in; empty or absent at the top level.
- namestringrequired
- descriptionstring
- createdOninteger(int64)required
  When it was created, in milliseconds since 1 January 1970 (UTC).
- thumbnailUrlstring(uri)
  A picture of the project's map, when one has been drawn.
- totalPolygonsinteger
  How many areas and lines it holds.
- totalSpotsinteger
  How many spots it holds.
- membersarray of string
  The accounts that can open it, its owner included.
- commentsEnabledboolean
  Whether comments can be left on its map.
- defaultProductIdstring
  The product new shapes start with.

Errors

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

400invalid_project_idThe project or folder ID in the path is missing or blank.

401unauthorized_actionThe item is not on your account or your members', the request came from a web page on a website the key does not allow, or the action is not allowed for this person.

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.

404project_not_foundThe project does not exist.

Try it

API key

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.

pid required

GET https://api.measuremaponline.com/api/v1/projects/Xr7Lp2Qm9KdT4wZs

Fill in your API key to send.

As a cURL command

Shell

curl 'https://api.measuremaponline.com/api/v1/projects/Xr7Lp2Qm9KdT4wZs' \
  -H "Authorization: $MMO_API_KEY"