Get members

GET

members

Get members

curl --request GET \
  --url https://api.cevoid.com/v1/members \
  --header 'x-api-key: <api-key>'

{
  "count": 123,
  "next": "<string>",
  "nodes": [
    {
      "id": "member_abc123def456",
      "shortId": "mem_5a8b9c",
      "createdAt": "2024-01-15T09:30:00.000Z",
      "updatedAt": "2024-01-20T14:22:15.000Z",
      "name": "Sarah Johnson",
      "email": "[email protected]",
      "avatarUrl": "https://cdn.cevoid.com/avatars/member123/profile.jpg",
      "country": "US",
      "language": "en",
      "location": "San Francisco, CA",
      "socialInstagramHandle": "sarah.lifestyle",
      "bio": "Lifestyle blogger and photography enthusiast",
      "notes": "VIP customer, prefers email communication"
    }
  ]
}

Authorizations

x-api-key

string

header

required

Query Parameters

limit

number

default:25

Max value for limit is 25

Required range: 1 <= x <= 25

Example:

10

skip

number | null

default:0

Number of items to skip

Required range: x >= 0

Example:

0

market

string

Market ID or shortId for localized content

Example:

"us"

Response

Successful response

count

number

required

Total number of items

string | null

required

URL for next page

nodes

object[]

required

Show child attributes

nodes.id

string

required

Unique identifier for the member within the Cevoid system

Example:

"member_abc123def456"

nodes.shortId

string

required

Shortened, human-readable identifier for the member, often used in URLs and public references

Example:

"mem_5a8b9c"

nodes.createdAt

string

required

ISO 8601 timestamp indicating when the member account was first created in the system

Example:

"2024-01-15T09:30:00.000Z"

nodes.updatedAt

string

required

ISO 8601 timestamp indicating when the member was last updated

Example:

"2024-01-20T14:22:15.000Z"

nodes.name

string

Display name or full name of the member as provided during registration or profile updates

Example:

"Sarah Johnson"

nodes.email

string

Email address associated with the member account, used for communication and authentication

Example:

"[email protected]"

nodes.avatarUrl

string

URL to the member's profile picture or avatar image

Example:

"https://cdn.cevoid.com/avatars/member123/profile.jpg"

nodes.country

string

ISO 3166-1 alpha-2 country code representing the member's country of residence

Example:

"US"

nodes.language

string

ISO 639-1 language code representing the member's preferred language for communications

Example:

"en"

nodes.location

string

Geographic location information such as city, state, or region provided by the member

Example:

"San Francisco, CA"

Instagram username/handle associated with the member's social media account, without the @ symbol

Example:

"sarah.lifestyle"

nodes.bio

string

Biography or description provided by the member

Example:

"Lifestyle blogger and photography enthusiast"

nodes.notes

string

Internal notes about the member for company reference

Example:

"VIP customer, prefers email communication"

Get market by IDRetrieve a specific market by its ID or shortId

⌘I

Get members

curl --request GET \
  --url https://api.cevoid.com/v1/members \
  --header 'x-api-key: <api-key>'

{
  "count": 123,
  "next": "<string>",
  "nodes": [
    {
      "id": "member_abc123def456",
      "shortId": "mem_5a8b9c",
      "createdAt": "2024-01-15T09:30:00.000Z",
      "updatedAt": "2024-01-20T14:22:15.000Z",
      "name": "Sarah Johnson",
      "email": "[email protected]",
      "avatarUrl": "https://cdn.cevoid.com/avatars/member123/profile.jpg",
      "country": "US",
      "language": "en",
      "location": "San Francisco, CA",
      "socialInstagramHandle": "sarah.lifestyle",
      "bio": "Lifestyle blogger and photography enthusiast",
      "notes": "VIP customer, prefers email communication"
    }
  ]
}

Core Concepts

Posts

Markets

Members

Authorizations

Query Parameters

Response