Jump to

• Request
• Response
• Examples

Get a space

get

/swm/rs/v1/spaces/{spaceId}

Get information for an existing space.

If the space is Private, the API user must be a member of the space, but not necessarily the space creator (owner).

To retrieve the content in a space (products and comments), use the Content API.

Request

Supported Media Types

• application/json

Path Parameters

• spaceId: string
  ID of the space resource

Back to Top

Response

Supported Media Types

• application/json; charset=UTF-8

200 Response

space resource found

404 Response

space resource not found

Back to Top

Examples

Sample Request:

       GET swm/rs/v1/spaces/7go4VjU2dK5MkTfHWQHV1l39    

Sample Response:

       {"response":{"code":"200.0","developerMessage":"space resource found" },
        "spaceId":"7go4VjU2dK5MkTfHWQHV1l39",
        "spaceName":"New Example Space",
        "spaceDescription":"Items for kids play room",
        "siteName":"Sample Site",
        "accessLevel":"0",
        "creatorId":"nNGCePPATZMzzpCm",
        "creatorFirstName":"John",
        "creatorLastName":"Doe"
       }    

Possible Error Codes:

       {
          "code":"404.0","developerMessage":"space resource not found",
          "code":"403.1","developerMessage":"not space memeber"
       }    

Back to Top