POST /api/:space/members/post

Description:

Retrieve a member or a list of members from CompetitionLabs database by unique member ID's or any other Post body parameters using the POST method. 

Inserting a list of Id's or any other parameter must be comma ( , ) separated without any spaces

Resource URL:

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

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

Additional Query String Parameters

You can use the POST body parameters along with "_skip", "_limit" and "_sortByFields" generic parameters.

Post body parameters

Parameter
Type
Required
Description
memberType
EnumOptionalType of member, accepted values: Individual, Team
name
StringOptionalDisplay name of the member you want to create
memberRefId
StringOptionalMember id on customer system
groups
Array [String]OptionalGroup to which a member might belong
metadata
Array [Object]OptionalA list of MetaData
created
DateTimeOptionalISO8601 timestamp for when a Member was created. All records are stored in UTC time zone.
id
StringOptionalMember identifier retrieved from GET Members resource


EXAMPLE

Request with Id parameters
curl
--header "X-API-KEY: <your-api-key>"
--header "Content-Type: application/json"
--request POST https://app.competitionlabs.com/api/<your-space-name>/members/post
-d '{"id": "vnhtpWUB8HzUh8MGm3Ae,kz4STWUBeag0_3vrTqk-"}'
Response for Id parameter request
{
    "meta": {
        "totalRecordsFound": 2,
        "skip": 0,
        "limit": 20
    },
    "data": [
        {
            "jsonClass": "Member",
            "accountId": "QmTaPGUBsZyUBGOR_u9A",
            "memberType": "Individual",
            "memberRefId": "member14",
            "timeZoneOffset": 0,
            "created": "2018-09-04T16:32:28.446+00:00",
            "id": "vnhtpWUB8HzUh8MGm3Ae"
        },
        {
            "jsonClass": "Member",
            "accountId": "QmTaPGUBsZyUBGOR_u9A",
            "memberType": "Individual",
            "name": "test",
            "memberRefId": "member1",
            "groups": [],
            "timeZoneOffset": 0,
            "created": "2018-08-18T12:46:09.982+00:00",
            "id": "kz4STWUBeag0_3vrTqk-"
        }
    ]
}

ERROR CODES

CodeHTTP StatusDescriptionExample

503An array was sent
Error Response 503
{
    "status": 503
}

404The request URL was modified
Error Response 404
{
    "status": 404
}