Members

Get members

Retrieve all members with optional pagination

GEThttps://api.cevoid.com/v1/members

Request

curl 'https://api.cevoid.com/v1/members' \
  -H "x-api-key: ${CEVOID_API_KEY}"

fetch("https://api.cevoid.com/v1/members", {
  headers: {
    "x-api-key": process.env.CEVOID_API_KEY,
  },
})
  .then((response) => response.json())
  .then((data) => console.log(data))

const response = await fetch("https://api.cevoid.com/v1/members", {
  headers: {
    "x-api-key": process.env.CEVOID_API_KEY,
  },
})
if (!response.ok) throw new Error(`Request failed: ${response.status}`)
const data = await response.json()
console.log(data)

import os

import requests

response = requests.get(
    "https://api.cevoid.com/v1/members",
    headers={
        "x-api-key": os.environ["CEVOID_API_KEY"],
    },
)
response.raise_for_status()
print(response.json())

<?php

$curl = curl_init();
curl_setopt_array($curl, [
  CURLOPT_URL => 'https://api.cevoid.com/v1/members',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_HTTPHEADER => [
    'x-api-key: ' . getenv('CEVOID_API_KEY'),
  ],
]);

$response = curl_exec($curl);
curl_close($curl);

echo $response;

package main

import (
	"fmt"
	"io"
	"net/http"
	"os"
)

func main() {
	req, err := http.NewRequest(http.MethodGet, "https://api.cevoid.com/v1/members", nil)
	if err != nil {
		panic(err)
	}
	req.Header.Set("x-api-key", os.Getenv("CEVOID_API_KEY"))

	res, err := http.DefaultClient.Do(req)
	if err != nil {
		panic(err)
	}
	defer res.Body.Close()

	data, err := io.ReadAll(res.Body)
	if err != nil {
		panic(err)
	}
	fmt.Println(string(data))
}

require "net/http"

uri = URI("https://api.cevoid.com/v1/members")
request = Net::HTTP::Get.new(uri)
request["x-api-key"] = ENV.fetch("CEVOID_API_KEY")

response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) do |http|
  http.request(request)
end
puts response.body

Response

{
  "count": 0,
  "next": "string",
  "nodes": [
    {
      "id": "member_abc123def456",
      "shortId": "mem_5a8b9c",
      "name": "Sarah Johnson",
      "email": "sarah.johnson@example.com",
      "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",
      "createdAt": "2024-01-15T09:30:00.000Z",
      "updatedAt": "2024-01-20T14:22:15.000Z"
    }
  ]
}

"string"

"No valid API key provided"

"Something went wrong"

Authorizations

x-api-keystringheaderrequired

Send your API key in the x-api-key header.

Query parameters

limitnumberDefault: 25

Max value for limit is 25

Range: 1 <= x <= 25
Example: 10

skipnumber | nullDefault: 0

Number of items to skip

Range: 0 <= x
Example: 0

marketstring

Market ID or shortId for localized content

Example: us

Response

200 Successful response application/json

countnumberrequired

Total number of items

nextstring | nullrequired

URL for next page

nodesobject[]required

Item properties (13)

idstringrequired

Unique identifier for the member within the Cevoid system

Example: member_abc123def456

shortIdstringrequired

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

Example: mem_5a8b9c

namestring

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

Example: Sarah Johnson

emailstring

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

Example: sarah.johnson@example.com

avatarUrlstring

URL to the member's profile picture or avatar image

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

countrystring

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

Example: US

languagestring

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

Example: en

locationstring

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

Example: San Francisco, CA

socialInstagramHandlestring

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

Example: sarah.lifestyle

biostring

Biography or description provided by the member

Example: Lifestyle blogger and photography enthusiast

notesstring

Internal notes about the member for company reference

Example: VIP customer, prefers email communication

createdAtstringrequired

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

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

updatedAtstringrequired

ISO 8601 timestamp indicating when the member was last updated

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

400 Bad request application/json

string

401 Unauthorized application/json

enum<string>

No valid API key provided

500 Internal server error application/json

enum<string>

Something went wrong