Sample - GET /api/:space/members/sample

Description:

Returns a sample list of Members.

Resource URL:

https://<apphost>.competitionlabs.com/api/<your-space-name>/members/sample

Request headers

Key	Value	Required
X-API-KEY	Your unique API key	Yes
Content-Type	application/json	Yes

Request URL parameters

Parameter	Type	Required	Description
space	String	Yes	This is the space name which is linked to the account

EXAMPLE

Request

curl
--header "X-API-KEY: <your-api-key>"
--request GET https://app.competitionlabs.com/api/<your-space-name>/members/sample

Response

{
    "data": [
        {
            "jsonClass": "Member",
            "accountId": "AVXKOS4xHz_hNiERp3xj",
            "memberType": "Individual",
            "name": "France Andrade",
            "memberRefId": "ex-mem-ref-sample-id-3",
            "groups": [
                "G1",
                "G2"
            ],
            "metadata": [
                {
                    "jsonClass": "Metadata",
                    "key": "k1",
                    "value": [
                        "k1v1",
                        "k1v2"
                    ]
                },
                {
                    "jsonClass": "Metadata",
                    "key": "k2",
                    "value": [
                        "k2v1",
                        "k2v2"
                    ]
                }
            ],
            "created": "2016-07-08T11:16:32.945+00:00",
            "id": "AVXfxytXHz_hNiERp35j"
        },
        {
            "jsonClass": "Member",
            "accountId": "AVXKOS4xHz_hNiERp3xj",
            "memberType": "Individual",
            "name": "France Andrade",
            "memberRefId": "ex-mem-ref-sample-id-3",
            "groups": [
                "G1",
                "G2"
            ],
            "metadata": [
                {
                    "jsonClass": "Metadata",
                    "key": "k1",
                    "value": [
                        "k1v1",
                        "k1v2"
                    ]
                },
                {
                    "jsonClass": "Metadata",
                    "key": "k2",
                    "value": [
                        "k2v1",
                        "k2v2"
                    ]
                }
            ],
            "created": "2016-07-08T11:16:32.945+00:00",
            "id": "AVXfxytXHz_hNiERp35k"
        },
        {
            "jsonClass": "Member",
            "accountId": "AVXKOS4xHz_hNiERp3xj",
            "memberType": "Individual",
            "name": "France Andrade",
            "memberRefId": "ex-mem-ref-sample-id-3",
            "groups": [
                "G1",
                "G2"
            ],
            "metadata": [
                {
                    "jsonClass": "Metadata",
                    "key": "k1",
                    "value": [
                        "k1v1",
                        "k1v2"
                    ]
                },
                {
                    "jsonClass": "Metadata",
                    "key": "k2",
                    "value": [
                        "k2v1",
                        "k2v2"
                    ]
                }
            ],
            "created": "2016-07-08T11:16:32.945+00:00",
            "id": "AVXfxytXHz_hNiERp35l"
        }
    ]
}

ERROR CODES

Code	HTTP Status	Description	Example
1007	404	A record with requested id for products was not found	Error Response 404 Expand source { "errors": [ { "message": "A record with requested id was not found.", "code": 1007, "status": 404 } ] }