GET /api/:space/members/memberRef/:memberRefId

Description:

Returns Member details for the identifier specified.

Resource URL:

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

Request headers

KeyValueRequired
X-API-KEY
Your unique API keyYes
Content-Type
application/jsonYes

Request URL parameters

Parameter
Type
Required
Description
space
StringYesThis is the space name which is linked to the account
memberRefId
StringYesThe reference id to this member in your system

EXAMPLE

Request
curl
--header "X-API-KEY: <your-api-key>"
--request GET https://app.competitionlabs.com/api/<your-space-name>/members/memberRef/test-0sn4DmUBkPH_lz9GgxBM
Response
{
    "data": {
        "jsonClass": "Member",
        "accountId": "0sn4DmUBkPH_lz9GgxBM",
        "memberType": "Individual",
        "name": "test",
        "memberRefId": "test-0sn4DmUBkPH_lz9GgxBM",
        "groups": [
            "CL"
        ],
        "timeZoneOffset": 0.0,
        "created": "2019-05-20T10:30:56.990+0000",
        "id": "1cfL1GoBy9ZNBO19Vk_e"
    }
}

ERROR CODES

CodeHTTP StatusDescriptionExample
1007404No Member Ref Id was inserted in the Request URL
Error Response 404
{
    "errors": [
        {
            "message": "A record with requested id was not found.",
            "code": 1007,
            "status": 404
        }
    ]
}
10404Member Ref Id was not found
Error Response 404
{
    "errors": [
        {
            "message": "The reference was not found.",
            "code": 10,
            "status": 404
        }
    ]
}

404The Request URL was edited 
Error Response 404
{
    "status": 404
}