Members

In the Cevoid platform, a member is the most important part of your community. Members include customers, influencers, brand ambassadors, your own teammates, and other creators. On this page, you’ll learn about the different member endpoints you can use to manage members programmatically. We’ll also explore how to query, create, update, and delete members.

The member model

The member model contains all the information about your members, such as their username, avatar, and email.

Properties

Name
shortId
Type
string
Description
Unique identifier for the member.
Name
name
Type
string
Description
The name of the member.
Name
email
Type
string
Description
The email address of the member.
Name
avatarUrl
Type
string
Description
The avatar image URL for the member.
Name
firstName
Type
string
Description
The first name of the member.
Name
lastName
Type
string
Description
The last name of the member.
Name
bio
Type
string
Description
The bio of the member.
Name
country
Type
string
Description
The country of the member. This is a two-letter country code.
Name
language
Type
string
Description
The language of the member. This is a two-letter language code.
Name
location
Type
string
Description
The location of the member.
Name
socialInstagramHandle
Type
string
Description
The Instagram handle of the member.
Name
notes
Type
string
Description
If you have any notes about the member, they will be available here.
Name
updatedAt
Type
timestamp
Description
Timestamp of when the member was last updated.
Name
createdAt
Type
timestamp
Description
Timestamp of when the member was created.

GET/v1/members

List all members

This endpoint allows you to retrieve a paginated list of all your members. By default, a maximum of ten members are shown per page.

Optional attributes

Name
skip
Type
integer
Description
Define the number of members to skip.
Name
limit
Type
integer
Description
Limit the number of members returned.

Request

GET

/v1/contacts

curl -G https://api.cevoid.com/v1/members \
  -H "x-api-key: {key}" \
  -d limit=10

Response

{
  "has_more": false,
  "data": [
    {
      "shortId": "m-WAz8eIbvDR60rouK",
      "name": "FrankMcCallister",
      "email": "frank.mccallister@cevoid.com",
      "avatarUrl": "https://assets.cevoid.com/avatars/frank.jpg",
      "firstName": "Frank",
      "lastName": "McCallister",
      "updatedAt": 705103200,
      "createdAt": 692233200
    },
    {
      "shortId": "m-hSIhXBhNe8X1d8Et"
      // ...
    }
  ]
}